diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3255f4d853e0f..7c6724fb5e1f1 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,8 +1,6 @@ >^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -> For 1.11 Features: set Milestone to 1.11 and Base Branch to release-1.11 +> For 1.12 Features: set Milestone to 1.12 and Base Branch to release-1.12 >^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -> NOTE: After opening the PR, please *un-check and re-check* the ["Allow edits from maintainers"](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) box so that maintainers can work on your patch and speed up the review process. This is a temporary workaround to address a known issue with GitHub.> > > Please delete this note before submitting the pull request. -![Allow edits from maintainers checkbox](https://help.github.com/assets/images/help/pull_requests/allow-maintainers-to-make-edits-sidebar-checkbox.png) diff --git a/.travis.yml b/.travis.yml index 384edc5f5c631..73ee995c1682c 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,6 +1,6 @@ language: go go: - - 1.9.3 + - 1.10.2 # Don't want default ./... here: install: @@ -10,7 +10,7 @@ install: # Fetch dependencies for us to run the tests in test/examples_test.go - go get -t -v k8s.io/website/test # Make sure we are testing against the correct branch -- pushd $GOPATH/src/k8s.io/kubernetes && git checkout release-1.10 && popd +- pushd $GOPATH/src/k8s.io/kubernetes && git checkout release-1.11 && popd # Simplified deduplication of dependencies. - cp -L -R $GOPATH/src/k8s.io/kubernetes/vendor/ $GOPATH/src/ diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000000000..4e2bae8b07109 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,30 @@ +# Credit to Julien Guyomard (https://github.com/jguyomard). This Dockerfile +# is essentially based on his Dockerfile at +# https://github.com/jguyomard/docker-hugo/blob/master/Dockerfile. The only significant +# change is that the Hugo version is now an overridable argument rather than a fixed +# environment variable. + +FROM alpine:latest + +MAINTAINER Luc Perkins + +RUN apk add --no-cache \ + curl \ + git \ + openssh-client \ + rsync + +ARG HUGO_VERSION + +RUN mkdir -p /usr/local/src && \ + cd /usr/local/src && \ + curl -L https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_${HUGO_VERSION}_linux-64bit.tar.gz | tar -xz && \ + mv hugo /usr/local/bin/hugo && \ + curl -L https://bin.equinox.io/c/dhgbqpS8Bvy/minify-stable-linux-amd64.tgz | tar -xz && \ + mv minify /usr/local/bin && \ + addgroup -Sg 1000 hugo && \ + adduser -Sg hugo -u 1000 -h /src hugo + +WORKDIR /src + +EXPOSE 1313 diff --git a/Makefile b/Makefile index 8909d51974bc3..fcbd8438206a7 100644 --- a/Makefile +++ b/Makefile @@ -1,3 +1,8 @@ +DOCKER = docker +HUGO_VERSION = 0.40.3 +DOCKER_IMAGE = kubernetes-hugo +DOCKER_RUN = $(DOCKER) run --rm --interactive --tty --volume $(PWD):/src + .PHONY: all build sass build-preview help serve help: ## Show this help. @@ -18,5 +23,11 @@ build-preview: ## Build site with drafts and future posts enabled. serve: ## Boot the development server. hugo server -stage: ## This needs to be updated for Hugo - #docker run -ti --rm -v "${PWD}":/k8sdocs -p 4000:4000 gcr.io/google-samples/k8sdocs:1.1 +docker-image: + $(DOCKER) build . --tag $(DOCKER_IMAGE) --build-arg HUGO_VERSION=$(HUGO_VERSION) + +docker-build: + $(DOCKER_RUN) $(DOCKER_IMAGE) hugo + +stage: + $(DOCKER_RUN) -p 1313:1313 $(DOCKER_IMAGE) hugo server --watch --bind 0.0.0.0 diff --git a/README.md b/README.md index 9eb11944ded97..31cf792ea08c4 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,38 @@ For more information about contributing to the Kubernetes documentation, see: * [Using Page Templates](http://kubernetes.io/docs/home/contribute/page-templates/) * [Documentation Style Guide](http://kubernetes.io/docs/home/contribute/style-guide/) +## Building the site using Docker + +If you'd like, you can build the Kubernetes docs using Docker. To get started, build the image locally: + +```bash +$ make docker-image + +# The underlying command: +$ docker build . \ + --tag kubernetes-hugo \ + --build-arg HUGO_VERSION=0.40.3 +``` + +You can create an image for a different version of Hugo by changing the value of the `HUGO_VERSION` argument for the build. You *must* specify a version or the image will not build. +Once the `kubernetes-hugo` image has been built locally, you can build the site: + +```bash +$ make docker-serve + +# The underlying command: +$ docker run \ + --rm \ + --interactive \ + --tty \ + --volume $(PWD):/src \ + kubernetes-hugo:latest \ + hugo +``` + +As when building without using a Docker container, the results of the build will be published to the `public` directory (the default output directory for [Hugo](https://gohugo.io), the static site generator used to build this site). + ## Thank you! Kubernetes thrives on community participation, and we really appreciate your -contributions to our site and our documentation! +contributions to our site and our documentation! \ No newline at end of file diff --git a/config.toml b/config.toml index 08ad4bff74b97..7390205f4916c 100644 --- a/config.toml +++ b/config.toml @@ -19,6 +19,9 @@ pygmentsUseClasses = false # See https://help.farbox.com/pygments.html pygmentsStyle = "emacs" +# Enable Git variables like commit, lastmod +enableGitInfo = true + [blackfriday] hrefTargetBlank = true fractions = false @@ -27,7 +30,7 @@ fractions = false date = ["date", ":filename", "publishDate", "lastmod"] [permalinks] - blog = "/:section/:year/:month/:day/:slug/" +blog = "/:section/:year/:month/:day/:slug/" # Be explicit about the output formats. We (currently) only want an RSS feed for the home page. [outputs] @@ -45,23 +48,31 @@ time_format_blog = "Monday, January 02, 2006" description = "Production-Grade Container Orchestration" showedit = true -latest = "v1.10" +latest = "v1.11" -fullversion = "v1.10.3" -version = "v1.10" +fullversion = "v1.11.0" +version = "v1.11" githubbranch = "master" docsbranch = "master" deprecated = false currentUrl = "https://kubernetes.io/docs/home/" nextUrl = "http://kubernetes-io-vnext-staging.netlify.com/" githubWebsiteRepo = "github.com/kubernetes/website" +githubWebsiteRaw = "raw.githubusercontent.com/kubernetes/website" + +[[params.versions]] +fullversion = "v1.11.0" +version = "v1.11" +githubbranch = "v1.11.0" +docsbranch = "release-1.11" +url = "https://kubernetes.io" [[params.versions]] fullversion = "v1.10.3" version = "v1.10" githubbranch = "v1.10.3" docsbranch = "release-1.10" -url = "https://kubernetes.io" +url = "https://v1-10.docs.kubernetes.io" [[params.versions]] fullversion = "v1.9.7" @@ -84,13 +95,6 @@ githubbranch = "v1.7.6" docsbranch = "release-1.7" url = "https://v1-7.docs.kubernetes.io" -[[params.versions]] -fullversion = "v1.6.8" -version = "v1.6" -githubbranch = "v1.6.8" -docsbranch = "release-1.6" -url = "https://v1-6.docs.kubernetes.io" - # Language definitions. diff --git a/content/en/_index.html b/content/en/_index.html index f957d245bbb36..e7a897832cf04 100644 --- a/content/en/_index.html +++ b/content/en/_index.html @@ -120,22 +120,23 @@

Batch

Case Studies

-
-

Using Kubernetes to reinvent the world's largest educational company

- Read more -
-
-

Kubernetes at Box: Microservices at Maximum Velocity

- Read more -
-
-

Inside eBay's shift to Kubernetes and containers atop OpenStack

- Read more -
-
-

Migrating from a homegrown 'cluster' to Kubernetes

- Watch the video -
+
+

Driving Banking Innovation with Cloud Native

+ Read more +
+
+

Supporting Fast Decisioning Applications with Kubernetes

+ Read more +
+
+

Cloud Native at Northwestern Mutual

+ Read more +
+
+

Launching and Scaling Up Experiments, Made Simple

+ Read more +
+
diff --git a/content/en/blog/_posts/2017-02-00-Highly-Available-Kubernetes-Clusters.md b/content/en/blog/_posts/2017-02-00-Highly-Available-Kubernetes-Clusters.md index df5358332edeb..d042699192920 100644 --- a/content/en/blog/_posts/2017-02-00-Highly-Available-Kubernetes-Clusters.md +++ b/content/en/blog/_posts/2017-02-00-Highly-Available-Kubernetes-Clusters.md @@ -38,7 +38,7 @@ $ KUBE\_GCE\_ZONE=europe-west1-b ./cluster/kube-up.sh -Now, we will add two additional pools of worker nodes, each of three nodes, in zones europe-west1-c and europe-west1-d (more details on adding pools of worker nodes can be find [here](http://kubernetes.io/docs/admin/multiple-zones/)): +Now, we will add two additional pools of worker nodes, each of three nodes, in zones europe-west1-c and europe-west1-d (more details on adding pools of worker nodes can be find [here](http://kubernetes.io/docs/setup/multiple-zones/)): ``` diff --git a/content/en/blog/_posts/2017-11-00-Kubernetes-Easy-Way.md b/content/en/blog/_posts/2017-11-00-Kubernetes-Easy-Way.md index 6a718be92f085..74c1fa08fc5a2 100644 --- a/content/en/blog/_posts/2017-11-00-Kubernetes-Easy-Way.md +++ b/content/en/blog/_posts/2017-11-00-Kubernetes-Easy-Way.md @@ -71,7 +71,7 @@ Once you log in, all of your clusters are available within Codefresh. ### Add Cluster -To add your cluster, click the down arrow, and then click **add cluste** r, select the project and cluster name. You can now deploy images! +To add your cluster, click the down arrow, and then click **add cluster**, select the project and cluster name. You can now deploy images! diff --git a/content/en/blog/_posts/2018-04-25-open-source-charts-2017.md b/content/en/blog/_posts/2018-04-25-open-source-charts-2017.md index b485964c33df1..0051669ebb0bc 100644 --- a/content/en/blog/_posts/2018-04-25-open-source-charts-2017.md +++ b/content/en/blog/_posts/2018-04-25-open-source-charts-2017.md @@ -40,8 +40,8 @@ SIG meetings provide focused opportunities for users, maintainers, and specialis ## Join the party! -You may already be using solutions that are successfully managed and scaled on Kubernetes. For example, GitHub.com, which hosts Kubernetes’ upstream source code, [now runs on Kubernetes](https://githubengineering.com/kubernetes-at-github/) https://githubengineering.com/kubernetes-at-github/) as well! +You may already be using solutions that are successfully managed and scaled on Kubernetes. For example, GitHub.com, which hosts Kubernetes’ upstream source code, [now runs on Kubernetes](https://githubengineering.com/kubernetes-at-github/) as well! Check out the [Kubernetes Contributors’ guide](https://github.com/kubernetes/community/blob/master/contributors/guide/README.md) for more information on how to get started as a contributor. -You can also join the [weekly Kubernetes Community meeting](https://github.com/kubernetes/community/tree/master/communication#weekly-meeting)and consider [joining a SIG or two](https://github.com/kubernetes/community/blob/master/sig-list.md#master-sig-list). +You can also join the [weekly Kubernetes Community meeting](https://github.com/kubernetes/community/tree/master/communication#weekly-meeting) and consider [joining a SIG or two](https://github.com/kubernetes/community/blob/master/sig-list.md#master-sig-list). diff --git a/content/en/blog/_posts/2018-04-30-zero-downtime-deployment-kubernetes-jenkins.md b/content/en/blog/_posts/2018-04-30-zero-downtime-deployment-kubernetes-jenkins.md index e61b74cd2d396..e7a70c7cad7ad 100644 --- a/content/en/blog/_posts/2018-04-30-zero-downtime-deployment-kubernetes-jenkins.md +++ b/content/en/blog/_posts/2018-04-30-zero-downtime-deployment-kubernetes-jenkins.md @@ -10,6 +10,7 @@ Ever since we added the [Kubernetes Continuous Deploy](https://aka.ms/azjenkinsk ## Rolling Update Kubernetes supports the RollingUpdate strategy to replace old pods with new ones gradually, while continuing to serve clients without incurring downtime. To perform a RollingUpdate deployment: + * Set `.spec.strategy.type` to `RollingUpdate` (the default value). * Set `.spec.strategy.rollingUpdate.maxUnavailable` and `.spec.strategy.rollingUpdate.maxSurge` to some reasonable value. * `maxUnavailable`: the maximum number of pods that can be unavailable during the update process. This can be an absolute number or percentage of the replicas count; the default is 25%. diff --git a/content/en/blog/_posts/2018-06-26-kubernetes-1.11-release-announcement.md b/content/en/blog/_posts/2018-06-26-kubernetes-1.11-release-announcement.md new file mode 100644 index 0000000000000..c86815b116319 --- /dev/null +++ b/content/en/blog/_posts/2018-06-26-kubernetes-1.11-release-announcement.md @@ -0,0 +1,112 @@ +--- +layout: blog +title: 'Kubernetes 1.11: In-Cluster Load Balancing and CoreDNS Plugin Graduate to General Availability' +date: 2018-06-27 +slug: kubernetes-1.11-release-announcement +--- + +**Author**: Kubernetes 1.11 [Release Team](https://github.com/kubernetes/sig-release/blob/master/releases/release-1.11/release_team.md) + +We’re pleased to announce the delivery of Kubernetes 1.11, our second release of 2018! + +Today’s release continues to advance maturity, scalability, and flexibility of Kubernetes, marking significant progress on features that the team has been hard at work on over the last year. This newest version graduates key features in networking, opens up two major features from SIG-API Machinery and SIG-Node for beta testing, and continues to enhance storage features that have been a focal point of the past two releases. The features in this release make it increasingly possible to plug any infrastructure, cloud or on-premise, into the Kubernetes system. + +Notable additions in this release include two highly-anticipated features graduating to general availability: IPVS-based In-Cluster Load Balancing and CoreDNS as a cluster DNS add-on option, which means increased scalability and flexibility for production applications. + +Let’s dive into the key features of this release: + +## IPVS-Based In-Cluster Service Load Balancing Graduates to General Availability + +In this release, [IPVS-based in-cluster service load balancing](https://github.com/kubernetes/features/issues/265) has moved to stable. IPVS (IP Virtual Server) provides high-performance in-kernel load balancing, with a simpler programming interface than iptables. This change delivers better network throughput, better programming latency, and higher scalability limits for the cluster-wide distributed load-balancer that comprises the Kubernetes Service model. IPVS is not yet the default but clusters can begin to use it for production traffic. + +## CoreDNS Promoted to General Availability + +[CoreDNS](https://coredns.io) is now available as a [cluster DNS add-on option](https://github.com/kubernetes/features/issues/427), and is the default when using kubeadm. CoreDNS is a flexible, extensible authoritative DNS server and directly integrates with the Kubernetes API. CoreDNS has fewer moving parts than the previous DNS server, since it’s a single executable and a single process, and supports flexible use cases by creating custom DNS entries. It’s also written in Go making it memory-safe. You can learn more about CoreDNS [here](https://youtu.be/dz9S7R8r5gw). + +## Dynamic Kubelet Configuration Moves to Beta + +This feature makes it possible for new Kubelet configurations to be rolled out in a live cluster. Currently, Kubelets are configured via command-line flags, which makes it difficult to update Kubelet configurations in a running cluster. With this beta feature, [users can configure Kubelets in a live cluster](https://kubernetes.io/docs/tasks/administer-cluster/reconfigure-kubelet/) via the API server. + +## Custom Resource Definitions Can Now Define Multiple Versions + +Custom Resource Definitions are no longer restricted to defining a single version of the custom resource, a restriction that was difficult to work around. Now, with this beta [feature](https://github.com/kubernetes/features/issues/544), multiple versions of the resource can be defined. In the future, this will be expanded to support some automatic conversions; for now, this feature allows custom resource authors to “promote with safe changes, e.g. v1beta1 to v1,” and to create a migration path for resources which do have changes. + +Custom Resource Definitions now also support ["status" and "scale" subresources](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/customresources-subresources.md), which integrate with monitoring and high-availability frameworks. These two changes advance the ability to run cloud-native applications in production using Custom Resource Definitions. + +## Enhancements to CSI + +Container Storage Interface (CSI) has been a major topic over the last few releases. After moving to [beta in 1.10](https://github.com/container-storage-interface/spec/blob/master/spec.md), the 1.11 release continues enhancing CSI with a number of features. The 1.11 release adds alpha support for raw block volumes to CSI, integrates CSI with the new kubelet plugin registration mechanism, and makes it easier to pass secrets to CSI plugins. + +## New Storage Features + +Support for [online resizing of Persistent Volumes](https://github.com/kubernetes/features/issues/284) has been introduced as an alpha feature. This enables users to increase the size of PVs without having to terminate pods and unmount volume first. The user will update the PVC to request a new size and kubelet will resize the file system for the PVC. + +Support for [dynamic maximum volume count](https://github.com/kubernetes/features/issues/554) has been introduced as an alpha feature. This new feature enables in-tree volume plugins to specify the maximum number of volumes that can be attached to a node and allows the limit to vary depending on the type of node. Previously, these limits were hard coded or configured via an environment variable. + +The StorageObjectInUseProtection feature is now stable and prevents the removal of both [Persistent Volumes](https://github.com/kubernetes/features/issues/499) that are bound to a Persistent Volume Claim, and [Persistent Volume Claims](https://github.com/kubernetes/features/issues/498) that are being used by a pod. This safeguard will help prevent issues from deleting a PV or a PVC that is currently tied to an active pod. + +Each Special Interest Group (SIG) within the community continues to deliver the most-requested enhancements, fixes, and functionality for their respective specialty areas. For a complete list of inclusions by SIG, please visit the [release notes](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.11.md#111-release-notes). + +## Availability + +Kubernetes 1.11 is available for [download on GitHub](https://github.com/kubernetes/kubernetes/releases/tag/v1.11.0). To get started with Kubernetes, check out these [interactive tutorials](https://kubernetes.io/docs/tutorials/). + +You can also install 1.11 using Kubeadm. Version 1.11.0 will be available as Deb and RPM packages, installable using the [Kubeadm cluster installer](https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/) sometime on June 28th. + +## 5 Day Features Blog Series + +If you’re interested in exploring these features more in depth, check back in two weeks for our 5 Days of Kubernetes series where we’ll highlight detailed walkthroughs of the following features: + +* Day 1: [IPVS-Based In-Cluster Service Load Balancing Graduates to General Availability](/blog/2018/07/09/ipvs-based-in-cluster-load-balancing-deep-dive/) +* Day 2: CoreDNS Promoted to General Availability +* Day 3: Dynamic Kubelet Configuration Moves to Beta +* Day 4: Custom Resource Definitions Can Now Define Multiple Versions +* Day 5: Overview of CSI Enhancements + +## Release team + +This release is made possible through the effort of hundreds of individuals who contributed both technical and non-technical content. Special thanks to the [release team](https://github.com/kubernetes/sig-release/blob/master/releases/release-1.11/release_team.md) led by Josh Berkus, Kubernetes Community Manager at Red Hat. The 20 individuals on the release team coordinate many aspects of the release, from documentation to testing, validation, and feature completeness. + +As the Kubernetes community has grown, our release process represents an amazing demonstration of collaboration in open source software development. Kubernetes continues to gain new users at a rapid clip. This growth creates a positive feedback cycle where more contributors commit code creating a more vibrant ecosystem. Kubernetes has over 20,000 individual contributors to date and an active community of more than 40,000 people. + +## Project Velocity + +The CNCF has continued refining DevStats, an ambitious project to visualize the myriad contributions that go into the project. [K8s DevStats](https://devstats.k8s.io) illustrates the breakdown of contributions from major company contributors, as well as an impressive set of preconfigured reports on everything from individual contributors to pull request lifecycle times. On average, 250 different companies and over 1,300 individuals contribute to Kubernetes each month. [Check out DevStats](https://devstats.k8s.io) to learn more about the overall velocity of the Kubernetes project and community. + +## User Highlights + +Established, global organizations are using [Kubernetes in production](https://kubernetes.io/case-studies/) at massive scale. Recently published user stories from the community include: + +* **The New York Times**, known as the newspaper of record, [moved out of its data centers and into the public cloud](https://kubernetes.io/case-studies/newyorktimes/) with the help of Google Cloud Platform and Kubernetes. This move meant a significant increase in speed of delivery, from 45 minutes to just a few seconds with Kubernetes. +* **Nordstrom**, a leading fashion retailer based in the U.S., began their cloud native journey by [adopting Docker containers orchestrated with Kubernetes](https://kubernetes.io/case-studies/nordstrom/). The results included a major increase in Ops efficiency, improving CPU utilization from 5x to 12x depending on the workload. +* **Squarespace**, a SaaS solution for easily building and hosting websites, [moved their monolithic application to microservices with the help of Kubernetes](https://kubernetes.io/case-studies/squarespace/). This resulted in a deployment time reduction of almost 85%. +* **Crowdfire**, a leading social media management platform, moved from a monolithic application to a [custom Kubernetes-based setup](https://kubernetes.io/case-studies/crowdfire/). This move reduced deployment time from 15 minutes to less than a minute. + +Is Kubernetes helping your team? Share your story with the community. + +## Ecosystem Updates + +* The CNCF recently expanded its certification offerings to include a Certified Kubernetes Application Developer exam. The CKAD exam certifies an individual's ability to design, build, configure, and expose cloud native applications for Kubernetes. More information can be found [here](https://www.cncf.io/blog/2018/03/16/cncf-announces-ckad-exam/). +* The CNCF recently added a new partner category, Kubernetes Training Partners (KTP). KTPs are a tier of vetted training providers who have deep experience in cloud native technology training. View partners and learn more [here](https://www.cncf.io/certification/training/). +* CNCF also offers [online training](https://www.cncf.io/certification/training/) that teaches the skills needed to create and configure a real-world Kubernetes cluster. +* Kubernetes documentation now features [user journeys](https://k8s.io/docs/home/): specific pathways for learning based on who readers are and what readers want to do. Learning Kubernetes is easier than ever for beginners, and more experienced users can find task journeys specific to cluster admins and application developers. + +## KubeCon + +The world’s largest Kubernetes gathering, KubeCon + CloudNativeCon is coming to [Shanghai](https://www.lfasiallc.com/events/kubecon-cloudnativecon-china-2018/) from November 14-15, 2018 and [Seattle](https://events.linuxfoundation.org/events/kubecon-cloudnativecon-north-america-2018/) from December 11-13, 2018. This conference will feature technical sessions, case studies, developer deep dives, salons and more! The CFP for both event is currently open. [Submit your talk](https://events.linuxfoundation.org/events/kubecon-cloudnativecon-north-america-2018/program/call-for-proposals-cfp/) and [register](https://events.linuxfoundation.org/events/kubecon-cloudnativecon-europe-2018/attend/register/) today! + +## Webinar + +Join members of the Kubernetes 1.11 release team on July 31st at 10am PDT to learn about the major features in this release including In-Cluster Load Balancing and the CoreDNS Plugin. Register [here](https://www.cncf.io/event/webinar-kubernetes-1-11/). + +## Get Involved + +The simplest way to get involved with Kubernetes is by joining one of the many [Special Interest Groups](https://github.com/kubernetes/community/blob/master/sig-list.md) (SIGs) that align with your interests. Have something you’d like to broadcast to the Kubernetes community? Share your voice at our weekly [community meeting](https://github.com/kubernetes/community/blob/master/communication.md#weekly-meeting), and through the channels below. + +Thank you for your continued feedback and support. + +* Post questions (or answer questions) on [Stack Overflow](http://stackoverflow.com/questions/tagged/kubernetes) +* Join the community portal for advocates on [K8sPort](http://k8sport.org/) +* Follow us on Twitter [@Kubernetesio](https://twitter.com/kubernetesio) for latest updates +* Chat with the community on [Slack](http://slack.k8s.io/) +* Share your Kubernetes [story](https://docs.google.com/a/linuxfoundation.org/forms/d/e/1FAIpQLScuI7Ye3VQHQTwBASrgkjQDSS5TP0g3AXfFhwSM9YpHgxRKFA/viewform) diff --git a/content/en/blog/_posts/2018-06-28-Airflow-Kubernetes-Operator.md b/content/en/blog/_posts/2018-06-28-Airflow-Kubernetes-Operator.md new file mode 100644 index 0000000000000..6f5171330fa5b --- /dev/null +++ b/content/en/blog/_posts/2018-06-28-Airflow-Kubernetes-Operator.md @@ -0,0 +1,204 @@ +--- +layout: blog +title: 'Airflow on Kubernetes (Part 1): A Different Kind of Operator' +date: 2018-06-28 +--- + +**Author**: Daniel Imberman (Bloomberg LP) + +## Introduction + +As part of Bloomberg's [continued commitment to developing the Kubernetes ecosystem](https://www.techatbloomberg.com/blog/bloomberg-awarded-first-cncf-end-user-award-contributions-kubernetes/), we are excited to announce the Kubernetes Airflow Operator; a mechanism for [Apache Airflow](https://airflow.apache.org/), a popular workflow orchestration framework to natively launch arbitrary Kubernetes Pods using the Kubernetes API. + +## What Is Airflow? + +Apache Airflow is one realization of the DevOps philosophy of "Configuration As Code." Airflow allows users to launch multi-step pipelines using a simple Python object DAG (Directed Acyclic Graph). You can define dependencies, programmatically construct complex workflows, and monitor scheduled jobs in an easy to read UI. + +Airflow DAGs +Airflow UI + +## Why Airflow on Kubernetes? + +Since its inception, Airflow's greatest strength has been its flexibility. Airflow offers a wide range of integrations for services ranging from Spark and HBase, to services on various cloud providers. Airflow also offers easy extensibility through its plug-in framework. However, one limitation of the project is that Airflow users are confined to the frameworks and clients that exist on the Airflow worker at the moment of execution. A single organization can have varied Airflow workflows ranging from data science pipelines to application deployments. This difference in use-case creates issues in dependency management as both teams might use vastly different libraries for their workflows. + +To address this issue, we've utilized Kubernetes to allow users to launch arbitrary Kubernetes pods and configurations. Airflow users can now have full power over their run-time environments, resources, and secrets, basically turning Airflow into an "any job you want" workflow orchestrator. + + +## The Kubernetes Operator + +Before we move any further, we should clarify that an [Operator](https://airflow.apache.org/concepts.html#operators) in Airflow is a task definition. When a user creates a DAG, they would use an operator like the "SparkSubmitOperator" or the "PythonOperator" to submit/monitor a Spark job or a Python function respectively. Airflow comes with built-in operators for frameworks like Apache Spark, BigQuery, Hive, and EMR. It also offers a Plugins entrypoint that allows DevOps engineers to develop their own connectors. + +Airflow users are always looking for ways to make deployments and ETL pipelines simpler to manage. Any opportunity to decouple pipeline steps, while increasing monitoring, can reduce future outages and fire-fights. The following is a list of benefits provided by the Airflow Kubernetes Operator: + + * **Increased flexibility for deployments:** +Airflow's plugin API has always offered a significant boon to engineers wishing to test new functionalities within their DAGs. On the downside, whenever a developer wanted to create a new operator, they had to develop an entirely new plugin. Now, any task that can be run within a Docker container is accessible through the exact same operator, with no extra Airflow code to maintain. + + * **Flexibility of configurations and dependencies:** +For operators that are run within static Airflow workers, dependency management can become quite difficult. If a developer wants to run one task that requires [SciPy](https://www.scipy.org) and another that requires [NumPy](http://www.numpy.org), the developer would have to either maintain both dependencies within all Airflow workers or offload the task to an external machine (which can cause bugs if that external machine changes in an untracked manner). Custom Docker images allow users to ensure that the tasks environment, configuration, and dependencies are completely idempotent. + + * **Usage of kubernetes secrets for added security:** +Handling sensitive data is a core responsibility of any DevOps engineer. At every opportunity, Airflow users want to isolate any API keys, database passwords, and login credentials on a strict need-to-know basis. With the Kubernetes operator, users can utilize the Kubernetes Vault technology to store all sensitive data. This means that the Airflow workers will never have access to this information, and can simply request that pods be built with only the secrets they need. + + +# Architecture + +Airflow Architecture + +The Kubernetes Operator uses the [Kubernetes Python Client](https://github.com/kubernetes-client/Python) to generate a request that is processed by the APIServer (1). Kubernetes will then launch your pod with whatever specs you've defined (2). Images will be loaded with all the necessary environment variables, secrets and dependencies, enacting a single command. Once the job is launched, the operator only needs to monitor the health of track logs (3). Users will have the choice of gathering logs locally to the scheduler or to any distributed logging service currently in their Kubernetes cluster. + +# Using the Kubernetes Operator + +## A Basic Example + +The following DAG is probably the simplest example we could write to show how the Kubernetes Operator works. This DAG creates two pods on Kubernetes: a Linux distro with Python and a base Ubuntu distro without it. The Python pod will run the Python request correctly, while the one without Python will report a failure to the user. If the Operator is working correctly, the `passing-task` pod should complete, while the `failing-task` pod returns a failure to the Airflow webserver. + + + +```Python +from airflow import DAG +from datetime import datetime, timedelta +from airflow.contrib.operators.kubernetes_pod_operator import KubernetesPodOperator +from airflow.operators.dummy_operator import DummyOperator + + +default_args = { + 'owner': 'airflow', + 'depends_on_past': False, + 'start_date': datetime.utcnow(), + 'email': ['airflow@example.com'], + 'email_on_failure': False, + 'email_on_retry': False, + 'retries': 1, + 'retry_delay': timedelta(minutes=5) +} + +dag = DAG( + 'kubernetes_sample', default_args=default_args, schedule_interval=timedelta(minutes=10)) + + +start = DummyOperator(task_id='run_this_first', dag=dag) + +passing = KubernetesPodOperator(namespace='default', + image="Python:3.6", + cmds=["Python","-c"], + arguments=["print('hello world')"], + labels={"foo": "bar"}, + name="passing-test", + task_id="passing-task", + get_logs=True, + dag=dag + ) + +failing = KubernetesPodOperator(namespace='default', + image="ubuntu:1604", + cmds=["Python","-c"], + arguments=["print('hello world')"], + labels={"foo": "bar"}, + name="fail", + task_id="failing-task", + get_logs=True, + dag=dag + ) + +passing.set_upstream(start) +failing.set_upstream(start) +``` +Basic DAG Run + +## But how does this relate to my workflow? + +While this example only uses basic images, the magic of Docker is that this same DAG will work for any image/command pairing you want. The following is a recommended CI/CD pipeline to run production-ready code on an Airflow DAG. + +### 1: PR in github +Use Travis or Jenkins to run unit and integration tests, bribe your favorite team-mate into PR'ing your code, and merge to the master branch to trigger an automated CI build. + +### 2: CI/CD via Jenkins -> Docker Image + +[Generate your Docker images and bump release version within your Jenkins build](https://getintodevops.com/blog/building-your-first-Docker-image-with-jenkins-2-guide-for-developers). + +### 3: Airflow launches task + +Finally, update your DAGs to reflect the new release version and you should be ready to go! + +```Python +production_task = KubernetesPodOperator(namespace='default', + # image="my-production-job:release-1.0.1", <-- old release + image="my-production-job:release-1.0.2", + cmds=["Python","-c"], + arguments=["print('hello world')"], + name="fail", + task_id="failing-task", + get_logs=True, + dag=dag + ) +``` + +# Launching a test deployment + +Since the Kubernetes Operator is not yet released, we haven't released an official [helm](https://helm.sh/) chart or operator (however both are currently in progress). However, we are including instructions for a basic deployment below and are actively looking for foolhardy beta testers to try this new feature. To try this system out please follow these steps: + +## Step 1: Set your kubeconfig to point to a kubernetes cluster + +## Step 2: Clone the Airflow Repo: + +Run `git clone https://github.com/apache/incubator-airflow.git` to clone the official Airflow repo. + +## Step 3: Run + +To run this basic deployment, we are co-opting the integration testing script that we currently use for the Kubernetes Executor (which will be explained in the next article of this series). To launch this deployment, run these three commands: + +``` +sed -ie "s/KubernetesExecutor/LocalExecutor/g" scripts/ci/kubernetes/kube/configmaps.yaml +./scripts/ci/kubernetes/Docker/build.sh +./scripts/ci/kubernetes/kube/deploy.sh +``` + +Before we move on, let's discuss what these commands are doing: + +### sed -ie "s/KubernetesExecutor/LocalExecutor/g" scripts/ci/kubernetes/kube/configmaps.yaml + +The Kubernetes Executor is another Airflow feature that allows for dynamic allocation of tasks as idempotent pods. The reason we are switching this to the LocalExecutor is simply to introduce one feature at a time. You are more then welcome to skip this step if you would like to try the Kubernetes Executor, however we will go into more detail in a future article. + +### ./scripts/ci/kubernetes/Docker/build.sh + +This script will tar the Airflow master source code build a Docker container based on the Airflow distribution + +### ./scripts/ci/kubernetes/kube/deploy.sh + +Finally, we create a full Airflow deployment on your cluster. This includes Airflow configs, a postgres backend, the webserver + scheduler, and all necessary services between. One thing to note is that the role binding supplied is a cluster-admin, so if you do not have that level of permission on the cluster, you can modify this at scripts/ci/kubernetes/kube/airflow.yaml + +## Step 4: Log into your webserver + +Now that your Airflow instance is running let's take a look at the UI! The UI lives in port 8080 of the Airflow pod, so simply run + +``` +WEB=$(kubectl get pods -o go-template --template '{{range .items}}{{.metadata.name}}{{"\n"}}{{end}}' | grep "airflow" | head -1) +kubectl port-forward $WEB 8080:8080 + ``` + + Now the Airflow UI will exist on http://localhost:8080. To log in simply enter `airflow`/`airflow` and you should have full access to the Airflow web UI. + +## Step 5: Upload a test document + +To modify/add your own DAGs, you can use `kubectl cp` to upload local files into the DAG folder of the Airflow scheduler. Airflow will then read the new DAG and automatically upload it to its system. The following command will upload any local file into the correct directory: + +`kubectl cp /:/root/airflow/dags -c scheduler` + +## Step 6: Enjoy! + +# So when will I be able to use this? + + While this feature is still in the early stages, we hope to see it released for wide release in the next few months. + +# Get Involved + +This feature is just the beginning of multiple major efforts to improves Apache Airflow integration into Kubernetes. The Kubernetes Operator has been merged into the [1.10 release branch of Airflow](https://github.com/apache/incubator-airflow/tree/v1-10-test) (the executor in experimental mode), along with a fully k8s native scheduler called the Kubernetes Executor (article to come). These features are still in a stage where early adopters/contributers can have a huge influence on the future of these features. + +For those interested in joining these efforts, I'd recommend checkint out these steps: + + * Join the airflow-dev mailing list at dev@airflow.apache.org. + * File an issue in [Apache Airflow JIRA](https://issues.apache.org/jira/projects/AIRFLOW/issues/) + * Join our SIG-BigData meetings on Wednesdays at 10am PST. + * Reach us on slack at #sig-big-data on kubernetes.slack.com + +Special thanks to the Apache Airflow and Kubernetes communities, particularly Grant Nicholas, Ben Goldberg, Anirudh Ramanathan, Fokko Dreisprong, and Bolke de Bruin, for your awesome help on these features as well as our future efforts. diff --git a/content/en/blog/_posts/2018-07-09-IPVS-In-Cluster-Load-Balancing.md b/content/en/blog/_posts/2018-07-09-IPVS-In-Cluster-Load-Balancing.md new file mode 100644 index 0000000000000..881cbce11c205 --- /dev/null +++ b/content/en/blog/_posts/2018-07-09-IPVS-In-Cluster-Load-Balancing.md @@ -0,0 +1,181 @@ +--- +layout: blog +title: 'IPVS-Based In-Cluster Load Balancing Deep Dive' +date: 2018-07-09 +--- + +**Author**: Jun Du(Huawei), Haibin Xie(Huawei), Wei Liang(Huawei) + +**Editor’s note: this post is part of a [series of in-depth articles](https://kubernetes.io/blog/2018/06/27/kubernetes-1.11-release-announcement/) on what’s new in Kubernetes 1.11** + +## Introduction + +Per [the Kubernetes 1.11 release blog post ](https://kubernetes.io/blog/2018/06/27/kubernetes-1.11-release-announcement/), we announced that IPVS-Based In-Cluster Service Load Balancing graduates to General Availability. In this blog, we will take you through a deep dive of the feature. + +## What Is IPVS? + +**IPVS** (**IP Virtual Server**) is built on top of the Netfilter and implements transport-layer load balancing as part of the Linux kernel. + +IPVS is incorporated into the LVS (Linux Virtual Server), where it runs on a host and acts as a load balancer in front of a cluster of real servers. IPVS can direct requests for TCP- and UDP-based services to the real servers, and make services of the real servers appear as virtual services on a single IP address. Therefore, IPVS naturally supports Kubernetes Service. + +## Why IPVS for Kubernetes? + +As Kubernetes grows in usage, the scalability of its resources becomes more and more important. In particular, the scalability of services is paramount to the adoption of Kubernetes by developers/companies running large workloads. + +Kube-proxy, the building block of service routing has relied on the battle-hardened iptables to implement the core supported Service types such as ClusterIP and NodePort. However, iptables struggles to scale to tens of thousands of Services because it is designed purely for firewalling purposes and is based on in-kernel rule lists. + +Even though Kubernetes already support 5000 nodes in release v1.6, the kube-proxy with iptables is actually a bottleneck to scale the cluster to 5000 nodes. One example is that with NodePort Service in a 5000-node cluster, if we have 2000 services and each services have 10 pods, this will cause at least 20000 iptable records on each worker node, and this can make the kernel pretty busy. + +On the other hand, using IPVS-based in-cluster service load balancing can help a lot for such cases. IPVS is specifically designed for load balancing and uses more efficient data structures (hash tables) allowing for almost unlimited scale under the hood. + +## IPVS-based Kube-proxy + +### Parameter Changes + +**Parameter: --proxy-mode** In addition to existing userspace and iptables modes, IPVS mode is configured via `--proxy-mode=ipvs`. It implicitly uses IPVS NAT mode for service port mapping. + +**Parameter: --ipvs-scheduler** + +A new kube-proxy parameter has been added to specify the IPVS load balancing algorithm, with the parameter being `--ipvs-scheduler`. If it’s not configured, then round-robin (rr) is the default value. + +- rr: round-robin +- lc: least connection +- dh: destination hashing +- sh: source hashing +- sed: shortest expected delay +- nq: never queue + +In the future, we can implement Service specific scheduler (potentially via annotation), which has higher priority and overwrites the value. + +**Parameter: `--cleanup-ipvs`** Similar to the `--cleanup-iptables` parameter, if true, cleanup IPVS configuration and IPTables rules that are created in IPVS mode. + +**Parameter: `--ipvs-sync-period`** Maximum interval of how often IPVS rules are refreshed (e.g. '5s', '1m'). Must be greater than 0. + +**Parameter: `--ipvs-min-sync-period`** Minimum interval of how often the IPVS rules are refreshed (e.g. '5s', '1m'). Must be greater than 0. + +**Parameter: `--ipvs-exclude-cidrs`** A comma-separated list of CIDR's which the IPVS proxier should not touch when cleaning up IPVS rules because IPVS proxier can't distinguish kube-proxy created IPVS rules from user original IPVS rules. If you are using IPVS proxier with your own IPVS rules in the environment, this parameter should be specified, otherwise your original rule will be cleaned. + +### Design Considerations + +#### IPVS Service Network Topology + +When creating a ClusterIP type Service, IPVS proxier will do the following three things: + +* Make sure a dummy interface exists in the node, defaults to kube-ipvs0 +* Bind Service IP addresses to the dummy interface +* Create IPVS virtual servers for each Service IP address respectively + +Here comes an example: + +``` +# kubectl describe svc nginx-service +Name: nginx-service +... +Type: ClusterIP +IP: 10.102.128.4 +Port: http 3080/TCP +Endpoints: 10.244.0.235:8080,10.244.1.237:8080 +Session Affinity: None + +# ip addr +... +73: kube-ipvs0: mtu 1500 qdisc noop state DOWN qlen 1000 + link/ether 1a:ce:f5:5f:c1:4d brd ff:ff:ff:ff:ff:ff + inet 10.102.128.4/32 scope global kube-ipvs0 + valid_lft forever preferred_lft forever + +# ipvsadm -ln +IP Virtual Server version 1.2.1 (size=4096) +Prot LocalAddress:Port Scheduler Flags + -> RemoteAddress:Port Forward Weight ActiveConn InActConn +TCP 10.102.128.4:3080 rr + -> 10.244.0.235:8080 Masq 1 0 0 + -> 10.244.1.237:8080 Masq 1 0 0 +``` + +Please note that the relationship between a Kubernetes Service and IPVS virtual servers is `1:N`. For example, consider a Kubernetes Service that has more than one IP address. An External IP type Service has two IP addresses - ClusterIP and External IP. Then the IPVS proxier will create 2 IPVS virtual servers - one for Cluster IP and another one for External IP. The relationship between a Kubernetes Endpoint (each IP+Port pair) and an IPVS virtual server is `1:1`. + +Deleting of a Kubernetes service will trigger deletion of the corresponding IPVS virtual server, IPVS real servers and its IP addresses bound to the dummy interface. + +#### Port Mapping + +There are three proxy modes in IPVS: NAT (masq), IPIP and DR. Only NAT mode supports port mapping. Kube-proxy leverages NAT mode for port mapping. The following example shows IPVS mapping Service port 3080 to Pod port 8080. + +``` +TCP 10.102.128.4:3080 rr + -> 10.244.0.235:8080 Masq 1 0 0 + -> 10.244.1.237:8080 Masq 1 0 +``` + +#### Session Affinity + +IPVS supports client IP session affinity (persistent connection). When a Service specifies session affinity, the IPVS proxier will set a timeout value (180min=10800s by default) in the IPVS virtual server. For example: + +``` +# kubectl describe svc nginx-service +Name: nginx-service +... +IP: 10.102.128.4 +Port: http 3080/TCP +Session Affinity: ClientIP + +# ipvsadm -ln +IP Virtual Server version 1.2.1 (size=4096) +Prot LocalAddress:Port Scheduler Flags + -> RemoteAddress:Port Forward Weight ActiveConn InActConn +TCP 10.102.128.4:3080 rr persistent 10800 +``` + +#### Iptables & Ipset in IPVS Proxier + +IPVS is for load balancing and it can't handle other workarounds in kube-proxy, e.g. packet filtering, hairpin-masquerade tricks, SNAT, etc. + +IPVS proxier leverages iptables in the above scenarios. Specifically, ipvs proxier will fall back on iptables in the following 4 scenarios: + +- kube-proxy start with --masquerade-all=true +- Specify cluster CIDR in kube-proxy startup +- Support Loadbalancer type service +- Support NodePort type service + +However, we don't want to create too many iptables rules. So we adopt ipset for the sake of decreasing iptables rules. The following is the table of ipset sets that IPVS proxier maintains: + +| set name | members | usage | +| ------------------------------ | ---------------------------------------- | ---------------------------------------- | +| KUBE-CLUSTER-IP | All Service IP + port | masquerade for cases that `masquerade-all=true` or `clusterCIDR` specified | +| KUBE-LOOP-BACK | All Service IP + port + IP | masquerade for resolving hairpin issue | +| KUBE-EXTERNAL-IP | Service External IP + port | masquerade for packets to external IPs | +| KUBE-LOAD-BALANCER | Load Balancer ingress IP + port | masquerade for packets to Load Balancer type service | +| KUBE-LOAD-BALANCER-LOCAL | Load Balancer ingress IP + port with `externalTrafficPolicy=local` | accept packets to Load Balancer with `externalTrafficPolicy=local` | +| KUBE-LOAD-BALANCER-FW | Load Balancer ingress IP + port with `loadBalancerSourceRanges` | Drop packets for Load Balancer type Service with `loadBalancerSourceRanges` specified | +| KUBE-LOAD-BALANCER-SOURCE-CIDR | Load Balancer ingress IP + port + source CIDR | accept packets for Load Balancer type Service with `loadBalancerSourceRanges` specified | +| KUBE-NODE-PORT-TCP | NodePort type Service TCP port | masquerade for packets to NodePort(TCP) | +| KUBE-NODE-PORT-LOCAL-TCP | NodePort type Service TCP port with `externalTrafficPolicy=local` | accept packets to NodePort Service with `externalTrafficPolicy=local` | +| KUBE-NODE-PORT-UDP | NodePort type Service UDP port | masquerade for packets to NodePort(UDP) | +| KUBE-NODE-PORT-LOCAL-UDP | NodePort type service UDP port with `externalTrafficPolicy=local` | accept packets to NodePort Service with `externalTrafficPolicy=local` | + + +In general, for IPVS proxier, the number of iptables rules is static, no matter how many Services/Pods we have. + +### Run kube-proxy in IPVS Mode + +Currently, local-up scripts, GCE scripts, and kubeadm support switching IPVS proxy mode via exporting environment variables (`KUBE_PROXY_MODE=ipvs`) or specifying flag (`--proxy-mode=ipvs`). Before running IPVS proxier, please ensure IPVS required kernel modules are already installed. + +``` +ip_vs +ip_vs_rr +ip_vs_wrr +ip_vs_sh +nf_conntrack_ipv4 +``` + +Finally, for Kubernetes v1.10, feature gate `SupportIPVSProxyMode` is set to `true` by default. For Kubernetes v1.11, the feature gate is entirely removed. However, you need to enable `--feature-gates=SupportIPVSProxyMode=true` explicitly for Kubernetes before v1.10. + +## Get Involved +The simplest way to get involved with Kubernetes is by joining one of the many [Special Interest Groups](https://github.com/kubernetes/community/blob/master/sig-list.md) (SIGs) that align with your interests. Have something you’d like to broadcast to the Kubernetes community? Share your voice at our weekly [community meeting](https://github.com/kubernetes/community/blob/master/communication.md#weekly-meeting), and through the channels below. + +Thank you for your continued feedback and support. +Post questions (or answer questions) on [Stack Overflow](http://stackoverflow.com/questions/tagged/kubernetes) +Join the community portal for advocates on [K8sPort](http://k8sport.org/) +Follow us on Twitter [@Kubernetesio](https://twitter.com/kubernetesio) for latest updates +Chat with the community on [Slack](http://slack.k8s.io/) +Share your Kubernetes [story](https://docs.google.com/a/linuxfoundation.org/forms/d/e/1FAIpQLScuI7Ye3VQHQTwBASrgkjQDSS5TP0g3AXfFhwSM9YpHgxRKFA/viewform) diff --git a/content/en/case-studies/_index.html b/content/en/case-studies/_index.html index 5fcf9337bd417..b96e718d410bd 100644 --- a/content/en/case-studies/_index.html +++ b/content/en/case-studies/_index.html @@ -12,35 +12,34 @@
-
- the new york times -

"I think once you get over the initial hump, things get a lot easier and actually a lot faster."

- - Read about The New York Times +
+ ING +

"The big cloud native promise to our business is the ability to go from idea to production within 48 hours. We are some years away from this, but that’s quite feasible to us."

+ + Read about ING
-
- nordstrom -

"We are always looking for ways to optimize and provide more value through technology. With Kubernetes we are showcasing two types of efficiency that we can bring: Dev efficiency and Ops efficiency. It’s a win-win."

- - Read about Nordstrom +
+ Capital One +

"With the scalability, the management, the coordination, Kubernetes really empowers us and gives us more time back than we had before."

+ + Read about Capital One
- +
- squarespace -

"Once you prove that Kubernetes solves one problem, everyone immediately starts solving other problems without you even having to evangelize it."

- - Read about Squarespace + Northwestern Mutual +

"No one would think a company that’s 160-plus years old is foraying this deep into the cloud and infrastructure stack."

+ + Read about Northwestern Mutual
- Crowdfire -

"In the 15 months that we’ve been using Kubernetes, it has been amazing for us. It enabled us to iterate quickly, increase development speed, and continuously deliver new features and bug fixes to our users, while keeping our operational costs and infrastructure management overhead under control."

- - Read about Crowdfire + openAI +

"Research teams can now take advantage of the frameworks we’ve built on top of Kubernetes, which make it easy to launch experiments, scale them by 10x or 50x, and take little effort to manage."

+ + Read about OpenAI
-
@@ -62,11 +61,15 @@

"Kubernetes has the opportunity to be the new cloud platform. The amount

Kubernetes Users

+ + ING + Capital One + Northwestern Mutual + OpenAI The New York Times Nordstrom Crowdfire Squarespace - Crowdfire Zalando Amadeus Ancestry.com diff --git a/content/en/case-studies/capital-one.html b/content/en/case-studies/capital-one.html new file mode 100644 index 0000000000000..ade270278d385 --- /dev/null +++ b/content/en/case-studies/capital-one.html @@ -0,0 +1,96 @@ +--- +title: Capital One Case Study +case_study_styles: true +cid: caseStudies +css: /css/style_case_studies.css +--- + +
+

CASE STUDY:
Supporting Fast Decisioning Applications with Kubernetes + +

+ +
+ +
+ Company  Capital One     Location  McLean, Virginia     Industry  Retail banking +
+ +
+
+
+
+

Challenge

+ The team set out to build a provisioning platform for Capital One applications deployed on AWS that use streaming, big-data decisioning, and machine learning. One of these applications handles millions of transactions a day; some deal with critical functions like fraud detection and credit decisioning. The key considerations: resilience and speed—as well as full rehydration of the cluster from base AMIs. + +
+

Solution

+ The decision to run Kubernetes "is very strategic for us," says John Swift, Senior Director Software Engineering. "We use Kubernetes as a substrate or an operating system, if you will. There’s a degree of affinity in our product development." +
+ +
+ +

Impact

+ "Kubernetes is a significant productivity multiplier," says Lead Software Engineer Keith Gasser, adding that to run the platform without Kubernetes would "easily see our costs triple, quadruple what they are now for the amount of pure AWS expense." Time to market has been improved as well: "Now, a team can come to us and we can have them up and running with a basic decisioning app in a fortnight, which before would have taken a whole quarter, if not longer." Deployments increased by several orders of magnitude. Plus, the rehydration/cluster-rebuild process, which took a significant part of a day to do manually, now takes a couple hours with Kubernetes automation and declarative configuration. + + +
+ +
+
+
+
+

+"With the scalability, the management, the coordination, Kubernetes really empowers us and gives us more time back than we had before." — Jamil Jadallah, Scrum Master +
+
+
+
+
+

+ As a top 10 U.S. retail bank, Capital One has applications that handle millions of transactions a day. Big-data decisioning—for fraud detection, credit approvals and beyond—is core to the business. To support the teams that build applications with those functions for the bank, the cloud team led by Senior Director Software Engineering John Swift embraced Kubernetes for its provisioning platform. "Kubernetes and its entire ecosystem are very strategic for us," says Swift. "We use Kubernetes as a substrate or an operating system, if you will. There’s a degree of affinity in our product development."

+ Almost two years ago, the team embarked on this journey by first working with Docker. Then came Kubernetes. "We wanted to put streaming services into Kubernetes as one feature of the workloads for fast decisioning, and to be able to do batch alongside it," says Lead Software Engineer Keith Gasser. "Once the data is streamed and batched, there are so many tool sets in Flink that we use for decisioning. We want to provide the tools in the same ecosystem, in a consistent way, rather than have a large custom snowflake ecosystem where every tool needs its own custom deployment. Kubernetes gives us the ability to bring all of these together, so the richness of the open source and even the license community dealing with big data can be corralled." + + + +
+
+
+
+ "We want to provide the tools in the same ecosystem, in a consistent way, rather than have a large custom snowflake ecosystem where every tool needs its own custom deployment. Kubernetes gives us the ability to bring all of these together, so the richness of the open source and even the license community dealing with big data can be corralled." + + +
+
+
+
+ In this first year, the impact has already been great. "Time to market is really huge for us," says Gasser. "Especially with fraud, you have to be very nimble in the way you respond to threats in the marketplace—being able to add and push new rules, detect new patterns of behavior, detect anomalies in account and transaction flows." With Kubernetes, "a team can come to us and we can have them up and running with a basic decisioning app in a fortnight, which before would have taken a whole quarter, if not longer. Kubernetes is a manifold productivity multiplier."

+ Teams now have the tools to be autonomous in their deployments, and as a result, deployments have increased by two orders of magnitude. "And that was with just seven dedicated resources, without needing a whole group sitting there watching everything," says Scrum Master Jamil Jadallah. "That’s a huge cost savings. With the scalability, the management, the coordination, Kubernetes really empowers us and gives us more time back than we had before." + +
+
+
+
+ With Kubernetes, "a team can come to us and we can have them up and running with a basic decisioning app in a fortnight, which before would have taken a whole quarter, if not longer. Kubernetes is a manifold productivity multiplier." +
+
+ +
+
+ Kubernetes has also been a great time-saver for Capital One’s required period "rehydration" of clusters from base AMIs. To minimize the attack vulnerability profile for applications in the cloud, "Our entire clusters get rebuilt from scratch periodically, with new fresh instances and virtual server images that are patched with the latest and greatest security patches," says Gasser. This process used to take the better part of a day, and personnel, to do manually. It’s now a quick Kubernetes job.

+ Savings extend to both capital and operating expenses. "It takes very little to get into Kubernetes because it’s all open source," Gasser points out. "We went the DIY route for building our cluster, and we definitely like the flexibility of being able to embrace the latest from the community immediately without waiting for a downstream company to do it. There’s capex related to those licenses that we don’t have to pay for. Moreover, there’s capex savings for us from some of the proprietary software that we get to sunset in our particular domain. So that goes onto our ledger in a positive way as well." (Some of those open source technologies include Prometheus, Fluentd, gRPC, Istio, CNI, and Envoy.) + +
+ +
+
+ "If we had to do all of this without Kubernetes, on underlying cloud services, I could easily see our costs triple, quadruple what they are now for the amount of pure AWS expense. That doesn’t account for personnel to deploy and maintain all the additional infrastructure." +
+
+ +
+ And on the opex side, Gasser says, the savings are high. "We run dozens of services, we have scores of pods, many daemon sets, and since we’re data-driven, we take advantage of EBS-backed volume claims for all of our stateful services. If we had to do all of this without Kubernetes, on underlying cloud services, I could easily see our costs triple, quadruple what they are now for the amount of pure AWS expense. That doesn’t account for personnel to deploy and maintain all the additional infrastructure."

+ The team is confident that the benefits will continue to multiply—without a steep learning curve for the engineers being exposed to the new technology. "As we onboard additional tenants in this ecosystem, I think the need for folks to understand Kubernetes may not necessarily go up. In fact, I think it goes down, and that’s good," says Gasser. "Because that really demonstrates the scalability of the technology. You start to reap the benefits, and they can concentrate on all the features they need to build for great decisioning in the business— fraud decisions, credit decisions—and not have to worry about, ‘Is my AWS server broken? Is my pod not running?’" +
+ +
diff --git a/content/en/case-studies/ing.html b/content/en/case-studies/ing.html new file mode 100644 index 0000000000000..a3956848070ce --- /dev/null +++ b/content/en/case-studies/ing.html @@ -0,0 +1,94 @@ +--- +title: ING Case Study +case_study_styles: true +cid: caseStudies +css: /css/style_case_studies.css +--- + + +
+

CASE STUDY:
Driving Banking Innovation with Cloud Native +

+ +
+ +
+ Company  ING     Location  Amsterdam, Netherlands +     Industry  Finance +
+ +
+
+
+
+

Challenge

+ After undergoing an agile transformation, ING realized it needed a standardized platform to support the work their developers were doing. "Our DevOps teams got empowered to be autonomous," says Infrastructure Architect Thijs Ebbers. "It has benefits; you get all kinds of ideas. But a lot of teams are going to devise the same wheel. Teams started tinkering with Docker, Docker Swarm, Kubernetes, Mesos. Well, it’s not really useful for a company to have one hundred wheels, instead of one good wheel. +
+
+

Solution

+ Using Kubernetes for container orchestration and Docker for containerization, the ING team began building an internal public cloud for its CI/CD pipeline and green-field applications. The pipeline, which has been built on Mesos Marathon, will be migrated onto Kubernetes. The bank-account management app Yolt in the U.K. (and soon France and Italy) market already is live hosted on a Kubernetes framework. At least two greenfield projects currently on the Kubernetes framework will be going into production later this year. By the end of 2018, the company plans to have converted a number of APIs used in the banking customer experience to cloud native APIs and host these on the Kubernetes-based platform. + +
+
+ +
+
+

Impact

+ "Cloud native technologies are helping our speed, from getting an application to test to acceptance to production," says Infrastructure Architect Onno Van der Voort. "If you walk around ING now, you see all these DevOps teams, doing stand-ups, demoing. They try to get new functionality out there really fast. We held a hackathon for one of our existing components and basically converted it to cloud native within 2.5 days, though of course the tail takes more time before code is fully production ready." +
+
+
+
+
+
+ "The big cloud native promise to our business is the ability to go from idea to production within 48 hours. We are some years away from this, but that’s quite feasible to us."

+ — Thijs Ebbers, Infrastructure Architect, ING +
+
+
+
+

ING has long embraced innovation in banking, launching the internet-based ING Direct in 1997.

In that same spirit, the company underwent an agile transformation a few years ago. "Our DevOps teams got empowered to be autonomous," says Infrastructure Architect Thijs Ebbers. "It has benefits; you get all kinds of ideas. But a lot of teams are going to devise the same wheel. Teams started tinkering with Docker, Docker Swarm, Kubernetes, Mesos. Well, it’s not really useful for a company to have one hundred wheels, instead of one good wheel."

+ Looking to standardize the deployment process within the company’s strict security guidelines, the team looked at several solutions and found that in the past year, "Kubernetes won the container management framework wars," says Ebbers. "We decided to standardize ING on a Kubernetes framework." Everything is run on premise due to banking regulations, he adds, but "we will be building an internal public cloud. We are trying to get on par with what public clouds are doing. That’s one of the reasons we got Kubernetes."

+ They also embraced Docker to address a major pain point in ING’s CI/CD pipeline. Before containerization, "Every development team had to order a VM, and it was quite a heavy delivery model for them," says Infrastructure Architect Onno Van der Voort. "Another use case for containerization is when the application travels through the pipeline, they fire up Docker containers to do test work against the applications and after they’ve done the work, the containers get killed again." + +
+
+
+
+ "We decided to standardize ING on a Kubernetes framework." Everything is run on premise due to banking regulations, he adds, but "we will be building an internal public cloud. We are trying to get on par with what public clouds are doing. That’s one of the reasons we got Kubernetes." + — Thijs Ebbers, Infrastructure Architect, ING +
+
+
+
+ Because of industry regulations, applications are only allowed to go through the pipeline, where compliance is enforced, rather than be deployed directly into a container. "We have to run the complete platform of services we need, many routing from different places," says Van der Voort. "We need this Kubernetes framework for deploying the containers, with all those components, monitoring, logging. It’s complex." For that reason, ING has chosen to start on the OpenShift Origin Kubernetes distribution.

+ Already, "cloud native technologies are helping our speed, from getting an application to test to acceptance to production," says Van der Voort. "If you walk around ING now, you see all these DevOps teams, doing stand-ups, demoing. They try to get new functionality out there really fast. We held a hackathon for one of our existing components and basically converted it to cloud native within 2.5 days, though of course the tail takes more time before code is fully production ready."

+ The pipeline, which has been built on Mesos Marathon, will be migrated onto Kubernetes. Some legacy applications are also being rewritten as cloud native in order to run on the framework. At least two smaller greenfield projects built on Kubernetes will go into production this year. By the end of 2018, the company plans to have converted a number of APIs used in the banking customer experience to cloud native APIs and host these on the Kubernetes-based platform. + +
+
+
+
+ "We have to run the complete platform of services we need, many routing from different places," says Van der Voort. "We need this Kubernetes framework for deploying the containers, with all those components, monitoring, logging. It’s complex." +
+
+ + +
+ The team, however, doesn’t see the bank’s back-end systems going onto the Kubernetes platform. "Our philosophy is it only makes sense to move things to cloud if they are cloud native," says Van der Voort. "If you have traditional architecture, build traditional patterns, it doesn’t hold any value to go to the cloud." Adds Cloud Platform Architect Alfonso Fernandez-Barandiaran: "ING has a strategy about where we will go, in order to improve our agility. So it’s not about how cool this technology is, it’s about finding the right technology and the right approach."

+ The Kubernetes framework will be hosting some greenfield projects that are high priority for ING: applications the company is developing in response to PSD2, the European Commission directive requiring more innovative online and mobile payments that went into effect at the beginning of 2018. For example, a bank-account management app called Yolt, serving the U.K. market (and soon France and Italy), was built on a Kubernetes platform and has gone into production. ING is also developing blockchain-enabled applications that will live on the Kubernetes platform. "We’ve been contacted by a lot of development teams that have ideas with what they want to do with containers," says Ebbers. + +
+
+
+
+Even with the particular requirements that come in banking, ING has managed to take a lead in technology and innovation. "Every time we have constraints, we look for maybe a better way that we can use this technology."
+
+ +
+ Even with the particular requirements that come in banking, ING has managed to take a lead in technology and innovation. "Every time we have constraints, we look for maybe a better way that we can use this technology," says Fernandez-Barandiaran.

+ The results, after all, are worth the effort. "The big cloud native promise to our business is the ability to go from idea to production within 48 hours," says Ebbers. "That would require all these projects to be mature. We are some years away from this, but that’s quite feasible to us." + +
+ +
diff --git a/content/en/case-studies/newyorktimes.html b/content/en/case-studies/newyorktimes.html index 1236bdd269986..c65b5fe88355f 100644 --- a/content/en/case-studies/newyorktimes.html +++ b/content/en/case-studies/newyorktimes.html @@ -5,15 +5,14 @@ css: /css/style_case_studies.css --- -
-

CASE STUDY:
The New York Times: From Print to the Web to Cloud Native - +
+

CASE STUDY:
The New York Times: From Print to the Web to Cloud Native

-
+
Company  New York Times     Location  New York, N.Y.      Industry  News Media
@@ -25,7 +24,7 @@

CASE STUDY:
Challenge

When the company decided a few years ago to move out of its data centers, its first deployments on the public cloud were smaller, less critical applications managed on virtual machines. "We started building more and more tools, and at some point we realized that we were doing a disservice by treating Amazon as another data center," says Deep Kapadia, Executive Director, Engineering at The New York Times. Kapadia was tapped to lead a Delivery Engineering Team that would "design for the abstractions that cloud providers offer us." -
+

Solution

The team decided to use Google Cloud Platform and its Kubernetes-as-a-service offering, GKE.
@@ -40,14 +39,20 @@

Impact

-
-
- - -
-
- "I think once you get over the initial hump, things get a lot easier and actually a lot faster." — Deep Kapadia, Executive Director, Engineering at The New York Times
+
+
+
+ +
+
+
+

+
+
+
+ "I think once you get over the initial hump, things get a lot easier and actually a lot faster." — Deep Kapadia, Executive Director, Engineering at The New York Times
+
diff --git a/content/en/case-studies/northwestern-mutual.html b/content/en/case-studies/northwestern-mutual.html new file mode 100644 index 0000000000000..dac0ef0d66d55 --- /dev/null +++ b/content/en/case-studies/northwestern-mutual.html @@ -0,0 +1,99 @@ +--- +title: Northwestern Mutual Case Study +case_study_styles: true +cid: caseStudies +css: /css/style_case_studies.css +--- + +
+

CASE STUDY:
Cloud Native at Northwestern Mutual + + +

+ +
+ +
+ Company  Northwestern Mutual     Location  Milwaukee, WI     Industry  Insurance and Financial Services +
+ +
+
+
+
+

Challenge

+ In the spring of 2015, Northwestern Mutual acquired a fintech startup, LearnVest, and decided to take "Northwestern Mutual’s leading products and services and meld it with LearnVest’s digital experience and innovative financial planning platform," says Brad Williams, Director of Engineering for Client Experience, Northwestern Mutual. The company’s existing infrastructure had been optimized for batch workflows hosted on on-prem networks; deployments were very traditional, focused on following a process instead of providing deployment agility. "We had to build a platform that was elastically scalable, but also much more responsive, so we could quickly get data to the client website so our end-customers have the experience they expect," says Williams. +
+

Solution

+ The platform team came up with a plan for using the public cloud (AWS), Docker containers, and Kubernetes for orchestration. "Kubernetes gave us that base framework so teams can be very autonomous in what they’re building and deliver very quickly and frequently," says Northwestern Mutual Cloud Native Engineer Frank Greco Jr. The team also built and open-sourced Kanali, a Kubernetes-native API management tool that uses OpenTracing, Jaeger, and gRPC. + + +
+ +
+ +

Impact

+ Before, infrastructure deployments could take weeks; now, it is done in a matter of minutes. The number of deployments has increased dramatically, from about 24 a year to over 500 in just the first 10 months of 2017. Availability has also increased: There used to be a six-hour control window for commits every Sunday morning, as well as other periods of general maintenance, during which outages could happen. "Now we have eliminated the planned outage windows," says Bryan Pfremmer, App Platform Teams Manager, Northwestern Mutual. Kanali has had an impact on the bottom line. The vendor API management product that the company previously used required 23 servers, "dedicated, to only API management," says Pfremmer. "Now it’s all integrated in the existing stack and running as another deployment on Kubernetes. And that’s just one environment. Between the three that we had plus the test, that’s hard dollar savings." +
+
+ +
+
+
+
+"In a large enterprise, you’re going to have people using Kubernetes, but then you’re also going to have people using WAS and .NET. You may not be at a point where your whole stack can be cloud native. What if you can take your API management tool and make it cloud native, but still proxy to legacy systems? Using different pieces that are cloud native, open source and Kubernetes native, you can do pretty innovative stuff." — Frank Greco Jr., Cloud Native Engineer at Northwestern Mutual
+
+
+
+

For more than 160 years, Northwestern Mutual has maintained its industry leadership in part by keeping a strong focus on risk management.

+ For many years, the company took a similar approach to managing its technology and has recently undergone a digital transformation to advance the company’s digital strategy - including making a lot of noise in the cloud-native world.

+In the spring of 2015, this insurance and financial services company acquired a fintech startup, LearnVest, and decided to take "Northwestern Mutual’s leading products and services and meld it with LearnVest’s digital experience and innovative financial planning platform," says Brad Williams, Director of Engineering for Client Experience, Northwestern Mutual. The company’s existing infrastructure had been optimized for batch workflows hosted on an on-premise datacenter; deployments were very traditional and had to many manual steps that were error prone.

+In order to give the company’s 4.5 million clients the digital experience they’d come to expect, says Williams, "We had to build a platform that was elastically scalable, but also much more responsive, so we could quickly get data to the client website. We essentially said, 'You build the system that you think is necessary to support a new, modern-facing one.’ That’s why we departed from anything legacy." + + +
+
+
+
+ "Kubernetes has definitely been the right choice for us. It gave us that base framework so teams can be autonomous in what they’re building and deliver very quickly and frequently." + +
+
+
+
+ Williams and the rest of the platform team decided that the first step would be to start moving from private data centers to AWS. With a new microservice architecture in mind—and the freedom to implement what was best for the organization—they began using Docker containers. After looking into the various container orchestration options, they went with Kubernetes, even though it was still in beta at the time. "There was some debate whether we should build something ourselves, or just leverage that product and evolve with it," says Northwestern Mutual Cloud Native Engineer Frank Greco Jr. "Kubernetes has definitely been the right choice for us. It gave us that base framework so teams can be autonomous in what they’re building and deliver very quickly and frequently."

+As early adopters, the team had to do a lot of work with Ansible scripts to stand up the cluster. "We had a lot of hard security requirements given the nature of our business," explains Bryan Pfremmer, App Platform Teams Manager, Northwestern Mutual. "We found ourselves running a configuration that very few other people ever tried." The client experience group was the first to use the new platform; today, a few hundred of the company’s 1,500 engineers are using it and more are eager to get on board. +The results have been dramatic. Before, infrastructure deployments could take two weeks; now, it is done in a matter of minutes. Now with a focus on Infrastructure automation, and self-service, "You can take an app to production in that same day if you want to," says Pfremmer. + + +
+
+
+
+"Now, developers have autonomy, they can use this whenever they want, however they want. It becomes more valuable the more instrumentation downstream that happens, as we mature in it." +
+
+ +
+
+ The process used to be so cumbersome that minor bug releases would be bundled with feature releases. With the new streamlined system enabled by Kubernetes, the number of deployments has increased from about 24 a year to more than 500 in just the first 10 months of 2017. Availability has also been improved: There used to be a six-hour control window for commits every early Sunday morning, as well as other periods of general maintenance, during which outages could happen. "Now there’s no planned outage window," notes Pfremmer.

+Northwestern Mutual built that API management tool—called Kanali—and open sourced it in the summer of 2017. The team took on the project because it was a key capability for what they were building and prior the solution worked in an "anti-cloud native way that was different than everything else we were doing," says Greco. Now API management is just another container deployed to Kubernetes along with a separate Jaeger deployment.

+Now the engineers using the Kubernetes deployment platform have the added benefit of visibility in production—and autonomy. Before, a centralized team and would have to run a trace. "Now, developers have autonomy, they can use this whenever they want, however they want. It becomes more valuable the more instrumentation downstream that happens, as we mature in it." says Greco. + + +
+ +
+
+ "We’re trying to make what we’re doing known so that we can find people who are like, 'Yeah, that’s interesting. I want to come do it!’" +
+
+ +
+ But the team didn’t stop there. "In a large enterprise, you’re going to have people using Kubernetes, but then you’re also going to have people using WAS and .NET," says Greco. "You may not be at a point where your whole stack can be cloud native. What if you can take your API management tool and make it cloud native, but still proxy to legacy systems? Using different pieces that are cloud native, open source and Kubernetes native, you can do pretty innovative stuff."

+ As the team continues to improve its stack and share its Kubernetes best practices, it feels that Northwestern Mutual’s reputation as a technology-first company is evolving too. "No one would think a company that’s 160-plus years old is foraying this deep into the cloud and infrastructure stack," says Pfremmer. And they’re hoping that means they’ll be able to attract new talent. "We’re trying to make what we’re doing known so that we can find people who are like, 'Yeah, that’s interesting. I want to come do it!’" + + +
+ +
diff --git a/content/en/case-studies/openAI.html b/content/en/case-studies/openAI.html new file mode 100644 index 0000000000000..4814ce6fdbe9e --- /dev/null +++ b/content/en/case-studies/openAI.html @@ -0,0 +1,99 @@ +--- +title: OpenAI Case Study +case_study_styles: true +cid: caseStudies +css: /css/style_case_studies.css +--- + +
+

CASE STUDY:
Launching and Scaling Up Experiments, Made Simple + +

+ +
+ +
+ Company  OpenAI     Location  San Francisco, California     Industry  Artificial Intelligence Research +
+ +
+
+
+
+

Challenge

+ An artificial intelligence research lab, OpenAI needed infrastructure for deep learning that would allow experiments to be run either in the cloud or in its own data center, and to easily scale. Portability, speed, and cost were the main drivers. +
+

Solution

+ OpenAI began running Kubernetes on top of AWS in 2016, and in early 2017 migrated to Azure. OpenAI runs key experiments in fields including robotics and gaming both in Azure and in its own data centers, depending on which cluster has free capacity. "We use Kubernetes mainly as a batch scheduling system and rely on our autoscaler to dynamically scale up and down our cluster," says Christopher Berner, Head of Infrastructure. "This lets us significantly reduce costs for idle nodes, while still providing low latency and rapid iteration." +
+ +
+ +

Impact

+ The company has benefited from greater portability: "Because Kubernetes provides a consistent API, we can move our research experiments very easily between clusters," says Berner. Being able to use its own data centers when appropriate is "lowering costs and providing us access to hardware that we wouldn’t necessarily have access to in the cloud," he adds. "As long as the utilization is high, the costs are much lower there." Launching experiments also takes far less time: "One of our researchers who is working on a new distributed training system has been able to get his experiment running in two or three days. In a week or two he scaled it out to hundreds of GPUs. Previously, that would have easily been a couple of months of work." + + +
+ +
+
+
+
+ +
+
+Check out "Building the Infrastructure that Powers the Future of AI" presented by Vicki Cheung, Member of Technical Staff & Jonas Schneider, Member of Technical Staff at OpenAI from KubeCon/CloudNativeCon Europe 2017. +
+
+
+
+
+

From experiments in robotics to old-school video game play research, OpenAI’s work in artificial intelligence technology is meant to be shared.

+ With a mission to ensure powerful AI systems are safe, OpenAI cares deeply about open source—both benefiting from it and contributing safety technology into it. "The research that we do, we want to spread it as widely as possible so everyone can benefit," says OpenAI’s Head of Infrastructure Christopher Berner. The lab’s philosophy—as well as its particular needs—lent itself to embracing an open source, cloud native strategy for its deep learning infrastructure.

+ OpenAI started running Kubernetes on top of AWS in 2016, and a year later, migrated the Kubernetes clusters to Azure. "We probably use Kubernetes differently from a lot of people," says Berner. "We use it for batch scheduling and as a workload manager for the cluster. It’s a way of coordinating a large number of containers that are all connected together. We rely on our autoscaler to dynamically scale up and down our cluster. This lets us significantly reduce costs for idle nodes, while still providing low latency and rapid iteration."

+ In the past year, Berner has overseen the launch of several Kubernetes clusters in OpenAI’s own data centers. "We run them in a hybrid model where the control planes—the Kubernetes API servers, etcd and everything—are all in Azure, and then all of the Kubernetes nodes are in our own data center," says Berner. "The cloud is really convenient for managing etcd and all of the masters, and having backups and spinning up new nodes if anything breaks. This model allows us to take advantage of lower costs and have the availability of more specialized hardware in our own data center." + + +
+
+
+
+ OpenAI’s experiments take advantage of Kubernetes’ benefits, including portability. "Because Kubernetes provides a consistent API, we can move our research experiments very easily between clusters..." + +
+
+
+
+ Different teams at OpenAI currently run a couple dozen projects. While the largest-scale workloads manage bare cloud VMs directly, most of OpenAI’s experiments take advantage of Kubernetes’ benefits, including portability. "Because Kubernetes provides a consistent API, we can move our research experiments very easily between clusters," says Berner. The on-prem clusters are generally "used for workloads where you need lots of GPUs, something like training an ImageNet model. Anything that’s CPU heavy, that’s run in the cloud. But we also have a number of teams that run their experiments both in Azure and in our own data centers, just depending on which cluster has free capacity, and that’s hugely valuable."

+ Berner has made the Kubernetes clusters available to all OpenAI teams to use if it’s a good fit. "I’ve worked a lot with our games team, which at the moment is doing research on classic console games," he says. "They had been running a bunch of their experiments on our dev servers, and they had been trying out Google cloud, managing their own VMs. We got them to try out our first on-prem Kubernetes cluster, and that was really successful. They’ve now moved over completely to it, and it has allowed them to scale up their experiments by 10x, and do that without needing to invest significant engineering time to figure out how to manage more machines. A lot of people are now following the same path." + +
+
+
+
+"One of our researchers who is working on a new distributed training system has been able to get his experiment running in two or three days," says Berner. "In a week or two he scaled it out to hundreds of GPUs. Previously, that would have easily been a couple of months of work." +
+
+ +
+
+ That path has been simplified by frameworks and tools that two of OpenAI’s teams have developed to handle interaction with Kubernetes. "You can just write some Python code, fill out a bit of configuration with exactly how many machines you need and which types, and then it will prepare all of those specifications and send it to the Kube cluster so that it gets launched there," says Berner. "And it also provides a bit of extra monitoring and better tooling that’s designed specifically for these machine learning projects."

+ The impact that Kubernetes has had at OpenAI is impressive. With Kubernetes, the frameworks and tooling, including the autoscaler, in place, launching experiments takes far less time. "One of our researchers who is working on a new distributed training system has been able to get his experiment running in two or three days," says Berner. "In a week or two he scaled it out to hundreds of GPUs. Previously, that would have easily been a couple of months of work."

+ Plus, the flexibility they now have to use their on-prem Kubernetes cluster when appropriate is "lowering costs and providing us access to hardware that we wouldn’t necessarily have access to in the cloud," he says. "As long as the utilization is high, the costs are much lower in our data center. To an extent, you can also customize your hardware to exactly what you need." + + +
+ +
+
+ "Research teams can now take advantage of the frameworks we’ve built on top of Kubernetes, which make it easy to launch experiments, scale them by 10x or 50x, and take little effort to manage."
— CHRISTOPHER BERNER, HEAD OF INFRASTRUCTURE FOR OPENAI +
+
+ +
+ + OpenAI is also benefiting from other technologies in the CNCF cloud-native ecosystem. gRPC is used by many of its systems for communications between different services, and Prometheus is in place "as a debugging tool if things go wrong," says Berner. "We actually haven’t had any real problems in our Kubernetes clusters recently, so I don’t think anyone has looked at our Prometheus monitoring in a while. If something breaks, it will be there."

+ One of the things Berner continues to focus on is Kubernetes’ ability to scale, which is essential to deep learning experiments. OpenAI has been able to push one of its Kubernetes clusters on Azure up to more than 2,500 nodes. "I think we’ll probably hit the 5,000-machine number that Kubernetes has been tested at before too long," says Berner, adding, "We’re definitely hiring if you’re excited about working on these things!" +
+ +
diff --git a/content/en/code-of-conduct.md b/content/en/code-of-conduct.md deleted file mode 100644 index 0d15c00cf3252..0000000000000 --- a/content/en/code-of-conduct.md +++ /dev/null @@ -1,3 +0,0 @@ -# Kubernetes Community Code of Conduct - -Please refer to our [Kubernetes Community Code of Conduct](https://git.k8s.io/community/code-of-conduct.md) diff --git a/content/en/community/_index.html b/content/en/community/_index.html index 96845f4029ff4..807faa6565fe7 100644 --- a/content/en/community/_index.html +++ b/content/en/community/_index.html @@ -8,7 +8,7 @@

Ensuring Kubernetes works well everywhere and for everyone.

-

Connect with the Kubernetes community on our Slack channel or join the +

Connect with the Kubernetes community on our Slack channel, discussion board, or join the Kubernetes-dev Google group. A weekly community meeting takes place via video conference to discuss the state of affairs, see these instructions for information @@ -38,6 +38,17 @@

Events

frameborder="0" scrolling="no">
--> +
+

Code of Conduct

+

The Kubernetes community values respect and inclusiveness, and + enforces a Code of Conduct in all + interactions. If you notice a violation of the Code of Conduct at + an event or meeting, in Slack, or in another communication + mechanism, reach out to the + steering committee. + Your anonymity will be protected.

+

+

diff --git a/content/en/community/code-of-conduct.md b/content/en/community/code-of-conduct.md new file mode 100644 index 0000000000000..3defdd4b72845 --- /dev/null +++ b/content/en/community/code-of-conduct.md @@ -0,0 +1,28 @@ +--- +title: Community +layout: basic +cid: community +css: /css/community.css +--- + +
+

Kubernetes Community Code of Conduct

+ +Kubernetes follows the +CNCF Code of Conduct. +The text of the CNCF CoC is replicated below, as of +commit 0ce4694. +If you notice that this is out of date, please +file an issue. + +If you notice a violation of the Code of Conduct at an event or meeting, in +Slack, or in another communication mechanism, reach out to the +steering committee. Your +anonymity will be protected. + +
+{{< include "/static/cncf-code-of-conduct.md" >}} +
+
+ + diff --git a/content/en/community/static/README.md b/content/en/community/static/README.md new file mode 100644 index 0000000000000..ef8e8d5a3e6bc --- /dev/null +++ b/content/en/community/static/README.md @@ -0,0 +1,2 @@ +The files in this directory have been imported from other sources. Do not +edit them directly, except by replacing them with new versions. \ No newline at end of file diff --git a/content/en/community/static/cncf-code-of-conduct.md b/content/en/community/static/cncf-code-of-conduct.md new file mode 100644 index 0000000000000..e332919bca026 --- /dev/null +++ b/content/en/community/static/cncf-code-of-conduct.md @@ -0,0 +1,45 @@ + +## CNCF Community Code of Conduct v1.0 + +### Contributor Code of Conduct + +As contributors and maintainers of this project, and in the interest of fostering +an open and welcoming community, we pledge to respect all people who contribute +through reporting issues, posting feature requests, updating documentation, +submitting pull requests or patches, and other activities. + +We are committed to making participation in this project a harassment-free experience for +everyone, regardless of level of experience, gender, gender identity and expression, +sexual orientation, disability, personal appearance, body size, race, ethnicity, age, +religion, or nationality. + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery +* Personal attacks +* Trolling or insulting/derogatory comments +* Public or private harassment +* Publishing other's private information, such as physical or electronic addresses, + without explicit permission +* Other unethical or unprofessional conduct. + +Project maintainers have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are not +aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers +commit themselves to fairly and consistently applying these principles to every aspect +of managing this project. Project maintainers who do not follow or enforce the Code of +Conduct may be permanently removed from the project team. + +This code of conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a CNCF project maintainer, Sarah Novotny , and/or Dan Kohn . + +This Code of Conduct is adapted from the Contributor Covenant +(http://contributor-covenant.org), version 1.2.0, available at +http://contributor-covenant.org/version/1/2/0/ + +### CNCF Events Code of Conduct + +CNCF events are governed by the Linux Foundation [Code of Conduct](http://events.linuxfoundation.org/events/cloudnativecon/attend/code-of-conduct) available on the event page. This is designed to be compatible with the above policy and also includes more details on responding to incidents. diff --git a/content/en/docs/admin/federation/OWNERS b/content/en/docs/admin/federation/OWNERS deleted file mode 100644 index 8284752efaf77..0000000000000 --- a/content/en/docs/admin/federation/OWNERS +++ /dev/null @@ -1,5 +0,0 @@ -reviewers: -- madhusudancs -- mml -- nikhiljindal - diff --git a/content/en/docs/admin/federation/_index.md b/content/en/docs/admin/federation/_index.md deleted file mode 100644 index 73e8963e38049..0000000000000 --- a/content/en/docs/admin/federation/_index.md +++ /dev/null @@ -1,389 +0,0 @@ ---- -reviewers: -- madhusudancs -- mml -- nikhiljindal -title: (Deprecated) Using `federation-up` and `deploy.sh` -toc_hide: true ---- - -## The mechanisms explained in this doc to setup federation are deprecated. [`kubefed`](/docs/tasks/federation/set-up-cluster-federation-kubefed/) is now the recommended way to deploy federation. - -This guide explains how to set up cluster federation that lets us control multiple Kubernetes clusters. - - -{{< toc >}} - -## Prerequisites - -This guide assumes that you have a running Kubernetes cluster. -If you need to start a new cluster, see the [getting started guides](/docs/setup/) for instructions on bringing a cluster up. - -To use the commands in this guide, you must download a Kubernetes release from the -[getting started binary releases](/docs/getting-started-guides/binary_release/) and -extract into a directory; all the commands in this guide are run from -that directory. - -```shell -$ curl -L https://github.com/kubernetes/kubernetes/releases/download/v1.4.0/kubernetes.tar.gz | tar xvzf - -$ cd kubernetes -``` - -You must also have a Docker installation running -locally--meaning on the machine where you run the commands described in this -guide. - -## Setting up a federation control plane - -Setting up federation requires running the federation control plane which -consists of etcd, federation-apiserver (via the hyperkube binary) and -federation-controller-manager (also via the hyperkube binary). You can run -these binaries as pods on an existing Kubernetes cluster. - -Note: This is a new mechanism to turn up Kubernetes Cluster Federation. If -you want to follow the old mechanism, please refer to the section -[Previous Federation turn up mechanism](#previous-federation-turn-up-mechanism) -at the end of this guide. - -### Initial setup - -Create a directory to store the configs required to turn up federation -and export that directory path in the environment variable -`FEDERATION_OUTPUT_ROOT`. This can be an existing directory, but it is -highly recommended to create a separate directory so that it is easier -to clean up later. - -```shell -$ export FEDERATION_OUTPUT_ROOT="${PWD}/_output/federation" -$ mkdir -p "${FEDERATION_OUTPUT_ROOT}" -``` - -Initialize the setup. - -```shell -$ federation/deploy/deploy.sh init -``` - -Optionally, you can create/edit `${FEDERATION_OUTPUT_ROOT}/values.yaml` to -customize any value in -[federation/federation/manifests/federation/values.yaml](https://github.com/madhusudancs/kubernetes-anywhere/blob/federation/federation/manifests/federation/values.yaml). Example: - -```yaml -apiserverRegistry: "gcr.io/myrepository" -apiserverVersion: "v1.5.0-alpha.0.1010+892a6d7af59c0b" -controllerManagerRegistry: "gcr.io/myrepository" -controllerManagerVersion: "v1.5.0-alpha.0.1010+892a6d7af59c0b" -``` - -Assuming you have built and pushed the `hyperkube` image to the repository -with the given tag in the example above. - -### Getting images - -To run the federation control plane components as pods, you first need the -images for all the components. You can either use the official release -images or you can build them yourself from HEAD. - -### Using official release images - -As part of every Kubernetes release, official release images are pushed to -`k8s.gcr.io`. To use the images in this repository, you can -set the container image fields in the following configs to point to the -images in this repository. `k8s.gcr.io/hyperkube` image -includes the federation-apiserver and federation-controller-manager -binaries, so you can point the corresponding configs for those components -to the hyperkube image. - -### Building and pushing images from HEAD - -To build the binaries, check out the -[Kubernetes repository](https://github.com/kubernetes/kubernetes) and -run the following commands from the root of the source directory: - - -```shell -$ federation/develop/develop.sh build_binaries -``` - -To build the image and push it to the repository, run: - -```shell -$ KUBE_REGISTRY="gcr.io/myrepository" federation/develop/develop.sh build_image -$ KUBE_REGISTRY="gcr.io/myrepository" federation/develop/develop.sh push -``` - -Note: This is going to overwrite the values you might have set for -`apiserverRegistry`, `apiserverVersion`, `controllerManagerRegistry` and -`controllerManagerVersion` in your `${FEDERATION_OUTPUT_ROOT}/values.yaml` -file. Hence, it is not recommended to customize these values in -`${FEDERATION_OUTPUT_ROOT}/values.yaml` if you are building the -images from source. - -### Running the federation control plane - -Once you have the images, you can turn up the federation control plane by -running: - -```shell -$ federation/deploy/deploy.sh deploy_federation -``` - -This spins up the federation control components as pods managed by -[`Deployments`](/docs/concepts/workloads/controllers/deployment/) on your -existing Kubernetes cluster. It also starts a -[`type: LoadBalancer`](/docs/concepts/services-networking/service/#type-loadbalancer) -[`Service`](/docs/concepts/services-networking/service/) for the -`federation-apiserver` and a -[`PVC`](/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims/) backed -by a dynamically provisioned -[`PV`](/docs/concepts/storage/persistent-volumes/) for - `etcd`. All these components are created in the `federation` namespace. - -You can verify that the pods are available by running the following -command: - -```shell -$ kubectl get deployments --namespace=federation -NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE -federation-apiserver 1 1 1 1 1m -federation-controller-manager 1 1 1 1 1m -``` - -Running `deploy.sh` also creates a new record in your kubeconfig for us -to be able to talk to federation apiserver. You can view this by running -`kubectl config view`. - -Note: Dynamic provisioning for persistent volume currently works only on -AWS, Google Kubernetes Engine, and GCE. However, you can edit the created `Deployments` to suit -your needs, if required. - -## Registering Kubernetes clusters with federation - -Now that you have the federation control plane up and running, you can start registering Kubernetes clusters. - -First of all, you need to create a secret containing kubeconfig for that Kubernetes cluster, which federation control plane will use to talk to that Kubernetes cluster. -For now, you can create this secret in the host Kubernetes cluster (that hosts federation control plane). When federation starts supporting secrets, you will be able to create this secret there. -Suppose that your kubeconfig for Kubernetes cluster is at `/cluster1/kubeconfig`, you can run the following command to create the secret: - -```shell -$ kubectl create secret generic cluster1 --namespace=federation --from-file=/cluster1/kubeconfig -``` - -Note that the file name should be `kubeconfig` since file name determines the name of the key in the secret. - -Now that the secret is created, you are ready to register the cluster. The YAML file for cluster will look like: - -```yaml -apiVersion: federation/v1beta1 -kind: Cluster -metadata: - name: cluster1 -spec: - serverAddressByClientCIDRs: - - clientCIDR: - serverAddress: - secretRef: - name: -``` - -You need to insert the appropriate values for ``, `` and ``. -`` here is name of the secret that you just created. -serverAddressByClientCIDRs contains the various server addresses that clients -can use as per their CIDR. You can set the server's public IP address with CIDR -`"0.0.0.0/0"` which all clients will match. In addition, if you want internal -clients to use server's clusterIP, you can set that as serverAddress. The client -CIDR in that case will be a CIDR that only matches IPs of pods running in that -cluster. - -Assuming your YAML file is located at `/cluster1/cluster.yaml`, you can run the following command to register this cluster: - - -```shell -$ kubectl create -f /cluster1/cluster.yaml --context=federation-cluster - -``` - -By specifying `--context=federation-cluster`, you direct the request to -federation apiserver. You can ensure that the cluster registration was -successful by running: - -```shell -$ kubectl get clusters --context=federation-cluster -NAME STATUS VERSION AGE -cluster1 Ready 3m -``` - -## Updating KubeDNS - -Once you've registered your cluster with the federation, you'll need to update KubeDNS so that your cluster can route federation service requests. The update method varies depending on your Kubernetes version; on Kubernetes 1.5 or later, you must pass the -`--federations` flag to kube-dns via the kube-dns config map. In version 1.4 or earlier, you must set the `--federations` flag directly on kube-dns-rc on other clusters. - -### Kubernetes 1.5+: Passing federations flag via config map to kube-dns - -For Kubernetes clusters of version 1.5+, you can pass the -`--federations` flag to kube-dns via the kube-dns config map. -The flag uses the following format: - -``` ---federations=${FEDERATION_NAME}=${DNS_DOMAIN_NAME} -``` - -To pass this flag to KubeDNS, create a config-map with name `kube-dns` in -namespace `kube-system`. The configmap should look like the following: - -```yaml -apiVersion: v1 -kind: ConfigMap -metadata: - name: kube-dns - namespace: kube-system -data: - federations: = -``` - -where `` should be replaced by the name you want to give to your -federation, and -`federation-domain-name` should be replaced by the domain name you want to use -in your federation DNS. - -You can find more details about config maps in general at -[config map](/docs/tasks/configure-pod-container/configure-pod-configmap/). - -### Kubernetes 1.4 and earlier: Setting federations flag on kube-dns-rc - -If your cluster is running Kubernetes version 1.4 or earlier, you must restart -KubeDNS and pass it a `--federations` flag, which tells it about valid federation DNS hostnames. -The flag uses the following format: - -``` ---federations=${FEDERATION_NAME}=${DNS_DOMAIN_NAME} -``` - -To update KubeDNS with the `--federations` flag, you can edit the existing kubedns replication controller to -include that flag in pod template spec, and then delete the existing pod. The replication controller then -recreates the pod with updated template. - -To find the name of existing kubedns replication controller, run the following command: - -```shell -$ kubectl get rc --namespace=kube-system -``` - -You should see a list of all the replication controllers on the cluster. The kube-dns replication -controller should have a name similar to `kube-dns-v18`. To edit the replication controller, specify it by name as follows: - -```shell -$ kubectl edit rc --namespace=kube-system -``` -In the resulting YAML file for the kube-dns replication controller, add the `--federations` flag as an argument to kube-dns container. - -Then, you must delete the existing kube dns pod. You can find the pod by running: - -```shell -$ kubectl get pods --namespace=kube-system -``` - -And then delete the appropriate pod by running: - -```shell -$ kubectl delete pods --namespace=kube-system -``` - -Once you've completed the kube-dns configuration, your federation is ready for use. - -## Turn down - -In order to turn the federation control plane down run the following -command: - -```shell -$ federation/deploy/deploy.sh destroy_federation -``` - -## Previous Federation turn up mechanism - -This describes the previous mechanism we had to turn up Kubernetes Cluster -Federation. It is recommended to use the new turn up mechanism. If you would -like to use this mechanism instead of the new one, please let us know -why the new mechanism doesn't work for your case by filing an issue here - -[https://github.com/kubernetes/kubernetes/issues/new](https://github.com/kubernetes/kubernetes/issues/new) - -### Getting images - -To run these as pods, you first need images for all the components. You can use -official release images or you can build from HEAD. - -#### Using official release images - -As part of every release, images are pushed to `staging-k8s.gcr.io`, which are -re-published through `k8s.gcr.io` (which is globally replicated). To use -these images, set env var `FEDERATION_PUSH_REPO_BASE=k8s.gcr.io` -This will always use the latest image. -To use the hyperkube image which includes federation-apiserver and -federation-controller-manager from a specific release, set the -`FEDERATION_IMAGE_TAG` environment variable. - -#### Building and pushing images from HEAD - -To run the code from HEAD, you need to build and push your own images. -You can build the images using the following command: - -```shell -$ FEDERATION=true KUBE_RELEASE_RUN_TESTS=n make quick-release -``` - -Next, you need to push these images to a registry such as Google Container Registry or Docker Hub, so that your cluster can pull them. -If Kubernetes cluster is running on Google Compute Engine (GCE), then you can push the images to `gcr.io/`. -The command to push the images will look like: - -```shell -$ FEDERATION=true FEDERATION_PUSH_REPO_BASE=gcr.io/ ./build/push-federation-images.sh -``` - -### Running the federation control plane - -Once you have the images, you can run these as pods on your existing kubernetes cluster. -The command to run these pods on an existing GCE cluster will look like: - -```shell -$ KUBERNETES_PROVIDER=gce FEDERATION_DNS_PROVIDER=google-clouddns FEDERATION_NAME=myfederation DNS_ZONE_NAME=myfederation.example FEDERATION_PUSH_REPO_BASE=k8s.gcr.io ./federation/cluster/federation-up.sh -``` - -`KUBERNETES_PROVIDER` is the cloud provider. - -`FEDERATION_DNS_PROVIDER` can be `google-clouddns` or `aws-route53`. It will be -set appropriately if it is missing and `KUBERNETES_PROVIDER` is one of `gce`, `gke` and `aws`. -This is used to resolve DNS requests for federation services. The service -controller keeps DNS records with the provider updated as services/pods are -updated in underlying Kubernetes clusters. - -`FEDERATION_NAME` is a name you can choose for your federation. This is the name that will appear in DNS routes. - -`DNS_ZONE_NAME` is the domain to be used for DNS records. This is a domain that you -need to buy and then configure it such that DNS queries for that domain are -routed to the appropriate provider as per `FEDERATION_DNS_PROVIDER`. - -Running that command creates a namespace `federation` and creates 2 deployments: `federation-apiserver` and `federation-controller-manager`. -You can verify that the pods are available by running the following command: - -```shell -$ kubectl get deployments --namespace=federation -NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE -federation-apiserver 1 1 1 1 1m -federation-controller-manager 1 1 1 1 1m -``` - -Running `federation-up.sh` also creates a new record in your kubeconfig for us -to be able to talk to federation apiserver. You can view this by running -`kubectl config view`. - -Note: `federation-up.sh` creates the federation-apiserver pod with an etcd -container that is backed by a persistent volume, so as to persist data. This -currently works only on AWS, Google Kubernetes Engine, and GCE. You can edit -`federation/manifests/federation-apiserver-deployment.yaml` to suit your needs, -if required. - - -## For more information - - * [Federation proposal](https://git.k8s.io/community/contributors/design-proposals/multicluster/federation.md) details use cases that motivated this work. diff --git a/content/en/docs/concepts/architecture/cloud-controller.md b/content/en/docs/concepts/architecture/cloud-controller.md index b83dc23124ae0..eae58ff8b85f3 100644 --- a/content/en/docs/concepts/architecture/cloud-controller.md +++ b/content/en/docs/concepts/architecture/cloud-controller.md @@ -1,9 +1,10 @@ --- title: Concepts Underlying the Cloud Controller Manager +content_template: templates/concept weight: 30 --- -## Cloud Controller Manager +{{% capture overview %}} The cloud controller manager (CCM) concept (not to be confused with the binary) was originally created to allow cloud specific vendor code and the Kubernetes core to evolve independent of one another. The cloud controller manager runs alongside other master components such as the Kubernetes controller manager, the API server, and scheduler. It can also be started as a Kubernetes addon, in which case it runs on top of Kubernetes. @@ -15,6 +16,12 @@ Here's the architecture of a Kubernetes cluster without the cloud controller man ![Pre CCM Kube Arch](/images/docs/pre-ccm-arch.png) +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ## Design In the preceding diagram, Kubernetes and the cloud provider are integrated through several different components: @@ -254,3 +261,5 @@ The following cloud providers have implemented CCMs: Complete instructions for configuring and running the CCM are provided [here](/docs/tasks/administer-cluster/running-cloud-controller/#cloud-controller-manager). + +{{% /capture %}} diff --git a/content/en/docs/concepts/architecture/master-node-communication.md b/content/en/docs/concepts/architecture/master-node-communication.md index 7b95443abd899..cdec599b1f2bc 100644 --- a/content/en/docs/concepts/architecture/master-node-communication.md +++ b/content/en/docs/concepts/architecture/master-node-communication.md @@ -4,12 +4,11 @@ reviewers: - roberthbailey - liggitt title: Master-Node communication +content_template: templates/concept weight: 20 --- -{{< toc >}} - -## Overview +{{% capture overview %}} This document catalogs the communication paths between the master (really the apiserver) and the Kubernetes cluster. The intent is to allow users to @@ -17,6 +16,12 @@ customize their installation to harden the network configuration such that the cluster can be run on an untrusted network (or on fully public IPs on a cloud provider). +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ## Cluster -> Master All communication paths from the cluster to the master terminate at the @@ -33,8 +38,8 @@ Nodes should be provisioned with the public root certificate for the cluster such that they can connect securely to the apiserver along with valid client credentials. For example, on a default GCE deployment, the client credentials provided to the kubelet are in the form of a client certificate. See -[kubelet TLS bootstrapping](/docs/admin/kubelet-tls-bootstrapping/) for -automated provisioning of kubelet client certificates. +[kubelet TLS bootstrapping](/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping/) +for automated provisioning of kubelet client certificates. Pods that wish to connect to the apiserver can do so securely by leveraging a service account so that Kubernetes will automatically inject the public root @@ -91,3 +96,4 @@ connection will be encrypted, it will not provide any guarantees of integrity. These connections **are not currently safe** to run over untrusted and/or public networks. +{{% /capture %}} diff --git a/content/en/docs/concepts/architecture/nodes.md b/content/en/docs/concepts/architecture/nodes.md index e52dc0eb380c5..f672eb38d97c1 100644 --- a/content/en/docs/concepts/architecture/nodes.md +++ b/content/en/docs/concepts/architecture/nodes.md @@ -3,12 +3,11 @@ reviewers: - caesarxuchao - dchen1107 title: Nodes +content_template: templates/concept weight: 10 --- -{{< toc >}} - -## What is a node? +{{% capture overview %}} A `node` is a worker machine in Kubernetes, previously known as a `minion`. A node may be a VM or physical machine, depending on the cluster. Each node has @@ -17,6 +16,12 @@ components. The services on a node include Docker, kubelet and kube-proxy. See [The Kubernetes Node](https://git.k8s.io/community/contributors/design-proposals/architecture/architecture.md#the-kubernetes-node) section in the architecture design doc for more details. +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ## Node Status A node's status contains the following information: @@ -46,6 +51,7 @@ The `conditions` field describes the status of all `Running` nodes. | `OutOfDisk` | `True` if there is insufficient free space on the node for adding new pods, otherwise `False` | | `Ready` | `True` if the node is healthy and ready to accept pods, `False` if the node is not healthy and is not accepting pods, and `Unknown` if the node controller has not heard from the node in the last `node-monitor-grace-period` (default is 40 seconds) | | `MemoryPressure` | `True` if pressure exists on the node memory -- that is, if the node memory is low; otherwise `False` | +| `PIDPressure` | `True` if pressure exists on the processes -- that is, if there are too many processes on the node; otherwise `False` | | `DiskPressure` | `True` if pressure exists on the disk size -- that is, if the disk capacity is low; otherwise `False` | | `NetworkUnavailable` | `True` if the network for the node is not correctly configured, otherwise `False` | | `ConfigOK` | `True` if the kubelet is correctly configured, otherwise `False` | @@ -279,3 +285,5 @@ on each kubelet where you want to reserve resources. Node is a top-level resource in the Kubernetes REST API. More details about the API object can be found at: [Node API object](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#node-v1-core). + +{{% /capture %}} diff --git a/content/en/docs/concepts/cluster-administration/addons.md b/content/en/docs/concepts/cluster-administration/addons.md index 33b065ac7c09d..b8a70ecc08fd4 100644 --- a/content/en/docs/concepts/cluster-administration/addons.md +++ b/content/en/docs/concepts/cluster-administration/addons.md @@ -1,8 +1,10 @@ --- title: Installing Addons +content_template: templates/concept --- -## Overview +{{% capture overview %}} + Add-ons extend the functionality of Kubernetes. @@ -10,6 +12,12 @@ This page lists some of the available add-ons and links to their respective inst Add-ons in each section are sorted alphabetically - the ordering does not imply any preferential status. +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ## Networking and Network Policy @@ -40,3 +48,5 @@ Add-ons in each section are sorted alphabetically - the ordering does not imply There are several other add-ons documented in the deprecated [cluster/addons](https://git.k8s.io/kubernetes/cluster/addons) directory. Well-maintained ones should be linked to here. PRs welcome! + +{{% /capture %}} diff --git a/content/en/docs/concepts/cluster-administration/certificates.md b/content/en/docs/concepts/cluster-administration/certificates.md index 7df5cd041125c..129470ddf0655 100644 --- a/content/en/docs/concepts/cluster-administration/certificates.md +++ b/content/en/docs/concepts/cluster-administration/certificates.md @@ -1,15 +1,21 @@ --- title: Certificates +content_template: templates/concept weight: 20 --- -{{< toc >}} -## Creating Certificates +{{% capture overview %}} When using client certificate authentication, you can generate certificates manually through `easyrsa`, `openssl` or `cfssl`. +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ### easyrsa **easyrsa** can manually generate certificates for your cluster. @@ -239,3 +245,5 @@ done. You can use the `certificates.k8s.io` API to provision x509 certificates to use for authentication as documented [here](/docs/tasks/tls/managing-tls-in-a-cluster). + +{{% /capture %}} diff --git a/content/en/docs/concepts/cluster-administration/cluster-administration-overview.md b/content/en/docs/concepts/cluster-administration/cluster-administration-overview.md index 5c83f861daa04..348caf2a7feb9 100644 --- a/content/en/docs/concepts/cluster-administration/cluster-administration-overview.md +++ b/content/en/docs/concepts/cluster-administration/cluster-administration-overview.md @@ -62,7 +62,7 @@ If you are using a guide involving Salt, see [Configuring Kubernetes with Salt]( ### Securing the kubelet * [Master-Node communication](/docs/concepts/architecture/master-node-communication/) - * [TLS bootstrapping](/docs/admin/kubelet-tls-bootstrapping/) + * [TLS bootstrapping](/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping/) * [Kubelet authentication/authorization](/docs/admin/kubelet-authentication-authorization/) ## Optional Cluster Services diff --git a/content/en/docs/concepts/cluster-administration/federation.md b/content/en/docs/concepts/cluster-administration/federation.md index 78f9253b92dc7..9bc16804364cc 100644 --- a/content/en/docs/concepts/cluster-administration/federation.md +++ b/content/en/docs/concepts/cluster-administration/federation.md @@ -168,7 +168,7 @@ users in the event of a cluster failure), then you need to have `R * (U + 1)` cl Finally, if any of your clusters would need more than the maximum recommended number of nodes for a Kubernetes cluster, then you may need even more clusters. Kubernetes v1.3 supports clusters up to 1000 nodes in size. Kubernetes v1.8 supports -clusters up to 5000 nodes. See [Building Large Clusters](/docs/admin/cluster-large/) for more guidance. +clusters up to 5000 nodes. See [Building Large Clusters](/docs/setup/cluster-large/) for more guidance. {{% /capture %}} diff --git a/content/en/docs/concepts/cluster-administration/kubelet-garbage-collection.md b/content/en/docs/concepts/cluster-administration/kubelet-garbage-collection.md index 9b25a524c8186..99364fc56eb00 100644 --- a/content/en/docs/concepts/cluster-administration/kubelet-garbage-collection.md +++ b/content/en/docs/concepts/cluster-administration/kubelet-garbage-collection.md @@ -2,15 +2,22 @@ reviewers: - mikedanese title: Configuring kubelet Garbage Collection +content_template: templates/concept weight: 70 --- -{{< toc >}} +{{% capture overview %}} Garbage collection is a helpful function of kubelet that will clean up unused images and unused containers. Kubelet will perform garbage collection for containers every minute and garbage collection for images every five minutes. External garbage collection tools are not recommended as these tools can potentially break the behavior of kubelet by removing containers expected to exist. +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ## Image Collection Kubernetes manages lifecycle of all images through imageManager, with the cooperation @@ -72,4 +79,10 @@ Including: | `--low-diskspace-threshold-mb` | `--eviction-hard` or `eviction-soft` | eviction generalizes disk thresholds to other resources | | `--outofdisk-transition-frequency` | `--eviction-pressure-transition-period` | eviction generalizes disk pressure transition to other resources | +{{% /capture %}} + +{{% capture whatsnext %}} + See [Configuring Out Of Resource Handling](/docs/tasks/administer-cluster/out-of-resource/) for more details. + +{{% /capture %}} diff --git a/content/en/docs/concepts/cluster-administration/logging.md b/content/en/docs/concepts/cluster-administration/logging.md index 7611a4fcd1605..8ce3884216610 100644 --- a/content/en/docs/concepts/cluster-administration/logging.md +++ b/content/en/docs/concepts/cluster-administration/logging.md @@ -3,15 +3,22 @@ reviewers: - piosz - x13n title: Logging Architecture +content_template: templates/concept weight: 60 --- +{{% capture overview %}} + Application and systems logs can help you understand what is happening inside your cluster. The logs are particularly useful for debugging problems and monitoring cluster activity. Most modern applications have some kind of logging mechanism; as such, most container engines are likewise designed to support some kind of logging. The easiest and most embraced logging method for containerized applications is to write to the standard output and standard error streams. However, the native functionality provided by a container engine or runtime is usually not enough for a complete logging solution. For example, if a container crashes, a pod is evicted, or a node dies, you'll usually still want to access your application's logs. As such, logs should have a separate storage and lifecycle independent of nodes, pods, or containers. This concept is called _cluster-level-logging_. Cluster-level logging requires a separate backend to store, analyze, and query logs. Kubernetes provides no native storage solution for log data, but you can integrate many existing logging solutions into your Kubernetes cluster. +{{% /capture %}} + {{< toc >}} +{{% capture body %}} + Cluster-level logging architectures are described in assumption that a logging backend is present inside or outside of your cluster. If you're not interested in having cluster-level logging, you might still find @@ -21,15 +28,15 @@ the description of how logs are stored and handled on the node to be useful. In this section, you can see an example of basic logging in Kubernetes that outputs data to the standard output stream. This demonstration uses -a [pod specification](/docs/concepts/cluster-administration/counter-pod.yaml) with +a [pod specification](/examples/debug/counter-pod.yaml) with a container that writes some text to standard output once per second. -{{< code file="counter-pod.yaml" >}} +{{< codenew file="debug/counter-pod.yaml" >}} To run this pod, use the following command: ```shell -$ kubectl create -f https://k8s.io/docs/tasks/debug-application-cluster/counter-pod.yaml +$ kubectl create -f https://k8s.io/examples/debug/counter-pod.yaml pod "counter" created ``` @@ -75,7 +82,7 @@ When you run [`kubectl logs`](/docs/reference/generated/kubectl/kubectl-commands the basic logging example, the kubelet on the node handles the request and reads directly from the log file, returning the contents in the response. -**Note:** currently, if some external system has performed the rotation, +**Note:** Currently, if some external system has performed the rotation, only the contents of the latest log file will be available through `kubectl logs`. E.g. if there's a 10MB file, `logrotate` performs the rotation and there are two files, one 10MB in size and one empty, @@ -243,3 +250,5 @@ container. You can implement cluster-level logging by exposing or pushing logs directly from every application; however, the implementation for such a logging mechanism is outside the scope of Kubernetes. + +{{% /capture %}} diff --git a/content/en/docs/concepts/cluster-administration/manage-deployment.md b/content/en/docs/concepts/cluster-administration/manage-deployment.md index 26dda7bbbf002..a91813c5583b1 100644 --- a/content/en/docs/concepts/cluster-administration/manage-deployment.md +++ b/content/en/docs/concepts/cluster-administration/manage-deployment.md @@ -4,13 +4,20 @@ reviewers: - janetkuo - mikedanese title: Managing Resources +content_template: templates/concept weight: 40 --- +{{% capture overview %}} + You've deployed your application and exposed it via a service. Now what? Kubernetes provides a number of tools to help you manage your application deployment, including scaling and updating. Among the features that we will discuss in more depth are [configuration files](/docs/concepts/configuration/overview/) and [labels](/docs/concepts/overview/working-with-objects/labels/). +{{% /capture %}} + {{< toc >}} +{{% capture body %}} + ## Organizing resource configurations Many applications require multiple resources to be created, such as a Deployment and a Service. Management of multiple resources can be simplified by grouping them together in the same file (separated by `---` in YAML). For example: @@ -391,7 +398,11 @@ $ kubectl edit deployment/my-nginx That's it! The Deployment will declaratively update the deployed nginx application progressively behind the scene. It ensures that only a certain number of old replicas may be down while they are being updated, and only a certain number of new replicas may be created above the desired number of pods. To learn more details about it, visit [Deployment page](/docs/concepts/workloads/controllers/deployment/). -## What's next? +{{% /capture %}} + +{{% capture whatsnext %}} - [Learn about how to use `kubectl` for application introspection and debugging.](/docs/tasks/debug-application-cluster/debug-application-introspection/) - [Configuration Best Practices and Tips](/docs/concepts/configuration/overview/) + +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/concepts/cluster-administration/networking.md b/content/en/docs/concepts/cluster-administration/networking.md index 10abe8854b93c..6d0dfc6af4fc8 100644 --- a/content/en/docs/concepts/cluster-administration/networking.md +++ b/content/en/docs/concepts/cluster-administration/networking.md @@ -2,9 +2,11 @@ reviewers: - thockin title: Cluster Networking +content_template: templates/concept weight: 50 --- +{{% capture overview %}} Kubernetes approaches networking somewhat differently than Docker does by default. There are 4 distinct networking problems to solve: @@ -14,10 +16,11 @@ default. There are 4 distinct networking problems to solve: 3. Pod-to-Service communications: this is covered by [services](/docs/concepts/services-networking/service/). 4. External-to-Service communications: this is covered by [services](/docs/concepts/services-networking/service/). -{{< toc >}} +{{% /capture %}} +{{< toc >}} -## Summary +{{% capture body %}} Kubernetes assumes that pods can communicate with other pods, regardless of which host they land on. Every pod gets its own IP address so you do not @@ -266,9 +269,12 @@ Weave Net runs as a [CNI plug-in](https://www.weave.works/docs/net/latest/cni-pl or stand-alone. In either version, it doesn't require any configuration or extra code to run, and in both cases, the network provides one IP address per pod - as is standard for Kubernetes. +{{% /capture %}} -## Other reading +{{% capture whatsnext %}} The early design of the networking model and its rationale, and some future plans are described in more detail in the [networking design document](https://git.k8s.io/community/contributors/design-proposals/network/networking.md). + +{{% /capture %}} diff --git a/content/en/docs/concepts/configuration/assign-pod-node.md b/content/en/docs/concepts/configuration/assign-pod-node.md index d6ceafc368948..7bca696bb5d0d 100644 --- a/content/en/docs/concepts/configuration/assign-pod-node.md +++ b/content/en/docs/concepts/configuration/assign-pod-node.md @@ -68,9 +68,12 @@ spec: Then add a nodeSelector like so: -{{< code file="pod.yaml" >}} +{{< codenew file="pods/pod-nginx.yaml" >}} -When you then run `kubectl create -f pod.yaml`, the pod will get scheduled on the node that you attached the label to! You can verify that it worked by running `kubectl get pods -o wide` and looking at the "NODE" that the pod was assigned to. +When you then run `kubectl create -f https://k8s.io/examples/pods/pod-nginx.yaml`, +the Pod will get scheduled on the node that you attached the label to. You can +verify that it worked by running `kubectl get pods -o wide` and looking at the +"NODE" that the Pod was assigned to. ## Interlude: built-in node labels @@ -133,7 +136,7 @@ Node affinity is specified as field `nodeAffinity` of field `affinity` in the Po Here's an example of a pod that uses node affinity: -{{< code file="pod-with-node-affinity.yaml" >}} +{{< codenew file="pods/pod-with-node-affinity.yaml" >}} This node affinity rule says the pod can only be placed on a node with a label whose key is `kubernetes.io/e2e-az-name` and whose value is either `e2e-az1` or `e2e-az2`. In addition, @@ -188,7 +191,7 @@ And inter-pod anti-affinity is specified as field `podAntiAffinity` of field `af #### An example of a pod that uses pod affinity: -{{< code file="pod-with-pod-affinity.yaml" >}} +{{< codenew file="pods/pod-with-pod-affinity.yaml" >}} The affinity on this pod defines one pod affinity rule and one pod anti-affinity rule. In this example, the `podAffinity` is `requiredDuringSchedulingIgnoredDuringExecution` @@ -344,4 +347,4 @@ as well, which allow a *node* to *repel* a set of pods. {{% capture whatsnext %}} -{{% /capture %}} \ No newline at end of file +{{% /capture %}} diff --git a/content/en/docs/concepts/configuration/manage-compute-resources-container.md b/content/en/docs/concepts/configuration/manage-compute-resources-container.md index 79d4a87f293ac..d6e03f0d28e62 100644 --- a/content/en/docs/concepts/configuration/manage-compute-resources-container.md +++ b/content/en/docs/concepts/configuration/manage-compute-resources-container.md @@ -144,9 +144,7 @@ When using Docker: multiplied by 100. The resulting value is the total amount of CPU time that a container can use every 100ms. A container cannot use more than its share of CPU time during this interval. - {{< note >}} - **Note**: The default quota period is 100ms. The minimum resolution of CPU quota is 1ms. - {{< /note >}} + {{< note >}}**Note**: The default quota period is 100ms. The minimum resolution of CPU quota is 1ms.{{}} - The `spec.containers[].resources.limits.memory` is converted to an integer, and used as the value of the @@ -209,12 +207,10 @@ $ kubectl describe nodes e2e-test-minion-group-4lw4 Name: e2e-test-minion-group-4lw4 [ ... lines removed for clarity ...] Capacity: - alpha.kubernetes.io/nvidia-gpu: 0 cpu: 2 memory: 7679792Ki pods: 110 Allocatable: - alpha.kubernetes.io/nvidia-gpu: 0 cpu: 1800m memory: 7474992Ki pods: 110 @@ -300,10 +296,10 @@ Container in the Pod was terminated and restarted five times. You can call `kubectl get pod` with the `-o go-template=...` option to fetch the status of previously terminated Containers: -```shell +```shell{% raw %} [13:59:01] $ kubectl get pod -o go-template='{{range.status.containerStatuses}}{{"Container Name: "}}{{.name}}{{"\r\nLastState: "}}{{.lastState}}{{end}}' simmemleak-hra99 Container Name: simmemleak -LastState: map[terminated:map[exitCode:137 reason:OOM Killed startedAt:2015-07-07T20:58:43Z finishedAt:2015-07-07T20:58:43Z containerID:docker://0e4095bba1feccdfe7ef9fb6ebffe972b4b14285d5acdec6f0d3ae8a22fad8b2]] +LastState: map[terminated:map[exitCode:137 reason:OOM Killed startedAt:2015-07-07T20:58:43Z finishedAt:2015-07-07T20:58:43Z containerID:docker://0e4095bba1feccdfe7ef9fb6ebffe972b4b14285d5acdec6f0d3ae8a22fad8b2]]{% endraw %} ``` You can see that the Container was terminated because of `reason:OOM Killed`, @@ -546,5 +542,3 @@ consistency across providers and platforms. * [ResourceRequirements](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#resourcerequirements-v1-core) {{% /capture %}} - - diff --git a/content/en/docs/concepts/configuration/pod-priority-preemption.md b/content/en/docs/concepts/configuration/pod-priority-preemption.md index 9564247fe1077..193880eb43d81 100644 --- a/content/en/docs/concepts/configuration/pod-priority-preemption.md +++ b/content/en/docs/concepts/configuration/pod-priority-preemption.md @@ -9,55 +9,92 @@ weight: 70 {{% capture overview %}} -{{< feature-state state="alpha" >}} +{{< feature-state for_k8s_version="1.8" state="alpha" >}} +{{< feature-state for_k8s_version="1.11" state="beta" >}} -[Pods](/docs/user-guide/pods) in Kubernetes 1.8 and later can have priority. Priority -indicates the importance of a Pod relative to other Pods. When a Pod cannot be scheduled, +[Pods](/docs/user-guide/pods) can have _priority_. Priority +indicates the importance of a Pod relative to other Pods. If a Pod cannot be scheduled, the scheduler tries to preempt (evict) lower priority Pods to make scheduling of the -pending Pod possible. In Kubernetes 1.9 and later, Priority also affects scheduling +pending Pod possible. + +In Kubernetes 1.9 and later, Priority also affects scheduling order of Pods and out-of-resource eviction ordering on the Node. +Pod priority and preemption are moved to beta since Kubernetes 1.11 and are enabled by default in +this release and later. + +In Kubernetes versions where Pod priority and preemption is still an alpha-level +feature, you need to explicitly enable it. To use these features in the older versions of +Kubernetes, follow the instructions in the documentation for your Kubernetes version, by +going to the documentation archive version for your Kubernetes version. + +| Kubernetes Version | Priority and Preemption State | Enabled by default | +| -------- |:-----:|:----:| +| 1.8 | alpha | no | +| 1.9 | alpha | no | +| 1.10 | alpha | no | +| 1.11 | beta | yes | + +{{< warning >}} +**Warning**: In a cluster where not all users are trusted, a malicious +user could create pods at the highest possible priorities, causing +other pods to be evicted/not get scheduled. To resolve this issue, +[ResourceQuota](https://kubernetes.io/docs/concepts/policy/resource-quotas/) is augmented to support +Pod priority. An admin can create ResourceQuota for users at specific priority levels, preventing +them from creating pods at high priorities. However, this feature is in alpha as of Kubernetes 1.11. +{{< /warning >}} + {{% /capture %}} {{% capture body %}} ## How to use priority and preemption -To use priority and preemption in Kubernetes 1.8 and later, follow these steps: - -1. Enable the feature. +To use priority and preemption in Kubernetes 1.11 and later, follow these steps: -1. Add one or more PriorityClasses. +1. Add one or more [PriorityClasses](#priorityclass). -1. Create Pods with `priorityClassName` set to one of the added PriorityClasses. +1. Create Pods with[`priorityClassName`](#pod-priority) set to one of the added PriorityClasses. Of course you do not need to create the Pods directly; normally you would add `priorityClassName` to the Pod template of a collection object like a Deployment. -The following sections provide more information about these steps. +Keep reading for more information about these steps. -## Enabling priority and preemption +If you try the feature and then decide to disable it, you must remove the PodPriority +command-line flag or set it to `false`, and then restart the API server and +scheduler. After the feature is disabled, the existing Pods keep their priority +fields, but preemption is disabled, and priority fields are ignored. If the feature +is disabled, you cannot set `priorityClassName` in new Pods. -Pod priority and preemption is disabled by default in Kubernetes 1.8. -To enable the feature, set this command-line flag for the API server, scheduler and kubelet: +## How to disable preemption -``` ---feature-gates=PodPriority=true -``` +{{< note >}} +**Note**: In Kubernetes 1.11, critical pods (except DaemonSet pods, which are +still scheduled by the DaemonSet controller) rely on scheduler preemption to be +scheduled when a cluster is under resource pressure. For this reason, we do not +recommend disabling this feature. If you still have to disable this feature, +follow the instructions below. +{{< /note >}} -Also enable scheduling.k8s.io/v1alpha1 API and Priority [admission controller](/docs/admin/admission-controllers/) in API server: +In Kubernetes 1.11 and later, preemption is controlled by a kube-scheduler flag +`disablePreemption`, which is set to `false` by default. +To disable preemption, set `disablePreemption` to true. This keeps pod priority +enabled but disables preemption. Here is a sample configuration: -``` ---runtime-config=scheduling.k8s.io/v1alpha1=true --enable-admission-plugins=Controller-Foo,Controller-Bar,...,Priority -``` +```yaml +apiVersion: componentconfig/v1alpha1 +kind: KubeSchedulerConfiguration +algorithmSource: + provider: DefaultProvider -After the feature is enabled, you can create [PriorityClasses](#priorityclass) -and create Pods with [`priorityClassName`](#pod-priority) set. +... -If you try the feature and then decide to disable it, you must remove the PodPriority -command-line flag or set it to false, and then restart the API server and -scheduler. After the feature is disabled, the existing Pods keep their priority -fields, but preemption is disabled, and priority fields are ignored, and you -cannot set `priorityClassName` in new Pods. +disablePreemption: true + +``` + +Although preemption of the scheduler is enabled by default, it is disabled if `PodPriority` +feature is disabled. ## PriorityClass @@ -80,22 +117,17 @@ with `globalDefault` set, the priority of Pods with no `priorityClassName` is ze The `description` field is an arbitrary string. It is meant to tell users of the cluster when they should use this PriorityClass. -{{< note >}} -**Note 1**: If you upgrade your existing cluster and enable this feature, the priority -of your existing Pods will be considered to be zero. -{{< /note >}} +### Notes about PodPriority and existing clusters +- If you upgrade your existing cluster and enable this feature, the priority +of your existing Pods is effectively zero. -{{< note >}} -**Note 2**: Addition of a PriorityClass with `globalDefault` set to true does not +- Addition of a PriorityClass with `globalDefault` set to `true` does not change the priorities of existing Pods. The value of such a PriorityClass is used only for Pods created after the PriorityClass is added. -{{< /note >}} -{{< note >}} -**Note 3**: If you delete a PriorityClass, existing Pods that use the name of the -deleted priority class remain unchanged, but you are not able to create more Pods +- If you delete a PriorityClass, existing Pods that use the name of the +deleted PriorityClass remain unchanged, but you cannot create more Pods that use the name of the deleted PriorityClass. -{{< /note >}} ### Example PriorityClass diff --git a/content/en/docs/concepts/configuration/secret.md b/content/en/docs/concepts/configuration/secret.md index 336e3f33401a3..df5b80129ea3d 100644 --- a/content/en/docs/concepts/configuration/secret.md +++ b/content/en/docs/concepts/configuration/secret.md @@ -482,7 +482,7 @@ Create a secret containing some ssh keys: $ kubectl create secret generic ssh-key-secret --from-file=ssh-privatekey=/path/to/.ssh/id_rsa --from-file=ssh-publickey=/path/to/.ssh/id_rsa.pub ``` -**Security Note:** think carefully before sending your own ssh keys: other users of the cluster may have access to the secret. Use a service account which you want to be accessible to all the users with whom you share the Kubernetes cluster, and can revoke if they are compromised. +**Security Note:** Think carefully before sending your own ssh keys: other users of the cluster may have access to the secret. Use a service account which you want to be accessible to all the users with whom you share the Kubernetes cluster, and can revoke if they are compromised. Now we can create a pod which references the secret with the ssh key and diff --git a/content/en/docs/concepts/configuration/taint-and-toleration.md b/content/en/docs/concepts/configuration/taint-and-toleration.md index 0497646916083..07b5af707cb2a 100644 --- a/content/en/docs/concepts/configuration/taint-and-toleration.md +++ b/content/en/docs/concepts/configuration/taint-and-toleration.md @@ -204,23 +204,23 @@ running on the node as follows * pods that tolerate the taint with a specified `tolerationSeconds` remain bound for the specified amount of time -In addition, Kubernetes 1.6 has alpha -support for representing node problems. In other words, the node controller -automatically taints a node when certain condition is true. The built-in taints -currently include: +In addition, Kubernetes 1.6 introduced alpha support for representing node +problems. In other words, the node controller automatically taints a node when +certain condition is true. The following taints are built in: * `node.kubernetes.io/not-ready`: Node is not ready. This corresponds to the NodeCondition `Ready` being "`False`". - * `node.alpha.kubernetes.io/unreachable`: Node is unreachable from the node + * `node.kubernetes.io/unreachable`: Node is unreachable from the node controller. This corresponds to the NodeCondition `Ready` being "`Unknown`". * `node.kubernetes.io/out-of-disk`: Node becomes out of disk. * `node.kubernetes.io/memory-pressure`: Node has memory pressure. * `node.kubernetes.io/disk-pressure`: Node has disk pressure. * `node.kubernetes.io/network-unavailable`: Node's network is unavailable. - * `node.cloudprovider.kubernetes.io/uninitialized`: When kubelet is started - with "external" cloud provider, it sets this taint on a node to mark it - as unusable. When a controller from the cloud-controller-manager initializes - this node, kubelet removes this taint. + * `node.kubernetes.io/unschedulable`: Node is unschedulable. + * `node.cloudprovider.kubernetes.io/uninitialized`: When the kubelet is started + with "external" cloud provider, this taint is set on a node to mark it + as unusable. After a controller from the cloud-controller-manager initializes + this node, the kubelet removes this taint. When the `TaintBasedEvictions` alpha feature is enabled (you can do this by including `TaintBasedEvictions=true` in `--feature-gates` for Kubernetes controller manager, @@ -277,17 +277,15 @@ Version 1.8 introduces an alpha feature that causes the node controller to creat Node conditions. When this feature is enabled (you can do this by including `TaintNodesByCondition=true` in the `--feature-gates` command line flag to the scheduler, such as `--feature-gates=FooBar=true,TaintNodesByCondition=true`), the scheduler does not check Node conditions; instead the scheduler checks taints. This assures that Node conditions don't affect what's scheduled onto the Node. The user can choose to ignore some of the Node's problems (represented as Node conditions) by adding appropriate Pod tolerations. -To make sure that turning on this feature doesn't break DaemonSets, starting in version 1.8, the DaemonSet controller automatically adds the following `NoSchedule` tolerations to all daemons: +Starting in Kubernetes 1.8, the DaemonSet controller automatically adds the +following `NoSchedule` tolerations to all daemons, to prevent DaemonSets from +breaking. * `node.kubernetes.io/memory-pressure` * `node.kubernetes.io/disk-pressure` * `node.kubernetes.io/out-of-disk` (*only for critical pods*) + * `node.kubernetes.io/unschedulable` (1.10 or later) + * `node.kubernetes.io/network-unavailable` (*host network only*) -The above settings ensure backward compatibility, but we understand they may not fit all user's needs, which is why -cluster admin may choose to add arbitrary tolerations to DaemonSets. - -{{% /capture %}} - -{{% capture whatsnext %}} - -{{% /capture %}} \ No newline at end of file +Adding these tolerations ensures backward compatibility. You can also add +arbitrary tolerations to DaemonSets. diff --git a/content/en/docs/concepts/containers/images.md b/content/en/docs/concepts/containers/images.md index 6d2795c88d877..dc6c31f8585b3 100644 --- a/content/en/docs/concepts/containers/images.md +++ b/content/en/docs/concepts/containers/images.md @@ -130,12 +130,12 @@ Once you have those variables filled in you can ### Configuring Nodes to Authenticate to a Private Repository -**Note:** if you are running on Google Kubernetes Engine, there will already be a `.dockercfg` on each node with credentials for Google Container Registry. You cannot use this approach. +**Note:** If you are running on Google Kubernetes Engine, there will already be a `.dockercfg` on each node with credentials for Google Container Registry. You cannot use this approach. -**Note:** if you are running on AWS EC2 and are using the EC2 Container Registry (ECR), the kubelet on each node will +**Note:** If you are running on AWS EC2 and are using the EC2 Container Registry (ECR), the kubelet on each node will manage and update the ECR login credentials. You cannot use this approach. -**Note:** this approach is suitable if you can control node configuration. It +**Note:** This approach is suitable if you can control node configuration. It will not work reliably on GCE, and any other cloud provider that does automatic node replacement. @@ -197,9 +197,9 @@ registry keys are added to the `.docker/config.json`. ### Pre-pulling Images -**Note:** if you are running on Google Kubernetes Engine, there will already be a `.dockercfg` on each node with credentials for Google Container Registry. You cannot use this approach. +**Note:** If you are running on Google Kubernetes Engine, there will already be a `.dockercfg` on each node with credentials for Google Container Registry. You cannot use this approach. -**Note:** this approach is suitable if you can control node configuration. It +**Note:** This approach is suitable if you can control node configuration. It will not work reliably on GCE, and any other cloud provider that does automatic node replacement. diff --git a/content/en/docs/concepts/extend-kubernetes/api-extension/custom-resources.md b/content/en/docs/concepts/extend-kubernetes/api-extension/custom-resources.md index d8c66a4520206..efab74152a30a 100644 --- a/content/en/docs/concepts/extend-kubernetes/api-extension/custom-resources.md +++ b/content/en/docs/concepts/extend-kubernetes/api-extension/custom-resources.md @@ -8,7 +8,11 @@ weight: 20 --- {{% capture overview %}} -This page explains [*custom resources*](/docs/concepts/api-extension/custom-resources/), which are extensions of the Kubernetes API. This page explains when to add a custom resource to your Kubernetes cluster and when to use a standalone service. It describes the two methods for adding custom resources and how to choose between them. + +This page explains *custom resources*, which are extensions of the Kubernetes +API, including when to add a custom resource to your Kubernetes cluster and when +to use a standalone service. It describes the two methods for adding custom +resources and how to choose between them. {{% /capture %}} @@ -103,20 +107,20 @@ Use a custom resource (CRD or Aggregated API) if most of the following apply: Kubernetes provides two ways to add custom resources to your cluster: -- [Custom Resource Definitions](/docs/concepts/api-extension/custom-resources/) (CRDs) are easier to use: they do not require any programming in some cases. +- CRDs are simple and can be created without any programming. - [API Aggregation](/docs/concepts/api-extension/apiserver-aggregation/) requires programming, but allows more control over API behaviors like how data is stored and conversion between API versions. Kubernetes provides these two options to meet the needs of different users, so that neither ease of use nor flexibility are compromised. Aggregated APIs are subordinate APIServers that sit behind the primary API server, which acts as a proxy. This arrangement is called [API Aggregation](/docs/concepts/api-extension/apiserver-aggregation/) (AA). To users, it simply appears that the Kubernetes API is extended. -Custom Resource Definitions (CRDS) allow users to create new types of resources without adding another APIserver. You do not need to understand API Aggregation to use CRDs. +CRDs allow users to create new types of resources without adding another APIserver. You do not need to understand API Aggregation to use CRDs. -Regardless of whether they are installed via CRDs or AA, the new resources are called Custom Resources to distinguish them from built-in Kubernetes resources (like pods). +Regardless of how they are installed, the new resources are referred to as Custom Resources to distinguish them from built-in Kubernetes resources (like pods). ## CustomResourceDefinitions -The [CustomResourceDefinition](/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/) (CRD) API resource allows you to define custom resources. Defining a CRD object creates a new custom resource with a name and schema that you specify. The Kubernetes API serves and handles the storage of your custom resource. +The [CustomResourceDefinition](/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/) API resource allows you to define custom resources. Defining a CRD object creates a new custom resource with a name and schema that you specify. The Kubernetes API serves and handles the storage of your custom resource. This frees you from writing your own API server to handle the custom resource, but the generic nature of the implementation means you have less flexibility than with @@ -132,7 +136,7 @@ and setup a controller to handle events. ## API server aggregation -Usually, each resource in the Kubernetes API requires code that handles REST requests and manages persistent storage of objects. The main Kubernetes API server handles built-in resources like *pods* and *services*, and can also handle custom resources in a generic way through [CustomResourceDefinitions](#customresourcedefinitions). +Usually, each resource in the Kubernetes API requires code that handles REST requests and manages persistent storage of objects. The main Kubernetes API server handles built-in resources like *pods* and *services*, and can also handle custom resources in a generic way through [CRDs](#customresourcedefinitions). The [aggregation layer](/docs/concepts/api-extension/apiserver-aggregation/) allows you to provide specialized implementations for your custom resources by writing and deploying your own standalone API server. @@ -152,7 +156,7 @@ Typically, CRDs are a good fit if: CRDs are easier to create than Aggregated APIs. -| Custom Resource Definitions | Aggregated API | +| CRDs | Aggregated API | | --------------------------- | -------------- | | Do not require programming. Users can choose any language for a CRD controller. | Requires programming in Go and building binary and image. Users can choose any language for a CRD controller. | | No additional service to run; CRs are handled by API Server. | An additional service to create and that could fail. | 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 637c32f11fa2a..71e542b1baa6c 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 @@ -37,7 +37,7 @@ During the registration, the device plugin needs to send: * The name of its Unix socket. * The Device Plugin API version against which it was built. * The `ResourceName` it wants to advertise. Here `ResourceName` needs to follow the - [extended resource naming scheme](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#extended-resources) + [extended resource naming scheme](/docs/concepts/configuration/manage-compute-resources-container/#extended-resources) as `vendor-domain/resource`. For example, an Nvidia GPU is advertised as `nvidia.com/gpu`. @@ -146,6 +146,7 @@ For examples of device plugin implementations, see: * The [RDMA device plugin](https://github.com/hustcat/k8s-rdma-device-plugin) * The [Solarflare device plugin](https://github.com/vikaschoudhary16/sfc-device-plugin) * The [AMD GPU device plugin](https://github.com/RadeonOpenCompute/k8s-device-plugin) -{{% /capture %}} +* The [SRIOV Network device plugin](https://github.com/intel/sriov-network-device-plugin) +{{% /capture %}} diff --git a/content/en/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins.md b/content/en/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins.md index 930beea4bcb12..422a51b6ad206 100644 --- a/content/en/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins.md +++ b/content/en/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins.md @@ -33,7 +33,7 @@ The kubelet has a single default network plugin, and a default network common to ## Network Plugin Requirements -Besides providing the [`NetworkPlugin` interface](https://github.com/kubernetes/kubernetes/tree/{{< param "fullversion" >}}/pkg/kubelet/network/plugins.go) to configure and clean up pod networking, the plugin may also need specific support for kube-proxy. The iptables proxy obviously depends on iptables, and the plugin may need to ensure that container traffic is made available to iptables. For example, if the plugin connects containers to a Linux bridge, the plugin must set the `net/bridge/bridge-nf-call-iptables` sysctl to `1` to ensure that the iptables proxy functions correctly. If the plugin does not use a Linux bridge (but instead something like Open vSwitch or some other mechanism) it should ensure container traffic is appropriately routed for the proxy. +Besides providing the [`NetworkPlugin` interface](https://github.com/kubernetes/kubernetes/tree/{{< param "fullversion" >}}/pkg/kubelet/dockershim/network/plugins.go) to configure and clean up pod networking, the plugin may also need specific support for kube-proxy. The iptables proxy obviously depends on iptables, and the plugin may need to ensure that container traffic is made available to iptables. For example, if the plugin connects containers to a Linux bridge, the plugin must set the `net/bridge/bridge-nf-call-iptables` sysctl to `1` to ensure that the iptables proxy functions correctly. If the plugin does not use a Linux bridge (but instead something like Open vSwitch or some other mechanism) it should ensure container traffic is appropriately routed for the proxy. By default if no kubelet network plugin is specified, the `noop` plugin is used, which sets `net/bridge/bridge-nf-call-iptables=1` to ensure simple configurations (like Docker with a bridge) work correctly with the iptables proxy. diff --git a/content/en/docs/concepts/overview/kubernetes-api.md b/content/en/docs/concepts/overview/kubernetes-api.md index e55b435c7aed1..e4295b7ab3149 100644 --- a/content/en/docs/concepts/overview/kubernetes-api.md +++ b/content/en/docs/concepts/overview/kubernetes-api.md @@ -2,9 +2,12 @@ reviewers: - chenopis title: The Kubernetes API +content_template: templates/concept weight: 30 --- +{{% capture overview %}} + Overall API conventions are described in the [API conventions doc](https://git.k8s.io/community/contributors/devel/api-conventions.md). API endpoints, resource types and samples are described in [API Reference](/docs/reference). @@ -17,6 +20,12 @@ Kubernetes also stores its serialized state (currently in [etcd](https://coreos. Kubernetes itself is decomposed into multiple components, which interact through its API. +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ## API changes In our experience, any system that is successful needs to grow and change as new use cases emerge or existing ones change. Therefore, we expect the Kubernetes API to continuously change and grow. However, we intend to not break compatibility with existing clients, for an extended period of time. In general, new API resources and new resource fields can be expected to be added frequently. Elimination of resources or fields will require following the [API deprecation policy](/docs/reference/using-api/deprecation-policy/). @@ -121,3 +130,5 @@ DaemonSets, Deployments, HorizontalPodAutoscalers, Ingress, Jobs and ReplicaSets Other extensions resources can be enabled by setting `--runtime-config` on apiserver. `--runtime-config` accepts comma separated values. For example: to disable deployments and ingress, set `--runtime-config=extensions/v1beta1/deployments=false,extensions/v1beta1/ingress=false` + +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/concepts/overview/object-management-kubectl/declarative-config.md b/content/en/docs/concepts/overview/object-management-kubectl/declarative-config.md index fda41e836f2e5..d46638acbe256 100644 --- a/content/en/docs/concepts/overview/object-management-kubectl/declarative-config.md +++ b/content/en/docs/concepts/overview/object-management-kubectl/declarative-config.md @@ -743,9 +743,6 @@ spec: app: nginx minReadySeconds: 5 replicas: 1 # defaulted by apiserver - selector: - matchLabels: - app: nginx strategy: rollingUpdate: # defaulted by apiserver - derived from strategy.type maxSurge: 1 diff --git a/content/en/docs/concepts/overview/object-management-kubectl/imperative-config.md b/content/en/docs/concepts/overview/object-management-kubectl/imperative-config.md index 7a44a27fc5497..f0681fd9b689d 100644 --- a/content/en/docs/concepts/overview/object-management-kubectl/imperative-config.md +++ b/content/en/docs/concepts/overview/object-management-kubectl/imperative-config.md @@ -100,14 +100,16 @@ Migrating from imperative commands to imperative object configuration involves several manual steps. 1. Export the live object to a local object configuration file: - - kubectl get / -o yaml --export > _.yaml +```sh +kubectl get / -o yaml --export > _.yaml +``` 1. Manually remove the status field from the object configuration file. 1. For subsequent object management, use `replace` exclusively. - - kubectl replace -f _.yaml +```sh +kubectl replace -f _.yaml +``` ## Defining controller selectors and PodTemplate labels diff --git a/content/en/docs/concepts/overview/working-with-objects/common-labels.md b/content/en/docs/concepts/overview/working-with-objects/common-labels.md new file mode 100644 index 0000000000000..314bbc7bb0b88 --- /dev/null +++ b/content/en/docs/concepts/overview/working-with-objects/common-labels.md @@ -0,0 +1,173 @@ +--- +title: Recommended Labels +content_template: templates/concept +--- + +{{% capture overview %}} +You can visualize and manage Kubernetes objects with more tools than kubectl and +the dashboard. A common set of labels allows tools to work interoperably, describing +objects in a common manner that all tools can understand. + +In addition to supporting tooling, the recommended labels describe applications +in a way that can be queried. +{{% /capture %}} + +{{% capture body %}} +The metadata is organized around the concept of an _application_. Kubernetes is not +a platform as a service (PaaS) and doesn't have or enforce a formal notion of an application. +Instead, applications are informal and described with metadata. The definition of +what an application contains is loose. + +{{< note >}} +**Note:** These are recommended labels. They make it easier to manage applications +but aren't required for any core tooling. +{{< /note >}} + +Shared labels and annotations share a common prefix: `app.kubernetes.io`. Labels +without a prefix are private to users. The shared prefix ensures that shared labels +do not interfere with custom user labels. + +## Labels + +In order to take full advantage of using these labels, they should be applied +on every resource object. + +| Key | Description | Example | Type | +| ----------------------------------- | --------------------- | -------- | ---- | +| `app.kubernetes.io/name` | The name of the application | `mysql` | string | +| `app.kubernetes.io/instance` | A unique name identifying the instance of an application | `wordpress-abcxzy` | string | +| `app.kubernetes.io/version` | The current version of the application (e.g., a semantic version, revision hash, etc.) | `5.7.21` | string | +| `app.kubernetes.io/component` | The component within the architecture | `database` | string | +| `app.kubernetes.io/part-of` | The name of a higher level application this one is part of | `wordpress` | string | +| `app.kubernetes.io/managed-by` | The tool being used to manage the operation of an application | `helm` | string | + +To illustrate these labels in action, consider the following StatefulSet object: + +```yaml +apiVersion: apps/v1 +kind: StatefulSet +metadata: + labels: + app.kubernetes.io/name: mysql + app.kubernetes.io/instance: wordpress-abcxzy + app.kubernetes.io/version: "5.7.21" + app.kubernetes.io/component: database + app.kubernetes.io/part-of: wordpress + app.kubernetes.io/managed-by: helm +``` + +## Applications And Instances Of Applications + +An application can be installed one or more times into a Kubernetes cluster and, +in some cases, the same namespace. For example, wordpress can be installed more +than once where different websites are different installations of wordpress. + +The name of an application and the instance name are recorded separately. For +example, WordPress has a `app.kubernetes.io/name` of `wordpress` while it has +an instance name, represented as `app.kubernetes.io/instance` with a value of +`wordpress-abcxzy`. This enables the application and instance of the application +to be identifiable. Every instance of an application must have a unique name. + +## Examples + +To illustrate different ways to use these labels the following examples have varying complexity. + +### A Simple Stateless Service + +Consider the case for a simple stateless service deployed using `Deployment` and `Service` objects. The following two snippets represent how the labels could be used in their simplest form. + +The `Deployment` is used to oversee the pods running the application itself. +```yaml +apiVersion: apps/v1 +kind: Deployment +metadata: + labels: + app.kubernetes.io/name: myservice + app.kubernetes.io/instance: myservice-abcxzy +... +``` + +The `Service` is used to expose the application. +```yaml +apiVersion: v1 +kind: Service +metadata: + labels: + app.kubernetes.io/name: myservice + app.kubernetes.io/instance: myservice-abcxzy +... +``` + +### Web Application With A Database + +Consider a slightly more complicated application: a web application (WordPress) +using a database (MySQL), installed using Helm. The following snippets illustrate +the start of objects used to deploy this application. + +The start to the following `Deployment` is used for WordPress: + +```yaml +apiVersion: apps/v1 +kind: Deployment +metadata: + labels: + app.kubernetes.io/name: wordpress + app.kubernetes.io/instance: wordpress-abcxzy + app.kubernetes.io/version: "4.9.4" + app.kubernetes.io/managed-by: helm + app.kubernetes.io/component: server + app.kubernetes.io/part-of: wordpress +... +``` + +The `Service` is used to expose WordPress: + +```yaml +apiVersion: v1 +kind: Service +metadata: + labels: + app.kubernetes.io/name: wordpress + app.kubernetes.io/instance: wordpress-abcxzy + app.kubernetes.io/version: "4.9.4" + app.kubernetes.io/managed-by: helm + app.kubernetes.io/component: server + app.kubernetes.io/part-of: wordpress +... +``` + +MySQL is exposed as a `StatefulSet` with metadata for both it and the larger application it belongs to: + +```yaml +apiVersion: apps/v1 +kind: StatefulSet +metadata: + labels: + app.kubernetes.io/name: mysql + app.kubernetes.io/instance: wordpress-abcxzy + app.kubernetes.io/managed-by: helm + app.kubernetes.io/component: database + app.kubernetes.io/part-of: wordpress + app.kubernetes.io/version: "5.7.21" +... +``` + +The `Service` is used to expose MySQL as part of WordPress: + +```yaml +apiVersion: v1 +kind: Service +metadata: + labels: + app.kubernetes.io/name: mysql + app.kubernetes.io/instance: wordpress-abcxzy + app.kubernetes.io/managed-by: helm + app.kubernetes.io/component: database + app.kubernetes.io/part-of: wordpress + app.kubernetes.io/version: "5.7.21" +... +``` + +With the MySQL `StatefulSet` and `Service` you'll notice information about both MySQL and Wordpress, the broader application, are included. + +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/concepts/overview/working-with-objects/labels.md b/content/en/docs/concepts/overview/working-with-objects/labels.md index 538e3561e610d..b4fb6959ccdf8 100644 --- a/content/en/docs/concepts/overview/working-with-objects/labels.md +++ b/content/en/docs/concepts/overview/working-with-objects/labels.md @@ -2,9 +2,12 @@ reviewers: - mikedanese title: Labels and Selectors +content_template: templates/concept weight: 40 --- +{{% capture overview %}} + _Labels_ are key/value pairs that are attached to objects, such as pods. Labels are intended to be used to specify identifying attributes of objects that are meaningful and relevant to users, but do not directly imply semantics to the core system. Labels can be used to organize and to select subsets of objects. Labels can be attached to objects at creation time and subsequently added and modified at any time. @@ -21,8 +24,12 @@ Each object can have a set of key/value labels defined. Each Key must be unique We'll eventually index and reverse-index labels for efficient queries and watches, use them to sort and group in UIs and CLIs, etc. We don't want to pollute labels with non-identifying, especially large and/or structured, data. Non-identifying information should be recorded using [annotations](/docs/concepts/overview/working-with-objects/annotations/). +{{% /capture %}} + {{< toc >}} +{{% capture body %}} + ## Motivation Labels enable users to map their own organizational structures onto system objects in a loosely coupled fashion, without requiring clients to store these mappings. @@ -194,3 +201,5 @@ selector: One use case for selecting over labels is to constrain the set of nodes onto which a pod can schedule. See the documentation on [node selection](/docs/concepts/configuration/assign-pod-node/) for more information. + +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/concepts/overview/working-with-objects/names.md b/content/en/docs/concepts/overview/working-with-objects/names.md index 4e81494a92e88..2c3cbec15d044 100644 --- a/content/en/docs/concepts/overview/working-with-objects/names.md +++ b/content/en/docs/concepts/overview/working-with-objects/names.md @@ -3,15 +3,24 @@ reviewers: - mikedanese - thockin title: Names +content_template: templates/concept weight: 20 --- +{{% capture overview %}} + All objects in the Kubernetes REST API are unambiguously identified by a Name and a UID. For non-unique user-provided attributes, Kubernetes provides [labels](/docs/user-guide/labels) and [annotations](/docs/concepts/overview/working-with-objects/annotations/). See the [identifiers design doc](https://git.k8s.io/community/contributors/design-proposals/architecture/identifiers.md) for the precise syntax rules for Names and UIDs. +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ## Names {{< glossary_definition term_id="name" length="all" >}} @@ -21,3 +30,5 @@ By convention, the names of Kubernetes resources should be up to maximum length ## UIDs {{< glossary_definition term_id="uid" length="all" >}} + +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/concepts/overview/working-with-objects/namespaces.md b/content/en/docs/concepts/overview/working-with-objects/namespaces.md index 52a9aabe01ba9..c0de016bbb394 100644 --- a/content/en/docs/concepts/overview/working-with-objects/namespaces.md +++ b/content/en/docs/concepts/overview/working-with-objects/namespaces.md @@ -4,12 +4,21 @@ reviewers: - mikedanese - thockin title: Namespaces +content_template: templates/concept weight: 30 --- +{{% capture overview %}} + Kubernetes supports multiple virtual clusters backed by the same physical cluster. These virtual clusters are called namespaces. +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ## When to Use Multiple Namespaces Namespaces are intended for use in environments with many users spread across multiple @@ -88,3 +97,5 @@ Most Kubernetes resources (e.g. pods, services, replication controllers, and oth in some namespaces. However namespace resources are not themselves in a namespace. And low-level resources, such as [nodes](/docs/admin/node) and persistentVolumes, are not in any namespace. + +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/concepts/policy/pod-security-policy.md b/content/en/docs/concepts/policy/pod-security-policy.md index 3c998b63847a6..9a1771980aab5 100644 --- a/content/en/docs/concepts/policy/pod-security-policy.md +++ b/content/en/docs/concepts/policy/pod-security-policy.md @@ -3,16 +3,23 @@ reviewers: - pweil- - tallclair title: Pod Security Policies +content_template: templates/concept weight: 20 --- +{{% capture overview %}} + {{< feature-state state="beta" >}} Pod Security Policies enable fine-grained authorization of pod creation and updates. +{{% /capture %}} + {{< toc >}} +{{% capture body %}} + ## What is a Pod Security Policy? A _Pod Security Policy_ is a cluster-level resource that controls security @@ -187,7 +194,7 @@ $ alias kubectl-user='kubectl --as=system:serviceaccount:psp-example:fake-user - Define the example PodSecurityPolicy object in a file. This is a policy that simply prevents the creation of privileged pods. -{{< code file="example-psp.yaml" >}} +{{< codenew file="policy/example-psp.yaml" >}} And create it with kubectl: @@ -348,13 +355,13 @@ podsecuritypolicy "example" deleted This is the least restricted policy you can create, equivalent to not using the pod security policy admission controller: -{{< code file="privileged-psp.yaml" >}} +{{< codenew file="policy/privileged-psp.yaml" >}} This is an example of a restrictive policy that requires users to run as an unprivileged user, blocks possible escalations to root, and requires use of several security mechanisms. -{{< code file="restricted-psp.yaml" >}} +{{< codenew file="policy/restricted-psp.yaml" >}} ## Policy Reference @@ -414,7 +421,8 @@ minimum value of the first range as the default. Validates against all ranges. to be used by hostPath volumes. An empty list means there is no restriction on host paths used. This is defined as a list of objects with a single `pathPrefix` field, which allows hostPath volumes to mount a path that begins with an -allowed prefix. For example: +allowed prefix, and a `readOnly` field indicating it must be mounted read-only. +For example: ```yaml allowedHostPaths: @@ -422,11 +430,18 @@ allowedHostPaths: # disallows "/fool", "/etc/foo" etc. # "/foo/../" is never valid. - pathPrefix: "/foo" + readOnly: true # only allow read-only mounts ``` -_Note: There are many ways a container with unrestricted access to the host +{{< warning >}}**Warning:** There are many ways a container with unrestricted access to the host filesystem can escalate privileges, including reading data from other -containers, and abusing the credentials of system services, such as Kubelet._ +containers, and abusing the credentials of system services, such as Kubelet. + +Writeable hostPath directory volumes allow containers to write +to the filesystem in ways that let them traverse the host filesystem outside the `pathPrefix`. +`readOnly: true`, available in Kubernetes 1.11+, must be used on **all** `allowedHostPaths` +to effectively limit access to the specified `pathPrefix`. +{{< /warning >}} **ReadOnlyRootFilesystem** - Requires that containers must run with a read-only root filesystem (i.e. no writable layer). @@ -558,3 +573,5 @@ default cannot be changed. Controlled via annotations on the PodSecurityPolicy. Refer to the [Sysctl documentation]( /docs/concepts/cluster-administration/sysctl-cluster/#podsecuritypolicy-annotations). + +{{% /capture %}} diff --git a/content/en/docs/concepts/policy/resource-quotas.md b/content/en/docs/concepts/policy/resource-quotas.md index 2d69664bcb96e..c6d42462784b6 100644 --- a/content/en/docs/concepts/policy/resource-quotas.md +++ b/content/en/docs/concepts/policy/resource-quotas.md @@ -1,312 +1,546 @@ ---- -reviewers: -- derekwaynecarr -title: Resource Quotas -weight: 10 ---- - -When several users or teams share a cluster with a fixed number of nodes, -there is a concern that one team could use more than its fair share of resources. - -Resource quotas are a tool for administrators to address this concern. - -A resource quota, defined by a `ResourceQuota` object, provides constraints that limit -aggregate resource consumption per namespace. It can limit the quantity of objects that can -be created in a namespace by type, as well as the total amount of compute resources that may -be consumed by resources in that project. - -Resource quotas work like this: - -- Different teams work in different namespaces. Currently this is voluntary, but - support for making this mandatory via ACLs is planned. -- The administrator creates one or more `ResourceQuotas` for each namespace. -- Users create resources (pods, services, etc.) in the namespace, and the quota system - tracks usage to ensure it does not exceed hard resource limits defined in a `ResourceQuota`. -- If creating or updating a resource violates a quota constraint, the request will fail with HTTP - status code `403 FORBIDDEN` with a message explaining the constraint that would have been violated. -- If quota is enabled in a namespace for compute resources like `cpu` and `memory`, users must specify - requests or limits for those values; otherwise, the quota system may reject pod creation. Hint: Use - the `LimitRanger` admission controller to force defaults for pods that make no compute resource requirements. - See the [walkthrough](/docs/tasks/administer-cluster/quota-memory-cpu-namespace/) for an example of how to avoid this problem. - -Examples of policies that could be created using namespaces and quotas are: - -- In a cluster with a capacity of 32 GiB RAM, and 16 cores, let team A use 20 GiB and 10 cores, - let B use 10GiB and 4 cores, and hold 2GiB and 2 cores in reserve for future allocation. -- Limit the "testing" namespace to using 1 core and 1GiB RAM. Let the "production" namespace - use any amount. - -In the case where the total capacity of the cluster is less than the sum of the quotas of the namespaces, -there may be contention for resources. This is handled on a first-come-first-served basis. - -Neither contention nor changes to quota will affect already created resources. - -## Enabling Resource Quota - -Resource Quota support is enabled by default for many Kubernetes distributions. It is -enabled when the apiserver `--enable-admission-plugins=` flag has `ResourceQuota` as -one of its arguments. - -A resource quota is enforced in a particular namespace when there is a -`ResourceQuota` in that namespace. - -## Compute Resource Quota - -You can limit the total sum of [compute resources](/docs/user-guide/compute-resources) that can be requested in a given namespace. - -The following resource types are supported: - -| Resource Name | Description | -| --------------------- | ----------------------------------------------------------- | -| `cpu` | Across all pods in a non-terminal state, the sum of CPU requests cannot exceed this value. | -| `limits.cpu` | Across all pods in a non-terminal state, the sum of CPU limits cannot exceed this value. | -| `limits.memory` | Across all pods in a non-terminal state, the sum of memory limits cannot exceed this value. | -| `memory` | Across all pods in a non-terminal state, the sum of memory requests cannot exceed this value. | -| `requests.cpu` | Across all pods in a non-terminal state, the sum of CPU requests cannot exceed this value. | -| `requests.memory` | Across all pods in a non-terminal state, the sum of memory requests cannot exceed this value. | - -### Resource Quota For Extended Resources - -In addition to the resources mentioned above, in release 1.10, quota support for -[extended resources](/docs/concepts/configuration/manage-compute-resources-container/#extended-resources) is added. - -As overcommit is not allowed for extended resources, it makes no sense to specify both `requests` -and `limits` for the same extended resource in a quota. So for extended resources, only quota items -with prefix `requests.` is allowed for now. - -Take the GPU resource as an example, if the resource name is `nvidia.com/gpu`, and you want to -limit the total number of GPUs requested in a namespace to 4, you can define a quota as follows: - +--- +reviewers: +- derekwaynecarr +title: Resource Quotas +content_template: templates/concept +weight: 10 +--- + +{{% capture overview %}} + +When several users or teams share a cluster with a fixed number of nodes, +there is a concern that one team could use more than its fair share of resources. + +Resource quotas are a tool for administrators to address this concern. + +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + +A resource quota, defined by a `ResourceQuota` object, provides constraints that limit +aggregate resource consumption per namespace. It can limit the quantity of objects that can +be created in a namespace by type, as well as the total amount of compute resources that may +be consumed by resources in that project. + +Resource quotas work like this: + +- Different teams work in different namespaces. Currently this is voluntary, but + support for making this mandatory via ACLs is planned. +- The administrator creates one or more `ResourceQuotas` for each namespace. +- Users create resources (pods, services, etc.) in the namespace, and the quota system + tracks usage to ensure it does not exceed hard resource limits defined in a `ResourceQuota`. +- If creating or updating a resource violates a quota constraint, the request will fail with HTTP + status code `403 FORBIDDEN` with a message explaining the constraint that would have been violated. +- If quota is enabled in a namespace for compute resources like `cpu` and `memory`, users must specify + requests or limits for those values; otherwise, the quota system may reject pod creation. Hint: Use + the `LimitRanger` admission controller to force defaults for pods that make no compute resource requirements. + See the [walkthrough](/docs/tasks/administer-cluster/quota-memory-cpu-namespace/) for an example of how to avoid this problem. + +Examples of policies that could be created using namespaces and quotas are: + +- In a cluster with a capacity of 32 GiB RAM, and 16 cores, let team A use 20 GiB and 10 cores, + let B use 10GiB and 4 cores, and hold 2GiB and 2 cores in reserve for future allocation. +- Limit the "testing" namespace to using 1 core and 1GiB RAM. Let the "production" namespace + use any amount. + +In the case where the total capacity of the cluster is less than the sum of the quotas of the namespaces, +there may be contention for resources. This is handled on a first-come-first-served basis. + +Neither contention nor changes to quota will affect already created resources. + +## Enabling Resource Quota + +Resource Quota support is enabled by default for many Kubernetes distributions. It is +enabled when the apiserver `--enable-admission-plugins=` flag has `ResourceQuota` as +one of its arguments. + +A resource quota is enforced in a particular namespace when there is a +`ResourceQuota` in that namespace. + +## Compute Resource Quota + +You can limit the total sum of [compute resources](/docs/user-guide/compute-resources) that can be requested in a given namespace. + +The following resource types are supported: + +| Resource Name | Description | +| --------------------- | ----------------------------------------------------------- | +| `cpu` | Across all pods in a non-terminal state, the sum of CPU requests cannot exceed this value. | +| `limits.cpu` | Across all pods in a non-terminal state, the sum of CPU limits cannot exceed this value. | +| `limits.memory` | Across all pods in a non-terminal state, the sum of memory limits cannot exceed this value. | +| `memory` | Across all pods in a non-terminal state, the sum of memory requests cannot exceed this value. | +| `requests.cpu` | Across all pods in a non-terminal state, the sum of CPU requests cannot exceed this value. | +| `requests.memory` | Across all pods in a non-terminal state, the sum of memory requests cannot exceed this value. | + +### Resource Quota For Extended Resources + +In addition to the resources mentioned above, in release 1.10, quota support for +[extended resources](/docs/concepts/configuration/manage-compute-resources-container/#extended-resources) is added. + +As overcommit is not allowed for extended resources, it makes no sense to specify both `requests` +and `limits` for the same extended resource in a quota. So for extended resources, only quota items +with prefix `requests.` is allowed for now. + +Take the GPU resource as an example, if the resource name is `nvidia.com/gpu`, and you want to +limit the total number of GPUs requested in a namespace to 4, you can define a quota as follows: + * `requests.nvidia.com/gpu: 4` See [Viewing and Setting Quotas](#viewing-and-setting-quotas) for more detail information. - - -## Storage Resource Quota - -You can limit the total sum of [storage resources](/docs/concepts/storage/persistent-volumes/) that can be requested in a given namespace. - -In addition, you can limit consumption of storage resources based on associated storage-class. - -| Resource Name | Description | -| --------------------- | ----------------------------------------------------------- | -| `requests.storage` | Across all persistent volume claims, the sum of storage requests cannot exceed this value. | -| `persistentvolumeclaims` | The total number of [persistent volume claims](/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) that can exist in the namespace. | -| `.storageclass.storage.k8s.io/requests.storage` | Across all persistent volume claims associated with the storage-class-name, the sum of storage requests cannot exceed this value. | -| `.storageclass.storage.k8s.io/persistentvolumeclaims` | Across all persistent volume claims associated with the storage-class-name, the total number of [persistent volume claims](/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) that can exist in the namespace. | - -For example, if an operator wants to quota storage with `gold` storage class separate from `bronze` storage class, the operator can -define a quota as follows: - -* `gold.storageclass.storage.k8s.io/requests.storage: 500Gi` -* `bronze.storageclass.storage.k8s.io/requests.storage: 100Gi` - -In release 1.8, quota support for local ephemeral storage is added as an alpha feature: - -| Resource Name | Description | -| ------------------------------- |----------------------------------------------------------- | -| `requests.ephemeral-storage` | Across all pods in the namespace, the sum of local ephemeral storage requests cannot exceed this value. | -| `limits.ephemeral-storage` | Across all pods in the namespace, the sum of local ephemeral storage limits cannot exceed this value. | - -## Object Count Quota - -The 1.9 release added support to quota all standard namespaced resource types using the following syntax: - -* `count/.` - -Here is an example set of resources users may want to put under object count quota: - -* `count/persistentvolumeclaims` -* `count/services` -* `count/secrets` -* `count/configmaps` -* `count/replicationcontrollers` -* `count/deployments.apps` -* `count/replicasets.apps` -* `count/statefulsets.apps` -* `count/jobs.batch` -* `count/cronjobs.batch` -* `count/deployments.extensions` - -When using `count/*` resource quota, an object is charged against the quota if it exists in server storage. -These types of quotas are useful to protect against exhaustion of storage resources. For example, you may -want to quota the number of secrets in a server given their large size. Too many secrets in a cluster can -actually prevent servers and controllers from starting! You may choose to quota jobs to protect against -a poorly configured cronjob creating too many jobs in a namespace causing a denial of service. - -Prior to the 1.9 release, it was possible to do generic object count quota on a limited set of resources. -In addition, it is possible to further constrain quota for particular resources by their type. - -The following types are supported: - -| Resource Name | Description | -| ------------------------------- | ------------------------------------------------- | -| `configmaps` | The total number of config maps that can exist in the namespace. | -| `persistentvolumeclaims` | The total number of [persistent volume claims](/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) that can exist in the namespace. | -| `pods` | The total number of pods in a non-terminal state that can exist in the namespace. A pod is in a terminal state if `.status.phase in (Failed, Succeeded)` is true. | -| `replicationcontrollers` | The total number of replication controllers that can exist in the namespace. | -| `resourcequotas` | The total number of [resource quotas](/docs/admin/admission-controllers/#resourcequota) that can exist in the namespace. | -| `services` | The total number of services that can exist in the namespace. | -| `services.loadbalancers` | The total number of services of type load balancer that can exist in the namespace. | -| `services.nodeports` | The total number of services of type node port that can exist in the namespace. | -| `secrets` | The total number of secrets that can exist in the namespace. | - -For example, `pods` quota counts and enforces a maximum on the number of `pods` -created in a single namespace that are not terminal. You might want to set a `pods` -quota on a namespace to avoid the case where a user creates many small pods and -exhausts the cluster's supply of Pod IPs. - -## Quota Scopes - -Each quota can have an associated set of scopes. A quota will only measure usage for a resource if it matches -the intersection of enumerated scopes. - -When a scope is added to the quota, it limits the number of resources it supports to those that pertain to the scope. -Resources specified on the quota outside of the allowed set results in a validation error. - -| Scope | Description | -| ----- | ----------- | -| `Terminating` | Match pods where `.spec.activeDeadlineSeconds >= 0` | -| `NotTerminating` | Match pods where `.spec.activeDeadlineSeconds is nil` | -| `BestEffort` | Match pods that have best effort quality of service. | -| `NotBestEffort` | Match pods that do not have best effort quality of service. | - -The `BestEffort` scope restricts a quota to tracking the following resource: `pods` - -The `Terminating`, `NotTerminating`, and `NotBestEffort` scopes restrict a quota to tracking the following resources: - -* `cpu` -* `limits.cpu` -* `limits.memory` -* `memory` -* `pods` -* `requests.cpu` -* `requests.memory` - -## Requests vs Limits - -When allocating compute resources, each container may specify a request and a limit value for either CPU or memory. -The quota can be configured to quota either value. - -If the quota has a value specified for `requests.cpu` or `requests.memory`, then it requires that every incoming -container makes an explicit request for those resources. If the quota has a value specified for `limits.cpu` or `limits.memory`, -then it requires that every incoming container specifies an explicit limit for those resources. - -## Viewing and Setting Quotas - -Kubectl supports creating, updating, and viewing quotas: - -```shell -kubectl create namespace myspace - -cat < compute-resources.yaml -apiVersion: v1 -kind: ResourceQuota -metadata: - name: compute-resources -spec: - hard: - pods: "4" - requests.cpu: "1" - requests.memory: 1Gi - limits.cpu: "2" - limits.memory: 2Gi - requests.nvidia.com/gpu: 4 -EOF -kubectl create -f ./compute-resources.yaml --namespace=myspace - -cat < object-counts.yaml -apiVersion: v1 -kind: ResourceQuota -metadata: - name: object-counts -spec: - hard: - configmaps: "10" - persistentvolumeclaims: "4" - replicationcontrollers: "20" - secrets: "10" - services: "10" - services.loadbalancers: "2" -EOF -kubectl create -f ./object-counts.yaml --namespace=myspace - -kubectl get quota --namespace=myspace -NAME AGE -compute-resources 30s -object-counts 32s - -kubectl describe quota compute-resources --namespace=myspace -Name: compute-resources -Namespace: myspace -Resource Used Hard --------- ---- ---- -limits.cpu 0 2 -limits.memory 0 2Gi -pods 0 4 -requests.cpu 0 1 -requests.memory 0 1Gi -requests.nvidia.com/gpu 0 4 - - -kubectl describe quota object-counts --namespace=myspace -Name: object-counts -Namespace: myspace -Resource Used Hard --------- ---- ---- -configmaps 0 10 -persistentvolumeclaims 0 4 -replicationcontrollers 0 20 -secrets 1 10 -services 0 10 -services.loadbalancers 0 2 -``` - -Kubectl also supports object count quota for all standard namespaced resources -using the syntax `count/.`: - -```shell -kubectl create namespace myspace - -kubectl create quota test --hard=count/deployments.extensions=2,count/replicasets.extensions=4,count/pods=3,count/secrets=4 --namespace=myspace - -kubectl run nginx --image=nginx --replicas=2 --namespace=myspace - -kubectl describe quota --namespace=myspace -Name: test -Namespace: myspace -Resource Used Hard --------- ---- ---- -count/deployments.extensions 1 2 -count/pods 2 3 -count/replicasets.extensions 1 4 -count/secrets 1 4 -``` - -## Quota and Cluster Capacity - -`ResourceQuotas` are independent of the cluster capacity. They are -expressed in absolute units. So, if you add nodes to your cluster, this does *not* -automatically give each namespace the ability to consume more resources. - -Sometimes more complex policies may be desired, such as: - - - Proportionally divide total cluster resources among several teams. - - Allow each tenant to grow resource usage as needed, but have a generous - limit to prevent accidental resource exhaustion. - - Detect demand from one namespace, add nodes, and increase quota. - -Such policies could be implemented using `ResourceQuotas` as building blocks, by -writing a "controller" that watches the quota usage and adjusts the quota -hard limits of each namespace according to other signals. - -Note that resource quota divides up aggregate cluster resources, but it creates no -restrictions around nodes: pods from several namespaces may run on the same node. - -## Example - -See a [detailed example for how to use resource quota](/docs/tasks/administer-cluster/quota-api-object/). - -## Read More - -See [ResourceQuota design doc](https://git.k8s.io/community/contributors/design-proposals/resource-management/admission_control_resource_quota.md) for more information. + + +## Storage Resource Quota + +You can limit the total sum of [storage resources](/docs/concepts/storage/persistent-volumes/) that can be requested in a given namespace. + +In addition, you can limit consumption of storage resources based on associated storage-class. + +| Resource Name | Description | +| --------------------- | ----------------------------------------------------------- | +| `requests.storage` | Across all persistent volume claims, the sum of storage requests cannot exceed this value. | +| `persistentvolumeclaims` | The total number of [persistent volume claims](/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) that can exist in the namespace. | +| `.storageclass.storage.k8s.io/requests.storage` | Across all persistent volume claims associated with the storage-class-name, the sum of storage requests cannot exceed this value. | +| `.storageclass.storage.k8s.io/persistentvolumeclaims` | Across all persistent volume claims associated with the storage-class-name, the total number of [persistent volume claims](/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) that can exist in the namespace. | + +For example, if an operator wants to quota storage with `gold` storage class separate from `bronze` storage class, the operator can +define a quota as follows: + +* `gold.storageclass.storage.k8s.io/requests.storage: 500Gi` +* `bronze.storageclass.storage.k8s.io/requests.storage: 100Gi` + +In release 1.8, quota support for local ephemeral storage is added as an alpha feature: + +| Resource Name | Description | +| ------------------------------- |----------------------------------------------------------- | +| `requests.ephemeral-storage` | Across all pods in the namespace, the sum of local ephemeral storage requests cannot exceed this value. | +| `limits.ephemeral-storage` | Across all pods in the namespace, the sum of local ephemeral storage limits cannot exceed this value. | + +## Object Count Quota + +The 1.9 release added support to quota all standard namespaced resource types using the following syntax: + +* `count/.` + +Here is an example set of resources users may want to put under object count quota: + +* `count/persistentvolumeclaims` +* `count/services` +* `count/secrets` +* `count/configmaps` +* `count/replicationcontrollers` +* `count/deployments.apps` +* `count/replicasets.apps` +* `count/statefulsets.apps` +* `count/jobs.batch` +* `count/cronjobs.batch` +* `count/deployments.extensions` + +When using `count/*` resource quota, an object is charged against the quota if it exists in server storage. +These types of quotas are useful to protect against exhaustion of storage resources. For example, you may +want to quota the number of secrets in a server given their large size. Too many secrets in a cluster can +actually prevent servers and controllers from starting! You may choose to quota jobs to protect against +a poorly configured cronjob creating too many jobs in a namespace causing a denial of service. + +Prior to the 1.9 release, it was possible to do generic object count quota on a limited set of resources. +In addition, it is possible to further constrain quota for particular resources by their type. + +The following types are supported: + +| Resource Name | Description | +| ------------------------------- | ------------------------------------------------- | +| `configmaps` | The total number of config maps that can exist in the namespace. | +| `persistentvolumeclaims` | The total number of [persistent volume claims](/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) that can exist in the namespace. | +| `pods` | The total number of pods in a non-terminal state that can exist in the namespace. A pod is in a terminal state if `.status.phase in (Failed, Succeeded)` is true. | +| `replicationcontrollers` | The total number of replication controllers that can exist in the namespace. | +| `resourcequotas` | The total number of [resource quotas](/docs/admin/admission-controllers/#resourcequota) that can exist in the namespace. | +| `services` | The total number of services that can exist in the namespace. | +| `services.loadbalancers` | The total number of services of type load balancer that can exist in the namespace. | +| `services.nodeports` | The total number of services of type node port that can exist in the namespace. | +| `secrets` | The total number of secrets that can exist in the namespace. | + +For example, `pods` quota counts and enforces a maximum on the number of `pods` +created in a single namespace that are not terminal. You might want to set a `pods` +quota on a namespace to avoid the case where a user creates many small pods and +exhausts the cluster's supply of Pod IPs. + +## Quota Scopes + +Each quota can have an associated set of scopes. A quota will only measure usage for a resource if it matches +the intersection of enumerated scopes. + +When a scope is added to the quota, it limits the number of resources it supports to those that pertain to the scope. +Resources specified on the quota outside of the allowed set results in a validation error. + +| Scope | Description | +| ----- | ----------- | +| `Terminating` | Match pods where `.spec.activeDeadlineSeconds >= 0` | +| `NotTerminating` | Match pods where `.spec.activeDeadlineSeconds is nil` | +| `BestEffort` | Match pods that have best effort quality of service. | +| `NotBestEffort` | Match pods that do not have best effort quality of service. | + +The `BestEffort` scope restricts a quota to tracking the following resource: `pods` + +The `Terminating`, `NotTerminating`, and `NotBestEffort` scopes restrict a quota to tracking the following resources: + +* `cpu` +* `limits.cpu` +* `limits.memory` +* `memory` +* `pods` +* `requests.cpu` +* `requests.memory` + +### Resource Quota Per PriorityClass + +{{< feature-state for_k8s_version="1.11" state="beta" >}} + +Pods can be created at a specific [priority](/docs/concepts/configuration/pod-priority-preemption/#pod-priority). +You can control a pod's consumption of system resources based on a pod's priority, by using the `scopeSelector` +field in the quota spec. + +A quota is matched and consumed only if `scopeSelector` in the quota spec selects the pod. + +{{< note >}} +**Note:** You need to enable the feature gate `ResourceQuotaScopeSelectors`before using resource quotas +per PriorityClass. +{{< /note >}} + +This example creates a quota object and matches it with pods at specific priorities. The example +works as follows: + +- Pods in the cluster have one of the three priority classes, "low", "medium", "high". +- One quota object is created for each priority. + +1. Save the following YAML to a file `quota.yml`. + + ```yaml + apiVersion: v1 + kind: List + items: + - apiVersion: v1 + kind: ResourceQuota + metadata: + name: pods-high + spec: + hard: + cpu: "1000" + memory: 200Gi + pods: "10" + scopeSelector: + matchExpressions: + - operator : In + scopeName: PriorityClass + values: ["high"] + - apiVersion: v1 + kind: ResourceQuota + metadata: + name: pods-medium + spec: + hard: + cpu: "10" + memory: 20Gi + pods: "10" + scopeSelector: + matchExpressions: + - operator : In + scopeName: PriorityClass + values: ["medium"] + - apiVersion: v1 + kind: ResourceQuota + metadata: + name: pods-low + spec: + hard: + cpu: "5" + memory: 10Gi + pods: "10" + scopeSelector: + matchExpressions: + - operator : In + scopeName: PriorityClass + values: ["low"] + ``` + +2. Apply it using `kubectl create`. + + ```shell + kubectl create -f ./quota.yml` + + resourcequota/pods-high created + resourcequota/pods-medium created + resourcequota/pods-low created + ``` + +3. Verify that `Used` quota is `0` using `kubectl describe quota`. + + ```shell + kubectl describe quota + + Name: pods-high + Namespace: default + Resource Used Hard + -------- ---- ---- + cpu 0 1k + memory 0 200Gi + pods 0 10 + + + Name: pods-low + Namespace: default + Resource Used Hard + -------- ---- ---- + cpu 0 5 + memory 0 10Gi + pods 0 10 + + + Name: pods-medium + Namespace: default + Resource Used Hard + -------- ---- ---- + cpu 0 10 + memory 0 20Gi + pods 0 10 + ``` +4. Create a pod with priority "high". Save the following YAML to a + file `high-priority-pod.yml`. + + ```yaml + apiVersion: v1 + kind: Pod + metadata: + name: high-priority + spec: + containers: + - name: high-priority + image: ubuntu + command: ["/bin/sh"] + args: ["-c", "while true; do echo hello; sleep 10;done"] + resources: + requests: + memory: "10Gi" + cpu: "500m" + limits: + memory: "10Gi" + cpu: "500m" + priorityClassName: high + ``` + + Apply it with `kubectl create`. + + ```shell + kubectl create -f ./high-priority-pod.yml + ``` + +5. Verify that "Used" stats for "high" priority quota, `pods-high`, has changed and that + the other two quotas are unchanged. + + ```shell + kubectl describe quota + + Name: pods-high + Namespace: default + Resource Used Hard + -------- ---- ---- + cpu 500m 1k + memory 10Gi 200Gi + pods 1 10 + + + Name: pods-low + Namespace: default + Resource Used Hard + -------- ---- ---- + cpu 0 5 + memory 0 10Gi + pods 0 10 + + + Name: pods-medium + Namespace: default + Resource Used Hard + -------- ---- ---- + cpu 0 10 + memory 0 20Gi + pods 0 10 + ``` + +`scopeSelector` supports the following values in the `operator` field: + +* `In` +* `NotIn` +* `Exist` +* `DoesNotExist` + +## Requests vs Limits + +When allocating compute resources, each container may specify a request and a limit value for either CPU or memory. +The quota can be configured to quota either value. + +If the quota has a value specified for `requests.cpu` or `requests.memory`, then it requires that every incoming +container makes an explicit request for those resources. If the quota has a value specified for `limits.cpu` or `limits.memory`, +then it requires that every incoming container specifies an explicit limit for those resources. + +## Viewing and Setting Quotas + +Kubectl supports creating, updating, and viewing quotas: + +```shell +kubectl create namespace myspace + +cat < compute-resources.yaml +apiVersion: v1 +kind: ResourceQuota +metadata: + name: compute-resources +spec: + hard: + pods: "4" + requests.cpu: "1" + requests.memory: 1Gi + limits.cpu: "2" + limits.memory: 2Gi + requests.nvidia.com/gpu: 4 +EOF +kubectl create -f ./compute-resources.yaml --namespace=myspace + +cat < object-counts.yaml +apiVersion: v1 +kind: ResourceQuota +metadata: + name: object-counts +spec: + hard: + configmaps: "10" + persistentvolumeclaims: "4" + replicationcontrollers: "20" + secrets: "10" + services: "10" + services.loadbalancers: "2" +EOF +kubectl create -f ./object-counts.yaml --namespace=myspace + +kubectl get quota --namespace=myspace +NAME AGE +compute-resources 30s +object-counts 32s + +kubectl describe quota compute-resources --namespace=myspace +Name: compute-resources +Namespace: myspace +Resource Used Hard +-------- ---- ---- +limits.cpu 0 2 +limits.memory 0 2Gi +pods 0 4 +requests.cpu 0 1 +requests.memory 0 1Gi +requests.nvidia.com/gpu 0 4 + + +kubectl describe quota object-counts --namespace=myspace +Name: object-counts +Namespace: myspace +Resource Used Hard +-------- ---- ---- +configmaps 0 10 +persistentvolumeclaims 0 4 +replicationcontrollers 0 20 +secrets 1 10 +services 0 10 +services.loadbalancers 0 2 +``` + +Kubectl also supports object count quota for all standard namespaced resources +using the syntax `count/.`: + +```shell +kubectl create namespace myspace + +kubectl create quota test --hard=count/deployments.extensions=2,count/replicasets.extensions=4,count/pods=3,count/secrets=4 --namespace=myspace + +kubectl run nginx --image=nginx --replicas=2 --namespace=myspace + +kubectl describe quota --namespace=myspace +Name: test +Namespace: myspace +Resource Used Hard +-------- ---- ---- +count/deployments.extensions 1 2 +count/pods 2 3 +count/replicasets.extensions 1 4 +count/secrets 1 4 +``` + +## Quota and Cluster Capacity + +`ResourceQuotas` are independent of the cluster capacity. They are +expressed in absolute units. So, if you add nodes to your cluster, this does *not* +automatically give each namespace the ability to consume more resources. + +Sometimes more complex policies may be desired, such as: + + - Proportionally divide total cluster resources among several teams. + - Allow each tenant to grow resource usage as needed, but have a generous + limit to prevent accidental resource exhaustion. + - Detect demand from one namespace, add nodes, and increase quota. + +Such policies could be implemented using `ResourceQuotas` as building blocks, by +writing a "controller" that watches the quota usage and adjusts the quota +hard limits of each namespace according to other signals. + +Note that resource quota divides up aggregate cluster resources, but it creates no +restrictions around nodes: pods from several namespaces may run on the same node. + +## Limit Priority Class consumption by default + +It may be desired that pods at a particular priority, eg. "cluster-services", should be allowed in a namespace, if and only if, a matching quota object exists. + +With this mechanism, operators will be able to restrict usage of certain high priority classes to a limited number of namespaces and not every namespaces will be able to consume these priority classes by default. + +To enforce this, kube-apiserver flag `--admission-control-config-file` should be used to pass path to the following configuration file: + +```shell +$ cat admission_config_file.yml +apiVersion: apiserver.k8s.io/v1alpha1 +kind: AdmissionConfiguration +plugins: +- name: "ResourceQuota" + configuration: + apiVersion: resourcequota.admission.k8s.io/v1alpha1 + kind: Configuration + limitedResources: + - resource: pods + matchScopes: + - operator : In + scopeName: PriorityClass + values: ["cluster-services"] +``` + +Now, "cluster-services" pods will be allowed in only those namespaces where a quota object with a matching `scopeSelector` is present. +For example: +```shell + scopeSelector: + matchExpressions: + - operator : In + scopeName: PriorityClass + values: ["cluster-services"] +``` + +**NOTE:** `scopeSelector` is an alpha field and feature gate `ResourceQuotaScopeSelectors` must be enabled before using it. + +See [LimitedResources](https://github.com/kubernetes/kubernetes/pull/36765) and [Quota supoport for priority class design doc](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/scheduling/pod-priority-resourcequota.md) for more information. + +## Example + +See a [detailed example for how to use resource quota](/docs/tasks/administer-cluster/quota-api-object/). + +{{% /capture %}} + +{{% capture whatsnext %}} + +See [ResourceQuota design doc](https://git.k8s.io/community/contributors/design-proposals/resource-management/admission_control_resource_quota.md) for more information. + +{{% /capture %}} diff --git a/content/en/docs/concepts/services-networking/ingress.md b/content/en/docs/concepts/services-networking/ingress.md index e1dc9447f792c..01aa25d21c9bd 100644 --- a/content/en/docs/concepts/services-networking/ingress.md +++ b/content/en/docs/concepts/services-networking/ingress.md @@ -92,6 +92,8 @@ In order for the Ingress resource to work, the cluster must have an Ingress cont * Kubernetes currently supports and maintains [GCE](https://git.k8s.io/ingress-gce/README.md) and [nginx](https://git.k8s.io/ingress-nginx/README.md) controllers. * F5 Networks provides [support and maintenance](https://support.f5.com/csp/article/K86859508) for the [F5 BIG-IP Controller for Kubernetes](http://clouddocs.f5.com/products/connectors/k8s-bigip-ctlr/latest). * [Kong](https://konghq.com/) offers [community](https://discuss.konghq.com/c/kubernetes) or [commercial](https://konghq.com/api-customer-success/) support and maintenance for the [Kong Ingress Controller for Kubernetes](https://konghq.com/blog/kubernetes-ingress-controller-for-kong/) +* [Traefik](https://github.com/containous/traefik) is a fully featured ingress controller +([Let's Encrypt](https://letsencrypt.org), secrets, http2, websocket...), and it also comes with commercial support by [Containous](https://containo.us/services) {{< note >}} Review the documentation for your controller to find its specific support policy. diff --git a/content/en/docs/concepts/services-networking/service.md b/content/en/docs/concepts/services-networking/service.md index 9bd4ed8a20a98..e0aa7740db672 100644 --- a/content/en/docs/concepts/services-networking/service.md +++ b/content/en/docs/concepts/services-networking/service.md @@ -250,6 +250,8 @@ spec: targetPort: 9377 ``` +Note that the port names must only contain lowercase alphanumeric characters and `-`, and must begin & end with an alphanumeric character. `123-abc` and `web` are valid, but `123_abc` and `-web` are not valid names. + ## Choosing your own IP address You can specify your own cluster IP address as part of a `Service` creation diff --git a/content/en/docs/concepts/storage/persistent-volumes.md b/content/en/docs/concepts/storage/persistent-volumes.md index 72b66b9807b55..7c17119f7f94d 100644 --- a/content/en/docs/concepts/storage/persistent-volumes.md +++ b/content/en/docs/concepts/storage/persistent-volumes.md @@ -5,13 +5,20 @@ reviewers: - thockin - msau42 title: Persistent Volumes +content_template: templates/concept weight: 20 --- +{{% capture overview %}} + This document describes the current state of `PersistentVolumes` in Kubernetes. Familiarity with [volumes](/docs/concepts/storage/volumes/) is suggested. +{{% /capture %}} + {{< toc >}} +{{% capture body %}} + ## Introduction Managing storage is a distinct problem from managing compute. The `PersistentVolume` subsystem provides an API for users and administrators that abstracts details of how storage is provided from how it is consumed. To do this we introduce two new API resources: `PersistentVolume` and `PersistentVolumeClaim`. @@ -71,14 +78,13 @@ Pods use claims as volumes. The cluster inspects the claim to find the bound vol Once a user has a claim and that claim is bound, the bound PV belongs to the user for as long as they need it. Users schedule Pods and access their claimed PVs by including a `persistentVolumeClaim` in their Pod's volumes block. [See below for syntax details](#claims-as-volumes). ### Storage Object in Use Protection -{{< feature-state for_k8s_version="v1.10" state="beta" >}} The purpose of the Storage Object in Use Protection feature is to ensure that Persistent Volume Claims (PVCs) in active use by a pod and Persistent Volume (PVs) that are bound to PVCs are not removed from the system as this may result in data loss. {{< note >}} **Note:** PVC is in active use by a pod when the pod status is `Pending` and the pod is assigned to a node or the pod status is `Running`. {{< /note >}} -When the [Storage Object in Use Protection beta feature](/docs/tasks/administer-cluster/storage-object-in-use-protection/) is enabled, if a user deletes a PVC in active use by a pod, the PVC is not removed immediately. PVC removal is postponed until the PVC is no longer actively used by any pods, and also if admin deletes a PV that is bound to a PVC, the PV is not removed immediately. PV removal is postponed until the PV is not bound to a PVC any more. +When the [Storage Object in Use Protection feature](/docs/tasks/administer-cluster/storage-object-in-use-protection/) is enabled, if a user deletes a PVC in active use by a pod, the PVC is not removed immediately. PVC removal is postponed until the PVC is no longer actively used by any pods, and also if admin deletes a PV that is bound to a PVC, the PV is not removed immediately. PV removal is postponed until the PV is not bound to a PVC any more. You can see that a PVC is protected when the PVC's status is `Terminating` and the `Finalizers` list includes `kubernetes.io/pvc-protection`: @@ -169,20 +175,21 @@ However, the particular path specified in the custom recycler pod template in th ### Expanding Persistent Volumes Claims -Kubernetes 1.8 added Alpha support for expanding persistent volumes. In v1.9, the following volume types support expanding Persistent volume claims: +{{< feature-state for_k8s_version="v1.8" state="alpha" >}} +{{< feature-state for_k8s_version="v1.11" state="beta" >}} +Support for expanding PersistentVolumeClaims (PVCs) is now enabled by default. You can expand +the following types of volumes: * gcePersistentDisk * awsElasticBlockStore * Cinder * glusterfs * rbd +* Azure File +* Azure Disk +* Portworx -Administrator can allow expanding persistent volume claims by setting `ExpandPersistentVolumes` feature gate to true. Administrator -should also enable [`PersistentVolumeClaimResize` admission plugin](/docs/admin/admission-controllers/#persistentvolumeclaimresize) -to perform additional validations of volumes that can be resized. - -Once `PersistentVolumeClaimResize` admission plug-in has been turned on, resizing will only be allowed for storage classes -whose `allowVolumeExpansion` field is set to true. +You can only expand a PVC if its storage class's `allowVolumeExpansion` field is set to true. ``` yaml kind: StorageClass @@ -198,17 +205,33 @@ parameters: allowVolumeExpansion: true ``` -Once both feature gate and the aforementioned admission plug-in are turned on, a user can request larger volume for their `PersistentVolumeClaim` -by simply editing the claim and requesting a larger size. This in turn will trigger expansion of the volume that is backing the underlying `PersistentVolume`. +To request a larger volume for a PVC, edit the PVC object and specify a larger +size. This triggers expansion of the volume that backs the underlying `PersistentVolume`. A +new `PersistentVolume` is never created to satisfy the claim. Instead, an existing volume is resized. + +#### Resizing a volume containing a file system + +You can only resize volumes containing a file system if the file system is XFS, Ext3, or Ext4. + +When a volume contains a file system, the file system is only resized when a new Pod is started using +the `PersistentVolumeClaim` in ReadWrite mode. Therefore, if a pod or deployment is using a volume and +you want to expand it, you need to delete or recreate the pod after the volume has been exxpanded by the cloud provider in the controller-manager. You can check the status of resize operation by running the `kubectl describe pvc` command: + +``` +kubectl describe pvc +``` + +If the `PersistentVolumeClaim` has the status `FileSystemResizePending`, it is safe to recreate the pod using the PersistentVolumeClaim. -Under no circumstances will a new `PersistentVolume` be created to satisfy the claim. Kubernetes will instead attempt to resize the existing volume. +#### Resizing an in-use PersistentVolumeClaim -For expanding volumes containing a file system, file system resizing is only performed when a new Pod is started using the `PersistentVolumeClaim` in -ReadWrite mode. In other words, if a volume being expanded is used in a pod or deployment, you will need to delete and recreate the pod for file system -resizing to take place. Also, file system resizing is only supported for following file system types: +{{< feature-state for_k8s_version="v1.11" state="alpha" >}} -* XFS -* Ext3, Ext4 +Expanding in-use PVCs is an alpha feature. To use it, enable the `ExpandInUsePersistentVolumes` feature gate. +In this case, you don't need to delete and recreate a Pod or deployment that is using an existing PVC. +Any in-use PVC automatically becomes available to its Pod as soon as its file system has been expanded. +This feature has no effect on PVCs that are not in use by a Pod or deployment. You must create a Pod which +uses the PVC before the expansion can complete. {{< note >}} **Note:** Expanding EBS volumes is a time consuming operation. Also, there is a per-volume quota of one modification every 6 hours. @@ -223,7 +246,7 @@ resizing to take place. Also, file system resizing is only supported for followi * AWSElasticBlockStore * AzureFile * AzureDisk -* FC (Fibre Channel)** +* FC (Fibre Channel) * FlexVolume * Flocker * NFS @@ -239,8 +262,6 @@ resizing to take place. Also, file system resizing is only supported for followi * ScaleIO Volumes * StorageOS -Raw Block Support exists for these plugins only. - ## Persistent Volumes Each PV contains a spec and status, which is the specification and status of the volume. @@ -274,11 +295,14 @@ Currently, storage size is the only resource that can be set or requested. Futu ### Volume Mode -Prior to v1.9, the default behavior for all volume plugins was to create a filesystem on the persistent volume. With v1.9, the user can specify a `volumeMode` which will now support raw block devices in addition to file systems. Valid values for `volumeMode` are "Filesystem" or "Block". If left unspecified, `volumeMode` defaults to "Filesystem" internally. This is an optional API parameter. +{{< feature-state for_k8s_version="v1.9" state="alpha" >}} -{{< note >}} -**Note:** This feature is alpha in v1.9 and may change in the future. -{{< /note >}} +To enable this feature, enable the `BlockVolume` feature gate on the apiserver, controller-manager and the kubelet. + +Prior to Kubernetes 1.9, all volume plugins created a filesystem on the persistent volume. +Now, you can set the value of `volumeMode` to `raw` to use a raw block device, or `filesystem` +to use a filesystem. `filesystem` is the default if the value is omitted. This is an optional API +parameter. ### Access Modes @@ -501,7 +525,26 @@ spec: ## Raw Block Volume Support -Static provisioning support for Raw Block Volumes is included as an alpha feature for v1.9. With this change are some new API fields that need to be used to facilitate this functionality. Kubernetes v1.10 supports only Fibre Channel and Local Volume plugins for this feature. +{{< feature-state for_k8s_version="v1.9" state="alpha" >}} + +To enable support for raw block volumes, enable the `BlockVolume` feature gate on the +apiserver, controller-manager and the kubelet. + +The following volume plugins support raw block volumes, including dynamic provisioning where +applicable. + +* AWSElasticBlockStore +* AzureDisk +* FC (Fibre Channel) +* GCEPersistentDisk +* iSCSI +* Local volume +* RBD (Ceph Block Device) + +{{< note >}} +**Note**: Only FC and iSCSI volumes supported raw block volumes in Kubernetes 1.9. +Support for the additional plugins was added in 1.10. +{{< /note >}} ### Persistent Volumes using a Raw Block Volume ```yaml @@ -608,3 +651,5 @@ and need persistent storage, we recommend that you use the following pattern: dynamic storage support (in which case the user should create a matching PV) or the cluster has no storage system (in which case the user cannot deploy config requiring PVCs). + +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/concepts/storage/storage-classes.md b/content/en/docs/concepts/storage/storage-classes.md index 7e49d36b28b0e..a4a0bf145dbc0 100644 --- a/content/en/docs/concepts/storage/storage-classes.md +++ b/content/en/docs/concepts/storage/storage-classes.md @@ -5,15 +5,22 @@ reviewers: - thockin - msau42 title: Storage Classes +content_template: templates/concept weight: 30 --- +{{% capture overview %}} + This document describes the concept of `StorageClass` in Kubernetes. Familiarity with [volumes](/docs/concepts/storage/volumes/) and [persistent volumes](/docs/concepts/storage/persistent-volumes) is suggested. +{{% /capture %}} + {{< toc >}} +{{% capture body %}} + ## Introduction A `StorageClass` provides a way for administrators to describe the "classes" of @@ -670,3 +677,5 @@ specified by the `WaitForFirstConsumer` volume binding mode. Delaying volume binding allows the scheduler to consider all of a pod's scheduling constraints when choosing an appropriate PersistentVolume for a PersistentVolumeClaim. + +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/concepts/storage/storage-limits.md b/content/en/docs/concepts/storage/storage-limits.md new file mode 100644 index 0000000000000..b1c3a563b1a20 --- /dev/null +++ b/content/en/docs/concepts/storage/storage-limits.md @@ -0,0 +1,75 @@ +--- +reviewers: +- jsafrane +- saad-ali +- thockin +- msau42 +title: Node-specific Volume Limits +content_template: templates/concept +--- + +{{% capture overview %}} + +This page describes the maximum number of volumes that can be attached +to a node for various cloud providers. + +Cloud providers like Google, Amazon, and Microsoft typically have a limit on +how many volumes can be attached to a node. It is important for Kubernetes to +respect those limits. Otherwise, Pods scheduled on a node could get stuck +waiting for volumes to attach. + +{{% /capture %}} + +{{% capture body %}} + +## Kubernetes default limits + +The Kubernetes scheduler has default limits on the number of volumes +that can be attached to a node: + + + + + + +
Cloud serviceMaximum volumes per node
Amazon Elastic Block Store (EBS)39
Google Persistent Disk16
Microsoft Azure Disk Storage16
+ +## Custom limits + +You can change these limits by setting the value of the +`KUBE_MAX_PD_VOLS` environment variable, and then starting the scheduler. + +Use caution if you set a limit that is higher than the default limit. Consult +the cloud provider's documentation to make sure that nodes can actually support +the limit you set. + +The limit applies to the entire cluster, so it affects all nodes. + +## Dynamic volume limits + +{{< feature-state state="alpha" for_k8s_version="v1.11" >}} + +Kubernetes 1.11 introduces dynamic volume limits based on node type. This +is an alpha feature that supports these services: + +- Amazon EBS +- Google Persistent Disk + +To enable dynamic volume limits, set the `AttachVolumeLimit` +[feature gate](/docs/reference/command-line-tools-reference/feature-gates/) +to True. + +When the dynamic volume limits feature is enabled, Kubernetes automatically +determines the node type and supports the appropriate number of attachable +volumes for the node. For example: + +* On +Google Compute Engine, +up to 128 volumes could be attached to a node, depending on the node type. + +* For Amazon EBS disks on M5/C5 instance types, Kubernetes would permit only 25 +volumes to be attached to a node. For other instance types on +Amazon Elastic Compute Cloud (EC2), +Kubernetes would permit 39 volumes to be attached. + +{{% /capture %}} diff --git a/content/en/docs/concepts/storage/volumes.md b/content/en/docs/concepts/storage/volumes.md index 6c6499fcc264e..57902008697e2 100644 --- a/content/en/docs/concepts/storage/volumes.md +++ b/content/en/docs/concepts/storage/volumes.md @@ -246,7 +246,7 @@ or different paths in each Container. When a Pod is removed from a node for any reason, the data in the `emptyDir` is deleted forever. {{< note >}} -**Note:** a Container crashing does *NOT* remove a Pod from a node, so the data in an `emptyDir` volume is safe across Container crashes. +**Note:** A Container crashing does *NOT* remove a Pod from a node, so the data in an `emptyDir` volume is safe across Container crashes. {{< /note >}} Some uses for an `emptyDir` are: @@ -646,8 +646,15 @@ Currently, the following types of volume sources can be projected: - [`secret`](#secret) - [`downwardAPI`](#downwardapi) - [`configMap`](#configmap) +- `serviceAccountToken` -All sources are required to be in the same namespace as the Pod. For more details, see the [all-in-one volume design document](https://github.com/kubernetes/community/blob/{{< param "githubbranch" >}}/contributors/design-proposals/node/all-in-one-volume.md). +All sources are required to be in the same namespace as the Pod. For more details, +see the [all-in-one volume design document](https://github.com/kubernetes/community/blob/{{< param "githubbranch" >}}/contributors/design-proposals/node/all-in-one-volume.md). + +The projection of service account tokens is a feature introduced in Kubernetes +1.11. To enable this feature, you need to explicitly set the `TokenRequestProjection` +[feature gate](/docs/reference/command-line-tools-reference/feature-gates/) to +True. #### Example Pod with a secret, a downward API, and a configmap. @@ -730,6 +737,45 @@ parameters are nearly the same with two exceptions: volume source. However, as illustrated above, you can explicitly set the `mode` for each individual projection. +When the `TokenRequestProjection` feature is enabled, you can inject the token +for the current [service account](/docs/reference/access-authn-authz/authentication/#service-account-tokens) +into a Pod at a specified path. Below is an example: + +```yaml +apiVersion: v1 +kind: Pod +metadata: + name: sa-token-test +spec: + containers: + - name: container-test + image: busybox + volumeMounts: + - name: token-vol + mountPath: "/sevice-account" + readOnly: true + volumes: + - name: token-vol + projected: + sources: + - serviceAccountToken: + audience: api + expirationSeconds: 3600 + path: token +``` + +The example Pod has a projected volume containing the injected service account +token. This token can be used by Pod containers to access the Kubernetes API +server, for example. The `audience` field contains the intended audience of the +token. A recipient of the token must identify itself with an identifier specified +in the audience of the token, and otherwise should reject the token. This field +is optional and it defaults to the identifier of the API server. + +The `expirationSeconds` is the expected duration of validity of the service account +token. It defaults to 1 hour and must be at least 10 minutes (600 seconds). +The `path` field specifies a relative path to the mount point of the projected +volume. + {{< note >}} **Note:** A Container using a projected volume source as a [subPath](#using-subpath) volume mount will not receive updates for those volume sources. @@ -1018,6 +1064,43 @@ spec: claimName: my-lamp-site-data ``` +### Using subPath with expanded environment variables + +{{< feature-state for_k8s_version="v1.11" state="alpha" >}} + + +`subPath` directory names can also be constructed from Downward API environment variables. +Before you use this feature, you must enable the `VolumeSubpathEnvExpansion`feature gate. + +In this example, a Pod uses `subPath` to create a directory `pod1` within the hostPath volume `/var/log/pods`, using the pod name from the Downward API. The host directory `/var/log/pods/pod1` is mounted at `/logs` in the container. + +```yaml +apiVersion: v1 +kind: Pod +metadata: + name: pod1 +spec: + containers: + - name: container1 + env: + - name: POD_NAME + valueFrom: + fieldRef: + apiVersion: v1 + fieldPath: metadata.name + image: busybox + command: [ "sh", "-c", "while [ true ]; do echo 'Hello'; sleep 10; done | tee -a /logs/hello.txt" ] + volumeMounts: + - name: workdir1 + mountPath: /logs + subPath: $(POD_NAME) + restartPolicy: Never + volumes: + - name: workdir1 + hostPath: + path: /var/log/pods +``` + ## Resources The storage media (Disk, SSD, etc.) of an `emptyDir` volume is determined by the @@ -1116,6 +1199,26 @@ persistent volume: secret is required. If the secret object contains more than one secret, all secrets are passed. +#### CSI raw block volume support + +{{< feature-state for_k8s_version="v1.11" state="alpha" >}} + +Starting with version 1.11, CSI introduced support for raw block volumes, which +relies on the raw block volume feature that was introduced in a previous version of +Kubernetes. This feature will make it possible for vendors with external CSI drivers to +implement raw block volumes support in Kubernetes workloads. + +CSI block volume support is feature-gated and turned off by default. To run CSI with +block volume support enabled, a cluster administrator must enable the feature for each +Kubernetes component using the following feature gate flags: + +``` +--feature-gates=BlockVolume=true,CSIBlockVolume=true +``` + +Learn how to +[setup your PV/PVC with raw block volume support](/docs/concepts/storage/persistent-volumes/#raw-block-volume-support). + ### FlexVolume `FlexVolume` is an out-of-tree plugin interface that has existed in Kubernetes diff --git a/content/en/docs/concepts/workloads/controllers/cron-jobs.md b/content/en/docs/concepts/workloads/controllers/cron-jobs.md index 84abde442e690..521a69b44fc25 100644 --- a/content/en/docs/concepts/workloads/controllers/cron-jobs.md +++ b/content/en/docs/concepts/workloads/controllers/cron-jobs.md @@ -4,12 +4,11 @@ reviewers: - soltysh - janetkuo title: CronJob +content_template: templates/concept weight: 80 --- -{{< toc >}} - -## What is a cron job? +{{% capture overview %}} A _Cron Job_ manages time based [Jobs](/docs/concepts/workloads/controllers/jobs-run-to-completion/), namely: @@ -21,6 +20,12 @@ on a given schedule, written in [Cron](https://en.wikipedia.org/wiki/Cron) forma For instructions on creating and working with cron jobs, and for an example of a spec file for a cron job, see [Running automated tasks with cron jobs](/docs/tasks/job/automated-tasks-with-cron-jobs). +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ## Cron Job Limitations A cron job creates a job object _about_ once per execution time of its schedule. We say "about" because there @@ -43,3 +48,5 @@ starting at all. The Cronjob is only responsible for creating Jobs that match its schedule, and the Job in turn is responsible for the management of the Pods it represents. + +{{% /capture %}} diff --git a/content/en/docs/concepts/workloads/controllers/daemonset.md b/content/en/docs/concepts/workloads/controllers/daemonset.md index 15237bf250612..880ad43961065 100644 --- a/content/en/docs/concepts/workloads/controllers/daemonset.md +++ b/content/en/docs/concepts/workloads/controllers/daemonset.md @@ -6,12 +6,11 @@ reviewers: - janetkuo - kow3ns title: DaemonSet +content_template: templates/concept weight: 50 --- -{{< toc >}} - -## What is a DaemonSet? +{{% capture overview %}} A _DaemonSet_ ensures that all (or some) Nodes run a copy of a Pod. As nodes are added to the cluster, Pods are added to them. As nodes are removed from the cluster, those Pods are garbage @@ -28,17 +27,23 @@ In a simple case, one DaemonSet, covering all nodes, would be used for each type A more complex setup might use multiple DaemonSets for a single type of daemon, but with different flags and/or different memory and cpu requests for different hardware types. +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ## Writing a DaemonSet Spec ### Create a DaemonSet You can describe a DaemonSet in a YAML file. For example, the `daemonset.yaml` file below describes a DaemonSet that runs the fluentd-elasticsearch Docker image: -{{< code file="daemonset.yaml" >}} +{{< codenew file="controllers/daemonset.yaml" >}} * Create a DaemonSet based on the YAML file: ``` -kubectl create -f daemonset.yaml +kubectl create -f https://k8s.io/examples/controllers/daemonset.yaml ``` ### Required Fields @@ -98,7 +103,9 @@ If you do not specify either, then the DaemonSet controller will create Pods on ## How Daemon Pods are Scheduled -Normally, the machine that a Pod runs on is selected by the Kubernetes scheduler. However, Pods +### Scheduled by DaemonSet controller (default) + +Normally, the machine that a Pod runs on is selected by the Kubernetes scheduler. However, Pods created by the DaemonSet controller have the machine already selected (`.spec.nodeName` is specified when the Pod is created, so it is ignored by the scheduler). Therefore: @@ -107,29 +114,72 @@ when the Pod is created, so it is ignored by the scheduler). Therefore: - The DaemonSet controller can make Pods even when the scheduler has not been started, which can help cluster bootstrap. -Daemon Pods do respect [taints and tolerations](/docs/concepts/configuration/taint-and-toleration), -but they are created with `NoExecute` tolerations for the following taints with no `tolerationSeconds`: - - `node.kubernetes.io/not-ready` - - `node.alpha.kubernetes.io/unreachable` +### Scheduled by default scheduler + +{{< feature-state state="alpha" for-kubernetes-version="1.11" >}} + +A DaemonSet ensures that all eligible nodes run a copy of a Pod. Normally, the +node that a Pod runs on is selected by the Kubernetes scheduler. However, +DaemonSet pods are created and scheduled by the DaemonSet controller instead. +That introduces the following issues: + + * Inconsistent Pod behavior: Normal Pods waiting to be scheduled are created + and in `Pending` state, but DaemonSet pods are not created in `Pending` + state. This is confusing to the user. + * [Pod preemption](/docs/concepts/configuration/pod-priority-preemption/) + is handled by default scheduler. When preemption is enabled, the DaemonSet controller + will make scheduling decisions without considering pod priority and preemption. + +`ScheduleDaemonSetPods` allows you to schedule DaemonSets using the default +scheduler instead of the DaemonSet controller, by adding the `NodeAffinity` term +to the DaemonSet pods, instead of the `.spec.nodeName` term. The default +scheduler is then used to bind the pod to the target host. If node affinity of +the DaemonSet pod already exists, it is replaced. The DaemonSet controller only +performs these operations when creating or modifying DaemonSet pods, and no +changes are made to the `spec.template` of the DaemonSet. + +```yaml +nodeAffinity: + requiredDuringSchedulingIgnoredDuringExecution: + nodeSelectorTerms: + - matchFields: + - key: metadata.name + operator: In + values: + - target-host-name +``` + +In addition, `node.kubernetes.io/unschedulable:NoSchedule` toleration is added +automatically to DaemonSet Pods. The DaemonSet controller ignores +`unschedulable` Nodes when scheduling DaemonSet Pods. You must enable +`TaintModesByCondition` to ensure that the default scheduler behaves the same +way and schedules DaemonSet pods on `unschedulable` nodes. + +When this feature and `TaintNodesByCondition` are enabled together, if DaemonSet +uses the host network, you must also add the +`node.kubernetes.io/network-unavailable:NoSchedule toleration`. + -This ensures that when the `TaintBasedEvictions` alpha feature is enabled, -they will not be evicted when there are node problems such as a network partition. (When the -`TaintBasedEvictions` feature is not enabled, they are also not evicted in these scenarios, but -due to hard-coded behavior of the NodeController rather than due to tolerations). +### Taints and Tolerations - They also tolerate following `NoSchedule` taints: +Although Daemon Pods respect +[taints and tolerations](/docs/concepts/configuration/taint-and-toleration), +the following tolerations are added to DamonSet Pods automatically according to +the related features. - - `node.kubernetes.io/memory-pressure` - - `node.kubernetes.io/disk-pressure` +| Toleration Key | Effect | Alpha Features | Version | Description | +| ---------------------------------------- | ---------- | ------------------------------------------------------------ | ------- | ------------------------------------------------------------ | +| `node.kubernetes.io/not-ready` | NoExecute | `TaintBasedEvictions` | 1.8+ | when `TaintBasedEvictions` is enabled,they will not be evicted when there are node problems such as a network partition. | +| `node.kubernetes.io/unreachable` | NoExecute | `TaintBasedEvictions` | 1.8+ | when `TaintBasedEvictions` is enabled,they will not be evicted when there are node problems such as a network partition. | +| `node.kubernetes.io/disk-pressure` | NoSchedule | `TaintNodesByCondition` | 1.8+ | | +| `node.kubernetes.io/memory-pressure` | NoSchedule | `TaintNodesByCondition` | 1.8+ | | +| `node.kubernetes.io/unschedulable` | NoSchedule | `ScheduleDaemonSetPods`, `TaintNodesByCondition` | 1.11+ | When ` ScheduleDaemonSetPods` is enabled, ` TaintNodesByCondition` is necessary to make sure DaemonSet pods tolerate unschedulable attributes by default scheduler. | +| `node.kubernetes.io/network-unavailable` | NoSchedule | `ScheduleDaemonSetPods`, `TaintNodesByCondition`, hostnework | 1.11+ | When ` ScheduleDaemonSetPods` is enabled, ` TaintNodesByCondition` is necessary to make sure DaemonSet pods, who uses host network, tolerate network-unavailable attributes by default scheduler. | +| `node.kubernetes.io/out-of-disk` | NoSchedule | `ExperimentalCriticalPodAnnotation` (critical pod only), `TaintNodesByCondition` | 1.8+ | | -When the support to critical pods is enabled and the pods in a DaemonSet are -labeled as critical, the Daemon pods are created with an additional -`NoSchedule` toleration for the `node.kubernetes.io/out-of-disk` taint. -Note that all above `NoSchedule` taints above are created only in version 1.8 or later if the alpha feature `TaintNodesByCondition` is enabled. -Also note that the `node-role.kubernetes.io/master` `NoSchedule` toleration specified in the above example is needed on 1.6 or later to schedule on *master* nodes as this is not a default toleration. ## Communicating with Daemon Pods @@ -201,3 +251,5 @@ Use a Deployment for stateless services, like frontends, where scaling up and do number of replicas and rolling out updates are more important than controlling exactly which host the Pod runs on. Use a DaemonSet when it is important that a copy of a Pod always run on all or certain hosts, and when it needs to start before other Pods. + +{{% /capture %}} diff --git a/content/en/docs/concepts/workloads/controllers/deployment.md b/content/en/docs/concepts/workloads/controllers/deployment.md index ef79cd7d4c3b8..92d7b67ddd321 100644 --- a/content/en/docs/concepts/workloads/controllers/deployment.md +++ b/content/en/docs/concepts/workloads/controllers/deployment.md @@ -40,7 +40,7 @@ The following are typical use cases for Deployments: The following is an example of a Deployment. It creates a ReplicaSet to bring up three `nginx` Pods: -{{< code file="nginx-deployment.yaml" >}} +{{< codenew file="controllers/nginx-deployment.yaml" >}} In this example: @@ -71,7 +71,7 @@ The `template` field contains the following instructions: To create this Deployment, run the following command: ```shell -kubectl create -f https://raw.githubusercontent.com/kubernetes/website/master/content/en/docs/concepts/workloads/controllers/nginx-deployment.yaml +kubectl create -f https://k8s.io/examples/controllers/nginx-deployment.yaml ``` {{< note >}} @@ -417,7 +417,7 @@ First, check the revisions of this deployment: $ kubectl rollout history deployment/nginx-deployment deployments "nginx-deployment" REVISION CHANGE-CAUSE -1 kubectl create -f docs/user-guide/nginx-deployment.yaml --record +1 kubectl create -f https://k8s.io/examples/controllers/nginx-deployment.yaml --record 2 kubectl set image deployment/nginx-deployment nginx=nginx:1.9.1 3 kubectl set image deployment/nginx-deployment nginx=nginx:1.91 ``` diff --git a/content/en/docs/concepts/workloads/controllers/garbage-collection.md b/content/en/docs/concepts/workloads/controllers/garbage-collection.md index 4fcf1fbc44535..ed4aa90cfe7ee 100644 --- a/content/en/docs/concepts/workloads/controllers/garbage-collection.md +++ b/content/en/docs/concepts/workloads/controllers/garbage-collection.md @@ -36,17 +36,17 @@ setting the `ownerReference` field. Here's a configuration file for a ReplicaSet that has three Pods: -{{< code file="my-repset.yaml" >}} +{{< codenew file="controllers/replicaset.yaml" >}} If you create the ReplicaSet and then view the Pod metadata, you can see OwnerReferences field: ```shell -kubectl create -f https://k8s.io/docs/concepts/controllers/my-repset.yaml +kubectl create -f https://k8s.io/examples/controllers/replicaset.yaml kubectl get pods --output=yaml ``` -The output shows that the Pod owner is a ReplicaSet named my-repset: +The output shows that the Pod owner is a ReplicaSet named `my-repset`: ```shell apiVersion: v1 @@ -110,15 +110,15 @@ field on the `deleteOptions` argument when deleting an Object. Possible values i Prior to Kubernetes 1.9, the default garbage collection policy for many controller resources was `orphan`. This included ReplicationController, ReplicaSet, StatefulSet, DaemonSet, and -Deployment. For kinds in the extensions/v1beta1, apps/v1beta1, and apps/v1beta2 group versions, unless you -specify otherwise, dependent objects are orphaned by default. In Kubernetes 1.9, for all kinds in the apps/v1 +Deployment. For kinds in the `extensions/v1beta1`, `apps/v1beta1`, and `apps/v1beta2` group versions, unless you +specify otherwise, dependent objects are orphaned by default. In Kubernetes 1.9, for all kinds in the `apps/v1` group version, dependent objects are deleted by default. Here's an example that deletes dependents in background: ```shell kubectl proxy --port=8080 -curl -X DELETE localhost:8080/apis/extensions/v1beta1/namespaces/default/replicasets/my-repset \ +curl -X DELETE localhost:8080/apis/apps/v1/namespaces/default/replicasets/my-repset \ -d '{"kind":"DeleteOptions","apiVersion":"v1","propagationPolicy":"Background"}' \ -H "Content-Type: application/json" ``` @@ -127,7 +127,7 @@ Here's an example that deletes dependents in foreground: ```shell kubectl proxy --port=8080 -curl -X DELETE localhost:8080/apis/extensions/v1beta1/namespaces/default/replicasets/my-repset \ +curl -X DELETE localhost:8080/apis/apps/v1/namespaces/default/replicasets/my-repset \ -d '{"kind":"DeleteOptions","apiVersion":"v1","propagationPolicy":"Foreground"}' \ -H "Content-Type: application/json" ``` @@ -136,7 +136,7 @@ Here's an example that orphans dependents: ```shell kubectl proxy --port=8080 -curl -X DELETE localhost:8080/apis/extensions/v1beta1/namespaces/default/replicasets/my-repset \ +curl -X DELETE localhost:8080/apis/apps/v1/namespaces/default/replicasets/my-repset \ -d '{"kind":"DeleteOptions","apiVersion":"v1","propagationPolicy":"Orphan"}' \ -H "Content-Type: application/json" ``` diff --git a/content/en/docs/concepts/workloads/controllers/jobs-run-to-completion.md b/content/en/docs/concepts/workloads/controllers/jobs-run-to-completion.md index 9b9b8ab124b46..1b0c5a388b5fb 100644 --- a/content/en/docs/concepts/workloads/controllers/jobs-run-to-completion.md +++ b/content/en/docs/concepts/workloads/controllers/jobs-run-to-completion.md @@ -3,12 +3,11 @@ reviewers: - erictune - soltysh title: Jobs - Run to Completion +content_template: templates/concept weight: 70 --- -{{< toc >}} - -## What is a Job? +{{% capture overview %}} A _job_ creates one or more pods and ensures that a specified number of them successfully terminate. As pods successfully complete, the _job_ tracks the successful completions. When a specified number @@ -21,17 +20,23 @@ due to a node hardware failure or a node reboot). A Job can also be used to run multiple pods in parallel. +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ## Running an example Job Here is an example Job config. It computes π to 2000 places and prints it out. It takes around 10s to complete. -{{< code file="job.yaml" >}} +{{< codenew file="controllers/job.yaml" >}} Run the example job by downloading the example file and then running this command: ```shell -$ kubectl create -f ./job.yaml +$ kubectl create -f https://k8s.io/examples/controllers/job.yaml job "pi" created ``` @@ -123,7 +128,7 @@ There are three main types of jobs: 1. Parallel Jobs with a *fixed completion count*: - specify a non-zero positive value for `.spec.completions`. - the job is complete when there is one successful pod for each value in the range 1 to `.spec.completions`. - - **not implemented yet:** each pod passed a different index in the range 1 to `.spec.completions`. + - **not implemented yet:** Each pod passed a different index in the range 1 to `.spec.completions`. 1. Parallel Jobs with a *work queue*:  - do not specify `.spec.completions`, default to `.spec.parallelism`.  - the pods must coordinate with themselves or an external service to determine what each should work on. @@ -395,3 +400,5 @@ object, but complete control over what pods are created and how work is assigned ## Cron Jobs Support for creating Jobs at specified times/dates (i.e. cron) is available in Kubernetes [1.4](https://github.com/kubernetes/kubernetes/pull/11980). More information is available in the [cron job documents](/docs/concepts/workloads/controllers/cron-jobs/) + +{{% /capture %}} diff --git a/content/en/docs/concepts/workloads/controllers/replicaset.md b/content/en/docs/concepts/workloads/controllers/replicaset.md index c0aee35a2bbf5..ddf97a0e2aa9b 100644 --- a/content/en/docs/concepts/workloads/controllers/replicaset.md +++ b/content/en/docs/concepts/workloads/controllers/replicaset.md @@ -51,13 +51,13 @@ use a Deployment instead, and define your application in the spec section. ## Example -{{< code file="frontend.yaml" >}} +{{< codenew file="controllers/frontend.yaml" >}} Saving this manifest into `frontend.yaml` and submitting it to a Kubernetes cluster should create the defined ReplicaSet and the pods that it manages. ```shell -$ kubectl create -f frontend.yaml +$ kubectl create -f http://k8s.io/examples/controllers/frontend.yaml replicaset "frontend" created $ kubectl describe rs/frontend Name: frontend @@ -192,14 +192,14 @@ A ReplicaSet can also be a target for a ReplicaSet can be auto-scaled by an HPA. Here is an example HPA targeting the ReplicaSet we created in the previous example. -{{< code file="hpa-rs.yaml" >}} +{{< codenew file="controllers/hpa-rs.yaml" >}} Saving this manifest into `hpa-rs.yaml` and submitting it to a Kubernetes cluster should create the defined HPA that autoscales the target ReplicaSet depending on the CPU usage of the replicated pods. ```shell -kubectl create -f hpa-rs.yaml +kubectl create -f https://k8s.io/examples/controllers/hpa-rs.yaml ``` Alternatively, you can use the `kubectl autoscale` command to accomplish the same diff --git a/content/en/docs/concepts/workloads/controllers/replicationcontroller.md b/content/en/docs/concepts/workloads/controllers/replicationcontroller.md index 5424cd1be1402..c9e23e5beccb5 100644 --- a/content/en/docs/concepts/workloads/controllers/replicationcontroller.md +++ b/content/en/docs/concepts/workloads/controllers/replicationcontroller.md @@ -44,12 +44,12 @@ service, such as web servers. This example ReplicationController config runs three copies of the nginx web server. -{{< code file="replication.yaml" >}} +{{< codenew file="controllers/replication.yaml" >}} Run the example job by downloading the example file and then running this command: ```shell -$ kubectl create -f ./replication.yaml +$ kubectl create -f https://k8s.io/examples/controllers/replication.yaml replicationcontroller "nginx" created ``` diff --git a/content/en/docs/concepts/workloads/pods/disruptions.md b/content/en/docs/concepts/workloads/pods/disruptions.md index 86f04ee7a82af..1a620c9b75af5 100644 --- a/content/en/docs/concepts/workloads/pods/disruptions.md +++ b/content/en/docs/concepts/workloads/pods/disruptions.md @@ -76,7 +76,7 @@ and [stateful](/docs/tasks/run-application/run-replicated-stateful-application/) spread applications across racks (using [anti-affinity](/docs/user-guide/node-selection/#inter-pod-affinity-and-anti-affinity-beta-feature)) or across zones (if using a -[multi-zone cluster](/docs/admin/multiple-zones).) +[multi-zone cluster](/docs/setup/multiple-zones).) The frequency of voluntary disruptions varies. On a basic Kubernetes cluster, there are no voluntary disruptions at all. However, your cluster administrator or hosting provider diff --git a/content/en/docs/concepts/workloads/pods/pod-lifecycle.md b/content/en/docs/concepts/workloads/pods/pod-lifecycle.md index 4c056aa2b6196..b94d7a595d96f 100644 --- a/content/en/docs/concepts/workloads/pods/pod-lifecycle.md +++ b/content/en/docs/concepts/workloads/pods/pod-lifecycle.md @@ -32,33 +32,46 @@ have a given `phase` value. Here are the possible values for `phase`: -* 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. +Value | Description +:-----|:----------- +`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. That is, 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. -* 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. +## Pod conditions -* Succeeded: All Containers in the Pod have terminated in success, and will not - be restarted. +A Pod has a PodStatus, which has an array of +[PodConditions](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#podcondition-v1-core) +through which the Pod has or has not passed. Each element of the PodCondition +array has six possible fields: -* Failed: All Containers in the Pod have terminated, and at least one Container - has terminated in failure. That is, the Container either exited with non-zero - status or was terminated by the system. +* The `lastProbeTime` field provides a timestamp for when the Pod condition + was last probed. -* 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. +* The `lastTransitionTime` field provides a timestamp for when the Pod + last transitioned from one status to another. -## Pod conditions +* The `message` field is a human-readable message indicating details + about the transition. A Pod has a PodStatus, which has an array of [PodConditions](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#podcondition-v1-core). Each element of the PodCondition array has a `type` field and a `status` field. The `type` -field is a string, with possible values PodScheduled, Ready, Initialized, and -Unschedulable. The `status` field is a string, with possible values True, False, -and Unknown. +field is a string with the following possible values: + +* `PodScheduled`: the Pod has been scheduled to a node; +* `Ready`: the Pod is able to serve requests and should be added to the load + balancing pools of all matching Services; +* `Initialized`: all [init containers](/docs/concepts/workloads/pods/init-containers) + have started successfully; +* `Unschedulable`: the scheduler cannot schedule the Pod right now, for example + due to lacking of resources or other constraints; +* `ContainersReady`: all containers in the Pod are ready. + +The `status` field is a string, with possible values "`True`", "`False`", and +"`Unknown`". ## Container probes @@ -130,7 +143,8 @@ puts itself into an unready state regardless of whether the readiness probe exis The Pod remains in the unready state while it waits for the Containers in the Pod to stop. -For more information about how to set up a liveness or readiness probe, see [Configure Liveness and Readiness Probes](/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/). +For more information about how to set up a liveness or readiness probe, see +[Configure Liveness and Readiness Probes](/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/). ## Pod and Container status @@ -141,6 +155,58 @@ and Note that the information reported as Pod status depends on the current [ContainerState](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#containerstatus-v1-core). +## Pod readiness gate + +{{< feature-state for_k8s_version="v1.11" state="alpha" >}} + +In order to add extensibility to Pod readiness by enabling the injection of +extra feedbacks or signals into `PodStatus`, Kubernetes 1.11 introduced a +feature named [Pod ready++](https://github.com/kubernetes/community/blob/master/keps/sig-network/0007-pod-ready%2B%2B.md). +You can use the new field `ReadinessGate` in the `PodSpec` to specify additional +conditions to be evaluated for Pod readiness. If Kubernetes cannot find such a +condition in the `status.conditions` field of a Pod, the status of the condition +is default to "`False`". Below is an example: + +```yaml +Kind: Pod +... +spec: + readinessGates: + - conditionType: "www.example.com/feature-1" +status: + conditions: + - type: Ready # this is a builtin PodCondition + status: "True" + lastProbeTime: null + lastTransitionTime: 2018-01-01T00:00:00Z + - type: "www.example.com/feature-1" # an extra PodCondition + status: "False" + lastProbeTIme: null + lastTransitionTime: 2018-01-01T00:00:00Z + containerStatuses: + - containerID: docker://abcd... + ready: true +... +``` + +The new Pod conditions must comply with Kubernetes [label key format](/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set). +Since the `kubectl patch` command still doesn't support patching object status, +the new Pod conditions have to be injected through the `PATCH` action using +one of the [KubeClient libraries](/docs/reference/using-api/client-librarie/). + +With the introduction of new Pod conditions, a Pod is evaluated to be ready **only** +when both the following statements are true: + +* All containers in the Pod are ready. +* All conditions specified in `ReadinessGates` are "`True`". + +To facilitate this change to Pod readiness evaluation, a new Pod condition +`ContainersReady` is introduced to capture the old Pod `Ready` condition. + +As an alpha feature, the "Pod Ready++" feature has to be explicitly enabled by +setting the `PodReadinessGates` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) +to True. + ## Restart policy A PodSpec has a `restartPolicy` field with possible values Always, OnFailure, @@ -154,7 +220,6 @@ minutes of successful execution. As discussed in the once bound to a node, a Pod will never be rebound to another node. - ## Pod lifetime In general, Pods do not disappear until someone destroys them. This might be a diff --git a/content/en/docs/concepts/workloads/pods/pod.md b/content/en/docs/concepts/workloads/pods/pod.md index 23f3cf3fe5328..d3fbee3e916a9 100644 --- a/content/en/docs/concepts/workloads/pods/pod.md +++ b/content/en/docs/concepts/workloads/pods/pod.md @@ -1,15 +1,21 @@ --- reviewers: title: Pods +content_template: templates/concept weight: 20 --- -{{< toc >}} - +{{% capture overview %}} _Pods_ are the smallest deployable units of computing that can be created and managed in Kubernetes. +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ## What is a Pod? A _pod_ (as in a pod of whales or pea pod) is a group of one or more containers @@ -199,3 +205,5 @@ spec.containers[0].securityContext.privileged: forbidden '<*>(0xc20b222db0)true' Pod is a top-level resource in the Kubernetes REST API. More details about the API object can be found at: [Pod API object](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#pod-v1-core). + +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/getting-started-guides/ubuntu/validation.md b/content/en/docs/getting-started-guides/ubuntu/validation.md index 13d65a88de043..611eed822285d 100644 --- a/content/en/docs/getting-started-guides/ubuntu/validation.md +++ b/content/en/docs/getting-started-guides/ubuntu/validation.md @@ -90,7 +90,7 @@ a deployed cluster. The following example will skip the `Flaky`, `Slow`, and juju run-action kubernetes-e2e/0 test skip='\[(Flaky|Slow|Feature:.*)\]' {{< note >}} -**Note:** the escaping of the regex due to how bash handles brackets. +**Note:** The escaping of the regex due to how bash handles brackets. {{< /note >}} To see the different types of tests the Kubernetes end-to-end charm has access diff --git a/content/en/docs/getting-started-guides/windows/_index.md b/content/en/docs/getting-started-guides/windows/_index.md index a0d153193a27f..5efb00af98afa 100644 --- a/content/en/docs/getting-started-guides/windows/_index.md +++ b/content/en/docs/getting-started-guides/windows/_index.md @@ -158,6 +158,12 @@ Note: this file assumes that a user previous created 'l2bridge' host networks on #### For 3. Open vSwitch (OVS) & Open Virtual Network (OVN) with Overlay +{{< note >}} +**Note:** Fully automated setup via Ansible playbooks is [available](https://github.com/openvswitch/ovn-kubernetes/tree/master/contrib). +{{< /note >}} + +For manual setup, continue the following steps. + ##### Linux Host Setup Setting up the central node and the components needed is out of scope of this document. You can read [these instructions](https://github.com/openvswitch/ovn-kubernetes#k8s-master-node-initialization) for that. @@ -255,112 +261,24 @@ The examples listed below assume running Windows nodes on Windows Server 1709. I ### Scheduling Pods on Windows Because your cluster has both Linux and Windows nodes, you must explicitly set the `nodeSelector` constraint to be able to schedule pods to Windows nodes. You must set nodeSelector with the label `beta.kubernetes.io/os` to the value `windows`; see the following example: -```yaml -{ - "apiVersion": "v1", - "kind": "Pod", - "metadata": { - "name": "iis", - "labels": { - "name": "iis" - } - }, - "spec": { - "containers": [ - { - "name": "iis", - "image": "microsoft/iis:windowsservercore-1709", - "ports": [ - { - "containerPort": 80 - } - ] - } - ], - "nodeSelector": { - "beta.kubernetes.io/os": "windows" - } - } -} -``` -**Note:** this example assumes you are running on Windows Server 1709, so uses the image tag to support that. If you are on a different version, you will need to update the tag. For example, if on Windows Server 2016, update to use `"image": "microsoft/iis"` which will default to that OS version. +{{< codenew file="windows/simple-pod.yaml" >}} + +{{< note >}} +**Note:** This example assumes you are running on Windows Server 1709, so uses the image tag to support that. If you are on a different version, you will need to update the tag. For example, if on Windows Server 2016, update to use `"image": "microsoft/iis"` which will default to that OS version. +{{< /note >}} ### Secrets and ConfigMaps Secrets and ConfigMaps can be utilized in Windows Server Containers, but must be used as environment variables. See limitations section below for additional details. **Examples:** - Windows pod with secrets mapped to environment variables - ```yaml - apiVersion: v1 - kind: Secret - metadata: - name: mysecret - type: Opaque - data: - username: YWRtaW4= - password: MWYyZDFlMmU2N2Rm - - --- - - apiVersion: v1 - kind: Pod - metadata: - name: my-secret-pod - spec: - containers: - - name: my-secret-pod - image: microsoft/windowsservercore:1709 - env: - - name: USERNAME - valueFrom: - secretKeyRef: - name: mysecret - key: username - - name: PASSWORD - valueFrom: - secretKeyRef: - name: mysecret - key: password - nodeSelector: - beta.kubernetes.io/os: windows -``` +Windows pod with secrets mapped to environment variables - Windows pod with configMap values mapped to environment variables +{{< codenew file="windows/secret-pod.yaml" >}} -```yaml -kind: ConfigMap -apiVersion: v1 -metadata: - name: example-config -data: - example.property.1: hello - example.property.2: world +Windows Pod with configMap values mapped to environment variables ---- - -apiVersion: v1 -kind: Pod -metadata: - name: my-configmap-pod -spec: - containers: - - name: my-configmap-pod - image: microsoft/windowsservercore:1709 - env: - - name: EXAMPLE_PROPERTY_1 - valueFrom: - configMapKeyRef: - name: example-config - key: example.property.1 - - name: EXAMPLE_PROPERTY_2 - valueFrom: - configMapKeyRef: - name: example-config - key: example.property.2 - nodeSelector: - beta.kubernetes.io/os: windows -``` +{{< codenew file="windows/configmap-pod.yaml" >}} ### Volumes Some supported Volume Mounts are local, emptyDir, hostPath. One thing to remember is that paths must either be escaped, or use forward slashes, for example `mountPath: "C:\\etc\\foo"` or `mountPath: "C:/etc/foo"`. @@ -369,76 +287,19 @@ Persistent Volume Claims are supported for supported volume types. **Examples:** - Windows pod with a hostPath volume - ```yaml - apiVersion: v1 - kind: Pod - metadata: - name: my-hostpath-volume-pod - spec: - containers: - - name: my-hostpath-volume-pod - image: microsoft/windowsservercore:1709 - volumeMounts: - - name: foo - mountPath: "C:\\etc\\foo" - readOnly: true - nodeSelector: - beta.kubernetes.io/os: windows - volumes: - - name: foo - hostPath: - path: "C:\\etc\\foo" - ``` - - Windows pod with multiple emptyDir volumes - - ```yaml - apiVersion: v1 - kind: Pod - metadata: - name: my-empty-dir-pod - spec: - containers: - - image: microsoft/windowsservercore:1709 - name: my-empty-dir-pod - volumeMounts: - - mountPath: /cache - name: cache-volume - - mountPath: C:/scratch - name: scratch-volume - volumes: - - name: cache-volume - emptyDir: {} - - name: scratch-volume - emptyDir: {} - nodeSelector: - beta.kubernetes.io/os: windows - ``` +Windows pod with a hostPath volume + +{{< codenew file="windows/hostpath-volume-pod.yaml" >}} + +Windows pod with multiple emptyDir volumes + +{{< codenew file="windows/emptydir-pod.yaml" >}} ### DaemonSets DaemonSets are supported -```yaml -apiVersion: extensions/v1beta1 -kind: DaemonSet -metadata: - name: my-DaemonSet - labels: - app: foo -spec: - template: - metadata: - labels: - app: foo - spec: - containers: - - name: foo - image: microsoft/windowsservercore:1709 - nodeSelector: - beta.kubernetes.io/os: windows -``` +{{< codenew file="windows/daemonset.yaml" >}} ### Metrics @@ -448,53 +309,13 @@ Windows Stats use a hybrid model: pod and container level stats come from CRI (v Container resources (CPU and memory) could be set now for windows containers in v1.10. -```yaml -apiVersion: apps/v1 -kind: Deployment -metadata: - name: iis -spec: - replicas: 3 - template: - metadata: - labels: - app: iis - spec: - containers: - - name: iis - image: microsoft/iis - resources: - limits: - memory: "128Mi" - cpu: 2 - ports: - - containerPort: 80 -``` +{{< codenew file="windows/deploy-resource.yaml" >}} ### Hyper-V Containers Hyper-V containers are supported as experimental in v1.10. To create a Hyper-V container, kubelet should be started with feature gates `HyperVContainer=true` and Pod should include annotation `experimental.windows.kubernetes.io/isolation-type=hyperv`. -```yaml -apiVersion: apps/v1 -kind: Deployment -metadata: - name: iis -spec: - replicas: 3 - template: - metadata: - labels: - app: iis - annotations: - experimental.windows.kubernetes.io/isolation-type: hyperv - spec: - containers: - - name: iis - image: microsoft/iis - ports: - - containerPort: 80 -``` +{{< codenew file="windows/deploy-hyperv.yaml" >}} ### Kubelet and kube-proxy can now run as Windows services @@ -551,3 +372,4 @@ Some of these limitations will be addressed by the community in future releases - Support for Windows is in Beta as of v1.9 and your feedback is welcome. For information on getting involved, please head to [SIG-Windows](https://github.com/kubernetes/community/blob/master/sig-windows/README.md) - Troubleshooting and Common Problems: [Link](https://docs.microsoft.com/en-us/virtualization/windowscontainers/kubernetes/common-problems) + diff --git a/content/en/docs/getting-started-guides/windows/emptydir-pod.yaml b/content/en/docs/getting-started-guides/windows/emptydir-pod.yaml deleted file mode 100644 index 8a3a2133a68cb..0000000000000 --- a/content/en/docs/getting-started-guides/windows/emptydir-pod.yaml +++ /dev/null @@ -1,20 +0,0 @@ -apiVersion: v1 -kind: Pod -metadata: - name: empty-dir-pod -spec: - containers: - - image: redis:3.0-nanoserver - name: empty-dir-redis - volumeMounts: - - mountPath: /cache - name: cache-volume - - mountPath: C:/scratch - name: scratch-volume - volumes: - - name: cache-volume - emptyDir: {} - - name: scratch-volume - emptyDir: {} - nodeSelector: - beta.kubernetes.io/os: windows \ No newline at end of file diff --git a/content/en/docs/imported/community/devel.md b/content/en/docs/imported/community/devel.md index 750c4d563e3fb..533e286a69034 100644 --- a/content/en/docs/imported/community/devel.md +++ b/content/en/docs/imported/community/devel.md @@ -13,7 +13,7 @@ Guide](http://kubernetes.io/docs/admin/). * **Contributor Guide** ([Please start here](https://github.com/kubernetes/community/tree/master/contributors/guide/README.md)) to learn about how to contribute to Kubernetes -* **GitHub Issues** ([issues.md](https://github.com/kubernetes/community/tree/master/contributors/devel/issues.md)): How incoming issues are triaged. +* **GitHub Issues** ([issues-triage.md](https://github.com/kubernetes/community/blob/master/contributors/guide/issue-triage.md)): How incoming issues are triaged. * **Pull Request Process** ([/contributors/guide/pull-requests.md](https://github.com/kubernetes/community/tree/master/contributors/guide/pull-requests.md)): When and why pull requests are closed. @@ -59,7 +59,7 @@ Guide](http://kubernetes.io/docs/admin/). * **API Conventions** ([api-conventions.md](https://github.com/kubernetes/community/tree/master/contributors/devel/api-conventions.md)): Defining the verbs and resources used in the Kubernetes API. -* **API Client Libraries** ([client-libraries.md](https://github.com/kubernetes/community/tree/master/contributors/devel/client-libraries.md)): +* **API Client Libraries** ([client-libraries](/docs/reference/using-api/client-libraries/)): A list of existing client libraries, both supported and user-contributed. diff --git a/content/en/docs/imported/release/notes.md b/content/en/docs/imported/release/notes.md index 750afc7f04974..8dce51dcef36a 100644 --- a/content/en/docs/imported/release/notes.md +++ b/content/en/docs/imported/release/notes.md @@ -1,1947 +1,720 @@ --- -title: v1.10 Release Notes +title: v1.11 Release Notes +content_template: templates/concept --- - +{{% capture overview %}} - +[Documentation](https://docs.k8s.io) & [Examples](https://releases.k8s.io/release-1.11/examples) - - - -# v1.10.0 - -[Documentation](https://docs.k8s.io) & [Examples](https://releases.k8s.io/release-1.10/examples) - -## Downloads for v1.10.0 +## Downloads for v1.11.0 filename | sha256 hash -------- | ----------- -[kubernetes.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes.tar.gz) | `a48d4f6eb4bf329a87915d2264250f2045aab1e8c6cc3e574a887ec42b5c6edc` -[kubernetes-src.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-src.tar.gz) | `3b51bf50370fc022f5e4578b071db6b63963cd64b35c41954d4a2a8f6738c0a7` +[kubernetes.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes.tar.gz) | `3c779492574a5d8ce702d89915184f5dd52280da909abf134232e5ab00b4a885` +[kubernetes-src.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-src.tar.gz) | `f0b2d8e61860acaf50a9bae0dc36b8bfdb4bb41b8d0a1bb5a9bc3d87aad3b794` ### Client Binaries filename | sha256 hash -------- | ----------- -[kubernetes-client-darwin-386.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-client-darwin-386.tar.gz) | `8f35d820d21bfdb3186074eb2ed5212b983e119215356a7a76a9f773f2a1e6a3` -[kubernetes-client-darwin-amd64.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-client-darwin-amd64.tar.gz) | `ae06d0cd8f6fa8d145a9dbdb77e6cba99ad9cfce98b01c766df1394c17443e42` -[kubernetes-client-linux-386.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-client-linux-386.tar.gz) | `8147723a68763b9791def5b41d75745e835ddd82f23465a2ba7797b84ad73554` -[kubernetes-client-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-client-linux-amd64.tar.gz) | `845668fe2f854b05aa6f0b133314df83bb41a486a6ba613dbb1374bf3fbe8720` -[kubernetes-client-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-client-linux-arm.tar.gz) | `5d2552a6781ef0ecaf308fe6a02637faef217c98841196d4bd7c52a0f1a4bfa0` -[kubernetes-client-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-client-linux-arm64.tar.gz) | `9d5e4ba43ad7250429015f33f728c366daa81e894e8bfe8063d73ce990e82944` -[kubernetes-client-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-client-linux-ppc64le.tar.gz) | `acabf3a26870303641ce60a59b5bb9702c8a7445b16f4293abc7868e91d252c8` -[kubernetes-client-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-client-linux-s390x.tar.gz) | `8d836df10b50d11434b5ee797aecc21714723f02fc47fe3dd600426eb83b9e38` -[kubernetes-client-windows-386.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-client-windows-386.tar.gz) | `ca183b66f910ff11fa468e47251c68d256ef145fcfc2d23d4347d066e7787971` -[kubernetes-client-windows-amd64.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-client-windows-amd64.tar.gz) | `817aea754a059c635f4d690aa0232a8e77eb74e76357cafd8f10556972022e9e` +[kubernetes-client-darwin-386.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-client-darwin-386.tar.gz) | `196738ef058510438b3129f0a72544544b7d52a8732948b4f9358781f87dab59` +[kubernetes-client-darwin-amd64.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-client-darwin-amd64.tar.gz) | `9ec8357b10b79f8fd87f3a836879d0a4bb46fb70adbb82f1e34dc7e91d74999f` +[kubernetes-client-linux-386.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-client-linux-386.tar.gz) | `e8ee8a965d3ea241d9768b9ac868ecbbee112ef45038ff219e4006fa7f4ab4e2` +[kubernetes-client-linux-amd64.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-client-linux-amd64.tar.gz) | `d31377c92b4cc9b3da086bc1974cbf57b0d2c2b22ae789ba84cf1b7554ea7067` +[kubernetes-client-linux-arm.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-client-linux-arm.tar.gz) | `9e9da909293a4682a5d6270a39894b056b3e901532b15eb8fdc0814a8d628d65` +[kubernetes-client-linux-arm64.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-client-linux-arm64.tar.gz) | `149df9daac3e596042f5759977f9f9299a397130d9dddc2d4a2b513dd64f1092` +[kubernetes-client-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-client-linux-ppc64le.tar.gz) | `ff3d3e4714406d92e9a2b7ef2887519800b89f6592a756524f7a37dc48057f44` +[kubernetes-client-linux-s390x.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-client-linux-s390x.tar.gz) | `e5a39bdc1e474d9d00974a81101e043aaff37c30c1418fb85a0c2561465e14c7` +[kubernetes-client-windows-386.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-client-windows-386.tar.gz) | `4ba1102a33c6d4df650c4864a118f99a9882021fea6f250a35f4b4f4a2d68eaa` +[kubernetes-client-windows-amd64.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-client-windows-amd64.tar.gz) | `0bb74af7358f9a2f4139ed1c10716a2f5f0c1c13ab3af71a0621a1983233c8d7` ### Server Binaries filename | sha256 hash -------- | ----------- -[kubernetes-server-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-server-linux-amd64.tar.gz) | `f2e0505bee7d9217332b96be11d1b88c06f51049f7a44666b0ede80bfb92fdf6` -[kubernetes-server-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-server-linux-arm.tar.gz) | `a7be68c32a299c98353633f3161f910c4b970c8364ccee5f98e1991364b3ce69` -[kubernetes-server-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-server-linux-arm64.tar.gz) | `4df4add2891d02101818653ac68b57e6ce4760fd298f47467ce767ac029f4508` -[kubernetes-server-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-server-linux-ppc64le.tar.gz) | `199b52461930c0218f984884069770fb7e6ceaf66342d5855b209ff1889025b8` -[kubernetes-server-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-server-linux-s390x.tar.gz) | `578f93fc22d2a5bec7dc36633946eb5b7359d96233a2ce74f8b3c5a231494584` +[kubernetes-server-linux-amd64.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-server-linux-amd64.tar.gz) | `b8a8a88afd8a40871749b2362dbb21295c6a9c0a85b6fc87e7febea1688eb99e` +[kubernetes-server-linux-arm.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-server-linux-arm.tar.gz) | `88b9168013bb07a7e17ddc0638e7d36bcd2984d049a50a96f54cb4218647d8da` +[kubernetes-server-linux-arm64.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-server-linux-arm64.tar.gz) | `12fab9e9f0e032f278c0e114c72ea01899a0430fc772401f23e26de306e0f59f` +[kubernetes-server-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-server-linux-ppc64le.tar.gz) | `6616d726a651e733cfd4cccd78bfdc1d421c4a446edf4b617b8fd8f5e21f073e` +[kubernetes-server-linux-s390x.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-server-linux-s390x.tar.gz) | `291838980929c8073ac592219d9576c84a9bdf233585966c81a380c3d753316e` ### Node Binaries filename | sha256 hash -------- | ----------- -[kubernetes-node-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-node-linux-amd64.tar.gz) | `8c03412881eaab5f3ea828bbb81e8ebcfc092d311b2685585817531fa7c2a289` -[kubernetes-node-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-node-linux-arm.tar.gz) | `d6a413fcadb1b933a761ac9b0c864f596498a8ac3cc4922c1569306cd0047b1d` -[kubernetes-node-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-node-linux-arm64.tar.gz) | `46d6b74759fbc3b2aad42357f019dae0e882cd4639e499e31b5b029340dabd42` -[kubernetes-node-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-node-linux-ppc64le.tar.gz) | `bdecc12feab2464ad917623ade0cbf58675e0566db38284b79445841d246fc08` -[kubernetes-node-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-node-linux-s390x.tar.gz) | `afe35c2854f35939be75ccfb0ec81399acf4043ae7cf19dd6fbe6386288972c2` -[kubernetes-node-windows-amd64.tar.gz](https://dl.k8s.io/v1.10.0/kubernetes-node-windows-amd64.tar.gz) | `eac14e3420ca9769e067cbf929b5383cd77d56e460880a30c0df1bbfbb5a43db` - -## Major Themes - -### Node - -Many of the changes within SIG-Node revolve around control. With the beta release of the `kubelet.config.k8s.io` API group, a significant subset of Kubelet configuration can now be [configured via a versioned config file](https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/). Kubernetes v1.10 adds alpha support for the ability to [configure whether containers in a pod should share a single process namespace](https://github.com/kubernetes/features/issues/495), and the CRI has been upgraded to v1alpha2, which adds [support for Windows Container Configuration](https://github.com/kubernetes/features/issues/547). Kubernetes v1.10 also ships with the beta release of the [CRI validation test suite](https://github.com/kubernetes/features/issues/292). - -The Resource Management Working Group graduated three features to beta in the 1.10 release. First, [CPU Manager](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/), which allows users to request exclusive CPU cores. This helps performance in a variety of use-cases, including network latency sensitive applications, as well as applications that benefit from CPU cache residency. Next, [Huge Pages](https://kubernetes.io/docs/tasks/manage-hugepages/scheduling-hugepages/), which allows pods to consume either 2Mi or 1Gi Huge Pages. This benefits applications that consume large amounts of memory. Use of Huge Pages is a common tuning recommendation for databases and JVMs. Finally, the [Device Plugin](https://kubernetes.io/docs/concepts/cluster-administration/device-plugins/) feature, which provides a framework for vendors to advertise their resources to the Kubelet without changing Kubernetes core code. Targeted devices include GPUs, High-performance NICs, FPGAs, InfiniBand, and other similar computing resources that may require vendor specific initialization and setup. - -### Storage - -This release brings additional power to both local storage and Persistent Volumes. [Mount namespace propagation](https://github.com/kubernetes/features/issues/432) allows a container to mount a volume as rslave so that host mounts can be seen inside the container, or as rshared so that mounts made inside a container can be seen by the host. (Note that this is [not supported on Windows](https://github.com/kubernetes/kubernetes/pull/60275).) [Local Ephemeral Storage Capacity Isolation](https://github.com/kubernetes/features/issues/361) makes it possible to set requests and limits on ephemeral local storage resources. In addition, you can now create [Local Persistent Storage](https://github.com/kubernetes/features/issues/121), which enables PersistentVolumes to be created with locally attached disks, and not just network volumes. - -On the Persistent Volumes side, this release [Prevents deletion of Persistent Volume Claims that are used by a pod](https://github.com/kubernetes/features/issues/498) and [Persistent Volumes that are bound to a Persistent Volume Claim](https://github.com/kubernetes/features/issues/499), making it impossible to delete storage that is in use by a pod. - -This release also includes [Topology Aware Volume Scheduling](https://github.com/kubernetes/features/issues/490) for local persistent volumes, the stable release of [Detailed storage metrics of internal state](https://github.com/kubernetes/features/issues/496), and beta support for [Out-of-tree CSI Volume Plugins](https://github.com/kubernetes/features/issues/178). - -### Windows - -This release continues to enable more existing features on Windows, including container CPU resources, image filesystem stats, and flexvolumes. It also adds Windows service control manager support and experimental support for Hyper-V isolation of single-container pods. - -### OpenStack +[kubernetes-node-linux-amd64.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-node-linux-amd64.tar.gz) | `b23e905efb828fdffc4efc208f7343236b22c964e408fe889f529502aed4a335` +[kubernetes-node-linux-arm.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-node-linux-arm.tar.gz) | `44bf8973581887a2edd33eb637407e76dc0dc3a5abcc2ff04aec8338b533156d` +[kubernetes-node-linux-arm64.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-node-linux-arm64.tar.gz) | `51e481c782233b46ee21e9635c7d8c2a84450cbe30d7b1cbe5c5982b33f40b13` +[kubernetes-node-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-node-linux-ppc64le.tar.gz) | `d1a3feda31a954d3a83193a51a117873b6ef9f8acc3e10b3f1504fece91f2eb8` +[kubernetes-node-linux-s390x.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-node-linux-s390x.tar.gz) | `0ad76c6e6aef670c215256803b3b0d19f4730a0843429951c6421564c73d4932` +[kubernetes-node-windows-amd64.tar.gz](https://dl.k8s.io/v1.11.0/kubernetes-node-windows-amd64.tar.gz) | `8ad26200ed40d40a1b78d7a5dbe56220f0813d31194f40f267b476499fe2c5c3` -SIG-OpenStack updated the OpenStack provider to use newer APIs, consolidated community code into one repository, engaged with the Cloud Provider Working Group to have a consistent plan for moving provider code into individual repositories, improved testing of provider code, and strengthened ties with the OpenStack developer community. +## Urgent Upgrade Notes -### API-machinery +{{< caution >}} +**Caution**: You **MUST** do this before you upgrade! +{{< /caution >}} -[API Aggregation](https://github.com/kubernetes/features/issues/263) has been upgraded to "stable" in Kubernetes 1.10, so you can use it in production. Webhooks have seen numerous improvements, including alpha [Support for self-hosting authorizer webhooks](https://github.com/kubernetes/features/issues/516). +Before upgrading to Kubernetes 1.11, you must keep the following in mind: -### Auth +* **JSON configuration files that contain fields with incorrect case will no longer be valid. You must correct these files before upgrading.** When specifying keys in JSON resource definitions during direct API server communication, the keys are case-sensitive. A bug introduced in Kubernetes 1.8 caused the API server to accept a request with incorrect case and coerce it to correct case, but this behaviour has been fixed in 1.11 and the API server will once again be enforcing the correct case. It’s worth noting that during this time, the `kubectl` tool continued to enforce case-sensitive keys, so users that strictly manage resources with `kubectl` will be unaffected by this change. ([#65034](https://github.com/kubernetes/kubernetes/pull/65034), [@caesarxuchao](https://github.com/caesarxuchao)) +* **[Pod priority and preemption](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/) is now enabled by default.** Note that this means that pods from *any* namespace can now request priority classes that compete with and/or cause preemption of critical system pods that are already running. If that is not desired, disable the PodPriority feature by setting `--feature-gates=PodPriority=false` on the kube-apiserver, kube-scheduler, and kubelet components before upgrading to 1.11. Disabling the PodPriority feature limits [critical pods](https://kubernetes.io/docs/tasks/administer-cluster/guaranteed-scheduling-critical-addon-pods/#marking-pod-as-critical-when-priorites-are-enabled) to the `kube-system` namespace. -This release lays the groundwork for new authentication methods, including the alpha release of [External client-go credential providers](https://github.com/kubernetes/features/issues/541) and the [TokenRequest API](https://github.com/kubernetes/features/issues/542). In addition, [Pod Security Policy](https://github.com/kubernetes/features/issues/5) now lets administrators decide what contexts pods can run in, and gives administrators the ability to [limit node access to the API](https://github.com/kubernetes/features/issues/279). +{{% /capture %}} -### Azure +{{< toc >}} -Kubernetes 1.10 includes alpha [Azure support for cluster-autoscaler](https://github.com/kubernetes/features/issues/514), as well as [support for Azure Virtual Machine Scale Sets](https://github.com/kubernetes/features/issues/513). +{{% capture body %}} -### CLI - -This release includes a change to [kubectl get and describe to work better with extensions](https://github.com/kubernetes/features/issues/515), as the server, rather than the client, returns this information for a smoother user experience. - -### Network - -In terms of networking, Kubernetes 1.10 is about control. Users now have beta support for the ability to [configure a pod's resolv.conf](https://github.com/kubernetes/features/issues/504), rather than relying on the cluster DNS, as well as [configuring the NodePort IP address](https://github.com/kubernetes/features/issues/539). You can also [switch the default DNS plugin to CoreDNS](https://github.com/kubernetes/features/issues/427) (beta). - -## Before Upgrading - -* In-place node upgrades to this release from versions 1.7.14, 1.8.9, and 1.9.4 are not supported if using subpath volumes with PVCs. Such pods should be drained from the node first. - -* The minimum supported version of Docker is now 1.11; if you are using Docker 1.10 or below, be sure to upgrade Docker before upgrading Kubernetes. ([#57845](https://github.com/kubernetes/kubernetes/pull/57845), [@yujuhong](https://github.com/yujuhong)) - -* The Container Runtime Interface (CRI) version has increased from v1alpha1 to v1alpha2. Runtimes implementing the CRI will need to update to the new version, which configures container namespaces using an enumeration rather than booleans. This change to the alpha API is not backwards compatible; implementations of the CRI such as containerd, will need to update to the new API version. ([#58973](https://github.com/kubernetes/kubernetes/pull/58973), [@verb](https://github.com/verb)) - -* The default Flexvolume plugin directory for COS images on GCE has changed to `/home/kubernetes/flexvolume`, rather than `/etc/srv/kubernetes/kubelet-plugins/volume/exec`. Existing Flexvolume installations in clusters using COS images must be moved to the new directory, and installation processes must be updated with the new path. ([#58171](https://github.com/kubernetes/kubernetes/pull/58171), [@verult](https://github.com/verult)) +## Major Themes -* Default values differ between the Kubelet's componentconfig (config file) API and the Kubelet's command line. Be sure to review the default values when migrating to using a config file. For example, the authz mode is set to "AlwaysAllow" if you rely on the command line, but defaults to the more secure "Webhook" mode if you load config from a file. ([#59666](https://github.com/kubernetes/kubernetes/pull/59666), [@mtaufen](https://github.com/mtaufen)) +### SIG API Machinery -* [GCP kube-up.sh] Variables that were part of kube-env that were only used for kubelet flags are no longer being set, and are being replaced by the more portable mechanism of the kubelet configuration file. The individual variables in the kube-env metadata entry were never meant to be a stable interface and this release note only applies if you are depending on them. ([#60020](https://github.com/kubernetes/kubernetes/pull/60020), [@roberthbailey](https://github.com/roberthbailey)) +This release SIG API Machinery focused mainly on CustomResources. For example, subresources for CustomResources are now beta and enabled by default. With this, updates to the `/status` subresource will disallow updates to all fields other than `.status` (not just `.spec` and `.metadata` as before). Also, `required` and `description` can be used at the root of the CRD OpenAPI validation schema when the `/status` subresource is enabled. -* kube-proxy: feature gates are now specified as a map when provided via a JSON or YAML KubeProxyConfiguration, rather than as a string of key-value pairs. For example: +In addition, users can now create multiple versions of CustomResourceDefinitions, but without any kind of automatic conversion, and CustomResourceDefinitions now allow specification of additional columns for `kubectl get` output via the `spec.additionalPrinterColumns` field. -KubeProxyConfiguration Before: +### SIG Auth -``` -apiVersion: kubeproxy.config.k8s.io/v1alpha1 -kind: KubeProxyConfiguration -**featureGates: "SupportIPVSProxyMode=true"** -``` +Work this cycle focused on graduating existing functions, and on making security functions more understandable for users. -KubeProxyConfiguration After: +RBAC [cluster role aggregation](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#aggregated-clusterroles), introduced in 1.9, graduated to stable status with no changes in 1.11, and [client-go credential plugins](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins) graduated to beta status, while also adding support for obtaining TLS credentials from an external plugin. -``` -apiVersion: kubeproxy.config.k8s.io/v1alpha1 -kind: KubeProxyConfiguration -**featureGates:** -** SupportIPVSProxyMode: true** -``` +Kubernetes 1.11 also makes it easier to see what's happening, as audit events can now be annotated with information about how an API request was handled: + * Authorization sets `authorization.k8s.io/decision` and `authorization.k8s.io/reason` annotations with the authorization decision ("allow" or "forbid") and a human-readable description of why the decision was made (for example, RBAC includes the name of the role/binding/subject which allowed a request). + * PodSecurityPolicy admission sets `podsecuritypolicy.admission.k8s.io/admit-policy` and `podsecuritypolicy.admission.k8s.io/validate-policy` annotations containing the name of the policy that allowed a pod to be admitted. (PodSecurityPolicy also gained the ability to [limit hostPath volume mounts to be read-only](https://kubernetes.io/docs/concepts/policy/pod-security-policy/#volumes-and-file-systems).) -([#57962](https://github.com/kubernetes/kubernetes/pull/57962), [@xiangpengzhao](https://github.com/xiangpengzhao)) +In addition, the NodeRestriction admission plugin now prevents kubelets from modifying taints on their Node API objects, making it easier to keep track of which nodes should be in use. -* The `kubeletconfig` API group has graduated from alpha to beta, and the name has changed to `kubelet.config.k8s.io`. Please use `kubelet.config.k8s.io/v1beta1`, as `kubeletconfig/v1alpha1` is no longer available. ([#53833](https://github.com/kubernetes/kubernetes/pull/53833), [@mtaufen](https://github.com/mtaufen)) +### SIG CLI -* kube-apiserver: the experimental in-tree Keystone password authenticator has been removed in favor of extensions that enable use of Keystone tokens. ([#59492](https://github.com/kubernetes/kubernetes/pull/59492), [@dims](https://github.com/dims)) +SIG CLI's main focus this release was on refactoring `kubectl` internals to improve composability, readability and testability of `kubectl` commands. Those refactors will allow the team to extract a mechanism for extensibility of kubectl -- that is, plugins -- in the next releases. -* The udpTimeoutMilliseconds field in the kube-proxy configuration file has been renamed to udpIdleTimeout. Administrators must update their files accordingly. ([#57754](https://github.com/kubernetes/kubernetes/pull/57754), [@ncdc](https://github.com/ncdc)) +### SIG Cluster Lifecycle -* The kubelet's `--cloud-provider=auto-detect` feature has been removed; make certain to specify the cloud provider. ([#56287](https://github.com/kubernetes/kubernetes/pull/56287), [@stewart-yu](https://github.com/stewart-yu)) +SIG Cluster Lifecycle focused on improving kubeadm’s user experience by including a set of new commands related to maintaining the kubeadm configuration file, the API version of which has now has been incremented to `v1alpha2`. These commands can handle the migration of the configuration to a newer version, printing the default configuration, and listing and pulling the required container images for bootstrapping a cluster. -* kube-apiserver: the OpenID Connect authenticator no longer accepts tokens from the Google v3 token APIs; users must switch to the "https://www.googleapis.com/oauth2/v4/token" endpoint. +Other notable changes include: +* CoreDNS replaces kube-dns as the default DNS provider +* Improved user experience for environments without a public internet connection and users using other CRI runtimes than Docker +* Support for structured configuration for the kubelet, which avoids the need to modify the systemd drop-in file +* Many improvements to the upgrade process and other bug fixes -* kube-apiserver: the root /proxy paths have been removed (deprecated since v1.2). Use the /proxy subresources on objects that support HTTP proxying. ([#59884](https://github.com/kubernetes/kubernetes/pull/59884), [@mikedanese](https://github.com/mikedanese)) +### SIG Instrumentation -* Eviction thresholds set to 0% or 100% will turn off eviction. ([#59681](https://github.com/kubernetes/kubernetes/pull/59681), [@mtaufen](https://github.com/mtaufen)) +As far as Sig Instrumentation, the major change in Kubernetes 1.11 is the deprecation of Heapster as part of ongoing efforts to move to the new Kubernetes monitoring model. Clusters still using Heapster for autoscaling should be migrated over to metrics-server and the custom metrics API. See the deprecation section for more information. -* CustomResourceDefinitions: OpenAPI v3 validation schemas containing `$ref`references are no longer permitted. Before upgrading, ensure CRD definitions do not include those `$ref` fields. ([#58438](https://github.com/kubernetes/kubernetes/pull/58438), [@carlory](https://github.com/carlory)) +### SIG Network -* Webhooks now do not skip cluster-scoped resources. Before upgrading your Kubernetes clusters, double check whether you have configured webhooks for cluster-scoped objects (e.g., nodes, persistentVolume), as these webhooks will start to take effect. Delete/modify the configs if that's not desirable. ([#58185](https://github.com/kubernetes/kubernetes/pull/58185), [@caesarxuchao](https://github.com/caesarxuchao)) +The main milestones for SIG Network this release are the graduation of IPVS-based load balancing and CoreDNS to general availability. -* Using kubectl gcp auth plugin with a Google Service Account to authenticate to a cluster now additionally requests a token with the "userinfo.email" scope. This way, users can write ClusterRoleBindings/RoleBindings with the email address of the service account directly. (This is a breaking change if the numeric uniqueIDs of the Google service accounts were being used in RBAC role bindings. The behavior can be overridden by explicitly specifying the scope values as comma-separated string in the "users[*].config.scopes" field in the KUBECONFIG file.) This way, users can now set a Google Service Account JSON key in the GOOGLE_APPLICATION_CREDENTIALS environment variable, craft a kubeconfig file with GKE master IP+CA cert, and authenticate to GKE in headless mode without requiring gcloud CLI. ([#58141](https://github.com/kubernetes/kubernetes/pull/58141), [@ahmetb](https://github.com/ahmetb)) +IPVS is an alternative approach to in-cluster load balancing that uses in-kernel hash tables rather than the previous iptables approach, while CoreDNS is a replacement for kube-dns for service discovery. -* kubectl port-forward no longer supports the deprecated -p flag; the flag itself is unnecessary and should be replaced by just the ``. ([#59705](https://github.com/kubernetes/kubernetes/pull/59705), [@phsiao](https://github.com/phsiao)) +### SIG Node -* Removed deprecated --require-kubeconfig flag, removed default --kubeconfig value (([#58367](https://github.com/kubernetes/kubernetes/pull/58367), [@zhangxiaoyu-zidif](https://github.com/zhangxiaoyu-zidif)) +SIG-Node advanced several features and made incremental improvements in a few key topic areas this release. -* The public-address-override, address, and port flags have been removed and replaced by bind-address, insecure-bind-address, and insecure-port, respectively. They are marked as deprecated in [#36604](https://github.com/kubernetes/kubernetes/pull/36604), which is more than a year ago. ([#59018](https://github.com/kubernetes/kubernetes/pull/59018), [@hzxuzhonghu](https://github.com/hzxuzhonghu)) +The dynamic kubelet config feature graduated to beta, so it is enabled by default, simplifying management of the node object itself. Kubelets that are configured to work with the CRI may take advantage of the log rotation feature, which is graduating to beta this release. -* The alpha `--init-config-dir` flag has been removed. Instead, use the `--config` flag to reference a kubelet configuration file directly. ([#57624](https://github.com/kubernetes/kubernetes/pull/57624), [@mtaufen](https://github.com/mtaufen)) +The cri-tools project, which aims to provide consistent tooling for operators to debug and introspect their nodes in production independent of their chosen container runtime, graduated to GA. -* Removed deprecated and unmaintained salt support. kubernetes-salt.tar.gz will no longer be published in the release tarball. ([#58248](https://github.com/kubernetes/kubernetes/pull/58248), [@mikedanese](https://github.com/mikedanese)) +As far as platforms, working with SIG-Windows, enhancements were made to the kubelet to improve platform support on Windows operating systems, and improvements to resource management were also made. In particular, support for sysctls on Linux graduated to beta. -* The deprecated –mode switch for GCE has been removed.([#61203](https://github.com/kubernetes/kubernetes/pull/61203)) +### SIG OpenStack -* The word “manifest” has been expunged from the Kubelet API. ([#60314](https://github.com/kubernetes/kubernetes/pull/60314)) +SIG-OpenStack continued to build out testing, with eleven acceptance tests covering a wide-range of scenarios and use-cases. During the 1.11 cycle our reporting back to test-grid has qualified the OpenStack cloud provider as a gating job for the Kubernetes release. -* [https://github.com/kubernetes/kubernetes/issues/49213](https://github.com/kubernetes/kubernetes/issues/49213) sig-cluster-lifecycle has decided to phase out the cluster/ directory over the next couple of releases in favor of deployment automations maintained outside of the core repo and outside of kubernetes orgs. [@kubernetes/sig-cluster-lifecycle-misc](https://github.com/orgs/kubernetes/teams/sig-cluster-lifecycle-misc)) +New features include improved integration between the Keystone service and Kubernetes RBAC, and a number of stability and compatibility improvements across the entire provider code-base. - * Remove deprecated ContainerVM support from GCE kube-up. ([#58247](https://github.com/kubernetes/kubernetes/pull/58247), [@mikedanese](https://github.com/mikedanese)) +### SIG Scheduling +[Pod Priority and Preemption](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/) has graduated to Beta, so it is enabled by default. Note that this involves [significant and important changes for operators](https://github.com/kubernetes/sig-release/pull/201/files). The team also worked on improved performance and reliability of the scheduler. - * Remove deprecated kube-push.sh functionality. ([#58246](https://github.com/kubernetes/kubernetes/pull/58246), [@mikedanese](https://github.com/mikedanese)) +### SIG Storage - * Remove deprecated container-linux support in gce kube-up.sh. ([#58098](https://github.com/kubernetes/kubernetes/pull/58098), [@mikedanese](https://github.com/mikedanese)) +Sig Storage graduated two features that had been introduced in previous versions and introduced three new features in an alpha state. - * Remove deprecated and unmaintained photon-controller kube-up.sh. ([#58096](https://github.com/kubernetes/kubernetes/pull/58096), [@mikedanese](https://github.com/mikedanese)) +The StorageProtection feature, which prevents deletion of PVCs while Pods are still using them and of PVs while still bound to a PVC, is now generally available, and volume resizing, which lets you increase size of a volume after a Pod restarts is now beta, which means it is on by default. - * Remove deprecated and unmaintained libvirt-coreos kube-up.sh. ([#58023](https://github.com/kubernetes/kubernetes/pull/58023), [@mikedanese](https://github.com/mikedanese)) +New alpha features include: +* Online volume resizing will increase the filesystem size of a resized volume without requiring a Pod restart. +* AWS EBS and GCE PD volumes support increased limits on the maximum number of attached volumes per node. +* Subpath volume directories can be created using DownwardAPI environment variables. - * Remove deprecated and unmaintained windows installer. ([#58020](https://github.com/kubernetes/kubernetes/pull/58020), [@mikedanese](https://github.com/mikedanese)) +### SIG Windows - * Remove deprecated and unmaintained openstack-heat kube-up.sh. ([#58021](https://github.com/kubernetes/kubernetes/pull/58021), [@mikedanese](https://github.com/mikedanese)) +This release supports more of Kubernetes API for pods and containers on Windows, including: - * Remove deprecated vagrant kube-up.sh. ([#58118](https://github.com/kubernetes/kubernetes/pull/58118),[@roberthbailey](https://github.com/roberthbailey)) +* Metrics for Pod, Container, Log filesystem +* The run_as_user security contexts +* Local persistent volumes and fstype for Azure disk -* The DaemonSet controller, its integration tests, and its e2e tests, have been updated to use the apps/v1 API. Users should, but are not yet required to, update their scripts accordingly. ([#59883](https://github.com/kubernetes/kubernetes/pull/59883), [@kow3ns](https://github.com/kow3ns)) +Improvements in Windows Server version 1803 also bring new storage functionality to Kubernetes v1.11, including: -* MountPropagation feature is now beta. As a consequence, all volume mounts in containers are now `rslave` on Linux by default. To make this default work in all Linux environments the entire mount tree should be marked as shareable, e.g. via `mount --make-rshared /`. All Linux distributions that use systemd already have the root directory mounted as rshared and hence they need not do anything. In Linux environments without systemd we recommend running `mount --make-rshared /` during boot before docker is started, ([@jsafrane](https://github.com/jsafrane)) +* Volume mounts for ConfigMap and Secret +* Flexvolume plugins for SMB and iSCSI storage are also available out-of-tree at [Microsoft/K8s-Storage-Plugins](https://github.com/Microsoft/K8s-Storage-Plugin) ## Known Issues -* Use of subPath module with hostPath volumes can cause issues during reconstruction ([#61446](https://github.com/kubernetes/kubernetes/issues/61446)) and with containerized kubelets ([#61456](https://github.com/kubernetes/kubernetes/issues/61456)). The workaround for this issue is to specify the complete path in the hostPath volume. Use of subPathmounts nested within atomic writer volumes (configmap, secret, downwardAPI, projected) does not work ([#61545](https://github.com/kubernetes/kubernetes/issues/61545)), and socket files cannot be loaded from a subPath ([#62377](https://github.com/kubernetes/kubernetes/issues/61377)). Work on these issues is ongoing. - -* Kubeadm is currently omitting etcd certificates in a self-hosted deployment; this will be fixed in a point relelase. ([#61322](https://github.com/kubernetes/kubernetes/issues/61322)) - -* Some users, especially those with very large clusters, may see higher memory usage by the kube-controller-manager in 1.10. ([#61041](https://github.com/kubernetes/kubernetes/issues/61041)) - -## Deprecations - -* etcd2 as a backend is deprecated and support will be removed in Kubernetes 1.13. - -* VolumeScheduling and LocalPersistentVolume features are beta and enabled by default. The PersistentVolume NodeAffinity alpha annotation is deprecated and will be removed in a future release. ([#59391](https://github.com/kubernetes/kubernetes/pull/59391), [@msau42](https://github.com/msau42)) - -* The alpha Accelerators feature gate is deprecated and will be removed in v1.11. Please use device plugins ([https://github.com/kubernetes/features/issues/368](https://github.com/kubernetes/features/issues/368)) instead. They can be enabled using the DevicePlugins feature gate. ([#57384](https://github.com/kubernetes/kubernetes/pull/57384), [@mindprince](https://github.com/mindprince)) - -* The ability to use kubectl scale jobs is deprecated. All other scale operations remain in place, but the ability to scale jobs will be removed in a future release. ([#60139](https://github.com/kubernetes/kubernetes/pull/60139), [@soltysh](https://github.com/soltysh)) - -* Flags that can be set via the [Kubelet's --config file](https://kubernetes.io/docs/tasks/administer-cluster/kubelet-config-file/) are now deprecated in favor of the file. ([#60148](https://github.com/kubernetes/kubernetes/pull/60148), [@mtaufen](https://github.com/mtaufen)) - -* `--show-all` (which only affected pods and only for human readable/non-API printers) is now defaulted to true and deprecated. The flag determines whether pods in a terminal state are displayed. It will be inert in 1.11 and removed in a future release. ([#60210](https://github.com/kubernetes/kubernetes/pull/60210), [@deads2k](https://github.com/deads2k)) - -* The ability to use the insecure HTTP port of kube-controller-manager and cloud-controller-manager has been deprecated, and will be removed in a future release. Use `--secure-port` and `--bind-address` instead. ([#59582](https://github.com/kubernetes/kubernetes/pull/59582), [@sttts](https://github.com/sttts)) - -* The ability to use the insecure flags `--insecure-bind-address`, `--insecure-port` in the apiserver has been deprecated and will be removed in a future release. Use `--secure-port` and `--bind-address` instead. ([#59018](https://github.com/kubernetes/kubernetes/pull/59018), [@hzxuzhonghu](https://github.com/hzxuzhonghu)) - -* The recycling reclaim policy has been deprecated. Users should use dynamic provisioning instead. ([#59063](https://github.com/kubernetes/kubernetes/pull/59063), [@ayushpateria](https://github.com/ayushpateria)) - -* kube-apiserver flag --tls-ca-file has had no effect for some time. It is now deprecated and slated for removal in 1.11. If you are specifying this flag, you must remove it from your launch config before upgrading to 1.11. ([#58968](https://github.com/kubernetes/kubernetes/pull/58968), [@deads2k](https://github.com/deads2k)) - -* The `PodSecurityPolicy` API has been moved to the `policy/v1beta1` API group. The `PodSecurityPolicy` API in the `extensions/v1beta1` API group is deprecated and will be removed in a future release. Authorizations for using pod security policy resources should change to reference the `policy` API group after upgrading to 1.11. ([#54933](https://github.com/kubernetes/kubernetes/pull/54933), [@php-coder](https://github.com/php-coder)) - -* Add `--enable-admission-plugin` `--disable-admission-plugin` flags and deprecate `--admission-control`. When using the separate flag, the order in which they're specified doesn't matter. ([#58123](https://github.com/kubernetes/kubernetes/pull/58123), [@hzxuzhonghu](https://github.com/hzxuzhonghu)) - -* The kubelet --docker-disable-shared-pid flag, which runs docker containers with a process namespace that is shared between all containers in a pod, is now deprecated and will be removed in a future release. It is replaced by `v1.Pod.Spec.ShareProcessNamespace`, which configures this behavior. This field is alpha and can be enabled with --feature-gates=PodShareProcessNamespace=true. ([#58093](https://github.com/kubernetes/kubernetes/pull/58093), [@verb](https://github.com/verb)) - -* The kubelet's cadvisor port has been deprecated. The default will change to 0 (disabled) in 1.12, and the cadvisor port will be removed entirely in 1.13. ([#59827](https://github.com/kubernetes/kubernetes/pull/59827), [@dashpole](https://github.com/dashpole)) - -* rktnetes has been deprecated in favor of rktlet. Please see [https://github.com/kubernetes-incubator/rktlet](https://github.com/kubernetes-incubator/rktlet) for more information. ([#58418](https://github.com/kubernetes/kubernetes/pull/58418), [@yujuhong](https://github.com/yujuhong)) - -* The Kubelet now explicitly registers all of its command-line flags with an internal flagset, which prevents flags from third party libraries from unintentionally leaking into the Kubelet's command-line API. Many unintentionally leaked flags are now marked deprecated, so that users have a chance to migrate away from them before they are removed. In addition, one previously leaked flag, --cloud-provider-gce-lb-src-cidrs, has been entirely removed from the Kubelet's command-line API, because it is irrelevant to Kubelet operation. The deprecated flags are: - - * --application_metrics_count_limit - * --boot_id_file - * --container_hints - * --containerd - * --docker - * --docker_env_metadata_whitelist - * --docker_only - * --docker-tls - * --docker-tls-ca - * --docker-tls-cert - * --docker-tls-key - * --enable_load_reader - * --event_storage_age_limit - * --event_storage_event_limit - * --global_housekeeping_interval - * --google-json-key - * --log_cadvisor_usage - * --machine_id_file - * --storage_driver_user - * --storage_driver_password - * --storage_driver_host - * --storage_driver_db - * --storage_driver_table - * --storage_driver_secure - * --storage_driver_buffer_duration - -([#57613](https://github.com/kubernetes/kubernetes/pull/57613), [@mtaufen](https://github.com/mtaufen)) - -* The boostrapped RBAC role and rolebinding for the `cloud-provider` service account is now deprecated. If you're currently using this service account, you must create and apply your own [RBAC policy](https://kubernetes.io/docs/admin/authorization/rbac/) for new clusters. ([#59949](https://github.com/kubernetes/kubernetes/pull/59949), [@nicksardo](https://github.com/nicksardo)) - -* Format-separated endpoints for the OpenAPI spec, such as /swagger.json, /swagger-2.0.0.0.json, and so on, have been deprecated. The old endpoints will remain in 1.10, 1.11, 1.12 and 1.13, and get removed in 1.14. Please use single `/openapi/v2` endpoint with the appropriate Accept: header instead. For example: - - - - - - - - - - - - - - - - - - -
previousnow
GET /swagger.jsonGET /openapi/v2 -Accept: application/json
GET /swagger-2.0.0.pb-v1GET /openapi/v2 -Accept: application/com.github.proto-openapi.spec.v2@v1.0+protobuf
GET /swagger-2.0.0.pb-v1.gzGET /openapi/v2 -Accept: application/com.github.proto-openapi.spec.v2@v1.0+protobuf Accept-Encoding: gzip
- - ([#59293](https://github.com/kubernetes/kubernetes/pull/59293), [@roycaihw](https://github.com/roycaihw)) - -## Other Notable Changes - -### Apps - -* Updated defaultbackend image to 1.4 and deployment apiVersion to apps/v1. Users should concentrate on updating scripts to the new version. ([#57866](https://github.com/kubernetes/kubernetes/pull/57866), [@zouyee](https://github.com/zouyee)) - -* Fix StatefulSet to work correctly with set-based selectors. ([#59365](https://github.com/kubernetes/kubernetes/pull/59365), [@ayushpateria](https://github.com/ayushpateria)) - -* Fixes a case when Deployment with recreate strategy could get stuck on old failed Pod. ([#60301](https://github.com/kubernetes/kubernetes/pull/60301), [@tnozicka](https://github.com/tnozicka)) - -* ConfigMap objects now support binary data via a new `binaryData` field. When using `kubectl create configmap --from-file`, files containing non-UTF8 data will be placed in this new field in order to preserve the non-UTF8 data. Note that kubectl's `--append-hash` feature doesn't take `binaryData` into account. Use of this feature requires 1.10+ apiserver and kubelets. ([#57938](https://github.com/kubernetes/kubernetes/pull/57938), [@dims](https://github.com/dims)) - -### AWS - -* Add AWS cloud provider option to use an assumed IAM role. For example, this allows running Controller Manager in a account separate from the worker nodes, but still allows all resources created to interact with the workers. ELBs created would be in the same account as the worker nodes for instance.([#59668](https://github.com/kubernetes/kubernetes/pull/59668), [@brycecarman](https://github.com/brycecarman)) +* IPVS based kube-proxy doesn't support graceful close connections for terminating pod. This issue will be fixed in a future release. ([#57841](https://github.com/kubernetes/kubernetes/pull/57841), [@jsravn](https://github.com/jsravn)) +* kube-proxy needs to be configured to override hostname in some environments. ([#857](https://github.com/kubernetes/kubeadm/issues/857), [@detiber](https://github.com/detiber)) +* There's a known issue where the Vertical Pod Autoscaler will radically change implementation in 1.12, so users of VPA (alpha) in 1.11 are warned that they will not be able to automatically migrate their VPA configs from 1.11 to 1.12. -* AWS EBS volume plugin now includes block and volumeMode support. ([#58625](https://github.com/kubernetes/kubernetes/pull/58625), [@screeley44](https://github.com/screeley44)) -* On AWS kubelet returns an error when started under conditions that do not allow it to work (AWS has not yet tagged the instance), rather than failing silently. ([#60125](https://github.com/kubernetes/kubernetes/pull/60125), [@vainu-arto](https://github.com/vainu-arto)) - -* AWS Security Groups created for ELBs will now be tagged with the same additional tags as the ELB; that is, the tags specified by the "service.beta.kubernetes.io/aws-load-balancer-additional-resource-tags" annotation. This is useful for identifying orphaned resources. ([#58767](https://github.com/kubernetes/kubernetes/pull/58767), [@2rs2ts](https://github.com/2rs2ts)) - -* AWS Network Load Balancers will now be deleted properly, including security group rules. Fixes [#57568](https://github.com/kubernetes/kubernetes/pull/57568) ([#57569](https://github.com/kubernetes/kubernetes/pull/57569), [@micahhausler](https://github.com/micahhausler)) - -* Time for attach/detach retry operations has been decreased from 10-12s to 2-6s ([#56974](https://github.com/kubernetes/kubernetes/pull/56974), [@gnufied](https://github.com/gnufied)) - -### Auth - -* Contexts must be named in kubeconfigs. ([#56769](https://github.com/kubernetes/kubernetes/pull/56769), [@dixudx](https://github.com/dixudx)) - -* vSphere operations will no longer fail due to authentication errors. ([#57978](https://github.com/kubernetes/kubernetes/pull/57978), [@prashima](https://github.com/prashima)) - -* This removes the cloud-provider role and role binding from the rbac boostrapper and replaces it with a policy applied via addon mgr. This also creates a new clusterrole allowing the service account to create events for any namespace. - -* client-go: alpha support for out-of-tree exec-based credential providers. For example, a cloud provider could create their own authentication system rather than using the standard authentication provided with Kubernetes. ([#59495](https://github.com/kubernetes/kubernetes/pull/59495), [@ericchiang](https://github.com/ericchiang)) - -* The node authorizer now allows nodes to request service account tokens for the service accounts of pods running on them. This allows agents using the node identity to take actions on behalf of local pods. ([#55019](https://github.com/kubernetes/kubernetes/pull/55019), [@mikedanese](https://github.com/mikedanese)) - -* kube-apiserver: the OpenID Connect authenticator can now verify ID Tokens signed with JOSE algorithms other than RS256 through the --oidc-signing-algs flag. ([#58544](https://github.com/kubernetes/kubernetes/pull/58544), [@ericchiang](https://github.com/ericchiang)) - -* Requests with invalid credentials no longer match audit policy rules where users or groups are set, correcting a problem where authorized requests were getting through. ([#59398](https://github.com/kubernetes/kubernetes/pull/59398), [@CaoShuFeng](https://github.com/CaoShuFeng)) - -* The Stackdriver Metadata Agent addon now includes RBAC manifests, enabling it to watch nodes and pods. ([#57455](https://github.com/kubernetes/kubernetes/pull/57455), [@kawych](https://github.com/kawych)) - -* Fix RBAC role for certificate controller to allow cleaning up of Certificate Signing Requests that are Approved and issued or Denied. ([#59375](https://github.com/kubernetes/kubernetes/pull/59375), [@mikedanese](https://github.com/mikedanese)) - -* kube-apiserver: Use of the `--admission-control-config-file` with a file containing an AdmissionConfiguration apiserver.k8s.io/v1alpha1 config object no longer leads to an error when launching kube-apiserver. ([#58439](https://github.com/kubernetes/kubernetes/pull/58439) [@liggitt](https://github.com/liggitt)) - -* Default enabled admission plugins are now `NamespaceLifecycle,LimitRanger,ServiceAccount,PersistentVolumeLabel,DefaultStorageClass,DefaultTolerationSeconds,MutatingAdmissionWebhook,ValidatingAdmissionWebhook,ResourceQuota`. Please note that if you previously had not set the `--admission-control` flag, your cluster behavior may change (to be more standard). ([#58684](https://github.com/kubernetes/kubernetes/pull/58684), [@hzxuzhonghu](https://github.com/hzxuzhonghu)) - -* Encryption key and encryption provider rotation now works properly. ([#58375](https://github.com/kubernetes/kubernetes/pull/58375), [@liggitt](https://github.com/liggitt) - -* RBAC: The system:kubelet-api-admin cluster role can be used to grant full access to the kubelet API so integrators can grant this role to the --kubelet-client-certificate credential given to the apiserver. ([#57128](https://github.com/kubernetes/kubernetes/pull/57128), [@liggitt](https://github.com/liggitt)) - -* DenyEscalatingExec admission controller now checks psp HostNetwork as well as hostIPC and hostPID. hostNetwork is also checked to deny exec /attach. ([#56839](https://github.com/kubernetes/kubernetes/pull/56839), [@hzxuzhonghu]=(https://github.com/hzxuzhonghu)) - -* When using Role-Based Access Control, the "admin", "edit", and "view" roles now have the expected permissions on NetworkPolicy resources, rather than reserving those permissions to only cluster-admin. ([#56650](https://github.com/kubernetes/kubernetes/pull/56650), [@danwinship](https://github.com/danwinship)) - -* Added docker-logins config to kubernetes-worker charm. ([#56217](https://github.com/kubernetes/kubernetes/pull/56217), [@Cynerva](https://github.com/Cynerva)) - -* Add ability to control primary GID of containers through Pod Spec at Pod level and Per Container SecurityContext level. ([#52077](https://github.com/kubernetes/kubernetes/pull/52077)) - -### CLI - -* Use structured generator for kubectl autoscale. ([#55913](https://github.com/kubernetes/kubernetes/pull/55913), [@wackxu](https://github.com/wackxu)) - -* Allow kubectl to set image|env on a cronjob ([#57742](https://github.com/kubernetes/kubernetes/pull/57742), [@soltysh](https://github.com/soltysh)) - -* Fixed crash in kubectl cp when path has multiple leading slashes. ([#58144](https://github.com/kubernetes/kubernetes/pull/58144), [@tomerf](https://github.com/tomerf)) - -* kubectl port-forward now allows using resource name (e.g., deployment/www) to select a matching pod, as well as the use of --pod-running-timeout to wait until at least one pod is running. ([#59705](https://github.com/kubernetes/kubernetes/pull/59705), [@phsiao](https://github.com/phsiao)) - -* 'cj' has been added as a shortname for CronJobs, as in `kubectl get cj` ([#59499](https://github.com/kubernetes/kubernetes/pull/59499), [@soltysh](https://github.com/soltysh)) - -* `crds` has been added as a shortname for CustomResourceDefinition, as in `kubectl get crds` ([#59061](https://github.com/kubernetes/kubernetes/pull/59061), [@nikhita](https://github.com/nikhita)) - -* Fix kubectl explain for resources not existing in default version of API group, such as `batch/v1, Kind=CronJob`. ([#58753](https://github.com/kubernetes/kubernetes/pull/58753), [@soltysh](https://github.com/soltysh)) - -* Added the ability to select pods in a chosen node to be drained based on given pod label-selector. ([#56864](https://github.com/kubernetes/kubernetes/pull/56864), [@juanvallejo](https://github.com/juanvallejo)) - -* Kubectl explain now prints out the Kind and API version of the resource being explained. ([#55689](https://github.com/kubernetes/kubernetes/pull/55689), [@luksa](https://github.com/luksa)) - -### Cluster Lifecycle - -* The default Kubernetes version for kubeadm is now 1.10. ([#61127](https://github.com/kubernetes/kubernetes/pull/61127), [@timothysc](https://github.com/timothysc)) - -* The minimum Kubernetes version in kubeadm is now v1.9.0. ([#57233](https://github.com/kubernetes/kubernetes/pull/57233), [@xiangpengzhao](https://github.com/xiangpengzhao)) - -* Fixes a bug in Heapster deployment for google sink. ([#57902](https://github.com/kubernetes/kubernetes/pull/57902), [@kawych](https://github.com/kawych)) - -* On cluster provision or upgrade, kubeadm now generates certs and secures all connections to the etcd static-pod with mTLS. This includes the etcd serving cert, the etcd peer cert, and the apiserver etcd client cert. Flags and hostMounts are added to the etcd and apiserver static-pods to load these certs. For connections to etcd, https is now used in favor of http. ([#57415](https://github.com/kubernetes/kubernetes/pull/57415), [@stealthybox](https://github.com/stealthybox) These certs are also generated on upgrade. ([#60385](https://github.com/kubernetes/kubernetes/pull/60385), [@stealthybox](https://github.com/stealthybox)) - -* Demoted controlplane passthrough flags apiserver-extra-args, controller-manager-extra-args, scheduler-extra-args to alpha flags ([#59882](https://github.com/kubernetes/kubernetes/pull/59882), [@kris-nova](https://github.com/kris-nova)) - -* The new flag `--apiserver-advertise-dns-address` is used in the node's kubelet.confg to point to the API server, allowing users to define a DNS entry instead of an IP address. ([#59288](https://github.com/kubernetes/kubernetes/pull/59288), [@stevesloka](https://github.com/stevesloka)) - -* MasterConfiguration manifiest The criSocket flag is now usable within the `MasterConfiguration` and `NodeConfiguration` manifest files that exist for configuring kubeadm. Before it only existed as a command line flag and was not able to be configured when using the `--config` flag and the manifest files. ([#59057](https://github.com/kubernetes/kubernetes/pull/59057)([#59292](https://github.com/kubernetes/kubernetes/pull/59292), [@JordanFaust](https://github.com/JordanFaust)) - -* `kubeadm init` can now omit the tainting of the master node if configured to do so in `kubeadm.yaml` using `noTaintMaster: true`. For example, uses can create a file with the content: +## Before Upgrading +* When Response is a `metav1.Status`, it is no longer copied into the audit.Event status. Only the "status", "reason" and "code" fields are set. For example, when we run `kubectl get pods abc`, the API Server returns a status object: ``` -apiVersion: [kubeadm.k8s.io/v1alpha1](http://kubeadm.k8s.io/v1alpha1) -kind: MasterConfiguration -kubernetesVersion: v1.9.1 -noTaintMaster: true +{"kind":"Status","apiVersion":"v1","metadata":{},"status":"Failure","message":"pods \"abc\" not found","reason":"NotFound","details":{"name":"abc","kind":"pods"},"code":404} ``` +In previous versions, the whole object was logged in audit events. Starting in 1.11, only `status`, `reason`, and `code` are logged. Code that relies on the older version must be updated to avoid errors. +([#62695](https://github.com/kubernetes/kubernetes/pull/62695), [@CaoShuFeng](https://github.com/CaoShuFeng)) +* HTTP transport now uses `context.Context` to cancel dial operations. k8s.io/client-go/transport/Config struct has been updated to accept a function with a `context.Context` parameter. This is a breaking change if you use this field in your code. ([#60012](https://github.com/kubernetes/kubernetes/pull/60012), [@ash2k](https://github.com/ash2k)) +* kubectl: This client version requires the `apps/v1` APIs, so it will not work against a cluster version older than v1.9.0. Note that kubectl only guarantees compatibility with clusters that are +/-1 minor version away. ([#61419](https://github.com/kubernetes/kubernetes/pull/61419), [@enisoc](https://github.com/enisoc)) +* Pod priority and preemption is now enabled by default. Even if you don't plan to use this feature, you might need to take some action immediately after upgrading. In multi-tenant clusters where not all users are trusted, you are advised to create appropriate quotas for two default priority classes, system-cluster-critical and system-node-critical, which are added to clusters by default. `ResourceQuota` should be created to limit users from creating Pods at these priorities if not all users of your cluster are trusted. We do not advise disabling this feature because critical system Pods rely on the scheduler preemption to be scheduled when cluster is under resource pressure. +* Default mount propagation has changed from `HostToContainer` ("rslave" in Linux terminology), as it was in 1.10, to `None` ("private") to match the behavior in 1.9 and earlier releases; `HostToContainer` as a default caused regressions in some pods. If you are relying on this behavior you will need to set it explicitly. ([#62462](https://github.com/kubernetes/kubernetes/pull/62462), [@jsafrane](https://github.com/jsafrane)) +* The kube-apiserver `--storage-version` flag has been removed; you must use `--storage-versions` instead. ([#61453](https://github.com/kubernetes/kubernetes/pull/61453), [@hzxuzhonghu](https://github.com/hzxuzhonghu)) +* Authors of aggregated API servers must not rely on authorization being done by the kube-apiserver, and must do delegated authorization in addition. ([#61349](https://github.com/kubernetes/kubernetes/pull/61349), [@sttts](https://github.com/sttts)) +* GC is now bound by QPS so if you need more QPS to avoid ratelimiting GC, you'll have to set it explicitly. ([#63657](https://github.com/kubernetes/kubernetes/pull/63657), [@shyamjvs](https://github.com/shyamjvs)) +* `kubeadm join` is now blocking on the kubelet performing the TLS Bootstrap properly. Earlier, `kubeadm join` only did the discovery part and exited successfully without checking that the kubelet actually started properly and performed the TLS bootstrap correctly. Now, as kubeadm runs some post-join steps (for example, annotating the Node API object with the CRISocket), `kubeadm join` is now waiting for the kubelet to perform the TLS Bootstrap, and then uses that credential to perform further actions. This also improves the UX, as `kubeadm` will exit with a non-zero code if the kubelet isn't in a functional state, instead of pretending everything's fine. + ([#64792](https://github.com/kubernetes/kubernetes/pull/64792), [@luxas](https://github.com/luxas)) +* The structure of the kubelet dropin in the kubeadm deb package has changed significantly. Instead of hard-coding the parameters for the kubelet in the dropin, a structured configuration file for the kubelet is used, and is expected to be present in `/var/lib/kubelet/config.yaml`. For runtime-detected, instance-specific configuration values, a environment file with dynamically-generated flags at `kubeadm init` or `kubeadm join` run time is used. Finally, if you want to override something specific for the kubelet that can't be done via the kubeadm Configuration file (which is preferred), you might add flags to the `KUBELET_EXTRA_ARGS` environment variable in either `/etc/default/kubelet` +or `/etc/sysconfig/kubelet`, depending on the system you're running on. +([#64780](https://github.com/kubernetes/kubernetes/pull/64780), [@luxas](https://github.com/luxas)) +* The `--node-name` flag for kubeadm now dictates the Node API object name the kubelet uses for registration, in all cases but where you might use an in-tree cloud provider. If you're not using an in-tree cloud provider, `--node-name` will set the Node API object name. If you're using an in-tree cloud provider, you MUST make `--node-name` match the name the in-tree cloud provider decides to use. +([#64706](https://github.com/kubernetes/kubernetes/pull/64706), [@liztio](https://github.com/liztio)) +* The `PersistentVolumeLabel` admission controller is now disabled by default. If you depend on this feature (AWS/GCE) then ensure it is added to the `--enable-admission-plugins` flag on the kube-apiserver. ([#64326](https://github.com/kubernetes/kubernetes/pull/64326), [@andrewsykim](https://github.com/andrewsykim)) +* kubeadm: kubelets in kubeadm clusters now disable the readonly port (10255). If you're relying on unauthenticated access to the readonly port, please switch to using the secure port (10250). Instead, you can now use ServiceAccount tokens when talking to the secure port, which will make it easier to get access to, for example, the `/metrics` endpoint of the kubelet, securely. ([#64187](https://github.com/kubernetes/kubernetes/pull/64187), [@luxas](https://github.com/luxas)) +* The formerly publicly-available cAdvisor web UI that the kubelet ran on port 4194 by default is now turned off by default. The flag configuring what port to run this UI on `--cadvisor-port` was deprecated in v1.10. Now the default is `--cadvisor-port=0`, in other words, to not run the web server. If you still need to run cAdvisor, the recommended way to run it is via a DaemonSet. Note that the `--cadvisor-port` will be removed in v1.12 ([#63881](https://github.com/kubernetes/kubernetes/pull/63881), [@luxas](https://github.com/luxas)) + +### New Deprecations + +* As a reminder, etcd2 as a backend is deprecated and support will be removed in Kubernetes 1.13. Please ensure that your clusters are upgraded to etcd3 as soon as possible. +* InfluxDB cluster monitoring has been deprecated as part of the deprecation of Heapster. Instead, you may use the [metrics server](https://github.com/kubernetes-incubator/metrics-server). It's a simplified heapster that is able to gather and serve current metrics values. It provides the Metrics API that is used by `kubectl top`, and horizontal pod autoscaler. Note that it doesn't include some features of Heapster, such as short term metrics for graphs in kube-dashboard and dedicated push sinks, which proved hard to maintain and scale. Clusters using Heapster for transfering metrics into long-term storage should consider using their metric solution's native Kubernetes support, if present, or should consider alternative solutions. ([#62328](https://github.com/kubernetes/kubernetes/pull/62328), [@serathius](https://github.com/serathius)) +* The kubelet `--rotate-certificates` flag is now deprecated, and will be removed in a future release. The kubelet certificate rotation feature can now be enabled via the `.RotateCertificates` field in the kubelet's config file. ([#63912](https://github.com/kubernetes/kubernetes/pull/63912), [@luxas](https://github.com/luxas)) +* The kubeadm configuration file version has been upgraded from `v1alpha2` from `v1alpha1`. `v1alpha1` read support exists in v1.11, but will be removed in v1.12. ([#63788](https://github.com/kubernetes/kubernetes/pull/63788), [@luxas](https://github.com/luxas)) +The following PRs changed the API spec: + * In the new v1alpha2 kubeadm Configuration API, the `.CloudProvider` and `.PrivilegedPods` fields don't exist anymore. Instead, you should use the out-of-tree cloud provider implementations, which are beta in v1.11. + * If you have to use the legacy in-tree cloud providers, you can rearrange your config like the example below. If you need the `cloud-config` file (located in `{cloud-config-path}`), you can mount it into the API Server and controller-manager containers using ExtraVolumes, as in: + ```yaml + kind: MasterConfiguration + apiVersion: kubeadm.k8s.io/v1alpha2 + apiServerExtraArgs: + cloud-provider: "{cloud}" + cloud-config: "{cloud-config-path}" + apiServerExtraVolumes: + - name: cloud + hostPath: "{cloud-config-path}" + mountPath: "{cloud-config-path}" + controllerManagerExtraArgs: + cloud-provider: "{cloud}" + cloud-config: "{cloud-config-path}" + controllerManagerExtraVolumes: + - name: cloud + hostPath: "{cloud-config-path}" + mountPath: "{cloud-config-path}" + ``` +* If you need to use the `.PrivilegedPods` functionality, you can still edit the manifests in `/etc/kubernetes/manifests/`, and set `.SecurityContext.Privileged=true` for the apiserver and controller manager. + ([#63866](https://github.com/kubernetes/kubernetes/pull/63866), [@luxas](https://github.com/luxas)) + * kubeadm: The Token-related fields in the `MasterConfiguration` object have now been refactored. Instead of the top-level `.Token`, `.TokenTTL`, `.TokenUsages`, `.TokenGroups` fields, there is now a `BootstrapTokens` slice of `BootstrapToken` objects that support the same features under the `.Token`, `.TTL`, `.Usages`, `.Groups` fields. ([#64408](https://github.com/kubernetes/kubernetes/pull/64408), [@luxas](https://github.com/luxas)) + * `.NodeName` and `.CRISocket` in the `MasterConfiguration` and `NodeConfiguration` v1alpha1 API objects are now `.NodeRegistration.Name` and `.NodeRegistration.CRISocket` respectively in the v1alpha2 API. The `.NoTaintMaster` field has been removed in the v1alpha2 API. ([#64210](https://github.com/kubernetes/kubernetes/pull/64210), [@luxas](https://github.com/luxas)) + * kubeadm: Support for `.AuthorizationModes` in the kubeadm v1alpha2 API has been removed. Instead, you can use the `.APIServerExtraArgs` and `.APIServerExtraVolumes` fields to achieve the same effect. Files using the v1alpha1 API and setting this field will be automatically upgraded to this v1alpha2 API and the information will be preserved. ([#64068](https://github.com/kubernetes/kubernetes/pull/64068), [@luxas](https://github.com/luxas)) +* The annotation `service.alpha.kubernetes.io/tolerate-unready-endpoints` is deprecated. Users should use Service.spec.publishNotReadyAddresses instead. ([#63742](https://github.com/kubernetes/kubernetes/pull/63742), [@thockin](https://github.com/thockin)) +* `--show-all`, which only affected pods, and even then only for human readable/non-API printers, is inert in v1.11, and will be removed in a future release. ([#60793](https://github.com/kubernetes/kubernetes/pull/60793), [@charrywanganthony](https://github.com/charrywanganthony)) +* The `kubectl rolling-update` is now deprecated. Use `kubectl rollout` instead. ([#61285](https://github.com/kubernetes/kubernetes/pull/61285), [@soltysh](https://github.com/soltysh)) +* kube-apiserver: the default `--endpoint-reconciler-type` is now `lease`. The `master-count` endpoint reconciler type is deprecated and will be removed in 1.13. ([#63383](https://github.com/kubernetes/kubernetes/pull/63383), [@liggitt](https://github.com/liggitt)) +* OpenStack built-in cloud provider is now deprecated. Please use the external cloud provider for OpenStack. ([#63524](https://github.com/kubernetes/kubernetes/pull/63524), [@dims](https://github.com/dims)) +* The Kubelet's deprecated `--allow-privileged` flag now defaults to true. This enables users to stop setting `--allow-privileged` in order to transition to `PodSecurityPolicy`. Previously, users had to continue setting `--allow-privileged`, because the default was false. ([#63442](https://github.com/kubernetes/kubernetes/pull/63442), [@mtaufen](https://github.com/mtaufen)) +* The old dynamic client has been replaced by a new one. The previous dynamic client will exist for one release in `client-go/deprecated-dynamic`. Switch as soon as possible. ([#63446](https://github.com/kubernetes/kubernetes/pull/63446), [@deads2k](https://github.com/deads2k)) +* In-tree support for openstack credentials is now deprecated. please use the "client-keystone-auth" from the cloud-provider-openstack repository. details on how to use this new capability is documented [here](https://github.com/kubernetes/cloud-provider-openstack/blob/master/docs/using-client-keystone-auth.md) ([#64346](https://github.com/kubernetes/kubernetes/pull/64346), [@dims](https://github.com/dims)) +* The GitRepo volume type is deprecated. To provision a container with a git repo, mount an `EmptyDir` into an `InitContainer` that clones the repo using git, then `moEmptyDir` into the Pod's container. +([#63445](https://github.com/kubernetes/kubernetes/pull/63445), [@ericchiang](https://github.com/ericchiang)) +* Alpha annotation for PersistentVolume node affinity has been removed. Update your PersistentVolumes to use the beta PersistentVolume.nodeAffinity field before upgrading to this release. ([#61816](https://github.com/kubernetes/kubernetes/pull/61816), [@wackxu +](https://github.com/wackxu)) + +### Removed Deprecations + +* kubeadm has removed the `.ImagePullPolicy` field in the v1alpha2 API version. Instead it's set statically to `IfNotPresent` for all required images. If you want to always pull the latest images before cluster init (as `Always` would do), run `kubeadm config images pull` before each `kubeadm init`. If you don't want the kubelet to pull any images at `kubeadm init` time, for example if you don't have an internet connection, you can also run `kubeadm config images pull` before `kubeadm init` or side-load the images some other way (such as `docker load -i image.tar`). Having the images locally cached will result in no pull at runtime, which makes it possible to run without any internet connection. ([#64096](https://github.com/kubernetes/kubernetes/pull/64096), [@luxas](https://github.com/luxas)) +* kubeadm has removed `.Etcd.SelfHosting` from its configuration API. It was never used in practice ([#63871](https://github.com/kubernetes/kubernetes/pull/63871), [@luxas](https://github.com/luxas)) +* The deprecated and inactive option '--enable-custom-metrics' has been removed in 1.11. ([#60699](https://github.com/kubernetes/kubernetes/pull/60699), [@CaoShuFeng](https://github.com/CaoShuFeng)) +* --include-extended-apis, which was deprecated back in [#32894](https://github.com/kubernetes/kubernetes/pull/32894), has been removed. ([#62803](https://github.com/kubernetes/kubernetes/pull/62803), [@deads2k](https://github.com/deads2k)) +* Kubelets will no longer set `externalID` in their node spec. This feature has been deprecated since v1.1. ([#61877](https://github.com/kubernetes/kubernetes/pull/61877), [@mikedanese](https://github.com/mikedanese)) +* The `initresource` admission plugin has been removed. ([#58784](https://github.com/kubernetes/kubernetes/pull/58784), [@wackxu](https://github.com/wackxu)) +* `ObjectMeta `, `ListOptions`, and `DeleteOptions` have been removed from the core api group. Please reference them in `meta/v1` instead. ([#61809](https://github.com/kubernetes/kubernetes/pull/61809), [@hzxuzhonghu](https://github.com/hzxuzhonghu)) +* The deprecated `--mode` flag in `check-network-mode` has been removed. ([#60102](https://github.com/kubernetes/kubernetes/pull/60102), [@satyasm](https://github.com/satyasm)) +* Support for the `alpha.kubernetes.io/nvidia-gpu` resource, which was deprecated in 1.10, has been removed. Please use the resource exposed by DevicePlugins instead (`nvidia.com/gpu`). ([#61498](https://github.com/kubernetes/kubernetes/pull/61498), [@mindprince](https://github.com/mindprince)) +* The `kube-cloud-controller-manager` flag `--service-account-private-key-file` has been removed. Use `--use-service-account-credentials` instead. ([#60875](https://github.com/kubernetes/kubernetes/pull/60875), [@charrywanganthony](https://github.com/charrywanganthony)) +* The rknetes code, which was deprecated in 1.10, has been removed. Use rktlet and CRI instead. ([#61432](https://github.com/kubernetes/kubernetes/pull/61432), [@filbranden](https://github.com/filbranden)) +* DaemonSet scheduling associated with the alpha ScheduleDaemonSetPods feature flag has been emoved. See https://github.com/kubernetes/features/issues/548 for feature status. ([#61411](https://github.com/kubernetes/kubernetes/pull/61411), [@liggitt](https://github.com/liggitt)) +* The `METADATA_AGENT_VERSION` configuration option has been removed to keep metadata agent version consistent across Kubernetes deployments. ([#63000](https://github.com/kubernetes/kubernetes/pull/63000), [@kawych](https://github.com/kawych)) +* The deprecated `--service-account-private-key-file` flag has been removed from the cloud-controller-manager. The flag is still present and supported in the kube-controller-manager. ([#65182](https://github.com/kubernetes/kubernetes/pull/65182), [@liggitt](https://github.com/liggitt)) +* Removed alpha functionality that allowed the controller manager to approve kubelet server certificates. This functionality should be replaced by automating validation and approval of node server certificate signing requests. ([#62471](https://github.com/kubernetes/kubernetes/pull/62471), [@mikedanese](https://github.com/mikedanese)) + +#### Graduated to Stable/GA +* IPVS-based in-cluster load balancing is now GA ([ref](https://github.com/kubernetes/features/issues/265)) +* Enable CoreDNS as a DNS plugin for Kubernetes ([ref](https://github.com/kubernetes/features/issues/427)) +* Azure Go SDK is now GA ([#63063](https://github.com/kubernetes/kubernetes/pull/63063), [@feiskyer](https://github.com/feiskyer)) +* ClusterRole aggregation is now GA ([ref](https://github.com/kubernetes/features/issues/502)) +* CRI validation test suite is now GA ([ref](https://github.com/kubernetes/features/issues/292)) +* StorageObjectInUseProtection is now GA ([ref](https://github.com/kubernetes/features/issues/498)) and ([ref](https://github.com/kubernetes/features/issues/499)) + +#### Graduated to Beta + +* Supporting out-of-tree/external cloud providers is now considered beta ([ref](https://github.com/kubernetes/features/issues/88)) +* Resizing PersistentVolumes after pod restart is now considered beta. ([ref](https://github.com/kubernetes/features/issues/284)) +* sysctl support is now considered beta ([ref](https://github.com/kubernetes/features/issues/34)) +* Support for Azure Virtual Machine Scale Sets is now considered beta. ([ref](https://github.com/kubernetes/features/issues/513)) +* Azure support for Cluster Autoscaler is now considered beta. ([ref](https://github.com/kubernetes/features/issues/514)) +* The ability to limit a node's access to the API is now considered beta. ([ref](https://github.com/kubernetes/features/issues/279)) +* CustomResource versioning is now considered beta. ([ref](https://github.com/kubernetes/features/issues/544)) +* Windows container configuration in CRI is now considered beta ([ref](https://github.com/kubernetes/features/issues/547)) +* CRI logging and stats are now considered beta ([ref](https://github.com/kubernetes/features/issues/552)) +* The dynamic Kubelet config feature is now beta, and the DynamicKubeletConfig feature gate is on by default. In order to use dynamic Kubelet config, ensure that the Kubelet's --dynamic-config-dir option is set. ([#64275](https://github.com/kubernetes/kubernetes/pull/64275), [@mtaufen](https://github.com/mtaufen)) +* The Sysctls experimental feature has been promoted to beta (enabled by default via the `Sysctls` feature flag). PodSecurityPolicy and Pod objects now have fields for specifying and controlling sysctls. Alpha sysctl annotations will be ignored by 1.11+ kubelets. All alpha sysctl annotations in existing deployments must be converted to API fields to be effective. ([#6371](https://github.com/kubernetes/kubernetes/pull/63717), [@ingvagabund](https://github.com/ingvagabund)) +* Volume expansion is now considered Beta. ([#64288](https://github.com/kubernetes/kubernetes/pull/64288), [@gnufied](https://github.com/gnufied)) +* CRI container log rotation is now considered beta, and is enabled by default. ([#64046](https://github.com/kubernetes/kubernetes/pull/64046), [@yujuhong](https://github.com/yujuhong)) +* The `PriorityClass` API has been promoted to `scheduling.k8s.io/v1beta1` ([#63100](https://github.com/kubernetes/kubernetes/pull/63100), [@ravisantoshgudimetla](https://github.com/ravisantoshgudimetla)) +* The priorityClass feature is now considered beta. ([#63724](https://github.com/kubernetes/kubernetes/pull/63724), [@ravisantoshgudimetla](https://github.com/ravisantoshgudimetla)) +* client-go: credential exec plugins is now considered beta. ([#64482](https://github.com/kubernetes/kubernetes/pull/64482), [@ericchiang](https://github.com/ericchiang)) +* Subresources for custom resources is now considered beta and enabled by default. With this, updates to the `/status` subresource will disallow updates to all fields other than `.status` (not just `.spec` and `.metadata` as before). Also, `required` can be used at the root of the CRD OpenAPI validation schema when the `/status` subresource is enabled. ([#63598](https://github.com/kubernetes/kubernetes/pull/63598), [@nikhita](https://github.com/nikhita)) + +### New alpha features + +* kube-scheduler can now schedule DaemonSet pods ([ref](https://github.com/kubernetes/features/issues/548)) +* You can now resize PersistentVolumes without taking them offline ([ref](https://github.com/kubernetes/features/issues/531)) +* You can now set a maximum volume count ([ref](https://github.com/kubernetes/features/issues/554)) +* You can now do environment variable expansion in a subpath mount. ([ref](https://github.com/kubernetes/features/issues/559)) +* You can now run containers in a pod as a particular group. ([ref](https://github.com/kubernetes/features/issues/213)) +You can now bind tokens to service requests. ([ref](https://github.com/kubernetes/features/issues/542)) +* The --experimental-qos-reserve kubelet flags has been replaced by the alpha level --qos-reserved flag or the QOSReserved field in the kubeletconfig, and requires the QOSReserved feature gate to be enabled. ([#62509](https://github.com/kubernetes/kubernetes/pull/62509), [@sjenning](https://github.com/sjenning)) -And point to the file using the --config flag, as in - -`kubeadm init --config /etc/kubeadm/kubeadm.yaml` - -([#55479](https://github.com/kubernetes/kubernetes/pull/55479), [@ijc](https://github.com/ijc)) - -* kubeadm: New "imagePullPolicy" option in the init configuration file, that gets forwarded to kubelet static pods to control pull policy for etcd and control plane images. This option allows for precise image pull policy specification for master nodes and thus for more tight control over images. It is useful in CI environments and in environments, where the user has total control over master VM templates (thus, the master VM templates can be preloaded with the required Docker images for the control plane services). ([#58960](https://github.com/kubernetes/kubernetes/pull/58960), [@rosti](https://github.com/rosti)) - -* Fixed issue with charm upgrades resulting in an error state. ([#59064](https://github.com/kubernetes/kubernetes/pull/59064), [@hyperbolic2346](https://github.com/hyperbolic2346)) - -* kube-apiserver --advertise-address is now set using downward API for self-hosted Kubernetes with kubeadm. ([#56084](https://github.com/kubernetes/kubernetes/pull/56084), [@andrewsykim](https://github.com/andrewsykim)) - -* When using client or server certificate rotation, the Kubelet will no longer wait until the initial rotation succeeds or fails before starting static pods. This makes running self-hosted masters with rotation more predictable. ([#58930](https://github.com/kubernetes/kubernetes/pull/58930), [@smarterclayton](https://github.com/smarterclayton)) - -* Kubeadm no longer throws an error for the --cloud-provider=external flag. ([#58259](https://github.com/kubernetes/kubernetes/pull/58259), [@dims](https://github.com/dims)) - -* Added support for network spaces in the kubeapi-load-balancer charm. ([#58708](https://github.com/kubernetes/kubernetes/pull/58708), [@hyperbolic2346](https://github.com/hyperbolic2346)) - -* Added support for network spaces in the kubernetes-master charm. ([#58704](https://github.com/kubernetes/kubernetes/pull/58704), [@hyperbolic2346](https://github.com/hyperbolic2346)) - -* Added support for network spaces in the kubernetes-worker charm. ([#58523](https://github.com/kubernetes/kubernetes/pull/58523), [@hyperbolic2346](https://github.com/hyperbolic2346)) - -* Added support for changing nginx and default backend images to kubernetes-worker config. ([#58542](https://github.com/kubernetes/kubernetes/pull/58542), [@hyperbolic2346](https://github.com/hyperbolic2346)) - -* kubeadm now accepts `--apiserver-extra-args`, `--controller-manager-extra-args` and `--scheduler-extra-args`, making it possible to override / specify additional flags for control plane components. One good example is to deploy Kubernetes with a different admission-control flag on API server. ([#58080](https://github.com/kubernetes/kubernetes/pull/58080), [@simonferquel](https://github.com/simonferquel)) - -* Alpha Initializers have been removed from kubadm admission control. Kubeadm users who still want to use Initializers can use apiServerExtraArgs through the kubeadm config file to enable it when booting up the cluster. ([#58428](https://github.com/kubernetes/kubernetes/pull/58428), [@dixudx](https://github.com/dixudx)) - -* ValidatingAdmissionWebhook and MutatingAdmissionWebhook are beta, and are enabled in kubeadm by default. ([#58255](https://github.com/kubernetes/kubernetes/pull/58255), [@dixudx](https://github.com/dixudx)) - -* Add proxy_read_timeout flag to kubeapi_load_balancer charm. ([#57926](https://github.com/kubernetes/kubernetes/pull/57926), [@wwwtyro](https://github.com/wwwtyro)) - -* Check for known manifests during preflight instead of only checking for non-empty manifests directory. This makes the preflight checks less heavy-handed by specifically checking for well-known files (kube-apiserver.yaml, kube-controller-manager.yaml, kube-scheduler.yaml, etcd.yaml) in /etc/kubernetes/manifests instead of simply checking for a non-empty directory. ([#57287](https://github.com/kubernetes/kubernetes/pull/57287), [@mattkelly](https://github.com/mattkelly)) - -* PVC Protection alpha feature was renamed to Storage Protection. The Storage Protection feature is beta. ([#59052](https://github.com/kubernetes/kubernetes/pull/59052), [@pospispa](https://github.com/pospispa)) - -* iSCSI sessions managed by kubernetes will now explicitly set startup.mode to 'manual' to prevent automatic login after node failure recovery. This is the default open-iscsi mode, so this change will only impact users who have changed their startup.mode to be 'automatic' in /etc/iscsi/iscsid.conf. ([#57475](https://github.com/kubernetes/kubernetes/pull/57475), [@stmcginnis](https://github.com/stmcginnis)) - -* The IPVS feature gateway is now enabled by default in kubeadm, which makes the --feature-gates=SupportIPVSProxyMode=true obsolete, and it is no longer supported. ([#60540](https://github.com/kubernetes/kubernetes/pull/60540), [@m1093782566](https://github.com/m1093782566)) - -### GCP - -* ingress-gce image in glbc.manifest updated to 1.0.0 ([#61302](https://github.com/kubernetes/kubernetes/pull/61302), [@rramkumar1](https://github.com/rramkumar1)) - -### Instrumentation - -* For advanced auditing, audit policy supports subresources wildcard matching, such as "resource/", "/subresource","*". ([#55306](https://github.com/kubernetes/kubernetes/pull/55306), [@hzxuzhonghu](https://github.com/hzxuzhonghu)) - -* [Auditing](https://kubernetes.io/docs/tasks/debug-application-cluster/audit/) is now enabled behind a featureGate in kubeadm. A user can supply their own audit policy with configuration option as well as a place for the audit logs to live. If no policy is supplied a default policy will be provided. The default policy will log all Metadata level policy logs. It is the example provided in the documentation. ([#59067](https://github.com/kubernetes/kubernetes/pull/59067), [@chuckha](https://github.com/chuckha)) - -* Reduce Metrics Server memory requirement from 140Mi + 4Mi per node to 40Mi + 4Mi per node. ([#58391](https://github.com/kubernetes/kubernetes/pull/58391), [@kawych](https://github.com/kawych)) - -* Annotations is added to advanced audit api. ([#58806](https://github.com/kubernetes/kubernetes/pull/58806), [@CaoShuFeng](https://github.com/CaoShuFeng)) - -* Reorganized iptables rules to fix a performance regression on clusters with thousands of services. ([#56164](https://github.com/kubernetes/kubernetes/pull/56164), [@danwinship](https://github.com/danwinship)) - -* Container runtime daemon (e.g. dockerd) logs in GCE cluster will be uploaded to stackdriver and elasticsearch with tag `container-runtime`. ([#59103](https://github.com/kubernetes/kubernetes/pull/59103), [@Random-Liu](https://github.com/Random-Liu)) - -* Enable prometheus apiserver metrics for custom resources. ([#57682](https://github.com/kubernetes/kubernetes/pull/57682), [@nikhita](https://github.com/nikhita)) - -* Add apiserver metric for number of requests dropped because of inflight limit, making it easier to figure out on which dimension the master is overloaded. ([#58340](https://github.com/kubernetes/kubernetes/pull/58340), [@gmarek](https://github.com/gmarek)) - -* The Metrics Server now exposes metrics via the /metric endpoint. These metrics are in the prometheus format. ([#57456](https://github.com/kubernetes/kubernetes/pull/57456), [@kawych](https://github.com/kawych)) - -* Reduced the CPU and memory requests for the Metrics Server Nanny sidecar container to free up unused resources. ([#57252](https://github.com/kubernetes/kubernetes/pull/57252), [@kawych](https://github.com/kawych)) - -* Enabled log rotation for load balancer's api logs to prevent running out of disk space. ([#56979](https://github.com/kubernetes/kubernetes/pull/56979), [@hyperbolic2346](https://github.com/hyperbolic2346)) - -* Fixed `etcd-version-monitor` to backward compatibly support etcd 3.1 [go-grpc-prometheus](https://github.com/grpc-ecosystem/go-grpc-prometheus) metrics format. ([#56871](https://github.com/kubernetes/kubernetes/pull/56871), [@jpbetz](https://github.com/jpbetz)) - -### Node - -* Summary of Container Runtime changes: - * [beta] [cri-tools](https://github.com/kubernetes-incubator/cri-tools): CLI and validation tools for CRI is now v1.0.0-beta.0. This release mainly focused on UX improvements. [@feiskyer] - * [stable] [containerd](https://github.com/containerd/containerd): containerd v1.1 natively supports CRI v1alpha2 now, so users can use Kubernetes v1.10 with containerd v1.1 directly, without having to use the intermediate cri-containerd daemon. [All Kubernetes 1.10 tests passed](https://k8s-testgrid.appspot.com/sig-node-containerd). [@Random-Liu] - * [stable] [cri-o](https://github.com/kubernetes-incubator/cri-o): cri-o v1.10 updated CRI version to v1alpha2 and made several bug and stability fixes. [@mrunalp] - * [stable] [frakti](https://github.com/kubernetes/frakti): frakti v1.10 implemented GCE Persistent Disk as a high performance volume, fixed several bugs, added ARM64 support, and passed all CRI validation conformance tests and node e2e conformance tests. [@resouer] - -* Fixed race conditions around devicemanager Allocate() and endpoint deletion. ([#60856](https://github.com/kubernetes/kubernetes/pull/60856), [@jiayingz](https://github.com/jiayingz)) - -* kubelet initial flag parse now normalizes flags instead of exiting. ([#61053](https://github.com/kubernetes/kubernetes/pull/61053), [@andrewsykim](https://github.com/andrewsykim)) - -* Fixed regression where kubelet --cpu-cfs-quota flag did not work when --cgroups-per-qos was enabled ([#61294](https://github.com/kubernetes/kubernetes/pull/61294), [@derekwaynecarr](https://github.com/derekwaynecarr)) - -* Kubelet now supports container log rotation for container runtimes implementing CRI (container runtime interface). The feature can be enabled with feature gate `CRIContainerLogRotation`. The flags `--container-log-max-size` and `--container-log-max-files` can be used to configure the rotation behavior. ([#59898](https://github.com/kubernetes/kubernetes/pull/59898), [@Random-Liu](https://github.com/Random-Liu)) - -* Fixed a bug where if an error was returned that was not an `autorest.DetailedError` we would return `"not found", nil` which caused nodes to go to `NotReady` state. ([#57484](https://github.com/kubernetes/kubernetes/pull/57484), [@brendandburns](https://github.com/brendandburns)) - -* [HugePages](https://kubernetes.io/docs/tasks/manage-hugepages/scheduling-hugepages/) feature is beta, and thus enabled by default. ([#56939](https://github.com/kubernetes/kubernetes/pull/56939), [@derekwaynecarr](https://github.com/derekwaynecarr)) - -* Avoid panic when failing to allocate a Cloud CIDR (aka GCE Alias IP Range). ([#58186](https://github.com/kubernetes/kubernetes/pull/58186), [@negz](https://github.com/negz)) - -* 'none' can now be specified in KubeletConfiguration.EnforceNodeAllocatable (--enforce-node-allocatable) to explicitly disable enforcement. ([#59515](https://github.com/kubernetes/kubernetes/pull/59515), [@mtaufen](https://github.com/mtaufen)) - -* The alpha KubeletConfiguration.ConfigTrialDuration field is no longer available. It can still be set using the dynamic configuration alpha feature. ([#59628](https://github.com/kubernetes/kubernetes/pull/59628), [@mtaufen](https://github.com/mtaufen)) - -* Summary API will include pod CPU and Memory stats for CRI container runtime. ([#60328](https://github.com/kubernetes/kubernetes/pull/60328), [@Random-Liu](https://github.com/Random-Liu)) - -* Some field names in the Kubelet's now v1beta1 config API differ from the v1alpha1 API: for example, PodManifestPath is renamed to StaticPodPath, ManifestURL is renamed to StaticPodURL, and ManifestURLHeader is renamed to StaticPodURLHeader. Users should focus on switching to the v1beta1 API. ([#60314](https://github.com/kubernetes/kubernetes/pull/60314), [@mtaufen](https://github.com/mtaufen)) - -* The DevicePlugins feature has graduated to beta, and is now enabled by default; users should focus on moving to the v1beta API if possible. ([#60170](https://github.com/kubernetes/kubernetes/pull/60170), [@jiayingz](https://github.com/jiayingz)) - -* Per-cpu metrics have been disabled by default for to improve scalability. ([#60106](https://github.com/kubernetes/kubernetes/pull/60106), [@dashpole](https://github.com/dashpole)) - -* When the `PodShareProcessNamespace` alpha feature is enabled, setting `pod.Spec.ShareProcessNamespace` to `true` will cause a single process namespace to be shared between all containers in a pod. ([#58716](https://github.com/kubernetes/kubernetes/pull/58716), [@verb](https://github.com/verb)) - -* Resource quotas on extended resources such as GPUs are now supported. ([#57302](https://github.com/kubernetes/kubernetes/pull/57302), [@lichuqiang](https://github.com/lichuqiang)) - -* If the TaintNodesByCondition is enabled, a node will be tainted when it is under PID pressure. ([#60008](https://github.com/kubernetes/kubernetes/pull/60008), [@k82cn](https://github.com/k82cn)) - -* The Kubelet Summary API will now include total usage of pods through the "pods" SystemContainer. ([#57802](https://github.com/kubernetes/kubernetes/pull/57802), [@dashpole](https://github.com/dashpole)) - -* vSphere Cloud Provider supports VMs provisioned on vSphere v6.5. ([#59519](https://github.com/kubernetes/kubernetes/pull/59519), [@abrarshivani](https://github.com/abrarshivani)) - -* Created k8s.gcr.io image repo alias to pull images from the closest regional repo. Replaces gcr.io/google_containers. ([#57824](https://github.com/kubernetes/kubernetes/pull/57824), [@thockin](https://github.com/thockin)) - -* Fix the bug where kubelet in the standalone mode would wait for the update from the apiserver source, even if there wasn't one. ([#59276](https://github.com/kubernetes/kubernetes/pull/59276), [@roboll](https://github.com/roboll)) - -* Changes secret, configMap, downwardAPI and projected volumes to mount read-only, instead of allowing applications to write data and then reverting it automatically. Until version 1.11, setting the feature gate ReadOnlyAPIDataVolumes=false will preserve the old behavior. ([#58720](https://github.com/kubernetes/kubernetes/pull/58720), [@joelsmith](https://github.com/joelsmith)) - -* Fixes a bug where kubelet crashes trying to free memory under memory pressure. ([#58574](https://github.com/kubernetes/kubernetes/pull/58574), [@yastij](https://github.com/yastij)) - -* New alpha feature limits the number of processes running in a pod. Cluster administrators will be able to place limits by using the new kubelet command line parameter --pod-max-pids. Note that since this is a alpha feature they will need to enable the "SupportPodPidsLimit" feature. By default, we do not set any maximum limit, If an administrator wants to enable this, they should enable SupportPodPidsLimit=true in the --feature-gates= parameter to kubelet and specify the limit using the --pod-max-pids parameter. The limit set is the total count of all processes running in all containers in the pod. ([#57973](https://github.com/kubernetes/kubernetes/pull/57973),[@dims](https://github.com/dims)) - -* Fixes bug finding master replicas in GCE when running multiple Kubernetes clusters. ([#58561](https://github.com/kubernetes/kubernetes/pull/58561), [@jesseshieh](https://github.com/jesseshieh)) - -* --tls-min-version on kubelet and kube-apiserver allow for configuring minimum TLS versions ([#58528](https://github.com/kubernetes/kubernetes/pull/58528), [@deads2k](https://github.com/deads2k)) - -* Fix a bug affecting nested data volumes such as secret, configmap, etc. ([#57422](https://github.com/kubernetes/kubernetes/pull/57422), [@joelsmith](https://github.com/joelsmith)) - -* kubelet will no longer attempt to remove images being used by running containers when garbage collecting. ([#57020](https://github.com/kubernetes/kubernetes/pull/57020), [@dixudx](https://github.com/dixudx)) - -* Allow kubernetes components to react to SIGTERM signal and shutdown gracefully. ([#57756](https://github.com/kubernetes/kubernetes/pull/57756), [@mborsz](https://github.com/mborsz)) - -* Fixed garbage collection and resource quota issue when the controller-manager uses --leader-elect=false ([#57340](https://github.com/kubernetes/kubernetes/pull/57340), [@jmcmeek](https://github.com/jmcmeek)) - -* Fixed issue creating docker secrets with kubectl 1.9 for accessing docker private registries. ([#57463](https://github.com/kubernetes/kubernetes/pull/57463), [@dims](https://github.com/dims)) - -* The CPU Manager feature is now beta, and is enabled by default, but the default policy is no-op so no action is required. ([#55977](https://github.com/kubernetes/kubernetes/pull/55977), [@ConnorDoyle](https://github.com/ConnorDoyle)) - -### OpenStack - -* Fixed a bug in the OpenStack cloud provider where dual stack deployments (IPv4 and IPv6) did not work well when using kubenet as the network plugin. ([#59749](https://github.com/kubernetes/kubernetes/pull/59749), [@zioproto](https://github.com/zioproto)) - -* Fixed a bug that tries to use the octavia client to query flip. ([#59075](https://github.com/kubernetes/kubernetes/pull/59075), [@jrperritt](https://github.com/jrperritt)) - -* Kubernetes now registers metadata.hostname as node name for OpenStack nodes, eliminating a problem with invalid node names. ([#58502](https://github.com/kubernetes/kubernetes/pull/58502), [@dixudx](https://github.com/dixudx)) - -* Authentication information for OpenStack cloud provider can now be specified as environment variables. When we convert the OpenStack cloud provider to run in an external process, we can now use the kubernetes Secrets capability to inject the OS_* variables. This way we can specify the cloud configuration as a configmap, and specify secrets for the userid/password information. The configmap is mounted as a file, and the secrets are made available as environment variables. The external controller itself runs as a pod/daemonset. For backward compatibility, we preload all the OS_* variables, and if anything is in the config file, then that overrides the environment variables. ([#58300](https://github.com/kubernetes/kubernetes/pull/58300), [@dims](https://github.com/dims)) - -* Fixed issue when using OpenStack config drive for node metadata. Since we need to run commands such as blkid, we need to ensure that api server and kube controller are running in the privileged mode. ([#57561](https://github.com/kubernetes/kubernetes/pull/57561), [@dims](https://github.com/dims)) - -* Orphaned routes are properly removed from terminated instances. ([#56258](https://github.com/kubernetes/kubernetes/pull/56258), [@databus23](https://github.com/databus23)) - -* OpenStack Cinder will now detach properly when Nova is shut down. ([#56846](https://github.com/kubernetes/kubernetes/pull/56846), [@zetaab](https://github.com/zetaab)) -### Scalability - -* Added the ability to limit the increase in apiserver memory usage when audit logging with buffering is enabled. ([#61118](https://github.com/kubernetes/kubernetes/pull/61118), [@shyamjvs](https://github.com/shyamjvs)) - -* Upgrade to etcd client 3.2.13 and grpc 1.7.5 to improve HA etcd cluster stability. ([#57480](https://github.com/kubernetes/kubernetes/pull/57480), [@jpbetz](https://github.com/jpbetz)) - -### Storage - -* Fixes CVE-2017-1002101 - See [https://issue.k8s.io/60813](https://issue.k8s.io/60813) for details on this **major security fix**. ([#61044](https://github.com/kubernetes/kubernetes/pull/61044), [@liggitt](https://github.com/liggitt)) - -* Fixed missing error checking that could cause kubelet to crash in a race condition. ([#60962](https://github.com/kubernetes/kubernetes/pull/60962), [@technicianted](https://github.com/technicianted)) - -* Fixed a regression that prevented using `subPath` volume mounts with secret, configMap, projected, and downwardAPI volumes. ([#61080](https://github.com/kubernetes/kubernetes/pull/61080), [@liggitt](https://github.com/liggitt)) - -* K8s supports cephfs fuse mount. ([#55866](https://github.com/kubernetes/kubernetes/pull/55866), [@zhangxiaoyu-zidif](https://github.com/zhangxiaoyu-zidif)) - -* Use GiB unit for creating and resizing volumes for Glusterfs. ([#56581](https://github.com/kubernetes/kubernetes/pull/56581), [@gnufied](https://github.com/gnufied)) - -* Adding support for Block Volume type to rbd plugin. ([#56651](https://github.com/kubernetes/kubernetes/pull/56651), [@sbezverk](https://github.com/sbezverk)) - -* Add FSType for CSI volume source to specify filesystems (alpha defaults to ext4) ([#58209](https://github.com/kubernetes/kubernetes/pull/58209), [@NickrenREN](https://github.com/NickrenREN)) - -* Enabled File system resize of mounted volumes. ([#58794](https://github.com/kubernetes/kubernetes/pull/58794), [@gnufied](https://github.com/gnufied)) - -* The Local Volume Plugin has been updated to support Block volumeMode PVs. With this change, it is now possible to create local volume PVs for raw block devices. ([#59303](https://github.com/kubernetes/kubernetes/pull/59303), [@dhirajh](https://github.com/dhirajh)) - -* Fixed an issue where Portworx volume driver wasn't passing namespace and annotations to the Portworx Create API. ([#59607](https://github.com/kubernetes/kubernetes/pull/59607), [@harsh-px](https://github.com/harsh-px)) - -* Addressed breaking changes introduced by new 0.2.0 release of CSI spec. Specifically, csi.Version was removed from all API calls and CcontrollerProbe and NodeProbe were consolidated into a single Probe API call. ([#59209](https://github.com/kubernetes/kubernetes/pull/59209), [@sbezverk](https://github.com/sbezverk)) - -* GCE PD volume plugin now supports block volumes. ([#58710](https://github.com/kubernetes/kubernetes/pull/58710), [@screeley44](https://github.com/screeley44)) - -* Implements MountDevice and UnmountDevice for the CSI Plugin, the functions will call through to NodeStageVolume/NodeUnstageVolume for CSI plugins. ([#60115](https://github.com/kubernetes/kubernetes/pull/60115), [@davidz627](https://github.com/davidz627)) - -* The LocalStorageCapacityIsolation feature is beta and enabled by default. The LocalStorageCapacityIsolation feature added a new resource type ResourceEphemeralStorage "ephemeral-storage" so that this resource can be allocated, limited, and consumed as the same way as CPU/memory. All the features related to resource management (resource request/limit, quota, limitrange) are available for local ephemeral storage. This local ephemeral storage represents the storage for root file system, which will be consumed by containers' writable layer and logs. Some volumes such as emptyDir might also consume this storage. ([#60159](https://github.com/kubernetes/kubernetes/pull/60159), [@jingxu97](https://github.com/jingxu97)) - -* VolumeScheduling and LocalPersistentVolume features are beta and enabled by default. The PersistentVolume NodeAffinity alpha annotation is deprecated and will be removed in a future release. ([#59391](https://github.com/kubernetes/kubernetes/pull/59391), [@msau42](https://github.com/msau42)) - -* K8s now supports rbd-nbd for Ceph rbd volume mounts. ([#58916](https://github.com/kubernetes/kubernetes/pull/58916), [@ianchakeres](https://github.com/ianchakeres)) - -* CSI now allows credentials to be specified on CreateVolume/DeleteVolume, ControllerPublishVolume/ControllerUnpublishVolume, and NodePublishVolume/NodeUnpublishVolume operations. Before this change all API calls had to fetch key/value stored in secret and use it to authenticate/authorize these operations. With this change API calls receive key/value as a input parameter so they not need to know where and how credentials were stored and fetched. Main goal was to make these API calls CO (Container Orchestrator) agnostic. ([#60118](https://github.com/kubernetes/kubernetes/pull/60118), [@sbezverk](https://github.com/sbezverk)) - -* StorageOS volume plugin has been updated to support mount options and environments where the kubelet runs in a container and the device location should be specified. ([#58816](https://github.com/kubernetes/kubernetes/pull/58816), [@croomes](https://github.com/croomes)) - -* Get parent dir via canonical absolute path when trying to judge mount-point, fixing a problem that caused an NFS volume with improper permissions to get stuck in `TERMINATING` status. ([#58433](https://github.com/kubernetes/kubernetes/pull/58433), [@yue9944882]](https://github.com/yue9944882)) - -* Clusters with GCE feature 'DiskAlphaAPI' enabled can now dynamically provision GCE PD volumes. ([#59447](https://github.com/kubernetes/kubernetes/pull/59447), [@verult](https://github.com/verult)) - -* Added `keyring` parameter for Ceph RBD provisioner. ([#58287](https://github.com/kubernetes/kubernetes/pull/58287), [@madddi](https://github.com/madddi)) - -* Added xfsprogs to hyperkube container image. ([#56937](https://github.com/kubernetes/kubernetes/pull/56937), [@redbaron](https://github.com/redbaron)) - -* Improved messages user gets during and after volume resizing is done, providing a clear message to the user explaining what to do when resizing is finished. ([#58415](https://github.com/kubernetes/kubernetes/pull/58415), [@gnufied](https://github.com/gnufied)) - -* MountPropagation feature is now beta. As consequence, all volume mounts in containers are now "rslave" on Linux by default. To make this default work in all Linux environments you should have entire mount tree marked as shareable via "mount --make-rshared /". All Linux distributions that use systemd already have root directory mounted as rshared and hence they need not do anything. In Linux environments without systemd we recommend running "mount --make-rshared /" during boot, before docker is started. ([#59252](https://github.com/kubernetes/kubernetes/pull/59252), [@jsafrane](https://github.com/jsafrane)) - -* Volume metrics support for vSphere Cloud Provider has been added. You can now monitor available space, capacity, and used space on volumes created using vSphere. ([#59328](https://github.com/kubernetes/kubernetes/pull/59328), [@divyenpatel](https://github.com/divyenpatel)) - -* Emit number of bound and unbound persistent volumes as Metrics. This PR adds four kinds of Volume Metrics for kube-controller-manager: bound PVC numbers, unbound PVC numbers, bound PV numbers and unbound PV numbers. The PVC metrics use namespace as dimension and the PV metrics use StorageClassName as its dimension. With these metrics we can better monitor the use of volumes in the cluster. ([#57872](https://github.com/kubernetes/kubernetes/pull/57872), [@mlmhl](https://github.com/mlmhl)) - -* Add windows config to Kubelet CRI so that WindowsContainerResources can be managed. ([#57076](https://github.com/kubernetes/kubernetes/pull/57076), [@feiskyer](https://github.com/feiskyer)) - -* PersistentVolumes that are bound to a PersistentVolumeClaim will not be deleted. ([#58743](https://github.com/kubernetes/kubernetes/pull/58743), [@NickrenREN](https://github.com/NickrenREN)) - -* The VolumeAttachment API is now available as V1beta1, and is enabled by default. The Alpha API is deprecated and will be removed in a future release. ([#58462](https://github.com/kubernetes/kubernetes/pull/58462), [@NickrenREN](https://github.com/NickrenREN)) - -* Add storage-backend configuration option to kubernetes-master charm. ([#58830](https://github.com/kubernetes/kubernetes/pull/58830), [@wwwtyro](https://github.com/wwwtyro)) - -* Fixed dynamic provisioning of GCE PDs to round to the next GB (base 1000) instead of GiB (base 1024). ([#56600](https://github.com/kubernetes/kubernetes/pull/56600), [@edisonxiang](https://github.com/edisonxiang)) - -* PersistentVolume flexVolume sources can now reference secrets in a namespace other than the PersistentVolumeClaim's namespace. ([#56460](https://github.com/kubernetes/kubernetes/pull/56460), [@liggitt](https://github.com/liggitt)) - -### Windows - -* kubelet and kube-proxy can now be run as native Windows services. ([#60144](https://github.com/kubernetes/kubernetes/pull/60144), [@alinbalutoiu](https://github.com/alinbalutoiu)) - -* WindowsContainerResources is set now for windows containers. ([#59333](https://github.com/kubernetes/kubernetes/pull/59333), [@feiskyer](https://github.com/feiskyer)) - -* Disable mount propagation for windows containers (because it is not supported by the OS). ([#60275](https://github.com/kubernetes/kubernetes/pull/60275), [@feiskyer](https://github.com/feiskyer)) - -* Fix image file system stats for windows nodes. ([#59743](https://github.com/kubernetes/kubernetes/pull/59743), [@feiskyer](https://github.com/feiskyer)) - -* Kubernetes will now return an error if New-SmbGlobalMapping failed when mounting an azure file on Windows. ([#59540](https://github.com/kubernetes/kubernetes/pull/59540), [@andyzhangx](https://github.com/andyzhangx)) - -* Kubernetes now uses the more reliable GlobalMemoryStatusEx to get total physical memory on windows nodes. ([#57124](https://github.com/kubernetes/kubernetes/pull/57124), [@JiangtianLi](https://github.com/JiangtianLi)) - -* Windows containers now support experimental Hyper-V isolation by setting annotation `experimental.windows.kubernetes.io/isolation-type=hyperv` and feature gates HyperVContainer. At the moment this function only supports one container per pod. ([#58751](https://github.com/kubernetes/kubernetes/pull/58751), [@feiskyer](https://github.com/feiskyer)) - -* Get windows kernel version directly from registry rather than windows.getVersion(). ([#58498](https://github.com/kubernetes/kubernetes/pull/58498), [@feiskyer](https://github.com/feiskyer)) - -* Fixed controller manager crash when using mixed case names in a vSphere cloud provider environment. ([#57286](https://github.com/kubernetes/kubernetes/pull/57286), [@rohitjogvmw](https://github.com/rohitjogvmw)) - -* Flexvolume is now [enabled on Windows nodes](https://github.com/andyzhangx/Demo/tree/master/windows/flexvolume). ([#56921](https://github.com/kubernetes/kubernetes/pull/56921), [@andyzhangx](https://github.com/andyzhangx)) - -### Autoscaling - -* The getSubnetIDForLB() returns subnet id rather than net id. ([#58208](https://github.com/kubernetes/kubernetes/pull/58208), [@FengyunPan](https://github.com/FengyunPan)) - -* `kubectl scale` can now scale any resource (kube, CRD, aggregate) conforming to the standard scale endpoint ([#58298](https://github.com/kubernetes/kubernetes/pull/58298), [@p0lyn0mial](https://github.com/p0lyn0mial)) - -* Cluster Autoscaler has been updated to Version 1.2.0, which includes fixes around GPUs and base image change. See [https://github.com/kubernetes/autoscaler/releases/tag/cluster-autoscaler-](https://github.com/kubernetes/autoscaler/releases/tag/cluster-autoscaler-1.1.2)1.2.0for details. ([#60842](https://github.com/kubernetes/kubernetes/pull/60842), [@mwielgus](https://github.com/mwielgus)) - -* Allows HorizontalPodAutoscaler to use global metrics not associated with any Kubernetes object (for example metrics from a hosting service running outside of the Kubernetes cluster). ([#60096](https://github.com/kubernetes/kubernetes/pull/60096), [@MaciekPytel](https://github.com/MaciekPytel)) - -* fluentd-gcp resources can be modified via a ScalingPolicy. ([#59657](https://github.com/kubernetes/kubernetes/pull/59657), [@x13n](https://github.com/x13n)) - -* Added anti-affinity to kube-dns pods. Otherwise the "no single point of failure" setting doesn't actually work (a single node failure can still take down the entire cluster). ([#57683](https://github.com/kubernetes/kubernetes/pull/57683), [@vainu-arto](https://github.com/vainu-arto)) - -### API-Machinery - -* Fixed webhooks to use the scheme provided in clientConfig, instead of defaulting to http. ([#60943](https://github.com/kubernetes/kubernetes/pull/60943), [@jennybuckley](https://github.com/jennybuckley)) - -* The webhook admission controller in a custom apiserver now works off-the-shelf. ([#60995](https://github.com/kubernetes/kubernetes/pull/60995), [@caesarxuchao](https://github.com/caesarxuchao)) - -* Upgrade the default etcd server version to 3.1.12 to pick up critical etcd "mvcc "unsynced" watcher restore operation" fix. ([#60998](https://github.com/kubernetes/kubernetes/pull/60998), [@jpbetz](https://github.com/jpbetz)) - -* Fixed bug allowing garbage collector to enter a broken state that could only be fixed by restarting the controller-manager. ([#61201](https://github.com/kubernetes/kubernetes/pull/61201), [@jennybuckley](https://github.com/jennybuckley)) - -* kube-apiserver: The external hostname no longer longer use the cloud provider API to select a default. It can be set explicitly using --external-hostname, if needed. If there is no default, AdvertiseAddress or os.Hostname() will be used, in that order. ([#56812](https://github.com/kubernetes/kubernetes/pull/56812), [@dims](https://github.com/dims)) - -* Custom resources can be listed with a set of grouped resources (category) by specifying the categories in the [CustomResourceDefinition spec](https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/#categories). Example: They can be used with `kubectl get important`, where `important` is a category. ([#59561](https://github.com/kubernetes/kubernetes/pull/59561), [@nikhita](https://github.com/nikhita)) - -* Fixed an issue making it possible to create a situation in which two webhooks make it impossible to delete each other. ValidatingWebhooks and MutatingWebhooks will not be called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects in the admissionregistration.k8s.io group ([#59840](https://github.com/kubernetes/kubernetes/pull/59840), [@jennybuckley](https://github.com/jennybuckley)) - -* Fixed potential deadlock when deleting CustomResourceDefinition for custom resources with finalizers. ([#60542](https://github.com/kubernetes/kubernetes/pull/60542), [@liggitt](https://github.com/liggitt)) - -* A buffered audit backend can be used with other audit backends. ([#60076](https://github.com/kubernetes/kubernetes/pull/60076), [@crassirostris](https://github.com/crassirostris)) - -* Introduced `--http2-max-streams-per-connection` command line flag on api-servers and set default to 1000 for aggregated API servers. ([#60054](https://github.com/kubernetes/kubernetes/pull/60054), [@MikeSpreitzer](https://github.com/MikeSpreitzer)) - -* APIserver backed by etcdv3 exports metric shows number of resources per kind. ([#59757](https://github.com/kubernetes/kubernetes/pull/59757), [@gmarek](https://github.com/gmarek)) - -* Add `kubectl create job --from-cronjob` command. ([#60084](https://github.com/kubernetes/kubernetes/pull/60084), [@soltysh](https://github.com/soltysh)) - -* `/status` and `/scale` subresources have been added for custom resources. See [https://github.com/kubernetes/kubernetes/pull/55168](https://github.com/kubernetes/kubernetes/pull/55168) for more details. ([#55168](https://github.com/kubernetes/kubernetes/pull/55168), [@nikhita](https://github.com/nikhita)) - -* Restores the ability of older clients to delete and scale jobs with initContainers. ([#59880](https://github.com/kubernetes/kubernetes/pull/59880), [@liggitt](https://github.com/liggitt)) - -* Fixed a race condition causing apiserver crashes during etcd healthchecking. ([#60069](https://github.com/kubernetes/kubernetes/pull/60069), [@wojtek-t](https://github.com/wojtek-t)) - -* Fixed a race condition in k8s.io/client-go/tools/cache.SharedInformer that could violate the sequential delivery guarantee and cause panics on shutdown in Kubernetes 1.8.* and 1.9.*. ([#59828](https://github.com/kubernetes/kubernetes/pull/59828), [@krousey](https://github.com/krousey)) - -* Add automatic etcd 3.2->3.1 and 3.1->3.0 minor version rollback support to gcr.io/google_container/etcd images. For HA clusters, all members must be stopped before performing a rollback. ([#59298](https://github.com/kubernetes/kubernetes/pull/59298), [@jpbetz](https://github.com/jpbetz)) - -* The `meta.k8s.io/v1alpha1` objects for retrieving tabular responses from the server (`Table`) or fetching just the `ObjectMeta` for an object (as `PartialObjectMetadata`) are now beta as part of `meta.k8s.io/v1beta1` and configurations must be changed to use the new API. Clients may request alternate representations of normal Kubernetes objects by passing an `Accept` header like `application/json;as=Table;g=meta.k8s.io;v=v1beta1` or `application/json;as=PartialObjectMetadata;g=meta.k8s.io;v1=v1beta1`. Older servers will ignore this representation or return an error if it is not available. Clients may request fallback to the normal object by adding a non-qualified mime-type to their `Accept` header like `application/json` - the server will then respond with either the alternate representation if it is supported or the fallback mime-type which is the normal object response. ([#59059](https://github.com/kubernetes/kubernetes/pull/59059), [@smarterclayton](https://github.com/smarterclayton)) - -* kube-apiserver now uses SSH tunnels for webhooks if the webhook is not directly routable from apiserver's network environment. ([#58644](https://github.com/kubernetes/kubernetes/pull/58644), [@yguo0905](https://github.com/yguo0905)) - -* Access to externally managed IP addresses via the kube-apiserver service proxy subresource is no longer allowed by default. This can be re-enabled via the `ServiceProxyAllowExternalIPs` feature gate, but will be disallowed completely in 1.11 ([#57265](https://github.com/kubernetes/kubernetes/pull/57265), [@brendandburns](https://github.com/brendandburns)) +## Other Notable Changes -* The apiregistration.k8s.io (aggregation) is now generally available. Users should transition from the v1beta1 API to the v1 API. ([#58393](https://github.com/kubernetes/kubernetes/pull/58393), [@deads2k](https://github.com/deads2k)) +### SIG API Machinery + +* Orphan delete is now supported for custom resources. ([#63386](https://github.com/kubernetes/kubernetes/pull/63386), [@roycaihw](https://github.com/roycaihw)) +* Metadata of CustomResources is now pruned and schema-checked during deserialization of requests and when read from etcd. In the former case, invalid meta data is rejected, in the later it is dropped from the CustomResource objects. ([#64267](https://github.com/kubernetes/kubernetes/pull/64267), [@sttts](https://github.com/sttts)) +* The kube-apiserver openapi doc now includes extensions identifying `APIService` and `CustomResourceDefinition` `kind`s ([#64174](https://github.com/kubernetes/kubernetes/pull/64174), [@liggitt](https://github.com/liggitt)) +* CustomResourceDefinitions Status subresource now supports GET and PATCH ([#63619](https://github.com/kubernetes/kubernetes/pull/63619), [@roycaihw](https://github.com/roycaihw)) +* When updating `/status` subresource of a custom resource, only the value at the `.status` subpath for the update is considered. ([#63385](https://github.cm/kubernetes/kubernetes/pull/63385), [@CaoShuFeng](https://github.com/CaoShuFeng)) +* Added a way to pass extra arguments to etcd. The these extra arguments can be used to adjust runtime configuration like heartbeat interval etc. ([#63961](https://github.com/kubernetes/kubernetes/pull/63961), [@mborsz](https://github.com/mborsz)) +* Added Establishing Controller on CRDs to avoid race between Established condition and CRs actually served. In HA setups, the Established condition is delayed by 5 seconds. ([#63068](https://github.com/kubernetes/kubernetes/pull/63068), [@xmudrii](https://github.com/xmudrii)) +* Added `spec.additionalPrinterColumns` to CRDs to define server side printing columns. ([#60991](https://github.com/kubernetes/kubernetes/pull/60991), [@sttts](https://github.com/sttts)) +* Added CRD Versioning with NOP converter ([#63830](https://github.com/kubernetes/kubernetes/pull/63830), [@mbohlool](https://github.com/mbohlool)) +* Allow "required" and "description" to be used at the CRD OpenAPI validation schema root when the `/status` subresource is enabled. ([#63533](https://github.com/kubernetes/kubernetes/pull/63533), [@sttts](https://github.com/sttts)) +* Etcd health checks by the apiserver now ensure the apiserver can connect to and exercise the etcd API. ([#65027](https://github.com/kubernetes/kubernetes/pull/65027), [@liggitt](https://github.com/liggitt)) api- machinery +* The deprecated `--service-account-private-key-file` flag has been removed from the `cloud-controller-manager`. The flag is still present and supported in the `kube-controller-manager`. ([#65182](https://github.com/kubernetes/kubernetes/pull/65182), [@liggitt](https://github.com/liggitt)) +* Webhooks for the mutating admission controller now support the "remove" operation. ([#64255](https://github.com/kubernetes/kubernetes/pull/64255), [@rojkov](https://github.com/rojkov)) sig-API machinery +* The CRD OpenAPI v3 specification for validation now allows `additionalProperties`, which are mutually exclusive to properties. ([#62333](https://github.com/kubernetes/kubernetes/pull/62333), [@sttts](https://github.com/sttts)) +* Added the apiserver configuration option to choose the audit output version. ([#60056](https://github.com/kubernetes/kubernetes/pull/60056), [@crassirostris](https://github.com/crassirostris)) +* Created a new `dryRun` query parameter for mutating endpoints. If the parameter is set, then the query will be rejected, as the feature is not implemented yet. This will allow forward compatibility with future clients; otherwise, future clients talking with older apiservers might end up modifying a resource even if they include the `dryRun` query parameter. ([#63557](https://github.com/kubernetes/kubernetes/pull/63557), [@apelisse](https://github.com/apelisse)) +* `list`/`watch` API requests with a `fieldSelector` that specifies `metadata.name` can now be authorized as requests for an individual named resource ([#63469](https://github.com/kubernetes/kubernetes/pull/63469), [@wojtek-t](https://github.com/wojtek-t)) +* Exposed `/debug/flags/v` to allow dynamically set glog logging level. For example, to change glog level to 3, send a PUT request such as `curl -X PUT http://127.0.0.1:8080/debug/flags/v -d "3"`. ([#63777](https://github.com/kubernetes/kubernetes/pull/63777), [@hzxuzhonghu](https://github.com/hzxuzhonghu)) +* Exec authenticator plugin supports TLS client certificates. ([#61803](https://github.com/kubernetes/kubernetes/pull/61803), [@awly](https://github.com/awly)) +* The `serverAddressByClientCIDRs` property in `metav1.APIGroup`(discovery API) is now optional instead of required. ([#61963](https://github.com/kubernetes/kubernetes/pull/61963), [@roycaihw](https://github.com/roycaihw)) +* `apiservices/status` and `certificatesigningrequests/status` now support `GET` and `PATCH` ([#64063](https://github.com/kubernetes/kubernetes/pull/64063), [@roycaihw](https://github.com/roycaihw)) +* APIServices with kube-like versions (e.g. `v1`, `v2beta1`, etc.) will be sorted appropriately within each group. ([#64004](https://github.com/kubernetes/kubernetes/pull/64004), [@mbohlool](https://github.com/mbohlool)) +* Event object references with apiversion will now that value. ([#63913](https://github.com/kubernetes/kubernetes/pull/63913), [@deads2k](https://github.com/deads2k)) +* Fixes the `kubernetes.default.svc` loopback service resolution to use a loopback configuration. ([#62649](https://github.com/kubernetes/kubernetes/pull/62649), [@liggitt](https://github.com/liggitt)) + +### SIG Apps + +* Added generators for `apps/v1` deployments. ([#61288](https://github.com/kubernetes/kubernetes/pull/61288), [@ayushpateria](https://github.com/ayushpateria)) + +### SIG Auth + +* RBAC information is now included in audit logs via audit.Event annotations: + * authorization.k8s.io/decision = {allow, forbid} + * authorization.k8s.io/reason = human-readable reason for the decision ([#58807](https://github.com/kubernetes/kubernetes/pull/58807), [@CaoShuFeng](https://github.com/CaoShuFeng)) +* `kubectl certificate approve|deny` will not modify an already approved or denied CSR unless the `--force` flag is provided. ([#61971](https://github.com/kubernetes/kubernetes/pull/61971), [@smarterclayton](https://github.com/smarterclayton)) +* The `--bootstrap-kubeconfig` argument to Kubelet previously created the first bootstrap client credentials in the certificates directory as `kubelet-client.key` and `kubelet-client.crt`. Subsequent certificates created by cert rotation were created in a combined PEM file that was atomically rotated as `kubelet-client-DATE.pem` in that directory, which meant clients relying on the `node.kubeconfig` generated by bootstrapping would never use a rotated cert. The initial bootstrap certificate is now generated into the cert directory as a PEM file and symlinked to `kubelet-client-current.pem` so that the generated kubeconfig remains valid after rotation. ([#62152](https://github.com/kubernetes/kubernetes/pull/62152), [@smarterclayton](https://github.com/smarterclayton)) +* Owner references can now be set during creation, even if the user doesn't have deletion power ([#63403](https://github.com/kubernetes/kubernetes/pull/63403), [@deads2k](https://github.com/deads2k)) +* Laid the groundwork for OIDC distributed claims handling in the apiserver authentication token checker. A distributed claim allows the OIDC provider to delegate a claim to a separate URL. ([ref](http://openid.net/specs/openid-connect-core-1_0.html#AggregatedDistributedClaims)). ([#63213](https://github.com/kubernetes/kubernetes/pull/63213), [@filmil](https://github.com/filmil)) +* RBAC: all configured authorizers are now checked to determine if an RBAC role or clusterrole escalation (setting permissions the user does not currently have via RBAC) is allowed. ([#56358](https://github.com/kubernetes/kubernetes/pull/56358), [@liggitt](https://github.com/liggitt)) +* kube-apiserver: OIDC authentication now supports requiring specific claims with `--oidc-required-claim==` Previously, there was no mechanism for a user to specify claims in the OIDC authentication process that were requid to be present in the ID Token with an expected value. This version now makes it possible to require claims support for the OIDC authentication. It allows users to pass in a `--oidc-required-claims` flag, and `key=value` pairs in the API config, which will ensure that the specified required claims are checked against the ID Token claims. ([#62136](https://github.com/kubernetes/kubernetes/pull/62136), [@rithujohn191](https://github.com/rithujohn191)) +* Included the list of security groups when failing with the errors that more than one is tagged. ([#58874](https://github.com/kubernetes/kubernetes/pull/58874), [@sorenmat](https://github.com/sorenmat)) +* Added proxy for container streaming in kubelet for streaming auth. ([#64006](https://github.com/kubernetes/kubernetes/pull/64006), [@Random-Liu](https://github.com/Random-Liu)) +* PodSecurityPolicy admission information has been added to audit logs. ([#58143](https://github.com/kubernetes/kubernetes/pull/58143), [@CaoShuFeng](https://github.com/CaoShuFeng)) +* TokenRequests now are required to have an expiration duration between 10 minutes and 2^32 seconds. ([#63999](https://github.com/kubernetes/kubernetes/pull/63999), [@mikedanese](https://github.com/mikedanese)) +* The `NodeRestriction` admission plugin now prevents kubelets from modifying/removing taints applied to their Node API object. ([#63167](https://github.com/kubernetes/kubernetes/pull/63167), [@liggitt](https://github.com/liggitt)) +* authz: nodes should not be able to delete themselves ([#62818](https://github.com/kubernetes/kubernetes/pull/62818), [@mikedanese](https://github.com/mikedanese)) + +### SIG Autoscaling + +* A cluster-autoscaler ClusterRole is added to cover only the functionality required by Cluster Autoscaler and avoid abusing system:cluster-admin role. Cloud providers other than GCE might want to update their deployments or sample yaml files to reuse the role created via add-on. ([#64503](https://github.com/kubernetes/kubernetes/pull/64503), [@kgolab](https://github.com/kgolab)) + +### SIG Azure + +* The Azure cloud provider now supports standard SKU load balancer and public IP. +`excludeMasterFromStandardLB` defaults to true, which means master nodes are excluded from the standard load balancer. Also note that because all nodes (except master) are added as loadbalancer backends, the standard load balancer doesn't work with the `service.beta.kubernetes.io/azure-load-balancer-mode` annotation. +([#61884](https://github.com/kubernetes/kubernetes/pull/61884), [#62707](https://github.com/kubernetes/kubernetes/pull/62707), [@feiskyer](https://github.com/feiskyer)) +* The Azure cloud provider now supports specifying allowed service tags by the `service.beta.kubernetes.io/azure-allowed-service-tags` annotation. ([#61467](https://github.com/kubernetes/kubernetes/pull/61467), [@feiskyer](https://github.com/feiskyer)) +* You can now change the size of an azuredisk PVC using `kubectl edit pvc pvc-azuredisk`. Note that this operation will fail if the volume is already attached to a running VM. ([#64386](https://github.com/kubernetes/kubernetes/pull/64386), [@andyzhangx](https://github.com/andyzhangx)) +* Block device support has been added for azure disk. ([#63841](https://github.com/kubernetes/kubernetes/pull/63841), [@andyzhangx](https://github.com/andyzhangx)) +* Azure VM names can now contain the underscore (`_`) character ([#63526](https://github.com/kubernetes/kubernetes/pull/63526), [@djsly](https://github.com/djsly)) +* Azure disks now support external resource groups. +([#64427](https://github.com/kubernetes/kuernetes/pull/64427), [@andyzhangx](https://github.com/andyzhangx)) +* Added reason message logs for non-existant Azure resources. +([#64248](https://github.com/kubernetes/kubernetes/pull/64248), [@feiskyer](https://github.com/feiskyer)) + +### SIG CLI + +* You can now use the `base64decode` function in kubectl go templates to decode base64-encoded data, such as `kubectl get secret SECRET -o go-template='{{ .data.KEY | base64decode }}'`. ([#60755](https://github.com/kubernetes/kubernetes/pull/60755), [@glb](https://github.com/glb)) +* `kubectl patch` now supports `--dry-run`. ([#60675](https://github.com/kubernetes/kubernetes/pull/60675), [@timoreimann](https://github.com/timoreimann)) +* The global flag `--match-server-version` is now global. `kubectl version` will respect it. ([#63613](https://github.com/kubernetes/kubernetes/pull/63613), [@deads2k](https://github.com/deads2k)) +* kubectl will list all allowed print formats when an invalid format is passed. ([#64371](https://github.com/kubernetes/kubernetes/pull/64371), [@CaoShuFeng](https://github.com/CaoShuFeng)) +* The global flag "context" now gets applied to `kubectl config view --minify`. In previous versions, this command was only available for `current-context`. Now it will be easier for users to view other non current contexts when minifying. ([#64608](https://github.com/kubernetes/kubernetes/pull/64608), [@dixudx](https://github.com/dixudx)) +* `kubectl apply --prune` supports CronJob resources. ([#62991](https://github.com/kubernetes/kubernetes/pull/62991), [@tomoe](https://github.com/tomoe)) +* The `--dry-run` flag has been enabled for `kubectl auth reconcile` ([#64458](https://github.com/kubernetes/kubernetes/pull/64458), [@mrogers950](https://github.com/mrogers950)) +* `kubectl wait` is a new command that allows waiting for one or more resources to be deleted or to reach a specific condition. It adds a `kubectl wait --for=[delete|condition=condition-name] resource/string` command. ([#64034](https://github.com/kubernetes/kubernetes/pull/64034), [@deads2k](https://github.com/deads2k)) +* `kubectl auth reconcile` only works with rbac.v1; all the core helpers have been switched over to use the external types. ([#63967](https://github.com/kubernetes/kubernetes/pull/63967), [@deads2k](https://github.com/deads2k)) +* kubectl and client-go now detect duplicated names for user, cluster and context when loading kubeconfig and report this condition as an error. ([#60464](https://github.com/kubernetes/kubernetes/pull/60464), [@roycaihw](https://github.com/roycaihw)) +* Added 'UpdateStrategyType' and 'RollingUpdateStrategy' to 'kubectl describe sts' command output. ([#63844](https://github.com/kubernetes/kubernetes/pull/63844), [@tossmilestone](https://github.com/tossmilestone)) +* Initial Korean translation for kubectl has been added. ([#62040](https://github.com/kubernetes/kubernetes/pull/62040), [@ianychoi](https://github.com/ianychoi)) +* `kubectl cp` now supports completion. +([#60371](https://github.com/kubernetes/kubernetes/pull/60371), [@superbrothers](https://github.com/superbrothers)) +* The shortcuts that were moved server-side in at least 1.9 have been removed from being hardcoded in kubectl. This means that the client-based restmappers have been moved to client-go, where everyone who needs them can have access. ([#63507](https://github.com/kubernetes/kubernetes/pull/63507), [@deads2k](https://github.com/deads2k)) +* When using `kubectl delete` with selection criteria, the defaults to is now to ignore "not found" errors. Note that this does not apply when deleting a speciic resource. ([#63490](https://github.com/kubernetes/kubernetes/pull/63490), [@deads2k](https://github.com/deads2k)) +* `kubectl create [secret | configmap] --from-file` now works on Windows with fully-qualified paths ([#63439](https://github.com/kubernetes/kubernetes/pull/63439), [@liggitt](https://github.com/liggitt)) +* Portability across systems has been increased by the use of `/usr/bin/env` in all script shebangs. ([#62657](https://github.com/kubernetes/kubernetes/pull/62657), [@matthyx](https://github.com/matthyx)) +* You can now use `kubectl api-resources` to discover resources. + ([#42873](https://github.com/kubernetes/kubernetes/pull/42873), [@xilabao](https://github.com/xilabao)) +* You can now display requests/limits of extended resources in node allocated resources. ([#46079](https://github.com/kubernetes/kubernetes/pull/46079), [@xiangpengzhao](https://github.com/xiangpengzhao)) +* The `--remove-extra-subjects` and `--remove-extra-permissions` flags have been enabled for `kubectl auth reconcile` ([#64541](https://github.com/kubernetes/kubernetes/pull/64541), [@mrogers950](https://github.com/mrogers950)) +* kubectl now has improved compatibility with older servers when creating/updating API objects ([#61949](https://github.com/kubernetes/kubernetes/pull/61949), [@liggitt](https://github.com/liggitt)) +* `kubectl apply` view/edit-last-applied now supports completion. ([#60499](https://github.com/kubernetes/kubernetes/pull/60499), [@superbrothers](https://github.com/superbrothers)) + +### SIG Cluster Lifecycle + + * kubeadm: The `:Etcd` struct has been refactored in the v1alpha2 API. All the options now reside under either `.Etcd.Local` or `.Etcd.External`. Automatic conversions from the v1alpha1 API are supported. ([#64066](https://github.com/kubernetes/kubernetes/pull/64066), [@luxas](https://github.com/luxas)) +* kubeadm now uses an upgraded API version for the configuration file, `kubeadm.k8s.io/v1alpha2`. kubeadm in v1.11 will still be able to read `v1alpha1` configuration, and will automatically convert the configuration to `v1alpha2`, both internally and when storing the configuration in the ConfigMap in the cluster. ([#63788](https://github.com/kubernetes/kubernetes/pull/63788), [@luxas](https://github.com/luxas)) +* Phase `kubeadm alpha phase kubelet` has been added to support dynamic kubelet configuration in kubeadm. ([#57224](https://github.com/kubernetes/kubernetes/pull/57224), [@xiangpengzhao](https://github.com/xiangpengzhao)) +* The kubeadm config option `API.ControlPlaneEndpoint` has been extended to take an optional port, which may differ from the apiserver's bind port. ([#62314](https://github.com/kubernetes/kubernetes/pull/62314), [@rjosephwright](https://github.com/rjosephwright)) +* The `--cluster-name` parameter has been added to kubeadm init, enabling users to specify the cluster name in kubeconfig. ([#60852](https://github.com/kubernetes/kubernetes/pull/60852), [@karan](https://github.com/karan)) +* The logging feature for kubeadm commands now supports a verbosity setting. ([#57661](https://github.com/kubernetes/kubernetes/pull/57661), [@vbmade2000](https://github.com/vbmade2000)) +* kubeadm now has a join timeout that can be controlled via the `discoveryTimeout` config option. This option is set to 5 minutes by default. ([#60983](https://github.com/kubernetes/kubernetes/pull/60983), [@rosti](https://github.com/rosti)) +* Added the `writable` boolean option to kubeadm config. This option works on a per-volume basis for `ExtraVolumes` config keys. ([#60428](https://github.com/kubernetes/kubernetes/pul60428), [@rosti](https://github.com/rosti)) +* Added a new `kubeadm upgrade node config` command. ([#64624](https://github.com/kubernetes/kubernetes/pull/64624), [@luxas](https://github.com/luxas)) +* kubeadm now makes the CoreDNS container more secure by dropping (root) capabilities and improves the integrity of the container by running the whole container in read-only. ([#64473](https://github.com/kubernetes/kubernetes/pull/64473), [@nberlee](https://github.com/nberlee)) +* kubeadm now detects the Docker cgroup driver and starts the kubelet with the matching driver. This eliminates a common error experienced by new users in when the Docker cgroup driver is not the same as the one set for the kubelet due to different Linux distributions setting different cgroup drivers for Docker, making it hard to start the kubelet properly. +([#64347](https://github.com/kubernetes/kubernetes/pull/64347), [@neolit123](https://github.com/neolit123)) +* Added a 'kubeadm config migrate' command to convert old API types to their newer counterparts in the new, supported API types. This is just a client-side tool; it just executes locally without requiring a cluster to be running, operating in much the same way as a Unix pipe that upgrades config files. ([#64232](https://github.com/kubernetes/kubernetes/pull/64232), [@luxas](https://github.com/luxas)) +* kubeadm will now pull required images during preflight checks if it cannot find them on the system. ([#64105](https://github.com/kubernetes/kubernetes/pull/64105), [@chuckha](https://github.com/chuckha)) +* "kubeadm init" now writes a structured and versioned kubelet ComponentConfiguration file to `/var/lib/kubelet/config.yaml` and an environment file with runtime flags that you can source in the systemd kubelet dropin to `/var/lib/kubelet/kubeadm-flags.env`. ([#63887](https://github.com/kubernetes/kubernetes/pull/63887), [@luxas](https://github.com/luxas)) +* A `kubeadm config print-default` command has now been added. You can use this command to output a starting point when writing your own kubeadm configuration files. ([#63969](https://github.com/kubernetes/kubernetes/pull/63969), [@luxas](https://github.com/luxas)) +* Updated kubeadm's minimum supported kubernetes in v1.11.x to 1.10 ([#63920](https://github.com/kubernetes/kubernetes/pull/63920), [@dixudx](https://github.com/dixudx)) +* Added the `kubeadm upgrade diff` command to show how static pod manifests will be changed by an upgrade. This command shows the changes that will be made to the static pod manifests before applying them. This is a narrower case than kubeadm upgrade apply --dry-run, which specifically focuses on the static pod manifests. ([#63930](https://github.com/kubernetes/kubernetes/pull/63930), [@liztio](https://github.com/liztio)) +* The `kubeadm config images pull` command can now be used to pull container images used by kubeadm. ([#63833](https://github.com/kubernetes/kubernetes/pull/63833), [@chuckha](https://github.com/chuckha)) +* kubeadm will now deploy CoreDNS by default instead of KubeDNS ([#63509](https://github.com/kubernetes/kubernetes/pull/63509), [@detiber](https://github.com/detiber)) +* Preflight checks for kubeadm no longer validate custom kube-apiserver, kube-controller-manager and kube-scheduler arguments. ([#63673](https://github.com/kubernetes/kubernetes/pull/63673), [@chuckha](https://github.com/chuckha)) +* Added a `kubeadm config images list` command that lists required container images for a kubeadm install. ([#63450](https://github.com/kubernetes/kubernetes/pull/63450), [@chuckha](https://github.com/chukha)) +* You can now use `kubeadm token` specifying `--kubeconfig`. In this case, kubeadm searches the current user home path and the environment variable KUBECONFIG for existing files. If provided, the `--kubeconfig` flag will be honored instead. ([#62850](https://github.com/kubernetes/kubernetes/pull/62850), [@neolit123](https://github.com/neolit123)) +([#64988](https://github.com/kubernetes/kubernetes/pull/64988), [@detiber](https://github.com/detiber)) +* kubeadm now sets peer URLs for the default etcd instance. Previously we left the defaults, which meant the peer URL was unsecured. +* Kubernetes now packages crictl in a cri-tools deb and rpm package. ([#64836](https://github.com/kubernetes/kubernetes/pull/64836), [@chuckha](https://github.com/chuckha)) +* kubeadm now prompts the user for confirmation when resetting a master node. ([#59115](https://github.com/kubernetes/kubernetes/pull/59115), [@alexbrand](https://github.com/alexbrand)) +* kubead now creates kube-proxy with a toleration to run on all nodes, no matter the taint. ([#62390](https://github.com/kubernetes/kubernetes/pull/62390), [@discordianfish](https://github.com/discordianfish)) +* kubeadm now sets the kubelet `--resolv-conf` flag conditionally on init. ([#64665](https://github.com/kubernetes/kubernetes/pull/64665), [@stealthybox](https://github.com/stealthybox)) +* Added ipset and udevadm to the hyperkube base image. ([#61357](https://github.com/kubernetes/kubernetes/pull/61357), [@rphillips](https://github.com/rphillips)) + +### SIG GCP + +* Kubernetes clusters on GCE now have crictl installed. Users can use it to help debug their nodes. See the [crictl documentation](https://github.com/kubernetes-incubator/cri-tools/blob/master/docs/crictl.md) for details. ([#63357](https://github.com/kubernetes/kubernetes/pull/63357), [@Random-Liu](https://github.com/Random-Liu)) +* `cluster/kube-up.sh` now provisions a Kubelet config file for GCE via the metadata server. This file is installed by the corresponding GCE init scripts. ([#62183](https://github.com/kubernetes/kubernetes/pull/62183), [@mtaufen](https://github.com/mtaufen)) +* GCE: Update cloud provider to use TPU v1 API ([#64727](https://github.com/kubernetes/kubernetes/pull/64727), [@yguo0905](https://github.com/yguo0905)) +* GCE: Bump GLBC version to 1.1.1 - fixing an issue of handling multiple certs with identical certificates. ([#62751](https://github.com/kubernetes/kubernetes/pull/62751), [@nicksardo](https://github.com/nicksardo)) + +### SIG Instrumentation + +* Added prometheus cluster monitoring addon to kube-up. ([#62195](https://github.com/kubernetes/kubernetes/pull/62195), [@serathius](https://github.com/serathius)) +* Kubelet now exposes a new endpoint, `/metrics/probes`, which exposes a Prometheus metric containing the liveness and/or readiness probe results for a container. ([#61369](https://github.com/kubernetes/kubernetes/pull/61369), [@rramkumar1](https://github.com/rramkumar1)) + +### SIG Network + +* The internal IP address of the node is now added as additional information for kubectl. ([#57623](https://github.com/kubernetes/kubernetes/pull/57623), [@dixudx](https://github.com/dixudx)) +* NetworkPolicies can now target specific pods in other namespaces by including both a namespaceSelector and a podSelector in the same peer element. ([#60452](https://github.com/kubernetes/kubernetes/pull/60452), [@danwinship](https://github.com/danwinship)) +* CoreDNS deployment configuration now uses the k8s.gcr.io imageRepository. ([#64775](https://github.com/kubernetes/kubernetes/pull/64775), [@rajansandeep](https://giub.com/rajansandeep)) +* kubelet's `--cni-bin-dir` option now accepts multiple comma-separated CNI binary directory paths, which are searched for CNI plugins in the given order. ([#58714](https://github.com/kubernetes/kubernetes/pull/58714), [@dcbw](https://github.com/dcbw)) +* You can now use `--ipvs-exclude-cidrs` to specify a list of CIDR's which the IPVS proxier should not touch when cleaning up IPVS rules. ([#62083](https://github.com/kubernetes/kubernetes/pull/62083), [@rramkumar1](https://github.com/rramkumar1)) +* You can now receive node DNS info with the `--node-ip` flag, which adds `ExternalDNS`, `InternalDNS`, and `ExternalIP` to kubelet's output. ([#63170](https://github.com/kubernetes/kubernetes/pull/63170), [@micahhausler](https://github.com/micahhausler)) +* You can now have services that listen on the same host ports on different interfaces by specifying `--nodeport-addresses`. ([#62003](https://github.com/kubernetes/kubernetes/pull/62003), [@m1093782566](https://github.com/m1093782566)) +* Added port-forward examples for service + +### SIG Node + +* CRI: The container log path has been changed from containername_attempt#.log to containername/attempt#.log ([#62015](https://github.com/kubernetes/kubernetes/pull/62015), [@feiskyer](https://github.com/feiskyer)) +* Introduced the `ContainersReady` condition in Pod status. ([#64646](https://github.com/kubernetes/kubernetes/pull/64646), [@freehan](https://github.com/freehan)) +* Kubelet will now set extended resource capacity to zero after it restarts. If the extended resource is exported by a device plugin, its capacity will change to a valid value after the device plugin re-connects with the Kubelet. If the extended resource is exported by an external component through direct node status capacity patching, the component should repatch the field after kubelet becomes ready again. During the time gap, pods previously assigned with such resources may fail kubelet admission but their controller should create new pods in response to such failures. ([#64784](https://github.com/kubernetes/kubernetes/pull/64784), [@jiayingz](https://github.com/jiayingz)) node +* You can now use a security context with Windows containers +([#64009](https://github.com/kubernetes/kubernetes/pull/64009), [@feiskyer](https://github.com/feiskyer)) +* Added e2e regression tests for kubelet security. ([#64140](https://github.com/kubernetes/kubernetes/pull/64140), [@dixudx](https://github.com/dixudx)) +* The maximum number of images the Kubelet will report in the Node status can now be controlled via the Kubelet's `--node-status-max-images` flag. The default (50) remains the same. ([#64170](https://github.com/kubernetes/kubernetes/pull/64170), [@mtaufen](https://github.com/mtaufen)) +* The Kubelet now exports metrics that report the assigned (`node_config_assigned`), last-known-good (`node_config_last_known_good`), and active (`node_config_active`) config sources, and a metric indicating whether the node is experiencing a config-related error (`node_config_error`). The config source metrics always report the value `1`, and carry the `node_config_name`, `node_config_uid`, `node_config_resource_version`, and `node_config_kubelet_key labels`, which identify the config version. The error metric reports `1` if there is an error, `0` otherwise. ([#57527](https://github.com/kubernetes/kubernetes/pull/57527), [@mtaufen](https://github.com/mtaufen)) +* You now have the ability to quota resources by priority. ([#57963](https://github.com/kubernetes/kubernetes/pull/57963), [@vikaschoudhary16](https://github.com/ikaschoudhary16)) +* The gRPC max message size in the remote container runtime has been increased to 16MB. ([#64672](https://github.com/kubernetes/kubernetes/pull/64672), [@mcluseau](https://github.com/mcluseau)) +* Added a feature gate for the plugin watcher. ([#64605](https://github.com/kubernetes/kubernetes/pull/64605), [@vikaschoudhary16](https://github.com/vikaschoudhary16)) +* The status of dynamic Kubelet config is now reported via Node.Status.Config, rather than the KubeletConfigOk node condition. ([#63314](https://github.com/kubernetes/kubernetes/pull/63314), [@mtaufen](https://github.com/mtaufen)) +* You must now specify `Node.Spec.ConfigSource.ConfigMap.KubeletConfigKey` when using dynamic Kubelet config to tell the Kubelet which key of the `ConfigMap` identifies its config file. ([#59847](https://github.com/kubernetes/kubernetes/pull/59847), [@mtaufen](https://github.com/mtaufen)) +* The dynamic Kubelet config feature will now update the config in the event of a ConfigMap mutation, which reduces the chance for silent config skew. Only name, namespace, and kubeletConfigKey may now be set in `Node.Spec.ConfigSource.ConfigMap`. The least disruptive pattern for config management is still to create a new ConfigMap and incrementally roll out a new `Node.Spec.ConfigSource`. ([#63221](https://github.com/kubernetes/kubernetes/pull/63221), [@mtaufen](https://github.com/mtaufen)) +* Change seccomp annotation from "docker/default" to "runtime/default" ([#62662](https://github.com/kubernetes/kubernetes/pull/62662), [@wangzhen127](https://github.com/wangzhen127)) +* The node authorizer now automatically sets up rules for `Node.Spec.ConfigSource` when the DynamicKubeletConfig feature gate is enabled. ([#60100](https://github.com/kubernetes/kubernetes/pull/60100), [@mtaufen](https://github.com/mtaufen)) +* CRI now defines mounting behavior. If the host path doesn't exist, the runtime should return an error. If the host path is a symlink, the runtime should follow the symlink and mount the real destination to the container. ([#61460](https://github.com/kubernetes/kubernetes/pull/61460), [@feiskyer](https://github.com/feiskyer)) + +### SIG OpenStack + +* Provide a meaningful error message in the openstack cloud provider when no valid IP address can be found for a node, rather than just the first address of the node, which leads to a load balancer error if that address is a hostname or DNS name instead of an IP address. ([#64318](https://github.com/kubernetes/kubernetes/pull/64318), [@gonzolino](https://github.com/gonzolino)) +* Restored the pre-1.10 behavior of the openstack cloud provider, which uses the instance name as the Kubernetes Node name. This requires instances be named with RFC-1123 compatible names. ([#63903](https://github.com/kubernetes/kubernetes/pull/63903), [@liggitt](https://github.com/liggitt)) +* Kubernetes will try to read the openstack auth config from the client config and fall back to read from the environment variables if the auth config is not available. ([#60200](https://github.com/kubernetes/kubernetes/pull/60200), [@dixudx](https://github.com/dixudx)) + +### SIG Scheduling + +* Schedule DaemonSet Pods in scheduler, rather than the Daemonset controller. +([#63223](https://github.com/kubernetes/kubernetes/pull/63223), [@k82cn](https://github.com/k82cn)) +* Added `MatchFields` to `NodeSelectorTerm`; in 1.11, it only supports `metadata.name`. ([#62002](https://github.com/kubernetes/kubernetes/pull/62002), [@k82cn](https://github.com/k82cn)) +* kube-scheduler now has the `--write-config-to` flag so that Scheduler canwritets default configuration to a file. +([#62515](https://github.com/kubernetes/kubernetes/pull/62515), [@resouer](https://github.com/resouer)) +* Performance of the affinity/anti-affinity predicate for the default scheduler has been significantly improved. ([#62211](https://github.com/kubernetes/kubernetes/pull/62211), [@bsalamat](https://github.com/bsalamat)) +* The 'scheduling_latency_seconds' metric into has been split into finer steps (predicate, priority, preemption). ([#65306](https://github.com/kubernetes/kubernetes/pull/65306), [@shyamjvs](https://github.com/shyamjvs)) +* Scheduler now has a summary-type metric, 'scheduling_latency_seconds'. ([#64838](https://github.com/kubernetes/kubernetes/pull/64838), [@krzysied](https://github.com/krzysied)) +* `nodeSelector.matchFields` (node's `metadata.node`) is now supported in scheduler. ([#62453](https://github.com/kubernetes/kubernetes/pull/62453), [@k82cn](https://github.com/k82cn)) +* Added a parametrizable priority function mapping requested/capacity ratio to priority. This function is disabled by default and can be enabled via the scheduler policy config file. +([#63929](https://github.com/kubernetes/kubernetes/pull/63929), [@losipiuk](https://github.com/losipiuk)) +* System critical priority classes are now automatically added at cluster boostrapping. ([#60519](https://github.com/kubernetes/kubernetes/pull/60519), [@bsalamat](https://github.com/bsalamat)) + +### SIG Storage + +* AWS EBS, Azure Disk, GCE PD and Ceph RBD volume plugins now support dynamic provisioning of raw block volumes. ([#64447](https://github.com/kubernetes/kubernetes/pull/64447), [@jsafrane](https://github.com/jsafrane)) +* gitRepo volumes in pods no longer require git 1.8.5 or newer; older git versions are now supported. ([#62394](https://github.com/kubernetes/kubernetes/pull/62394), [@jsafrane](https://github.com/jsafrane)) +* Added support for resizing Portworx volumes. ([#62308](https://github.com/kubernetes/kubernetes/pull/62308), [@harsh-px](https://github.com/harsh-px)) +* Added block volume support to Cinder volume plugin. ([#64879](https://github.com/kubernetes/kubernetes/pull/64879), [@bertinatto](https://github.com/bertinatto)) +* Provided API support for external CSI storage drivers to support block volumes. ([#64723](https://github.com/kubernetes/kubernetes/pull/64723), [@vladimirvivien](https://github.com/vladimirvivien)) +* Volume topology aware dynamic provisioning for external provisioners is now supported. ([#63193](https://github.com/kubernetes/kubernetes/pull/63193), [@lichuqiang](https://github.com/lichuqiang)) +* Added a volume projection that is able to project service account tokens. ([#62005](https://github.com/kubernetes/kubernetes/pull/62005), [@mikedanese](https://github.com/mikedanese)) +* PodSecurityPolicy now supports restricting hostPath volume mounts to be readOnly and under specific path prefixes ([#58647](https://github.com/kubernetes/kubernetes/pull/58647), [@jhorwit2](https://github.com/jhorwit2)) +* Added StorageClass API to restrict topologies of dynamically provisioned volumes. ([#63233](https://github.com/kubernetes/kubernetes/pull/63233), [@lichuqiang](https://github.com/lichuqiang)) +* Added Alpha support for dynamic volume limits based on node type ([#64154](https://github.com/kubernetes/kubernetes/pull/64154), [@gnufied](https://github.com/gnufied)) +* AWS EBS volumes can be now used as ReadOnly in pods. ([#64403](https://github.com/kubernetes/kubernetes/pull/64403), [@jsafrane](https://github.com/jsafrane)) +* Basic plumbing for volume topology aware dynamic provisionin has been implemented. ([#63232](https://github.com/kubernetes/kubernetes/pull/63232), [@lichuqiang](https://github.com/lichuqiang)) +* Changed ext3/ext4 volume creation to not reserve any portion of the volume for the root user. When creating ext3/ext4 volume, mkfs defaults to reserving 5% of the volume for the super-user (root). This patch changes the mkfs to pass -m0 to disable this setting. +([#64102](https://github.com/kubernetes/kubernetes/pull/64102), [@atombender](https://github.com/atombender)) +* Added support for NFS relations on kubernetes-worker charm. ([#63817](https://github.com/kubernetes/kubernetes/pull/63817), [@hyperbolic2346](https://github.com/hyperbolic2346)) +* Implemented kubelet side online file system resizing ([#62460](https://github.com/kubernetes/kubernetes/pull/62460), [@mlmhl](https://github.com/mlmhl)) +* Generated subpath name from Downward API env ([#49388](https://github.com/kubernetes/kubernetes/pull/49388), [@kevtaylor](https://github.com/kevtaylor)) + +### SIG vSphere + +* Added a mechanism in vSphere Cloud Provider to get credentials from Kubernetes secrets, rather than the plain text `vsphere.conf` file.([#63902](https://github.com/kubernetes/kubernetes/pull/63902), [@abrarshivani](https://github.com/abrarshivani)) +* vSphere Cloud Provider: added SAML token authentication support ([#63824](https://github.com/kubernetes/kubernetes/pull/63824), [@dougm](https://github.com/dougm)) + +### SIG Windows + +* Added log and fs stats for Windows containers. ([#62266](https://github.com/kubernetes/kubernetes/pull/62266), [@feiskyer](https://github.com/feiskyer)) +* Added security contexts for Windows containers. [#64009](https://github.com/kubernetes/kubernetes/pull/64009), ([@feiskyer](https://github.com/feiskyer)) +* Added local persistent volumes for Windows containers. ([#62012](https://github.com/kubernetes/kubernetes/pull/62012), [@andyzhangx](https://github.com/andyzhangx)) and fstype for Azure disk ([#61267](https://github.com/kubernetes/kubernetes/pull/61267), [@andyzhangx](https://github.com/andyzhangx)) +* Improvements in Windows Server version 1803 also bring new storage functionality to Kubernetes v1.11, including: + * Volume mounts for ConfigMap and Secret + * Flexvolume plugins for SMB and iSCSI storage are also available out-of-tree at [Microsoft/K8s-Storage-Plugins](https://github.com/Microsoft/K8s-Storage-Plugins) +* Setup dns servers and search domains for Windows Pods in dockershim. Docker EE version >= 17.10.0 is required for propagating DNS to containers. ([#63905](https://github.com/kubernetes/kubernetes/pull/63905), [@feiskyer](https://github.com/feiskyer)) + +### Additional changes + +* Extended the Stackdriver Metadata Agent by adding a new Deployment for ingesting unscheduled pods and services. ([#62043](https://github.com/kubernetes/kubernetes/pull/62043), [@supriyagarg](https://github.com/supriyagarg)) +* Added all kinds of resource objects' statuses in HPA description. ([#59609](https://github.com/kubernetes/kubernetes/pull/59609), [@zhangxiaoyu-zidif](https://github.com/zhangxiaoyu-zidif)) +* Implemented preemption for extender with a verb and new interface ([#58717](https://github.com/kubernetes/kubernetes/pull/58717), [@resouer](https://github.com/resouer)) +* Updated nvidia-gpu-device-plugin DaemonSet config to use RollingUpdate updateStrategy instead of OnDelete. ([#64296](https://github.com/kubernetes/kubernetes/pull/64296), [@mindprince](https://github.com/mindprince)) +* increased grpc client default response size. ([#63977](https://github.com/kubernetes/kubernetes/pull/677), [@runcom](https://github.com/runcom)) +* Applied pod name and namespace labels to pod cgroup in cAdvisor metrics ([#63406](https://github.com/kubernetes/kubernetes/pull/63406), [@derekwaynecarr](https://github.com/derekwaynecarr)) +* [fluentd-gcp addon] Use the logging agent's node name as the metadata agent URL. ([#63353](https://github.com/kubernetes/kubernetes/pull/63353), [@bmoyles0117](https://github.com/bmoyles0117)) +* The new default value for the --allow-privileged parameter of the Kubernetes-worker charm has been set to true based on changes which went into the Kubernetes 1.10 release. Before this change the default value was set to false. If you're installing Canonical Kubernetes you should expect this value to now be true by default and you should now look to use PSP (pod security policies). ([#64104](https://github.com/kubernetes/kubernetes/pull/64104), [@CalvinHartwell](https://github.com/CalvinHartwell)) -* Fixes an issue where the resourceVersion of an object in a DELETE watch event was not the resourceVersion of the delete itself, but of the last update to the object. This could disrupt the ability of clients clients to re-establish watches properly. ([#58547](https://github.com/kubernetes/kubernetes/pull/58547), [@liggitt](https://github.com/liggitt)) +## External Dependencies -* kube-apiserver: requests to endpoints handled by unavailable extension API servers (as indicated by an `Available` condition of `false` in the registered APIService) now return `503` errors instead of `404` errors. ([#58070](https://github.com/kubernetes/kubernetes/pull/58070), [@weekface](https://github.com/weekface)) - -* Custom resources can now be submitted to and received from the API server in application/yaml format, consistent with other API resources. ([#58260](https://github.com/kubernetes/kubernetes/pull/58260), [@liggitt](https://github.com/liggitt)) - -### Network - -* Fixed kube-proxy to work correctly with iptables 1.6.2 and later. ([#60978](https://github.com/kubernetes/kubernetes/pull/60978), [@danwinship](https://github.com/danwinship)) - -* Makes the kube-dns addon optional so that users can deploy their own DNS solution. ([#57113](https://github.com/kubernetes/kubernetes/pull/57113), [@wwwtyro](https://github.com/wwwtyro)) - -* `kubectl port-forward` now supports specifying a service to port forward to, as in `kubectl port-forward svc/myservice 8443:443`. Additional support has also been added for looking up targetPort for a service, as well as enabling using svc/name to select a pod. ([#59809](https://github.com/kubernetes/kubernetes/pull/59809), [@phsiao](https://github.com/phsiao)) -* [Make NodePort IP addres](https://github.com/kubernetes/website/pull/7631/files)[ses configurabl](https://github.com/kubernetes/website/pull/7631/files)[e](https://github.com/kubernetes/website/pull/7631/files). ([#58052](https://github.com/kubernetes/kubernetes/pull/58052), [@m1093782566](https://github.com/m1093782566)) - -* Fixed the issue in kube-proxy iptables/ipvs mode to properly handle incorrect IP version. ([#56880](https://github.com/kubernetes/kubernetes/pull/56880), [@MrHohn](https://github.com/MrHohn)) -* Kubeadm: CoreDNS supports migration of the kube-dns configuration to CoreDNS configuration when upgrading the service discovery from kube-dns to CoreDNS as part of Beta. ([#58828](https://github.com/kubernetes/kubernetes/pull/58828), [@rajansandeep](https://github.com/rajansandeep)) - -* Adds BETA support for `DNSConfig` field in PodSpec and `DNSPolicy=None`, so configurable pod resolve.conf is now enabled by default. ([#59771](https://github.com/kubernetes/kubernetes/pull/59771), [@MrHohn](https://github.com/MrHohn)) -* Removed some redundant rules created by the iptables proxier to improve performance on systems with very many services. ([#57461](https://github.com/kubernetes/kubernetes/pull/57461), [@danwinship](https://github.com/danwinship)) - -* Fix an issue where port forwarding doesn't forward local TCP6 ports to the pod ([#57457](https://github.com/kubernetes/kubernetes/pull/57457), [@vfreex](https://github.com/vfreex)) -* Correctly handle transient connection reset errors on GET requests from client library. ([#58520](https://github.com/kubernetes/kubernetes/pull/58520), [@porridge](https://github.com/porridge)) - -* GCE: Allows existing internal load balancers to continue using a subnetwork that may have been wrongfully chosen due to a bug choosing subnetworks on automatic networks. ([#57861](https://github.com/kubernetes/kubernetes/pull/57861), [@nicksardo](https://github.com/nicksardo)) -### Azure - -* Set node external IP for azure node when disabling UseInstanceMetadata. ([#60959](https://github.com/kubernetes/kubernetes/pull/60959), [@feiskyer](https://github.com/feiskyer)) - -* Changed default azure file/dir mode to 0755. ([#56551](https://github.com/kubernetes/kubernetes/pull/56551), [@andyzhangx](https://github.com/andyzhangx)) - -* Fixed azure file plugin failure issue on Windows after node restart. ([#60625](https://github.com/kubernetes/kubernetes/pull/60625), [@andyzhangx](https://github.com/andyzhangx))([#60623](https://github.com/kubernetes/kubernetes/pull/60623), [@feiskyer](https://github.com/feiskyer)) - -* Fixed race condition issue when detaching azure disk, preventing `Multi-Attach error`s when scheduling one pod from one node to another. ([#60183](https://github.com/kubernetes/kubernetes/pull/60183), [@andyzhangx](https://github.com/andyzhangx)) - -* Add AzureDisk support for vmss nodes. ([#59716](https://github.com/kubernetes/kubernetes/pull/59716), [@feiskyer](https://github.com/feiskyer)) - -* Map correct vmset name for Azure internal load balancers. ([#59747](https://github.com/kubernetes/kubernetes/pull/59747), [@feiskyer](https://github.com/feiskyer)) - -* Node's providerID will now follow the Azure resource ID format (`azure:///subscriptions//resourceGroups//providers/Microsoft.Compute/virtualMachines/` rather than `azure://d84a1c30-0c9f-11e8-8a34-000d3a919531`) when useInstanceMetadata is enabled ([#59539](https://github.com/kubernetes/kubernetes/pull/59539), [@feiskyer](https://github.com/feiskyer)) - -* Azure public IP is now correctly removed after a service is deleted. ([#59340](https://github.com/kubernetes/kubernetes/pull/59340), [@feiskyer](https://github.com/feiskyer)) - -* Added PV size grow feature for azure filesystems. ([#57017](https://github.com/kubernetes/kubernetes/pull/57017), [@andyzhangx](https://github.com/andyzhangx)) - -* Ensured IP is set for Azure internal load balancer. ([#59083](https://github.com/kubernetes/kubernetes/pull/59083), [@feiskyer](https://github.com/feiskyer)) - -* Set fsGroup by securityContext.fsGroup in azure file. However,f user both sets gid=xxx in mountOptions in azure storage class and securityContext.fsGroup, gid=xxx setting in mountOptions takes precedence. ([#58316](https://github.com/kubernetes/kubernetes/pull/58316), [@andyzhangx](https://github.com/andyzhangx)) - -* If an Azure disk is not found, K8s will immediately detach it. ([#58345](https://github.com/kubernetes/kubernetes/pull/58345), [@rootfs](https://github.com/rootfs)) -* Instrumented the Azure cloud provider for Prometheus monitoring. ([#58204](https://github.com/kubernetes/kubernetes/pull/58204), [@cosmincojocar](https://github.com/cosmincojocar)) - -* Fixed device name change issues for azure disk. ([#57953](https://github.com/kubernetes/kubernetes/pull/57953), [@andyzhangx](https://github.com/andyzhangx)) ([#57549](https://github.com/kubernetes/kubernetes/pull/57549), [@andyzhangx](https://github.com/andyzhangx)) - -* Support multiple scale sets in Azure cloud provider. ([#57543](https://github.com/kubernetes/kubernetes/pull/57543), [@feiskyer](https://github.com/feiskyer)) - -* Support LoadBalancer for Azure Virtual Machine Scale Sets ([#57131](https://github.com/kubernetes/kubernetes/pull/57131), [@feiskyer](https://github.com/feiskyer)) - -* Fixed incorrect error info when creating an azure file PVC failed. ([#56550](https://github.com/kubernetes/kubernetes/pull/56550), [@andyzhangx](https://github.com/andyzhangx)) - -* Added mount options support for azure disk. For example: - -``` -kind: StorageClass -apiVersion: storage.k8s.io/v1 -metadata: - name: hdd -provisioner: kubernetes.io/azure-disk -mountOptions: - - barrier=1 - - acl -parameters: - skuname: Standard_LRS - kind: Managed - fstype: ext3 -``` - -([#56147](https://github.com/kubernetes/kubernetes/pull/56147), [@andyzhangx](https://github.com/andyzhangx)) - -### Scheduling - -* Fixed a bug the in scheduler cache by using Pod UID as the cache key instead of namespace/name ([#61069](https://github.com/kubernetes/kubernetes/pull/61069), [@anfernee](https://github.com/anfernee)) - -* When `TaintNodesByCondition` is enabled, added `node.kubernetes.io/unschedulable:NoSchedule` ([#61161](https://github.com/kubernetes/kubernetes/pull/61161), [@k82cn](https://github.com/k82cn)) - -* kube-scheduler: Support extender managed extended resources in kube-scheduler ([#60332](https://github.com/kubernetes/kubernetes/pull/60332), [@yguo0905](https://github.com/yguo0905)) - -* Updated priority of mirror pod according to PriorityClassName. ([#58485](https://github.com/kubernetes/kubernetes/pull/58485), [@k82cn](https://github.com/k82cn)) - -* kube-scheduler: restores default leader election behavior. Setting the `--leader-elect` command line parameter to `true` ([#60524](https://github.com/kubernetes/kubernetes/pull/60524), [@dims](https://github.com/dims)) - -* All pods with priorityClassName system-node-critical and system-cluster-critical will be critical pods while preserving backwards compatibility. ([#58835](https://github.com/kubernetes/kubernetes/pull/58835), [@ravisantoshgudimetla](https://github.com/ravisantoshgudimetla)) -* Priority admission controller picks a global default with the lowest priority value if more than one such default PriorityClass exists. ([#59991](https://github.com/kubernetes/kubernetes/pull/59991), [@bsalamat](https://github.com/bsalamat)) -* Disallow PriorityClass names with 'system-' prefix for user defined priority classes. ([#59382](https://github.com/kubernetes/kubernetes/pull/59382), [@bsalamat](https://github.com/bsalamat)) -* kube-scheduler: Use default predicates/prioritizers if they are unspecified in the policy config. ([#59363](https://github.com/kubernetes/kubernetes/pull/59363), [@yguo0905](https://github.com/yguo0905)) - -* Scheduler should be able to read from config file if configmap is not present. ([#59386](https://github.com/kubernetes/kubernetes/pull/59386), [@ravisantoshgudimetla](https://github.com/ravisantoshgudimetla)) -* Add apiserver metric for current inflight-request usage. ([#58342](https://github.com/kubernetes/kubernetes/pull/58342), [@gmarek](https://github.com/gmarek)) - -* Stability: Make Pod delete event handling of scheduler more robust. ([#58712](https://github.com/kubernetes/kubernetes/pull/58712), [@bsalamat](https://github.com/bsalamat))* Allow scheduler set AlwaysCheckAllPredicates, short circuit all predicates if one predicate fails can greatly improve the scheduling performance. ([#56926](https://github.com/kubernetes/kubernetes/pull/56926), [@wgliang](https://github.com/wgliang)) - -* GCE: support passing kube-scheduler policy config via SCHEDULER_POLICY_CONFIG. This allows us to specify a customized scheduler policy configuration. ([#57425](https://github.com/kubernetes/kubernetes/pull/57425), [@yguo0905](https://github.com/yguo0905)) - -* Returns an error for non overcommitable resources if they don't have limit field set in container spec to prevent users from creating invalid configurations. ([#57170](https://github.com/kubernetes/kubernetes/pull/57170), [@jiayingz](https://github.com/jiayingz)) - -* GCE: Fixed ILB creation on automatic networks with manually created subnetworks. ([#57351](https://github.com/kubernetes/kubernetes/pull/57351), [@nicksardo](https://github.com/nicksardo)) - -* Multiple Performance Improvements to the MatchInterPodAffinity predicate ([#57476](https://github.com/kubernetes/kubernetes/pull/57476), [@misterikkit](https://github.com/misterikkit))([#57477](https://github.com/kubernetes/kubernetes/pull/57477), [@misterikkit](https://github.com/misterikkit)) - -* The calico-node addon tolerates all NoExecute and NoSchedule taints by default. So Calico components can even be scheduled on tainted nodes. ([#57122](https://github.com/kubernetes/kubernetes/pull/57122), [@caseydavenport](https://github.com/caseydavenport)) -* The scheduler skips pods that use a PVC that either does not exist or is being deleted. ([#55957](https://github.com/kubernetes/kubernetes/pull/55957), [@jsafrane](https://github.com/jsafrane)) - -### Other changes - -* Updated dashboard version to v1.8.3, which keeps auto-generated certs in memory. ([#57326](https://github.com/kubernetes/kubernetes/pull/57326), [@floreks](https://github.com/floreks)) - -* fluentd-gcp addon: Fixed bug with reporting metrics in event-exporter. ([#60126](https://github.com/kubernetes/kubernetes/pull/60126), [@serathius](https://github.com/serathius)) - -* Avoid hook errors when effecting label changes on kubernetes-worker charm. ([#59803](https://github.com/kubernetes/kubernetes/pull/59803), [@wwwtyro](https://github.com/wwwtyro)) - -* Fixed charm issue where docker login would run prior to daemon options being set. ([#59396](https://github.com/kubernetes/kubernetes/pull/59396), [@kwmonroe](https://github.com/kwmonroe)) - -* Implementers of the cloud provider interface will note the addition of a context to this interface. Trivial code modification will be necessary for a cloud provider to continue to compile. ([#59287](https://github.com/kubernetes/kubernetes/pull/59287), [@cheftako](https://github.com/cheftako)) - -* Added configurable etcd quota backend bytes in GCE. ([#59259](https://github.com/kubernetes/kubernetes/pull/59259), [@wojtek-t](https://github.com/wojtek-t)) - -* GCP: allow a master to not include a metadata concealment firewall rule (if it's not running the metadata proxy). ([#58104](https://github.com/kubernetes/kubernetes/pull/58104), [@ihmccreery](https://github.com/ihmccreery)) - -* Fixed issue with kubernetes-worker option allow-privileged not properly handling the value True with a capital T. ([#59116](https://github.com/kubernetes/kubernetes/pull/59116), [@hyperbolic2346](https://github.com/hyperbolic2346)) - -* Controller-manager --service-sync-period flag has been removed. (It was never used in the code and should have no user impact.) ([#59359](https://github.com/kubernetes/kubernetes/pull/59359), [@khenidak](https://github.com/khenidak)) - -* [fluentd-gcp addon] Switch to the image provided by Stackdriver. The Stackdriver Logging Agent container image uses fluentd v0.14.25. ([#59128](https://github.com/kubernetes/kubernetes/pull/59128), [@bmoyles0117](https://github.com/bmoyles0117)) - -## Non-user-facing Changes - -* CRI now uses moutpoint as image filesystem identifier instead of UUID. ([#59475](https://github.com/kubernetes/kubernetes/pull/59475), [@Random-Liu](https://github.com/Random-Liu)) - -* GCE: support Cloud TPU API in cloud provider ([#58029](https://github.com/kubernetes/kubernetes/pull/58029), [@yguo0905](https://github.com/yguo0905)) - -* kubelet now notifies systemd that it has finished starting, if systemd is available and running. ([#60654](https://github.com/kubernetes/kubernetes/pull/60654), [@dcbw](https://github.com/dcbw)) - -* Do not count failed pods as unready in HPA controller ([#60648](https://github.com/kubernetes/kubernetes/pull/60648), [@bskiba](https://github.com/bskiba)) - -* fixed foreground deletion of podtemplates ([#60683](https://github.com/kubernetes/kubernetes/pull/60683), [@nilebox](https://github.com/nilebox)) - -* Conformance tests are added for the DaemonSet kinds in the apps/v1 group version. Deprecated versions of DaemonSet will not be tested for conformance, and conformance is only applicable to release 1.10 and later. ([#60456](https://github.com/kubernetes/kubernetes/pull/60456), [@kow3ns](https://github.com/kow3ns)) - -* Log audit backend can now be configured to perform batching before writing events to disk. ([#60237](https://github.com/kubernetes/kubernetes/pull/60237), [@crassirostris](https://github.com/crassirostris)) - -* New conformance tests added for the Garbage Collector ([#60116](https://github.com/kubernetes/kubernetes/pull/60116), [@jennybuckley](https://github.com/jennybuckley)) - -* Fixes a bug where character devices are not recongized by the kubelet ([#60440](https://github.com/kubernetes/kubernetes/pull/60440), [@andrewsykim](https://github.com/andrewsykim)) - -* StatefulSet in apps/v1 is now included in Conformance Tests. ([#60336](https://github.com/kubernetes/kubernetes/pull/60336), [@enisoc](https://github.com/enisoc)) - -* dockertools: disable memory swap on Linux. ([#59404](https://github.com/kubernetes/kubernetes/pull/59404), [@ohmystack](https://github.com/ohmystack)) - -* Increase timeout of integration tests ([#60458](https://github.com/kubernetes/kubernetes/pull/60458), [@jennybuckley](https://github.com/jennybuckley)) - -* force node name lowercase on static pod name generating ([#59849](https://github.com/kubernetes/kubernetes/pull/59849), [@yue9944882](https://github.com/yue9944882) - -* fix device name change issue for azure disk ([#60346](https://github.com/kubernetes/kubernetes/pull/60346), [@andyzhangx](https://github.com/andyzhangx)) - -* Additional changes to iptables kube-proxy backend to improve performance on clusters with very large numbers of services. ([#60306](https://github.com/kubernetes/kubernetes/pull/60306), [@danwinship](https://github.com/danwinship)) - -* add spelling checking script ([#59463](https://github.com/kubernetes/kubernetes/pull/59463), [@dixudx](https://github.com/dixudx)) - -* Use consts as predicate name in handlers ([#59952](https://github.com/kubernetes/kubernetes/pull/59952), [@resouer](https://github.com/resouer)) - -* Fix instanceID for vmss nodes. ([#59857](https://github.com/kubernetes/kubernetes/pull/59857), [@feiskyer](https://github.com/feiskyer)) - -* Increase allowed lag for ssh key sync loop in tunneler to allow for one failure ([#60068](https://github.com/kubernetes/kubernetes/pull/60068), [@wojtek-t](https://github.com/wojtek-t)) - -* Set an upper bound (5 minutes) on how long the Kubelet will wait before exiting when the client cert from disk is missing or invalid. This prevents the Kubelet from waiting forever without attempting to bootstrap a new client credentials. ([#59316](https://github.com/kubernetes/kubernetes/pull/59316), [@smarterclayton](https://github.com/smarterclayton)) - -* Add ipset binary for IPVS to hyperkube docker image ([#57648](https://github.com/kubernetes/kubernetes/pull/57648), [@Fsero](https://github.com/Fsero)) - -* Making sure CSI E2E test runs on a local cluster ([#60017](https://github.com/kubernetes/kubernetes/pull/60017), [@sbezverk](https://github.com/sbezverk)) - -* Fix kubelet PVC stale metrics ([#59170](https://github.com/kubernetes/kubernetes/pull/59170), [@cofyc](https://github.com/cofyc)) - -* Separate current ARM rate limiter into read/write ([#59830](https://github.com/kubernetes/kubernetes/pull/59830), [@khenidak](https://github.com/khenidak)) - -* Improve control over how ARM rate limiter is used within Azure cloud provider, add generic cache for Azure VM/LB/NSG/RouteTable ([#59520](https://github.com/kubernetes/kubernetes/pull/59520), [@feiskyer](https://github.com/feiskyer)) - -* fix typo ([#59619](https://github.com/kubernetes/kubernetes/pull/59619), [@jianliao82](https://github.com/jianliao82)) - -* DaemonSet, Deployment, ReplicaSet, and StatefulSet objects are now persisted in etcd in apps/v1 format ([#58854](https://github.com/kubernetes/kubernetes/pull/58854), [@liggitt](https://github.com/liggitt)) - -* YAMLDecoder Read now tracks rest of buffer on io.ErrShortBuffer ([#58817](https://github.com/kubernetes/kubernetes/pull/58817), [@karlhungus](https://github.com/karlhungus)) - -* Prevent kubelet from getting wedged if initialization of modules returns an error. ([#59020](https://github.com/kubernetes/kubernetes/pull/59020), [@brendandburns](https://github.com/brendandburns)) - -* Fixed a race condition inside kubernetes-worker that would result in a temporary error situation. ([#59005](https://github.com/kubernetes/kubernetes/pull/59005), [@hyperbolic2346](https://github.com/hyperbolic2346)) - -* Fix regression in the CRI: do not add a default hostname on short image names ([#58955](https://github.com/kubernetes/kubernetes/pull/58955), [@runcom](https://github.com/runcom)) - -* use containing API group when resolving shortname from discovery ([#58741](https://github.com/kubernetes/kubernetes/pull/58741), [@dixudx](https://github.com/dixudx)) - -* remove spaces from kubectl describe hpa ([#56331](https://github.com/kubernetes/kubernetes/pull/56331), [@shiywang](https://github.com/shiywang)) - -* fluentd-es addon: multiline stacktraces are now grouped into one entry automatically ([#58063](https://github.com/kubernetes/kubernetes/pull/58063), [@monotek](https://github.com/monotek)) - -* Default scheduler code is moved out of the plugin directory. ([#57852](https://github.com/kubernetes/kubernetes/pull/57852), [@misterikkit](https://github.com/misterikkit)) - -* CDK nginx ingress is now handled via a daemon set. ([#57530](https://github.com/kubernetes/kubernetes/pull/57530), [@hyperbolic2346](https://github.com/hyperbolic2346)) - -* Move local PV negative scheduling tests to integration ([#57570](https://github.com/kubernetes/kubernetes/pull/57570), [@sbezverk](https://github.com/sbezverk)) - -* Only create Privileged PSP binding during e2e tests if RBAC is enabled. ([#56382](https://github.com/kubernetes/kubernetes/pull/56382), [@mikkeloscar](https://github.com/mikkeloscar)) - -* ignore nonexistent ns net file error when deleting container network in case a retry ([#57697](https://github.com/kubernetes/kubernetes/pull/57697), [@dixudx](https://github.com/dixudx)) - -* Use old dns-ip mechanism with older cdk-addons. ([#57403](https://github.com/kubernetes/kubernetes/pull/57403), [@wwwtyro](https://github.com/wwwtyro)) - -* Retry 'connection refused' errors when setting up clusters on GCE. ([#57394](https://github.com/kubernetes/kubernetes/pull/57394), [@mborsz](https://github.com/mborsz)) - -* YAMLDecoder Read now returns the number of bytes read ([#57000](https://github.com/kubernetes/kubernetes/pull/57000), [@sel](https://github.com/sel)) - -* Drop hacks used for Mesos integration that was already removed from main kubernetes repository ([#56754](https://github.com/kubernetes/kubernetes/pull/56754), [@dims](https://github.com/dims)) - -* Compare correct file names for volume detach operation ([#57053](https://github.com/kubernetes/kubernetes/pull/57053), [@prashima](https://github.com/prashima)) - -* Fixed documentation typo in IPVS README. ([#56578](https://github.com/kubernetes/kubernetes/pull/56578), [@shift](https://github.com/shift)) - -* The ConfigOK node condition has been renamed to KubeletConfigOk. ([#59905](https://github.com/kubernetes/kubernetes/pull/59905), [@mtaufen](https://github.com/mtaufen)) - -* Adding pkg/kubelet/apis/deviceplugin/v1beta1 API. ([#59588](https://github.com/kubernetes/kubernetes/pull/59588), [@jiayingz](https://github.com/jiayingz)) - -* Fixes volume predicate handler for equiv class ([#59335](https://github.com/kubernetes/kubernetes/pull/59335), [@resouer](https://github.com/resouer)) - -* Bugfix: vSphere Cloud Provider (VCP) does not need any special service account anymore. ([#59440](https://github.com/kubernetes/kubernetes/pull/59440), [@rohitjogvmw](https://github.com/rohitjogvmw)) - -* fix the error prone account creation method of blob disk ([#59739](https://github.com/kubernetes/kubernetes/pull/59739), [@andyzhangx](https://github.com/andyzhangx)) - -* Updated kubernetes-worker to request new security tokens when the aws cloud provider changes the registered node name. ([#59730](https://github.com/kubernetes/kubernetes/pull/59730), [@hyperbolic2346](https://github.com/hyperbolic2346)) - -* Pod priority can be specified ins PodSpec even when the feature is disabled, but it will be effective only when the feature is enabled. ([#59291](https://github.com/kubernetes/kubernetes/pull/59291), [@bsalamat](https://github.com/bsalamat))* Add generic cache for Azure VMSS ([#59652](https://github.com/kubernetes/kubernetes/pull/59652), [@feiskyer](https://github.com/feiskyer)) - -* fix the create azure file pvc failure if there is no storage account in current resource group ([#56557](https://github.com/kubernetes/kubernetes/pull/56557), [@andyzhangx](https://github.com/andyzhangx)) - -* Implement envelope service with gRPC, so that KMS providers can be pulled out from API server. ([#55684](https://github.com/kubernetes/kubernetes/pull/55684), [@wu-qiang](https://github.com/wu-qiang)) - -* Enable golint for `pkg/scheduler` and fix the golint errors in it. ([#58437](https://github.com/kubernetes/kubernetes/pull/58437), [@tossmilestone](https://github.com/tossmilestone)) - -* Ensure euqiv hash calculation is per schedule ([#59245](https://github.com/kubernetes/kubernetes/pull/59245), [@resouer](https://github.com/resouer)) - -* Upped the timeout for apiserver communication in the juju kubernetes-worker charm. ([#59219](https://github.com/kubernetes/kubernetes/pull/59219), [@hyperbolic2346](https://github.com/hyperbolic2346)) - -* kubeadm init: skip checking cri socket in preflight checks ([#58802](https://github.com/kubernetes/kubernetes/pull/58802), [@dixudx](https://github.com/dixudx)) - -* Configurable etcd compaction frequency in GCE ([#59106](https://github.com/kubernetes/kubernetes/pull/59106), [@wojtek-t](https://github.com/wojtek-t)) - -* Fixed a bug which caused the apiserver reboot failure in the presence of malfunctioning webhooks. ([#59073](https://github.com/kubernetes/kubernetes/pull/59073), [@caesarxuchao](https://github.com/caesarxuchao)) - -* GCE: Apiserver uses `InternalIP` as the most preferred kubelet address type by default. ([#59019](https://github.com/kubernetes/kubernetes/pull/59019), [@MrHohn](https://github.com/MrHohn)) - -* CRI: Add a call to reopen log file for a container. ([#58899](https://github.com/kubernetes/kubernetes/pull/58899), [@yujuhong](https://github.com/yujuhong)) - -* The alpha KubeletConfigFile feature gate has been removed, because it was redundant with the Kubelet's --config flag. It is no longer necessary to set this gate to use the flag. The --config flag is still considered alpha. ([#58978](https://github.com/kubernetes/kubernetes/pull/58978), [@mtaufen](https://github.com/mtaufen)) - -* Fixing extra_sans option on master and load balancer. ([#58843](https://github.com/kubernetes/kubernetes/pull/58843), [@hyperbolic2346](https://github.com/hyperbolic2346)) - -* Ensure config has been created before attempting to launch ingress. ([#58756](https://github.com/kubernetes/kubernetes/pull/58756), [@wwwtyro](https://github.com/wwwtyro)) - -* Support metrics API in `kubectl top` commands. ([#56206](https://github.com/kubernetes/kubernetes/pull/56206), [@brancz](https://github.com/brancz)) - -* Bump GCE metadata proxy to v0.1.9 to pick up security fixes. ([#58221](https://github.com/kubernetes/kubernetes/pull/58221), [@ihmccreery](https://github.com/ihmccreery)) - -* "ExternalTrafficLocalOnly" has been removed from feature gate. It has been a GA feature since v1.7. ([#56948](https://github.com/kubernetes/kubernetes/pull/56948), [@MrHohn](https://github.com/MrHohn)) -* feat(fakeclient): push event on watched channel on add/update/delete ([#57504](https://github.com/kubernetes/kubernetes/pull/57504), [@yue9944882](https://github.com/yue9944882)) - -* Fixes a possible deadlock preventing quota from being recalculated ([#58107](https://github.com/kubernetes/kubernetes/pull/58107), [@ironcladlou](https://github.com/ironcladlou)) - -* Bump metadata proxy version to v0.1.7 to pick up security fix. ([#57762](https://github.com/kubernetes/kubernetes/pull/57762), [@ihmccreery](https://github.com/ihmccreery)) - -* The kubelet uses a new release 3.1 of the pause container with the Docker runtime. This version will clean up orphaned zombie processes that it inherits. ([#57517](https://github.com/kubernetes/kubernetes/pull/57517), [@verb](https://github.com/verb)) - -* Add cache for VM get operation in azure cloud provider ([#57432](https://github.com/kubernetes/kubernetes/pull/57432), [@karataliu](https://github.com/karataliu)) - -* Configurable liveness probe initial delays for etcd and kube-apiserver in GCE ([#57749](https://github.com/kubernetes/kubernetes/pull/57749), [@wojtek-t](https://github.com/wojtek-t)) - -* Fixed garbage collection hang ([#57503](https://github.com/kubernetes/kubernetes/pull/57503), [@liggitt](https://github.com/liggitt) - -* Improve scheduler performance of MatchInterPodAffinity predicate. ([#57478](https://github.com/kubernetes/kubernetes/pull/57478), [@misterikkit](https://github.com/misterikkit)) - -* Add the path '/version/' to the `system:discovery` cluster role. ([#57368](https://github.com/kubernetes/kubernetes/pull/57368), [@brendandburns](https://github.com/brendandburns)) - -* adding predicates ordering for the kubernetes scheduler. ([#57168](https://github.com/kubernetes/kubernetes/pull/57168), [@yastij](https://github.com/yastij)) - -* Fix ipvs proxier nodeport ethassumption ([#56685](https://github.com/kubernetes/kubernetes/pull/56685), [@m1093782566](https://github.com/m1093782566)) - -* Fix Heapster configuration and Metrics Server configuration to enable overriding default resource requirements. ([#56965](https://github.com/kubernetes/kubernetes/pull/56965), [@kawych](https://github.com/kawych)) - -* Improved event generation in volume mount, attach, and extend operations ([#56872](https://github.com/kubernetes/kubernetes/pull/56872), [@davidz627](https://github.com/davidz627)) - -* Remove ScrubDNS interface from cloudprovider. ([#56955](https://github.com/kubernetes/kubernetes/pull/56955), [@feiskyer](https://github.com/feiskyer)) - -* Fixed a garbage collection race condition where objects with ownerRefs pointing to cluster-scoped objects could be deleted incorrectly. ([#57211](https://github.com/kubernetes/kubernetes/pull/57211), [@liggitt](https://github.com/liggitt)) - -* api-server provides specific events when unable to repair a service cluster ip or node port ([#54304](https://github.com/kubernetes/kubernetes/pull/54304), [@frodenas](https://github.com/frodenas)) - -* delete useless params containerized ([#56146](https://github.com/kubernetes/kubernetes/pull/56146), [@jiulongzaitian](https://github.com/jiulongzaitian)) - -* dockershim now makes an Image's Labels available in the Info field of ImageStatusResponse ([#58036](https://github.com/kubernetes/kubernetes/pull/58036), [@shlevy](https://github.com/shlevy)) - -* Support GetLabelsForVolume in OpenStack Provider ([#58871](https://github.com/kubernetes/kubernetes/pull/58871), [@edisonxiang](https://github.com/edisonxiang)) - -* Add "nominatedNodeName" field to PodStatus. This field is set when a pod preempts other pods on the node. ([#58990](https://github.com/kubernetes/kubernetes/pull/58990), [@bsalamat](https://github.com/bsalamat))* Fix the PersistentVolumeLabel controller from initializing the PV labels when it's not the next pending initializer. ([#56831](https://github.com/kubernetes/kubernetes/pull/56831), [@jhorwit2](https://github.com/jhorwit2)) - -* Rename StorageProtection to StorageObjectInUseProtection ([#59901](https://github.com/kubernetes/kubernetes/pull/59901), [@NickrenREN](https://github.com/NickrenREN)) - -* Add support for cloud-controller-manager in local-up-cluster.sh ([#57757](https://github.com/kubernetes/kubernetes/pull/57757), [@dims](https://github.com/dims)) - -* GCE: A role and clusterrole will now be provided with GCE/GKE for allowing the cloud-provider to post warning events on all services and watching configmaps in the kube-system namespace. No user action is required. ([#59686](https://github.com/kubernetes/kubernetes/pull/59686), [@nicksardo](https://github.com/nicksardo)) - -* Wait for kubedns to be ready when collecting the cluster IP. ([#57337](https://github.com/kubernetes/kubernetes/pull/57337), [@wwwtyro](https://github.com/wwwtyro)) - -## External Dependencies -* The supported etcd server version is 3.1.12, as compared to 3.0.17 in v1.9 ([#60988](https://github.com/kubernetes/kubernetes/pull/60988)) -* The validated docker versions are the same as for v1.9: 1.11.2 to 1.13.1 and 17.03.x ([ref](https://github.com/kubernetes/kubernetes/blob/master/test/e2e_node/system/docker_validator_test.go)) -* The Go version is go1.9.3, as compared to go1.9.2 in v1.9. ([#59012](https://github.com/kubernetes/kubernetes/pull/59012)) -* The minimum supported go is the same as for v1.9: go1.9.1. ([#55301](https://github.com/kubernetes/kubernetes/pull/55301)) -* CNI is the same as v1.9: v0.6.0 ([#51250](https://github.com/kubernetes/kubernetes/pull/51250)) -* CSI is updated to 0.2.0 as compared to 0.1.0 in v1.9. ([#60736](https://github.com/kubernetes/kubernetes/pull/60736)) -* The dashboard add-on has been updated to v1.8.3, as compared to 1.8.0 in v1.9. ([#517326](https://github.com/kubernetes/kubernetes/pull/57326)) -* Heapster has is the same as v1.9: v1.5.0. It will be upgraded in v1.11. ([ref](https://github.com/kubernetes/kubernetes/blob/master/cluster/addons/cluster-monitoring/google/heapster-controller.yaml)) -* Cluster Autoscaler has been updated to v1.2.0. ([#60842](https://github.com/kubernetes/kubernetes/pull/60842), [@mwielgus](https://github.com/mwielgus)) -* Updates kube-dns to v1.14.8 ([#57918](https://github.com/kubernetes/kubernetes/pull/57918), [@rramkumar1](https://github.com/rramkumar1)) -* Influxdb is unchanged from v1.9: v1.3.3 ([#53319](https://github.com/kubernetes/kubernetes/pull/53319)) -* Grafana is unchanged from v1.9: v4.4.3 ([#53319](https://github.com/kubernetes/kubernetes/pull/53319)) -* CAdvisor is v0.29.1 ([#60867](https://github.com/kubernetes/kubernetes/pull/60867)) -* fluentd-gcp-scaler is v0.3.0 ([#61269](https://github.com/kubernetes/kubernetes/pull/61269)) -* Updated fluentd in fluentd-es-image to fluentd v1.1.0 ([#58525](https://github.com/kubernetes/kubernetes/pull/58525), [@monotek](https://github.com/monotek)) -* fluentd-elasticsearch is v2.0.4 ([#58525](https://github.com/kubernetes/kubernetes/pull/58525)) -* Updated fluentd-gcp to v3.0.0. ([#60722](https://github.com/kubernetes/kubernetes/pull/60722)) -* Ingress glbc is v1.0.0 ([#61302](https://github.com/kubernetes/kubernetes/pull/61302)) -* OIDC authentication is coreos/go-oidc v2 ([#58544](https://github.com/kubernetes/kubernetes/pull/58544)) -* Updated fluentd-gcp updated to v2.0.11. ([#56927](https://github.com/kubernetes/kubernetes/pull/56927), [@x13n](https://github.com/x13n)) -* Calico has been updated to v2.6.7 ([#59130](https://github.com/kubernetes/kubernetes/pull/59130), [@caseydavenport](https://github.com/caseydavenport)) - -# v1.10.0-rc.1 - -[Documentation](https://docs.k8s.io) & [Examples](https://releases.k8s.io/release-1.10/examples) - -## Downloads for v1.10.0-rc.1 - - -filename | sha256 hash --------- | ----------- -[kubernetes.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes.tar.gz) | `d7409a0bf36558b8328eefc01959920641f1fb2630fe3ac19b266fcea05a1646` -[kubernetes-src.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-src.tar.gz) | `4384bfe4151850e5d169b125c0cba51b7c2f00aa9972a6b4c22c44af74e8e3f8` - -### Client Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-client-darwin-386.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-client-darwin-386.tar.gz) | `1eb98b5d527ee9ed375f06df96c1158b9879880eb12d68a81e823d7a92e3866d` -[kubernetes-client-darwin-amd64.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-client-darwin-amd64.tar.gz) | `be7e35e9698b84ace37e0ed54640c3958c0d9eea8bd413eb8b604ec02922321a` -[kubernetes-client-linux-386.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-client-linux-386.tar.gz) | `825a80abdb1171e72c1660fb7854ed6e8290cb7cb54ebb88c3570b3f95e77a02` -[kubernetes-client-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-client-linux-amd64.tar.gz) | `97e22907c3f0780818b7124c50451ae78e930cd99ec8f96f188cdd080547e21b` -[kubernetes-client-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-client-linux-arm64.tar.gz) | `d27674c7daec425f0fa72ca14695e7f13c81cfd08517ceb1f5ce1bb052b5b9b2` -[kubernetes-client-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-client-linux-arm.tar.gz) | `e54f1fc7cf95981f54d68108ad0113396357ff0c7baaf6a76a635f0de21fb944` -[kubernetes-client-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-client-linux-ppc64le.tar.gz) | `7535a6668e6ca6888b22615439fae8c68d37d62f572b284755db87600050a6c6` -[kubernetes-client-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-client-linux-s390x.tar.gz) | `6a9f90e2ea5cb50b2691c45d327cca444ae9bfc41cba43ca22016679da940a71` -[kubernetes-client-windows-386.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-client-windows-386.tar.gz) | `cc5fef5e054588ad41870a379662d8429bd0f09500bcf4a67648bf6593d18aaf` -[kubernetes-client-windows-amd64.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-client-windows-amd64.tar.gz) | `a06033004c5cecc43494d95dd5d5e75f698cf8e4d358c229c5fef222c131b077` - -### Server Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-server-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-server-linux-amd64.tar.gz) | `e844897e9a39ca14a449e077cb4e4f2dc6c7d5326b95a1e47bef3b6f9c6057f7` -[kubernetes-server-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-server-linux-arm64.tar.gz) | `c15476626cd750a8f59c30c3389ada482995aea66b510c43732035d33e87e774` -[kubernetes-server-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-server-linux-arm.tar.gz) | `74a1ff7478d7ca5c4ccb2fb772ef13745a20cfb512e3e66f238abb98122cc4eb` -[kubernetes-server-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-server-linux-ppc64le.tar.gz) | `3b004717fe811352c15fe71f3122d2eaac7e0d1c4ff07d8810894c877b409c0f` -[kubernetes-server-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-server-linux-s390x.tar.gz) | `b6ff40f13355b47e2c02c6c016ac334a3f5008769ed7b4377c617c2fc9e30b7a` - -### Node Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-node-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-node-linux-amd64.tar.gz) | `a3a3e27c2b77fa46b7c9ff3b8bfdc672c2657e47fc4b1ca3d76cdc102ca27630` -[kubernetes-node-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-node-linux-arm64.tar.gz) | `af172c9d71ba2d15e14354159ac34ca7fe112b7d2d2ba38325c467950aa04755` -[kubernetes-node-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-node-linux-arm.tar.gz) | `fb904aa009c3309e92505ceff15863f83d9317af15cbf729bcbd198f5be3379f` -[kubernetes-node-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-node-linux-ppc64le.tar.gz) | `659f0091578e42b111417d45f708be2ac60447512e485dab7d2f4abaeee36f49` -[kubernetes-node-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-node-linux-s390x.tar.gz) | `ce40dcc55ca299401ddf146b2622dd7f19532e95620bae63aea58a45a8020875` -[kubernetes-node-windows-amd64.tar.gz](https://dl.k8s.io/v1.10.0-rc.1/kubernetes-node-windows-amd64.tar.gz) | `0f8b5c551f58cdf298d41258483311cef66fe1b41093152a43120514a493b23d` - -## Changelog since v1.10.0-beta.4 - -### Other notable changes - -* Updates kubeadm default to use 1.10 ([#61127](https://github.com/kubernetes/kubernetes/pull/61127), [@timothysc](https://github.com/timothysc)) -* Bump ingress-gce image in glbc.manifest to 1.0.0 ([#61302](https://github.com/kubernetes/kubernetes/pull/61302), [@rramkumar1](https://github.com/rramkumar1)) -* Fix regression where kubelet --cpu-cfs-quota flag did not work when --cgroups-per-qos was enabled ([#61294](https://github.com/kubernetes/kubernetes/pull/61294), [@derekwaynecarr](https://github.com/derekwaynecarr)) -* Fix bug allowing garbage collector to enter a broken state that could only be fixed by restarting the controller-manager. ([#61201](https://github.com/kubernetes/kubernetes/pull/61201), [@jennybuckley](https://github.com/jennybuckley)) -* When `TaintNodesByCondition` enabled, added `node.kubernetes.io/unschedulable:NoSchedule` ([#61161](https://github.com/kubernetes/kubernetes/pull/61161), [@k82cn](https://github.com/k82cn)) - * taint to the node if `spec.Unschedulable` is true. - * When `ScheduleDaemonSetPods` enabled, `node.kubernetes.io/unschedulable:NoSchedule` - * toleration is added automatically to DaemonSet Pods; so the `unschedulable` field of - * a node is not respected by the DaemonSet controller. -* Fixed kube-proxy to work correctly with iptables 1.6.2 and later. ([#60978](https://github.com/kubernetes/kubernetes/pull/60978), [@danwinship](https://github.com/danwinship)) -* Audit logging with buffering enabled can increase apiserver memory usage (e.g. up to 200MB in 100-node cluster). The increase is bounded by the buffer size (configurable). Ref: issue [#60500](https://github.com/kubernetes/kubernetes/pull/60500) ([#61118](https://github.com/kubernetes/kubernetes/pull/61118), [@shyamjvs](https://github.com/shyamjvs)) -* Fix a bug in scheduler cache by using Pod UID as the cache key instead of namespace/name ([#61069](https://github.com/kubernetes/kubernetes/pull/61069), [@anfernee](https://github.com/anfernee)) - - - -# v1.10.0-beta.4 - -[Documentation](https://docs.k8s.io) & [Examples](https://releases.k8s.io/release-1.10/examples) - -## Downloads for v1.10.0-beta.4 - - -filename | sha256 hash --------- | ----------- -[kubernetes.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes.tar.gz) | `69132f3edcf549c686055903e8ef007f0c92ec05a8ec1e3fea4d5b4dc4685580` -[kubernetes-src.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-src.tar.gz) | `60ba32e493c0a1449cdbd615d709e9d46780c91c88255e8e9f468c5e4e124576` - -### Client Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-client-darwin-386.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-client-darwin-386.tar.gz) | `80ef567c51aa705511ca20fbfcad2e85f1dc4fb750c0f58e0d82f4166359273f` -[kubernetes-client-darwin-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-client-darwin-amd64.tar.gz) | `925830f3c6c135adec206012ae94807b58b9438008ae87881e7a9d648ab993ec` -[kubernetes-client-linux-386.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-client-linux-386.tar.gz) | `9e4f40325a27b79f16eb3254c6283d67e2fecd313535b300f9931800e4c495a4` -[kubernetes-client-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-client-linux-amd64.tar.gz) | `85ee9bfa519e49283ab711c73f52809f8fc43616cc2076dc060987e6f262ff95` -[kubernetes-client-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-client-linux-arm.tar.gz) | `f0123581243a278052413e862208a797e78e7689c6dba0da08ab3200feedd66c` -[kubernetes-client-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-client-linux-arm64.tar.gz) | `dd19b034e1798f5bb0b1c6230ef294ca8f3ef7944837c5d49dce4659bb284b8e` -[kubernetes-client-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-client-linux-ppc64le.tar.gz) | `84a46003fe0140f8ecec03befceed7a4d955f9f88abdced99ecee24bc675b113` -[kubernetes-client-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-client-linux-s390x.tar.gz) | `c4ee2bf9f7ea66ab41b350220920644bee3eeceb13cfd19873843a9ab43b372d` -[kubernetes-client-windows-386.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-client-windows-386.tar.gz) | `917e768179e82a33232281b9b6e555cee75cf6315bd3c60a1fce4717fbd0e538` -[kubernetes-client-windows-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-client-windows-amd64.tar.gz) | `915f3cc888332b360701a4b20d1af384ec5388636f2c3e3868e36124ce8a96a8` - -### Server Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-server-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-server-linux-amd64.tar.gz) | `01b50da6bae8abe4e2c813381c3848ff615fc1d8164d11b163ac0819554ad7b4` -[kubernetes-server-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-server-linux-arm.tar.gz) | `0a1ebd399759a68972e6248b09ce46a76deef931e51c807e032fefc4210e3dde` -[kubernetes-server-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-server-linux-arm64.tar.gz) | `b8298a06aed6cd1c624855fb4e2d7258e8f9201fbc5bfebc8190c24273e95d9b` -[kubernetes-server-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-server-linux-ppc64le.tar.gz) | `b3b03dc71476f70c8a62cf5ac72fe0bfa433005778d39bfbc43fe225675f9986` -[kubernetes-server-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-server-linux-s390x.tar.gz) | `940bc9b4f73f32896f3c55d1b5824f931517689ec62b70600c8699e84bc725ee` - -### Node Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-node-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-node-linux-amd64.tar.gz) | `bcc29195864e4e486a7e8194be06f3cf575203e012790ea6d70003349b108701` -[kubernetes-node-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-node-linux-arm.tar.gz) | `35ab99a6cd30c2ea6a1f2347d244fb8583bfd7ef1d54f89fbf9a3a3be14fb9e7` -[kubernetes-node-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-node-linux-arm64.tar.gz) | `fcb611d964c7e1c546fbbb38c8b30b3e3bb54226540caa0b80930f53e321dd2e` -[kubernetes-node-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-node-linux-ppc64le.tar.gz) | `4de7b25cf712df27b6eec5232dc2891e07dbeb8c3699a145f777cc0629f1fe9c` -[kubernetes-node-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-node-linux-s390x.tar.gz) | `2f0b6a01c7c86209f031f47e1901bf3da82efef4db5b73b4e7d83be04b03c814` -[kubernetes-node-windows-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.4/kubernetes-node-windows-amd64.tar.gz) | `619013157435d8da7f58bb339aa21d5a080c341aebe226934d1139d29cff72be` - -## Changelog since v1.10.0-beta.3 - -### Other notable changes - -* Fix a regression that prevented using `subPath` volume mounts with secret, configMap, projected, and downwardAPI volumes ([#61080](https://github.com/kubernetes/kubernetes/pull/61080), [@liggitt](https://github.com/liggitt)) -* Upgrade the default etcd server version to 3.1.12 to pick up critical etcd "mvcc "unsynced" watcher restore operation" fix. ([#60998](https://github.com/kubernetes/kubernetes/pull/60998), [@jpbetz](https://github.com/jpbetz)) -* Fixed missing error checking that could cause kubelet to crash in a race condition. ([#60962](https://github.com/kubernetes/kubernetes/pull/60962), [@technicianted](https://github.com/technicianted)) - - - -# v1.10.0-beta.3 - -[Documentation](https://docs.k8s.io) & [Examples](https://releases.k8s.io/release-1.10/examples) - -## Downloads for v1.10.0-beta.3 - - -filename | sha256 hash --------- | ----------- -[kubernetes.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes.tar.gz) | `65880d0bb77eeb83554bb0a6c78b6d3a25cd38ef7d714bbe2c73b203386618d6` -[kubernetes-src.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-src.tar.gz) | `e9fbf8198fd80c92dd7e2ecf0cf6cefda06f9b89e7986ae141412f8732dae47c` - -### Client Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-client-darwin-386.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-client-darwin-386.tar.gz) | `50b1a41e70804f74b3e76d7603752d45dfd47011fd986d055462e1330330aa45` -[kubernetes-client-darwin-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-client-darwin-amd64.tar.gz) | `3658e70ae9761464df50c6cae8d57349648c80d16658892e42ea898ddab362bc` -[kubernetes-client-linux-386.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-client-linux-386.tar.gz) | `00b8c048b201931ab1fb059df030e0bfc866f3c3ff464213aa6071ff261a3d33` -[kubernetes-client-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-client-linux-amd64.tar.gz) | `364d6439185399e72f96bea1bf2863deb2080f4bf6df721932ef14ec45b2d5fc` -[kubernetes-client-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-client-linux-arm.tar.gz) | `98670b2e965e118fb02901aa949cd1eb12d34ffd0bba7ff22014e9ad587556bc` -[kubernetes-client-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-client-linux-arm64.tar.gz) | `5f4febc543aa2f10c0c8aee9c9a8cb169b19b04486bda4cf1f72c80fa7a3a483` -[kubernetes-client-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-client-linux-ppc64le.tar.gz) | `ff3d020e97e2ff4c1824db910f13945d70320fc3988cc24385708cab58d4065f` -[kubernetes-client-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-client-linux-s390x.tar.gz) | `508695afe6d3466488bc20cad31c184723cb238d1c311d2d1c4f9f1c9e981bd6` -[kubernetes-client-windows-386.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-client-windows-386.tar.gz) | `9f6372cfb973d04a150e1388d96cb60e7fe6ccb9ba63a146ff2dee491c2e3f4e` -[kubernetes-client-windows-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-client-windows-amd64.tar.gz) | `2c85f2f13dc535d3c777f186b7e6d9403d64ac18ae01d1e460a8979e62845e04` - -### Server Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-server-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-server-linux-amd64.tar.gz) | `4797ada6fd43e223d67840e815c1edb244a3b40a3a1b6ecfde7789119f2add3d` -[kubernetes-server-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-server-linux-arm.tar.gz) | `fb2fdb4b2feb41adbbd33fe4b7abbe9780d91a288a64ff7acf85d5ef942d3960` -[kubernetes-server-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-server-linux-arm64.tar.gz) | `bc1f35e1999beaac91b65050f70c8e539918b927937e88bfcfa34a0c26b96701` -[kubernetes-server-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-server-linux-ppc64le.tar.gz) | `cce312f5af7dd182c8cc4ef35a768fef788a849a93a6f2f36e9d2991e721b362` -[kubernetes-server-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-server-linux-s390x.tar.gz) | `42edec36fa34a4cc4959af20a587fb05924ccc87c94b0f845953ba1ceec56bb7` - -### Node Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-node-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-node-linux-amd64.tar.gz) | `e517986261e3789cada07d9063ae96ed9b17ffd80c1b220b6ae9c41238c07c08` -[kubernetes-node-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-node-linux-arm.tar.gz) | `9eb213248982816a855a7ff18c9421d5e987d5f1c472880a16bc6c477ce8da2a` -[kubernetes-node-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-node-linux-arm64.tar.gz) | `e938dce3ec05cedcd6ab8e2b63224170db00e2c47e67685eb3cb4bad247ac8c0` -[kubernetes-node-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-node-linux-ppc64le.tar.gz) | `bc9bf3d55f85d3b30f0a28fd79b7610ecdf019b8bc8d7f978da62ee0006c72eb` -[kubernetes-node-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-node-linux-s390x.tar.gz) | `c5a1b18b8030ec86748e23d45f1de63783c2e95d67b0d6c2fcbcd545d205db8d` -[kubernetes-node-windows-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.3/kubernetes-node-windows-amd64.tar.gz) | `df4f4e8df8665ed08a9a3d9816e61c6c9f0ce50e4185b6c7a7f34135ad1f91d0` - -## Changelog since v1.10.0-beta.2 - -### Other notable changes - -* kubelet initial flag parse should normalize flags instead of exiting. ([#61053](https://github.com/kubernetes/kubernetes/pull/61053), [@andrewsykim](https://github.com/andrewsykim)) -* Fixes CVE-2017-1002101 - See https://issue.k8s.io/60813 for details ([#61044](https://github.com/kubernetes/kubernetes/pull/61044), [@liggitt](https://github.com/liggitt)) -* Fixes the races around devicemanager Allocate() and endpoint deletion. ([#60856](https://github.com/kubernetes/kubernetes/pull/60856), [@jiayingz](https://github.com/jiayingz)) -* When ScheduleDaemonSetPods is enabled, the DaemonSet controller will delegate Pods scheduling to default scheduler. ([#59862](https://github.com/kubernetes/kubernetes/pull/59862), [@k82cn](https://github.com/k82cn)) -* Set node external IP for azure node when disabling UseInstanceMetadata ([#60959](https://github.com/kubernetes/kubernetes/pull/60959), [@feiskyer](https://github.com/feiskyer)) -* Bug fix, allow webhooks to use the scheme provided in clientConfig, instead of defaulting to http. ([#60943](https://github.com/kubernetes/kubernetes/pull/60943), [@jennybuckley](https://github.com/jennybuckley)) -* Downgrade default etcd server version to 3.1.11 due to [#60589](https://github.com/kubernetes/kubernetes/pull/60589) ([#60891](https://github.com/kubernetes/kubernetes/pull/60891), [@shyamjvs](https://github.com/shyamjvs)) -* kubelet and kube-proxy can now be ran as Windows services ([#60144](https://github.com/kubernetes/kubernetes/pull/60144), [@alinbalutoiu](https://github.com/alinbalutoiu)) - - - -# v1.10.0-beta.2 - -[Documentation](https://docs.k8s.io) & [Examples](https://releases.k8s.io/release-1.10/examples) - -## Downloads for v1.10.0-beta.2 - - -filename | sha256 hash --------- | ----------- -[kubernetes.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes.tar.gz) | `d07d77f16664cdb5ce86c87de36727577f48113efdb00f83283714ac1373d521` -[kubernetes-src.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-src.tar.gz) | `c27b06e748e4c10f42472f51ddfef7e9546e4ec9d2ce9f7a9a3c5768de8d97bf` - -### Client Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-client-darwin-386.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-client-darwin-386.tar.gz) | `d63168f9155f04e4b47fe96381f9aa06c3d498b6e6b71d1fb8c3ffeb0f3c6e4c` -[kubernetes-client-darwin-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-client-darwin-amd64.tar.gz) | `f473cbe830c1bfb738b0a66f07b3cd858ba185232eba26fe776f90d8a27bd7c1` -[kubernetes-client-linux-386.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-client-linux-386.tar.gz) | `2a0f74d30cdaf19ed7c3fde3528e98a8cd98fdb9dc6e6a501525e69895674d56` -[kubernetes-client-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-client-linux-amd64.tar.gz) | `69c18569717a97cb5e6bc22bebcf2f64969ba68b11685faaf2949c4ffbcd0b73` -[kubernetes-client-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-client-linux-arm.tar.gz) | `10e1d76a1ee6c0df9f9cce40d18c350a1e3e3665e6fe64d22e4433b6283d3fe2` -[kubernetes-client-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-client-linux-arm64.tar.gz) | `12f081b99770548c8ddd688ae6b417c196f8308bd5901abbed6f203e133411ae` -[kubernetes-client-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-client-linux-ppc64le.tar.gz) | `6e1a035b4857539c90324e00b150ae65aaf4f4524250c9ca7d77ad5936f0628e` -[kubernetes-client-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-client-linux-s390x.tar.gz) | `5a8e2b0d14e18a39f821b09a7d73fa5c085cf6c197aeb540a3fe289e04fcc0d9` -[kubernetes-client-windows-386.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-client-windows-386.tar.gz) | `03fac6befb94b85fb90e0bb47596868b4da507d803806fad2a5fb4b85c98d87d` -[kubernetes-client-windows-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-client-windows-amd64.tar.gz) | `3bf8dd42eb70735ebdbda4ec4ec54e9507410e2f97ab2f364b88c2f24fdf471c` - -### Server Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-server-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-server-linux-amd64.tar.gz) | `1278703060865281aa48b1366e3c4b0720d4eca623ba08cf852a4719a6680ec3` -[kubernetes-server-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-server-linux-arm.tar.gz) | `b1e2b399bec8c25b7b6037203485d2d09b091afc51ffebf861d5bddb8bb076ac` -[kubernetes-server-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-server-linux-arm64.tar.gz) | `4c3d0ed44d6a19ae178034117891678ec373894b02f8d33627b37a36c2ea815b` -[kubernetes-server-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-server-linux-ppc64le.tar.gz) | `88a7b52030104a4c6fb1f8c5f79444ed853f381e1463fec7e4939a9998d92dff` -[kubernetes-server-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-server-linux-s390x.tar.gz) | `35981580c00bff0e3d92238f961e37dd505c08bcd4cafb11e274daa1eb8ced5f` - -### Node Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-node-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-node-linux-amd64.tar.gz) | `ceedb0a322167bae33042407da5369e0b7889fbaa3568281500c921afcdbe310` -[kubernetes-node-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-node-linux-arm.tar.gz) | `b84ab4c486bc8f00841fccce2aafe4dcef25606c8f3184bce2551ab6486c8f71` -[kubernetes-node-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-node-linux-arm64.tar.gz) | `b79a41145c28358a64d7a689cd282cf8361fe87c410fbae1cdc8db76cfcf6e5b` -[kubernetes-node-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-node-linux-ppc64le.tar.gz) | `afc00f67b9f6d4fc149d4426fc8bbf6083077e11a1d2330d70be7e765b6cb923` -[kubernetes-node-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-node-linux-s390x.tar.gz) | `f6128bbccddfe8ce39762bacb5c13c6c68d76a4bf8d35e773560332eb05a2c86` -[kubernetes-node-windows-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.2/kubernetes-node-windows-amd64.tar.gz) | `b1dde1ed2582cd511236fec69ebd6ca30281b30cc37e0841c493f06924a466cf` - -## Changelog since v1.10.0-beta.1 - -### Action Required - -* ACTION REQUIRED: LocalStorageCapacityIsolation feature is beta and enabled by default. ([#60159](https://github.com/kubernetes/kubernetes/pull/60159), [@jingxu97](https://github.com/jingxu97)) - -### Other notable changes - -* Upgrade the default etcd server version to 3.2.16 ([#59836](https://github.com/kubernetes/kubernetes/pull/59836), [@jpbetz](https://github.com/jpbetz)) -* Cluster Autoscaler 1.1.2 ([#60842](https://github.com/kubernetes/kubernetes/pull/60842), [@mwielgus](https://github.com/mwielgus)) -* ValidatingWebhooks and MutatingWebhooks will not be called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects in the admissionregistration.k8s.io group ([#59840](https://github.com/kubernetes/kubernetes/pull/59840), [@jennybuckley](https://github.com/jennybuckley)) -* Kubeadm: CoreDNS supports migration of the kube-dns configuration to CoreDNS configuration when upgrading the service discovery from kube-dns to CoreDNS as part of Beta. ([#58828](https://github.com/kubernetes/kubernetes/pull/58828), [@rajansandeep](https://github.com/rajansandeep)) -* Fix broken useManagedIdentityExtension for azure cloud provider ([#60775](https://github.com/kubernetes/kubernetes/pull/60775), [@feiskyer](https://github.com/feiskyer)) -* kubelet now notifies systemd that it has finished starting, if systemd is available and running. ([#60654](https://github.com/kubernetes/kubernetes/pull/60654), [@dcbw](https://github.com/dcbw)) -* Do not count failed pods as unready in HPA controller ([#60648](https://github.com/kubernetes/kubernetes/pull/60648), [@bskiba](https://github.com/bskiba)) -* fixed foreground deletion of podtemplates ([#60683](https://github.com/kubernetes/kubernetes/pull/60683), [@nilebox](https://github.com/nilebox)) -* Conformance tests are added for the DaemonSet kinds in the apps/v1 group version. Deprecated versions of DaemonSet will not be tested for conformance, and conformance is only applicable to release 1.10 and later. ([#60456](https://github.com/kubernetes/kubernetes/pull/60456), [@kow3ns](https://github.com/kow3ns)) -* Log audit backend can now be configured to perform batching before writing events to disk. ([#60237](https://github.com/kubernetes/kubernetes/pull/60237), [@crassirostris](https://github.com/crassirostris)) -* Fixes potential deadlock when deleting CustomResourceDefinition for custom resources with finalizers ([#60542](https://github.com/kubernetes/kubernetes/pull/60542), [@liggitt](https://github.com/liggitt)) -* fix azure file plugin failure issue on Windows after node restart ([#60625](https://github.com/kubernetes/kubernetes/pull/60625), [@andyzhangx](https://github.com/andyzhangx)) -* Set Azure vmType to standard if it is not set in azure cloud config. ([#60623](https://github.com/kubernetes/kubernetes/pull/60623), [@feiskyer](https://github.com/feiskyer)) -* On cluster provision or upgrade, kubeadm generates an etcd specific CA for all etcd related certificates. ([#60385](https://github.com/kubernetes/kubernetes/pull/60385), [@stealthybox](https://github.com/stealthybox)) -* kube-scheduler: restores default leader election behavior. leader-elect command line parameter should "true" ([#60524](https://github.com/kubernetes/kubernetes/pull/60524), [@dims](https://github.com/dims)) -* client-go: alpha support for exec-based credential providers ([#59495](https://github.com/kubernetes/kubernetes/pull/59495), [@ericchiang](https://github.com/ericchiang)) - - - -# v1.10.0-beta.1 - -[Documentation](https://docs.k8s.io) & [Examples](https://releases.k8s.io/release-1.10/examples) - -## Downloads for v1.10.0-beta.1 - - -filename | sha256 hash --------- | ----------- -[kubernetes.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes.tar.gz) | `428139d9877f5f94acc806cc4053b0a5f8eac2acc219f06efd0817807473dbc5` -[kubernetes-src.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-src.tar.gz) | `5bfdecdbb43d946ea965f22ec6b8a0fc7195197a523aefebc2b7b926d4252edf` - -### Client Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-client-darwin-386.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-client-darwin-386.tar.gz) | `8cc086e901fe699df5e0711438195e675e099848a72ba272b290d22abc107a93` -[kubernetes-client-darwin-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-client-darwin-amd64.tar.gz) | `b2782b8f6dbfe3fa962b08606cbf3366b071b78c47794d2ef67f9d484b4af4e4` -[kubernetes-client-linux-386.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-client-linux-386.tar.gz) | `a4001ad2387ccb4557b15c560b0ea8ea4d7c7ed494375346e3f83c10eb9426ac` -[kubernetes-client-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-client-linux-amd64.tar.gz) | `b95d354e80d9f00a883e5eeb8c2e0ceaacc0f3cc8c904cb2eca1e1b6d91462b2` -[kubernetes-client-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-client-linux-arm64.tar.gz) | `647d234c59bc1d6f8eea88624d85b09bbe1272d9e27e1f7963e03cc025530ed0` -[kubernetes-client-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-client-linux-arm.tar.gz) | `187da9ad060ac7d426811772f6c3d891a354945af6a7d8832ac7097e19d4b46d` -[kubernetes-client-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-client-linux-ppc64le.tar.gz) | `6112396b8f0e7b1401b374aa2ae6195849da7718572036b6f060a722a89dc319` -[kubernetes-client-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-client-linux-s390x.tar.gz) | `09789cf33d8eed610ad2eef7d3ae25a4b4a63ee5525e452f9094097a172a1ce9` -[kubernetes-client-windows-386.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-client-windows-386.tar.gz) | `1e71bc9979c8915587cdea980dad36b0cafd502f972c051c2aa63c3bbfeceb14` -[kubernetes-client-windows-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-client-windows-amd64.tar.gz) | `3c2978479c6f65f1cb5043ba182a0571480090298b7d62090d9bf11b043dd27d` - -### Server Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-server-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-server-linux-amd64.tar.gz) | `d887411450bbc06e2f4a24ce3c478fe6844856a8707b3236c045d44ab93b27d2` -[kubernetes-server-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-server-linux-arm64.tar.gz) | `907f037eea90bf893520d3adeccdf29eda69eea32c564b08cecbedfd06471acd` -[kubernetes-server-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-server-linux-arm.tar.gz) | `f2ac4ad4f831a970cb35c1d7194788850dff722e859a08a879c918db1233aaa7` -[kubernetes-server-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-server-linux-ppc64le.tar.gz) | `0bebb59217b491c5aa4b4b9dc740c0c8c5518872f6f86853cbe30493ea8539a5` -[kubernetes-server-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-server-linux-s390x.tar.gz) | `5f343764e04e3a8639dffe225cc6f8bc6f17e1584b2c68923708546f48d38f89` - -### Node Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-node-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-node-linux-amd64.tar.gz) | `c4475c315d4ae27c30f80bc01d6ea8b0b8549ec6a60a5dc745cf11a0c4398c23` -[kubernetes-node-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-node-linux-arm64.tar.gz) | `4512a4c3e62cd26fb0d3f78bfc8de9a860e7d88e7c913c5df4c239536f89da42` -[kubernetes-node-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-node-linux-arm.tar.gz) | `1da407ad152b185f520f04215775a8fe176550a31a2bb79e3e82968734bdfb5c` -[kubernetes-node-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-node-linux-ppc64le.tar.gz) | `f23f6f819e6d894f8ca7457f80ee4ede729fd35ac59e9c65ab031b56aa06d4a1` -[kubernetes-node-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-node-linux-s390x.tar.gz) | `205c789f52a4c666a63ac7944ffa8ee325cb97e788b748c262eae59b838a94ba` -[kubernetes-node-windows-amd64.tar.gz](https://dl.k8s.io/v1.10.0-beta.1/kubernetes-node-windows-amd64.tar.gz) | `aa7675fd22d9ca671585f429f6981aa79798f1894025c3abe3a7154f3c94aae6` - -## Changelog since v1.10.0-alpha.3 - -### Action Required - -* [action required] Default Flexvolume plugin directory for COS images on GCE is changed to `/home/kubernetes/flexvolume`. ([#58171](https://github.com/kubernetes/kubernetes/pull/58171), [@verult](https://github.com/verult)) -* action required: [GCP kube-up.sh] Some variables that were part of kube-env are no longer being set (ones only used for kubelet flags) and are being replaced by a more portable mechanism (kubelet configuration file). The individual variables in the kube-env metadata entry were never meant to be a stable interface and this release note only applies if you are depending on them. ([#60020](https://github.com/kubernetes/kubernetes/pull/60020), [@roberthbailey](https://github.com/roberthbailey)) -* action required: Deprecate format-separated endpoints for OpenAPI spec. Please use single `/openapi/v2` endpoint instead. ([#59293](https://github.com/kubernetes/kubernetes/pull/59293), [@roycaihw](https://github.com/roycaihw)) -* action required: kube-proxy: feature gates are now specified as a map when provided via a JSON or YAML KubeProxyConfiguration, rather than as a string of key-value pairs. ([#57962](https://github.com/kubernetes/kubernetes/pull/57962), [@xiangpengzhao](https://github.com/xiangpengzhao)) -* Action Required: The boostrapped RBAC role and rolebinding for the `cloud-provider` service account is now deprecated. If you're currently using this service account, you must create and apply your own RBAC policy for new clusters. ([#59949](https://github.com/kubernetes/kubernetes/pull/59949), [@nicksardo](https://github.com/nicksardo)) -* ACTION REQUIRED: VolumeScheduling and LocalPersistentVolume features are beta and enabled by default. The PersistentVolume NodeAffinity alpha annotation is deprecated and will be removed in a future release. ([#59391](https://github.com/kubernetes/kubernetes/pull/59391), [@msau42](https://github.com/msau42)) -* action required: Deprecate the kubelet's cadvisor port. The default will change to 0 (disabled) in 1.12, and the cadvisor port will be removed entirely in 1.13. ([#59827](https://github.com/kubernetes/kubernetes/pull/59827), [@dashpole](https://github.com/dashpole)) -* action required: The `kubeletconfig` API group has graduated from alpha to beta, and the name has changed to `kubelet.config.k8s.io`. Please use `kubelet.config.k8s.io/v1beta1`, as `kubeletconfig/v1alpha1` is no longer available. ([#53833](https://github.com/kubernetes/kubernetes/pull/53833), [@mtaufen](https://github.com/mtaufen)) -* Action required: Default values differ between the Kubelet's componentconfig (config file) API and the Kubelet's command line. Be sure to review the default values when migrating to using a config file. ([#59666](https://github.com/kubernetes/kubernetes/pull/59666), [@mtaufen](https://github.com/mtaufen)) -* kube-apiserver: the experimental in-tree Keystone password authenticator has been removed in favor of extensions that enable use of Keystone tokens. ([#59492](https://github.com/kubernetes/kubernetes/pull/59492), [@dims](https://github.com/dims)) -* The udpTimeoutMilliseconds field in the kube-proxy configuration file has been renamed to udpIdleTimeout. Action required: administrators need to update their files accordingly. ([#57754](https://github.com/kubernetes/kubernetes/pull/57754), [@ncdc](https://github.com/ncdc)) - -### Other notable changes - -* Enable IPVS feature gateway by default ([#60540](https://github.com/kubernetes/kubernetes/pull/60540), [@m1093782566](https://github.com/m1093782566)) -* dockershim now makes an Image's Labels available in the Info field of ImageStatusResponse ([#58036](https://github.com/kubernetes/kubernetes/pull/58036), [@shlevy](https://github.com/shlevy)) -* kube-scheduler: Support extender managed extended resources in kube-scheduler ([#60332](https://github.com/kubernetes/kubernetes/pull/60332), [@yguo0905](https://github.com/yguo0905)) -* Fix the issue in kube-proxy iptables/ipvs mode to properly handle incorrect IP version. ([#56880](https://github.com/kubernetes/kubernetes/pull/56880), [@MrHohn](https://github.com/MrHohn)) -* WindowsContainerResources is set now for windows containers ([#59333](https://github.com/kubernetes/kubernetes/pull/59333), [@feiskyer](https://github.com/feiskyer)) -* GCE: support Cloud TPU API in cloud provider ([#58029](https://github.com/kubernetes/kubernetes/pull/58029), [@yguo0905](https://github.com/yguo0905)) -* The node authorizer now allows nodes to request service account tokens for the service accounts of pods running on them. ([#55019](https://github.com/kubernetes/kubernetes/pull/55019), [@mikedanese](https://github.com/mikedanese)) -* Fix StatefulSet to work with set-based selectors. ([#59365](https://github.com/kubernetes/kubernetes/pull/59365), [@ayushpateria](https://github.com/ayushpateria)) -* New conformance tests added for the Garbage Collector ([#60116](https://github.com/kubernetes/kubernetes/pull/60116), [@jennybuckley](https://github.com/jennybuckley)) -* Make NodePort IP addresses configurable ([#58052](https://github.com/kubernetes/kubernetes/pull/58052), [@m1093782566](https://github.com/m1093782566)) -* Implements MountDevice and UnmountDevice for the CSI Plugin, the functions will call through to NodeStageVolume/NodeUnstageVolume for CSI plugins. ([#60115](https://github.com/kubernetes/kubernetes/pull/60115), [@davidz627](https://github.com/davidz627)) -* Fixes a bug where character devices are not recongized by the kubelet ([#60440](https://github.com/kubernetes/kubernetes/pull/60440), [@andrewsykim](https://github.com/andrewsykim)) -* [fluentd-gcp addon] Switch to the image, provided by Stackdriver. ([#59128](https://github.com/kubernetes/kubernetes/pull/59128), [@bmoyles0117](https://github.com/bmoyles0117)) -* StatefulSet in apps/v1 is now included in Conformance Tests. ([#60336](https://github.com/kubernetes/kubernetes/pull/60336), [@enisoc](https://github.com/enisoc)) -* K8s supports rbd-nbd for Ceph rbd volume mounts. ([#58916](https://github.com/kubernetes/kubernetes/pull/58916), [@ianchakeres](https://github.com/ianchakeres)) -* AWS EBS volume plugin got block volume support ([#58625](https://github.com/kubernetes/kubernetes/pull/58625), [@screeley44](https://github.com/screeley44)) -* Summary API will include pod CPU and Memory stats for CRI container runtime. ([#60328](https://github.com/kubernetes/kubernetes/pull/60328), [@Random-Liu](https://github.com/Random-Liu)) -* dockertools: disable memory swap on Linux. ([#59404](https://github.com/kubernetes/kubernetes/pull/59404), [@ohmystack](https://github.com/ohmystack)) -* On AWS kubelet returns an error when started under conditions that do not allow it to work (AWS has not yet tagged the instance). ([#60125](https://github.com/kubernetes/kubernetes/pull/60125), [@vainu-arto](https://github.com/vainu-arto)) -* Increase timeout of integration tests ([#60458](https://github.com/kubernetes/kubernetes/pull/60458), [@jennybuckley](https://github.com/jennybuckley)) -* Fixes a case when Deployment with recreate strategy could get stuck on old failed Pod. ([#60301](https://github.com/kubernetes/kubernetes/pull/60301), [@tnozicka](https://github.com/tnozicka)) -* Buffered audit backend is introduced, to be used with other audit backends. ([#60076](https://github.com/kubernetes/kubernetes/pull/60076), [@crassirostris](https://github.com/crassirostris)) -* Update dashboard version to v1.8.3 ([#57326](https://github.com/kubernetes/kubernetes/pull/57326), [@floreks](https://github.com/floreks)) -* GCE PD volume plugin got block volume support ([#58710](https://github.com/kubernetes/kubernetes/pull/58710), [@screeley44](https://github.com/screeley44)) -* force node name lowercase on static pod name generating ([#59849](https://github.com/kubernetes/kubernetes/pull/59849), [@yue9944882](https://github.com/yue9944882)) -* AWS Security Groups created for ELBs will now be tagged with the same additional tags as the ELB (i.e. the tags specified by the "service.beta.kubernetes.io/aws-load-balancer-additional-resource-tags" annotation.) ([#58767](https://github.com/kubernetes/kubernetes/pull/58767), [@2rs2ts](https://github.com/2rs2ts)) -* Fixes an error when deleting an NLB in AWS - Fixes [#57568](https://github.com/kubernetes/kubernetes/pull/57568) ([#57569](https://github.com/kubernetes/kubernetes/pull/57569), [@micahhausler](https://github.com/micahhausler)) -* fix device name change issue for azure disk ([#60346](https://github.com/kubernetes/kubernetes/pull/60346), [@andyzhangx](https://github.com/andyzhangx)) -* On cluster provision or upgrade, kubeadm now generates certs and secures all connections to the etcd static-pod with mTLS. ([#57415](https://github.com/kubernetes/kubernetes/pull/57415), [@stealthybox](https://github.com/stealthybox)) -* Some field names in the Kubelet's now v1beta1 config API differ from the v1alpha1 API: PodManifestPath is renamed to StaticPodPath, ManifestURL is renamed to StaticPodURL, ManifestURLHeader is renamed to StaticPodURLHeader. ([#60314](https://github.com/kubernetes/kubernetes/pull/60314), [@mtaufen](https://github.com/mtaufen)) -* Adds BETA support for `DNSConfig` field in PodSpec and `DNSPolicy=None`. ([#59771](https://github.com/kubernetes/kubernetes/pull/59771), [@MrHohn](https://github.com/MrHohn)) -* kubeadm: Demote controlplane passthrough flags to alpha flags ([#59882](https://github.com/kubernetes/kubernetes/pull/59882), [@kris-nova](https://github.com/kris-nova)) -* DevicePlugins feature graduates to beta. ([#60170](https://github.com/kubernetes/kubernetes/pull/60170), [@jiayingz](https://github.com/jiayingz)) -* Additional changes to iptables kube-proxy backend to improve performance on clusters with very large numbers of services. ([#60306](https://github.com/kubernetes/kubernetes/pull/60306), [@danwinship](https://github.com/danwinship)) -* CSI now allows credentials to be specified on CreateVolume/DeleteVolume, ControllerPublishVolume/ControllerUnpublishVolume, and NodePublishVolume/NodeUnpublishVolume operations ([#60118](https://github.com/kubernetes/kubernetes/pull/60118), [@sbezverk](https://github.com/sbezverk)) -* Disable mount propagation for windows containers. ([#60275](https://github.com/kubernetes/kubernetes/pull/60275), [@feiskyer](https://github.com/feiskyer)) -* Introduced `--http2-max-streams-per-connection` command line flag on api-servers and set default to 1000 for aggregated API servers. ([#60054](https://github.com/kubernetes/kubernetes/pull/60054), [@MikeSpreitzer](https://github.com/MikeSpreitzer)) -* APIserver backed by etcdv3 exports metric showing number of resources per kind ([#59757](https://github.com/kubernetes/kubernetes/pull/59757), [@gmarek](https://github.com/gmarek)) -* The DaemonSet controller, its integration tests, and its e2e tests, have been updated to use the apps/v1 API. ([#59883](https://github.com/kubernetes/kubernetes/pull/59883), [@kow3ns](https://github.com/kow3ns)) -* Fix image file system stats for windows nodes ([#59743](https://github.com/kubernetes/kubernetes/pull/59743), [@feiskyer](https://github.com/feiskyer)) -* Custom resources can be listed with a set of grouped resources (category) by specifying the categories in the CustomResourceDefinition spec. Example: They can be used with `kubectl get all`, where `all` is a category. ([#59561](https://github.com/kubernetes/kubernetes/pull/59561), [@nikhita](https://github.com/nikhita)) -* [fluentd-gcp addon] Fixed bug with reporting metrics in event-exporter ([#60126](https://github.com/kubernetes/kubernetes/pull/60126), [@serathius](https://github.com/serathius)) -* Critical pods to use priorityClasses. ([#58835](https://github.com/kubernetes/kubernetes/pull/58835), [@ravisantoshgudimetla](https://github.com/ravisantoshgudimetla)) -* `--show-all` (which only affected pods and only for human readable/non-API printers) is now defaulted to true and deprecated. It will be inert in 1.11 and removed in a future release. ([#60210](https://github.com/kubernetes/kubernetes/pull/60210), [@deads2k](https://github.com/deads2k)) -* Removed some redundant rules created by the iptables proxier, to improve performance on systems with very many services. ([#57461](https://github.com/kubernetes/kubernetes/pull/57461), [@danwinship](https://github.com/danwinship)) -* Disable per-cpu metrics by default for scalability. ([#60106](https://github.com/kubernetes/kubernetes/pull/60106), [@dashpole](https://github.com/dashpole)) - * Fix inaccurate disk usage monitoring of overlayFs. - * Retry docker connection on startup timeout to avoid permanent loss of metrics. -* When the `PodShareProcessNamespace` alpha feature is enabled, setting `pod.Spec.ShareProcessNamespace` to `true` will cause a single process namespace to be shared between all containers in a pod. ([#60181](https://github.com/kubernetes/kubernetes/pull/60181), [@verb](https://github.com/verb)) -* add spelling checking script ([#59463](https://github.com/kubernetes/kubernetes/pull/59463), [@dixudx](https://github.com/dixudx)) -* Allows HorizontalPodAutoscaler to use global metrics not associated with any Kubernetes object (for example metrics from a hoster service running outside of Kubernetes cluster). ([#60096](https://github.com/kubernetes/kubernetes/pull/60096), [@MaciekPytel](https://github.com/MaciekPytel)) -* fix race condition issue when detaching azure disk ([#60183](https://github.com/kubernetes/kubernetes/pull/60183), [@andyzhangx](https://github.com/andyzhangx)) -* Add kubectl create job command ([#60084](https://github.com/kubernetes/kubernetes/pull/60084), [@soltysh](https://github.com/soltysh)) -* [Alpha] Kubelet now supports container log rotation for container runtime which implements CRI(container runtime interface). ([#59898](https://github.com/kubernetes/kubernetes/pull/59898), [@Random-Liu](https://github.com/Random-Liu)) - * The feature can be enabled with feature gate `CRIContainerLogRotation`. - * The flags `--container-log-max-size` and `--container-log-max-files` can be used to configure the rotation behavior. -* Reorganized iptables rules to fix a performance regression on clusters with thousands of services. ([#56164](https://github.com/kubernetes/kubernetes/pull/56164), [@danwinship](https://github.com/danwinship)) -* StorageOS volume plugin updated to support mount options and environments where the kubelet runs in a container and the device location should be specified. ([#58816](https://github.com/kubernetes/kubernetes/pull/58816), [@croomes](https://github.com/croomes)) -* Use consts as predicate name in handlers ([#59952](https://github.com/kubernetes/kubernetes/pull/59952), [@resouer](https://github.com/resouer)) -* `/status` and `/scale` subresources are added for custom resources. ([#55168](https://github.com/kubernetes/kubernetes/pull/55168), [@nikhita](https://github.com/nikhita)) -* Allow kubectl env to specify which keys to import from a config map ([#60040](https://github.com/kubernetes/kubernetes/pull/60040), [@PhilipGough](https://github.com/PhilipGough)) -* Set default enabled admission plugins `NamespaceLifecycle,LimitRanger,ServiceAccount,PersistentVolumeLabel,DefaultStorageClass,DefaultTolerationSeconds,MutatingAdmissionWebhook,ValidatingAdmissionWebhook,ResourceQuota` ([#58684](https://github.com/kubernetes/kubernetes/pull/58684), [@hzxuzhonghu](https://github.com/hzxuzhonghu)) -* Fix instanceID for vmss nodes. ([#59857](https://github.com/kubernetes/kubernetes/pull/59857), [@feiskyer](https://github.com/feiskyer)) -* Deprecate kubectl scale jobs (only jobs). ([#60139](https://github.com/kubernetes/kubernetes/pull/60139), [@soltysh](https://github.com/soltysh)) -* Adds new flag `--apiserver-advertise-dns-address` which is used in node kubelet.confg to point to API server ([#59288](https://github.com/kubernetes/kubernetes/pull/59288), [@stevesloka](https://github.com/stevesloka)) -* Fix kube-proxy flags validation for --healthz-bind-address and --metrics-bind-address to allow specifying ip:port. ([#54191](https://github.com/kubernetes/kubernetes/pull/54191), [@MrHohn](https://github.com/MrHohn)) -* Increase allowed lag for ssh key sync loop in tunneler to allow for one failure ([#60068](https://github.com/kubernetes/kubernetes/pull/60068), [@wojtek-t](https://github.com/wojtek-t)) -* Flags that can be set via the Kubelet's --config file are now deprecated in favor of the file. ([#60148](https://github.com/kubernetes/kubernetes/pull/60148), [@mtaufen](https://github.com/mtaufen)) -* PVC Protection alpha feature was renamed to Storage Protection. Storage Protection feature is beta. ([#59052](https://github.com/kubernetes/kubernetes/pull/59052), [@pospispa](https://github.com/pospispa)) -* kube-apiserver: the root /proxy paths have been removed (deprecated since v1.2). Use the /proxy subresources on objects that support HTTP proxying. ([#59884](https://github.com/kubernetes/kubernetes/pull/59884), [@mikedanese](https://github.com/mikedanese)) -* Set an upper bound (5 minutes) on how long the Kubelet will wait before exiting when the client cert from disk is missing or invalid. This prevents the Kubelet from waiting forever without attempting to bootstrap a new client credentials. ([#59316](https://github.com/kubernetes/kubernetes/pull/59316), [@smarterclayton](https://github.com/smarterclayton)) -* v1.Pod now has a field to configure whether a single process namespace should be shared between all containers in a pod. This feature is in alpha preview. ([#58716](https://github.com/kubernetes/kubernetes/pull/58716), [@verb](https://github.com/verb)) -* Priority admission controller picks a global default with the lowest priority value if more than one such default PriorityClass exists. ([#59991](https://github.com/kubernetes/kubernetes/pull/59991), [@bsalamat](https://github.com/bsalamat)) -* Add ipset binary for IPVS to hyperkube docker image ([#57648](https://github.com/kubernetes/kubernetes/pull/57648), [@Fsero](https://github.com/Fsero)) -* kube-apiserver: the OpenID Connect authenticator can now verify ID Tokens signed with JOSE algorithms other than RS256 through the --oidc-signing-algs flag. ([#58544](https://github.com/kubernetes/kubernetes/pull/58544), [@ericchiang](https://github.com/ericchiang)) - * kube-apiserver: the OpenID Connect authenticator no longer accepts tokens from the Google v3 token APIs, users must switch to the "https://www.googleapis.com/oauth2/v4/token" endpoint. -* Rename StorageProtection to StorageObjectInUseProtection ([#59901](https://github.com/kubernetes/kubernetes/pull/59901), [@NickrenREN](https://github.com/NickrenREN)) -* kubeadm: add criSocket field to MasterConfiguration manifiest ([#59057](https://github.com/kubernetes/kubernetes/pull/59057), [@JordanFaust](https://github.com/JordanFaust)) -* kubeadm: add criSocket field to NodeConfiguration manifiest ([#59292](https://github.com/kubernetes/kubernetes/pull/59292), [@JordanFaust](https://github.com/JordanFaust)) -* The `PodSecurityPolicy` API has been moved to the `policy/v1beta1` API group. The `PodSecurityPolicy` API in the `extensions/v1beta1` API group is deprecated and will be removed in a future release. Authorizations for using pod security policy resources should change to reference the `policy` API group after upgrading to 1.11. ([#54933](https://github.com/kubernetes/kubernetes/pull/54933), [@php-coder](https://github.com/php-coder)) -* Restores the ability of older clients to delete and scale jobs with initContainers ([#59880](https://github.com/kubernetes/kubernetes/pull/59880), [@liggitt](https://github.com/liggitt)) -* Support for resource quota on extended resources ([#57302](https://github.com/kubernetes/kubernetes/pull/57302), [@lichuqiang](https://github.com/lichuqiang)) -* Fix race causing apiserver crashes during etcd healthchecking ([#60069](https://github.com/kubernetes/kubernetes/pull/60069), [@wojtek-t](https://github.com/wojtek-t)) -* If TaintNodesByCondition enabled, taint node when it under PID pressure ([#60008](https://github.com/kubernetes/kubernetes/pull/60008), [@k82cn](https://github.com/k82cn)) -* Expose total usage of pods through the "pods" SystemContainer in the Kubelet Summary API ([#57802](https://github.com/kubernetes/kubernetes/pull/57802), [@dashpole](https://github.com/dashpole)) -* Unauthorized requests will not match audit policy rules where users or groups are set. ([#59398](https://github.com/kubernetes/kubernetes/pull/59398), [@CaoShuFeng](https://github.com/CaoShuFeng)) -* Making sure CSI E2E test runs on a local cluster ([#60017](https://github.com/kubernetes/kubernetes/pull/60017), [@sbezverk](https://github.com/sbezverk)) -* Addressing breaking changes introduced by new 0.2.0 release of CSI spec ([#59209](https://github.com/kubernetes/kubernetes/pull/59209), [@sbezverk](https://github.com/sbezverk)) -* GCE: A role and clusterrole will now be provided with GCE/GKE for allowing the cloud-provider to post warning events on all services and watching configmaps in the kube-system namespace. ([#59686](https://github.com/kubernetes/kubernetes/pull/59686), [@nicksardo](https://github.com/nicksardo)) -* Updated PID pressure node condition ([#57136](https://github.com/kubernetes/kubernetes/pull/57136), [@k82cn](https://github.com/k82cn)) -* Add AWS cloud provider option to use an assumed IAM role ([#59668](https://github.com/kubernetes/kubernetes/pull/59668), [@brycecarman](https://github.com/brycecarman)) -* `kubectl port-forward` now supports specifying a service to port forward to: `kubectl port-forward svc/myservice 8443:443` ([#59809](https://github.com/kubernetes/kubernetes/pull/59809), [@phsiao](https://github.com/phsiao)) -* Fix kubelet PVC stale metrics ([#59170](https://github.com/kubernetes/kubernetes/pull/59170), [@cofyc](https://github.com/cofyc)) -* - Separate current ARM rate limiter into read/write ([#59830](https://github.com/kubernetes/kubernetes/pull/59830), [@khenidak](https://github.com/khenidak)) - * - Improve control over how ARM rate limiter is used within Azure cloud provider -* The ConfigOK node condition has been renamed to KubeletConfigOk. ([#59905](https://github.com/kubernetes/kubernetes/pull/59905), [@mtaufen](https://github.com/mtaufen)) -* fluentd-gcp resources can be modified via a ScalingPolicy ([#59657](https://github.com/kubernetes/kubernetes/pull/59657), [@x13n](https://github.com/x13n)) -* Adding pkg/kubelet/apis/deviceplugin/v1beta1 API. ([#59588](https://github.com/kubernetes/kubernetes/pull/59588), [@jiayingz](https://github.com/jiayingz)) -* Fixes volume predicate handler for equiv class ([#59335](https://github.com/kubernetes/kubernetes/pull/59335), [@resouer](https://github.com/resouer)) -* Bugfix: vSphere Cloud Provider (VCP) does not need any special service account anymore. ([#59440](https://github.com/kubernetes/kubernetes/pull/59440), [@rohitjogvmw](https://github.com/rohitjogvmw)) -* Fixing a bug in OpenStack cloud provider, where dual stack deployments (IPv4 and IPv6) did not work well when using kubenet as the network plugin. ([#59749](https://github.com/kubernetes/kubernetes/pull/59749), [@zioproto](https://github.com/zioproto)) -* Get parent dir via canonical absolute path when trying to judge mount-point ([#58433](https://github.com/kubernetes/kubernetes/pull/58433), [@yue9944882](https://github.com/yue9944882)) -* Container runtime daemon (e.g. dockerd) logs in GCE cluster will be uploaded to stackdriver and elasticsearch with tag `container-runtime` ([#59103](https://github.com/kubernetes/kubernetes/pull/59103), [@Random-Liu](https://github.com/Random-Liu)) -* Add AzureDisk support for vmss nodes ([#59716](https://github.com/kubernetes/kubernetes/pull/59716), [@feiskyer](https://github.com/feiskyer)) -* Fixed a race condition in k8s.io/client-go/tools/cache.SharedInformer that could violate the sequential delivery guarantee and cause panics on shutdown. ([#59828](https://github.com/kubernetes/kubernetes/pull/59828), [@krousey](https://github.com/krousey)) -* Avoid hook errors when effecting label changes on kubernetes-worker charm. ([#59803](https://github.com/kubernetes/kubernetes/pull/59803), [@wwwtyro](https://github.com/wwwtyro)) -* kubectl port-forward now allows using resource name (e.g., deployment/www) to select a matching pod, as well as allows the use of --pod-running-timeout to wait till at least one pod is running. ([#59705](https://github.com/kubernetes/kubernetes/pull/59705), [@phsiao](https://github.com/phsiao)) - * kubectl port-forward no longer support deprecated -p flag -* Deprecate insecure HTTP port of kube-controller-manager and cloud-controller-manager. Use `--secure-port` and `--bind-address` instead. ([#59582](https://github.com/kubernetes/kubernetes/pull/59582), [@sttts](https://github.com/sttts)) -* Eviction thresholds set to 0% or 100% are now ignored. ([#59681](https://github.com/kubernetes/kubernetes/pull/59681), [@mtaufen](https://github.com/mtaufen)) -* [advanced audit] support subresources wildcard matching. ([#55306](https://github.com/kubernetes/kubernetes/pull/55306), [@hzxuzhonghu](https://github.com/hzxuzhonghu)) -* CronJobs can be accessed through cj alias ([#59499](https://github.com/kubernetes/kubernetes/pull/59499), [@soltysh](https://github.com/soltysh)) -* fix typo in resource_allocation.go ([#58275](https://github.com/kubernetes/kubernetes/pull/58275), [@carmark](https://github.com/carmark)) -* fix the error prone account creation method of blob disk ([#59739](https://github.com/kubernetes/kubernetes/pull/59739), [@andyzhangx](https://github.com/andyzhangx)) -* Add automatic etcd 3.2->3.1 and 3.1->3.0 minor version rollback support to gcr.io/google_container/etcd images. For HA clusters, all members must be stopped before performing a rollback. ([#59298](https://github.com/kubernetes/kubernetes/pull/59298), [@jpbetz](https://github.com/jpbetz)) -* `kubeadm init` can now omit the tainting of the master node if configured to do so in `kubeadm.yaml`. ([#55479](https://github.com/kubernetes/kubernetes/pull/55479), [@ijc](https://github.com/ijc)) -* Updated kubernetes-worker to request new security tokens when the aws cloud provider changes the registered node name. ([#59730](https://github.com/kubernetes/kubernetes/pull/59730), [@hyperbolic2346](https://github.com/hyperbolic2346)) -* Controller-manager --service-sync-period flag is removed (was never used in the code). ([#59359](https://github.com/kubernetes/kubernetes/pull/59359), [@khenidak](https://github.com/khenidak)) -* Pod priority can be specified ins PodSpec even when the feature is disabled, but it will be effective only when the feature is enabled. ([#59291](https://github.com/kubernetes/kubernetes/pull/59291), [@bsalamat](https://github.com/bsalamat)) -* kubeadm: Enable auditing behind a feature gate. ([#59067](https://github.com/kubernetes/kubernetes/pull/59067), [@chuckha](https://github.com/chuckha)) -* Map correct vmset name for Azure internal load balancers ([#59747](https://github.com/kubernetes/kubernetes/pull/59747), [@feiskyer](https://github.com/feiskyer)) -* Add generic cache for Azure VMSS ([#59652](https://github.com/kubernetes/kubernetes/pull/59652), [@feiskyer](https://github.com/feiskyer)) -* kubeadm: New "imagePullPolicy" option in the init configuration file, that gets forwarded to kubelet static pods to control pull policy for etcd and control plane images. ([#58960](https://github.com/kubernetes/kubernetes/pull/58960), [@rosti](https://github.com/rosti)) -* fix the create azure file pvc failure if there is no storage account in current resource group ([#56557](https://github.com/kubernetes/kubernetes/pull/56557), [@andyzhangx](https://github.com/andyzhangx)) -* Add generic cache for Azure VM/LB/NSG/RouteTable ([#59520](https://github.com/kubernetes/kubernetes/pull/59520), [@feiskyer](https://github.com/feiskyer)) -* The alpha KubeletConfiguration.ConfigTrialDuration field is no longer available. ([#59628](https://github.com/kubernetes/kubernetes/pull/59628), [@mtaufen](https://github.com/mtaufen)) -* Updates Calico version to v2.6.7 (Fixed a bug where Felix would crash when parsing a NetworkPolicy with a named port. See https://github.com/projectcalico/calico/releases/tag/v2.6.7) ([#59130](https://github.com/kubernetes/kubernetes/pull/59130), [@caseydavenport](https://github.com/caseydavenport)) -* return error if New-SmbGlobalMapping failed when mounting azure file on Windows ([#59540](https://github.com/kubernetes/kubernetes/pull/59540), [@andyzhangx](https://github.com/andyzhangx)) -* Disallow PriorityClass names with 'system-' prefix for user defined priority classes. ([#59382](https://github.com/kubernetes/kubernetes/pull/59382), [@bsalamat](https://github.com/bsalamat)) -* Fixed an issue where Portworx volume driver wasn't passing namespace and annotations to the Portworx Create API. ([#59607](https://github.com/kubernetes/kubernetes/pull/59607), [@harsh-px](https://github.com/harsh-px)) -* Enable apiserver metrics for custom resources. ([#57682](https://github.com/kubernetes/kubernetes/pull/57682), [@nikhita](https://github.com/nikhita)) -* fix typo ([#59619](https://github.com/kubernetes/kubernetes/pull/59619), [@jianliao82](https://github.com/jianliao82)) - * incase -> in case - * selction -> selection -* Implement envelope service with gRPC, so that KMS providers can be pulled out from API server. ([#55684](https://github.com/kubernetes/kubernetes/pull/55684), [@wu-qiang](https://github.com/wu-qiang)) -* Enable golint for `pkg/scheduler` and fix the golint errors in it. ([#58437](https://github.com/kubernetes/kubernetes/pull/58437), [@tossmilestone](https://github.com/tossmilestone)) -* AWS: Make attach/detach operations faster. from 10-12s to 2-6s ([#56974](https://github.com/kubernetes/kubernetes/pull/56974), [@gnufied](https://github.com/gnufied)) -* CRI starts using moutpoint as image filesystem identifier instead of UUID. ([#59475](https://github.com/kubernetes/kubernetes/pull/59475), [@Random-Liu](https://github.com/Random-Liu)) -* DaemonSet, Deployment, ReplicaSet, and StatefulSet objects are now persisted in etcd in apps/v1 format ([#58854](https://github.com/kubernetes/kubernetes/pull/58854), [@liggitt](https://github.com/liggitt)) -* 'none' can now be specified in KubeletConfiguration.EnforceNodeAllocatable (--enforce-node-allocatable) to explicitly disable enforcement. ([#59515](https://github.com/kubernetes/kubernetes/pull/59515), [@mtaufen](https://github.com/mtaufen)) -* vSphere Cloud Provider supports VMs provisioned on vSphere v1.6.5 ([#59519](https://github.com/kubernetes/kubernetes/pull/59519), [@abrarshivani](https://github.com/abrarshivani)) -* Annotations is added to advanced audit api ([#58806](https://github.com/kubernetes/kubernetes/pull/58806), [@CaoShuFeng](https://github.com/CaoShuFeng)) -* 2nd try at using a vanity GCR name ([#57824](https://github.com/kubernetes/kubernetes/pull/57824), [@thockin](https://github.com/thockin)) -* Node's providerID is following Azure resource ID format now when useInstanceMetadata is enabled ([#59539](https://github.com/kubernetes/kubernetes/pull/59539), [@feiskyer](https://github.com/feiskyer)) -* Block Volume Support: Local Volume Plugin update ([#59303](https://github.com/kubernetes/kubernetes/pull/59303), [@dhirajh](https://github.com/dhirajh)) -* [action-required] The Container Runtime Interface (CRI) version has increased from v1alpha1 to v1alpha2. Runtimes implementing the CRI will need to update to the new version, which configures container namespaces using an enumeration rather than booleans. ([#58973](https://github.com/kubernetes/kubernetes/pull/58973), [@verb](https://github.com/verb)) -* Fix the bug where kubelet in the standalone mode would wait for the update from the apiserver source. ([#59276](https://github.com/kubernetes/kubernetes/pull/59276), [@roboll](https://github.com/roboll)) -* Add "keyring" parameter for Ceph RBD provisioner ([#58287](https://github.com/kubernetes/kubernetes/pull/58287), [@madddi](https://github.com/madddi)) -* Ensure euqiv hash calculation is per schedule ([#59245](https://github.com/kubernetes/kubernetes/pull/59245), [@resouer](https://github.com/resouer)) -* kube-scheduler: Use default predicates/prioritizers if they are unspecified in the policy config ([#59363](https://github.com/kubernetes/kubernetes/pull/59363), [@yguo0905](https://github.com/yguo0905)) -* Fixed charm issue where docker login would run prior to daemon options being set. ([#59396](https://github.com/kubernetes/kubernetes/pull/59396), [@kwmonroe](https://github.com/kwmonroe)) -* Implementers of the cloud provider interface will note the addition of a context to this interface. Trivial code modification will be necessary for a cloud provider to continue to compile. ([#59287](https://github.com/kubernetes/kubernetes/pull/59287), [@cheftako](https://github.com/cheftako)) -* /release-note-none ([#58264](https://github.com/kubernetes/kubernetes/pull/58264), [@WanLinghao](https://github.com/WanLinghao)) -* Use a more reliable way to get total physical memory on windows nodes ([#57124](https://github.com/kubernetes/kubernetes/pull/57124), [@JiangtianLi](https://github.com/JiangtianLi)) -* Add xfsprogs to hyperkube container image. ([#56937](https://github.com/kubernetes/kubernetes/pull/56937), [@redbaron](https://github.com/redbaron)) -* Ensure Azure public IP removed after service deleted ([#59340](https://github.com/kubernetes/kubernetes/pull/59340), [@feiskyer](https://github.com/feiskyer)) -* Improve messages user gets during and after volume resizing is done. ([#58415](https://github.com/kubernetes/kubernetes/pull/58415), [@gnufied](https://github.com/gnufied)) -* Fix RBAC permissions for Stackdriver Metadata Agent. ([#57455](https://github.com/kubernetes/kubernetes/pull/57455), [@kawych](https://github.com/kawych)) -* Scheduler should be able to read from config file if configmap is not present. ([#59386](https://github.com/kubernetes/kubernetes/pull/59386), [@ravisantoshgudimetla](https://github.com/ravisantoshgudimetla)) -* MountPropagation feature is now beta. As consequence, all volume mounts in containers are now "rslave" on Linux by default. ([#59252](https://github.com/kubernetes/kubernetes/pull/59252), [@jsafrane](https://github.com/jsafrane)) -* Fix RBAC role for certificate controller to allow cleaning. ([#59375](https://github.com/kubernetes/kubernetes/pull/59375), [@mikedanese](https://github.com/mikedanese)) -* Volume metrics support for vSphere Cloud Provider ([#59328](https://github.com/kubernetes/kubernetes/pull/59328), [@divyenpatel](https://github.com/divyenpatel)) -* Announcing the deprecation of the recycling reclaim policy. ([#59063](https://github.com/kubernetes/kubernetes/pull/59063), [@ayushpateria](https://github.com/ayushpateria)) -* Intended for post-1.9 ([#57872](https://github.com/kubernetes/kubernetes/pull/57872), [@mlmhl](https://github.com/mlmhl)) -* The `meta.k8s.io/v1alpha1` objects for retrieving tabular responses from the server (`Table`) or fetching just the `ObjectMeta` for an object (as `PartialObjectMetadata`) are now beta as part of `meta.k8s.io/v1beta1`. Clients may request alternate representations of normal Kubernetes objects by passing an `Accept` header like `application/json;as=Table;g=meta.k8s.io;v=v1beta1` or `application/json;as=PartialObjectMetadata;g=meta.k8s.io;v1=v1beta1`. Older servers will ignore this representation or return an error if it is not available. Clients may request fallback to the normal object by adding a non-qualified mime-type to their `Accept` header like `application/json` - the server will then respond with either the alternate representation if it is supported or the fallback mime-type which is the normal object response. ([#59059](https://github.com/kubernetes/kubernetes/pull/59059), [@smarterclayton](https://github.com/smarterclayton)) -* add PV size grow feature for azure file ([#57017](https://github.com/kubernetes/kubernetes/pull/57017), [@andyzhangx](https://github.com/andyzhangx)) -* Upgrade default etcd server version to 3.2.14 ([#58645](https://github.com/kubernetes/kubernetes/pull/58645), [@jpbetz](https://github.com/jpbetz)) -* Add windows config to Kubelet CRI ([#57076](https://github.com/kubernetes/kubernetes/pull/57076), [@feiskyer](https://github.com/feiskyer)) -* Configurable etcd quota backend bytes in GCE ([#59259](https://github.com/kubernetes/kubernetes/pull/59259), [@wojtek-t](https://github.com/wojtek-t)) -* Remove unmaintained kube-registry-proxy support from gce kube-up. ([#58564](https://github.com/kubernetes/kubernetes/pull/58564), [@mikedanese](https://github.com/mikedanese)) -* Allow expanding mounted volumes ([#58794](https://github.com/kubernetes/kubernetes/pull/58794), [@gnufied](https://github.com/gnufied)) -* Upped the timeout for apiserver communication in the juju kubernetes-worker charm. ([#59219](https://github.com/kubernetes/kubernetes/pull/59219), [@hyperbolic2346](https://github.com/hyperbolic2346)) -* kubeadm init: skip checking cri socket in preflight checks ([#58802](https://github.com/kubernetes/kubernetes/pull/58802), [@dixudx](https://github.com/dixudx)) -* Add "nominatedNodeName" field to PodStatus. This field is set when a pod preempts other pods on the node. ([#58990](https://github.com/kubernetes/kubernetes/pull/58990), [@bsalamat](https://github.com/bsalamat)) -* Changes secret, configMap, downwardAPI and projected volumes to mount read-only, instead of allowing applications to write data and then reverting it automatically. Until version 1.11, setting the feature gate ReadOnlyAPIDataVolumes=false will preserve the old behavior. ([#58720](https://github.com/kubernetes/kubernetes/pull/58720), [@joelsmith](https://github.com/joelsmith)) -* Fixed issue with charm upgrades resulting in an error state. ([#59064](https://github.com/kubernetes/kubernetes/pull/59064), [@hyperbolic2346](https://github.com/hyperbolic2346)) -* Ensure IP is set for Azure internal load balancer. ([#59083](https://github.com/kubernetes/kubernetes/pull/59083), [@feiskyer](https://github.com/feiskyer)) -* Postpone PV deletion when it is being bound to a PVC ([#58743](https://github.com/kubernetes/kubernetes/pull/58743), [@NickrenREN](https://github.com/NickrenREN)) -* Add V1beta1 VolumeAttachment API, co-existing with Alpha API object ([#58462](https://github.com/kubernetes/kubernetes/pull/58462), [@NickrenREN](https://github.com/NickrenREN)) -* When using client or server certificate rotation, the Kubelet will no longer wait until the initial rotation succeeds or fails before starting static pods. This makes running self-hosted masters with rotation more predictable. ([#58930](https://github.com/kubernetes/kubernetes/pull/58930), [@smarterclayton](https://github.com/smarterclayton)) - - - -# v1.10.0-alpha.3 - -[Documentation](https://docs.k8s.io) & [Examples](https://releases.k8s.io/master/examples) - -## Downloads for v1.10.0-alpha.3 - - -filename | sha256 hash --------- | ----------- -[kubernetes.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes.tar.gz) | `246f0373ccb25a243a387527b32354b69fc2211c422e71479d22bfb3a829c8fb` -[kubernetes-src.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-src.tar.gz) | `f9c60bb37fb7b363c9f66d8efd8aa5a36ea2093c61317c950719b3ddc86c5e10` - -### Client Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-client-darwin-386.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-client-darwin-386.tar.gz) | `ca8dfd7fbd34478e7ba9bba3779fcca08f7efd4f218b0c8a7f52bbeea0f42cd7` -[kubernetes-client-darwin-amd64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-client-darwin-amd64.tar.gz) | `713c35d99f44bd19d225d2c9f2d7c4f3976b5dd76e9a817b2aaf68ee0cb5a939` -[kubernetes-client-linux-386.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-client-linux-386.tar.gz) | `7601e55e3bb0f0fc11611c68c4bc000c3cbbb7a09652c386e482a1671be7e2d6` -[kubernetes-client-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-client-linux-amd64.tar.gz) | `8a6c498531c1832176e22d622008a98bac6043f05dec96747649651531ed3fd7` -[kubernetes-client-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-client-linux-arm64.tar.gz) | `81561820fb5a000152e9d8d94882e0ed6228025ea7973ee98173b5fc89d62a42` -[kubernetes-client-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-client-linux-arm.tar.gz) | `6ce8c3ed253a10d78e62e000419653a29c411cd64910325b21ff3370cb0a89eb` -[kubernetes-client-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-client-linux-ppc64le.tar.gz) | `a46b42c94040767f6bbf2ce10aef36d8dbe94c0069f866a848d69b2274f8f0bc` -[kubernetes-client-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-client-linux-s390x.tar.gz) | `fa3e656b612277fc4c303aef95c60b58ed887e36431db23d26b536f226a23cf6` -[kubernetes-client-windows-386.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-client-windows-386.tar.gz) | `832e12266495ac55cb54a999bc5ae41d42d160387b487d8b4ead577d96686b62` -[kubernetes-client-windows-amd64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-client-windows-amd64.tar.gz) | `7056a3eb5a8f9e8fa0326aa6e0bf97fc5b260447315f8ec7340be5747a16f5fd` - -### Server Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-server-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-server-linux-amd64.tar.gz) | `dc8e2be2fcb6477249621fb5c813c853371a3bf8732c5cb3a6d6cab667cfa324` -[kubernetes-server-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-server-linux-arm64.tar.gz) | `399071ad9042a72bccd6e1aa322405c02b4a807c0b4f987d608c4c9c369979d6` -[kubernetes-server-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-server-linux-arm.tar.gz) | `7457ad16665e331fa9224a3d61690206723721197ad9760c3b488de9602293f5` -[kubernetes-server-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-server-linux-ppc64le.tar.gz) | `ffcb728d879c0347bd751c9bccac3520bb057d203ba1acd55f8c727295282049` -[kubernetes-server-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-server-linux-s390x.tar.gz) | `f942f6e15886a1fb0d91d04adf47677068c56070dff060f38c371c3ee3e99648` - -### Node Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-node-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-node-linux-amd64.tar.gz) | `81b22beb30be9d270016c7b35b86ea585f29c0c5f09128da9341f9f67c8865f9` -[kubernetes-node-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-node-linux-arm64.tar.gz) | `d9020b99c145f44c519b1a95b55ed24e69d9c679a02352c7e05e86042daca9d1` -[kubernetes-node-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-node-linux-arm.tar.gz) | `1d10bee4ed62d70b318f5703b2cd8295a08e199f810d6b361f367907e3f01fb6` -[kubernetes-node-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-node-linux-ppc64le.tar.gz) | `67cd4dde212abda37e6f9e6dee1bb59db96e0727100ef0aa561c15562df0f3e1` -[kubernetes-node-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-node-linux-s390x.tar.gz) | `362b030e011ea6222b1f2dec62311d3971bcce4dba94997963e2a091efbf967b` -[kubernetes-node-windows-amd64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.3/kubernetes-node-windows-amd64.tar.gz) | `e609a2b0410acbb64d3ee6d7f134d98723d82d05bdbead1eaafd3584d3e45c39` - -## Changelog since v1.10.0-alpha.2 - -### Other notable changes - -* Fixed issue with kubernetes-worker option allow-privileged not properly handling the value True with a capital T. ([#59116](https://github.com/kubernetes/kubernetes/pull/59116), [@hyperbolic2346](https://github.com/hyperbolic2346)) -* Added anti-affinity to kube-dns pods ([#57683](https://github.com/kubernetes/kubernetes/pull/57683), [@vainu-arto](https://github.com/vainu-arto)) -* cloudprovider/openstack: fix bug the tries to use octavia client to query flip ([#59075](https://github.com/kubernetes/kubernetes/pull/59075), [@jrperritt](https://github.com/jrperritt)) -* Windows containers now support experimental Hyper-V isolation by setting annotation `experimental.windows.kubernetes.io/isolation-type=hyperv` and feature gates HyperVContainer. Only one container per pod is supported yet. ([#58751](https://github.com/kubernetes/kubernetes/pull/58751), [@feiskyer](https://github.com/feiskyer)) -* `crds` is added as a shortname for CustomResourceDefinition i.e. `kubectl get crds` can now be used. ([#59061](https://github.com/kubernetes/kubernetes/pull/59061), [@nikhita](https://github.com/nikhita)) -* Fix an issue where port forwarding doesn't forward local TCP6 ports to the pod ([#57457](https://github.com/kubernetes/kubernetes/pull/57457), [@vfreex](https://github.com/vfreex)) -* YAMLDecoder Read now tracks rest of buffer on io.ErrShortBuffer ([#58817](https://github.com/kubernetes/kubernetes/pull/58817), [@karlhungus](https://github.com/karlhungus)) -* Prevent kubelet from getting wedged if initialization of modules returns an error. ([#59020](https://github.com/kubernetes/kubernetes/pull/59020), [@brendandburns](https://github.com/brendandburns)) -* Fixed a race condition inside kubernetes-worker that would result in a temporary error situation. ([#59005](https://github.com/kubernetes/kubernetes/pull/59005), [@hyperbolic2346](https://github.com/hyperbolic2346)) -* [GCE] Apiserver uses `InternalIP` as the most preferred kubelet address type by default. ([#59019](https://github.com/kubernetes/kubernetes/pull/59019), [@MrHohn](https://github.com/MrHohn)) -* Deprecate insecure flags `--insecure-bind-address`, `--insecure-port` and remove `--public-address-override`. ([#59018](https://github.com/kubernetes/kubernetes/pull/59018), [@hzxuzhonghu](https://github.com/hzxuzhonghu)) -* Support GetLabelsForVolume in OpenStack Provider ([#58871](https://github.com/kubernetes/kubernetes/pull/58871), [@edisonxiang](https://github.com/edisonxiang)) -* Build using go1.9.3. ([#59012](https://github.com/kubernetes/kubernetes/pull/59012), [@ixdy](https://github.com/ixdy)) -* CRI: Add a call to reopen log file for a container. ([#58899](https://github.com/kubernetes/kubernetes/pull/58899), [@yujuhong](https://github.com/yujuhong)) -* The alpha KubeletConfigFile feature gate has been removed, because it was redundant with the Kubelet's --config flag. It is no longer necessary to set this gate to use the flag. The --config flag is still considered alpha. ([#58978](https://github.com/kubernetes/kubernetes/pull/58978), [@mtaufen](https://github.com/mtaufen)) -* `kubectl scale` can now scale any resource (kube, CRD, aggregate) conforming to the standard scale endpoint ([#58298](https://github.com/kubernetes/kubernetes/pull/58298), [@p0lyn0mial](https://github.com/p0lyn0mial)) -* kube-apiserver flag --tls-ca-file has had no effect for some time. It is now deprecated and slated for removal in 1.11. If you are specifying this flag, you must remove it from your launch config before upgrading to 1.11. ([#58968](https://github.com/kubernetes/kubernetes/pull/58968), [@deads2k](https://github.com/deads2k)) -* Fix regression in the CRI: do not add a default hostname on short image names ([#58955](https://github.com/kubernetes/kubernetes/pull/58955), [@runcom](https://github.com/runcom)) -* Get windows kernel version directly from registry ([#58498](https://github.com/kubernetes/kubernetes/pull/58498), [@feiskyer](https://github.com/feiskyer)) -* Remove deprecated --require-kubeconfig flag, remove default --kubeconfig value ([#58367](https://github.com/kubernetes/kubernetes/pull/58367), [@zhangxiaoyu-zidif](https://github.com/zhangxiaoyu-zidif)) -* Google Cloud Service Account email addresses can now be used in RBAC ([#58141](https://github.com/kubernetes/kubernetes/pull/58141), [@ahmetb](https://github.com/ahmetb)) - * Role bindings since the default scopes now include the "userinfo.email" - * scope. This is a breaking change if the numeric uniqueIDs of the Google - * service accounts were being used in RBAC role bindings. The behavior - * can be overridden by explicitly specifying the scope values as - * comma-separated string in the "users[*].config.scopes" field in the - * KUBECONFIG file. -* kube-apiserver is changed to use SSH tunnels for webhook iff the webhook is not directly routable from apiserver's network environment. ([#58644](https://github.com/kubernetes/kubernetes/pull/58644), [@yguo0905](https://github.com/yguo0905)) -* Updated priority of mirror pod according to PriorityClassName. ([#58485](https://github.com/kubernetes/kubernetes/pull/58485), [@k82cn](https://github.com/k82cn)) -* Fixes a bug where kubelet crashes trying to free memory under memory pressure ([#58574](https://github.com/kubernetes/kubernetes/pull/58574), [@yastij](https://github.com/yastij)) - - - -# v1.10.0-alpha.2 - -[Documentation](https://docs.k8s.io) & [Examples](https://releases.k8s.io/master/examples) - -## Downloads for v1.10.0-alpha.2 - - -filename | sha256 hash --------- | ----------- -[kubernetes.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes.tar.gz) | `89efeb8b16c40e5074f092f51399995f0fe4a0312367a8f54bd227c3c6fcb629` -[kubernetes-src.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-src.tar.gz) | `eefbbf435f1b7a0e416f4e6b2c936c49ce5d692994da8d235c5e25bc408eec57` - -### Client Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-client-darwin-386.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-client-darwin-386.tar.gz) | `878366200ddfb9128a133d7d377057c6f878b24357062cf5243c0f0aac26b292` -[kubernetes-client-darwin-amd64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-client-darwin-amd64.tar.gz) | `dc065b9ecfa513607eac6e7dd125b2c25c9a9e7c13d0b2b6e56586e17bbd6ae5` -[kubernetes-client-linux-386.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-client-linux-386.tar.gz) | `93c2462051935d8f6bca6c72d09948963d47cd64426660f63e0cea7d37e24812` -[kubernetes-client-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-client-linux-amd64.tar.gz) | `0eef61285fad1f9ff8392c59986d3a41887abc642bcb5cb451c5a5300927e2c4` -[kubernetes-client-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-client-linux-arm64.tar.gz) | `6cf7913730a57b503beaf37f5c4d0f97789358983ed03654036f8b986b60cc62` -[kubernetes-client-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-client-linux-arm.tar.gz) | `f03c3ecbf4c08d263f2daa8cbe838e20452d6650b80e9a74762c155c26a579b7` -[kubernetes-client-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-client-linux-ppc64le.tar.gz) | `25a2f93ebb721901d262adae4c0bdaa4cf1293793e9dff4507e031b85f46aff8` -[kubernetes-client-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-client-linux-s390x.tar.gz) | `3e0b9ef771f36edb61bd61ccb67996ed41793c01f8686509bf93e585ee882c94` -[kubernetes-client-windows-386.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-client-windows-386.tar.gz) | `387e5e6b0535f4f5996c0732f1b591d80691acaec86e35482c7b90e00a1856f7` -[kubernetes-client-windows-amd64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-client-windows-amd64.tar.gz) | `c10a72d40252707b732d33d03beec3c6380802d0a6e3214cbbf4af258fddf28c` - -### Server Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-server-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-server-linux-amd64.tar.gz) | `42c1e016e8b0c5cc36c7bf574abca18c63e16d719d35e19ddbcbcd5aaeabc46c` -[kubernetes-server-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-server-linux-arm64.tar.gz) | `b7774c54344c75bf5c703d4ca271f0af6c230e86cbe40eafd9cbf98a4f4be6e9` -[kubernetes-server-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-server-linux-arm.tar.gz) | `c11c8554506b64d6fd1a6e79bfc4e1e19f4f826b9ba98de81bc757901e8cdc43` -[kubernetes-server-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-server-linux-ppc64le.tar.gz) | `196bd957804b2a9049189d225e49bf78e52e9adef12c072128e4e85d35da438e` -[kubernetes-server-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-server-linux-s390x.tar.gz) | `be12fbea28a6cb089734782fe11e6f90a30785b9ad1ec02bc08a59afeb95c173` - -### Node Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-node-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-node-linux-amd64.tar.gz) | `a1feb239dfc473b49adf95d7d94e4a9c6c7d07416d4e935e3fc10175ffaa7163` -[kubernetes-node-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-node-linux-arm64.tar.gz) | `26583c0bd08313bdc0bdfba6745f3ccd0f117431d3a5e2623bb5015675d506b8` -[kubernetes-node-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-node-linux-arm.tar.gz) | `79c6299a5482467e3e85ee881f21edf5d491bc28c94e547d9297d1e1ad1b7458` -[kubernetes-node-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-node-linux-ppc64le.tar.gz) | `2732fd288f1eac44c599423ce28cbdb85b54a646970a3714be5ff86d1b14b5e2` -[kubernetes-node-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-node-linux-s390x.tar.gz) | `8d49432f0ff3baf55e71c29fb6ffc1673b2a45b9eae2e1906138b1409da53940` -[kubernetes-node-windows-amd64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.2/kubernetes-node-windows-amd64.tar.gz) | `15ff74edfa98cd1afadcc4e53dd592b1e2935fbab76ad731309d355ae23bdd09` - -## Changelog since v1.10.0-alpha.1 - -### Action Required - -* Bug fix: webhooks now do not skip cluster-scoped resources ([#58185](https://github.com/kubernetes/kubernetes/pull/58185), [@caesarxuchao](https://github.com/caesarxuchao)) - * Action required: Before upgrading your Kubernetes clusters, double check if you had configured webhooks for cluster-scoped objects (e.g., nodes, persistentVolume), these webhooks will start to take effect. Delete/modify the configs if that's not desirable. - -### Other notable changes - -* Fixing extra_sans option on master and load balancer. ([#58843](https://github.com/kubernetes/kubernetes/pull/58843), [@hyperbolic2346](https://github.com/hyperbolic2346)) -* ConfigMap objects now support binary data via a new `binaryData` field. When using `kubectl create configmap --from-file`, files containing non-UTF8 data will be placed in this new field in order to preserve the non-UTF8 data. Use of this feature requires 1.10+ apiserver and kubelets. ([#57938](https://github.com/kubernetes/kubernetes/pull/57938), [@dims](https://github.com/dims)) -* New alpha feature to limit the number of processes running in a pod. Cluster administrators will be able to place limits by using the new kubelet command line parameter --pod-max-pids. Note that since this is a alpha feature they will need to enable the "SupportPodPidsLimit" feature. ([#57973](https://github.com/kubernetes/kubernetes/pull/57973), [@dims](https://github.com/dims)) -* Add storage-backend configuration option to kubernetes-master charm. ([#58830](https://github.com/kubernetes/kubernetes/pull/58830), [@wwwtyro](https://github.com/wwwtyro)) -* use containing API group when resolving shortname from discovery ([#58741](https://github.com/kubernetes/kubernetes/pull/58741), [@dixudx](https://github.com/dixudx)) -* Fix kubectl explain for resources not existing in default version of API group ([#58753](https://github.com/kubernetes/kubernetes/pull/58753), [@soltysh](https://github.com/soltysh)) -* Ensure config has been created before attempting to launch ingress. ([#58756](https://github.com/kubernetes/kubernetes/pull/58756), [@wwwtyro](https://github.com/wwwtyro)) -* Access to externally managed IP addresses via the kube-apiserver service proxy subresource is no longer allowed by default. This can be re-enabled via the `ServiceProxyAllowExternalIPs` feature gate, but will be disallowed completely in 1.11 ([#57265](https://github.com/kubernetes/kubernetes/pull/57265), [@brendandburns](https://github.com/brendandburns)) -* Added support for external cloud providers in kubeadm ([#58259](https://github.com/kubernetes/kubernetes/pull/58259), [@dims](https://github.com/dims)) -* rktnetes has been deprecated in favor of rktlet. Please see https://github.com/kubernetes-incubator/rktlet for more information. ([#58418](https://github.com/kubernetes/kubernetes/pull/58418), [@yujuhong](https://github.com/yujuhong)) -* Fixes bug finding master replicas in GCE when running multiple Kubernetes clusters ([#58561](https://github.com/kubernetes/kubernetes/pull/58561), [@jesseshieh](https://github.com/jesseshieh)) -* Update Calico version to v2.6.6 ([#58482](https://github.com/kubernetes/kubernetes/pull/58482), [@tmjd](https://github.com/tmjd)) -* Promoting the apiregistration.k8s.io (aggregation) to GA ([#58393](https://github.com/kubernetes/kubernetes/pull/58393), [@deads2k](https://github.com/deads2k)) -* Stability: Make Pod delete event handling of scheduler more robust. ([#58712](https://github.com/kubernetes/kubernetes/pull/58712), [@bsalamat](https://github.com/bsalamat)) -* Added support for network spaces in the kubeapi-load-balancer charm ([#58708](https://github.com/kubernetes/kubernetes/pull/58708), [@hyperbolic2346](https://github.com/hyperbolic2346)) -* Added support for network spaces in the kubernetes-master charm ([#58704](https://github.com/kubernetes/kubernetes/pull/58704), [@hyperbolic2346](https://github.com/hyperbolic2346)) -* update etcd unified version to 3.1.10 ([#54242](https://github.com/kubernetes/kubernetes/pull/54242), [@zouyee](https://github.com/zouyee)) -* updates fluentd in fluentd-es-image to fluentd 1.1.0 ([#58525](https://github.com/kubernetes/kubernetes/pull/58525), [@monotek](https://github.com/monotek)) -* Support metrics API in `kubectl top` commands. ([#56206](https://github.com/kubernetes/kubernetes/pull/56206), [@brancz](https://github.com/brancz)) -* Added support for network spaces in the kubernetes-worker charm ([#58523](https://github.com/kubernetes/kubernetes/pull/58523), [@hyperbolic2346](https://github.com/hyperbolic2346)) -* CustomResourceDefinitions: OpenAPI v3 validation schemas containing `$ref`references are no longer permitted (valid references could not be constructed previously because property ids were not permitted either). Before upgrading, ensure CRD definitions do not include those `$ref` fields. ([#58438](https://github.com/kubernetes/kubernetes/pull/58438), [@carlory](https://github.com/carlory)) -* Openstack: register metadata.hostname as node name ([#58502](https://github.com/kubernetes/kubernetes/pull/58502), [@dixudx](https://github.com/dixudx)) -* Added nginx and default backend images to kubernetes-worker config. ([#58542](https://github.com/kubernetes/kubernetes/pull/58542), [@hyperbolic2346](https://github.com/hyperbolic2346)) -* --tls-min-version on kubelet and kube-apiserver allow for configuring minimum TLS versions ([#58528](https://github.com/kubernetes/kubernetes/pull/58528), [@deads2k](https://github.com/deads2k)) -* Fixes an issue where the resourceVersion of an object in a DELETE watch event was not the resourceVersion of the delete itself, but of the last update to the object. This could disrupt the ability of clients clients to re-establish watches properly. ([#58547](https://github.com/kubernetes/kubernetes/pull/58547), [@liggitt](https://github.com/liggitt)) -* Fixed crash in kubectl cp when path has multiple leading slashes ([#58144](https://github.com/kubernetes/kubernetes/pull/58144), [@tomerf](https://github.com/tomerf)) -* kube-apiserver: requests to endpoints handled by unavailable extension API servers (as indicated by an `Available` condition of `false` in the registered APIService) now return `503` errors instead of `404` errors. ([#58070](https://github.com/kubernetes/kubernetes/pull/58070), [@weekface](https://github.com/weekface)) -* Correctly handle transient connection reset errors on GET requests from client library. ([#58520](https://github.com/kubernetes/kubernetes/pull/58520), [@porridge](https://github.com/porridge)) -* Authentication information for OpenStack cloud provider can now be specified as environment variables ([#58300](https://github.com/kubernetes/kubernetes/pull/58300), [@dims](https://github.com/dims)) -* Bump GCE metadata proxy to v0.1.9 to pick up security fixes. ([#58221](https://github.com/kubernetes/kubernetes/pull/58221), [@ihmccreery](https://github.com/ihmccreery)) -* - kubeadm now supports CIDR notations in NO_PROXY environment variable ([#53895](https://github.com/kubernetes/kubernetes/pull/53895), [@kad](https://github.com/kad)) -* kubeadm now accept `--apiserver-extra-args`, `--controller-manager-extra-args` and `--scheduler-extra-args` to override / specify additional flags for control plane components ([#58080](https://github.com/kubernetes/kubernetes/pull/58080), [@simonferquel](https://github.com/simonferquel)) -* Add `--enable-admission-plugin` `--disable-admission-plugin` flags and deprecate `--admission-control`. ([#58123](https://github.com/kubernetes/kubernetes/pull/58123), [@hzxuzhonghu](https://github.com/hzxuzhonghu)) - * Afterwards, don't care about the orders specified in the flags. -* "ExternalTrafficLocalOnly" has been removed from feature gate. It has been a GA feature since v1.7. ([#56948](https://github.com/kubernetes/kubernetes/pull/56948), [@MrHohn](https://github.com/MrHohn)) -* GCP: allow a master to not include a metadata concealment firewall rule (if it's not running the metadata proxy). ([#58104](https://github.com/kubernetes/kubernetes/pull/58104), [@ihmccreery](https://github.com/ihmccreery)) -* kube-apiserver: fixes loading of `--admission-control-config-file` containing AdmissionConfiguration apiserver.k8s.io/v1alpha1 config object ([#58439](https://github.com/kubernetes/kubernetes/pull/58439), [@liggitt](https://github.com/liggitt)) -* Fix issue when using OpenStack config drive for node metadata ([#57561](https://github.com/kubernetes/kubernetes/pull/57561), [@dims](https://github.com/dims)) -* Add FSType for CSI volume source to specify filesystems ([#58209](https://github.com/kubernetes/kubernetes/pull/58209), [@NickrenREN](https://github.com/NickrenREN)) -* OpenStack cloudprovider: Ensure orphaned routes are removed. ([#56258](https://github.com/kubernetes/kubernetes/pull/56258), [@databus23](https://github.com/databus23)) -* Reduce Metrics Server memory requirement ([#58391](https://github.com/kubernetes/kubernetes/pull/58391), [@kawych](https://github.com/kawych)) -* Fix a bug affecting nested data volumes such as secret, configmap, etc. ([#57422](https://github.com/kubernetes/kubernetes/pull/57422), [@joelsmith](https://github.com/joelsmith)) -* kubectl now enforces required flags at a more fundamental level ([#53631](https://github.com/kubernetes/kubernetes/pull/53631), [@dixudx](https://github.com/dixudx)) -* Remove alpha Initializers from kubadm admission control ([#58428](https://github.com/kubernetes/kubernetes/pull/58428), [@dixudx](https://github.com/dixudx)) -* Enable ValidatingAdmissionWebhook and MutatingAdmissionWebhook in kubeadm from v1.9 ([#58255](https://github.com/kubernetes/kubernetes/pull/58255), [@dixudx](https://github.com/dixudx)) -* Fixed encryption key and encryption provider rotation ([#58375](https://github.com/kubernetes/kubernetes/pull/58375), [@liggitt](https://github.com/liggitt)) -* set fsGroup by securityContext.fsGroup in azure file ([#58316](https://github.com/kubernetes/kubernetes/pull/58316), [@andyzhangx](https://github.com/andyzhangx)) -* Remove deprecated and unmaintained salt support. kubernetes-salt.tar.gz will no longer be published in the release tarball. ([#58248](https://github.com/kubernetes/kubernetes/pull/58248), [@mikedanese](https://github.com/mikedanese)) -* Detach and clear bad disk URI ([#58345](https://github.com/kubernetes/kubernetes/pull/58345), [@rootfs](https://github.com/rootfs)) -* Allow version arg in kubeadm upgrade apply to be optional if config file already have version info ([#53220](https://github.com/kubernetes/kubernetes/pull/53220), [@medinatiger](https://github.com/medinatiger)) -* feat(fakeclient): push event on watched channel on add/update/delete ([#57504](https://github.com/kubernetes/kubernetes/pull/57504), [@yue9944882](https://github.com/yue9944882)) -* Custom resources can now be submitted to and received from the API server in application/yaml format, consistent with other API resources. ([#58260](https://github.com/kubernetes/kubernetes/pull/58260), [@liggitt](https://github.com/liggitt)) -* remove spaces from kubectl describe hpa ([#56331](https://github.com/kubernetes/kubernetes/pull/56331), [@shiywang](https://github.com/shiywang)) -* fluentd-gcp updated to version 2.0.14. ([#58224](https://github.com/kubernetes/kubernetes/pull/58224), [@zombiezen](https://github.com/zombiezen)) -* Instrument the Azure cloud provider for Prometheus monitoring. ([#58204](https://github.com/kubernetes/kubernetes/pull/58204), [@cosmincojocar](https://github.com/cosmincojocar)) -* -Add scheduler optimization options, short circuit all predicates if … ([#56926](https://github.com/kubernetes/kubernetes/pull/56926), [@wgliang](https://github.com/wgliang)) -* Remove deprecated ContainerVM support from GCE kube-up. ([#58247](https://github.com/kubernetes/kubernetes/pull/58247), [@mikedanese](https://github.com/mikedanese)) -* Remove deprecated kube-push.sh functionality. ([#58246](https://github.com/kubernetes/kubernetes/pull/58246), [@mikedanese](https://github.com/mikedanese)) -* The getSubnetIDForLB() should return subnet id rather than net id. ([#58208](https://github.com/kubernetes/kubernetes/pull/58208), [@FengyunPan](https://github.com/FengyunPan)) -* Avoid panic when failing to allocate a Cloud CIDR (aka GCE Alias IP Range). ([#58186](https://github.com/kubernetes/kubernetes/pull/58186), [@negz](https://github.com/negz)) -* Handle Unhealthy devices ([#57266](https://github.com/kubernetes/kubernetes/pull/57266), [@vikaschoudhary16](https://github.com/vikaschoudhary16)) -* Expose Metrics Server metrics via /metric endpoint. ([#57456](https://github.com/kubernetes/kubernetes/pull/57456), [@kawych](https://github.com/kawych)) -* Remove deprecated container-linux support in gce kube-up.sh. ([#58098](https://github.com/kubernetes/kubernetes/pull/58098), [@mikedanese](https://github.com/mikedanese)) -* openstack cinder detach problem is fixed if nova is shutdowned ([#56846](https://github.com/kubernetes/kubernetes/pull/56846), [@zetaab](https://github.com/zetaab)) -* Fixes a possible deadlock preventing quota from being recalculated ([#58107](https://github.com/kubernetes/kubernetes/pull/58107), [@ironcladlou](https://github.com/ironcladlou)) -* fluentd-es addon: multiline stacktraces are now grouped into one entry automatically ([#58063](https://github.com/kubernetes/kubernetes/pull/58063), [@monotek](https://github.com/monotek)) -* GCE: Allows existing internal load balancers to continue using an outdated subnetwork ([#57861](https://github.com/kubernetes/kubernetes/pull/57861), [@nicksardo](https://github.com/nicksardo)) -* ignore images in used by running containers when GC ([#57020](https://github.com/kubernetes/kubernetes/pull/57020), [@dixudx](https://github.com/dixudx)) -* Remove deprecated and unmaintained photon-controller kube-up.sh. ([#58096](https://github.com/kubernetes/kubernetes/pull/58096), [@mikedanese](https://github.com/mikedanese)) -* The kubelet flag to run docker containers with a process namespace that is shared between all containers in a pod is now deprecated and will be replaced by a new field in `v1.Pod` that configures this behavior. ([#58093](https://github.com/kubernetes/kubernetes/pull/58093), [@verb](https://github.com/verb)) -* fix device name change issue for azure disk: add remount logic ([#57953](https://github.com/kubernetes/kubernetes/pull/57953), [@andyzhangx](https://github.com/andyzhangx)) -* The Kubelet now explicitly registers all of its command-line flags with an internal flagset, which prevents flags from third party libraries from unintentionally leaking into the Kubelet's command-line API. Many unintentionally leaked flags are now marked deprecated, so that users have a chance to migrate away from them before they are removed. One previously leaked flag, --cloud-provider-gce-lb-src-cidrs, was entirely removed from the Kubelet's command-line API, because it is irrelevant to Kubelet operation. ([#57613](https://github.com/kubernetes/kubernetes/pull/57613), [@mtaufen](https://github.com/mtaufen)) -* Remove deprecated and unmaintained libvirt-coreos kube-up.sh. ([#58023](https://github.com/kubernetes/kubernetes/pull/58023), [@mikedanese](https://github.com/mikedanese)) -* Remove deprecated and unmaintained windows installer. ([#58020](https://github.com/kubernetes/kubernetes/pull/58020), [@mikedanese](https://github.com/mikedanese)) -* Remove deprecated and unmaintained openstack-heat kube-up.sh. ([#58021](https://github.com/kubernetes/kubernetes/pull/58021), [@mikedanese](https://github.com/mikedanese)) -* Fixes authentication problem faced during various vSphere operations. ([#57978](https://github.com/kubernetes/kubernetes/pull/57978), [@prashima](https://github.com/prashima)) -* fluentd-gcp updated to version 2.0.13. ([#57789](https://github.com/kubernetes/kubernetes/pull/57789), [@x13n](https://github.com/x13n)) -* Add support for cloud-controller-manager in local-up-cluster.sh ([#57757](https://github.com/kubernetes/kubernetes/pull/57757), [@dims](https://github.com/dims)) -* Update CSI spec dependency to point to v0.1.0 tag ([#57989](https://github.com/kubernetes/kubernetes/pull/57989), [@NickrenREN](https://github.com/NickrenREN)) -* Update kube-dns to Version 1.14.8 that includes only small changes to how Prometheus metrics are collected. ([#57918](https://github.com/kubernetes/kubernetes/pull/57918), [@rramkumar1](https://github.com/rramkumar1)) -* Add proxy_read_timeout flag to kubeapi_load_balancer charm. ([#57926](https://github.com/kubernetes/kubernetes/pull/57926), [@wwwtyro](https://github.com/wwwtyro)) -* Adding support for Block Volume type to rbd plugin. ([#56651](https://github.com/kubernetes/kubernetes/pull/56651), [@sbezverk](https://github.com/sbezverk)) -* Fixes a bug in Heapster deployment for google sink. ([#57902](https://github.com/kubernetes/kubernetes/pull/57902), [@kawych](https://github.com/kawych)) -* Forbid unnamed contexts in kubeconfigs. ([#56769](https://github.com/kubernetes/kubernetes/pull/56769), [@dixudx](https://github.com/dixudx)) -* Upgrade to etcd client 3.2.13 and grpc 1.7.5 to improve HA etcd cluster stability. ([#57480](https://github.com/kubernetes/kubernetes/pull/57480), [@jpbetz](https://github.com/jpbetz)) -* Default scheduler code is moved out of the plugin directory. ([#57852](https://github.com/kubernetes/kubernetes/pull/57852), [@misterikkit](https://github.com/misterikkit)) - * plugin/pkg/scheduler -> pkg/scheduler - * plugin/cmd/kube-scheduler -> cmd/kube-scheduler -* Bump metadata proxy version to v0.1.7 to pick up security fix. ([#57762](https://github.com/kubernetes/kubernetes/pull/57762), [@ihmccreery](https://github.com/ihmccreery)) -* HugePages feature is beta ([#56939](https://github.com/kubernetes/kubernetes/pull/56939), [@derekwaynecarr](https://github.com/derekwaynecarr)) -* GCE: support passing kube-scheduler policy config via SCHEDULER_POLICY_CONFIG ([#57425](https://github.com/kubernetes/kubernetes/pull/57425), [@yguo0905](https://github.com/yguo0905)) -* Returns an error for non overcommitable resources if they don't have limit field set in container spec. ([#57170](https://github.com/kubernetes/kubernetes/pull/57170), [@jiayingz](https://github.com/jiayingz)) -* Update defaultbackend image to 1.4 and deployment apiVersion to apps/v1 ([#57866](https://github.com/kubernetes/kubernetes/pull/57866), [@zouyee](https://github.com/zouyee)) -* kubeadm: set kube-apiserver advertise address using downward API ([#56084](https://github.com/kubernetes/kubernetes/pull/56084), [@andrewsykim](https://github.com/andrewsykim)) -* CDK nginx ingress is now handled via a daemon set. ([#57530](https://github.com/kubernetes/kubernetes/pull/57530), [@hyperbolic2346](https://github.com/hyperbolic2346)) -* The kubelet uses a new release 3.1 of the pause container with the Docker runtime. This version will clean up orphaned zombie processes that it inherits. ([#57517](https://github.com/kubernetes/kubernetes/pull/57517), [@verb](https://github.com/verb)) -* Allow kubectl set image|env on a cronjob ([#57742](https://github.com/kubernetes/kubernetes/pull/57742), [@soltysh](https://github.com/soltysh)) -* Move local PV negative scheduling tests to integration ([#57570](https://github.com/kubernetes/kubernetes/pull/57570), [@sbezverk](https://github.com/sbezverk)) -* fix azure disk not available issue when device name changed ([#57549](https://github.com/kubernetes/kubernetes/pull/57549), [@andyzhangx](https://github.com/andyzhangx)) -* Only create Privileged PSP binding during e2e tests if RBAC is enabled. ([#56382](https://github.com/kubernetes/kubernetes/pull/56382), [@mikkeloscar](https://github.com/mikkeloscar)) -* RBAC: The system:kubelet-api-admin cluster role can be used to grant full access to the kubelet API ([#57128](https://github.com/kubernetes/kubernetes/pull/57128), [@liggitt](https://github.com/liggitt)) -* Allow kubernetes components to react to SIGTERM signal and shutdown gracefully. ([#57756](https://github.com/kubernetes/kubernetes/pull/57756), [@mborsz](https://github.com/mborsz)) -* ignore nonexistent ns net file error when deleting container network in case a retry ([#57697](https://github.com/kubernetes/kubernetes/pull/57697), [@dixudx](https://github.com/dixudx)) -* check psp HostNetwork in DenyEscalatingExec admission controller. ([#56839](https://github.com/kubernetes/kubernetes/pull/56839), [@hzxuzhonghu](https://github.com/hzxuzhonghu)) -* The alpha `--init-config-dir` flag has been removed. Instead, use the `--config` flag to reference a kubelet configuration file directly. ([#57624](https://github.com/kubernetes/kubernetes/pull/57624), [@mtaufen](https://github.com/mtaufen)) -* Add cache for VM get operation in azure cloud provider ([#57432](https://github.com/kubernetes/kubernetes/pull/57432), [@karataliu](https://github.com/karataliu)) -* Fix garbage collection when the controller-manager uses --leader-elect=false ([#57340](https://github.com/kubernetes/kubernetes/pull/57340), [@jmcmeek](https://github.com/jmcmeek)) -* iSCSI sessions managed by kubernetes will now explicitly set startup.mode to 'manual' to ([#57475](https://github.com/kubernetes/kubernetes/pull/57475), [@stmcginnis](https://github.com/stmcginnis)) - * prevent automatic login after node failure recovery. This is the default open-iscsi mode, so - * this change will only impact users who have changed their startup.mode to be 'automatic' - * in /etc/iscsi/iscsid.conf. -* Configurable liveness probe initial delays for etcd and kube-apiserver in GCE ([#57749](https://github.com/kubernetes/kubernetes/pull/57749), [@wojtek-t](https://github.com/wojtek-t)) -* Fixed garbage collection hang ([#57503](https://github.com/kubernetes/kubernetes/pull/57503), [@liggitt](https://github.com/liggitt)) -* Fixes controller manager crash in certain vSphere cloud provider environment. ([#57286](https://github.com/kubernetes/kubernetes/pull/57286), [@rohitjogvmw](https://github.com/rohitjogvmw)) -* Remove useInstanceMetadata parameter from Azure cloud provider. ([#57647](https://github.com/kubernetes/kubernetes/pull/57647), [@feiskyer](https://github.com/feiskyer)) -* Support multiple scale sets in Azure cloud provider. ([#57543](https://github.com/kubernetes/kubernetes/pull/57543), [@feiskyer](https://github.com/feiskyer)) -* GCE: Fixes ILB creation on automatic networks with manually created subnetworks. ([#57351](https://github.com/kubernetes/kubernetes/pull/57351), [@nicksardo](https://github.com/nicksardo)) -* Improve scheduler performance of MatchInterPodAffinity predicate. ([#57476](https://github.com/kubernetes/kubernetes/pull/57476), [@misterikkit](https://github.com/misterikkit)) -* Improve scheduler performance of MatchInterPodAffinity predicate. ([#57477](https://github.com/kubernetes/kubernetes/pull/57477), [@misterikkit](https://github.com/misterikkit)) -* Improve scheduler performance of MatchInterPodAffinity predicate. ([#57478](https://github.com/kubernetes/kubernetes/pull/57478), [@misterikkit](https://github.com/misterikkit)) -* Allow use resource ID to specify public IP address in azure_loadbalancer ([#53557](https://github.com/kubernetes/kubernetes/pull/53557), [@yolo3301](https://github.com/yolo3301)) -* Fixes a bug where if an error was returned that was not an `autorest.DetailedError` we would return `"not found", nil` which caused nodes to go to `NotReady` state. ([#57484](https://github.com/kubernetes/kubernetes/pull/57484), [@brendandburns](https://github.com/brendandburns)) -* Add the path '/version/' to the `system:discovery` cluster role. ([#57368](https://github.com/kubernetes/kubernetes/pull/57368), [@brendandburns](https://github.com/brendandburns)) -* Fixes issue creating docker secrets with kubectl 1.9 for accessing docker private registries. ([#57463](https://github.com/kubernetes/kubernetes/pull/57463), [@dims](https://github.com/dims)) -* adding predicates ordering for the kubernetes scheduler. ([#57168](https://github.com/kubernetes/kubernetes/pull/57168), [@yastij](https://github.com/yastij)) -* Free up CPU and memory requested but unused by Metrics Server Pod Nanny. ([#57252](https://github.com/kubernetes/kubernetes/pull/57252), [@kawych](https://github.com/kawych)) -* The alpha Accelerators feature gate is deprecated and will be removed in v1.11. Please use device plugins instead. They can be enabled using the DevicePlugins feature gate. ([#57384](https://github.com/kubernetes/kubernetes/pull/57384), [@mindprince](https://github.com/mindprince)) -* Fixed dynamic provisioning of GCE PDs to round to the next GB instead of GiB ([#56600](https://github.com/kubernetes/kubernetes/pull/56600), [@edisonxiang](https://github.com/edisonxiang)) -* Separate loop and plugin control ([#52371](https://github.com/kubernetes/kubernetes/pull/52371), [@cheftako](https://github.com/cheftako)) -* Use old dns-ip mechanism with older cdk-addons. ([#57403](https://github.com/kubernetes/kubernetes/pull/57403), [@wwwtyro](https://github.com/wwwtyro)) -* Retry 'connection refused' errors when setting up clusters on GCE. ([#57394](https://github.com/kubernetes/kubernetes/pull/57394), [@mborsz](https://github.com/mborsz)) -* Upgrade to etcd client 3.2.11 and grpc 1.7.5 to improve HA etcd cluster stability. ([#57160](https://github.com/kubernetes/kubernetes/pull/57160), [@jpbetz](https://github.com/jpbetz)) -* Added the ability to select pods in a chosen node to be drained, based on given pod label-selector ([#56864](https://github.com/kubernetes/kubernetes/pull/56864), [@juanvallejo](https://github.com/juanvallejo)) -* Wait for kubedns to be ready when collecting the cluster IP. ([#57337](https://github.com/kubernetes/kubernetes/pull/57337), [@wwwtyro](https://github.com/wwwtyro)) -* Use "k8s.gcr.io" for container images rather than "gcr.io/google_containers". This is just a redirect, for now, so should not impact anyone materially. ([#54174](https://github.com/kubernetes/kubernetes/pull/54174), [@thockin](https://github.com/thockin)) - * Documentation and tools should all convert to the new name. Users should take note of this in case they see this new name in the system. -* Fix ipvs proxier nodeport eth* assumption ([#56685](https://github.com/kubernetes/kubernetes/pull/56685), [@m1093782566](https://github.com/m1093782566)) - - - -# v1.10.0-alpha.1 - -[Documentation](https://docs.k8s.io) & [Examples](https://releases.k8s.io/master/examples) - -## Downloads for v1.10.0-alpha.1 - - -filename | sha256 hash --------- | ----------- -[kubernetes.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes.tar.gz) | `403b90bfa32f7669b326045a629bd15941c533addcaf0c49d3c3c561da0542f2` -[kubernetes-src.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-src.tar.gz) | `266da065e9eddf19d36df5ad325f2f854101a0e712766148e87d998e789b80cf` - -### Client Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-client-darwin-386.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-client-darwin-386.tar.gz) | `5aaa8e294ae4060d34828239e37f37b45fa5a69508374be668965102848626be` -[kubernetes-client-darwin-amd64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-client-darwin-amd64.tar.gz) | `40a8e3bab11b88a2bb8e748f0b29da806d89b55775508039abe9c38c5f4ab97d` -[kubernetes-client-linux-386.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-client-linux-386.tar.gz) | `e08dde0b561529f0b2bb39c141f4d7b1c943749ef7c1f9779facf5fb5b385d6a` -[kubernetes-client-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-client-linux-amd64.tar.gz) | `76a05d31acaab932ef45c67e1d6c9273933b8bc06dd5ce9bad3c7345d5267702` -[kubernetes-client-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-client-linux-arm64.tar.gz) | `4b833c9e80f3e4ac4958ea0ffb5ae564b31d2a524f6a14e58802937b2b936d73` -[kubernetes-client-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-client-linux-arm.tar.gz) | `f1484ab75010a2258ed7717b1284d0c139d17e194ac9e391b8f1c0999eec3c2d` -[kubernetes-client-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-client-linux-ppc64le.tar.gz) | `da884f09ec753925b2c1f27ea0a1f6c3da2056855fc88f47929bb3d6c2a09312` -[kubernetes-client-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-client-linux-s390x.tar.gz) | `c486f760c6707fc92d1659d3cbe33d68c03190760b73ac215957ee52f9c19195` -[kubernetes-client-windows-386.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-client-windows-386.tar.gz) | `514c550b7ff85ac33e6ed333bcc06461651fe4004d8b7c12ca67f5dc1d2198bf` -[kubernetes-client-windows-amd64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-client-windows-amd64.tar.gz) | `ddad59222f6a8cb4e88c4330c2a967c4126cb22ac5e0d7126f9f65cca0fb9f45` - -### Server Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-server-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-server-linux-amd64.tar.gz) | `514efd798ce1d7fe4233127f3334a3238faad6c26372a2d457eff02cbe72d756` -[kubernetes-server-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-server-linux-arm64.tar.gz) | `f71f75fb96221f65891fc3e04fd52ae4e5628da8b7b4fbedece3fab4cb650afa` -[kubernetes-server-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-server-linux-arm.tar.gz) | `a9d8c2386813fd690e60623a6ee1968fe8f0a1a8e13bc5cc12b2caf8e8a862e1` -[kubernetes-server-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-server-linux-ppc64le.tar.gz) | `21336a5e40aead4e2ec7e744a99d72bf8cb552341f3141abf8f235beb250cd93` -[kubernetes-server-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-server-linux-s390x.tar.gz) | `257e44d38fef83f08990b6b9b5e985118e867c0c33f0e869f0900397b9d30498` - -### Node Binaries - -filename | sha256 hash --------- | ----------- -[kubernetes-node-linux-amd64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-node-linux-amd64.tar.gz) | `97bf1210f0595ebf496ca7b000c4367f8a459d97ef72459efc6d0e07a072398f` -[kubernetes-node-linux-arm64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-node-linux-arm64.tar.gz) | `eebcd3c14fb4faeb82ab047a2152db528adc2d9f7b20eef6f5dc58202ebe3124` -[kubernetes-node-linux-arm.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-node-linux-arm.tar.gz) | `3d4428416c775a0a6463f623286bd2ecdf9240ce901e1fbae180dfb564c53ea1` -[kubernetes-node-linux-ppc64le.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-node-linux-ppc64le.tar.gz) | `5cc96b24fad0ac1779a66f9b136d90e975b07bf619fea905e6c26ac5a4c41168` -[kubernetes-node-linux-s390x.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-node-linux-s390x.tar.gz) | `134c13338edf4efcd511f4161742fbaa6dc232965d3d926c3de435e8a080fcbb` -[kubernetes-node-windows-amd64.tar.gz](https://dl.k8s.io/v1.10.0-alpha.1/kubernetes-node-windows-amd64.tar.gz) | `ae54bf2bbcb99cdcde959140460d0f83c0ecb187d060b594ae9c5349960ab055` - -## Changelog since v1.9.0 - -### Action Required - -* [action required] Remove the kubelet's `--cloud-provider=auto-detect` feature ([#56287](https://github.com/kubernetes/kubernetes/pull/56287), [@stewart-yu](https://github.com/stewart-yu)) - -### Other notable changes - -* Fix Heapster configuration and Metrics Server configuration to enable overriding default resource requirements. ([#56965](https://github.com/kubernetes/kubernetes/pull/56965), [@kawych](https://github.com/kawych)) -* YAMLDecoder Read now returns the number of bytes read ([#57000](https://github.com/kubernetes/kubernetes/pull/57000), [@sel](https://github.com/sel)) -* Retry 'connection refused' errors when setting up clusters on GCE. ([#57324](https://github.com/kubernetes/kubernetes/pull/57324), [@mborsz](https://github.com/mborsz)) -* Update kubeadm's minimum supported Kubernetes version in v1.10.x to v1.9.0 ([#57233](https://github.com/kubernetes/kubernetes/pull/57233), [@xiangpengzhao](https://github.com/xiangpengzhao)) -* Graduate CPU Manager feature from alpha to beta. ([#55977](https://github.com/kubernetes/kubernetes/pull/55977), [@ConnorDoyle](https://github.com/ConnorDoyle)) -* Drop hacks used for Mesos integration that was already removed from main kubernetes repository ([#56754](https://github.com/kubernetes/kubernetes/pull/56754), [@dims](https://github.com/dims)) -* Compare correct file names for volume detach operation ([#57053](https://github.com/kubernetes/kubernetes/pull/57053), [@prashima](https://github.com/prashima)) -* Improved event generation in volume mount, attach, and extend operations ([#56872](https://github.com/kubernetes/kubernetes/pull/56872), [@davidz627](https://github.com/davidz627)) -* GCE: bump COS image version to cos-stable-63-10032-71-0 ([#57204](https://github.com/kubernetes/kubernetes/pull/57204), [@yujuhong](https://github.com/yujuhong)) -* fluentd-gcp updated to version 2.0.11. ([#56927](https://github.com/kubernetes/kubernetes/pull/56927), [@x13n](https://github.com/x13n)) -* calico-node addon tolerates all NoExecute and NoSchedule taints by default. ([#57122](https://github.com/kubernetes/kubernetes/pull/57122), [@caseydavenport](https://github.com/caseydavenport)) -* Support LoadBalancer for Azure Virtual Machine Scale Sets ([#57131](https://github.com/kubernetes/kubernetes/pull/57131), [@feiskyer](https://github.com/feiskyer)) -* Makes the kube-dns addon optional so that users can deploy their own DNS solution. ([#57113](https://github.com/kubernetes/kubernetes/pull/57113), [@wwwtyro](https://github.com/wwwtyro)) -* Enabled log rotation for load balancer's api logs to prevent running out of disk space. ([#56979](https://github.com/kubernetes/kubernetes/pull/56979), [@hyperbolic2346](https://github.com/hyperbolic2346)) -* Remove ScrubDNS interface from cloudprovider. ([#56955](https://github.com/kubernetes/kubernetes/pull/56955), [@feiskyer](https://github.com/feiskyer)) -* Fix `etcd-version-monitor` to backward compatibly support etcd 3.1 [go-grpc-prometheus](https://github.com/grpc-ecosystem/go-grpc-prometheus) metrics format. ([#56871](https://github.com/kubernetes/kubernetes/pull/56871), [@jpbetz](https://github.com/jpbetz)) -* enable flexvolume on Windows node ([#56921](https://github.com/kubernetes/kubernetes/pull/56921), [@andyzhangx](https://github.com/andyzhangx)) -* When using Role-Based Access Control, the "admin", "edit", and "view" roles now have the expected permissions on NetworkPolicy resources. ([#56650](https://github.com/kubernetes/kubernetes/pull/56650), [@danwinship](https://github.com/danwinship)) -* Fix the PersistentVolumeLabel controller from initializing the PV labels when it's not the next pending initializer. ([#56831](https://github.com/kubernetes/kubernetes/pull/56831), [@jhorwit2](https://github.com/jhorwit2)) -* kube-apiserver: The external hostname no longer use the cloud provider API to select a default. It can be set explicitly using --external-hostname, if needed. ([#56812](https://github.com/kubernetes/kubernetes/pull/56812), [@dims](https://github.com/dims)) -* Use GiB unit for creating and resizing volumes for Glusterfs ([#56581](https://github.com/kubernetes/kubernetes/pull/56581), [@gnufied](https://github.com/gnufied)) -* PersistentVolume flexVolume sources can now reference secrets in a namespace other than the PersistentVolumeClaim's namespace. ([#56460](https://github.com/kubernetes/kubernetes/pull/56460), [@liggitt](https://github.com/liggitt)) -* Scheduler skips pods that use a PVC that either does not exist or is being deleted. ([#55957](https://github.com/kubernetes/kubernetes/pull/55957), [@jsafrane](https://github.com/jsafrane)) -* Fixed a garbage collection race condition where objects with ownerRefs pointing to cluster-scoped objects could be deleted incorrectly. ([#57211](https://github.com/kubernetes/kubernetes/pull/57211), [@liggitt](https://github.com/liggitt)) -* Kubectl explain now prints out the Kind and API version of the resource being explained ([#55689](https://github.com/kubernetes/kubernetes/pull/55689), [@luksa](https://github.com/luksa)) -* api-server provides specific events when unable to repair a service cluster ip or node port ([#54304](https://github.com/kubernetes/kubernetes/pull/54304), [@frodenas](https://github.com/frodenas)) -* Added docker-logins config to kubernetes-worker charm ([#56217](https://github.com/kubernetes/kubernetes/pull/56217), [@Cynerva](https://github.com/Cynerva)) -* delete useless params containerized ([#56146](https://github.com/kubernetes/kubernetes/pull/56146), [@jiulongzaitian](https://github.com/jiulongzaitian)) -* add mount options support for azure disk ([#56147](https://github.com/kubernetes/kubernetes/pull/56147), [@andyzhangx](https://github.com/andyzhangx)) -* Use structured generator for kubectl autoscale ([#55913](https://github.com/kubernetes/kubernetes/pull/55913), [@wackxu](https://github.com/wackxu)) -* K8s supports cephfs fuse mount. ([#55866](https://github.com/kubernetes/kubernetes/pull/55866), [@zhangxiaoyu-zidif](https://github.com/zhangxiaoyu-zidif)) -* COS: Keep the docker network checkpoint ([#54805](https://github.com/kubernetes/kubernetes/pull/54805), [@yujuhong](https://github.com/yujuhong)) -* Fixed documentation typo in IPVS README. ([#56578](https://github.com/kubernetes/kubernetes/pull/56578), [@shift](https://github.com/shift)) - - -See the [Releases Page](https://github.com/kubernetes/kubernetes/releases) for older releases. - -Release notes of older releases can be found in: - -- [CHANGELOG-1.2.md](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.2.md) -- [CHANGELOG-1.3.md](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.3.md) -- [CHANGELOG-1.4.md](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.4.md) -- [CHANGELOG-1.5.md](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.5.md) -- [CHANGELOG-1.6.md](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.6.md) -- [CHANGELOG-1.7.md](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.7.md) -- [CHANGELOG-1.8.md](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.8.md) -- [CHANGELOG-1.9.md](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.9.md) - -[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/CHANGELOG.md?pixel)]() +* Default etcd server version is v3.2.18 compared with v3.1.12 in v1.10 ([#61198](https://github.com/kubernetes/kubernetes/pull/61198)) +* Rescheduler is v0.4.0, compared with v0.3.1 in v1.10 ([#65454](https://github.com/kubernetes/kubernetes/pull/65454)) +* The validated docker versions are the same as for v1.10: 1.11.2 to 1.13.1 and 17.03.x (ref) +* The Go version is go1.10.2, as compared to go1.9.3 in v1.10. ([#63412](https://github.com/kubernetes/kubernetes/pull/63412)) +* The minimum supported go is the same as for v1.10: go1.9.1. ([#55301](https://github.com/kubernetes/kubernetes/pull/55301)) +* CNI is the same as v1.10: v0.6.0 ([#51250](https://github.com/kubernetes/kubernetes/pull/51250)) +* CSI is updated to 0.3.0 as compared to 0.2.0 in v1.10. ([#64719](https://github.com/kubernetes/kubernetes/pull/64719)) +* The dashboard add-on is the same as v1.10: v1.8.3. ([#517326](https://github.com/kubernetes/kubernetes/pull/57326)) +* Bump Heapster to v1.5.2 as compared to v1.5.0 in v1.10 ([#61396](https://github.com/kubernetes/kubernetes/pull/61396)) +* Updates Cluster Autoscaler version to v1.3.0 from v1.2.0 in v1.10. See [release notes](https://github.com/kubernetes/autoscaler/releases/tag/cluster-autoscaler-1.3.0) for details. ([#65219](https://github.com/kubernetes/kubernetes/pull/65219)) +* Kube-dns has been updated to v1.14.10, as compared to v1.14.8 in v1.10 ([#62676](https://github.com/kubernetes/kubernetes/pull/62676)) +* Influxdb is unchanged from v1.10: v1.3.3 ([#53319](https://github.com/kubernetes/kubernetes/pull/53319)) +* Grafana is unchanged from v1.10: v4.4.3 ([#53319](https://github.com/kubernetes/kubernetes/pull/53319)) +* CAdvisor is v0.30.1, as opposed to v0.29.1 in v1.10 ([#64987](https://github.com/kubernetes/kubernetes/pull/64987)) +* fluentd-gcp-scaler is unchanged from v1.10: v0.3.0 ([#61269](https://github.com/kubernetes/kubernetes/pull/61269)) +* fluentd in fluentd-es-image is unchanged from 1.10: v1.1.0 ([#58525](https://github.com/kubernetes/kubernetes/pull/58525)) +* fluentd-elasticsearch is unchanged from 1.10: v2.0.4 ([#58525](https://github.com/kubernetes/kubernetes/pull/58525)) +* fluentd-gcp is unchanged from 1.10: v3.0.0. ([#60722](https://github.com/kubernetes/kubernetes/pull/60722)) +* Ingress glbc is unchanged from 1.10: v1.0.0 ([#61302](https://github.com/kubernetes/kubernetes/pull/61302)) +* OIDC authentication is unchanged from 1.10: coreos/go-oidc v2 ([#58544](https://github.com/kubernetes/kubernetes/pull/58544)) +* Calico is unchanged from 1.10: v2.6.7 ([#59130](https://github.com/kubernetes/kubernetes/pull/59130)) +* hcsshim has been updated to v0..11 ([#64272](https://github.com/kubernetes/kubernetes/pull/64272)) +* gitRepo volumes in pods no longer require git 1.8.5 or newer; older git versions are now supported. ([#62394](https://github.com/kubernetes/kubernetes/pull/62394)) +* Update crictl on GCE to v1.11.0. ([#65254](https://github.com/kubernetes/kubernetes/pull/65254)) +* CoreDNS is now v1.1.3 ([#64258](https://github.com/kubernetes/kubernetes/pull/64258)) +* Setup dns servers and search domains for Windows Pods in dockershim. Docker EE version >= 17.10.0 is required for propagating DNS to containers. ([#63905](https://github.com/kubernetes/kubernetes/pull/63905)) +* Update version of Istio addon from 0.5.1 to 0.8.0. See [full Istio release notes](https://istio.io/about/notes/0.6.html).([#64537](https://github.com/kubernetes/kubernetes/pull/64537)) +* Update cadvisor godeps to v0.30.0 ([#64800](https://github.com/kubernetes/kubernetes/pull/64800)) +* Update event-exporter to version v0.2.0 that supports old (gke_container/gce_instance) and new (k8s_container/k8s_node/k8s_pod) stackdriver resources. ([#63918](https://github.com/kubernetes/kubernetes/pull/63918)) +* Rev the Azure SDK for networking to 2017-06-01 ([#61955](https://github.com/kubernetes/kubernetes/pull/61955)) + +## Bug Fixes + +* Fixed spurious "unable to find api field" errors patching custom resources ([#63146](https://github.com/kubernetes/kubernetes/pull/63146), [@liggitt](https://github.com/liggitt)) +* Nodes are not deleted from kubernetes anymore if node is shutdown in Openstack. ([#59931](https://github.com/kubernetes/kubernetes/pull/59931), [@zetaab](https://github.com/zetaab)) +* Re-enabled nodeipam controller for external clouds. Re-enables nodeipam controller for external clouds. Also does a small refactor so that we don't need to pass in allocateNodeCidr into the controller. + ([#63049](https://github.com/kubernetes/kubernetes/pull/63049), [@andrewsykim](https://github.com/andrewsykim)) +* Fixed a configuration error when upgrading kubeadm from 1.9 to 1.10+; Kubernetes must have the same major and minor versions as the kubeadm library. ([#62568](https://github.com/kubernetes/kubernetes/pull/62568), [@liztio](https://github.com/liztio)) +* kubectl no longer renders a List as suffix kind name for CRD resources ([#62512](https://github.com/kubernetes/kubernetes/pull/62512), [@dixudx](https://github.com/dixudx)) +* Restored old behavior to the `--template` flag in `get.go`. In old releases, providing a `--template` flag value and no `--output` value implicitly assigned a default value ("go-template") to `--output`, printing using the provided template argument. +([#65377](https://github.com/kubernetes/kubernetes/pull/65377),[@juanvallejo](https://github.com/juanvallejo)) +* Ensured cloudprovider.InstanceNotFound is reported when the VM is not found on Azure ([#61531](https://github.com/kubernetes/kubernetes/pull/61531), [@feiskyer](https://github.com/feiskyer)) +* Kubernetes version command line parameter in kubeadm has been updated to drop an unnecessary redirection from ci/latest.txt to ci-cross/latest.txt. Users should know exactly where the builds are stored on Google Cloud storage buckets from now on. For example for 1.9 and 1.10, users can specify ci/latest-1.9 and ci/latest-1.10 as the CI build jobs what build images correctly updates those. The CI jobs for master update the ci-cross/latest location, so if you are looking for latest master builds, then the correct parameter to use would be ci-cross/latest. ([#63504](https://github.com/kubernetes/kubernetes/pull/63504), [@dims](https://github.cm/dims)) +* Fixes incompatibility with custom scheduler extender configurations specifying `bindVerb` ([#65424](https://github.com/kubernetes/kubernetes/pull/65424), [@liggitt](https://github.com/liggitt)) +* kubectl built for darwin from darwin now enables cgo to use the system-native C libraries for DNS resolution. Cross-compiled kubectl (e.g. from an official kubernetes release) still uses the go-native netgo DNS implementation. ([#64219](https://github.com/kubernetes/kubernetes/pull/64219), [@ixdy](https://github.com/ixdy)) +* API server properly parses propagationPolicy as a query parameter sent with a delete request ([#63414](https://github.com/kubernetes/kubernetes/pull/63414), [@roycaihw](https://github.com/roycaihw)) +* Corrected a race condition in bootstrapping aggregated cluster roles in new HA clusters ([#63761](https://github.com/kubernetes/kubernetes/pull/63761), [@liggitt](https://github.com/liggitt)) +* kubelet: fix hangs in updating Node status after network interruptions/changes between the kubelet and API server ([#63492](https://github.com/kubernetes/kubernetes/pull/63492), [@liggitt](https://github.com/liggitt)) +* Added log and fs stats for Windows containers ([#62266](https://github.com/kubernetes/kubernetes/pull/62266), [@feiskyer](https://github.com/feiskyer)) +* Fail fast if cgroups-per-qos is set on Windows ([#62984](https://github.com/kubernetes/kubernetes/pull/62984), [@feiskyer](https://github.com/feiskyer)) +* Minor fix for VolumeZoneChecker predicate, storageclass can be in annotation and spec. ([#63749](https://github.com/kubernetes/kubernetes/pull/63749), [@wenlxie](https://github.com/wenlxie)) +* Fixes issue for readOnly subpath mounts for SELinux systems and when the volume mountPath already existed in the container image. ([#64351](https://github.com/kubernetes/kubernetes/pull/64351), [@msau42](https://github.com/msau42)) +* Fixed CSI gRPC connection leak during volume operations. ([#64519](https://github.com/kubernetes/kubernetes/pull/64519), [@vladimirvivien](https://github.com/vladimirvivien)) +* Fixed error reporting of CSI volumes attachment. ([#63303](https://github.com/kubernetes/kubernetes/pull/63303), [@jsafrane](https://github.com/jsafrane)) +* Fixed SELinux relabeling of CSI volumes. ([#64026](https://github.com/kubernetes/kubernetes/pull/64026), [@jsafrane](https://github.com/jsafrane)) +* Fixed detach of already detached CSI volumes. ([#63295](https://github.com/kubernetes/kubernetes/pull/63295), [@jsafrane](https://github.com/jsafrane)) +* fix rbd device works at block mode not get mapped to container ([#64555](https://github.com/kubernetes/kubernetes/pull/64555), [@wenlxie](https://github.com/wenlxie)) +* Fixed an issue where Portworx PVCs remain in pending state when created using a StorageClass with empty parameters ([#64895](https://github.com/kubernetes/kubernetes/pull/64895), [@harsh-px](https://github.com/harsh-px)) storage +* FIX: The OpenStack cloud providers DeleteRoute method fails to delete routes when it can’t find the corresponding instance in OpenStack. (#62729, databus23) +* [fluentd-gcp addon] Increase CPU limit for fluentd to 1 core to achieve 100kb/s throughput. ([#62430](https://github.com/kubernetes/kubernetes/pull/62430), [@bmoyles0117](https://github.com/bmoyles0117)) +* GCE: Fixed operation polling to adhere to the specified interval. Furthermore, operation errors are now returned instead of ignored. ([#64630](https://github.com/kubernetes/kubernetes/pull/64630), [@nicksardo](https://github.com/nicksardo)) +* Included kms-plugin-container.manifest to master nifests tarball. ([#65035](https://github.com/kubernetes/kubernetes/pull/65035), [@immutableT](https://github.com/immutableT)) +* Fixed missing nodes lines when kubectl top nodes ([#64389](https://github.com/kubernetes/kubernetes/pull/64389), [@yue9944882](https://github.com/yue9944882)) sig-cli +* Fixed kubectl drain --timeout option when eviction is used. ([#64378](https://github.com/kubernetes/kubernetes/pull/64378), [@wrdls](https://github.com/wrdls)) sig-cli +* Fixed kubectl auth can-i exit code. It will return 1 if the user is not allowed and 0 if it's allowed. ([#59579](https://github.com/kubernetes/kubernetes/pull/59579), [@fbac](https://github.com/fbac)) +* Fixed data loss issue if using existing azure disk with partitions in disk mount ([#63270](https://github.com/kubernetes/kubernetes/pull/63270), [@andyzhangx](https://github.com/andyzhangx)) +* Fixed azure file size grow issue ([#64383](https://github.com/kubernetes/kubernetes/pull/64383), [@andyzhangx](https://github.com/andyzhangx)) +* Fixed SessionAffinity not updated issue for Azure load balancer ([#64180](https://github.com/kubernetes/kubernetes/pull/64180), [@feiskyer](https://github.com/feiskyer)) +* Fixed kube-controller-manager panic while provisioning Azure security group rules ([#64739](https://github.com/kubernetes/kubernetes/pull/64739), [@feiskyer](https://github.com/feiskyer)) +* Fixed API server panic during concurrent GET or LIST requests with non-empty `resourceVersion`. ([#65092](https://github.com/kubernetes/kubernetes/pull/65092), [@sttts](https://github.com/sttts)) +* Fixed incorrect OpenAPI schema for CustomResourceDefinition objects ([#65256](https://github.com/kubernetes/kubernetes/pull/65256), [@liggitt](https://github.com/liggitt)) +* Fixed issue where PersistentVolume.NodeAffinity.NodeSelectorTerms were ANDed instead of ORed. ([#62556](https://github.com/kubernetes/kubernetes/pull/62556), [@msau42](https://github.com/msau42)) +* Fixed potential infinite loop that can occur when NFS PVs are recycled. ([#62572](https://github.com/kubernetes/kubernetes/pull/62572), [@joelsmith](https://github.com/joelsmith)) +* Fixed column alignment when kubectl get is used with custom columns from OpenAPI schema ([#56629](https://github.com/kubernetes/kubernetes/pull/56629), [@luksa](https://github.com/luksa)) +* kubectl: restore the ability to show resource kinds when displaying multiple objects ([#61985](https://github.com/kubernetes/kubernetes/pull/61985), [@liggitt](https://github.com/liggitt)) +* Fixed a panic in `kubectl run --attach ...` when the api server failed to create the runtime object (due to name conflict, PSP restriction, etc.) ([#61713](https://github.com/kubernetes/kubernetes/pull/61713), [@mountkin](https://github.com/mountkin)) +* kube-scheduler has been fixed to use `--leader-elect` option back to true (as it was in previous versions) ([#59732](https://github.com/kubernetes/kubernetes/pull/59732), [@dims](https://github.com/dims)) +* kubectl: fixes issue with `-o yaml` and `-o json` omitting kind and apiVersion when used with `--dry-run` ([#61808](https://github.com/kubernetes/kubernetes/pull/61808), [@liggitt](https://github.com/liggitt)) +* Ensure reasons end up as comments in `kubectl edit`. ([#60990](https://github.com/kubernetes/kubernetes/pull/60990), [@bmcstdio](https://github.com/bmcstdio)) +* Fixes issue where subpath readOnly mounts failed ([#63045](https://github.com/kubernetes/kubernetes/pull/63045), [@msau42](https://github.com/msau42)) +* Fix stackdriver metrics for node memory using wrong metric type ([#63535](https://github.co/kubernetes/kubernetes/pull/63535), [@serathius](https://github.com/serathius)) +* fix mount unmount failure for a Windows pod ([#63272](https://github.com/kubernetes/kubernetes/pull/63272), [@andyzhangx](https://github.com/andyzhangx)) + +### General Fixes and Reliability + +* Fixed a regression in kube-scheduler to properly load client connection information from a `--config` file that references a kubeconfig file. ([#65507](https://github.com/kubernetes/kubernetes/pull/65507), [@liggitt](https://github.com/liggitt)) +* Fix regression in `v1.JobSpec.backoffLimit` that caused failed Jobs to be restarted indefinitely. ([#63650](https://github.com/kubernetes/kubernetes/pull/63650), [@soltysh](https://github.com/soltysh)) +* fixes a potential deadlock in the garbage collection controller ([#64235](https://github.com/kubernetes/kubernetes/pull/64235), [@liggitt](https://github.com/liggitt)) +* fix formatAndMount func issue on Windows ([#63248](https://github.com/kubernetes/kubernetes/pull/63248), [@andyzhangx](https://github.com/andyzhangx)) +* Fix issue of colliding nodePorts when the cluster has services with externalTrafficPolicy=Local ([#64349](https://github.com/kubernetes/kubernetes/pull/64349), [@nicksardo](https://github.com/nicksardo)) +* fixes a panic applying json patches containing out of bounds operations ([#64355](https://github.com/kubernetes/kubernetes/pull/64355), [@liggitt](https://github.com/liggitt)) +* Fix incorrectly propagated ResourceVersion in ListRequests returning 0 items. ([#64150](https://github.com/kubernetes/kubernetes/pull/64150), [@wojtek-t](https://github.com/wojtek-t)) +* GCE: Fix to make the built-in `kubernetes` service properly point to the master's load balancer address in clusters that use multiple master VMs. ([#63696](https://github.com/kubernetes/kubernetes/pull/63696), [@grosskur](https://github.com/grosskur)) +* Fixes fake client generation for non-namespaced subresources ([#60445](https://github.com/kubernetes/kubernetes/pull/60445), [@jhorwit2](https://github.com/jhorwit2)) +* Schedule even if extender is not available when using extender ([#61445](https://github.com/kubernetes/kubernetes/pull/61445), [@resouer](https://github.com/resouer)) +* Fix panic create/update CRD when mutating/validating webhook configured. ([#61404](https://github.com/kubernetes/kubernetes/pull/61404), [@hzxuzhonghu](https://github.com/hzxuzhonghu)) +* Pods requesting resources prefixed with `*kubernetes.io` will remain unscheduled if there are no nodes exposing that resource. ([#61860](https://github.com/kubernetes/kubernetes/pull/61860), [@mindprince](https://github.com/mindprince)) +* fix scheduling policy on ConfigMap breaks without the --policy-configmap-namespace flag set ([#61388](https://github.com/kubernetes/kubernetes/pull/61388), [@zjj2wry](https://github.com/zjj2wry)) +* Bugfix for erroneous upgrade needed messaging in kubernetes worker charm. ([#60873](https://github.com/kubernetes/kubernetes/pull/60873), [@wwwtyro](https://github.com/wwwtyro)) +* Fix inter-pod anti-affinity check to consider a pod a match when all the anti-affinity terms match. ([#62715](https://github.com/kubernetes/kubernetes/pull/62715), [@bsalamat](https://github.com/bsalamat)) +* Pod affinity `nodeSelectorTerm.matchExpressions` may now be empty, and works as previously documented: nil or empty `matchExpressions` matches no objects in scheduler. ([#62448](https://github.com/kubernetes/kubernetes/pull/62448), [@k82cn](https://github.com/k82cn)) +* Fix an issue in inter-pod affinity predicate that cause affinity to self being processed correctly ([#62591](https://github.com/kubernetes/kubernetes/pull/62591), [@bsalamat](https://github.com/bsalamat)) +* fix WaitForAttach failure issue for azure disk ([#62612](https://github.com/kubernetes/kubernetes/pull/62612), [@andyzhangx](https://github.com/andyzhangx)) +* Fix user visible files creation for windows ([#62375](https://github.com/kubernetes/kubernetes/pull/62375), [@feiskyer](https://github.com/feiskyer)) +* Fix machineID getting for vmss nodes when using instance metadata ([#62611](https://github.com/kubernetes/kubernetes/pull/62611), [@feiskyer](https://github.com/feiskyer)) +* Fix Forward chain default reject policy for IPVS proxier ([#62007](https://github.com/kubernetes/kubernetes/pull/62007), [@m1093782566](https://github.com/m1093782566)) +* fix nsenter GetFileType issue in containerized kubelet ([#62467](https://github.com/kubernetes/kubernetes/pull/62467), [@andyzhangx](https://github.com/andyzhangx)) +* Ensure expected load balancer is selected for Azure ([#62450](https://github.com/kubernetes/kubernetes/pull/62450), [@feiskyer](https://github.com/feiskyer)) +* Resolves forbidden error when the `daemon-set-controller` cluster role access `controllerrevisions` resources. ([#62146](https://github.com/kubernetes/kubernetes/pull/62146), [@frodenas](https://github.com/frodenas)) +* fix incompatible file type checking on Windows ([#62154](https://github.com/kubernetes/kubernetes/pull/62154), [@dixudx](https://github.com/dixudx)) +* fix local volume absolute path issue on Windows ([#620s18](https://github.com/kubernetes/kubernetes/pull/62018), [@andyzhangx](https://github.com/andyzhangx)) +* fix the issue that default azure disk fsypte(ext4) does not work on Windows ([#62250](https://github.com/kubernetes/kubernetes/pull/62250), [@andyzhangx](https://github.com/andyzhangx)) +* Fixed bug in rbd-nbd utility when nbd is used. ([#62168](https://github.com/kubernetes/kubernetes/pull/62168), [@piontec](https://github.com/piontec)) +* fix local volume issue on Windows ([#62012](https://github.com/kubernetes/kubernetes/pull/62012), [@andyzhangx](https://github.com/andyzhangx)) +* Fix a bug that fluentd doesn't inject container logs for CRI container runtimes (containerd, cri-o etc.) into elasticsearch on GCE. ([#61818](https://github.com/kubernetes/kubernetes/pull/61818), [@Random-Liu](https://github.com/Random-Liu)) +* flexvolume: trigger plugin init only for the relevant plugin while probe ([#58519](https://github.com/kubernetes/kubernetes/pull/58519), [@linyouchong](https://github.com/linyouchong)) +* Fixed ingress issue with CDK and pre-1.9 versions of kubernetes. ([#61859](https://github.com/kubernetes/kubernetes/pull/61859), [@hyperbolic2346](https://github.com/hyperbolic2346)) +* Fixed racy panics when using fake watches with ObjectTracker ([#61195](https://github.com/kubernetes/kubernetes/pull/61195), [@grantr](https://github.com/grantr)) +* Fixed mounting of UNIX sockets(and other special files) in subpaths ([#61480](https://github.com/kubernetes/kubernetes/pull/61480), [@gnufscied](https://github.com/gnufied)) +* Fixed [#61123](https://github.com/kubernetes/kubernetes/pull/61123) by triggering syncer.Update on all cases including when a syncer is created ([#61124](https://github.com/kubernetes/kubernetes/pull/61124), [@satyasm](https://github.com/satyasm)) +* Fixed data race in node lifecycle controller ([#60831](https://github.com/kubernetes/kubernetes/pull/60831), [@resouer](https://github.com/resouer)) +* Fixed resultRun by resetting it to 0 on pod restart ([#62853](https://github.com/kubernetes/kubernetes/pull62853), [@tony612](https://github.com/tony612)) +* Fixed the liveness probe to use `/bin/bash -c` instead of `/bin/bash c`. ([#63033](https://github.com/kubernetes/kubernetes/pull/63033), [@bmoyles0117](https://github.com/bmoyles0117)) +* Fixed scheduler informers to receive events for all the pods in the cluster. ([#63003](https://github.com/kubernetes/kubernetes/pull/63003), [@bsalamat](https://github.com/bsalamat)) +* Fixed in vSphere Cloud Provider to handle upgrades from kubernetes version less than v1.9.4 to v1.9.4 and above. ([#62919](https://github.com/kubernetes/kubernetes/pull/62919), [@abrarshivani](https://github.com/abrarshivani)) +* Fixed error where config map for Metadata Agent was not created by addon manager. ([#62909](https://github.com/kubernetes/kubernetes/pull/62909), [@kawych](https://github.com/kawych)) +* Fixed permissions to allow statefulset scaling for admins, editors, and viewers ([#62336](https://github.com/kubernetes/kubernetes/pull/62336), [@deads2k](https://github.com/deads2k)) +* GCE: Fixed for internal load balancer management resulting in backend services with outdated instance group links. ([#62885](https://github.com/kubernetes/kubernetes/pull/62885), [@nicksardo](https://github.com/nicksardo)) +* Deployment will stop adding pod-template-hash labels/selector to ReplicaSets and Pods it adopts. Resources created by Deployments are not affected (will still have pod-template-hash labels/selector). ([#61615](https://github.com/kubernetes/kubernetes/pull/61615), [@janetkuo](https://github.com/janetkuo)) +* Used inline func to ensure unlock is executed ([#61644](https://github.com/kubernetes/kubernetes/pull/61644), [@resouer](https://github.com/resouer)) +* kubernetes-master charm now properly clears the client-ca-file setting on the apiserver snap ([#61479](https://github.com/kubernetes/kubernetes/pull/61479), [@hyperbolic2346](https://github.com/hyperbolic2346)) +* Bound cloud allocator to 10 retries with 100 ms delay between retries. ([#61375](https://github.com/kubernetes/kubernetes/pull/61375), [@satyasm](https://github.com/satyasm)) +* Respect fstype in Windows for azure disk ([#61267](https://github.com/kubernetes/kubernetes/pull/61267), [@andyzhangx](https://github.com/andyzhangx)) +* Unready pods will no longer impact the number of desired replicas when using horizontal auto-scaling with external metrics or object metrics. ([#60886](https://github.com/kubernetes/kubernetes/pull/60886), [@mattjmcnaughton](https://github.com/mattjmcnaughton)) +* Removed unsafe double RLock in cpumanager ([#62464](https://github.com/kubernetes/kubernetes/pull/62464), [@choury](https://github.com/choury)) + +## Non-user-facing changes + +* Remove UID mutation from request.context. ([#63957](https://github.com/kubernetes/kubernetes/pull/63957), [@hzxuzhonghu](https://github.com/hzxuzhonghu)) +* Use Patch instead of Put to sync pod status. ([#62306](https://github.com/kubernetes/kubernetes/pull/62306), [@freehan](https://github.com/freehan)) +* Allow env from resource with keys & updated tests ([#60636](https://github.com/kubernetes/kubernetes/pull/60636), [@PhilipGough](https://github.com/PhilipGough)) +* set EnableHTTPSTrafficOnly in azure storage account creation ([#64957](https://github.com/kubernetes/kubernetes/pull/64957), [@andyzhangx](https://github.com/andyzhangx)) +* New conformance test added for Watch. ([#61424](https://github.com/kubernetes/kubernetes/pull/61424), [@jennybuckley](https://github.com/jennybuckley)) +* Use DeleteOptions.PropagationPolicy instead of OrphanDependents in kubectl ([#59851](https://thub.com/kubernetes/kubernetes/pull/59851), [@nilebox](https://github.com/nilebox)) +* Add probe based mechanism for kubelet plugin discovery ([#63328](https://github.com/kubernetes/kubernetes/pull/63328), [@vikaschoudhary16](https://github.com/vikaschoudhary16)) +* keep pod state consistent when scheduler cache UpdatePod ([#64692](https://github.com/kubernetes/kubernetes/pull/64692), [@adohe](https://github.com/adohe)) +* kubectl delete does not use reapers for removing objects anymore, but relies on server-side GC entirely ([#63979](https://github.com/kubernetes/kubernetes/pull/63979), [@soltysh](https://github.com/soltysh)) +* Updated default image for nginx ingress in CDK to match current Kubernetes docs. ([#64285](https://github.com/kubernetes/kubernetes/pull/64285), [@hyperbolic2346](https://github.com/hyperbolic2346)) +* Increase scheduler cache generation number monotonically in order to avoid collision and use of stale information in scheduler. ([#63264](https://github.com/kubernetes/kubernetes/pull/63264), [@bsalamat](https://github.com/bsalamat)) +* Adding CSI driver registration code. ([#64560](https://github.com/kubernetes/kubernetes/pull/64560), [@sbezverk](https://github.com/sbezverk)) +* Do not check vmSetName when getting Azure node's IP ([#63541](https://github.com/kubernetes/kubernetes/pull/63541), [@feiskyer](https://github.com/feiskyer)) +* [fluentd-gcp addon] Update event-exporter image to have the latest base image. ([#61727](https://github.com/kubernetes/kubernetes/pull/61727), [@crassirostris](https://github.com/crassirostris)) +* Make volume usage metrics available for Cinder ([#62668](https://github.com/kubernetes/kubernetes/pull/62668), [@zetaab](https://github.com/zetaab)) +* cinder volume plugin : When the cinder volume status is `error`, controller will not do `attach ` and `detach ` operation ([#61082](https://github.com/kubernetes/kubernetes/pull/61082), [@wenlxie](https://github.com/wenlxie)) +* Allow user to scale l7 default backend deployment ([#62685](https://github.com/kubernetes/kubernetes/pull/62685), [@freehan](https://github.com/freehan)) +* Add support to ingest log entries to Stackdriver against new "k8s_container" and "k8s_node" resources. ([#62076](https://github.com/kubernetes/kubernetes/pull/62076), [@qingling128](https://github.com/qingling128)) +* Disabled CheckNodeMemoryPressure and CheckNodeDiskPressure predicates if TaintNodesByCondition enabled ([#60398](https://github.com/kubernetes/kubernetes/pull/60398), [@k82cn](https://github.com/k82cn)) +* Support custom test configuration for IPAM performance integration tests ([#61959](https://github.com/kubernetes/kubernetes/pull/61959), [@satyasm](https://github.com/satyasm)) +* OIDC authentication now allows tokens without an "email_verified" claim when using the "email" claim. If an "email_verified" claim is present when using the "email" claim, it must be `true`. ([#61508](https://github.com/kubernetes/kubernetes/pull/61508), [@rithujohn191](https://github.com/rithujohn191)) +* Add e2e test for CRD Watch ([#61025](https://github.com/kubernetes/kubernetes/pull/61025), [@ayushpateria](https://github.com/ayushpateria)) +* Return error if get NodeStageSecret and NodePublishSecret failed in CSI volume plugin ([#61096](https://github.com/kubernetes/kubernetes/pull/61096), [@mlmhl](https://github.com/mlmhl)) +* kubernetes-master charm now supports metrics server for horizontal pod autoscaler. ([#60174](https://github.com/kubernetes/kubernetes/pull/60174), [@hyperbolic2346](https://github.com/hyperbolic2346)) +* In a GCE cluster, the default `HIRPIN_MODE` is now "hairpin-veth". ([#60166](https://github.com/kubernetes/kubernetes/pull/60166), [@rramkumar1](https://github.com/rramkumar1)) +* Balanced resource allocation priority in scheduler to include volume count on node ([#60525](https://github.com/kubernetes/kubernetes/pull/60525), [@ravisantoshgudimetla](https://github.com/ravisantoshgudimetla)) +* new dhcp-domain parameter to be used for figuring out the hostname of a node ([#61890](https://github.com/kubernetes/kubernetes/pull/61890), [@dims](https://github.com/dims)) +* Disable ipamperf integration tests as part of every PR verification. ([#61863](https://github.com/kubernetes/kubernetes/pull/61863), [@satyasm](https://github.com/satyasm)) +* Enable server-side print in kubectl by default, with the ability to turn it off with --server-print=false ([#61477](https://github.com/kubernetes/kubernetes/pull/61477), [@soltysh](https://github.com/soltysh)) +* Updated admission controller settings for Juju deployed Kubernetes clusters ([#61427](https://github.com/kubernetes/kubernetes/pull/61427), [@hyperbolic2346](https://github.com/hyperbolic2346)) +* Performance test framework and basic tests for the IPAM controller, to simulate behavior of the four supported modes under lightly loaded and loaded conditions, where load is defined as the number of operations to perform as against the configured kubernetes. ([#61143](https://github.com/kubernetes/kubernetes/pull/61143), [@satyasm](https://github.com/satyasm)) +* Removed always pull policy from the template for ingress on CDK. ([#61598](https://github.com/kubernetes/kubernetes/pull/61598), [@hyperbolic2346](https://github.com/hyperbolic2346)) +* `make test-cmd` now works on OSX. ([#61393](https://github.com/kubernetes/kubernetes/pull/61393), [@totherme](https://github.com/totherme)) +* Conformance: ReplicaSet must be supported in the `apps/v1` version. ([#61367](https://github.com/kubernetes/kubernetes/pull/61367), [@enisoc](https://github.com/enisoc)) +* Remove 'system' prefix from Metadata Agent rbac configuration ([#61394](https://github.com/kubernetes/kubernetes/pull/61394), [@kawych](https://github.com/kawych)) +* Support new NODE_OS_DISTRIBUTION 'custom' on GCE on a new add event. ([#61235](https://github.com/kubernetes/kubernetes/pull/61235), [@yguo0905](https://github.com/yguo0905)) +* include file name in the error when visiting files ([#60919](https://github.com/kubernetes/kubernetes/pull/60919), [@dixudx](https://github.com/dixudx)) +* Split PodPriority and PodPreemption feature gate ([#62243](https://github.com/kubernetes/kubernetes/pull/62243), [@resouer](https://github.com/resouer)) +* Code generated for CRDs now passes `go vet`. ([#62412](https://github.com/kubernetes/kubernetes/pull/62412), [@bhcleek](https://github.com/bhcleek)) +* "beginPort+offset" format support for port range which affects kube-proxy only ([#58731](https://github.com/kubernetes/kubernetes/pull/58731), [@yue9944882](https://github.com/yue9944882)) +* Added e2e test for watch ([#60331](https://github.com/kubernetes/kubernetes/pull/60331), [@jennybuckley](https://github.com/jennybuckley)) +* add warnings on using pod-infra-container-image for remote container runtime ([#62982](https://github.com/kubernetes/kubernetes/pull/62982), [@dixudx](https://github.com/dixudx)) +* Mount additional paths required for a working CA root, for setups where /etc/ssl/certs doesn't contains certificates but just symlink. ([#59122](https://github.com/kubernetes/kubernetes/pull/59122), [@klausenbusk](https://github.com/klausenbusk)) +* Introduce truncating audit bacnd that can be enabled for existing backend to limit the size of individual audit events and batches of events. ([#61711](https://github.com/kubernetes/kubernetes/pull/61711), [@crassirostris](https://github.com/crassirostris)) +* stop kubelet to cloud provider integration potentially wedging kubelet sync loop ([#62543](https://github.com/kubernetes/kubernetes/pull/62543), [@ingvagabund](https://github.com/ingvagabund)) +* Set pod status to "Running" if there is at least one container still reporting as "Running" status and others are "Completed". ([#62642](https://github.com/kubernetes/kubernetes/pull/62642), [@ceshihao](https://github.com/ceshihao)) +* Fix memory cgroup notifications, and reduce associated log spam. ([#63220](https://github.com/kubernetes/kubernetes/pull/63220), [@dashpole](https://github.com/dashpole)) +* Remove never used NewCronJobControllerFromClient method (#59471, dmathieu) + +{{% /capture %}} diff --git a/content/en/docs/reference/_index.md b/content/en/docs/reference/_index.md index 3926ed9a1681c..c8df4c82f41ea 100644 --- a/content/en/docs/reference/_index.md +++ b/content/en/docs/reference/_index.md @@ -11,12 +11,11 @@ weight: 70 * [Kubernetes API Overview](/docs/reference/using-api/api-overview/) - Overview of the API for Kubernetes. * Kubernetes API Versions - * [1.10](/docs/reference/generated/kubernetes-api/v1.10/) - * [1.9](https://v1-9.docs.kubernetes.io/docs/reference/) - * [1.8](https://v1-8.docs.kubernetes.io/docs/reference/) - * [1.7](https://v1-7.docs.kubernetes.io/docs/reference/) - * [1.6](https://v1-6.docs.kubernetes.io/docs/reference/) - * [1.5](https://v1-5.docs.kubernetes.io/docs/reference/) + * [1.11](/docs/reference/generated/kubernetes-api/v1.11/) + * [1.10](https://v1-10.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.10/) + * [1.9](https://v1-9.docs.kubernetes.io/docs/api-reference/v1.9/) + * [1.8](https://v1-8.docs.kubernetes.io/docs/api-reference/v1.8/) + * [1.7](https://v1-7.docs.kubernetes.io/docs/api-reference/v1.7/) ## API Client Libraries 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 cfcf69225cbc6..59aac722c407d 100644 --- a/content/en/docs/reference/access-authn-authz/admission-controllers.md +++ b/content/en/docs/reference/access-authn-authz/admission-controllers.md @@ -7,11 +7,15 @@ reviewers: - janetkuo - thockin title: Using Admission Controllers +content_template: templates/concept weight: 30 --- -{{< toc >}} +{{% capture overview %}} +This page provides an overview of Admission Controllers. +{{% /capture %}} +{{% capture body %}} ## What are they? An admission controller is a piece of code that intercepts requests to the @@ -22,7 +26,7 @@ is authenticated and authorized. The controllers consist of the administrator. In that list, there are two special controllers: MutatingAdmissionWebhook and ValidatingAdmissionWebhook. These execute the mutating and validating (respectively) [admission control -webhooks](/docs/admin/extensible-admission-controllers/#external-admission-webhooks) +webhooks](/docs/admin/extensible-admission-controllers.md#external-admission-webhooks) which are configured in the API. Admission controllers may be "validating", "mutating", or both. Mutating @@ -79,11 +83,11 @@ kube-apiserver --disable-admission-plugins=PodNodeSelector,AlwaysDeny ... ## What does each admission controller do? -### AlwaysAdmit (DEPRECATED) +### AlwaysAdmit (DEPRECATED) {#alwaysadmit} Use this admission controller by itself to pass-through all requests. AlwaysAdmit is DEPRECATED as no real meaning. -### AlwaysPullImages +### AlwaysPullImages {#alwayspullimages} This admission controller modifies every new Pod to force the image pull policy to Always. This is useful in a multitenant cluster so that users can be assured that their private images can only be used by those @@ -93,11 +97,11 @@ scheduled onto the right node), without any authorization check against the imag is enabled, images are always pulled prior to starting containers, which means valid credentials are required. -### AlwaysDeny (DEPRECATED) +### AlwaysDeny (DEPRECATED) {#alwaysdeny} Rejects all requests. AlwaysDeny is DEPRECATED as no real meaning. -### DefaultStorageClass +### DefaultStorageClass {#defaultstorageclass} This admission controller observes creation of `PersistentVolumeClaim` objects that do not request any specific storage class and automatically adds a default storage class to them. @@ -112,7 +116,7 @@ This admission controller ignores any `PersistentVolumeClaim` updates; it acts o See [persistent volume](/docs/concepts/storage/persistent-volumes/) documentation about persistent volume claims and storage classes and how to mark a storage class as default. -### DefaultTolerationSeconds +### DefaultTolerationSeconds {#defaulttolerationseconds} This admission controller sets the default forgiveness toleration for pods to tolerate the taints `notready:NoExecute` and `unreachable:NoExecute` for 5 minutes, @@ -120,7 +124,7 @@ if the pods don't already have toleration for taints `node.kubernetes.io/not-ready:NoExecute` or `node.alpha.kubernetes.io/unreachable:NoExecute`. -### DenyExecOnPrivileged (deprecated) +### DenyExecOnPrivileged (deprecated) {#denyexeconprivileged} This admission controller will intercept all requests to exec a command in a pod if that pod has a privileged container. @@ -129,7 +133,7 @@ commands in those containers, we strongly encourage enabling this admission cont This functionality has been merged into [DenyEscalatingExec](#denyescalatingexec). -### DenyEscalatingExec +### DenyEscalatingExec {#denyescalatingexec} This admission controller will deny exec and attach commands to pods that run with escalated privileges that allow host access. This includes pods that run as privileged, have access to the host IPC namespace, and @@ -139,11 +143,13 @@ If your cluster supports containers that run with escalated privileges, and you restrict the ability of end-users to exec commands in those containers, we strongly encourage enabling this admission controller. -### EventRateLimit (alpha) +### EventRateLimit (alpha) {#eventratelimit} This admission controller mitigates the problem where the API server gets flooded by event requests. The cluster admin can specify event rate limits by: + * Ensuring that `eventratelimit.admission.k8s.io/v1alpha1=true` is included in the + `--runtime-config` flag for the API server; * Enabling the `EventRateLimit` admission controller; * Referencing an `EventRateLimit` configuration file from the file provided to the API server's command line flag `--admission-control-config-file`: @@ -183,7 +189,7 @@ limits: See the [EventRateLimit proposal](https://git.k8s.io/community/contributors/design-proposals/api-machinery/admission_control_event_rate_limit.md) for more details. -### ExtendedResourceToleration +### ExtendedResourceToleration {#extendedresourcetoleration} This plug-in facilitates creation of dedicated nodes with extended resources. If operators want to create dedicated nodes with extended resources (like GPUs, FPGAs etc.), they are expected to @@ -192,7 +198,7 @@ name as the key. This admission controller, if enabled, automatically adds tolerations for such taints to pods requesting extended resources, so users don't have to manually add these tolerations. -### ImagePolicyWebhook +### ImagePolicyWebhook {#imagepolicywebhook} The ImagePolicyWebhook admission controller allows a backend webhook to make admission decisions. @@ -225,8 +231,7 @@ plugins: ... ``` -The ImagePolicyWebhook config file must reference a [kubeconfig](/docs/tasks/access-application-cluster/configure-access-multiple-clusters/) -formatted file which sets up the connection to the backend. It is required that the backend communicate over TLS. +The ImagePolicyWebhook config file must reference a [kubeconfig](/docs/concepts/cluster-administration/authenticate-across-clusters-kubeconfig/) formatted file which sets up the connection to the backend. It is required that the backend communicate over TLS. The kubeconfig file's cluster field must point to the remote service, and the user field must contain the returned authorizer. @@ -245,7 +250,7 @@ users: client-certificate: /path/to/cert.pem # cert for the webhook admission controller to use client-key: /path/to/key.pem # key matching the cert ``` -For additional HTTP configuration, refer to the [kubeconfig](/docs/tasks/access-application-cluster/configure-access-multiple-clusters/) documentation. +For additional HTTP configuration, refer to the [kubeconfig](/docs/concepts/cluster-administration/authenticate-across-clusters-kubeconfig/) documentation. #### Request Payloads @@ -315,30 +320,19 @@ Examples of information you might put here are: In any case, the annotations are provided by the user and are not validated by Kubernetes in any way. In the future, if an annotation is determined to be widely useful, it may be promoted to a named field of ImageReviewSpec. -### Initializers (alpha) +### Initializers (alpha) {#initializers} The admission controller determines the initializers of a resource based on the existing `InitializerConfiguration`s. It sets the pending initializers by modifying the metadata of the resource to be created. -For more information, please check [Dynamic Admission Control](/docs/admin/extensible-admission-controllers/). +For more information, please check [Dynamic Admission Control](/docs/admin/extensible-admission-controllers.md). -### InitialResources (experimental) - -This admission controller observes pod creation requests. If a container omits compute resource requests and limits, -then the admission controller auto-populates a compute resource request based on historical usage of containers running the same image. -If there is not enough data to make a decision the Request is left unchanged. -When the admission controller sets a compute resource request, it does this by *annotating* -the pod spec rather than mutating the `container.resources` fields. -The annotations added contain the information on what compute resources were auto-populated. - -See the [InitialResources proposal](https://git.k8s.io/community/contributors/design-proposals/autoscaling/initial-resources.md) for more details. - -### LimitPodHardAntiAffinityTopology +### LimitPodHardAntiAffinityTopology {#limitpodhardantiaffinitytopology} This admission controller denies any pod that defines `AntiAffinity` topology key other than `kubernetes.io/hostname` in `requiredDuringSchedulingRequiredDuringExecution`. -### LimitRanger +### LimitRanger {#limitranger} This admission controller will observe the incoming request and ensure that it does not violate any of the constraints enumerated in the `LimitRange` object in a `Namespace`. If you are using `LimitRange` objects in @@ -346,9 +340,9 @@ your Kubernetes deployment, you MUST use this admission controller to enforce th be used to apply default resource requests to Pods that don't specify any; currently, the default LimitRanger applies a 0.1 CPU requirement to all Pods in the `default` namespace. -See the [limitRange design doc](https://git.k8s.io/community/contributors/design-proposals/resource-management/admission_control_limit_range.md) and the [example of Limit Range](/docs/tasks/administer-cluster/memory-default-namespace/) for more details. +See the [limitRange design doc](https://git.k8s.io/community/contributors/design-proposals/resource-management/admission_control_limit_range.md) and the [example of Limit Range](/docs/tasks/configure-pod-container/limit-range/) for more details. -### MutatingAdmissionWebhook (beta in 1.9) +### MutatingAdmissionWebhook (beta in 1.9) {#mutatingadmissionwebhook} This admission controller calls any mutating webhooks which match the request. Matching webhooks are called in serial; each one may modify the object if it desires. @@ -379,7 +373,7 @@ versions >= 1.9). is finalized, not all possible webhook behaviors will be guaranteed to be supported indefinitely. -### NamespaceAutoProvision +### NamespaceAutoProvision {#namespaceautoprovision} This admission controller examines all incoming requests on namespaced resources and checks if the referenced namespace does exist. @@ -387,12 +381,12 @@ It creates a namespace if it cannot be found. This admission controller is useful in deployments that do not want to restrict creation of a namespace prior to its usage. -### NamespaceExists +### NamespaceExists {#namespaceexists} This admission controller checks all requests on namespaced resources other than `Namespace` itself. If the namespace referenced from a request doesn't exist, the request is rejected. -### NamespaceLifecycle +### NamespaceLifecycle {#namespacelifecycle} This admission controller enforces that a `Namespace` that is undergoing termination cannot have new objects created in it, and ensures that requests in a non-existent `Namespace` are rejected. This admission controller also prevents deletion of @@ -401,14 +395,15 @@ three system reserved namespaces `default`, `kube-system`, `kube-public`. A `Namespace` deletion kicks off a sequence of operations that remove all objects (pods, services, etc.) in that namespace. In order to enforce integrity of that process, we strongly recommend running this admission controller. -### NodeRestriction +### NodeRestriction {#noderestriction} This admission controller limits the `Node` and `Pod` objects a kubelet can modify. In order to be limited by this admission controller, kubelets must use credentials in the `system:nodes` group, with a username in the form `system:node:`. Such kubelets will only be allowed to modify their own `Node` API object, and only modify `Pod` API objects that are bound to their node. +In Kubernetes 1.11+, kubelets are not allowed to update or remove taints from their `Node` API object. Future versions may add additional restrictions to ensure kubelets have the minimal set of permissions required to operate correctly. -### OwnerReferencesPermissionEnforcement +### OwnerReferencesPermissionEnforcement {#ownerreferencespermissionenforcement} This admission controller protects the access to the `metadata.ownerReferences` of an object so that only users with "delete" permission to the object can change it. @@ -416,7 +411,7 @@ This admission controller also protects the access to `metadata.ownerReferences[ of an object, so that only users with "update" permission to the `finalizers` subresource of the referenced *owner* can change it. -### PersistentVolumeLabel (DEPRECATED) +### PersistentVolumeLabel (DEPRECATED) {#persistentvolumelabel} This admission controller automatically attaches region or zone labels to PersistentVolumes as defined by the cloud provider (for example, GCE or AWS). @@ -424,9 +419,11 @@ It helps ensure the Pods and the PersistentVolumes mounted are in the same region and/or zone. If the admission controller doesn't support automatic labelling your PersistentVolumes, you may need to add the labels manually to prevent pods from mounting volumes from -a different zone. PersistentVolumeLabel is DEPRECATED and labeling persistent volumes has been taken over by [cloud controller manager](/docs/tasks/administer-cluster/running-cloud-controller/). +a different zone. PersistentVolumeLabel is DEPRECATED and labeling persistent volumes has been taken over by +[cloud controller manager](/docs/tasks/administer-cluster/running-cloud-controller/). +Starting from 1.11, this admission controller is disabled by default. -### PodNodeSelector +### PodNodeSelector {#podnodeselector} This admission controller defaults and limits what node selectors may be used within a namespace by reading a namespace annotation and a global configuration. @@ -469,20 +466,20 @@ metadata: #### Internal Behavior This admission controller has the following behavior: - 1. If the `Namespace` has an annotation with a key `scheduler.alpha.kubernetes.io/node-selector`, use its value as the - node selector. - 1. If the namespace lacks such an annotation, use the `clusterDefaultNodeSelector` defined in the `PodNodeSelector` - plugin configuration file as the node selector. - 1. Evaluate the pod's node selector against the namespace node selector for conflicts. Conflicts result in rejection. - 1. Evaluate the pod's node selector against the namespace-specific whitelist defined the plugin configuration file. - Conflicts result in rejection. +1. If the `Namespace` has an annotation with a key `scheduler.alpha.kubernetes.io/node-selector`, use its value as the +node selector. +2. If the namespace lacks such an annotation, use the `clusterDefaultNodeSelector` defined in the `PodNodeSelector` +plugin configuration file as the node selector. +3. Evaluate the pod's node selector against the namespace node selector for conflicts. Conflicts result in rejection. +4. Evaluate the pod's node selector against the namespace-specific whitelist defined the plugin configuration file. +Conflicts result in rejection. {{< note >}} **Note:** PodNodeSelector allows forcing pods to run on specifically labeled nodes. Also see the PodTolerationRestriction admission plugin, which allows preventing pods from running on specifically tainted nodes. {{< /note >}} -### PersistentVolumeClaimResize +### PersistentVolumeClaimResize {#persistentvolumeclaimresize} This admission controller implements additional validations for checking incoming `PersistentVolumeClaim` resize requests. @@ -511,16 +508,16 @@ parameters: allowVolumeExpansion: true ``` -For more information about persistent volume claims, see ["PersistentVolumeClaims"](/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims). +For more information about persistent volume claims, see [PersistentVolumeClaims](/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims). -### PodPreset +### PodPreset {#podpreset} This admission controller injects a pod with the fields specified in a matching PodPreset. See also [PodPreset concept](/docs/concepts/workloads/pods/podpreset/) and [Inject Information into Pods Using a PodPreset](/docs/tasks/inject-data-application/podpreset) for more information. -### PodSecurityPolicy +### PodSecurityPolicy {#podsecuritypolicy} This admission controller acts on creation and modification of the pod and determines if it should be admitted based on the requested security context and the available Pod Security Policies. @@ -531,7 +528,7 @@ extensions group (`--runtime-config=extensions/v1beta1/podsecuritypolicy=true`). See also [Pod Security Policy documentation](/docs/concepts/policy/pod-security-policy/) for more information. -### PodTolerationRestriction +### PodTolerationRestriction {#podtolerationrestriction} This admission controller first verifies any conflict between a pod's tolerations and its namespace's tolerations, and rejects the pod request if there is a conflict. @@ -549,11 +546,11 @@ Tolerations to a namespace are assigned via the `scheduler.alpha.kubernetes.io/tolerationsWhitelist` annotation keys. -### Priority +### Priority {#priority} The priority admission controller uses the `priorityClassName` field and populates the integer value of the priority. If the priority class is not found, the Pod is rejected. -### ResourceQuota +### ResourceQuota {#resourcequota} This admission controller will observe the incoming request and ensure that it does not violate any of the constraints enumerated in the `ResourceQuota` object in a `Namespace`. If you are using `ResourceQuota` @@ -562,20 +559,20 @@ objects in your Kubernetes deployment, you MUST use this admission controller to See the [resourceQuota design doc](https://git.k8s.io/community/contributors/design-proposals/resource-management/admission_control_resource_quota.md) and the [example of Resource Quota](/docs/concepts/policy/resource-quotas/) for more details. -### SecurityContextDeny +### SecurityContextDeny {#securitycontextdeny} -This admission controller will deny any pod that attempts to set certain escalating [SecurityContext](/docs/tasks/configure-pod-container/security-context/) fields. This should be enabled if a cluster doesn't utilize [pod security policies](/docs/concepts/policy/pod-security-policy/) to restrict the set of values a security context can take. +This admission controller will deny any pod that attempts to set certain escalating [SecurityContext](/docs/user-guide/security-context) fields. This should be enabled if a cluster doesn't utilize [pod security policies](/docs/user-guide/pod-security-policy) to restrict the set of values a security context can take. -### ServiceAccount +### ServiceAccount {#serviceaccount} -This admission controller implements automation for [serviceAccounts](/docs/tasks/configure-pod-container/configure-service-account/). +This admission controller implements automation for [serviceAccounts](/docs/user-guide/service-accounts). We strongly recommend using this admission controller if you intend to make use of Kubernetes `ServiceAccount` objects. -### Storage Object in Use Protection (beta) -{{< feature-state for_k8s_version="v1.10" state="beta" >}} +### Storage Object in Use Protection + The `StorageObjectInUseProtection` plugin adds the `kubernetes.io/pvc-protection` or `kubernetes.io/pv-protection` finalizers to newly created Persistent Volume Claims (PVCs) or Persistent Volumes (PV). In case a user deletes a PVC or PV the PVC or PV is not removed until the finalizer is removed from the PVC or PV by PVC or PV Protection Controller. Refer to the [Storage Object in Use Protection](/docs/concepts/storage/persistent-volumes/#storage-object-in-use-protection) for more detailed information. -### ValidatingAdmissionWebhook (alpha in 1.8; beta in 1.9) +### ValidatingAdmissionWebhook (alpha in 1.8; beta in 1.9) {#validatingadmissionwebhook} This admission controller calls any validating webhooks which match the request. Matching webhooks are called in parallel; if any of them rejects the request, the request @@ -596,15 +593,17 @@ versions 1.9 and later). Yes. -For Kubernetes version 1.10 and later, we recommend running the following set of admission controllers using the ```--enable-admission-plugins``` flag (**order doesn't matter**). +For Kubernetes version 1.10 and later, we recommend running the following set of admission controllers using the `--enable-admission-plugins` flag (**order doesn't matter**). -Note: ```--admission-control``` was deprecated in 1.10 and replaced with ```--enable-admission-plugins```. +{{< note >}} +**Note:** `--admission-control` was deprecated in 1.10 and replaced with `--enable-admission-plugins`. +{{< /note >}} ```shell --enable-admission-plugins=NamespaceLifecycle,LimitRanger,ServiceAccount,DefaultStorageClass,DefaultTolerationSeconds,MutatingAdmissionWebhook,ValidatingAdmissionWebhook,ResourceQuota ``` -For Kubernetes 1.9 and earlier, we recommend running the following set of admission controllers using the ```--admission-control``` flag (**order matters**). +For Kubernetes 1.9 and earlier, we recommend running the following set of admission controllers using the `--admission-control` flag (**order matters**). * v1.9 @@ -644,3 +643,4 @@ admission controllers ran in the exact order specified. ```shell --admission-control=NamespaceLifecycle,LimitRanger,SecurityContextDeny,ServiceAccount,PersistentVolumeLabel,ResourceQuota ``` +{{% /capture %}} diff --git a/content/en/docs/reference/access-authn-authz/authentication.md b/content/en/docs/reference/access-authn-authz/authentication.md index 296fd4d3a66a0..1ccf0331c698c 100644 --- a/content/en/docs/reference/access-authn-authz/authentication.md +++ b/content/en/docs/reference/access-authn-authz/authentication.md @@ -6,11 +6,15 @@ reviewers: - deads2k - liggitt title: Authenticating +content_template: templates/concept weight: 10 --- -{{< toc >}} +{{% capture overview %}} +This page provides an overview of authenticating. +{{% /capture %}} +{{% capture body %}} ## Users in Kubernetes All Kubernetes clusters have two categories of users: service accounts managed @@ -90,12 +94,15 @@ The API server reads bearer tokens from a file when given the `--token-auth-file changed without restarting API server. The token file is a csv file with a minimum of 3 columns: token, user name, user uid, -followed by optional group names. Note, if you have more than one group the column must be -double quoted e.g. +followed by optional group names. + +{{< note >}} +**Note:** If you have more than one group the column must be double quoted e.g. ```conf token,user,uid,"group1,group2,group3" ``` +{{< /note >}} #### Putting a Bearer Token in a Request @@ -182,9 +189,11 @@ mounted into pods at well-known locations, and allow in-cluster processes to talk to the API server. Accounts may be explicitly associated with pods using the `serviceAccountName` field of a `PodSpec`. -NOTE: `serviceAccountName` is usually omitted because this is done automatically. +{{< note >}} +**Note:** `serviceAccountName` is usually omitted because this is done automatically. +{{< /note >}} -``` +```yaml apiVersion: apps/v1 # this apiVersion is relevant as of Kubernetes 1.9 kind: Deployment metadata: @@ -236,7 +245,9 @@ metadata: type: kubernetes.io/service-account-token ``` -Note: values are base64 encoded because secrets are always base64 encoded. +{{< note >}} +**Note:** Values are base64 encoded because secrets are always base64 encoded. +{{< /note >}} The signed JWT can be used as a bearer token to authenticate as the given service account. See [above](#putting-a-bearer-token-in-a-request) for how the token is included @@ -393,8 +404,8 @@ Webhook authentication is a hook for verifying bearer tokens. * `--authentication-token-webhook-cache-ttl` how long to cache authentication decisions. Defaults to two minutes. The configuration file uses the [kubeconfig](/docs/concepts/cluster-administration/authenticate-across-clusters-kubeconfig/) -file format. Within the file "users" refers to the API server webhook and -"clusters" refers to the remote service. An example would be: +file format. Within the file `users` refers to the API server webhook and +`clusters` refers to the remote service. An example would be: ```yaml # clusters refers to the remote service. @@ -506,7 +517,7 @@ For example, with this configuration: this request: -``` +```http GET / HTTP/1.1 X-Remote-User: fido X-Remote-Group: dogs @@ -664,7 +675,7 @@ rules: ## client-go credential plugins -{{< feature-state for_k8s_version="v1.10" state="alpha" >}} +{{< feature-state for_k8s_version="v1.11" state="beta" >}} `k8s.io/client-go` and tools using it such as `kubectl` and `kubelet` are able to execute an external command to receive user credentials. @@ -675,8 +686,6 @@ protocol specific logic, then returns opaque credentials to use. Almost all cred use cases require a server side component with support for the [webhook token authenticator](#webhook-token-authentication) to interpret the credential format produced by the client plugin. -As of 1.10 only bearer tokens are supported. Support for client certs may be added in a future release. - ### Example use case In a hypothetical use case, an organization would run an external service that exchanges LDAP credentials @@ -694,7 +703,7 @@ To authenticate against the API: ### Configuration -Credential plugins are configured through [`kubectl` config files](/docs/tasks/access-application-cluster/configure-access-multiple-clusters/) +Credential plugins are configured through [kubectl config files](/docs/tasks/access-application-cluster/configure-access-multiple-clusters/) as part of the user fields. ```yaml @@ -707,11 +716,13 @@ users: # Command to execute. Required. command: "example-client-go-exec-plugin" - # API version to use when encoding and decoding the ExecCredentials - # resource. Required. + # API version to use when decoding the ExecCredentials resource. Required. # - # The API version returned by the plugin MUST match the version encoded. - apiVersion: "client.authentication.k8s.io/v1alpha1" + # The API version returned by the plugin MUST match the version listed here. + # + # To integrate with tools that support multiple versions (such as client.authentication.k8s.io/v1alpha1), + # set an environment variable or pass an argument to the tool that indicates which version the exec plugin expects. + apiVersion: "client.authentication.k8s.io/v1beta1" # Environment variables to set when executing the plugin. Optional. env: @@ -745,72 +756,61 @@ the binary `/home/jane/bin/example-client-go-exec-plugin` is executed. exec: # Path relative to the directory of the kubeconfig command: "./bin/example-client-go-exec-plugin" - apiVersion: "client.authentication.k8s.io/v1alpha1" + apiVersion: "client.authentication.k8s.io/v1beta1" ``` ### Input and output formats -When executing the command, `k8s.io/client-go` sets the `KUBERNETES_EXEC_INFO` environment -variable to a JSON serialized [`ExecCredential`]( -https://github.com/kubernetes/client-go/blob/master/pkg/apis/clientauthentication/v1alpha1/types.go) -resource. +The executed command prints an `ExecCredential` object to `stdout`. `k8s.io/client-go` +authenticates against the Kubernetes API using the returned credentials in the `status`. -``` -KUBERNETES_EXEC_INFO='{ - "apiVersion": "client.authentication.k8s.io/v1alpha1", - "kind": "ExecCredential", - "spec": { - "interactive": true - } -}' -``` - -When plugins are executed from an interactive session, `stdin` and `stderr` are directly -exposed to the plugin so it can prompt the user for input for interactive logins. +When run from an interactive session, `stdin` is exposed directly to the plugin. Plugins should use a +[TTY check](https://godoc.org/golang.org/x/crypto/ssh/terminal#IsTerminal) to determine if it's +appropriate to prompt a user interactively. -When responding to a 401 HTTP status code (indicating invalid credentials), this object will -include metadata about the response. +To use bearer token credentials, the plugin returns a token in the status of the `ExecCredential`. ```json { - "apiVersion": "client.authentication.k8s.io/v1alpha1", + "apiVersion": "client.authentication.k8s.io/v1beta1", "kind": "ExecCredential", - "spec": { - "response": { - "code": 401, - "header": { - "WWW-Authenticate": [ - "Bearer realm=ldap.example.com" - ] - }, - }, - "interactive": true + "status": { + "token": "my-bearer-token" } } ``` -The executed command is expected to print an `ExecCredential` to `stdout`. `k8s.io/client-go` -will then use the returned bearer token in the `status` when authenticating against the -Kubernetes API. +Alternatively, a PEM-encoded client certificate and key can be returned to use TLS client auth. +If the plugin returns a different certificate and key on a subsequent call, `k8s.io/client-go` +will close existing connections with the server to force a new TLS handshake. + +If specified, `clientKeyData` and `clientCertificateData` must both must be present. + +`clientCertificateData` may contain additional intermediate certificates to send to the server. ```json { - "apiVersion": "client.authentication.k8s.io/v1alpha1", + "apiVersion": "client.authentication.k8s.io/v1beta1", "kind": "ExecCredential", "status": { - "token": "my-bearer-token" + "clientCertificateData": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----", + "clientKeyData": "-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----" } } ``` -Optionally, this output can include the expiry of the token formatted as a RFC3339 timestamp. -If an expiry is omitted, the bearer token is cached until the server responds with a 401 HTTP -status code. Note that this caching is only for the duration of process and therefore the plugin -is triggered each time the tool using the plugin is invoked. +Optionally, the response can include the expiry of the credential formatted as a +RFC3339 timestamp. Presence or absence of an expiry has the following impact: + +- If an expiry is included, the bearer token and TLS credentials are cached until + the expiry time is reached, or if the server responds with a 401 HTTP status code, + or when the process exits. +- If an expiry is omitted, the bearer token and TLS credentials are cached until + the server responds with a 401 HTTP status code or until the process exits. ```json { - "apiVersion": "client.authentication.k8s.io/v1alpha1", + "apiVersion": "client.authentication.k8s.io/v1beta1", "kind": "ExecCredential", "status": { "token": "my-bearer-token", @@ -818,3 +818,4 @@ is triggered each time the tool using the plugin is invoked. } } ``` +{{% /capture %}} diff --git a/content/en/docs/reference/access-authn-authz/authorization.md b/content/en/docs/reference/access-authn-authz/authorization.md index 40dd7d47ab52c..f352f4caf0ece 100644 --- a/content/en/docs/reference/access-authn-authz/authorization.md +++ b/content/en/docs/reference/access-authn-authz/authorization.md @@ -17,7 +17,7 @@ policies using the supported authorization modules. {{% capture body %}} In Kubernetes, you must be authenticated (logged in) before your request can be authorized (granted permission to access). For information about authentication, -see [Accessing Control Overview](/docs/admin/accessing-the-api/). +see [Accessing Control Overview](/docs/reference/access-authn-authz/controlling-access/). Kubernetes expects attributes that are common to REST API requests. This means that Kubernetes authorization works with existing organization-wide or @@ -44,10 +44,10 @@ Kubernetes reviews only the following API request attributes: * **user** - The `user` string provided during authentication. * **group** - The list of group names to which the authenticated user belongs. - * **"extra"** - A map of arbitrary string keys to string values, provided by the authentication layer. + * **extra** - A map of arbitrary string keys to string values, provided by the authentication layer. * **API** - Indicates whether the request is for an API resource. * **Request path** - Path to miscellaneous non-resource endpoints like `/api` or `/healthz`. - * **API request verb** - API verbs `get`, `list`, `create`, `update`, `patch`, `watch`, `proxy`, `redirect`, `delete`, and `deletecollection` are used for resource requests. To determine the request verb for a resource API endpoint, see **Determine the request verb** below. + * **API request verb** - API verbs `get`, `list`, `create`, `update`, `patch`, `watch`, `proxy`, `redirect`, `delete`, and `deletecollection` are used for resource requests. To determine the request verb for a resource API endpoint, see [Determine the request verb](/docs/reference/access-authn-authz/authorization/#determine-whether-a-request-is-allowed-or-denied) below. * **HTTP request verb** - HTTP verbs `get`, `post`, `put`, and `delete` are used for non-resource requests. * **Resource** - The ID or name of the resource that is being accessed (for resource requests only) -- For resource requests using `get`, `update`, `patch`, and `delete` verbs, you must provide the resource name. * **Subresource** - The subresource that is being accessed (for resource requests only). @@ -70,17 +70,17 @@ DELETE | delete (for individual resources), deletecollection (for collections Kubernetes sometimes checks authorization for additional permissions using specialized verbs. For example: * [PodSecurityPolicy](/docs/concepts/policy/pod-security-policy/) checks for authorization of the `use` verb on `podsecuritypolicies` resources in the `policy` API group. -* [RBAC](/docs/admin/authorization/rbac/#privilege-escalation-prevention-and-bootstrapping) checks for authorization +* [RBAC](/docs/reference/access-authn-authz/rbac/#privilege-escalation-prevention-and-bootstrapping) checks for authorization of the `bind` verb on `roles` and `clusterroles` resources in the `rbac.authorization.k8s.io` API group. -* [Authentication](/docs/admin/authentication/) layer checks for authorization of the `impersonate` verb on `users`, `groups`, and `serviceaccounts` in the core API group, and the `userextras` in the `authentication.k8s.io` API group. +* [Authentication](/docs/reference/access-authn-authz/authentication/) layer checks for authorization of the `impersonate` verb on `users`, `groups`, and `serviceaccounts` in the core API group, and the `userextras` in the `authentication.k8s.io` API group. ## Authorization Modules - * **Node** - A special-purpose authorizer that grants permissions to kubelets based on the pods they are scheduled to run. To learn more about using the Node authorization mode, see [Node Authorization](/docs/admin/authorization/node/). - * **ABAC** - Attribute-based access control (ABAC) defines an access control paradigm whereby access rights are granted to users through the use of policies which combine attributes together. The policies can use any type of attributes (user attributes, resource attributes, object, environment attributes, etc). To learn more about using the ABAC mode, see [ABAC Mode](/docs/admin/authorization/abac/). - * **RBAC** - Role-based access control (RBAC) is a method of regulating access to computer or network resources based on the roles of individual users within an enterprise. In this context, access is the ability of an individual user to perform a specific task, such as view, create, or modify a file. To learn more about using the RBAC mode, see [RBAC Mode](/docs/admin/authorization/rbac/) - * When specified "RBAC" (Role-Based Access Control) uses the "rbac.authorization.k8s.io" API group to drive authorization decisions, allowing admins to dynamically configure permission policies through the Kubernetes API. + * **Node** - A special-purpose authorizer that grants permissions to kubelets based on the pods they are scheduled to run. To learn more about using the Node authorization mode, see [Node Authorization](/docs/reference/access-authn-authz/node/). + * **ABAC** - Attribute-based access control (ABAC) defines an access control paradigm whereby access rights are granted to users through the use of policies which combine attributes together. The policies can use any type of attributes (user attributes, resource attributes, object, environment attributes, etc). To learn more about using the ABAC mode, see [ABAC Mode](/docs/reference/access-authn-authz/abac/). + * **RBAC** - Role-based access control (RBAC) is a method of regulating access to computer or network resources based on the roles of individual users within an enterprise. In this context, access is the ability of an individual user to perform a specific task, such as view, create, or modify a file. To learn more about using the RBAC mode, see [RBAC Mode](/docs/reference/access-authn-authz/rbac/) + * When specified RBAC (Role-Based Access Control) uses the `rbac.authorization.k8s.io` API group to drive authorization decisions, allowing admins to dynamically configure permission policies through the Kubernetes API. * To enable RBAC, start the apiserver with `--authorization-mode=RBAC`. - * **Webhook** - A WebHook is an HTTP callback: an HTTP POST that occurs when something happens; a simple event-notification via HTTP POST. A web application implementing WebHooks will POST a message to a URL when certain things happen. To learn more about using the Webhook mode, see [Webhook Mode](/docs/admin/authorization/webhook/). + * **Webhook** - A WebHook is an HTTP callback: an HTTP POST that occurs when something happens; a simple event-notification via HTTP POST. A web application implementing WebHooks will POST a message to a URL when certain things happen. To learn more about using the Webhook mode, see [Webhook Mode](/docs/reference/access-authn-authz/webhook/). #### Checking API Access @@ -96,7 +96,7 @@ $ kubectl auth can-i create deployments --namespace prod no ``` -Administrators can combine this with ["user impersonation"](/docs/admin/authentication/#user-impersonation) +Administrators can combine this with [user impersonation](/docs/reference/access-authn-authz/authentication/#user-impersonation) to determine what action other users can perform. ```bash @@ -159,14 +159,6 @@ The following flags can be used: You can choose more than one authorization module. Modules are checked in order so an earlier module has higher priority to allow or deny a request. -{{% /capture %}} -{{% capture whatsnext %}} -* To learn more about Authentication, see **Authentication** in [Controlling Access to the Kubernetes API](/docs/admin/accessing-the-api/). -* To learn more about Admission Control, see [Using Admission Controllers](/docs/admin/admission-controllers/). -{{% /capture %}} - - - ## Privilege escalation via pod creation Users who have the ability to create pods in a namespace can potentially @@ -183,3 +175,9 @@ maps in the namespace; and impersonate any service account in the namespace and take any action the account could take. This applies regardless of authorization mode. {{< /caution >}} +{{% /capture %}} + +{{% capture whatsnext %}} +* To learn more about Authentication, see **Authentication** in [Controlling Access to the Kubernetes API](/docs/reference/access-authn-authz/controlling-access/). +* To learn more about Admission Control, see [Using Admission Controllers](/docs/reference/access-authn-authz/admission-controllers/). +{{% /capture %}} diff --git a/content/en/docs/reference/access-authn-authz/bootstrap-tokens.md b/content/en/docs/reference/access-authn-authz/bootstrap-tokens.md index de9d77e81b606..736461481daa8 100644 --- a/content/en/docs/reference/access-authn-authz/bootstrap-tokens.md +++ b/content/en/docs/reference/access-authn-authz/bootstrap-tokens.md @@ -2,19 +2,21 @@ reviewers: - jbeda title: Authenticating with Bootstrap Tokens +content_template: templates/concept weight: 20 --- -{{< toc >}} - -## Overview - +{{% capture overview %}} Bootstrap tokens are a simple bearer token that is meant to be used when creating new clusters or joining new nodes to an existing cluster. It was built -to support [`kubeadm`](/docs/admin/kubeadm/), but can be used in other contexts +to support [kubeadm](/docs/reference/setup-tools/kubeadm/kubeadm/), but can be used in other contexts for users that wish to start clusters without `kubeadm`. It is also built to work, via RBAC policy, with the [Kubelet TLS -Bootstrapping](/docs/admin/kubelet-tls-bootstrapping/) system. +Bootstrapping](/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping/) system. +{{% /capture %}} + +{{% capture body %}} +## Bootstrap Tokens Overview Bootstrap Tokens are defined with a specific type (`bootstrap.kubernetes.io/token`) of secrets that lives in the `kube-system` @@ -117,10 +119,10 @@ rejected when used for authentication and ignored during ConfigMap signing. The expiry value is encoded as an absolute UTC time using RFC3339. Enable the `tokencleaner` controller to automatically delete expired tokens. -## Token Management with `kubeadm` +## Token Management with kubeadm You can use the `kubeadm` tool to manage tokens on a running cluster. See the -[`kubeadm token` docs](/docs/admin/kubeadm/#manage-tokens) for details. +[kubeadm token docs](/docs/reference/setup-tools/kubeadm/kubeadm-token/) for details. ## ConfigMap Signing @@ -176,10 +178,13 @@ verify the JWS using the `HS256` scheme (HMAC-SHA256) with the full token (e.g. `07401b.f395accd246ae52d`) as the shared secret. Users _must_ verify that HS256 is used. -WARNING: Any party with a bootstrapping token can create a valid signature for that +{{< warning >}} +**Warning:** Any party with a bootstrapping token can create a valid signature for that token. When using ConfigMap signing it's discouraged to share the same token with many clients, since a compromised client can potentially man-in-the middle another client relying on the signature to bootstrap TLS trust. +{{< /warning >}} Consult the [kubeadm security model](/docs/reference/generated/kubeadm/#security-model) section for more information. +{{% /capture %}} diff --git a/content/en/docs/reference/access-authn-authz/controlling-access.md b/content/en/docs/reference/access-authn-authz/controlling-access.md index 30c2aeee60584..723a10463f3b6 100644 --- a/content/en/docs/reference/access-authn-authz/controlling-access.md +++ b/content/en/docs/reference/access-authn-authz/controlling-access.md @@ -4,9 +4,15 @@ reviewers: - erictune - lavalamp title: Controlling Access to the Kubernetes API +content_template: templates/concept weight: 5 --- +{{% capture overview %}} +This page provides an overview of controlling access to the Kubernetes API. +{{% /capture %}} + +{{% capture body %}} Users [access the API](/docs/tasks/access-application-cluster/access-cluster/) using `kubectl`, client libraries, or by making REST requests. Both human users and [Kubernetes service accounts](/docs/tasks/configure-pod-container/configure-service-account/) can be @@ -52,7 +58,7 @@ is available to subsequent steps to use in their decisions. Some authenticators also provide the group memberships of the user, while other authenticators do not. -While Kubernetes uses "usernames" for access control decisions and in request logging, +While Kubernetes uses `usernames` for access control decisions and in request logging, it does not have a `user` object nor does it store usernames or other information about users in its object store. @@ -156,4 +162,4 @@ When the cluster is created by `kube-up.sh`, on Google Compute Engine (GCE), and on several other cloud providers, the API server serves on port 443. On GCE, a firewall rule is configured on the project to allow external HTTPS access to the API. Other cluster setup methods vary. - +{{% /capture %}} diff --git a/content/en/docs/reference/access-authn-authz/extensible-admission-controllers.md b/content/en/docs/reference/access-authn-authz/extensible-admission-controllers.md index baa0a9a37eba5..6c307d08ad804 100644 --- a/content/en/docs/reference/access-authn-authz/extensible-admission-controllers.md +++ b/content/en/docs/reference/access-authn-authz/extensible-admission-controllers.md @@ -6,14 +6,12 @@ reviewers: - caesarxuchao - deads2k title: Dynamic Admission Control +content_template: templates/concept weight: 40 --- -{{< toc >}} - -## Overview - -The [admission controllers documentation](/docs/admin/admission-controllers/) +{{% capture overview %}} +The [admission controllers documentation](/docs/reference/access-authn-authz/admission-controllers/) introduces how to use standard, plugin-style admission controllers. However, plugin admission controllers are not flexible enough for all use cases, due to the following: @@ -26,16 +24,18 @@ address these limitations. They allow admission controllers to be developed out-of-tree and configured at runtime. This page describes how to use Admission Webhooks and Initializers. +{{% /capture %}} +{{% capture body %}} ## Admission Webhooks ### What are admission webhooks? Admission webhooks are HTTP callbacks that receive admission requests and do something with them. You can define two types of admission webhooks, -[validating admission Webhook](/docs/admin/admission-controllers/#validatingadmissionwebhook-alpha-in-18-beta-in-19) +[validating admission Webhook](/docs/reference/access-authn-authz/admission-controllers/#validatingadmissionwebhook-alpha-in-1-8-beta-in-1-9) and -[mutating admission webhook](/docs/admin/admission-controllers/#mutatingadmissionwebhook-beta-in-19). +[mutating admission webhook](/docs/reference/access-authn-authz/admission-controllers/#mutatingadmissionwebhook-beta-in-1-9). With validating admission Webhooks, you may reject requests to enforce custom admission policies. With mutating admission Webhooks, you may change requests to enforce custom defaults. @@ -44,7 +44,7 @@ enforce custom defaults. Admission webhooks are essentially part of the cluster control-plane. You should write and deploy them with great caution. Please read the [user -guides](https://github.com/kubernetes/website/pull/6836/files)(WIP) for +guides](/docs/reference/access-authn-authz/extensible-admission-controllers/#write-an-admission-webhook-server) for instructions if you intend to write/deploy production-grade admission webhooks. In the following, we describe how to quickly experiment with admission webhooks. @@ -54,7 +54,7 @@ In the following, we describe how to quickly experiment with admission webhooks. * Ensure that MutatingAdmissionWebhook and ValidatingAdmissionWebhook admission controllers are enabled. - [Here](/docs/admin/admission-controllers.md#is-there-a-recommended-set-of-admission-controllers-to-use) + [Here](/docs/reference/access-authn-authz/admission-controllers/#is-there-a-recommended-set-of-admission-controllers-to-use) is a recommended set of admission controllers to enable in general. * Ensure that the admissionregistration.k8s.io/v1beta1 API is enabled. @@ -119,8 +119,10 @@ webhooks: caBundle: ``` -*Note*: When using `clientConfig.service`, the server cert must be valid for +{{< note >}} +**Note:** When using `clientConfig.service`, the server cert must be valid for `..svc`. +{{< /note >}} When an apiserver receives a request that matches one of the `rules`, the apiserver sends an `admissionReview` request to webhook as specified in the @@ -130,7 +132,7 @@ After you create the webhook configuration, the system will take a few seconds to honor the new configuration. {{< note >}} -**Note** When the webhook plugin is deployed into the Kubernetes cluster as a +**Note:** When the webhook plugin is deployed into the Kubernetes cluster as a service, it has to expose its service on the 443 port. The communication between the API server and the webhook service may fail if a different port is used. @@ -220,13 +222,15 @@ and are not visible in the API unless specifically requested by using the query ### When to use initializers? Initializers are useful for admins to force policies (e.g., the -[AlwaysPullImages](/docs/admin/admission-controllers/#alwayspullimages) +[AlwaysPullImages](/docs/reference/access-authn-authz/admission-controllers/#alwayspullimages) admission controller), or to inject defaults (e.g., the -[DefaultStorageClass](/docs/admin/admission-controllers/#defaultstorageclass) +[DefaultStorageClass](/docs/reference/access-authn-authz/admission-controllers/#defaultstorageclass) admission controller), etc. +{{< note >}} **Note:** If your use case does not involve mutating objects, consider using external admission webhooks, as they have better performance. +{{< /note >}} ### How are initializers triggered? @@ -304,3 +308,4 @@ the pods will be stuck in an uninitialized state. Make sure that all expansions of the `` tuple in a `rule` are valid. If they are not, separate them in different `rules`. +{{% /capture %}} diff --git a/content/en/docs/reference/access-authn-authz/node.md b/content/en/docs/reference/access-authn-authz/node.md index d61b43ac7481c..5c6d0242e5c52 100644 --- a/content/en/docs/reference/access-authn-authz/node.md +++ b/content/en/docs/reference/access-authn-authz/node.md @@ -5,13 +5,15 @@ reviewers: - liggitt - ericchiang title: Using Node Authorization +content_template: templates/concept weight: 90 --- -{{< toc >}} - +{{% capture overview %}} Node authorization is a special-purpose authorization mode that specifically authorizes API requests made by kubelets. +{{% /capture %}} +{{% capture body %}} ## Overview The Node authorizer allows a kubelet to perform API operations. This includes: @@ -41,11 +43,11 @@ have the minimal set of permissions required to operate correctly. In order to be authorized by the Node authorizer, kubelets must use a credential that identifies them as being in the `system:nodes` group, with a username of `system:node:`. This group and user name format match the identity created for each kubelet as part of -[kubelet TLS bootstrapping](/docs/admin/kubelet-tls-bootstrapping/). +[kubelet TLS bootstrapping](/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping/). To enable the Node authorizer, start the apiserver with `--authorization-mode=Node`. -To limit the API objects kubelets are able to write, enable the [NodeRestriction](/docs/admin/admission-controllers#NodeRestriction) admission plugin by starting the apiserver with `--enable-admission-plugins=...,NodeRestriction,...` +To limit the API objects kubelets are able to write, enable the [NodeRestriction](/docs/reference/access-authn-authz/admission-controllers#NodeRestriction) admission plugin by starting the apiserver with `--enable-admission-plugins=...,NodeRestriction,...` ## Migration considerations @@ -68,7 +70,7 @@ since the default node identifier implementation would not consider that a node ### Upgrades from previous versions using RBAC -Upgraded pre-1.7 clusters using [RBAC](/docs/admin/authorization/rbac/) will continue functioning as-is because the `system:nodes` group binding will already exist. +Upgraded pre-1.7 clusters using [RBAC](/docs/reference/access-authn-authz/rbac/) will continue functioning as-is because the `system:nodes` group binding will already exist. If a cluster admin wishes to start using the `Node` authorizer and `NodeRestriction` admission plugin to limit node access to the API, that can be done non-disruptively: @@ -80,7 +82,7 @@ to limit node access to the API, that can be done non-disruptively: ### RBAC Node Permissions -In 1.6, the `system:node` cluster role was automatically bound to the `system:nodes` group when using the [RBAC Authorization mode](/docs/admin/authorization/rbac/). +In 1.6, the `system:node` cluster role was automatically bound to the `system:nodes` group when using the [RBAC Authorization mode](/docs/reference/access-authn-authz/rbac/). In 1.7, the automatic binding of the `system:nodes` group to the `system:node` role is deprecated because the node authorizer accomplishes the same purpose with the benefit of additional restrictions @@ -91,3 +93,4 @@ In 1.8, the binding will not be created at all. When using RBAC, the `system:node` cluster role will continue to be created, for compatibility with deployment methods that bind other users or groups to that role. +{{% /capture %}} diff --git a/content/en/docs/reference/access-authn-authz/rbac.md b/content/en/docs/reference/access-authn-authz/rbac.md index 0a470c66ba984..70f8a77506da4 100644 --- a/content/en/docs/reference/access-authn-authz/rbac.md +++ b/content/en/docs/reference/access-authn-authz/rbac.md @@ -4,12 +4,16 @@ reviewers: - deads2k - liggitt title: Using RBAC Authorization +content_template: templates/concept weight: 70 --- -{{< toc >}} +{{% capture overview %}} +Role-based access control (RBAC) is a method of regulating access to computer or network resources based on the roles of individual users within an enterprise. +{{% /capture %}} -Role-Based Access Control ("RBAC") uses the "rbac.authorization.k8s.io" API group +{{% capture body %}} +`RBAC` uses the `rbac.authorization.k8s.io` API group to drive authorization decisions, allowing admins to dynamically configure policies through the Kubernetes API. @@ -150,7 +154,7 @@ Most resources are represented by a string representation of their name, such as appears in the URL for the relevant API endpoint. However, some Kubernetes APIs involve a "subresource", such as the logs for a pod. The URL for the pods logs endpoint is: -``` +```http GET /api/v1/namespaces/{namespace}/pods/{name}/log ``` @@ -332,7 +336,7 @@ Subjects can be groups, users or service accounts. Users are represented by strings. These can be plain usernames, like "alice", email-style names, like "bob@example.com", or numeric IDs represented as a string. It is up to the Kubernetes admin to configure -the [authentication modules](/docs/admin/authentication/) to produce +the [authentication modules](/docs/reference/access-authn-authz/authentication/) to produce usernames in the desired format. The RBAC authorization system does not require any particular format. However, the prefix `system:` is reserved for Kubernetes system use, and so the admin should ensure @@ -603,7 +607,8 @@ This is commonly used by add-on API servers for unified authentication and autho system:node-bootstrapper None -Allows access to the resources required to perform Kubelet TLS bootstrapping. +Allows access to the resources required to perform +Kubelet TLS bootstrapping. system:node-problem-detector @@ -721,11 +726,15 @@ Grants a `Role` or `ClusterRole` within a specific namespace. Examples: * Grant the `admin` `ClusterRole` to a user named "bob" in the namespace "acme": - `kubectl create rolebinding bob-admin-binding --clusterrole=admin --user=bob --namespace=acme` + ``` + kubectl create rolebinding bob-admin-binding --clusterrole=admin --user=bob --namespace=acme + ``` * Grant the `view` `ClusterRole` to a service account named "myapp" in the namespace "acme": - `kubectl create rolebinding myapp-view-binding --clusterrole=view --serviceaccount=acme:myapp --namespace=acme` + ``` + kubectl create rolebinding myapp-view-binding --clusterrole=view --serviceaccount=acme:myapp --namespace=acme + ``` ### `kubectl create clusterrolebinding` @@ -733,22 +742,28 @@ Grants a `ClusterRole` across the entire cluster, including all namespaces. Exam * Grant the `cluster-admin` `ClusterRole` to a user named "root" across the entire cluster: - `kubectl create clusterrolebinding root-cluster-admin-binding --clusterrole=cluster-admin --user=root` + ``` + kubectl create clusterrolebinding root-cluster-admin-binding --clusterrole=cluster-admin --user=root + ``` * Grant the `system:node` `ClusterRole` to a user named "kubelet" across the entire cluster: - `kubectl create clusterrolebinding kubelet-node-binding --clusterrole=system:node --user=kubelet` + ``` + kubectl create clusterrolebinding kubelet-node-binding --clusterrole=system:node --user=kubelet + ``` * Grant the `view` `ClusterRole` to a service account named "myapp" in the namespace "acme" across the entire cluster: - `kubectl create clusterrolebinding myapp-view-binding --clusterrole=view --serviceaccount=acme:myapp` + ``` + kubectl create clusterrolebinding myapp-view-binding --clusterrole=view --serviceaccount=acme:myapp + ``` See the CLI help for detailed usage. ## Service Account Permissions Default RBAC policies grant scoped permissions to control-plane components, nodes, -and controllers, but grant *no permissions* to service accounts outside the "kube-system" namespace +and controllers, but grant *no permissions* to service accounts outside the `kube-system` namespace (beyond discovery permissions given to all authenticated users). This allows you to grant particular roles to particular service accounts as needed. @@ -775,7 +790,7 @@ In order from most secure to least secure, the approaches are: If an application does not specify a `serviceAccountName`, it uses the "default" service account. - {{< note >}}**NOTE:** Permissions given to the "default" service + {{< note >}}**Note:** Permissions given to the "default" service account are available to any pod in the namespace that does not specify a `serviceAccountName`.{{< /note >}} @@ -788,10 +803,10 @@ In order from most secure to least secure, the approaches are: --namespace=my-namespace ``` - Many [add-ons](/docs/concepts/cluster-administration/addons/) currently run as the "default" service account in the "kube-system" namespace. - To allow those add-ons to run with super-user access, grant cluster-admin permissions to the "default" service account in the "kube-system" namespace. + Many [add-ons](/docs/concepts/cluster-administration/addons/) currently run as the "default" service account in the `kube-system` namespace. + To allow those add-ons to run with super-user access, grant cluster-admin permissions to the "default" service account in the `kube-system` namespace. - {{< note >}}**NOTE:** Enabling this means the "kube-system" + {{< note >}}**Note:** Enabling this means the `kube-system` namespace contains secrets that grant super-user access to the API.{{< /note >}} @@ -831,7 +846,7 @@ In order from most secure to least secure, the approaches are: If you don't care about partitioning permissions at all, you can grant super-user access to all service accounts. - {{< warning >}}**WARNING:** This allows any user with read access + {{< warning >}}**Warning:** This allows any user with read access to secrets or the ability to create a pod to access super-user credentials.{{< /warning >}} @@ -847,7 +862,7 @@ Prior to Kubernetes 1.6, many deployments used very permissive ABAC policies, including granting full API access to all service accounts. Default RBAC policies grant scoped permissions to control-plane components, nodes, -and controllers, but grant *no permissions* to service accounts outside the "kube-system" namespace +and controllers, but grant *no permissions* to service accounts outside the `kube-system` namespace (beyond discovery permissions given to all authenticated users). While far more secure, this can be disruptive to existing workloads expecting to automatically receive API permissions. @@ -856,7 +871,7 @@ Here are two approaches for managing this transition: ### Parallel Authorizers Run both the RBAC and ABAC authorizers, and specify a policy file that contains -[the legacy ABAC policy](/docs/admin/authorization/abac#policy-file-format): +[the legacy ABAC policy](/docs/reference/access-authn-authz/abac/#policy-file-format): ``` --authorization-mode=RBAC,ABAC --authorization-policy-file=mypolicy.json @@ -876,11 +891,10 @@ in the server logs, you can remove the ABAC authorizer. You can replicate a permissive policy using RBAC role bindings. {{< warning >}} -**WARNING:** The following policy allows **ALL** service accounts to act as cluster administrators. +**Warning:** The following policy allows **ALL** service accounts to act as cluster administrators. Any application running in a container receives service account credentials automatically, and could perform any action against the API, including viewing secrets and modifying permissions. This is not a recommended policy. -{{< /warning >}} ``` kubectl create clusterrolebinding permissive-binding \ @@ -889,3 +903,6 @@ kubectl create clusterrolebinding permissive-binding \ --user=kubelet \ --group=system:serviceaccounts ``` +{{< /warning >}} + +{{% /capture %}} diff --git a/content/en/docs/reference/access-authn-authz/service-accounts-admin.md b/content/en/docs/reference/access-authn-authz/service-accounts-admin.md index 51387e00691d5..932f9fb225d87 100644 --- a/content/en/docs/reference/access-authn-authz/service-accounts-admin.md +++ b/content/en/docs/reference/access-authn-authz/service-accounts-admin.md @@ -5,15 +5,19 @@ reviewers: - lavalamp - liggitt title: Managing Service Accounts +content_template: templates/concept weight: 50 --- -*This is a Cluster Administrator guide to service accounts. It assumes knowledge of -the [User Guide to Service Accounts](/docs/user-guide/service-accounts).* +{{% capture overview %}} +This is a Cluster Administrator guide to service accounts. It assumes knowledge of +the [User Guide to Service Accounts](/docs/user-guide/service-accounts). -*Support for authorization and user accounts is planned but incomplete. Sometimes -incomplete features are referred to in order to better describe service accounts.* +Support for authorization and user accounts is planned but incomplete. Sometimes +incomplete features are referred to in order to better describe service accounts. +{{% /capture %}} +{{% capture body %}} ## User accounts vs service accounts Kubernetes distinguishes between the concept of a user account and a service account @@ -45,16 +49,15 @@ Three separate components cooperate to implement the automation around service a ### Service Account Admission Controller The modification of pods is implemented via a plugin -called an [Admission Controller](/docs/admin/admission-controllers). It is part of the apiserver. +called an [Admission Controller](/docs/reference/access-authn-authz/admission-controllers/). It is part of the apiserver. It acts synchronously to modify pods as they are created or updated. When this plugin is active (and it is by default on most distributions), then it does the following when a pod is created or modified: 1. If the pod does not have a `ServiceAccount` set, it sets the `ServiceAccount` to `default`. - 2. It ensures that the `ServiceAccount` referenced by the pod exists, and otherwise rejects it. - 4. If the pod does not contain any `ImagePullSecrets`, then `ImagePullSecrets` of the -`ServiceAccount` are added to the pod. - 5. It adds a `volume` to the pod which contains a token for API access. - 6. It adds a `volumeSource` to each container of the pod mounted at `/var/run/secrets/kubernetes.io/serviceaccount`. + 1. It ensures that the `ServiceAccount` referenced by the pod exists, and otherwise rejects it. + 1. If the pod does not contain any `ImagePullSecrets`, then `ImagePullSecrets` of the `ServiceAccount` are added to the pod. + 1. It adds a `volume` to the pod which contains a token for API access. + 1. It adds a `volumeSource` to each container of the pod mounted at `/var/run/secrets/kubernetes.io/serviceaccount`. ### Token Controller @@ -108,3 +111,4 @@ kubectl delete secret mysecretname Service Account Controller manages ServiceAccount inside namespaces, and ensures a ServiceAccount named "default" exists in every active namespace. +{{% /capture %}} diff --git a/content/en/docs/reference/command-line-tools-reference/cloud-controller-manager.md b/content/en/docs/reference/command-line-tools-reference/cloud-controller-manager.md index 8c7aeb6e42c71..fd7e36d8233f3 100644 --- a/content/en/docs/reference/command-line-tools-reference/cloud-controller-manager.md +++ b/content/en/docs/reference/command-line-tools-reference/cloud-controller-manager.md @@ -1,13 +1,13 @@ --- title: cloud-controller-manager notitle: true -weight: 90 --- - ## cloud-controller-manager + ### Synopsis + The Cloud controller manager is a daemon that embeds the cloud specific control loops shipped with Kubernetes. @@ -17,263 +17,309 @@ cloud-controller-manager [flags] ### Options - +
+ - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + +
--address ip     Default: 0.0.0.0
DEPRECATED: the IP address on which to listen for the --port port. See --bind-address instead.DEPRECATED: the IP address on which to listen for the --port port (set to 0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces). See --bind-address instead.
--allocate-node-cidrs
Should CIDRs for Pods be allocated and set on the cloud provider.Should CIDRs for Pods be allocated and set on the cloud provider.
--azure-container-registry-config string
Path to the file containing Azure container registry configuration information.Path to the file containing Azure container registry configuration information.
--bind-address ip     Default: 0.0.0.0
The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank, all interfaces will be used (0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces).The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank, all interfaces will be used (0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces).
--cert-dir string     Default: "/var/run/kubernetes"
The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored.The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored.
--cidr-allocator-type string     Default: "RangeAllocator"
Type of CIDR allocator to useType of CIDR allocator to use
--cloud-config string
The path to the cloud provider configuration file. Empty string for no configuration file.The path to the cloud provider configuration file. Empty string for no configuration file.
--cloud-provider string
The provider of cloud services. Cannot be empty.The provider for cloud services. Empty string for no provider.
--cluster-cidr string
CIDR Range for Pods in cluster. Requires --allocate-node-cidrs to be trueCIDR Range for Pods in cluster. Requires --allocate-node-cidrs to be true
--cluster-name string     Default: "kubernetes"
The instance prefix for the cluster.The instance prefix for the cluster.
--concurrent-service-syncs int32     Default: 1
The number of services that are allowed to sync concurrently. Larger number = more responsive service management, but more CPU (and network) loadThe number of services that are allowed to sync concurrently. Larger number = more responsive service management, but more CPU (and network) load
--configure-cloud-routes     Default: true
Should CIDRs allocated by allocate-node-cidrs be configured on the cloud provider.Should CIDRs allocated by allocate-node-cidrs be configured on the cloud provider.
--contention-profiling
Enable lock contention profiling, if profiling is enabled.Enable lock contention profiling, if profiling is enabled
--controller-start-interval duration
Interval between starting controller managers.Interval between starting controller managers.
--feature-gates mapStringBool
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
Accelerators=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (ALPHA - default=false)
CSIPersistentVolume=true|false (BETA - default=true)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (ALPHA - default=false)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (ALPHA - default=false)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
GCERegionalPersistentDisk=true|false (BETA - default=true)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (BETA - default=true)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (ALPHA - default=false)
PodShareProcessNamespace=true|false (ALPHA - default=false)
ReadOnlyAPIDataVolumes=true|false (DEPRECATED - default=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
RunAsGroup=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
ServiceProxyAllowExternalIPs=true|false (DEPRECATED - default=false)
StorageObjectInUseProtection=true|false (BETA - default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (BETA - default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
TokenRequest=true|false (ALPHA - default=false)
VolumeScheduling=true|false (BETA - default=true)
VolumeSubpath=true|false (default=true)		A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
AttachVolumeLimit=true|false (ALPHA - default=false)
BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (BETA - default=true)
CSIBlockVolume=true|false (ALPHA - default=false)
CSIPersistentVolume=true|false (BETA - default=true)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (BETA - default=true)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (BETA - default=true)
DynamicProvisioningScheduling=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandInUsePersistentVolumes=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (BETA - default=true)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
GCERegionalPersistentDisk=true|false (BETA - default=true)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
KubeletPluginsWatcher=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (BETA - default=true)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (BETA - default=true)
PodReadinessGates=true|false (BETA - default=false)
PodShareProcessNamespace=true|false (ALPHA - default=false)
QOSReserved=true|false (ALPHA - default=false)
ReadOnlyAPIDataVolumes=true|false (DEPRECATED - default=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
ResourceQuotaScopeSelectors=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
RunAsGroup=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
ServiceProxyAllowExternalIPs=true|false (DEPRECATED - default=false)
StorageObjectInUseProtection=true|false (default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
Sysctls=true|false (BETA - default=true)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
TokenRequest=true|false (ALPHA - default=false)
TokenRequestProjection=true|false (ALPHA - default=false)
VolumeScheduling=true|false (BETA - default=true)
VolumeSubpath=true|false (default=true)
VolumeSubpathEnvExpansion=true|false (ALPHA - default=false)
-h, --help
help for cloud-controller-managerhelp for cloud-controller-manager
--http2-max-streams-per-connection int
The limit that the server gives to clients for the maximum number of streams in an HTTP/2 connection. Zero means to use golang's default.The limit that the server gives to clients for the maximum number of streams in an HTTP/2 connection. Zero means to use golang's default.
--kube-api-burst int32     Default: 30
Burst to use while talking with kubernetes apiserver.Burst to use while talking with kubernetes apiserver.
--kube-api-content-type string     Default: "application/vnd.kubernetes.protobuf"
Content type of requests sent to apiserver.Content type of requests sent to apiserver.
--kube-api-qps float32     Default: 20
QPS to use while talking with kubernetes apiserver.QPS to use while talking with kubernetes apiserver.
--kubeconfig string
Path to kubeconfig file with authorization and master location information.Path to kubeconfig file with authorization and master location information.
--leader-elect     Default: true
Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability.Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability.
--leader-elect-lease-duration duration     Default: 15s
The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled.The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled.
--leader-elect-renew-deadline duration     Default: 10s
The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled.The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled.
--leader-elect-resource-lock endpoints     Default: "endpoints"
The type of resource object that is used for locking during leader election. Supported options are endpoints (default) and `configmaps`.The type of resource object that is used for locking during leader election. Supported options are endpoints (default) and `configmaps`.
--leader-elect-retry-period duration     Default: 2s
The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled.The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled.
--log-flush-frequency duration     Default: 5s
Maximum number of seconds between log flushesMaximum number of seconds between log flushes
--master string
The address of the Kubernetes API server (overrides any value in kubeconfig).The address of the Kubernetes API server (overrides any value in kubeconfig).
--min-resync-period duration     Default: 12h0m0s
The resync period in reflectors will be random between MinResyncPeriod and 2*MinResyncPeriod.The resync period in reflectors will be random between MinResyncPeriod and 2*MinResyncPeriod.
--node-monitor-period duration     Default: 5s
The period for syncing NodeStatus in NodeController.The period for syncing NodeStatus in NodeController.
--node-status-update-frequency duration     Default: 5m0s
Specifies how often the controller updates nodes' status.Specifies how often the controller updates nodes' status.
--port int     Default: 10253
DEPRECATED: the port on which to serve HTTP insecurely without authentication and authorization. If 0, don't serve HTTPS at all. See --secure-port instead.DEPRECATED: the port on which to serve HTTP insecurely without authentication and authorization. If 0, don't serve HTTPS at all. See --secure-port instead.
--profiling     Default: true--profiling
Enable profiling via web interface host:port/debug/pprof/Enable profiling via web interface host:port/debug/pprof/
--route-reconciliation-period duration     Default: 10s
The period for reconciling routes created for Nodes by cloud provider.The period for reconciling routes created for Nodes by cloud provider.
--secure-port int
The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all.The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all.
--tls-cert-file string
File containing the default x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory specified by --cert-dir.File containing the default x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory specified by --cert-dir.
--tls-cipher-suites stringSlice
Comma-separated list of cipher suites for the server. Values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). If omitted, the default Go cipher suites will be usedComma-separated list of cipher suites for the server. If omitted, the default Go cipher suites will be use. Possible values: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_ECDSA_WITH_RC4_128_SHA,TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_RSA_WITH_RC4_128_SHA,TLS_RSA_WITH_3DES_EDE_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_128_GCM_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_256_GCM_SHA384,TLS_RSA_WITH_RC4_128_SHA
--tls-min-version string
Minimum TLS version supported. Value must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants.Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12
--tls-private-key-file string
File containing the default x509 private key matching --tls-cert-file.File containing the default x509 private key matching --tls-cert-file.
--tls-sni-cert-key namedCertKey     Default: []
A pair of x509 certificate and private key file paths, optionally suffixed with a list of domain patterns which are fully qualified domain names, possibly with prefixed wildcard segments. If no domain patterns are provided, the names of the certificate are extracted. Non-wildcard matches trump over wildcard matches, explicit domain patterns trump over extracted names. For multiple key/certificate pairs, use the --tls-sni-cert-key multiple times. Examples: "example.crt,example.key" or "foo.crt,foo.key:*.foo.com,foo.com".A pair of x509 certificate and private key file paths, optionally suffixed with a list of domain patterns which are fully qualified domain names, possibly with prefixed wildcard segments. If no domain patterns are provided, the names of the certificate are extracted. Non-wildcard matches trump over wildcard matches, explicit domain patterns trump over extracted names. For multiple key/certificate pairs, use the --tls-sni-cert-key multiple times. Examples: "example.crt,example.key" or "foo.crt,foo.key:*.foo.com,foo.com".
--use-service-account-credentials
If true, use individual service account credentials for each controller.If true, use individual service account credentials for each controller.
--version version[=true]
Print version information and quitPrint version information and quit
+ + + 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 a12ad8c14315c..24257cc09bd8d 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 @@ -35,10 +35,13 @@ different Kubernetes components. | `APIListChunking` | `true` | Beta | 1.9 | | | `APIResponseCompression` | `false` | Alpha | 1.7 | | | `AppArmor` | `true` | Beta | 1.4 | | +| `AttachVolumeLimit` | `false` | Alpha | 1.11 | | | `BlockVolume` | `false` | Alpha | 1.9 | | | `CPUManager` | `false` | Alpha | 1.8 | 1.9 | | `CPUManager` | `true` | Beta | 1.10 | | -| `CRIContainerLogRotation` | `false` | Alpha | 1.10 | | +| `CRIContainerLogRotation` | `false` | Alpha | 1.10 | 1.10 | +| `CRIContainerLogRotation` | `true` | Beta| 1.11 | | +| `CSIBlockVolume` | `false` | Alpha | 1.11 | 1.11 | | `CSIPersistentVolume` | `false` | Alpha | 1.9 | 1.9 | | `CSIPersistentVolume` | `true` | Beta | 1.10 | | | `CustomPodDNS` | `false` | Alpha | 1.9 | 1.9 | @@ -49,11 +52,13 @@ different Kubernetes components. | `DebugContainers` | `false` | Alpha | 1.10 | | | `DevicePlugins` | `false` | Alpha | 1.8 | 1.9 | | `DevicePlugins` | `true` | Beta | 1.10 | | -| `DynamicKubeletConfig` | `false` | Alpha | 1.4 | | +| `DynamicKubeletConfig` | `false` | Alpha | 1.4 | 1.10 | +| `DynamicKubeletConfig` | `true` | Beta | 1.11 | | | `DynamicVolumeProvisioning` | `true` | Alpha | 1.3 | 1.7 | | `DynamicVolumeProvisioning` | `true` | GA | 1.8 | | | `EnableEquivalenceClassCache` | `false` | Alpha | 1.8 | | -| `ExpandPersistentVolumes` | `false` | Alpha | 1.8 | 1.8 | +| `ExpandPersistentVolumes` | `false` | Alpha | 1.8 | 1.10 | +| `ExpandPersistentVolumes` | `true` | Beta | 1.11 | | | `ExperimentalCriticalPodAnnotation` | `false` | Alpha | 1.5 | | | `ExperimentalHostUserNamespaceDefaulting` | `false` | Beta | 1.5 | | | `GCERegionalPersistentDisk` | `true` | Beta | 1.10 | | @@ -62,6 +67,7 @@ different Kubernetes components. | `HyperVContainer` | `false` | Alpha | 1.10 | | | `Initializers` | `false` | Alpha | 1.7 | | | `KubeletConfigFile` | `false` | Alpha | 1.8 | 1.9 | +| `KubeletPluginsWatcher` | `false` | Alpha | 1.11 | | | `LocalStorageCapacityIsolation` | `false` | Alpha | 1.7 | 1.9 | | `LocalStorageCapacityIsolation` | `true` | Beta| 1.10 | | | `MountContainers` | `false` | Alpha | 1.9 | | @@ -70,6 +76,7 @@ different Kubernetes components. | `PersistentLocalVolumes` | `false` | Alpha | 1.7 | 1.9 | | `PersistentLocalVolumes` | `true` | Beta | 1.10 | | | `PodPriority` | `false` | Alpha | 1.8 | | +| `PodReadinessGates` | `false` | Alpha | 1.11 | | | `PodShareProcessNamespace` | `false` | Alpha | 1.10 | | | `PVCProtection` | `false` | Alpha | 1.9 | 1.9 | | `ReadOnlyAPIDataVolumes` | `true` | Deprecated | 1.10 | | @@ -77,19 +84,24 @@ different Kubernetes components. | `RotateKubeletClientCertificate` | `true` | Beta | 1.7 | | | `RotateKubeletServerCertificate` | `false` | Alpha | 1.7 | | | `RunAsGroup` | `false` | Alpha | 1.10 | | -| `ScheduleDaemonSetPods` | `false` | Alpha | 1.10 | | | `ServiceNodeExclusion` | `false` | Alpha | 1.8 | | -| `StorageObjectInUseProtection` | `true` | Beta | 1.10 | | +| `StorageObjectInUseProtection` | `true` | Beta | 1.10 | 1.10 | +| `StorageObjectInUseProtection` | `true` | GA | 1.11 | | | `StreamingProxyRedirects` | `true` | Beta | 1.5 | | | `SupportIPVSProxyMode` | `false` | Alpha | 1.8 | 1.8 | | `SupportIPVSProxyMode` | `false` | Beta | 1.9 | 1.9 | -| `SupportIPVSProxyMode` | `true` | Beta | 1.10 | | +| `SupportIPVSProxyMode` | `true` | Beta | 1.10 | 1.10 | +| `SupportIPVSProxyMode` | `true` | GA | 1.11 | | | `SupportPodPidsLimit` | `false` | Alpha | 1.10 | | +| `Sysctls` | `true` | Beta | 1.11 | | | `TaintBasedEvictions` | `false` | Alpha | 1.6 | | | `TaintNodesByCondition` | `false` | Alpha | 1.8 | | | `TokenRequest` | `false` | Alpha | 1.10 | | +| `TokenRequestProjection` | `false` | Alpha | 1.11 | | | `VolumeScheduling` | `false` | Alpha | 1.9 | 1.9 | | `VolumeScheduling` | `true` | Beta | 1.10 | | +| `VolumeSubpathEnvExpansion` | `false` | Alpha | 1.11 | | +| `ScheduleDaemonSetPods` | `false` | Alpha | 1.11 | | ## Using a Feature @@ -141,11 +153,15 @@ Each feature gate is designed for enabling/disabling a specific feature: - `APIResponseCompression`: Compress the API responses for `LIST` or `GET` requests. - `AppArmor`: Enable AppArmor based mandatory access control on Linux nodes when using Docker. See [AppArmor Tutorial](/docs/tutorials/clusters/apparmor/) for more details. +- `AttachVolumeLimit`: Enable volume plugins to report limits on number of volumes + that can be attached to a node. + See [dynamic volume limits](/docs/concepts/storage/storage-limits/#dynamic-volume-limits) for more details. - `BlockVolume`: Enable the definition and consumption of raw block devices in Pods. See [Raw Block Volume Support](/docs/concepts/storage/persistent-volumes/#raw-block-volume-support) for more details. - `CPUManager`: Enable container level CPU affinity support, see [CPU Management Policies](/docs/tasks/administer-cluster/cpu-management-policies/). - `CRIContainerLogRotation`: Enable container log rotation for cri container runtime. +- `CSIBlockVolume`: Enable external CSI volume drivers to support block storage. See the [`csi` raw block volume support](/docs/concepts/storage/volumes/#csi-raw-block-volume-support) documentation for more details. - `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) compatible volume plugin. @@ -179,6 +195,8 @@ Each feature gate is designed for enabling/disabling a specific feature: When the `Initializers` admission controller is enabled, this feature is automatically enabled. - `KubeletConfigFile`: Enable loading kubelet configuration from a file specified using a config file. See [setting kubelet parameters via a config file](/docs/tasks/administer-cluster/kubelet-config-file/) for more details. +- `KubletPluginsWatcher`: Enable probe-based plugin watcher utility to enable kubelet + to discover plugins such as [CSI volume drivers](/docs/concepts/storage/volumes/#csi). - `LocalStorageCapacityIsolation`: Enable the consumption of [local ephemeral storage](/docs/concepts/configuration/manage-compute-resources-container/) and also the `sizeLimit` property of an [emptyDir volume](/docs/concepts/storage/volumes/#emptydir). - `MountContainers`: Enable using utility containers on host as the volume mounter. - `MountPropagation`: Enable sharing volume mounted by one container to other containers or pods. @@ -186,6 +204,9 @@ Each feature gate is designed for enabling/disabling a specific feature: - `PersistentLocalVolumes`: Enable the usage of `local` volume type in Pods. Pod affinity has to be specified if requesting a `local` volume. - `PodPriority`: Enable the descheduling and preemption of Pods based on their [priorities](/docs/concepts/configuration/pod-priority-preemption/). +- `PodReadinessGates`: Enable the setting of `PodReadinessGate` field for extending + Pod readiness evaluation. + For more details, please see [Pod readiness gate](/docs/concepts/workloads/pods/pod-lifecycle/#pod-readiness-gate). - `PVCProtection`: Enable the prevention of a PersistentVolumeClaim (PVC) from being deleted when it is still used by any Pod. More details can be found [here](/docs/tasks/administer-cluster/pvc-protection/). @@ -196,9 +217,9 @@ Each feature gate is designed for enabling/disabling a specific feature: the input Pod's cpu and memory limits. The intent is to break ties between nodes with same scores. - `RotateKubeletClientCertificate`: Enable the rotation of the client TLS certificate on the kubelet. - See [kubelet configuration](/docs/admin/kubelet-tls-bootstrapping/#kubelet-configuration) for more details. + See [kubelet configuration](/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping/#kubelet-configuration) for more details. - `RotateKubeletServerCertificate`: Enable the rotation of the server TLS certificate on the kubelet. - See [kubelet configuration](/docs/admin/kubelet-tls-bootstrapping/#kubelet-configuration) for more details. + See [kubelet configuration](/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping/#kubelet-configuration) for more details. - `RunAsGroup`: Enable control over the primary group ID set on the init processes of containers. - `ScheduleDaemonSetPods`: Enable DaemonSet Pods to be scheduled by the default scheduler instead of the DaemonSet controller. - `ServiceNodeExclusion`: Enable the exclusion of nodes from load balancers created by a cloud provider. @@ -211,12 +232,15 @@ Each feature gate is designed for enabling/disabling a specific feature: - `SupportIPVSProxyMode`: Enable providing in-cluster service load balancing using IPVS. See [service proxies](/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies) for more details. - `SupportPodPidsLimit`: Enable the support to limiting PIDs in Pods. +- `Sysctls`: Enable support for namespaced kernel parameters (sysctls) that can be set for each pod. + See [sysctls](/docs/tasks/administer-cluster/sysctl-cluster/) for more details. - `TaintBasedEvictions`: Enable evicting pods from nodes based on taints on nodes and tolerations on Pods. See [taints and tolerations](/docs/concepts/configuration/taint-and-toleration/) for more details. - `TaintNodesByCondition`: Enable automatic tainting nodes based on [node conditions](/docs/concepts/architecture/nodes/#condition). - `TokenRequest`: Enable the `TokenRequest` endpoint on service account resources. +- `TokenRequestProjection`: Enable the injection of service account tokens into + a Pod through the [`projected` volume](/docs/concepts/storage/volumes/#projected). - `VolumeScheduling`: Enable volume topology aware scheduling and make the PersistentVolumeClaim (PVC) binding aware of scheduling decisions. It also enables the usage of [`local`](/docs/concepts/storage/volumes/#local) volume type when used together with the `PersistentLocalVolumes` feature gate. - diff --git a/content/en/docs/reference/command-line-tools-reference/kube-apiserver.md b/content/en/docs/reference/command-line-tools-reference/kube-apiserver.md index 0817c4e4b98d8..2a9f0ce66b0c8 100644 --- a/content/en/docs/reference/command-line-tools-reference/kube-apiserver.md +++ b/content/en/docs/reference/command-line-tools-reference/kube-apiserver.md @@ -1,12 +1,14 @@ --- title: kube-apiserver notitle: true -weight: 40 --- ## kube-apiserver + + ### Synopsis + The Kubernetes API server validates and configures data for the api objects which include pods, services, replicationcontrollers, and others. The API Server services REST operations and provides the frontend to the @@ -18,745 +20,925 @@ kube-apiserver [flags] ### Options - +
+ - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + - + + - + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + - + + - + + - + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + + + + + + + - + + - + + - + + - + + - + + - - - - - - - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + +
--admission-control-config-file string
File with admission control configuration.File with admission control configuration.
--advertise-address ip
The IP address on which to advertise the apiserver to members of the cluster. This address must be reachable by the rest of the cluster. If blank, the --bind-address will be used. If --bind-address is unspecified, the host's default interface will be used.The IP address on which to advertise the apiserver to members of the cluster. This address must be reachable by the rest of the cluster. If blank, the --bind-address will be used. If --bind-address is unspecified, the host's default interface will be used.
--allow-privileged
If true, allow privileged containers. [default=false]If true, allow privileged containers. [default=false]
--anonymous-auth     Default: true
Enables anonymous requests to the secure port of the API server. Requests that are not rejected by another authentication method are treated as anonymous requests. Anonymous requests have a username of system:anonymous, and a group name of system:unauthenticated.Enables anonymous requests to the secure port of the API server. Requests that are not rejected by another authentication method are treated as anonymous requests. Anonymous requests have a username of system:anonymous, and a group name of system:unauthenticated.
--apiserver-count int     Default: 1
The number of apiservers running in the cluster, must be a positive number.The number of apiservers running in the cluster, must be a positive number. (In use when --endpoint-reconciler-type=master-count is enabled.)
--audit-log-batch-buffer-size int     Default: 10000
The size of the buffer to store events before batching and writing. Only used in batch mode.The size of the buffer to store events before batching and writing. Only used in batch mode.
--audit-log-batch-max-size int     Default: 400
The maximum size of a batch. Only used in batch mode.The maximum size of a batch. Only used in batch mode.
--audit-log-batch-max-wait duration     Default: 30s
The amount of time to wait before force writing the batch that hadn't reached the max size. Only used in batch mode.The amount of time to wait before force writing the batch that hadn't reached the max size. Only used in batch mode.
--audit-log-batch-throttle-burst int     Default: 15
Maximum number of requests sent at the same moment if ThrottleQPS was not utilized before. Only used in batch mode.Maximum number of requests sent at the same moment if ThrottleQPS was not utilized before. Only used in batch mode.
--audit-log-batch-throttle-enable
Whether batching throttling is enabled. Only used in batch mode.Whether batching throttling is enabled. Only used in batch mode.
--audit-log-batch-throttle-qps float32     Default: 10
Maximum average number of batches per second. Only used in batch mode.Maximum average number of batches per second. Only used in batch mode.
--audit-log-format string     Default: "json"
Format of saved audits. "legacy" indicates 1-line text format for each event. "json" indicates structured json format. Requires the 'AdvancedAuditing' feature gate. Known formats are legacy,json.Format of saved audits. "legacy" indicates 1-line text format for each event. "json" indicates structured json format. Requires the 'AdvancedAuditing' feature gate. Known formats are legacy,json.
--audit-log-maxage int
The maximum number of days to retain old audit log files based on the timestamp encoded in their filename.The maximum number of days to retain old audit log files based on the timestamp encoded in their filename.
--audit-log-maxbackup int
The maximum number of old audit log files to retain.The maximum number of old audit log files to retain.
--audit-log-maxsize int
The maximum size in megabytes of the audit log file before it gets rotated.The maximum size in megabytes of the audit log file before it gets rotated.
--audit-log-mode string     Default: "blocking"
Strategy for sending audit events. Blocking indicates sending events should block server responses. Batch causes the backend to buffer and write events asynchronously. Known modes are batch,blocking.Strategy for sending audit events. Blocking indicates sending events should block server responses. Batch causes the backend to buffer and write events asynchronously. Known modes are batch,blocking.
--audit-log-path string
If set, all requests coming to the apiserver will be logged to this file. '-' means standard out.If set, all requests coming to the apiserver will be logged to this file. '-' means standard out.
--audit-log-truncate-enabled
Whether event and batch truncating is enabled.
--audit-log-truncate-max-batch-size int     Default: 10485760
Maximum size of the batch sent to the underlying backend. Actual serialized size can be several hundreds of bytes greater. If a batch exceeds this limit, it is split into several batches of smaller size.
--audit-log-truncate-max-event-size int     Default: 102400
Maximum size of the audit event sent to the underlying backend. If the size of an event is greater than this number, first request and response are removed, andif this doesn't reduce the size enough, event is discarded.
--audit-log-version string     Default: "audit.k8s.io/v1beta1"
API group and version used for serializing audit events written to log.
--audit-policy-file string
Path to the file that defines the audit policy configuration. Requires the 'AdvancedAuditing' feature gate. With AdvancedAuditing, a profile is required to enable auditing.Path to the file that defines the audit policy configuration. Requires the 'AdvancedAuditing' feature gate. With AdvancedAuditing, a profile is required to enable auditing.
--audit-webhook-batch-buffer-size int     Default: 10000
The size of the buffer to store events before batching and writing. Only used in batch mode.The size of the buffer to store events before batching and writing. Only used in batch mode.
--audit-webhook-batch-max-size int     Default: 400
The maximum size of a batch. Only used in batch mode.The maximum size of a batch. Only used in batch mode.
--audit-webhook-batch-max-wait duration     Default: 30s
The amount of time to wait before force writing the batch that hadn't reached the max size. Only used in batch mode.The amount of time to wait before force writing the batch that hadn't reached the max size. Only used in batch mode.
--audit-webhook-batch-throttle-burst int     Default: 15
Maximum number of requests sent at the same moment if ThrottleQPS was not utilized before. Only used in batch mode.Maximum number of requests sent at the same moment if ThrottleQPS was not utilized before. Only used in batch mode.
--audit-webhook-batch-throttle-enable     Default: true
Whether batching throttling is enabled. Only used in batch mode.Whether batching throttling is enabled. Only used in batch mode.
--audit-webhook-batch-throttle-qps float32     Default: 10
Maximum average number of batches per second. Only used in batch mode.Maximum average number of batches per second. Only used in batch mode.
--audit-webhook-config-file string
Path to a kubeconfig formatted file that defines the audit webhook configuration. Requires the 'AdvancedAuditing' feature gate.Path to a kubeconfig formatted file that defines the audit webhook configuration. Requires the 'AdvancedAuditing' feature gate.
--audit-webhook-initial-backoff duration     Default: 10s
The amount of time to wait before retrying the first failed request.The amount of time to wait before retrying the first failed request.
--audit-webhook-mode string     Default: "batch"
Strategy for sending audit events. Blocking indicates sending events should block server responses. Batch causes the backend to buffer and write events asynchronously. Known modes are batch,blocking.Strategy for sending audit events. Blocking indicates sending events should block server responses. Batch causes the backend to buffer and write events asynchronously. Known modes are batch,blocking.
--audit-webhook-truncate-enabled
Whether event and batch truncating is enabled.
--audit-webhook-truncate-max-batch-size int     Default: 10485760
Maximum size of the batch sent to the underlying backend. Actual serialized size can be several hundreds of bytes greater. If a batch exceeds this limit, it is split into several batches of smaller size.
--audit-webhook-truncate-max-event-size int     Default: 102400
Maximum size of the audit event sent to the underlying backend. If the size of an event is greater than this number, first request and response are removed, andif this doesn't reduce the size enough, event is discarded.
--audit-webhook-version string     Default: "audit.k8s.io/v1beta1"
API group and version used for serializing audit events written to webhook.
--authentication-token-webhook-cache-ttl duration     Default: 2m0s
The duration to cache responses from the webhook token authenticator.The duration to cache responses from the webhook token authenticator.
--authentication-token-webhook-config-file string
File with webhook configuration for token authentication in kubeconfig format. The API server will query the remote service to determine authentication for bearer tokens.File with webhook configuration for token authentication in kubeconfig format. The API server will query the remote service to determine authentication for bearer tokens.
--authorization-mode string     Default: "AlwaysAllow"--authorization-mode stringSlice     Default: [AlwaysAllow]
Ordered list of plug-ins to do authorization on secure port. Comma-delimited list of: AlwaysAllow,AlwaysDeny,ABAC,Webhook,RBAC,Node.Ordered list of plug-ins to do authorization on secure port. Comma-delimited list of: AlwaysAllow,AlwaysDeny,ABAC,Webhook,RBAC,Node.
--authorization-policy-file string
File with authorization policy in csv format, used with --authorization-mode=ABAC, on the secure port.File with authorization policy in csv format, used with --authorization-mode=ABAC, on the secure port.
--authorization-webhook-cache-authorized-ttl duration     Default: 5m0s
The duration to cache 'authorized' responses from the webhook authorizer.The duration to cache 'authorized' responses from the webhook authorizer.
--authorization-webhook-cache-unauthorized-ttl duration     Default: 30s
The duration to cache 'unauthorized' responses from the webhook authorizer.The duration to cache 'unauthorized' responses from the webhook authorizer.
--authorization-webhook-config-file string
File with webhook configuration in kubeconfig format, used with --authorization-mode=Webhook. The API server will query the remote service to determine access on the API server's secure port.File with webhook configuration in kubeconfig format, used with --authorization-mode=Webhook. The API server will query the remote service to determine access on the API server's secure port.
--azure-container-registry-config string
Path to the file containing Azure container registry configuration information.Path to the file containing Azure container registry configuration information.
--basic-auth-file string
If set, the file that will be used to admit requests to the secure port of the API server via http basic authentication.If set, the file that will be used to admit requests to the secure port of the API server via http basic authentication.
--bind-address ip     Default: 0.0.0.0
The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank, all interfaces will be used (0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces).The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank, all interfaces will be used (0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces).
--cert-dir string     Default: "/var/run/kubernetes"
The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored.The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored.
--client-ca-file string
If set, any request presenting a client certificate signed by one of the authorities in the client-ca-file is authenticated with an identity corresponding to the CommonName of the client certificate.If set, any request presenting a client certificate signed by one of the authorities in the client-ca-file is authenticated with an identity corresponding to the CommonName of the client certificate.
--cloud-config string
The path to the cloud provider configuration file. Empty string for no configuration file.The path to the cloud provider configuration file. Empty string for no configuration file.
--cloud-provider string
The provider for cloud services. Empty string for no provider.The provider for cloud services. Empty string for no provider.
--contention-profiling
Enable lock contention profiling, if profiling is enabledEnable lock contention profiling, if profiling is enabled
--cors-allowed-origins stringSlice
List of allowed origins for CORS, comma separated. An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled.List of allowed origins for CORS, comma separated. An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled.
--default-watch-cache-size int     Default: 100
Default watch cache size. If zero, watch cache will be disabled for resources that do not have a default watch size set.Default watch cache size. If zero, watch cache will be disabled for resources that do not have a default watch size set.
--delete-collection-workers int     Default: 1
Number of workers spawned for DeleteCollection call. These are used to speed up namespace cleanup.Number of workers spawned for DeleteCollection call. These are used to speed up namespace cleanup.
--deserialization-cache-size int
Number of deserialized json objects to cache in memory.Number of deserialized json objects to cache in memory.
--disable-admission-plugins stringSlice
admission plugins that should be disabled although they are in the default enabled plugins list. Comma-delimited list of admission plugins: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, DefaultStorageClass, DefaultTolerationSeconds, DenyEscalatingExec, DenyExecOnPrivileged, EventRateLimit, ExtendedResourceToleration, ImagePolicyWebhook, InitialResources, Initializers, LimitPodHardAntiAffinityTopology, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferencesPermissionEnforcement, PersistentVolumeClaimResize, PersistentVolumeLabel, PodNodeSelector, PodPreset, PodSecurityPolicy, PodTolerationRestriction, Priority, ResourceQuota, SecurityContextDeny, ServiceAccount, StorageObjectInUseProtection, ValidatingAdmissionWebhook. The order of plugins in this flag does not matter.admission plugins that should be disabled although they are in the default enabled plugins list. Comma-delimited list of admission plugins: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, DefaultStorageClass, DefaultTolerationSeconds, DenyEscalatingExec, DenyExecOnPrivileged, EventRateLimit, ExtendedResourceToleration, ImagePolicyWebhook, Initializers, LimitPodHardAntiAffinityTopology, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferencesPermissionEnforcement, PersistentVolumeClaimResize, PersistentVolumeLabel, PodNodeSelector, PodPreset, PodSecurityPolicy, PodTolerationRestriction, Priority, ResourceQuota, SecurityContextDeny, ServiceAccount, StorageObjectInUseProtection, ValidatingAdmissionWebhook. The order of plugins in this flag does not matter.
--enable-admission-plugins stringSlice
admission plugins that should be enabled in addition to default enabled ones. Comma-delimited list of admission plugins: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, DefaultStorageClass, DefaultTolerationSeconds, DenyEscalatingExec, DenyExecOnPrivileged, EventRateLimit, ExtendedResourceToleration, ImagePolicyWebhook, InitialResources, Initializers, LimitPodHardAntiAffinityTopology, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferencesPermissionEnforcement, PersistentVolumeClaimResize, PersistentVolumeLabel, PodNodeSelector, PodPreset, PodSecurityPolicy, PodTolerationRestriction, Priority, ResourceQuota, SecurityContextDeny, ServiceAccount, StorageObjectInUseProtection, ValidatingAdmissionWebhook. The order of plugins in this flag does not matter.admission plugins that should be enabled in addition to default enabled ones. Comma-delimited list of admission plugins: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, DefaultStorageClass, DefaultTolerationSeconds, DenyEscalatingExec, DenyExecOnPrivileged, EventRateLimit, ExtendedResourceToleration, ImagePolicyWebhook, Initializers, LimitPodHardAntiAffinityTopology, LimitRanger, MutatingAdmissionWebhook, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, NodeRestriction, OwnerReferencesPermissionEnforcement, PersistentVolumeClaimResize, PersistentVolumeLabel, PodNodeSelector, PodPreset, PodSecurityPolicy, PodTolerationRestriction, Priority, ResourceQuota, SecurityContextDeny, ServiceAccount, StorageObjectInUseProtection, ValidatingAdmissionWebhook. The order of plugins in this flag does not matter.
--enable-aggregator-routing
Turns on aggregator routing requests to endoints IP rather than cluster IP.Turns on aggregator routing requests to endoints IP rather than cluster IP.
--enable-bootstrap-token-auth
Enable to allow secrets of type 'bootstrap.kubernetes.io/token' in the 'kube-system' namespace to be used for TLS bootstrapping authentication.Enable to allow secrets of type 'bootstrap.kubernetes.io/token' in the 'kube-system' namespace to be used for TLS bootstrapping authentication.
--enable-garbage-collector     Default: true
Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-controller-manager.Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-controller-manager.
--enable-logs-handler     Default: true
If true, install a /logs handler for the apiserver logs.If true, install a /logs handler for the apiserver logs.
--enable-swagger-ui
Enables swagger ui on the apiserver at /swagger-uiEnables swagger ui on the apiserver at /swagger-ui
--endpoint-reconciler-type string     Default: "master-count"--endpoint-reconciler-type string     Default: "lease"
Use an endpoint reconciler (master-count, lease, none)Use an endpoint reconciler (master-count, lease, none)
--etcd-cafile string
SSL Certificate Authority file used to secure etcd communication.SSL Certificate Authority file used to secure etcd communication.
--etcd-certfile string
SSL certification file used to secure etcd communication.SSL certification file used to secure etcd communication.
--etcd-compaction-interval duration     Default: 5m0s
The interval of compaction requests. If 0, the compaction request from apiserver is disabled.The interval of compaction requests. If 0, the compaction request from apiserver is disabled.
--etcd-count-metric-poll-period duration     Default: 1m0s
Frequency of polling etcd for number of resources per type. 0 disables the metric collection.Frequency of polling etcd for number of resources per type. 0 disables the metric collection.
--etcd-keyfile string
SSL key file used to secure etcd communication.SSL key file used to secure etcd communication.
--etcd-prefix string     Default: "/registry"
The prefix to prepend to all resource paths in etcd.The prefix to prepend to all resource paths in etcd.
--etcd-servers stringSlice
List of etcd servers to connect with (scheme://ip:port), comma separated.List of etcd servers to connect with (scheme://ip:port), comma separated.
--etcd-servers-overrides stringSlice
Per-resource etcd servers overrides, comma separated. The individual override format: group/resource#servers, where servers are http://ip:port, semicolon separated.Per-resource etcd servers overrides, comma separated. The individual override format: group/resource#servers, where servers are URLs, semicolon separated.
--event-ttl duration     Default: 1h0m0s
Amount of time to retain events.Amount of time to retain events.
--experimental-encryption-provider-config string
The file containing configuration for encryption providers to be used for storing secrets in etcdThe file containing configuration for encryption providers to be used for storing secrets in etcd
--external-hostname string
The hostname to use when generating externalized URLs for this master (e.g. Swagger API Docs).The hostname to use when generating externalized URLs for this master (e.g. Swagger API Docs).
--feature-gates mapStringBool
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
Accelerators=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (ALPHA - default=false)
CSIPersistentVolume=true|false (BETA - default=true)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (ALPHA - default=false)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (ALPHA - default=false)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
GCERegionalPersistentDisk=true|false (BETA - default=true)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (BETA - default=true)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (ALPHA - default=false)
PodShareProcessNamespace=true|false (ALPHA - default=false)
ReadOnlyAPIDataVolumes=true|false (DEPRECATED - default=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
RunAsGroup=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
ServiceProxyAllowExternalIPs=true|false (DEPRECATED - default=false)
StorageObjectInUseProtection=true|false (BETA - default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (BETA - default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
TokenRequest=true|false (ALPHA - default=false)
VolumeScheduling=true|false (BETA - default=true)
VolumeSubpath=true|false (default=true)		A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
AttachVolumeLimit=true|false (ALPHA - default=false)
BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (BETA - default=true)
CSIBlockVolume=true|false (ALPHA - default=false)
CSIPersistentVolume=true|false (BETA - default=true)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (BETA - default=true)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (BETA - default=true)
DynamicProvisioningScheduling=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandInUsePersistentVolumes=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (BETA - default=true)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
GCERegionalPersistentDisk=true|false (BETA - default=true)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
KubeletPluginsWatcher=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (BETA - default=true)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (BETA - default=true)
PodReadinessGates=true|false (BETA - default=false)
PodShareProcessNamespace=true|false (ALPHA - default=false)
QOSReserved=true|false (ALPHA - default=false)
ReadOnlyAPIDataVolumes=true|false (DEPRECATED - default=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
ResourceQuotaScopeSelectors=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
RunAsGroup=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
ServiceProxyAllowExternalIPs=true|false (DEPRECATED - default=false)
StorageObjectInUseProtection=true|false (default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
Sysctls=true|false (BETA - default=true)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
TokenRequest=true|false (ALPHA - default=false)
TokenRequestProjection=true|false (ALPHA - default=false)
VolumeScheduling=true|false (BETA - default=true)
VolumeSubpath=true|false (default=true)
VolumeSubpathEnvExpansion=true|false (ALPHA - default=false)
-h, --help
help for kube-apiserverhelp for kube-apiserver
--http2-max-streams-per-connection int
The limit that the server gives to clients for the maximum number of streams in an HTTP/2 connection. Zero means to use golang's default.The limit that the server gives to clients for the maximum number of streams in an HTTP/2 connection. Zero means to use golang's default.
--kubelet-certificate-authority string
Path to a cert file for the certificate authority.Path to a cert file for the certificate authority.
--kubelet-client-certificate string
Path to a client cert file for TLS.Path to a client cert file for TLS.
--kubelet-client-key string
Path to a client key file for TLS.Path to a client key file for TLS.
--kubelet-https     Default: true
Use https for kubelet connections.Use https for kubelet connections.
--kubelet-preferred-address-types stringSlice     Default: [Hostname,InternalDNS,InternalIP,ExternalDNS,ExternalIP]
List of the preferred NodeAddressTypes to use for kubelet connections.List of the preferred NodeAddressTypes to use for kubelet connections.
--kubelet-read-only-port uint     Default: 10255
DEPRECATED: kubelet port.DEPRECATED: kubelet port.
--kubelet-timeout duration     Default: 5s
Timeout for kubelet operations.Timeout for kubelet operations.
--kubernetes-service-node-port int
If non-zero, the Kubernetes master service (which apiserver creates/maintains) will be of type NodePort, using this as the value of the port. If zero, the Kubernetes master service will be of type ClusterIP.If non-zero, the Kubernetes master service (which apiserver creates/maintains) will be of type NodePort, using this as the value of the port. If zero, the Kubernetes master service will be of type ClusterIP.
--log-flush-frequency duration     Default: 5s
Maximum number of seconds between log flushesMaximum number of seconds between log flushes
--master-service-namespace string     Default: "default"
DEPRECATED: the namespace from which the kubernetes master services should be injected into pods.DEPRECATED: the namespace from which the kubernetes master services should be injected into pods.
--max-connection-bytes-per-sec int
If non-zero, throttle each user connection to this number of bytes/sec. Currently only applies to long-running requests.If non-zero, throttle each user connection to this number of bytes/sec. Currently only applies to long-running requests.
--max-mutating-requests-inflight int     Default: 200
The maximum number of mutating requests in flight at a given time. When the server exceeds this, it rejects requests. Zero for no limit.The maximum number of mutating requests in flight at a given time. When the server exceeds this, it rejects requests. Zero for no limit.
--max-requests-inflight int     Default: 400
The maximum number of non-mutating requests in flight at a given time. When the server exceeds this, it rejects requests. Zero for no limit.The maximum number of non-mutating requests in flight at a given time. When the server exceeds this, it rejects requests. Zero for no limit.
--min-request-timeout int     Default: 1800
An optional field indicating the minimum number of seconds a handler must keep a request open before timing it out. Currently only honored by the watch request handler, which picks a randomized value above this number as the connection timeout, to spread out load.An optional field indicating the minimum number of seconds a handler must keep a request open before timing it out. Currently only honored by the watch request handler, which picks a randomized value above this number as the connection timeout, to spread out load.
--oidc-ca-file string
If set, the OpenID server's certificate will be verified by one of the authorities in the oidc-ca-file, otherwise the host's root CA set will be used.If set, the OpenID server's certificate will be verified by one of the authorities in the oidc-ca-file, otherwise the host's root CA set will be used.
--oidc-client-id string
The client ID for the OpenID Connect client, must be set if oidc-issuer-url is set.The client ID for the OpenID Connect client, must be set if oidc-issuer-url is set.
--oidc-groups-claim string
If provided, the name of a custom OpenID Connect claim for specifying user groups. The claim value is expected to be a string or array of strings. This flag is experimental, please see the authentication documentation for further details.If provided, the name of a custom OpenID Connect claim for specifying user groups. The claim value is expected to be a string or array of strings. This flag is experimental, please see the authentication documentation for further details.
--oidc-groups-prefix string
If provided, all groups will be prefixed with this value to prevent conflicts with other authentication strategies.If provided, all groups will be prefixed with this value to prevent conflicts with other authentication strategies.
--oidc-issuer-url string
The URL of the OpenID issuer, only HTTPS scheme will be accepted. If set, it will be used to verify the OIDC JSON Web Token (JWT).The URL of the OpenID issuer, only HTTPS scheme will be accepted. If set, it will be used to verify the OIDC JSON Web Token (JWT).
--oidc-required-claim mapStringString
A key=value pair that describes a required claim in the ID Token. If set, the claim is verified to be present in the ID Token with a matching value. Repeat this flag to specify multiple claims.
--oidc-signing-algs stringSlice     Default: [RS256]
Comma-separated list of allowed JOSE asymmetric signing algorithms. JWTs with a 'alg' header value not in this list will be rejected. Values are defined by RFC 7518 https://tools.ietf.org/html/rfc7518#section-3.1.Comma-separated list of allowed JOSE asymmetric signing algorithms. JWTs with a 'alg' header value not in this list will be rejected. Values are defined by RFC 7518 https://tools.ietf.org/html/rfc7518#section-3.1.
--oidc-username-claim string     Default: "sub"
The OpenID claim to use as the user name. Note that claims other than the default ('sub') is not guaranteed to be unique and immutable. This flag is experimental, please see the authentication documentation for further details.The OpenID claim to use as the user name. Note that claims other than the default ('sub') is not guaranteed to be unique and immutable. This flag is experimental, please see the authentication documentation for further details.
--oidc-username-prefix string
If provided, all usernames will be prefixed with this value. If not provided, username claims other than 'email' are prefixed by the issuer URL to avoid clashes. To skip any prefixing, provide the value '-'.If provided, all usernames will be prefixed with this value. If not provided, username claims other than 'email' are prefixed by the issuer URL to avoid clashes. To skip any prefixing, provide the value '-'.
--profiling     Default: true
Enable profiling via web interface host:port/debug/pprof/Enable profiling via web interface host:port/debug/pprof/
--proxy-client-cert-file string
Client certificate used to prove the identity of the aggregator or kube-apiserver when it must call out during a request. This includes proxying requests to a user api-server and calling out to webhook admission plugins. It is expected that this cert includes a signature from the CA in the --requestheader-client-ca-file flag. That CA is published in the 'extension-apiserver-authentication' configmap in the kube-system namespace. Components receiving calls from kube-aggregator should use that CA to perform their half of the mutual TLS verification.Client certificate used to prove the identity of the aggregator or kube-apiserver when it must call out during a request. This includes proxying requests to a user api-server and calling out to webhook admission plugins. It is expected that this cert includes a signature from the CA in the --requestheader-client-ca-file flag. That CA is published in the 'extension-apiserver-authentication' configmap in the kube-system namespace. Components receiving calls from kube-aggregator should use that CA to perform their half of the mutual TLS verification.
--proxy-client-key-file string
Private key for the client certificate used to prove the identity of the aggregator or kube-apiserver when it must call out during a request. This includes proxying requests to a user api-server and calling out to webhook admission plugins.
--repair-malformed-updates     Default: true
If true, server will do its best to fix the update request to pass the validation, e.g., setting empty UID in update request to its existing value. This flag can be turned off after we fix all the clients that send malformed updates.Private key for the client certificate used to prove the identity of the aggregator or kube-apiserver when it must call out during a request. This includes proxying requests to a user api-server and calling out to webhook admission plugins.
--request-timeout duration     Default: 1m0s
An optional field indicating the duration a handler must keep a request open before timing it out. This is the default request timeout for requests but may be overridden by flags such as --min-request-timeout for specific types of requests.An optional field indicating the duration a handler must keep a request open before timing it out. This is the default request timeout for requests but may be overridden by flags such as --min-request-timeout for specific types of requests.
--requestheader-allowed-names stringSlice
List of client certificate common names to allow to provide usernames in headers specified by --requestheader-username-headers. If empty, any client certificate validated by the authorities in --requestheader-client-ca-file is allowed.List of client certificate common names to allow to provide usernames in headers specified by --requestheader-username-headers. If empty, any client certificate validated by the authorities in --requestheader-client-ca-file is allowed.
--requestheader-client-ca-file string
Root certificate bundle to use to verify client certificates on incoming requests before trusting usernames in headers specified by --requestheader-username-headersRoot certificate bundle to use to verify client certificates on incoming requests before trusting usernames in headers specified by --requestheader-username-headers. WARNING: generally do not depend on authorization being already done for incoming requests.
--requestheader-extra-headers-prefix stringSlice
List of request header prefixes to inspect. X-Remote-Extra- is suggested.List of request header prefixes to inspect. X-Remote-Extra- is suggested.
--requestheader-group-headers stringSlice
List of request headers to inspect for groups. X-Remote-Group is suggested.List of request headers to inspect for groups. X-Remote-Group is suggested.
--requestheader-username-headers stringSlice
List of request headers to inspect for usernames. X-Remote-User is common.List of request headers to inspect for usernames. X-Remote-User is common.
--runtime-config mapStringString
A set of key=value pairs that describe runtime configuration that may be passed to apiserver. <group>/<version> (or <version> for the core group) key can be used to turn on/off specific api versions. <group>/<version>/<resource> (or <version>/<resource> for the core group) can be used to turn on/off specific resources. api/all and api/legacy are special keys to control all and legacy api versions respectively.A set of key=value pairs that describe runtime configuration that may be passed to apiserver. <group>/<version> (or <version> for the core group) key can be used to turn on/off specific api versions. api/all is special key to control all api versions, be careful setting it false, unless you know what you do. api/legacy is deprecated, we will remove it in the future, so stop using it.
--secure-port int     Default: 6443
The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all.The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all.
--service-account-api-audiences stringSlice
Identifiers of the API. The service account token authenticator will validate that tokens used against the API are bound to at least one of these audiences.Identifiers of the API. The service account token authenticator will validate that tokens used against the API are bound to at least one of these audiences.
--service-account-issuer string
Identifier of the service account token issuer. The issuer will assert this identifier in "iss" claim of issued tokens. This value is a string or URI.Identifier of the service account token issuer. The issuer will assert this identifier in "iss" claim of issued tokens. This value is a string or URI.
--service-account-key-file stringArray
File containing PEM-encoded x509 RSA or ECDSA private or public keys, used to verify ServiceAccount tokens. The specified file can contain multiple keys, and the flag can be specified multiple times with different files. If unspecified, --tls-private-key-file is used. Must be specified when --service-account-signing-key is providedFile containing PEM-encoded x509 RSA or ECDSA private or public keys, used to verify ServiceAccount tokens. The specified file can contain multiple keys, and the flag can be specified multiple times with different files. If unspecified, --tls-private-key-file is used. Must be specified when --service-account-signing-key is provided
--service-account-lookup     Default: true
If true, validate ServiceAccount tokens exist in etcd as part of authentication.If true, validate ServiceAccount tokens exist in etcd as part of authentication.
--service-account-signing-key-file string
Path to the file that contains the current private key of the service account token issuer. The issuer will sign issued ID tokens with this private key. (Ignored unless alpha TokenRequest is enabledPath to the file that contains the current private key of the service account token issuer. The issuer will sign issued ID tokens with this private key. (Requires the 'TokenRequest' feature gate.)
--service-cluster-ip-range ipNet     Default: 10.0.0.0/24
A CIDR notation IP range from which to assign service cluster IPs. This must not overlap with any IP ranges assigned to nodes for pods.A CIDR notation IP range from which to assign service cluster IPs. This must not overlap with any IP ranges assigned to nodes for pods.
--service-node-port-range portRange     Default: 30000-32767
A port range to reserve for services with NodePort visibility. Example: '30000-32767'. Inclusive at both ends of the range.A port range to reserve for services with NodePort visibility. Example: '30000-32767'. Inclusive at both ends of the range.
--storage-backend string
The storage backend for persistence. Options: 'etcd3' (default), 'etcd2'.The storage backend for persistence. Options: 'etcd3' (default), 'etcd2'.
--storage-media-type string     Default: "application/vnd.kubernetes.protobuf"
The media type to use to store objects in storage. Some resources or storage backends may only support a specific media type and will ignore this setting.The media type to use to store objects in storage. Some resources or storage backends may only support a specific media type and will ignore this setting.
--storage-versions string     Default: "admission.k8s.io/v1beta1,
admissionregistration.k8s.io/v1beta1,
apps/v1,
authentication.k8s.io/v1,
authorization.k8s.io/v1,
autoscaling/v1,
batch/v1,
certificates.k8s.io/v1beta1,
componentconfig/v1alpha1,
events.k8s.io/v1beta1,
extensions/v1beta1,
imagepolicy.k8s.io/v1alpha1,
kubeadm.k8s.io/v1alpha1,
networking.k8s.io/v1,
policy/v1beta1,
rbac.authorization.k8s.io/v1,
scheduling.k8s.io/v1alpha1,
settings.k8s.io/v1alpha1,
storage.k8s.io/v1,
v1"		--storage-versions string     Default: "admission.k8s.io/v1beta1,
admissionregistration.k8s.io/v1beta1,
apps/v1,
authentication.k8s.io/v1,
authorization.k8s.io/v1,
autoscaling/v1,
batch/v1,
certificates.k8s.io/v1beta1,
componentconfig/v1alpha1,
events.k8s.io/v1beta1,
extensions/v1beta1,
imagepolicy.k8s.io/v1alpha1,
networking.k8s.io/v1,
policy/v1beta1,
rbac.authorization.k8s.io/v1,
scheduling.k8s.io/v1beta1,
settings.k8s.io/v1alpha1,
storage.k8s.io/v1,
v1"
The per-group version to store resources in. Specified in the format "group1/version1,group2/version2,...". In the case where objects are moved from one group to the other, you may specify the format "group1=group2/v1beta1,group3/v1beta1,...". You only need to pass the groups you wish to change from the defaults. It defaults to a list of preferred versions of all registered groups, which is derived from the KUBE_API_VERSIONS environment variable.The per-group version to store resources in. Specified in the format "group1/version1,group2/version2,...". In the case where objects are moved from one group to the other, you may specify the format "group1=group2/v1beta1,group3/v1beta1,...". You only need to pass the groups you wish to change from the defaults. It defaults to a list of preferred versions of all known groups.
--target-ram-mb int
Memory limit for apiserver in MB (used to configure sizes of caches, etc.)Memory limit for apiserver in MB (used to configure sizes of caches, etc.)
--tls-cert-file string
File containing the default x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory specified by --cert-dir.File containing the default x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory specified by --cert-dir.
--tls-cipher-suites stringSlice
Comma-separated list of cipher suites for the server. Values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). If omitted, the default Go cipher suites will be usedComma-separated list of cipher suites for the server. If omitted, the default Go cipher suites will be use. Possible values: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_ECDSA_WITH_RC4_128_SHA,TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_RSA_WITH_RC4_128_SHA,TLS_RSA_WITH_3DES_EDE_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_128_GCM_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_256_GCM_SHA384,TLS_RSA_WITH_RC4_128_SHA
--tls-min-version string
Minimum TLS version supported. Value must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants.Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12
--tls-private-key-file string
File containing the default x509 private key matching --tls-cert-file.File containing the default x509 private key matching --tls-cert-file.
--tls-sni-cert-key namedCertKey     Default: []
A pair of x509 certificate and private key file paths, optionally suffixed with a list of domain patterns which are fully qualified domain names, possibly with prefixed wildcard segments. If no domain patterns are provided, the names of the certificate are extracted. Non-wildcard matches trump over wildcard matches, explicit domain patterns trump over extracted names. For multiple key/certificate pairs, use the --tls-sni-cert-key multiple times. Examples: "example.crt,example.key" or "foo.crt,foo.key:*.foo.com,foo.com".A pair of x509 certificate and private key file paths, optionally suffixed with a list of domain patterns which are fully qualified domain names, possibly with prefixed wildcard segments. If no domain patterns are provided, the names of the certificate are extracted. Non-wildcard matches trump over wildcard matches, explicit domain patterns trump over extracted names. For multiple key/certificate pairs, use the --tls-sni-cert-key multiple times. Examples: "example.crt,example.key" or "foo.crt,foo.key:*.foo.com,foo.com".
--token-auth-file string
If set, the file that will be used to secure the secure port of the API server via token authentication.If set, the file that will be used to secure the secure port of the API server via token authentication.
--version version[=true]
Print version information and quitPrint version information and quit
--watch-cache     Default: true
Enable watch caching in the apiserverEnable watch caching in the apiserver
--watch-cache-sizes stringSlice
List of watch cache sizes for every resource (pods, nodes, etc.), comma separated. The individual override format: resource[.group]#size, where resource is lowercase plural (no version), group is optional, and size is a number. It takes effect when watch-cache is enabled. Some resources (replicationcontrollers, endpoints, nodes, pods, services, apiservices.apiregistration.k8s.io) have system defaults set by heuristics, others default to default-watch-cache-sizeList of watch cache sizes for every resource (pods, nodes, etc.), comma separated. The individual override format: resource[.group]#size, where resource is lowercase plural (no version), group is optional, and size is a number. It takes effect when watch-cache is enabled. Some resources (replicationcontrollers, endpoints, nodes, pods, services, apiservices.apiregistration.k8s.io) have system defaults set by heuristics, others default to default-watch-cache-size
+ + + diff --git a/content/en/docs/reference/command-line-tools-reference/kube-controller-manager.md b/content/en/docs/reference/command-line-tools-reference/kube-controller-manager.md index f0ff07cbf0d8d..be3aa7a122f7f 100644 --- a/content/en/docs/reference/command-line-tools-reference/kube-controller-manager.md +++ b/content/en/docs/reference/command-line-tools-reference/kube-controller-manager.md @@ -1,12 +1,14 @@ --- title: kube-controller-manager notitle: true -weight: 50 --- ## kube-controller-manager + + ### Synopsis + The Kubernetes controller manager is a daemon that embeds the core control loops shipped with Kubernetes. In applications of robotics and automation, a control loop is a non-terminating loop that regulates the state of @@ -22,545 +24,631 @@ kube-controller-manager [flags] ### Options - +
+ - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - - - - - - - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + +
--address ip     Default: 0.0.0.0
DEPRECATED: the IP address on which to listen for the --port port. See --bind-address instead.DEPRECATED: the IP address on which to listen for the --port port (set to 0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces). See --bind-address instead.
--allocate-node-cidrs
Should CIDRs for Pods be allocated and set on the cloud provider.Should CIDRs for Pods be allocated and set on the cloud provider.
--attach-detach-reconcile-sync-period duration     Default: 1m0s
The reconciler sync wait time between volume attach detach. This duration must be larger than one second, and increasing this value from the default may allow for volumes to be mismatched with pods.The reconciler sync wait time between volume attach detach. This duration must be larger than one second, and increasing this value from the default may allow for volumes to be mismatched with pods.
--azure-container-registry-config string
Path to the file containing Azure container registry configuration information.Path to the file containing Azure container registry configuration information.
--bind-address ip     Default: 0.0.0.0
The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank, all interfaces will be used (0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces).The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank, all interfaces will be used (0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces).
--cert-dir string     Default: "/var/run/kubernetes"
The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored.The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored.
--cidr-allocator-type string     Default: "RangeAllocator"
Type of CIDR allocator to useType of CIDR allocator to use
--cloud-config string
The path to the cloud provider configuration file. Empty string for no configuration file.The path to the cloud provider configuration file. Empty string for no configuration file.
--cloud-provider string
The provider for cloud services. Empty string for no provider.The provider for cloud services. Empty string for no provider.
--cluster-cidr string
CIDR Range for Pods in cluster. Requires --allocate-node-cidrs to be trueCIDR Range for Pods in cluster. Requires --allocate-node-cidrs to be true
--cluster-name string     Default: "kubernetes"
The instance prefix for the cluster.The instance prefix for the cluster.
--cluster-signing-cert-file string     Default: "/etc/kubernetes/ca/ca.pem"
Filename containing a PEM-encoded X509 CA certificate used to issue cluster-scoped certificatesFilename containing a PEM-encoded X509 CA certificate used to issue cluster-scoped certificates
--cluster-signing-key-file string     Default: "/etc/kubernetes/ca/ca.key"
Filename containing a PEM-encoded RSA or ECDSA private key used to sign cluster-scoped certificatesFilename containing a PEM-encoded RSA or ECDSA private key used to sign cluster-scoped certificates
--concurrent-deployment-syncs int32     Default: 5
The number of deployment objects that are allowed to sync concurrently. Larger number = more responsive deployments, but more CPU (and network) loadThe number of deployment objects that are allowed to sync concurrently. Larger number = more responsive deployments, but more CPU (and network) load
--concurrent-endpoint-syncs int32     Default: 5
The number of endpoint syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) loadThe number of endpoint syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load
--concurrent-gc-syncs int32     Default: 20
The number of garbage collector workers that are allowed to sync concurrently.The number of garbage collector workers that are allowed to sync concurrently.
--concurrent-namespace-syncs int32     Default: 10
The number of namespace objects that are allowed to sync concurrently. Larger number = more responsive namespace termination, but more CPU (and network) loadThe number of namespace objects that are allowed to sync concurrently. Larger number = more responsive namespace termination, but more CPU (and network) load
--concurrent-replicaset-syncs int32     Default: 5
The number of replica sets that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) loadThe number of replica sets that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load
--concurrent-resource-quota-syncs int32     Default: 5
The number of resource quotas that are allowed to sync concurrently. Larger number = more responsive quota management, but more CPU (and network) loadThe number of resource quotas that are allowed to sync concurrently. Larger number = more responsive quota management, but more CPU (and network) load
--concurrent-service-syncs int32     Default: 1
The number of services that are allowed to sync concurrently. Larger number = more responsive service management, but more CPU (and network) loadThe number of services that are allowed to sync concurrently. Larger number = more responsive service management, but more CPU (and network) load
--concurrent-serviceaccount-token-syncs int32     Default: 5
The number of service account token objects that are allowed to sync concurrently. Larger number = more responsive token generation, but more CPU (and network) loadThe number of service account token objects that are allowed to sync concurrently. Larger number = more responsive token generation, but more CPU (and network) load
--concurrent_rc_syncs int32     Default: 5
The number of replication controllers that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) loadThe number of replication controllers that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load
--configure-cloud-routes     Default: true
Should CIDRs allocated by allocate-node-cidrs be configured on the cloud provider.Should CIDRs allocated by allocate-node-cidrs be configured on the cloud provider.
--contention-profiling
Enable lock contention profiling, if profiling is enabled.Enable lock contention profiling, if profiling is enabled
--controller-start-interval duration
Interval between starting controller managers.Interval between starting controller managers.
--controllers stringSlice     Default: [*]
A list of controllers to enable. '*' enables all on-by-default controllers, 'foo' enables the controller named 'foo', '-foo' disables the controller named 'foo'.
All controllers: attachdetach, bootstrapsigner, clusterrole-aggregation, cronjob, csrapproving, csrcleaner, csrsigning, daemonset, deployment, disruption, endpoint, garbagecollector, horizontalpodautoscaling, job, namespace, nodeipam, nodelifecycle, persistentvolume-binder, persistentvolume-expander, podgc, pv-protection, pvc-protection, replicaset, replicationcontroller, resourcequota, route, service, serviceaccount, serviceaccount-token, statefulset, tokencleaner, ttl
Disabled-by-default controllers: bootstrapsigner, tokencleaner		A list of controllers to enable. '*' enables all on-by-default controllers, 'foo' enables the controller named 'foo', '-foo' disables the controller named 'foo'.
All controllers: attachdetach, bootstrapsigner, clusterrole-aggregation, cronjob, csrapproving, csrcleaner, csrsigning, daemonset, deployment, disruption, endpoint, garbagecollector, horizontalpodautoscaling, job, namespace, nodeipam, nodelifecycle, persistentvolume-binder, persistentvolume-expander, podgc, pv-protection, pvc-protection, replicaset, replicationcontroller, resourcequota, route, service, serviceaccount, serviceaccount-token, statefulset, tokencleaner, ttl
Disabled-by-default controllers: bootstrapsigner, tokencleaner
--deployment-controller-sync-period duration     Default: 30s
Period for syncing the deployments.Period for syncing the deployments.
--disable-attach-detach-reconcile-sync
Disable volume attach detach reconciler sync. Disabling this may cause volumes to be mismatched with pods. Use wisely.Disable volume attach detach reconciler sync. Disabling this may cause volumes to be mismatched with pods. Use wisely.
--enable-dynamic-provisioning     Default: true
Enable dynamic provisioning for environments that support it.Enable dynamic provisioning for environments that support it.
--enable-garbage-collector     Default: true
Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-apiserver.Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-apiserver.
--enable-hostpath-provisioner
Enable HostPath PV provisioning when running without a cloud provider. This allows testing and development of provisioning features. HostPath provisioning is not supported in any way, won't work in a multi-node cluster, and should not be used for anything other than testing or development.Enable HostPath PV provisioning when running without a cloud provider. This allows testing and development of provisioning features. HostPath provisioning is not supported in any way, won't work in a multi-node cluster, and should not be used for anything other than testing or development.
--enable-taint-manager     Default: true
WARNING: Beta feature. If set to true enables NoExecute Taints and will evict all not-tolerating Pod running on Nodes tainted with this kind of Taints.WARNING: Beta feature. If set to true enables NoExecute Taints and will evict all not-tolerating Pod running on Nodes tainted with this kind of Taints.
--experimental-cluster-signing-duration duration     Default: 8760h0m0s
The length of duration signed certificates will be given.The length of duration signed certificates will be given.
--external-cloud-volume-plugin string
The plugin to use when cloud provider is set to external. Can be empty, should only be set when cloud-provider is external. Currently used to allow node and volume controllers to work for in tree cloud providers.The plugin to use when cloud provider is set to external. Can be empty, should only be set when cloud-provider is external. Currently used to allow node and volume controllers to work for in tree cloud providers.
--feature-gates mapStringBool
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
Accelerators=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (ALPHA - default=false)
CSIPersistentVolume=true|false (BETA - default=true)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (ALPHA - default=false)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (ALPHA - default=false)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
GCERegionalPersistentDisk=true|false (BETA - default=true)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (BETA - default=true)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (ALPHA - default=false)
PodShareProcessNamespace=true|false (ALPHA - default=false)
ReadOnlyAPIDataVolumes=true|false (DEPRECATED - default=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
RunAsGroup=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
ServiceProxyAllowExternalIPs=true|false (DEPRECATED - default=false)
StorageObjectInUseProtection=true|false (BETA - default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (BETA - default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
TokenRequest=true|false (ALPHA - default=false)
VolumeScheduling=true|false (BETA - default=true)
VolumeSubpath=true|false (default=true)		A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
AttachVolumeLimit=true|false (ALPHA - default=false)
BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (BETA - default=true)
CSIBlockVolume=true|false (ALPHA - default=false)
CSIPersistentVolume=true|false (BETA - default=true)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (BETA - default=true)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (BETA - default=true)
DynamicProvisioningScheduling=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandInUsePersistentVolumes=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (BETA - default=true)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
GCERegionalPersistentDisk=true|false (BETA - default=true)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
KubeletPluginsWatcher=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (BETA - default=true)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (BETA - default=true)
PodReadinessGates=true|false (BETA - default=false)
PodShareProcessNamespace=true|false (ALPHA - default=false)
QOSReserved=true|false (ALPHA - default=false)
ReadOnlyAPIDataVolumes=true|false (DEPRECATED - default=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
ResourceQuotaScopeSelectors=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
RunAsGroup=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
ServiceProxyAllowExternalIPs=true|false (DEPRECATED - default=false)
StorageObjectInUseProtection=true|false (default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
Sysctls=true|false (BETA - default=true)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
TokenRequest=true|false (ALPHA - default=false)
TokenRequestProjection=true|false (ALPHA - default=false)
VolumeScheduling=true|false (BETA - default=true)
VolumeSubpath=true|false (default=true)
VolumeSubpathEnvExpansion=true|false (ALPHA - default=false)
--flex-volume-plugin-dir string     Default: "/usr/libexec/kubernetes/kubelet-plugins/volume/exec/"
Full path of the directory in which the flex volume plugin should search for additional third party volume plugins.Full path of the directory in which the flex volume plugin should search for additional third party volume plugins.
-h, --help
help for kube-controller-managerhelp for kube-controller-manager
--horizontal-pod-autoscaler-downscale-delay duration     Default: 5m0s
The period since last downscale, before another downscale can be performed in horizontal pod autoscaler.The period since last downscale, before another downscale can be performed in horizontal pod autoscaler.
--horizontal-pod-autoscaler-sync-period duration     Default: 30s
The period for syncing the number of pods in horizontal pod autoscaler.The period for syncing the number of pods in horizontal pod autoscaler.
--horizontal-pod-autoscaler-tolerance float     Default: 0.1
The minimum change (from 1.0) in the desired-to-actual metrics ratio for the horizontal pod autoscaler to consider scaling.The minimum change (from 1.0) in the desired-to-actual metrics ratio for the horizontal pod autoscaler to consider scaling.
--horizontal-pod-autoscaler-upscale-delay duration     Default: 3m0s
The period since last upscale, before another upscale can be performed in horizontal pod autoscaler.The period since last upscale, before another upscale can be performed in horizontal pod autoscaler.
--horizontal-pod-autoscaler-use-rest-clients     Default: true
WARNING: alpha feature. If set to true, causes the horizontal pod autoscaler controller to use REST clients through the kube-aggregator, instead of using the legacy metrics client through the API server proxy. This is required for custom metrics support in the horizontal pod autoscaler.If set to true, causes the horizontal pod autoscaler controller to use REST clients through the kube-aggregator, instead of using the legacy metrics client through the API server proxy. This is required for custom metrics support in the horizontal pod autoscaler.
--http2-max-streams-per-connection int
The limit that the server gives to clients for the maximum number of streams in an HTTP/2 connection. Zero means to use golang's default.The limit that the server gives to clients for the maximum number of streams in an HTTP/2 connection. Zero means to use golang's default.
--insecure-experimental-approve-all-kubelet-csrs-for-group string
This flag does nothing.This flag does nothing.
--kube-api-burst int32     Default: 30
Burst to use while talking with kubernetes apiserver.Burst to use while talking with kubernetes apiserver.
--kube-api-content-type string     Default: "application/vnd.kubernetes.protobuf"
Content type of requests sent to apiserver.Content type of requests sent to apiserver.
--kube-api-qps float32     Default: 20
QPS to use while talking with kubernetes apiserver.QPS to use while talking with kubernetes apiserver.
--kubeconfig string
Path to kubeconfig file with authorization and master location information.Path to kubeconfig file with authorization and master location information.
--large-cluster-size-threshold int32     Default: 50
Number of nodes from which NodeController treats the cluster as large for the eviction logic purposes. --secondary-node-eviction-rate is implicitly overridden to 0 for clusters this size or smaller.Number of nodes from which NodeController treats the cluster as large for the eviction logic purposes. --secondary-node-eviction-rate is implicitly overridden to 0 for clusters this size or smaller.
--leader-elect     Default: true
Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability.Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability.
--leader-elect-lease-duration duration     Default: 15s
The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled.The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled.
--leader-elect-renew-deadline duration     Default: 10s
The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled.The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled.
--leader-elect-resource-lock endpoints     Default: "endpoints"
The type of resource object that is used for locking during leader election. Supported options are endpoints (default) and `configmaps`.The type of resource object that is used for locking during leader election. Supported options are endpoints (default) and `configmaps`.
--leader-elect-retry-period duration     Default: 2s
The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled.The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled.
--log-flush-frequency duration     Default: 5s
Maximum number of seconds between log flushesMaximum number of seconds between log flushes
--master string
The address of the Kubernetes API server (overrides any value in kubeconfig).The address of the Kubernetes API server (overrides any value in kubeconfig).
--min-resync-period duration     Default: 12h0m0s
The resync period in reflectors will be random between MinResyncPeriod and 2*MinResyncPeriod.The resync period in reflectors will be random between MinResyncPeriod and 2*MinResyncPeriod.
--namespace-sync-period duration     Default: 5m0s
The period for syncing namespace life-cycle updatesThe period for syncing namespace life-cycle updates
--node-cidr-mask-size int32     Default: 24
Mask size for node cidr in cluster.Mask size for node cidr in cluster.
--node-eviction-rate float32     Default: 0.1
Number of nodes per second on which pods are deleted in case of node failure when a zone is healthy (see --unhealthy-zone-threshold for definition of healthy/unhealthy). Zone refers to entire cluster in non-multizone clusters.Number of nodes per second on which pods are deleted in case of node failure when a zone is healthy (see --unhealthy-zone-threshold for definition of healthy/unhealthy). Zone refers to entire cluster in non-multizone clusters.
--node-monitor-grace-period duration     Default: 40s
Amount of time which we allow running Node to be unresponsive before marking it unhealthy. Must be N times more than kubelet's nodeStatusUpdateFrequency, where N means number of retries allowed for kubelet to post node status.Amount of time which we allow running Node to be unresponsive before marking it unhealthy. Must be N times more than kubelet's nodeStatusUpdateFrequency, where N means number of retries allowed for kubelet to post node status.
--node-monitor-period duration     Default: 5s
The period for syncing NodeStatus in NodeController.The period for syncing NodeStatus in NodeController.
--node-startup-grace-period duration     Default: 1m0s
Amount of time which we allow starting Node to be unresponsive before marking it unhealthy.Amount of time which we allow starting Node to be unresponsive before marking it unhealthy.
--pod-eviction-timeout duration     Default: 5m0s
The grace period for deleting pods on failed nodes.The grace period for deleting pods on failed nodes.
--port int     Default: 10252
DEPRECATED: the port on which to serve HTTP insecurely without authentication and authorization. If 0, don't serve HTTPS at all. See --secure-port instead.DEPRECATED: the port on which to serve HTTP insecurely without authentication and authorization. If 0, don't serve HTTPS at all. See --secure-port instead.
--profiling     Default: true--profiling
Enable profiling via web interface host:port/debug/pprof/Enable profiling via web interface host:port/debug/pprof/
--pv-recycler-increment-timeout-nfs int32     Default: 30
the increment of time added per Gi to ActiveDeadlineSeconds for an NFS scrubber podthe increment of time added per Gi to ActiveDeadlineSeconds for an NFS scrubber pod
--pv-recycler-minimum-timeout-hostpath int32     Default: 60
The minimum ActiveDeadlineSeconds to use for a HostPath Recycler pod. This is for development and testing only and will not work in a multi-node cluster.The minimum ActiveDeadlineSeconds to use for a HostPath Recycler pod. This is for development and testing only and will not work in a multi-node cluster.
--pv-recycler-minimum-timeout-nfs int32     Default: 300
The minimum ActiveDeadlineSeconds to use for an NFS Recycler podThe minimum ActiveDeadlineSeconds to use for an NFS Recycler pod
--pv-recycler-pod-template-filepath-hostpath string
The file path to a pod definition used as a template for HostPath persistent volume recycling. This is for development and testing only and will not work in a multi-node cluster.The file path to a pod definition used as a template for HostPath persistent volume recycling. This is for development and testing only and will not work in a multi-node cluster.
--pv-recycler-pod-template-filepath-nfs string
The file path to a pod definition used as a template for NFS persistent volume recyclingThe file path to a pod definition used as a template for NFS persistent volume recycling
--pv-recycler-timeout-increment-hostpath int32     Default: 30
the increment of time added per Gi to ActiveDeadlineSeconds for a HostPath scrubber pod. This is for development and testing only and will not work in a multi-node cluster.the increment of time added per Gi to ActiveDeadlineSeconds for a HostPath scrubber pod. This is for development and testing only and will not work in a multi-node cluster.
--pvclaimbinder-sync-period duration     Default: 15s
The period for syncing persistent volumes and persistent volume claimsThe period for syncing persistent volumes and persistent volume claims
--resource-quota-sync-period duration     Default: 5m0s
The period for syncing quota usage status in the systemThe period for syncing quota usage status in the system
--root-ca-file string
If set, this root certificate authority will be included in service account's token secret. This must be a valid PEM-encoded CA bundle.If set, this root certificate authority will be included in service account's token secret. This must be a valid PEM-encoded CA bundle.
--route-reconciliation-period duration     Default: 10s
The period for reconciling routes created for Nodes by cloud provider.The period for reconciling routes created for Nodes by cloud provider.
--secondary-node-eviction-rate float32     Default: 0.01
Number of nodes per second on which pods are deleted in case of node failure when a zone is unhealthy (see --unhealthy-zone-threshold for definition of healthy/unhealthy). Zone refers to entire cluster in non-multizone clusters. This value is implicitly overridden to 0 if the cluster size is smaller than --large-cluster-size-threshold.Number of nodes per second on which pods are deleted in case of node failure when a zone is unhealthy (see --unhealthy-zone-threshold for definition of healthy/unhealthy). Zone refers to entire cluster in non-multizone clusters. This value is implicitly overridden to 0 if the cluster size is smaller than --large-cluster-size-threshold.
--secure-port int
The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all.
--service-account-private-key-file string
Filename containing a PEM-encoded private RSA or ECDSA key used to sign service account tokens.The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all.
--service-cluster-ip-range string
CIDR Range for Services in cluster. Requires --allocate-node-cidrs to be trueCIDR Range for Services in cluster. Requires --allocate-node-cidrs to be true
--terminated-pod-gc-threshold int32     Default: 12500
Number of terminated pods that can exist before the terminated pod garbage collector starts deleting terminated pods. If <= 0, the terminated pod garbage collector is disabled.Number of terminated pods that can exist before the terminated pod garbage collector starts deleting terminated pods. If <= 0, the terminated pod garbage collector is disabled.
--tls-cert-file string
File containing the default x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory specified by --cert-dir.File containing the default x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory specified by --cert-dir.
--tls-cipher-suites stringSlice
Comma-separated list of cipher suites for the server. Values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). If omitted, the default Go cipher suites will be usedComma-separated list of cipher suites for the server. If omitted, the default Go cipher suites will be use. Possible values: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_ECDSA_WITH_RC4_128_SHA,TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_RSA_WITH_RC4_128_SHA,TLS_RSA_WITH_3DES_EDE_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_128_GCM_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_256_GCM_SHA384,TLS_RSA_WITH_RC4_128_SHA
--tls-min-version string
Minimum TLS version supported. Value must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants.Minimum TLS version supported. Possible values: VersionTLS10, VersionTLS11, VersionTLS12
--tls-private-key-file string
File containing the default x509 private key matching --tls-cert-file.File containing the default x509 private key matching --tls-cert-file.
--tls-sni-cert-key namedCertKey     Default: []
A pair of x509 certificate and private key file paths, optionally suffixed with a list of domain patterns which are fully qualified domain names, possibly with prefixed wildcard segments. If no domain patterns are provided, the names of the certificate are extracted. Non-wildcard matches trump over wildcard matches, explicit domain patterns trump over extracted names. For multiple key/certificate pairs, use the --tls-sni-cert-key multiple times. Examples: "example.crt,example.key" or "foo.crt,foo.key:*.foo.com,foo.com".A pair of x509 certificate and private key file paths, optionally suffixed with a list of domain patterns which are fully qualified domain names, possibly with prefixed wildcard segments. If no domain patterns are provided, the names of the certificate are extracted. Non-wildcard matches trump over wildcard matches, explicit domain patterns trump over extracted names. For multiple key/certificate pairs, use the --tls-sni-cert-key multiple times. Examples: "example.crt,example.key" or "foo.crt,foo.key:*.foo.com,foo.com".
--unhealthy-zone-threshold float32     Default: 0.55
Fraction of Nodes in a zone which needs to be not Ready (minimum 3) for zone to be treated as unhealthy. Fraction of Nodes in a zone which needs to be not Ready (minimum 3) for zone to be treated as unhealthy.
--use-service-account-credentials
If true, use individual service account credentials for each controller.If true, use individual service account credentials for each controller.
--version version[=true]
Print version information and quitPrint version information and quit
+ + + diff --git a/content/en/docs/reference/command-line-tools-reference/kube-proxy.md b/content/en/docs/reference/command-line-tools-reference/kube-proxy.md index 015f57a95e4b6..848eaf3994009 100644 --- a/content/en/docs/reference/command-line-tools-reference/kube-proxy.md +++ b/content/en/docs/reference/command-line-tools-reference/kube-proxy.md @@ -1,12 +1,14 @@ --- title: kube-proxy notitle: true -weight: 60 --- ## kube-proxy + + ### Synopsis + The Kubernetes network proxy runs on each node. This reflects services as defined in the Kubernetes API on each node and can do simple TCP and UDP stream forwarding or round robin TCP and UDP forwarding across a set of backends. @@ -21,239 +23,288 @@ kube-proxy [flags] ### Options - +
+ - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + + + + + + + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + +
--azure-container-registry-config string
Path to the file containing Azure container registry configuration information.Path to the file containing Azure container registry configuration information.
--bind-address 0.0.0.0     Default: 0.0.0.0
The IP address for the proxy server to serve on (set to 0.0.0.0 for all IPv4 interfaces and `::` for all IPv6 interfaces)The IP address for the proxy server to serve on (set to 0.0.0.0 for all IPv4 interfaces and `::` for all IPv6 interfaces)
--cleanup
If true cleanup iptables and ipvs rules and exit.If true cleanup iptables and ipvs rules and exit.
--cleanup-ipvs     Default: true
If true make kube-proxy cleanup ipvs rules before running. Default is trueIf true make kube-proxy cleanup ipvs rules before running. Default is true
--cluster-cidr string
The CIDR range of pods in the cluster. When configured, traffic sent to a Service cluster IP from outside this range will be masqueraded and traffic sent from pods to an external LoadBalancer IP will be directed to the respective cluster IP insteadThe CIDR range of pods in the cluster. When configured, traffic sent to a Service cluster IP from outside this range will be masqueraded and traffic sent from pods to an external LoadBalancer IP will be directed to the respective cluster IP instead
--config string
The path to the configuration file.The path to the configuration file.
--config-sync-period duration     Default: 15m0s
How often configuration from the apiserver is refreshed. Must be greater than 0.How often configuration from the apiserver is refreshed. Must be greater than 0.
--conntrack-max-per-core int32     Default: 32768
Maximum number of NAT connections to track per CPU core (0 to leave the limit as-is and ignore conntrack-min).Maximum number of NAT connections to track per CPU core (0 to leave the limit as-is and ignore conntrack-min).
--conntrack-min int32     Default: 131072
Minimum number of conntrack entries to allocate, regardless of conntrack-max-per-core (set conntrack-max-per-core=0 to leave the limit as-is).Minimum number of conntrack entries to allocate, regardless of conntrack-max-per-core (set conntrack-max-per-core=0 to leave the limit as-is).
--conntrack-tcp-timeout-close-wait duration     Default: 1h0m0s
NAT timeout for TCP connections in the CLOSE_WAIT stateNAT timeout for TCP connections in the CLOSE_WAIT state
--conntrack-tcp-timeout-established duration     Default: 24h0m0s
Idle timeout for established TCP connections (0 to leave as-is)Idle timeout for established TCP connections (0 to leave as-is)
--feature-gates mapStringBool
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
Accelerators=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (ALPHA - default=false)
CSIPersistentVolume=true|false (BETA - default=true)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (ALPHA - default=false)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (ALPHA - default=false)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
GCERegionalPersistentDisk=true|false (BETA - default=true)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (BETA - default=true)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (ALPHA - default=false)
PodShareProcessNamespace=true|false (ALPHA - default=false)
ReadOnlyAPIDataVolumes=true|false (DEPRECATED - default=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
RunAsGroup=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
ServiceProxyAllowExternalIPs=true|false (DEPRECATED - default=false)
StorageObjectInUseProtection=true|false (BETA - default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (BETA - default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
TokenRequest=true|false (ALPHA - default=false)
VolumeScheduling=true|false (BETA - default=true)
VolumeSubpath=true|false (default=true)		A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
AttachVolumeLimit=true|false (ALPHA - default=false)
BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (BETA - default=true)
CSIBlockVolume=true|false (ALPHA - default=false)
CSIPersistentVolume=true|false (BETA - default=true)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (BETA - default=true)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (BETA - default=true)
DynamicProvisioningScheduling=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandInUsePersistentVolumes=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (BETA - default=true)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
GCERegionalPersistentDisk=true|false (BETA - default=true)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
KubeletPluginsWatcher=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (BETA - default=true)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (BETA - default=true)
PodReadinessGates=true|false (BETA - default=false)
PodShareProcessNamespace=true|false (ALPHA - default=false)
QOSReserved=true|false (ALPHA - default=false)
ReadOnlyAPIDataVolumes=true|false (DEPRECATED - default=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
ResourceQuotaScopeSelectors=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
RunAsGroup=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
ServiceProxyAllowExternalIPs=true|false (DEPRECATED - default=false)
StorageObjectInUseProtection=true|false (default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
Sysctls=true|false (BETA - default=true)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
TokenRequest=true|false (ALPHA - default=false)
TokenRequestProjection=true|false (ALPHA - default=false)
VolumeScheduling=true|false (BETA - default=true)
VolumeSubpath=true|false (default=true)
VolumeSubpathEnvExpansion=true|false (ALPHA - default=false)
--healthz-bind-address 0.0.0.0     Default: 0.0.0.0:10256
The IP address and port for the health check server to serve on (set to 0.0.0.0 for all IPv4 interfaces and `::` for all IPv6 interfaces)The IP address and port for the health check server to serve on (set to 0.0.0.0 for all IPv4 interfaces and `::` for all IPv6 interfaces)
--healthz-port int32     Default: 10256
The port to bind the health check server. Use 0 to disable.The port to bind the health check server. Use 0 to disable.
-h, --help
help for kube-proxyhelp for kube-proxy
--hostname-override string
If non-empty, will use this string as identification instead of the actual hostname.If non-empty, will use this string as identification instead of the actual hostname.
--iptables-masquerade-bit int32     Default: 14
If using the pure iptables proxy, the bit of the fwmark space to mark packets requiring SNAT with. Must be within the range [0, 31].If using the pure iptables proxy, the bit of the fwmark space to mark packets requiring SNAT with. Must be within the range [0, 31].
--iptables-min-sync-period duration
The minimum interval of how often the iptables rules can be refreshed as endpoints and services change (e.g. '5s', '1m', '2h22m').The minimum interval of how often the iptables rules can be refreshed as endpoints and services change (e.g. '5s', '1m', '2h22m').
--iptables-sync-period duration     Default: 30s
The maximum interval of how often iptables rules are refreshed (e.g. '5s', '1m', '2h22m'). Must be greater than 0.The maximum interval of how often iptables rules are refreshed (e.g. '5s', '1m', '2h22m'). Must be greater than 0.
--ipvs-exclude-cidrs stringSlice
A comma-separated list of CIDR's which the ipvs proxier should not touch when cleaning up IPVS rules.
--ipvs-min-sync-period duration
The minimum interval of how often the ipvs rules can be refreshed as endpoints and services change (e.g. '5s', '1m', '2h22m').The minimum interval of how often the ipvs rules can be refreshed as endpoints and services change (e.g. '5s', '1m', '2h22m').
--ipvs-scheduler string
The ipvs scheduler type when proxy mode is ipvsThe ipvs scheduler type when proxy mode is ipvs
--ipvs-sync-period duration     Default: 30s
The maximum interval of how often ipvs rules are refreshed (e.g. '5s', '1m', '2h22m'). Must be greater than 0.The maximum interval of how often ipvs rules are refreshed (e.g. '5s', '1m', '2h22m'). Must be greater than 0.
--kube-api-burst int32     Default: 10
Burst to use while talking with kubernetes apiserverBurst to use while talking with kubernetes apiserver
--kube-api-content-type string     Default: "application/vnd.kubernetes.protobuf"
Content type of requests sent to apiserver.Content type of requests sent to apiserver.
--kube-api-qps float32     Default: 5
QPS to use while talking with kubernetes apiserverQPS to use while talking with kubernetes apiserver
--kubeconfig string
Path to kubeconfig file with authorization information (the master location is set by the master flag).Path to kubeconfig file with authorization information (the master location is set by the master flag).
--log-flush-frequency duration     Default: 5s
Maximum number of seconds between log flushesMaximum number of seconds between log flushes
--masquerade-all
If using the pure iptables proxy, SNAT all traffic sent via Service cluster IPs (this not commonly needed)If using the pure iptables proxy, SNAT all traffic sent via Service cluster IPs (this not commonly needed)
--master string
The address of the Kubernetes API server (overrides any value in kubeconfig)The address of the Kubernetes API server (overrides any value in kubeconfig)
--metrics-bind-address 0.0.0.0     Default: 127.0.0.1:10249
The IP address and port for the metrics server to serve on (set to 0.0.0.0 for all IPv4 interfaces and `::` for all IPv6 interfaces)The IP address and port for the metrics server to serve on (set to 0.0.0.0 for all IPv4 interfaces and `::` for all IPv6 interfaces)
--nodeport-addresses stringSlice
A string slice of values which specify the addresses to use for NodePorts. Values may be valid IP blocks (e.g. 1.2.3.0/24, 1.2.3.4/32). The default empty string slice ([]) means to use all local addresses.A string slice of values which specify the addresses to use for NodePorts. Values may be valid IP blocks (e.g. 1.2.3.0/24, 1.2.3.4/32). The default empty string slice ([]) means to use all local addresses.
--oom-score-adj int32     Default: -999
The oom-score-adj value for kube-proxy process. Values must be within the range [-1000, 1000]The oom-score-adj value for kube-proxy process. Values must be within the range [-1000, 1000]
--profiling
If true enables profiling via web interface on /debug/pprof handler.If true enables profiling via web interface on /debug/pprof handler.
--proxy-mode ProxyMode
Which proxy mode to use: 'userspace' (older) or 'iptables' (faster) or 'ipvs' (experimental). If blank, use the best-available proxy (currently iptables). If the iptables proxy is selected, regardless of how, but the system's kernel or iptables versions are insufficient, this always falls back to the userspace proxy.Which proxy mode to use: 'userspace' (older) or 'iptables' (faster) or 'ipvs' (experimental). If blank, use the best-available proxy (currently iptables). If the iptables proxy is selected, regardless of how, but the system's kernel or iptables versions are insufficient, this always falls back to the userspace proxy.
--proxy-port-range port-range
Range of host ports (beginPort-endPort, inclusive) that may be consumed in order to proxy service traffic. If unspecified (0-0) then ports will be randomly chosen.Range of host ports (beginPort-endPort, single port or beginPort+offset, inclusive) that may be consumed in order to proxy service traffic. If (unspecified, 0, or 0-0) then ports will be randomly chosen.
--udp-timeout duration     Default: 250ms
How long an idle UDP connection will be kept open (e.g. '250ms', '2s'). Must be greater than 0. Only applicable for proxy-mode=userspaceHow long an idle UDP connection will be kept open (e.g. '250ms', '2s'). Must be greater than 0. Only applicable for proxy-mode=userspace
--version version[=true]
Print version information and quitPrint version information and quit
--write-config-to string
If set, write the default configuration values to this file and exit.If set, write the default configuration values to this file and exit.
+ + + diff --git a/content/en/docs/reference/command-line-tools-reference/kube-scheduler.md b/content/en/docs/reference/command-line-tools-reference/kube-scheduler.md index ab0acc7e5e5bc..382ba3784b36f 100644 --- a/content/en/docs/reference/command-line-tools-reference/kube-scheduler.md +++ b/content/en/docs/reference/command-line-tools-reference/kube-scheduler.md @@ -1,12 +1,14 @@ --- title: kube-scheduler notitle: true -weight: 70 --- ## kube-scheduler + + ### Synopsis + The Kubernetes scheduler is a policy-rich, topology-aware, workload-specific function that significantly impacts availability, performance, and capacity. The scheduler needs to take into account individual and collective @@ -21,179 +23,218 @@ kube-scheduler [flags] ### Options - +
+ - + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + + - + - + + - + - + + - + + - + + - + + - + + + + + + + + +
--address string--address string     Default: "0.0.0.0"
The IP address to serve on (set to 0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces).DEPRECATED: the IP address on which to listen for the --port port (set to 0.0.0.0 for all IPv4 interfaces and :: for all IPv6 interfaces). See --bind-address instead.
--algorithm-provider string
The scheduling algorithm provider to use, one of: ClusterAutoscalerProvider | DefaultProviderDEPRECATED: the scheduling algorithm provider to use, one of: ClusterAutoscalerProvider | DefaultProvider
--azure-container-registry-config string
Path to the file containing Azure container registry configuration information.Path to the file containing Azure container registry configuration information.
--config string
The path to the configuration file.The path to the configuration file. Flags override values in this file.
--contention-profiling
Enable lock contention profiling, if profiling is enabledDEPRECATED: enable lock contention profiling, if profiling is enabled
--feature-gates mapStringBool
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
Accelerators=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (ALPHA - default=false)
CSIPersistentVolume=true|false (BETA - default=true)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (ALPHA - default=false)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (ALPHA - default=false)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
GCERegionalPersistentDisk=true|false (BETA - default=true)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (BETA - default=true)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (ALPHA - default=false)
PodShareProcessNamespace=true|false (ALPHA - default=false)
ReadOnlyAPIDataVolumes=true|false (DEPRECATED - default=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
RunAsGroup=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
ServiceProxyAllowExternalIPs=true|false (DEPRECATED - default=false)
StorageObjectInUseProtection=true|false (BETA - default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (BETA - default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
TokenRequest=true|false (ALPHA - default=false)
VolumeScheduling=true|false (BETA - default=true)
VolumeSubpath=true|false (default=true)		A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AppArmor=true|false (BETA - default=true)
AttachVolumeLimit=true|false (ALPHA - default=false)
BalanceAttachedNodeVolumes=true|false (ALPHA - default=false)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CRIContainerLogRotation=true|false (BETA - default=true)
CSIBlockVolume=true|false (ALPHA - default=false)
CSIPersistentVolume=true|false (BETA - default=true)
CustomPodDNS=true|false (BETA - default=true)
CustomResourceSubresources=true|false (BETA - default=true)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (BETA - default=true)
DynamicProvisioningScheduling=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandInUsePersistentVolumes=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (BETA - default=true)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
GCERegionalPersistentDisk=true|false (BETA - default=true)
HugePages=true|false (BETA - default=true)
HyperVContainer=true|false (ALPHA - default=false)
Initializers=true|false (ALPHA - default=false)
KubeletPluginsWatcher=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (BETA - default=true)
PersistentLocalVolumes=true|false (BETA - default=true)
PodPriority=true|false (BETA - default=true)
PodReadinessGates=true|false (BETA - default=false)
PodShareProcessNamespace=true|false (ALPHA - default=false)
QOSReserved=true|false (ALPHA - default=false)
ReadOnlyAPIDataVolumes=true|false (DEPRECATED - default=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
ResourceQuotaScopeSelectors=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
RunAsGroup=true|false (ALPHA - default=false)
ScheduleDaemonSetPods=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
ServiceProxyAllowExternalIPs=true|false (DEPRECATED - default=false)
StorageObjectInUseProtection=true|false (default=true)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (default=true)
SupportPodPidsLimit=true|false (ALPHA - default=false)
Sysctls=true|false (BETA - default=true)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
TokenRequest=true|false (ALPHA - default=false)
TokenRequestProjection=true|false (ALPHA - default=false)
VolumeScheduling=true|false (BETA - default=true)
VolumeSubpath=true|false (default=true)
VolumeSubpathEnvExpansion=true|false (ALPHA - default=false)
-h, --help
help for kube-schedulerhelp for kube-scheduler
--kube-api-burst int32     Default: 100
Burst to use while talking with kubernetes apiserverDEPRECATED: burst to use while talking with kubernetes apiserver
--kube-api-content-type string     Default: "application/vnd.kubernetes.protobuf"
Content type of requests sent to apiserver.DEPRECATED: content type of requests sent to apiserver.
--kube-api-qps float32     Default: 50
QPS to use while talking with kubernetes apiserverDEPRECATED: QPS to use while talking with kubernetes apiserver
--kubeconfig string
Path to kubeconfig file with authorization and master location information.DEPRECATED: path to kubeconfig file with authorization and master location information.
--leader-elect     Default: true
Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability.Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability.
--leader-elect-lease-duration duration     Default: 15s
The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled.The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled.
--leader-elect-renew-deadline duration     Default: 10s
The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled.The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled.
--leader-elect-resource-lock endpoints     Default: "endpoints"
The type of resource object that is used for locking during leader election. Supported options are endpoints (default) and `configmaps`.The type of resource object that is used for locking during leader election. Supported options are endpoints (default) and `configmaps`.
--leader-elect-retry-period duration     Default: 2s
The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled.The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled.
--lock-object-name string     Default: "kube-scheduler"
Define the name of the lock object.DEPRECATED: define the name of the lock object.
--lock-object-namespace string     Default: "kube-system"
Define the namespace of the lock object.DEPRECATED: define the namespace of the lock object.
--log-flush-frequency duration     Default: 5s
Maximum number of seconds between log flushesMaximum number of seconds between log flushes
--master string
The address of the Kubernetes API server (overrides any value in kubeconfig)The address of the Kubernetes API server (overrides any value in kubeconfig)
--policy-config-file string
File with scheduler policy configuration. This file is used if policy ConfigMap is not provided or --use-legacy-policy-config==trueDEPRECATED: file with scheduler policy configuration. This file is used if policy ConfigMap is not provided or --use-legacy-policy-config=true
--policy-configmap string
Name of the ConfigMap object that contains scheduler's policy configuration. It must exist in the system namespace before scheduler initialization if --use-legacy-policy-config==false. The config must be provided as the value of an element in 'Data' map with the key='policy.cfg'DEPRECATED: name of the ConfigMap object that contains scheduler's policy configuration. It must exist in the system namespace before scheduler initialization if --use-legacy-policy-config=false. The config must be provided as the value of an element in 'Data' map with the key='policy.cfg'
--policy-configmap-namespace string--policy-configmap-namespace string     Default: "kube-system"
The namespace where policy ConfigMap is located. The system namespace will be used if this is not provided or is empty.DEPRECATED: the namespace where policy ConfigMap is located. The kube-system namespace will be used if this is not provided or is empty.
--port int32     Default: 10251--port int     Default: 10251
The port that the scheduler's http service runs onDEPRECATED: the port on which to serve HTTP insecurely without authentication and authorization. If 0, don't serve HTTPS at all. See --secure-port instead.
--profiling
Enable profiling via web interface host:port/debug/pprof/DEPRECATED: enable profiling via web interface host:port/debug/pprof/
--scheduler-name string     Default: "default-scheduler"
Name of the scheduler, used to select which pods will be processed by this scheduler, based on pod's "spec.SchedulerName".DEPRECATED: name of the scheduler, used to select which pods will be processed by this scheduler, based on pod's "spec.schedulerName".
--use-legacy-policy-config
When set to true, scheduler will ignore policy ConfigMap and uses policy config fileDEPRECATED: when set to true, scheduler will ignore policy ConfigMap and uses policy config file
--version version[=true]
Print version information and quitPrint version information and quit
--write-config-to string
If set, write the configuration values to this file and exit.
+ + + diff --git a/content/en/docs/reference/command-line-tools-reference/kubelet.md b/content/en/docs/reference/command-line-tools-reference/kubelet.md index 1026c4fc4884a..5506d3469d66c 100644 --- a/content/en/docs/reference/command-line-tools-reference/kubelet.md +++ b/content/en/docs/reference/command-line-tools-reference/kubelet.md @@ -1,7 +1,6 @@ --- title: kubelet notitle: true -weight: 20 --- ## kubelet @@ -17,7 +16,7 @@ various mechanisms (primarily through the apiserver) and ensures that the contai described in those PodSpecs are running and healthy. The kubelet doesn't manage containers which were not created by Kubernetes. -Other than from an PodSpec from the apiserver, there are three ways that a container +Other than from a PodSpec from the apiserver, there are three ways that a container manifest can be provided to the Kubelet. File: Path passed as a flag on the command line. Files under this path will be monitored @@ -31,772 +30,48 @@ HTTP server: The kubelet can also listen for HTTP and respond to a simple API (underspec'd currently) to submit a new manifest. ``` -kubelet +kubelet [flags] ``` ### Options - +
- - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + - + - + + - + - + + - - - - - - - - - - - - - + +
--address 0.0.0.0     Default: 0.0.0.0
The IP address for the Kubelet to serve on (set to 0.0.0.0 for all IPv4 interfaces and `::` for all IPv6 interfaces)
--allow-privileged
If true, allow containers to request privileged mode.
--anonymous-auth     Default: true
Enables anonymous requests to the Kubelet server. Requests that are not rejected by another authentication method are treated as anonymous requests. Anonymous requests have a username of system:anonymous, and a group name of system:unauthenticated.
--authentication-token-webhook
Use the TokenReview API to determine authentication for bearer tokens.
--authentication-token-webhook-cache-ttl duration     Default: 2m0s
The duration to cache responses from the webhook token authenticator.
--authorization-mode string     Default: "AlwaysAllow"
Authorization mode for Kubelet server. Valid options are AlwaysAllow or Webhook. Webhook mode uses the SubjectAccessReview API to determine authorization.
--authorization-webhook-cache-authorized-ttl duration     Default: 5m0s
The duration to cache 'authorized' responses from the webhook authorizer.
--authorization-webhook-cache-unauthorized-ttl duration     Default: 30s
The duration to cache 'unauthorized' responses from the webhook authorizer.
--azure-container-registry-config string
Path to the file container Azure container registry configuration information.
--bootstrap-checkpoint-path string
Path to to the directory where the checkpoints are stored
--bootstrap-kubeconfig string
Path to a kubeconfig file that will be used to get client certificate for kubelet. If the file specified by --kubeconfig does not exist, the bootstrap kubeconfig is used to request a client certificate from the API server. On success, a kubeconfig file referencing the generated client certificate and key is written to the path specified by --kubeconfig. The client certificate and key file will be stored in the directory pointed by --cert-dir.
--cadvisor-port int32     Default: 4194
The port of the localhost cAdvisor endpoint (set to 0 to disable)
--cert-dir string     Default: "/var/lib/kubelet/pki"
The directory where the TLS certs are located. If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored.
--cgroup-driver string     Default: "cgroupfs"
Driver that the kubelet uses to manipulate cgroups on the host. Possible values: 'cgroupfs', 'systemd'
--cgroup-root string
Optional root cgroup to use for pods. This is handled by the container runtime on a best effort basis. Default: '', which means use the container runtime default.
--cgroups-per-qos     Default: true
Enable creation of QoS cgroup hierarchy, if true top level QoS and pod cgroups are created.
--chaos-chance float
If > 0.0, introduce random client errors and latency. Intended for testing.
--client-ca-file string
If set, any request presenting a client certificate signed by one of the authorities in the client-ca-file is authenticated with an identity corresponding to the CommonName of the client certificate.
--cloud-config string
The path to the cloud provider configuration file. Empty string for no configuration file.
--cloud-provider string
The provider for cloud services. Specify empty string for running with no cloud provider.
--cluster-dns stringSlice
Comma-separated list of DNS server IP address. This value is used for containers DNS server in case of Pods with "dnsPolicy=ClusterFirst". Note: all DNS servers appearing in the list MUST serve the same set of records otherwise name resolution within the cluster may not work correctly. There is no guarantee as to which DNS server may be contacted for name resolution.
--cluster-domain string
Domain for this cluster. If set, kubelet will configure all containers to search this domain in addition to the host's search domains
--cni-bin-dir string
The full path of the directory in which to search for CNI plugin binaries. Default: /opt/cni/bin
--cni-conf-dir string
The full path of the directory in which to search for CNI config files. Default: /etc/cni/net.d
--config string
The Kubelet will load its initial configuration from this file. The path may be absolute or relative; relative paths start at the Kubelet's current working directory. Omit this flag to use the built-in default configuration values. You must also enable the KubeletConfigFile feature gate to pass this flag.
--container-runtime string     Default: "docker"
The container runtime to use. Possible values: 'docker', 'rkt'.
--container-runtime-endpoint string     Default: "unix:///var/run/dockershim.sock"
[Experimental] The endpoint of remote runtime service. Currently unix socket is supported on Linux, and tcp is supported on windows. Examples:'unix:///var/run/dockershim.sock', 'tcp://localhost:3735'
--containerized
Experimental support for running kubelet in a container. Intended for testing.
--contention-profiling
Enable lock contention profiling, if profiling is enabled
--cpu-cfs-quota     Default: true
Enable CPU CFS quota enforcement for containers that specify CPU limits
--cpu-manager-policy string     Default: "none"
CPU Manager policy to use. Possible values: 'none', 'static'. Default: 'none'
--cpu-manager-reconcile-period NodeStatusUpdateFrequency     Default: 10s
CPU Manager reconciliation period. Examples: '10s', or '1m'. If not supplied, defaults to NodeStatusUpdateFrequency
--docker-disable-shared-pid     Default: true
The Container Runtime Interface (CRI) defaults to using a shared PID namespace for containers in a pod when running with Docker 1.13.1 or higher. Setting this flag reverts to the previous behavior of isolated PID namespaces. This ability will be removed in a future Kubernetes release.
--docker-endpoint string     Default: "unix:///var/run/docker.sock"
Use this for the docker endpoint to communicate with
--dynamic-config-dir string
The Kubelet will use this directory for checkpointing downloaded configurations and tracking configuration health. The Kubelet will create this directory if it does not already exist. The path may be absolute or relative; relative paths start at the Kubelet's current working directory. Providing this flag enables dynamic Kubelet configuration. Presently, you must also enable the DynamicKubeletConfig feature gate to pass this flag.
--enable-controller-attach-detach     Default: true
Enables the Attach/Detach controller to manage attachment/detachment of volumes scheduled to this node, and disables kubelet from executing any attach/detach operations
--enable-debugging-handlers     Default: true
Enables server endpoints for log collection and local running of containers and commands
--enable-server     Default: true
Enable the Kubelet's server
--enforce-node-allocatable stringSlice     Default: [pods]
A comma separated list of levels of node allocatable enforcement to be enforced by kubelet. Acceptable options are 'pods', 'system-reserved' & 'kube-reserved'. If the latter two options are specified, '--system-reserved-cgroup' & '--kube-reserved-cgroup' must also be set respectively. See https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/ for more details.
--event-burst int32     Default: 10
Maximum size of a bursty event records, temporarily allows event records to burst to this number, while still not exceeding event-qps. Only used if --event-qps > 0
--event-qps int32     Default: 5
If > 0, limit event creations per second to this value. If 0, unlimited.
--eviction-hard mapStringString     Default: imagefs.available<15%!,(MISSING)memory.available<100Mi,nodefs.available<10%!,(MISSING)nodefs.inodesFree<5%!<(MISSING)/td> -
A set of eviction thresholds (e.g. memory.available<1Gi) that if met would trigger a pod eviction.
--eviction-max-pod-grace-period int32
Maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. If negative, defer to pod specified value.
--eviction-minimum-reclaim mapStringString
A set of minimum reclaims (e.g. imagefs.available=2Gi) that describes the minimum amount of resource the kubelet will reclaim when performing a pod eviction if that resource is under pressure.
--eviction-pressure-transition-period duration     Default: 5m0s
Duration for which the kubelet has to wait before transitioning out of an eviction pressure condition.
--eviction-soft mapStringString
A set of eviction thresholds (e.g. memory.available<1.5Gi) that if met over a corresponding grace period would trigger a pod eviction.
--eviction-soft-grace-period mapStringString
A set of eviction grace periods (e.g. memory.available=1m30s) that correspond to how long a soft eviction threshold must hold before triggering a pod eviction.
--exit-on-lock-contention
Whether kubelet should exit upon lock-file contention.
--experimental-allocatable-ignore-eviction
When set to 'true', Hard Eviction Thresholds will be ignored while calculating Node Allocatable. See https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/ for more details. [default=false]
--experimental-allowed-unsafe-sysctls stringSlice
Comma-separated whitelist of unsafe sysctls or unsafe sysctl patterns (ending in *). Use these at your own risk.
--experimental-bootstrap-kubeconfig string
deprecated: use --bootstrap-kubeconfig
--experimental-check-node-capabilities-before-mount
[Experimental] if set true, the kubelet will check the underlying node for required components (binaries, etc.) before performing the mount
--experimental-kernel-memcg-notification
If enabled, the kubelet will integrate with the kernel memcg notification to determine if memory eviction thresholds are crossed rather than polling.
--experimental-mounter-path string
[Experimental] Path of mounter binary. Leave empty to use the default mount.
--experimental-qos-reserved mapStringString
A set of ResourceName=Percentage (e.g. memory=50%!)(MISSING) pairs that describe how pod resource requests are reserved at the QoS level. Currently only memory is supported. [default=none]
--fail-swap-on     Default: true
Makes the Kubelet fail to start if swap is enabled on the node.
--feature-gates mapStringBool
A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
APIListChunking=true|false (BETA - default=true)
APIResponseCompression=true|false (ALPHA - default=false)
Accelerators=true|false (ALPHA - default=false)
AdvancedAuditing=true|false (BETA - default=true)
AllAlpha=true|false (ALPHA - default=false)
AllowExtTrafficLocalEndpoints=true|false (default=true)
AppArmor=true|false (BETA - default=true)
BlockVolume=true|false (ALPHA - default=false)
CPUManager=true|false (BETA - default=true)
CSIPersistentVolume=true|false (ALPHA - default=false)
CustomPodDNS=true|false (ALPHA - default=false)
CustomResourceValidation=true|false (BETA - default=true)
DebugContainers=true|false (ALPHA - default=false)
DevicePlugins=true|false (ALPHA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
EnableEquivalenceClassCache=true|false (ALPHA - default=false)
ExpandPersistentVolumes=true|false (ALPHA - default=false)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
HugePages=true|false (BETA - default=true)
Initializers=true|false (ALPHA - default=false)
KubeletConfigFile=true|false (ALPHA - default=false)
LocalStorageCapacityIsolation=true|false (ALPHA - default=false)
MountContainers=true|false (ALPHA - default=false)
MountPropagation=true|false (ALPHA - default=false)
PVCProtection=true|false (ALPHA - default=false)
PersistentLocalVolumes=true|false (ALPHA - default=false)
PodPriority=true|false (ALPHA - default=false)
ResourceLimitsPriorityFunction=true|false (ALPHA - default=false)
RotateKubeletClientCertificate=true|false (BETA - default=true)
RotateKubeletServerCertificate=true|false (ALPHA - default=false)
ServiceNodeExclusion=true|false (ALPHA - default=false)
StreamingProxyRedirects=true|false (BETA - default=true)
SupportIPVSProxyMode=true|false (BETA - default=false)
TaintBasedEvictions=true|false (ALPHA - default=false)
TaintNodesByCondition=true|false (ALPHA - default=false)
VolumeScheduling=true|false (ALPHA - default=false)
--file-check-frequency duration     Default: 20s
Duration between checking config files for new data
--google-json-key string
The Google Cloud Platform Service Account JSON Key to use for authentication.
--hairpin-mode string     Default: "promiscuous-bridge"
How should the kubelet setup hairpin NAT. This allows endpoints of a Service to loadbalance back to themselves if they should try to access their own Service. Valid values are "promiscuous-bridge", "hairpin-veth" and "none".
--healthz-bind-address 0.0.0.0     Default: 127.0.0.1
The IP address for the healthz server to serve on (set to 0.0.0.0 for all IPv4 interfaces and `::` for all IPv6 interfaces)
--healthz-port int32     Default: 10248
The port of the localhost healthz endpoint (set to 0 to disable)
--host-ipc-sources stringSlice     Default: [*]
Comma-separated list of sources from which the Kubelet allows pods to use the host ipc namespace.
--host-network-sources stringSlice     Default: [*]
Comma-separated list of sources from which the Kubelet allows pods to use of host network.
--host-pid-sources stringSlice     Default: [*]
Comma-separated list of sources from which the Kubelet allows pods to use the host pid namespace.
--hostname-override string
If non-empty, will use this string as identification instead of the actual hostname.
--http-check-frequency duration     Default: 20s
Duration between checking http for new data
--image-gc-high-threshold int32     Default: 85
The percent of disk usage after which image garbage collection is always run.
--image-gc-low-threshold int32     Default: 80
The percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to.
--image-pull-progress-deadline duration     Default: 1m0s
If no pulling progress is made before this deadline, the image pulling will be cancelled.
--image-service-endpoint string
[Experimental] The endpoint of remote image service. If not specified, it will be the same with container-runtime-endpoint by default. Currently unix socket is supported on Linux, and tcp is supported on windows. Examples:'unix:///var/run/dockershim.sock', 'tcp://localhost:3735'
--iptables-drop-bit int32     Default: 15
The bit of the fwmark space to mark packets for dropping. Must be within the range [0, 31].
--iptables-masquerade-bit int32     Default: 14
The bit of the fwmark space to mark packets for SNAT. Must be within the range [0, 31]. Please match this parameter with corresponding parameter in kube-proxy.
--kube-api-burst int32     Default: 10
Burst to use while talking with kubernetes apiserver
--kube-api-content-type string     Default: "application/vnd.kubernetes.protobuf"
Content type of requests sent to apiserver.
--kube-api-qps int32     Default: 5
QPS to use while talking with kubernetes apiserver
--kube-reserved mapStringString
A set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=500Mi,ephemeral-storage=1Gi) pairs that describe resources reserved for kubernetes system components. Currently cpu, memory and local ephemeral storage for root file system are supported. See http://kubernetes.io/docs/user-guide/compute-resources for more detail. [default=none]
--kube-reserved-cgroup string
Absolute name of the top level cgroup that is used to manage kubernetes components for which compute resources were reserved via '--kube-reserved' flag. Ex. '/kube-reserved'. [default='']
--kubeconfig string     Default: "/var/lib/kubelet/kubeconfig"
Path to a kubeconfig file, specifying how to connect to the API server.
--kubelet-cgroups string
Optional absolute name of cgroups to create and run the Kubelet in.
--lock-file string
The path to file for kubelet to use as a lock file.
--make-iptables-util-chains     Default: true
If true, kubelet will ensure iptables utility rules are present on host.
--manifest-url string
URL for accessing the container manifest
--manifest-url-header --manifest-url-header 'a:hello,b:again,c:world' --manifest-url-header 'b:beautiful'
Comma-separated list of HTTP headers to use when accessing the manifest URL. Multiple headers with the same name will be added in the same order provided. This flag can be repeatedly invoked. For example: --manifest-url-header 'a:hello,b:again,c:world' --manifest-url-header 'b:beautiful'
--max-open-files int     Default: 1000000
Number of files that can be opened by Kubelet process.
--max-pods int32     Default: 110
Number of Pods that can run on this Kubelet.
--minimum-image-ttl-duration duration     Default: 2m0s
Minimum age for an unused image before it is garbage collected. Examples: '300ms', '10s' or '2h45m'.
--network-plugin string
The name of the network plugin to be invoked for various events in kubelet/pod lifecycle
--network-plugin-mtu int32
The MTU to be passed to the network plugin, to override the default. Set to 0 to use the default 1460 MTU.
--node-ip string
IP address of the node. If set, kubelet will use this IP address for the node
--node-labels mapStringString
Labels to add when registering the node in the cluster. Labels must be key=value pairs separated by ','.
--node-status-update-frequency duration     Default: 10s
Specifies how often kubelet posts node status to master. Note: be cautious when changing the constant, it must work with nodeMonitorGracePeriod in nodecontroller.
--oom-score-adj int32     Default: -999
The oom-score-adj value for kubelet process. Values must be within the range [-1000, 1000]
--pod-cidr string
The CIDR to use for pod IP addresses, only used in standalone mode. In cluster mode, this is obtained from the master.
--pod-infra-container-image string     Default: "gcr.io/google_containers/pause-amd64:3.1"
The image whose network/ipc namespaces containers in each pod will use.
--pod-manifest-path string
Path to the directory containing pod manifest files to run, or the path to a single pod manifest file. Files starting with dots will be ignored.
--pods-per-core int32
Number of Pods per core that can run on this Kubelet. The total number of Pods on this Kubelet cannot exceed max-pods, so max-pods will be used if this calculation results in a larger number of Pods allowed on the Kubelet. A value of 0 disables this limit.
--port int32     Default: 10250
The port for the Kubelet to serve on.
--protect-kernel-defaults
Default kubelet behaviour for kernel tuning. If set, kubelet errors if any of kernel tunables is different than kubelet defaults.
--provider-id string
Unique identifier for identifying the node in a machine database, i.e cloudprovider
--read-only-port int32     Default: 10255
The read-only port for the Kubelet to serve on with no authentication/authorization (set to 0 to disable)
--really-crash-for-testing
If true, when panics occur crash. Intended for testing.
--register-node     Default: true
Register the node with the apiserver. If --kubeconfig is not provided, this flag is irrelevant, as the Kubelet won't have an apiserver to register with. Default=true.
--register-with-taints []api.Taint
Register the node with the given list of taints (comma separated "=:"). No-op if register-node is false.
--registry-burst int32     Default: 10
Maximum size of a bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry-qps. Only used if --registry-qps > 0
--registry-qps int32     Default: 5
If > 0, limit registry pull QPS to this value. If 0, unlimited.
--resolv-conf string     Default: "/etc/resolv.conf"
Resolver configuration file used as the basis for the container DNS resolution configuration.
--rkt-api-endpoint string     Default: "localhost:15441"
The endpoint of the rkt API service to communicate with. Only used if --container-runtime='rkt'.
--rkt-path string
Path of rkt binary. Leave empty to use the first rkt in $PATH. Only used if --container-runtime='rkt'.
--root-dir string     Default: "/var/lib/kubelet"
Directory path for managing kubelet files (volume mounts,etc).
--rotate-certificates
Auto rotate the kubelet client certificates by requesting new certificates from the kube-apiserver when the certificate expiration approaches.
--runonce
If true, exit after spawning pods from local manifests or remote urls. Exclusive with --enable-server
--runtime-cgroups string
Optional absolute name of cgroups to create and run the runtime in.
--runtime-request-timeout duration     Default: 2m0s
Timeout of all runtime requests except long running request - pull, logs, exec and attach. When timeout exceeded, kubelet will cancel the request, throw out an error and retry later.
--seccomp-profile-root string     Default: "/var/lib/kubelet/seccomp"
Directory path for seccomp profiles.
--serialize-image-pulls     Default: true
Pull images one at a time. We recommend *not* changing the default value on nodes that run docker daemon with version < 1.9 or an Aufs storage backend. Issue #10959 has more details.
--streaming-connection-idle-timeout duration     Default: 4h0m0s
Maximum time a streaming connection can be idle before the connection is automatically closed. 0 indicates no timeout. Example: '5m'
--sync-frequency duration     Default: 1m0s
Max period between synchronizing running containers and config
--system-cgroups /
Optional absolute name of cgroups in which to place all non-kernel processes that are not already inside a cgroup under /. Empty for no container. Rolling back the flag requires a reboot.
--system-reserved mapStringString
A set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=500Mi,ephemeral-storage=1Gi) pairs that describe resources reserved for non-kubernetes components. Currently only cpu and memory are supported. See http://kubernetes.io/docs/user-guide/compute-resources for more detail. [default=none]
--system-reserved-cgroup string
Absolute name of the top level cgroup that is used to manage non-kubernetes components for which compute resources were reserved via '--system-reserved' flag. Ex. '/system-reserved'. [default='']Path to the file containing Azure container registry configuration information.
--tls-cert-file string-h, --help
File containing x509 Certificate used for serving HTTPS (with intermediate certs, if any, concatenated after server cert). If --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory passed to --cert-dir.help for kubelet
--tls-private-key-file string--log-flush-frequency duration     Default: 5s
File containing x509 private key matching --tls-cert-file.Maximum number of seconds between log flushes
--version version[=true]
Print version information and quit
--volume-plugin-dir string     Default: "/usr/libexec/kubernetes/kubelet-plugins/volume/exec/"
The full path of the directory in which to search for additional third party volume plugins
--volume-stats-agg-period duration     Default: 1m0s
Specifies interval for kubelet to calculate and cache the volume disk usage for all pods and volumes. To disable volume calculations, set to 0.Print version information and quit
+ + + diff --git a/content/en/docs/reference/federation/extensions/v1beta1/definitions.html b/content/en/docs/reference/federation/extensions/v1beta1/definitions.html index cdeef7b790c04..f3bafaf1493c8 100755 --- a/content/en/docs/reference/federation/extensions/v1beta1/definitions.html +++ b/content/en/docs/reference/federation/extensions/v1beta1/definitions.html @@ -683,6 +683,13 @@

v1beta1.DaemonSetStatus

integer (int32)

+ +

conditions

+

Represents the latest available observations of a DaemonSet’s current state.

+

false

+

v1beta1.DaemonSetCondition array

+ + @@ -1984,7 +1991,7 @@

v1.ObjectMeta

deletionTimestamp

-

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

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/api-conventions.md#metadata

false

@@ -2309,7 +2316,7 @@

v1.ISCSIVolumeSource

targetPortal

-

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

+

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

true

string

@@ -2323,14 +2330,14 @@

v1.ISCSIVolumeSource

lun

-

iSCSI target lun number.

+

iSCSI Target Lun number.

true

integer (int32)

iscsiInterface

-

Optional: Defaults to default (tcp). iSCSI interface name that uses an iSCSI transport.

+

iSCSI Interface Name that uses an iSCSI transport. Defaults to default (tcp).

false

string

@@ -2351,7 +2358,7 @@

v1.ISCSIVolumeSource

portals

-

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

+

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

false

string array

@@ -2372,14 +2379,14 @@

v1.ISCSIVolumeSource

secretRef

-

CHAP secret for iSCSI target and initiator authentication

+

CHAP Secret for iSCSI target and initiator authentication

false

v1.LocalObjectReference

initiatorName

-

Custom iSCSI initiator name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.

+

Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.

false

string

@@ -2557,8 +2564,8 @@

v1.PodAffinityTerm

topologyKey

-

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. For PreferredDuringScheduling pod anti-affinity, empty topologyKey is interpreted as "all topologies" ("all topologies" here means all the topologyKeys indicated by scheduler command-line argument --failure-domains); for affinity and for RequiredDuringScheduling pod anti-affinity, empty topologyKey is not allowed.

-

false

+

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.

+

true

string

@@ -2591,7 +2598,7 @@

v1.EnvFromSource

prefix

-

An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

+

An optional identifer to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

false

string

@@ -2880,7 +2887,7 @@

v1.SecretVolumeSource

v1.FlexVolumeSource

-

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.

+

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

@@ -3305,7 +3312,7 @@

v1.DeleteOptions

- + @@ -3478,7 +3485,7 @@

v1.Volume

- + @@ -4076,7 +4083,7 @@

v1.PodSpec

- + @@ -4207,6 +4214,13 @@

v1.PodSpec

+ + + + + + +

propagationPolicy

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.

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.

false

v1.DeletionPropagation

flexVolume

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

false

v1.FlexVolumeSource

dnsPolicy

Set DNS policy for containers within the pod. One of ClusterFirstWithHostNet, ClusterFirst or Default. Defaults to "ClusterFirst". To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to ClusterFirstWithHostNet.

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. Note that None policy is an alpha feature introduced in v1.9 and CustomPodDNS feature gate must be enabled to use it.

false

string

integer (int32)

dnsConfig

Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. This is an alpha feature introduced in v1.9 and CustomPodDNS feature gate must be enabled to use it.

false

v1.PodDNSConfig
@@ -5026,6 +5040,54 @@

v1.Status

+
+
+

v1.PodDNSConfig

+
+

PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

nameservers

A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.

false

string array

searches

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.

false

string array

options

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.

false

v1.PodDNSConfigOption array

+

v1beta1.ScaleStatus

@@ -5775,6 +5837,13 @@

v1.Container

+

volumeDevices

+

volumeDevices is the list of block devices to be used by the container. This is an alpha feature and may change in the future.

+

false

+

v1.VolumeDevice array

+ + +

livenessProbe

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

false

@@ -6139,6 +6208,47 @@

v1.APIResource

+
+
+

v1.VolumeDevice

+
+

volumeDevice describes a mapping of a raw block device within a container.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

name

name must match the name of a persistentVolumeClaim in the pod

true

string

devicePath

devicePath is the path inside of the container that the device will be mapped to.

true

string

+

v1.NodeSelectorRequirement

@@ -6341,6 +6451,47 @@

v1.SecretProjection

+
+
+

v1.PodDNSConfigOption

+
+

PodDNSConfigOption defines DNS resolver options of a pod.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

name

Required.

false

string

value

false

string

+

v1beta1.DaemonSet

@@ -7205,6 +7356,68 @@

v1.PreferredSchedulingTerm

+
+
+

v1beta1.DaemonSetCondition

+
+

DaemonSetCondition describes the state of a DaemonSet at a certain point.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

type

Type of DaemonSet condition.

true

string

status

Status of the condition, one of True, False, Unknown.

true

string

lastTransitionTime

Last time the condition transitioned from one status to another.

false

string

reason

The reason for the condition’s last transition.

false

string

message

A human readable message indicating details about the transition.

false

string

+

v1.ConfigMapKeySelector

diff --git a/content/en/docs/reference/federation/extensions/v1beta1/operations.html b/content/en/docs/reference/federation/extensions/v1beta1/operations.html index 26449a64e51d9..18187972174a3 100755 --- a/content/en/docs/reference/federation/extensions/v1beta1/operations.html +++ b/content/en/docs/reference/federation/extensions/v1beta1/operations.html @@ -1787,7 +1787,7 @@

Parameters

QueryParameter

propagationPolicy

-

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.

+

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.

false

string

@@ -3209,7 +3209,7 @@

Parameters

QueryParameter

propagationPolicy

-

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.

+

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.

false

string

@@ -5152,7 +5152,7 @@

Parameters

QueryParameter

propagationPolicy

-

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.

+

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.

false

string

@@ -6574,7 +6574,7 @@

Parameters

QueryParameter

propagationPolicy

-

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.

+

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.

false

string

diff --git a/content/en/docs/reference/federation/v1/definitions.html b/content/en/docs/reference/federation/v1/definitions.html index ca4e573991238..82a8434e7428f 100755 --- a/content/en/docs/reference/federation/v1/definitions.html +++ b/content/en/docs/reference/federation/v1/definitions.html @@ -1030,6 +1030,48 @@

v1.Event

string

+ +

eventTime

+

Time when this Event was first observed.

+

false

+

string

+ + + +

series

+

Data about the Event series this event represents or nil if it’s a singleton Event.

+

false

+

v1.EventSeries

+ + + +

action

+

What action was taken/failed regarding to the Regarding object.

+

false

+

string

+ + + +

related

+

Optional secondary object for more complex actions.

+

false

+

v1.ObjectReference

+ + + +

reportingComponent

+

Name of the controller that emitted this Event, e.g. kubernetes.io/kubelet.

+

true

+

string

+ + + +

reportingInstance

+

ID of the controller instance, e.g. kubelet-xyzf.

+

true

+

string

+ + @@ -1385,7 +1427,7 @@

v1.DeleteOptions

propagationPolicy

-

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.

+

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.

false

v1.DeletionPropagation

@@ -1393,6 +1435,54 @@

v1.DeleteOptions

+
+
+

v1.EventSeries

+
+

EventSeries contain information on series of events, i.e. thing that was/is happening continously for some time.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

count

Number of occurrences in this series up to the last heartbeat time

false

integer (int32)

lastObservedTime

Time of the last occurence observed

false

string

state

State of this Series: Ongoing or Finished

false

string

+

v1.StatusDetails

@@ -1509,7 +1599,14 @@

v1.ConfigMap

data

-

Data contains the configuration data. Each key must consist of alphanumeric characters, -, _ or ..

+

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.

+

false

+

object

+ + + +

binaryData

+

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.

false

object

@@ -1945,7 +2042,7 @@

v1.ObjectMeta

deletionTimestamp

-

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

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/api-conventions.md#metadata

false

@@ -2267,7 +2364,7 @@

v1.ServiceSpec

externalName

-

externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid DNS name and requires Type to be ExternalName.

+

externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires Type to be ExternalName.

false

string

diff --git a/content/en/docs/reference/federation/v1/operations.html b/content/en/docs/reference/federation/v1/operations.html index eef0937454868..98a18c2278e54 100755 --- a/content/en/docs/reference/federation/v1/operations.html +++ b/content/en/docs/reference/federation/v1/operations.html @@ -1908,7 +1908,7 @@

Parameters

QueryParameter

propagationPolicy

-

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.

+

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.

false

string

@@ -2946,7 +2946,7 @@

Parameters

QueryParameter

propagationPolicy

-

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.

+

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.

false

string

@@ -3984,7 +3984,7 @@

Parameters

QueryParameter

propagationPolicy

-

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.

+

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.

false

string

@@ -5022,7 +5022,7 @@

Parameters

QueryParameter

propagationPolicy

-

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.

+

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.

false

string

@@ -5941,7 +5941,7 @@

Parameters

QueryParameter

propagationPolicy

-

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.

+

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.

false

string

diff --git a/content/en/docs/reference/kubectl/conventions.md b/content/en/docs/reference/kubectl/conventions.md index fd328cf0b1558..70125b743a648 100644 --- a/content/en/docs/reference/kubectl/conventions.md +++ b/content/en/docs/reference/kubectl/conventions.md @@ -65,4 +65,4 @@ flag, which provides the object to be submitted to the cluster. ### `kubectl apply` -* When you use `kubectl apply` to update resources, always create resources initially using `kubectl create` or using `--save-config`. See [managing resources with kubectl apply](/docs/concepts/cluster-administration/manage-deployment/#kubectl-apply) for more information. +* You can use `kubectl apply` to create or update resources. However, to update a resource you should have created the resource by using `kubectl apply` or `kubectl create --save-config`. For more information about using kubectl apply to update resources, see [Managing Resources](/docs/concepts/cluster-administration/manage-deployment/#kubectl-apply). diff --git a/content/en/docs/reference/kubectl/kubectl.md b/content/en/docs/reference/kubectl/kubectl.md index dd968f8e3f95c..923ad9a84c3a6 100755 --- a/content/en/docs/reference/kubectl/kubectl.md +++ b/content/en/docs/reference/kubectl/kubectl.md @@ -2,6 +2,7 @@ title: kubectl notitle: true --- + ## kubectl kubectl controls the Kubernetes cluster manager @@ -36,13 +37,11 @@ kubectl [flags] --logtostderr log to standard error instead of files --match-server-version Require server version to match client version -n, --namespace string If present, the namespace scope for this CLI request - --password string Password for basic authentication to the API server --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0") -s, --server string The address and port of the Kubernetes API server --stderrthreshold severity logs at or above this threshold go to stderr (default 2) --token string Bearer token for authentication to the API server --user string The name of the kubeconfig user to use - --username string Username for basic authentication to the API server -v, --v Level log level for V logs --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging ``` @@ -51,6 +50,7 @@ kubectl [flags] * [kubectl alpha](kubectl_alpha.md) - Commands for features in alpha * [kubectl annotate](kubectl_annotate.md) - Update the annotations on a resource +* [kubectl api-resources](kubectl_api-resources.md) - Print the supported API resources on the server * [kubectl api-versions](kubectl_api-versions.md) - Print the supported API versions on the server, in the form of "group/version" * [kubectl apply](kubectl_apply.md) - Apply a configuration to a resource by filename or stdin * [kubectl attach](kubectl_attach.md) - Attach to a running container @@ -80,7 +80,6 @@ kubectl [flags] * [kubectl port-forward](kubectl_port-forward.md) - Forward one or more local ports to a pod * [kubectl proxy](kubectl_proxy.md) - Run a proxy to the Kubernetes API server * [kubectl replace](kubectl_replace.md) - Replace a resource by filename or stdin -* [kubectl rolling-update](kubectl_rolling-update.md) - Perform a rolling update of the given ReplicationController * [kubectl rollout](kubectl_rollout.md) - Manage the rollout of a resource * [kubectl run](kubectl_run.md) - Run a particular image on the cluster * [kubectl scale](kubectl_scale.md) - Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job @@ -89,5 +88,6 @@ kubectl [flags] * [kubectl top](kubectl_top.md) - Display Resource (CPU/Memory/Storage) usage. * [kubectl uncordon](kubectl_uncordon.md) - Mark node as schedulable * [kubectl version](kubectl_version.md) - Print the client and server version information +* [kubectl wait](kubectl_wait.md) - Experimental: Wait for one condition on one or many resources -###### Auto generated by spf13/cobra on 25-Mar-2018 +###### Auto generated by spf13/cobra on 16-Jun-2018 diff --git a/content/en/docs/reference/kubectl/overview.md b/content/en/docs/reference/kubectl/overview.md index d7207926700f5..dba8ea36a4e7c 100644 --- a/content/en/docs/reference/kubectl/overview.md +++ b/content/en/docs/reference/kubectl/overview.md @@ -161,7 +161,7 @@ Output format | Description In this example, the following command outputs the details for a single pod as a YAML formatted object: ```shell -$ kubectl get pod web-pod-13je7 -o=yaml` +$ kubectl get pod web-pod-13je7 -o=yaml ``` Remember: See the [kubectl](/docs/user-guide/kubectl/) reference documentation for details about which output format is supported by each command. @@ -203,15 +203,18 @@ submit-queue 610995 This means that for any given resource, the server will return columns and rows relevant to that resource, for the client to print. This allows for consistent human-readable output across clients used against the same cluster, by having the server encapsulate the details of printing. -To output object information using this feature, you can add the `--experimental-server-print` flag to a supported `kubectl` command. +This feature is enabled by default in `kubectl` 1.11 and higher. To disable it, add the +`--server-print=false` flag to the `kubectl get` command. ##### Examples +To print information about the status of a pod, use a command like the following: + ```shell -$ kubectl get pods --experimental-server-print +kubectl get pods --server-print=false ``` -The result of running this command is: +Output looks like this: ```shell NAME READY STATUS RESTARTS AGE diff --git a/content/en/docs/reference/kubernetes-api/index.md b/content/en/docs/reference/kubernetes-api/index.md index 3d693134b1361..8c2c6fab839b7 100644 --- a/content/en/docs/reference/kubernetes-api/index.md +++ b/content/en/docs/reference/kubernetes-api/index.md @@ -1,5 +1,5 @@ --- -title: v1.10 +title: v1.11 --- -[Kubernetes API v1.10](/docs/reference/generated/kubernetes-api/v1.10/) +[Kubernetes API v1.11](/docs/reference/generated/kubernetes-api/v1.11/) diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm.md index 4dfddf9c61c46..9c36cd372ecc9 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm.md @@ -39,7 +39,7 @@ Example usage: ### Options - +
@@ -50,7 +50,7 @@ Example usage: - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md index 63bcf58f03d63..def246a453795 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md @@ -8,7 +8,7 @@ Experimental sub-commands not yet fully functional. ### Options -
-h, --help
help for kubeadmhelp for kubeadm
+
@@ -19,7 +19,7 @@ Experimental sub-commands not yet fully functional. - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase.md index f72c52b0dc5cb..aa175471cac11 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase.md @@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options -
-h, --help
help for alphahelp for alpha
+
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon.md index f293951dbdee8..52689eee0cf6a 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon.md @@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options -
-h, --help
help for phasehelp for phase
+
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_all.md index c83bbda153256..29655fd8c65ba 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_all.md @@ -4,8 +4,7 @@ Installs all addons to a Kubernetes cluster ### Synopsis -Installs the kube-dns and the kube-proxys addons components via the API server. -Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed. +Installs the CoreDNS and the kube-proxys addons components via the API server. Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed. Alpha Disclaimer: this command is currently alpha. @@ -16,7 +15,7 @@ kubeadm alpha phase addon all [flags] ### Examples ``` - # Installs the kube-dns and the kube-proxys addons components via the API server, + # Installs the CoreDNS and the kube-proxys addons components via the API server, # functionally equivalent to what installed by kubeadm init. kubeadm alpha phase selfhosting from-staticpods @@ -24,7 +23,7 @@ kubeadm alpha phase addon all [flags] ### Options -
-h, --help
help for addonhelp for addon
+
@@ -35,77 +34,77 @@ kubeadm alpha phase addon all [flags] - + - + - + - + - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_coredns.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_coredns.md new file mode 100644 index 0000000000000..0c17c292f349c --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_coredns.md @@ -0,0 +1,84 @@ + +Installs the CoreDNS addon to a Kubernetes cluster + +### Synopsis + + +Installs the CoreDNS addon components via the API server. Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed. + +Alpha Disclaimer: this command is currently alpha. + +``` +kubeadm alpha phase addon coredns [flags] +``` + +### Options + +
--apiserver-advertise-address string
The IP address or DNS name the API server is accessible onThe IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible onThe port the API server is accessible on
--config string
Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental!Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental
--feature-gates string
A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)		A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for allhelp for all
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images fromChoose a container registry to pull control plane images from
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control planeChoose a specific Kubernetes version for the control plane
--pod-network-cidr string
The range of IP addresses used for the Pod networkThe range of IP addresses used for the Pod network
--service-cidr string     Default: "10.96.0.0/12"
The range of IP address used for service VIPsThe range of IP address used for service VIPs
--service-dns-domain string     Default: "cluster.local"
Alternative domain for servicesAlternative domain for services
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental
--feature-gates string
A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for coredns
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images from
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control plane
--service-cidr string     Default: "10.96.0.0/12"
The range of IP address used for service VIPs
--service-dns-domain string     Default: "cluster.local"
Alternative domain for services
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-proxy.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-proxy.md index 534834950bde3..40d91010cbe53 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-proxy.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-proxy.md @@ -14,7 +14,7 @@ kubeadm alpha phase addon kube-proxy [flags] ### Options - +
@@ -25,56 +25,56 @@ kubeadm alpha phase addon kube-proxy [flags] - + - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token.md index 8629089198185..491ef4d66c8a8 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token.md @@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options -
--apiserver-advertise-address string
The IP address or DNS name the API server is accessible onThe IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible onThe port the API server is accessible on
--config string
Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental!Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for kube-proxyhelp for kube-proxy
--image-repository string     Default: "k8s.gcr.io"
Choose a container registry to pull control plane images fromChoose a container registry to pull control plane images from
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control planeChoose a specific Kubernetes version for the control plane
--pod-network-cidr string
The range of IP addresses used for the Pod networkThe range of IP addresses used for the Pod network
+
@@ -19,14 +19,14 @@ This command is not meant to be run on its own. See list of available subcommand - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_all.md index a595bd4b98025..dd131e37d7ac9 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_all.md @@ -24,7 +24,7 @@ kubeadm alpha phase bootstrap-token all [flags] ### Options -
-h, --help
help for bootstrap-tokenhelp for bootstrap-token
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
+
@@ -35,56 +35,56 @@ kubeadm alpha phase bootstrap-token all [flags] - + - + - + - + - + - + - + - + - + - + @@ -94,7 +94,7 @@ kubeadm alpha phase bootstrap-token all [flags] ### Options inherited from parent commands -
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
--description string     Default: "The default bootstrap token generated by 'kubeadm init'."--description string
A human friendly description of how this token is used.A human friendly description of how this token is used.
--groups stringSlice     Default: [system:bootstrappers:kubeadm:default-node-token]
Extra groups that this token will authenticate as when used for authentication. Must match "system:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]"Extra groups that this token will authenticate as when used for authentication. Must match "\\Asystem:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]\\z"
-h, --help
help for allhelp for all
--skip-token-print
Skip printing of the bootstrap tokenSkip printing of the bootstrap token
--token string
The token to use for establishing bidirectional trust between nodes and mastersThe token to use for establishing bidirectional trust between nodes and masters. The format is [a-z0-9]{6}\.[a-z0-9]{16} - e.g. abcdef.0123456789abcdef
--ttl duration     Default: 24h0m0s--token-ttl duration     Default: 24h0m0s
The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expireThe duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire
--usages stringSlice     Default: [signing,authentication]
Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication]Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication]
+
@@ -105,7 +105,7 @@ kubeadm alpha phase bootstrap-token all [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_cluster-info.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_cluster-info.md index f8ad6866e3c7f..9e812e091641f 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_cluster-info.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_cluster-info.md @@ -16,7 +16,7 @@ kubeadm alpha phase bootstrap-token cluster-info [flags] ### Options -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
+
@@ -27,7 +27,7 @@ kubeadm alpha phase bootstrap-token cluster-info [flags] - + @@ -37,7 +37,7 @@ kubeadm alpha phase bootstrap-token cluster-info [flags] ### Options inherited from parent commands -
-h, --help
help for cluster-infohelp for cluster-info
+
@@ -48,7 +48,7 @@ kubeadm alpha phase bootstrap-token cluster-info [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_create.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_create.md index 7515ef09ed24d..d1cdf5d181ec1 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_create.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_create.md @@ -16,7 +16,7 @@ kubeadm alpha phase bootstrap-token create [flags] ### Options -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
+
@@ -27,56 +27,56 @@ kubeadm alpha phase bootstrap-token create [flags] - + - + - + - + - + - + - + - + - + - + @@ -86,7 +86,7 @@ kubeadm alpha phase bootstrap-token create [flags] ### Options inherited from parent commands -
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
--description string     Default: "The default bootstrap token generated by 'kubeadm init'."--description string
A human friendly description of how this token is used.A human friendly description of how this token is used.
--groups stringSlice     Default: [system:bootstrappers:kubeadm:default-node-token]
Extra groups that this token will authenticate as when used for authentication. Must match "system:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]"Extra groups that this token will authenticate as when used for authentication. Must match "\\Asystem:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]\\z"
-h, --help
help for createhelp for create
--skip-token-print
Skip printing of the bootstrap tokenSkip printing of the bootstrap token
--token string
The token to use for establishing bidirectional trust between nodes and mastersThe token to use for establishing bidirectional trust between nodes and masters. The format is [a-z0-9]{6}\.[a-z0-9]{16} - e.g. abcdef.0123456789abcdef
--ttl duration     Default: 24h0m0s--token-ttl duration     Default: 24h0m0s
The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expireThe duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire
--usages stringSlice     Default: [signing,authentication]
Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication]Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication]
+
@@ -97,7 +97,7 @@ kubeadm alpha phase bootstrap-token create [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node.md index 0ec18d7eac731..2128d7c290d88 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node.md @@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
+
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand - + @@ -29,7 +29,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options inherited from parent commands -
-h, --help
help for nodehelp for node
+
@@ -40,7 +40,7 @@ This command is not meant to be run on its own. See list of available subcommand - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-auto-approve.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-auto-approve.md index dcbd443e3e095..1d04250869bfd 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-auto-approve.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-auto-approve.md @@ -16,7 +16,7 @@ kubeadm alpha phase bootstrap-token node allow-auto-approve [flags] ### Options -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
+
@@ -27,7 +27,7 @@ kubeadm alpha phase bootstrap-token node allow-auto-approve [flags] - + @@ -37,7 +37,7 @@ kubeadm alpha phase bootstrap-token node allow-auto-approve [flags] ### Options inherited from parent commands -
-h, --help
help for allow-auto-approvehelp for allow-auto-approve
+
@@ -48,7 +48,7 @@ kubeadm alpha phase bootstrap-token node allow-auto-approve [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-post-csrs.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-post-csrs.md index 7fa3f3043b9b6..713644e273b63 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-post-csrs.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-post-csrs.md @@ -16,7 +16,7 @@ kubeadm alpha phase bootstrap-token node allow-post-csrs [flags] ### Options -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
+
@@ -27,7 +27,7 @@ kubeadm alpha phase bootstrap-token node allow-post-csrs [flags] - + @@ -37,7 +37,7 @@ kubeadm alpha phase bootstrap-token node allow-post-csrs [flags] ### Options inherited from parent commands -
-h, --help
help for allow-post-csrshelp for allow-post-csrs
+
@@ -48,7 +48,7 @@ kubeadm alpha phase bootstrap-token node allow-post-csrs [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs.md index e780478c151f0..d7ce2c46a039d 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs.md @@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
+
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_all.md index b9eb8eb92eea8..f40cf7c0544fb 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_all.md @@ -28,7 +28,7 @@ kubeadm alpha phase certs all [flags] ### Options -
-h, --help
help for certshelp for certs
+
@@ -39,49 +39,49 @@ kubeadm alpha phase certs all [flags] - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-etcd-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-etcd-client.md index 9968b1e83357f..0f93b4f2f6fe3 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-etcd-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-etcd-client.md @@ -16,7 +16,7 @@ kubeadm alpha phase certs apiserver-etcd-client [flags] ### Options -
--apiserver-advertise-address string
The IP address the API server is accessible on, to use for the API server serving certThe IP address the API server is accessible on, to use for the API server serving cert
--apiserver-cert-extra-sans stringSlice
Optional extra altnames to use for the API server serving cert. Can be both IP addresses and dns namesOptional extra altnames to use for the API server serving cert. Can be both IP addresses and DNS names
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for allhelp for all
--service-cidr string     Default: "10.96.0.0/12"
Alternative range of IP address for service VIPs, from which derives the internal API server VIP that will be added to the API Server serving certAlternative range of IP address for service VIPs, from which derives the internal API server VIP that will be added to the API Server serving cert
--service-dns-domain string     Default: "cluster.local"
Alternative domain for services, to use for the API server serving certAlternative domain for services, to use for the API server serving cert
+
@@ -27,21 +27,21 @@ kubeadm alpha phase certs apiserver-etcd-client [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-kubelet-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-kubelet-client.md index af8d9cb7ae7e8..9772c823785c7 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-kubelet-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-kubelet-client.md @@ -16,7 +16,7 @@ kubeadm alpha phase certs apiserver-kubelet-client [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for apiserver-etcd-clienthelp for apiserver-etcd-client
+
@@ -27,21 +27,21 @@ kubeadm alpha phase certs apiserver-kubelet-client [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver.md index a4c6b1d03a622..6fa23650d3603 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver.md @@ -18,7 +18,7 @@ kubeadm alpha phase certs apiserver [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for apiserver-kubelet-clienthelp for apiserver-kubelet-client
+
@@ -29,49 +29,49 @@ kubeadm alpha phase certs apiserver [flags] - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_ca.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_ca.md index 840a79833585b..2d13b77835581 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_ca.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_ca.md @@ -16,7 +16,7 @@ kubeadm alpha phase certs ca [flags] ### Options -
--apiserver-advertise-address string
The IP address the API server is accessible on, to use for the API server serving certThe IP address the API server is accessible on, to use for the API server serving cert
--apiserver-cert-extra-sans stringSlice
Optional extra altnames to use for the API server serving cert. Can be both IP addresses and dns namesOptional extra altnames to use for the API server serving cert. Can be both IP addresses and DNS names
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for apiserverhelp for apiserver
--service-cidr string     Default: "10.96.0.0/12"
Alternative range of IP address for service VIPs, from which derives the internal API server VIP that will be added to the API Server serving certAlternative range of IP address for service VIPs, from which derives the internal API server VIP that will be added to the API Server serving cert
--service-dns-domain string     Default: "cluster.local"
Alternative domain for services, to use for the API server serving certAlternative domain for services, to use for the API server serving cert
+
@@ -27,21 +27,21 @@ kubeadm alpha phase certs ca [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-ca.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-ca.md index d3e04a46ac67f..23ccb50b8a613 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-ca.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-ca.md @@ -16,7 +16,7 @@ kubeadm alpha phase certs etcd-ca [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for cahelp for ca
+
@@ -27,21 +27,21 @@ kubeadm alpha phase certs etcd-ca [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-healthcheck-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-healthcheck-client.md index ecc45cc06b376..fa0abd61cc9cb 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-healthcheck-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-healthcheck-client.md @@ -16,7 +16,7 @@ kubeadm alpha phase certs etcd-healthcheck-client [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for etcd-cahelp for etcd-ca
+
@@ -27,21 +27,21 @@ kubeadm alpha phase certs etcd-healthcheck-client [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-peer.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-peer.md index 54942af8ec24f..6a02d7f21ff43 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-peer.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-peer.md @@ -18,7 +18,7 @@ kubeadm alpha phase certs etcd-peer [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for etcd-healthcheck-clienthelp for etcd-healthcheck-client
+
@@ -29,21 +29,21 @@ kubeadm alpha phase certs etcd-peer [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-server.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-server.md index 704b0aecc92f1..9c7d9d95c5d0d 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-server.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-server.md @@ -18,7 +18,7 @@ kubeadm alpha phase certs etcd-server [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for etcd-peerhelp for etcd-peer
+
@@ -29,21 +29,21 @@ kubeadm alpha phase certs etcd-server [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-ca.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-ca.md index 89d58039d6c99..3eed51d2acd3c 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-ca.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-ca.md @@ -16,7 +16,7 @@ kubeadm alpha phase certs front-proxy-ca [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for etcd-serverhelp for etcd-server
+
@@ -27,21 +27,21 @@ kubeadm alpha phase certs front-proxy-ca [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-client.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-client.md index ace2d64d1d62a..072d83dfdd11c 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-client.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-client.md @@ -16,7 +16,7 @@ kubeadm alpha phase certs front-proxy-client [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for front-proxy-cahelp for front-proxy-ca
+
@@ -27,21 +27,21 @@ kubeadm alpha phase certs front-proxy-client [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_sa.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_sa.md index 15eda50f3c01c..5d56ec7b5c276 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_sa.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_sa.md @@ -16,7 +16,7 @@ kubeadm alpha phase certs sa [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for front-proxy-clienthelp for front-proxy-client
+
@@ -27,21 +27,21 @@ kubeadm alpha phase certs sa [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane.md index 9cd09759d59b8..a14adfcf4444c 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane.md @@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save the certificatesThe path where to save the certificates
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for sahelp for sa
+
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_all.md index d2fd4bc44a037..0a15bced4bdf2 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_all.md @@ -25,7 +25,7 @@ kubeadm alpha phase controlplane all [flags] ### Options -
-h, --help
help for controlplanehelp for controlplane
+
@@ -36,84 +36,84 @@ kubeadm alpha phase controlplane all [flags] - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_apiserver.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_apiserver.md index 8a8d758b89550..3939b997f4476 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_apiserver.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_apiserver.md @@ -1,5 +1,5 @@ -Generates the API server static Pod manifest. +Generates the API server static Pod manifest ### Synopsis @@ -14,7 +14,7 @@ kubeadm alpha phase controlplane apiserver [flags] ### Options -
--apiserver-advertise-address string
The IP address of the API server is accessible onThe IP address of the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible onThe port the API server is accessible on
--apiserver-extra-args mapStringString
A set of extra flags to pass to the API Server or override default ones in form of <flagname>=<value>A set of extra flags to pass to the API Server or override default ones in form of <flagname>=<value>
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
--controller-manager-extra-args mapStringString
A set of extra flags to pass to the Controller Manager or override default ones in form of <flagname>=<value>A set of extra flags to pass to the Controller Manager or override default ones in form of <flagname>=<value>
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)		A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for allhelp for all
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control planeChoose a specific Kubernetes version for the control plane
--pod-network-cidr string
The range of IP addresses used for the Pod networkThe range of IP addresses used for the Pod network
--scheduler-extra-args mapStringString
A set of extra flags to pass to the Scheduler or override default ones in form of <flagname>=<value>A set of extra flags to pass to the Scheduler or override default ones in form of <flagname>=<value>
--service-cidr string     Default: "10.96.0.0/12"
The range of IP address used for service VIPsThe range of IP address used for service VIPs
+
@@ -25,63 +25,63 @@ kubeadm alpha phase controlplane apiserver [flags] - + - + - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_controller-manager.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_controller-manager.md index 85bee3294684c..004692b024d38 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_controller-manager.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_controller-manager.md @@ -1,5 +1,5 @@ -Generates the controller-manager static Pod manifest. +Generates the controller-manager static Pod manifest ### Synopsis @@ -14,7 +14,7 @@ kubeadm alpha phase controlplane controller-manager [flags] ### Options -
--apiserver-advertise-address string
The IP address of the API server is accessible onThe IP address of the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible onThe port the API server is accessible on
--apiserver-extra-args mapStringString
A set of extra flags to pass to the API Server or override default ones in form of <flagname>=<value>A set of extra flags to pass to the API Server or override default ones in form of <flagname>=<value>
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)		A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for apiserverhelp for apiserver
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control planeChoose a specific Kubernetes version for the control plane
--service-cidr string     Default: "10.96.0.0/12"
The range of IP address used for service VIPsThe range of IP address used for service VIPs
+
@@ -25,42 +25,42 @@ kubeadm alpha phase controlplane controller-manager [flags] - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_scheduler.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_scheduler.md index 8c6d1daca6339..d8bab2226e510 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_scheduler.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_scheduler.md @@ -1,5 +1,5 @@ -Generates the scheduler static Pod manifest. +Generates the scheduler static Pod manifest ### Synopsis @@ -14,7 +14,7 @@ kubeadm alpha phase controlplane scheduler [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
--controller-manager-extra-args mapStringString
A set of extra flags to pass to the Controller Manager or override default ones in form of <flagname>=<value>A set of extra flags to pass to the Controller Manager or override default ones in form of <flagname>=<value>
-h, --help
help for controller-managerhelp for controller-manager
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control planeChoose a specific Kubernetes version for the control plane
--pod-network-cidr string
The range of IP addresses used for the Pod networkThe range of IP addresses used for the Pod network
+
@@ -25,35 +25,35 @@ kubeadm alpha phase controlplane scheduler [flags] - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd.md index 85cada5d43dc5..285144797f46d 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd.md @@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for schedulerhelp for scheduler
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control planeChoose a specific Kubernetes version for the control plane
--scheduler-extra-args mapStringString
A set of extra flags to pass to the Scheduler or override default ones in form of <flagname>=<value>A set of extra flags to pass to the Scheduler or override default ones in form of <flagname>=<value>
+
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd_local.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd_local.md index 9b99b855c89a8..d3ca8e253a051 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd_local.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd_local.md @@ -25,7 +25,7 @@ kubeadm alpha phase etcd local [flags] ### Options -
-h, --help
help for etcdhelp for etcd
+
@@ -36,21 +36,21 @@ kubeadm alpha phase etcd local [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig.md index 9357bae592467..1c7c61dd0c984 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig.md @@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for localhelp for local
+
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_admin.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_admin.md index b3b0e8c28d666..4ed4e00b13647 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_admin.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_admin.md @@ -14,7 +14,7 @@ kubeadm alpha phase kubeconfig admin [flags] ### Options -
-h, --help
help for kubeconfighelp for kubeconfig
+
@@ -25,42 +25,42 @@ kubeadm alpha phase kubeconfig admin [flags] - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_all.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_all.md index cd72365ae534c..fa98914fbcdd2 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_all.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_all.md @@ -25,7 +25,7 @@ kubeadm alpha phase kubeconfig all [flags] ### Options -
--apiserver-advertise-address string
The IP address the API server is accessible onThe IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible onThe port the API server is accessible on
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for adminhelp for admin
--kubeconfig-dir string     Default: "/etc/kubernetes"
The port where to save the kubeconfig fileThe path where to save the kubeconfig file
+
@@ -36,49 +36,49 @@ kubeadm alpha phase kubeconfig all [flags] - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_controller-manager.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_controller-manager.md index 87a07d1bd579e..6cae50ba82fe0 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_controller-manager.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_controller-manager.md @@ -14,7 +14,7 @@ kubeadm alpha phase kubeconfig controller-manager [flags] ### Options -
--apiserver-advertise-address string
The IP address the API server is accessible onThe IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible onThe port the API server is accessible on
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for allhelp for all
--kubeconfig-dir string     Default: "/etc/kubernetes"
The port where to save the kubeconfig fileThe path where to save the kubeconfig file
--node-name string
The node name that should be used for the kubelet client certificateThe node name that should be used for the kubelet client certificate
+
@@ -25,42 +25,42 @@ kubeadm alpha phase kubeconfig controller-manager [flags] - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_kubelet.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_kubelet.md index 5d5129756c194..9eaa2c3521ab6 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_kubelet.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_kubelet.md @@ -1,5 +1,5 @@ -Generates a kubeconfig file for the kubelet to use. Please note that this should be used *only* for bootstrapping purposes. +Generates a kubeconfig file for the kubelet to use. Please note that this should be used *only* for bootstrapping purposes ### Synopsis @@ -16,7 +16,7 @@ kubeadm alpha phase kubeconfig kubelet [flags] ### Options -
--apiserver-advertise-address string
The IP address the API server is accessible onThe IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible onThe port the API server is accessible on
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for controller-managerhelp for controller-manager
--kubeconfig-dir string     Default: "/etc/kubernetes"
The port where to save the kubeconfig fileThe path where to save the kubeconfig file
+
@@ -27,49 +27,49 @@ kubeadm alpha phase kubeconfig kubelet [flags] - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_scheduler.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_scheduler.md index 5a5551d8914df..b98f615b0bc9e 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_scheduler.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_scheduler.md @@ -14,7 +14,7 @@ kubeadm alpha phase kubeconfig scheduler [flags] ### Options -
--apiserver-advertise-address string
The IP address the API server is accessible onThe IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible onThe port the API server is accessible on
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for kubelethelp for kubelet
--kubeconfig-dir string     Default: "/etc/kubernetes"
The port where to save the kubeconfig fileThe path where to save the kubeconfig file
--node-name string
The node name that should be used for the kubelet client certificateThe node name that should be used for the kubelet client certificate
+
@@ -25,42 +25,42 @@ kubeadm alpha phase kubeconfig scheduler [flags] - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_user.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_user.md index 0813ad24ea327..b2f43935eb484 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_user.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_user.md @@ -21,7 +21,7 @@ kubeadm alpha phase kubeconfig user [flags] ### Options -
--apiserver-advertise-address string
The IP address the API server is accessible onThe IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible onThe port the API server is accessible on
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for schedulerhelp for scheduler
--kubeconfig-dir string     Default: "/etc/kubernetes"
The port where to save the kubeconfig fileThe path where to save the kubeconfig file
+
@@ -32,49 +32,56 @@ kubeadm alpha phase kubeconfig user [flags] - + - + - + - + - + - + + + + + + + + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet.md new file mode 100644 index 0000000000000..726a98890c565 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet.md @@ -0,0 +1,29 @@ + +Commands related to handling the kubelet. + +### Synopsis + + +This command is not meant to be run on its own. See list of available subcommands. + +### Options + +
--apiserver-advertise-address string
The IP address the API server is accessible onThe IP address the API server is accessible on
--apiserver-bind-port int32     Default: 6443
The port the API server is accessible onThe port the API server is accessible on
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--client-name string
The name of user. It will be used as the CN if client certificates are createdThe name of user. It will be used as the CN if client certificates are created
-h, --help
help for userhelp for user
--kubeconfig-dir string     Default: "/etc/kubernetes"
The port where to save the kubeconfig fileThe path where to save the kubeconfig file
--org stringSlice
The orgnizations of the client certificate. It will be used as the O if client certificates are created
--token string
The token that should be used as the authentication mechanism for this kubeconfig (instead of client certificates)The token that should be used as the authentication mechanism for this kubeconfig, instead of client certificates
+ + + + + + + + + + + + + + +
-h, --help
help for kubelet
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config.md new file mode 100644 index 0000000000000..8f2958f6076b9 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config.md @@ -0,0 +1,29 @@ + +Handles kubelet configuration. + +### Synopsis + + +This command is not meant to be run on its own. See list of available subcommands. + +### Options + + + + + + + + + + + + + + + + +
-h, --help
help for config
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_download.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_download.md new file mode 100644 index 0000000000000..d8b3b3cd5f802 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_download.md @@ -0,0 +1,59 @@ + +Downloads the kubelet configuration from the cluster ConfigMap kubelet-config-1.X, where X is the minor version of the kubelet. + +### Synopsis + + +Downloads the kubelet configuration from a ConfigMap of the form "kubelet-config-1.X" in the cluster, where X is the minor version of the kubelet. Either kubeadm autodetects the kubelet version by exec-ing "kubelet --version" or respects the --kubelet-version parameter. + +Alpha Disclaimer: this command is currently alpha. + +``` +kubeadm alpha phase kubelet config download [flags] +``` + +### Examples + +``` + # Downloads the kubelet configuration from the ConfigMap in the cluster. Autodetects the kubelet version. + kubeadm alpha phase kubelet config download + + # Downloads the kubelet configuration from the ConfigMap in the cluster. Uses a specific desired kubelet version. + kubeadm alpha phase kubelet config download --kubelet-version v1.11.0 +``` + +### Options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
-h, --help
help for download
--kubeconfig string     Default: "/etc/kubernetes/kubelet.conf"
The KubeConfig file to use when talking to the cluster
--kubelet-version string
The desired version for the kubelet. Defaults to being autodetected from 'kubelet --version'.
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_enable-dynamic.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_enable-dynamic.md new file mode 100644 index 0000000000000..56d653b7fbcf8 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_enable-dynamic.md @@ -0,0 +1,68 @@ + +EXPERIMENTAL: Enables or updates dynamic kubelet configuration for a Node + +### Synopsis + + +Enables or updates dynamic kubelet configuration for a Node, against the kubelet-config-1.X ConfigMap in the cluster, where X is the minor version of the desired kubelet version. + +WARNING: This feature is still experimental, and disabled by default. Enable only if you know what you are doing, as it may have surprising side-effects at this stage. + +Alpha Disclaimer: this command is currently alpha. + +``` +kubeadm alpha phase kubelet config enable-dynamic [flags] +``` + +### Examples + +``` + # Enables dynamic kubelet configuration for a Node. + kubeadm alpha phase kubelet enable-dynamic-config --node-name node-1 --kubelet-version v1.11.0 + + WARNING: This feature is still experimental, and disabled by default. Enable only if you know what you are doing, as it + may have surprising side-effects at this stage. +``` + +### Options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
-h, --help
help for enable-dynamic
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
--kubelet-version string
The desired version for the kubelet
--node-name string
Name of the node that should enable the dynamic kubelet configuration
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_upload.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_upload.md new file mode 100644 index 0000000000000..eb56fe1d031e8 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_upload.md @@ -0,0 +1,56 @@ + +Uploads kubelet configuration to a ConfigMap based on a kubeadm MasterConfiguration file. + +### Synopsis + + +Uploads kubelet configuration extracted from the kubeadm MasterConfiguration object to a ConfigMap of the form kubelet-config-1.X in the cluster, where X is the minor version of the current (API Server) Kubernetes version. + +Alpha Disclaimer: this command is currently alpha. + +``` +kubeadm alpha phase kubelet config upload [flags] +``` + +### Examples + +``` + # Uploads the kubelet configuration from the kubeadm Config file to a ConfigMap in the cluster. + kubeadm alpha phase kubelet config upload --config kubeadm.yaml +``` + +### Options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for upload
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_write-to-disk.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_write-to-disk.md new file mode 100644 index 0000000000000..09bcad8394920 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_config_write-to-disk.md @@ -0,0 +1,49 @@ + +Writes kubelet configuration to disk, either based on the --config argument. + +### Synopsis + + +Writes kubelet configuration to disk, based on the kubeadm configuration passed via "--config". + +Alpha Disclaimer: this command is currently alpha. + +``` +kubeadm alpha phase kubelet config write-to-disk [flags] +``` + +### Examples + +``` + # Extracts the kubelet configuration from a kubeadm configuration file + kubeadm alpha phase kubelet config write-to-disk --config kubeadm.yaml +``` + +### Options + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for write-to-disk
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_write-env-file.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_write-env-file.md new file mode 100644 index 0000000000000..7dc61eabb92a1 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubelet_write-env-file.md @@ -0,0 +1,52 @@ + +Writes an environment file with runtime flags for the kubelet. + +### Synopsis + + +Writes an environment file with flags that should be passed to the kubelet executing on the master or node. This --config flag can either consume a MasterConfiguration object or a NodeConfiguration one, as this function is used for both "kubeadm init" and "kubeadm join". + +Alpha Disclaimer: this command is currently alpha. + +``` +kubeadm alpha phase kubelet write-env-file [flags] +``` + +### Examples + +``` + # Writes a dynamic environment file with kubelet flags from a MasterConfiguration file. + kubeadm alpha phase kubelet write-env-file --config masterconfig.yaml + + # Writes a dynamic environment file with kubelet flags from a NodeConfiguration file. + kubeadm alpha phase kubelet write-env-file --config nodeConfig.yaml +``` + +### Options + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
-h, --help
help for write-env-file
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_mark-master.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_mark-master.md index f1df1a88c6019..9c456dd4838f9 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_mark-master.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_mark-master.md @@ -24,7 +24,7 @@ kubeadm alpha phase mark-master [flags] ### Options - +
@@ -35,28 +35,28 @@ kubeadm alpha phase mark-master [flags] - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight.md index 5156b96fd9341..b47c3938c345e 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight.md @@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options -
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for mark-masterhelp for mark-master
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
--node-name string
The node name to which label and taints should applyThe node name to which label and taints should apply
+
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_master.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_master.md index b42b1bc7c23da..2a84b5a9c30f6 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_master.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_master.md @@ -21,7 +21,7 @@ kubeadm alpha phase preflight master [flags] ### Options -
-h, --help
help for preflighthelp for preflight
+
@@ -32,7 +32,7 @@ kubeadm alpha phase preflight master [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_node.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_node.md index 34a2ee987322d..973c743a4c6ba 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_node.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_node.md @@ -21,7 +21,7 @@ kubeadm alpha phase preflight node [flags] ### Options -
-h, --help
help for masterhelp for master
+
@@ -32,7 +32,7 @@ kubeadm alpha phase preflight node [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting.md index 1815a4afa1a70..85f87530d2062 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting.md @@ -8,7 +8,7 @@ This command is not meant to be run on its own. See list of available subcommand ### Options -
-h, --help
help for nodehelp for node
+
@@ -19,7 +19,7 @@ This command is not meant to be run on its own. See list of available subcommand - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting_convert-from-staticpods.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting_convert-from-staticpods.md index 548f4a3a42392..76e16d03e07ec 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting_convert-from-staticpods.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting_convert-from-staticpods.md @@ -26,7 +26,7 @@ kubeadm alpha phase selfhosting convert-from-staticpods [flags] ### Options -
-h, --help
help for selfhostinghelp for selfhosting
+
@@ -37,35 +37,35 @@ kubeadm alpha phase selfhosting convert-from-staticpods [flags] - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_upload-config.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_upload-config.md index 8ba97c89140d7..c9b013f9346b8 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_upload-config.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_upload-config.md @@ -23,7 +23,7 @@ kubeadm alpha phase upload-config [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where certificates are storedThe path where certificates are stored
--config string
Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental!Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)		A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for convert-from-staticpodshelp for convert-from-staticpods
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
+
@@ -34,21 +34,21 @@ kubeadm alpha phase upload-config [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md index 392a006cc610e..301a76999bd56 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md @@ -10,16 +10,17 @@ The shell code must be evaluated to provide interactive completion of kubeadm commands. This can be done by sourcing it from the .bash_profile. -Note: this requires the bash-completion framework, which is not installed -by default on Mac. This can be installed by using homebrew: +Note: this requires the bash-completion framework. +To install it on Mac use homebrew: $ brew install bash-completion - Once installed, bash_completion must be evaluated. This can be done by adding the following line to the .bash_profile - $ source $(brew --prefix)/etc/bash_completion +If bash-completion is not installed on Linux, please install the 'bash-completion' package +via your distribution's package manager. + Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2 ``` @@ -49,7 +50,7 @@ source <(kubeadm completion zsh) ### Options -
--config string
Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental!Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental
-h, --help
help for upload-confighelp for upload-config
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster
+
@@ -60,7 +61,7 @@ source <(kubeadm completion zsh) - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md index 97a7460d28f69..54a478a8eaa71 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md @@ -17,7 +17,7 @@ kubeadm config [flags] ### Options -
-h, --help
help for completionhelp for completion
+
@@ -28,14 +28,14 @@ kubeadm config [flags] - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images.md new file mode 100644 index 0000000000000..85f978a88e0ee --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images.md @@ -0,0 +1,54 @@ + +Interact with container images used by kubeadm. + +### Synopsis + + +Interact with container images used by kubeadm. + +``` +kubeadm config images [flags] +``` + +### Options + +
-h, --help
help for confighelp for config
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.The KubeConfig file to use when talking to the cluster.
+ + + + + + + + + + + + + + +
-h, --help
help for images
+ + + +### Options inherited from parent commands + + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_list.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_list.md new file mode 100644 index 0000000000000..ca2a2119b5bbd --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_list.md @@ -0,0 +1,75 @@ + +Print a list of images kubeadm will use. The configuration file is used in case any images or image repositories are customized. + +### Synopsis + + +Print a list of images kubeadm will use. The configuration file is used in case any images or image repositories are customized. + +``` +kubeadm config images list [flags] +``` + +### Options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to kubeadm config file.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for list
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control plane.
+ + + +### Options inherited from parent commands + + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_pull.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_pull.md new file mode 100644 index 0000000000000..d5efa5ab05627 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_images_pull.md @@ -0,0 +1,82 @@ + +Pull images used by kubeadm. + +### Synopsis + + +Pull images used by kubeadm. + +``` +kubeadm config images pull [flags] +``` + +### Options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--config string
Path to kubeadm config file.
--cri-socket-path string     Default: "/var/run/dockershim.sock"
Path to the CRI socket.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for pull
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control plane.
+ + + +### Options inherited from parent commands + + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_migrate.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_migrate.md new file mode 100644 index 0000000000000..2a41580170881 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_migrate.md @@ -0,0 +1,82 @@ + +Read an older version of the kubeadm configuration API types from a file, and output the similar config object for the newer version. + +### Synopsis + + + +This command lets you convert configuration objects of older versions to the latest supported version, +locally in the CLI tool without ever touching anything in the cluster. +In this version of kubeadm, the following API versions are supported: +- kubeadm.k8s.io/v1alpha2 +- kubeadm.k8s.io/v1alpha1 + +Further, kubeadm can only write out config of version "kubeadm.k8s.io/v1alpha2", but read both types. +So regardless of what version you pass to the --old-config parameter here, the API object will be +read, deserialized, defaulted, converted, validated, and re-serialized when written to stdout or +--new-config if specified. + +In other words, the output of this command is what kubeadm actually would read internally if you +submitted this file to "kubeadm init" + + +``` +kubeadm config migrate [flags] +``` + +### Options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
-h, --help
help for migrate
--new-config string
Path to the resulting equivalent kubeadm config file using the new API version. Optional, if not specified output will be sent to STDOUT.
--old-config string
Path to the kubeadm config file that is using an old API version and should be converted. This flag is mandatory.
+ + + +### Options inherited from parent commands + + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print-default.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print-default.md new file mode 100644 index 0000000000000..3e011d9743d7b --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_print-default.md @@ -0,0 +1,67 @@ + +Print the default values for a kubeadm configuration object. + +### Synopsis + + + +This command prints the default MasterConfiguration object that is used for 'kubeadm init' and 'kubeadm upgrade', +and the default NodeConfiguration object that is used for 'kubeadm join'. + +Note that sensitive values like the Bootstrap Token fields are replaced with silly values like {"abcdef.0123456789abcdef" "" "nil" [] []} in order to pass validation but +not perform the real computation for creating a token. + + +``` +kubeadm config print-default [flags] +``` + +### Options + + + + + + + + + + + + + + + + + + + + + + + +
--api-objects stringSlice
A comma-separated list for API objects to print the default values for. Available values: [MasterConfiguration NodeConfiguration]. This flag unset means 'print all known objects'
-h, --help
help for print-default
+ + + +### Options inherited from parent commands + + + + + + + + + + + + + + + + +
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload.md index 6b349c6033857..e20d2ca0c720a 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload.md @@ -12,7 +12,7 @@ kubeadm config upload [flags] ### Options - +
@@ -23,7 +23,7 @@ kubeadm config upload [flags] - + @@ -33,7 +33,7 @@ kubeadm config upload [flags] ### Options inherited from parent commands -
-h, --help
help for uploadhelp for upload
+
@@ -44,7 +44,7 @@ kubeadm config upload [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-file.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-file.md index ce9ecef53b678..aa2905e2c1a98 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-file.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-file.md @@ -18,7 +18,7 @@ kubeadm config upload from-file [flags] ### Options -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.The KubeConfig file to use when talking to the cluster.
+
@@ -29,14 +29,14 @@ kubeadm config upload from-file [flags] - + - + @@ -46,7 +46,7 @@ kubeadm config upload from-file [flags] ### Options inherited from parent commands -
--config string
Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental.Path to a kubeadm config file. WARNING: Usage of a configuration file is experimental.
-h, --help
help for from-filehelp for from-file
+
@@ -57,7 +57,7 @@ kubeadm config upload from-file [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-flags.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-flags.md index abae4d531686f..faf57f341f74c 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-flags.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-flags.md @@ -18,7 +18,7 @@ kubeadm config upload from-flags [flags] ### Options -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.The KubeConfig file to use when talking to the cluster.
+
@@ -29,98 +29,84 @@ kubeadm config upload from-flags [flags] - + - + - + - + - + - + - + - + - + - + - + - - - - - - - - - - - - - - - + @@ -130,7 +116,7 @@ kubeadm config upload from-flags [flags] ### Options inherited from parent commands -
--apiserver-advertise-address string
The IP address the API Server will advertise it's listening on. Specify '0.0.0.0' to use the address of the default network interface.The IP address the API Server will advertise it's listening on. Specify '0.0.0.0' to use the address of the default network interface.
--apiserver-bind-port int32     Default: 6443
Port for the API Server to bind to.Port for the API Server to bind to.
--apiserver-cert-extra-sans stringSlice
Optional extra Subject Alternative Names (SANs) to use for the API Server serving certificate. Can be both IP addresses and DNS names.Optional extra Subject Alternative Names (SANs) to use for the API Server serving certificate. Can be both IP addresses and DNS names.
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.The path where to save and store the certificates.
--cri-socket string     Default: "/var/run/dockershim.sock"
Specify the CRI socket to connect to.Specify the CRI socket to connect to.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)		A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for from-flagshelp for from-flags
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control plane.Choose a specific Kubernetes version for the control plane.
--node-name string
Specify the node name.Specify the node name.
--pod-network-cidr string
Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node.Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node.
--service-cidr string     Default: "10.96.0.0/12"
Use alternative range of IP address for service VIPs.Use alternative range of IP address for service VIPs.
--service-dns-domain string     Default: "cluster.local"
Use alternative domain for services, e.g. "myorg.internal".
--token string
The token to use for establishing bidirectional trust between nodes and masters.
--token-ttl duration     Default: 24h0m0s
The duration before the bootstrap token is automatically deleted. If set to '0', the token will never expire.Use alternative domain for services, e.g. "myorg.internal".
+
@@ -141,7 +127,7 @@ kubeadm config upload from-flags [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md index a2ded40f2de10..9869d43c8d131 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md @@ -16,7 +16,7 @@ kubeadm config view [flags] ### Options -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.The KubeConfig file to use when talking to the cluster.
+
@@ -27,7 +27,7 @@ kubeadm config view [flags] - + @@ -37,7 +37,7 @@ kubeadm config view [flags] ### Options inherited from parent commands -
-h, --help
help for viewhelp for view
+
@@ -48,7 +48,7 @@ kubeadm config view [flags] - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md index d9139f947e91b..b846cf903473d 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md @@ -12,7 +12,7 @@ kubeadm init [flags] ### Options -
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.The KubeConfig file to use when talking to the cluster.
+
@@ -23,126 +23,126 @@ kubeadm init [flags] - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md index 88388b2be40ef..c321fe6af9134 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md @@ -53,7 +53,7 @@ kubeadm join [flags] ### Options -
--apiserver-advertise-address string
The IP address the API Server will advertise it's listening on. Specify '0.0.0.0' to use the address of the default network interface.The IP address the API Server will advertise it's listening on. Specify '0.0.0.0' to use the address of the default network interface.
--apiserver-bind-port int32     Default: 6443
Port for the API Server to bind to.Port for the API Server to bind to.
--apiserver-cert-extra-sans stringSlice
Optional extra Subject Alternative Names (SANs) to use for the API Server serving certificate. Can be both IP addresses and DNS names.Optional extra Subject Alternative Names (SANs) to use for the API Server serving certificate. Can be both IP addresses and DNS names.
--cert-dir string     Default: "/etc/kubernetes/pki"
The path where to save and store the certificates.The path where to save and store the certificates.
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental.Path to kubeadm config file. WARNING: Usage of a configuration file is experimental.
--cri-socket string     Default: "/var/run/dockershim.sock"
Specify the CRI socket to connect to.Specify the CRI socket to connect to.
--dry-run
Don't apply any changes; just output what would be done.Don't apply any changes; just output what would be done.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)		A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for inithelp for init
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--kubernetes-version string     Default: "stable-1.10"
Choose a specific Kubernetes version for the control plane.Choose a specific Kubernetes version for the control plane.
--node-name string
Specify the node name.Specify the node name.
--pod-network-cidr string
Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node.Specify range of IP addresses for the pod network. If set, the control plane will automatically allocate CIDRs for every node.
--service-cidr string     Default: "10.96.0.0/12"
Use alternative range of IP address for service VIPs.Use alternative range of IP address for service VIPs.
--service-dns-domain string     Default: "cluster.local"
Use alternative domain for services, e.g. "myorg.internal".Use alternative domain for services, e.g. "myorg.internal".
--skip-token-print
Skip printing of the default bootstrap token generated by 'kubeadm init'.Skip printing of the default bootstrap token generated by 'kubeadm init'.
--token string
The token to use for establishing bidirectional trust between nodes and masters.The token to use for establishing bidirectional trust between nodes and masters. The format is [a-z0-9]{6}\.[a-z0-9]{16} - e.g. abcdef.0123456789abcdef
--token-ttl duration     Default: 24h0m0s
The duration before the bootstrap token is automatically deleted. If set to '0', the token will never expire.The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire
+
@@ -64,84 +64,84 @@ kubeadm join [flags] - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md index 49036f02a3d13..5f5cd9b4be0d7 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md @@ -12,7 +12,7 @@ kubeadm reset [flags] ### Options -
--config string
Path to kubeadm config file.Path to kubeadm config file.
--cri-socket string     Default: "/var/run/dockershim.sock"
Specify the CRI socket to connect to.Specify the CRI socket to connect to.
--discovery-file string
A file or url from which to load cluster information.A file or url from which to load cluster information.
--discovery-token string
A token used to validate cluster information fetched from the master.A token used to validate cluster information fetched from the master.
--discovery-token-ca-cert-hash stringSlice
For token-based discovery, validate that the root CA public key matches this hash (format: "<type>:<value>").For token-based discovery, validate that the root CA public key matches this hash (format: "<type>:<value>").
--discovery-token-unsafe-skip-ca-verification
For token-based discovery, allow joining without --discovery-token-ca-cert-hash pinning.For token-based discovery, allow joining without --discovery-token-ca-cert-hash pinning.
--feature-gates string
A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)		A set of key=value pairs that describe feature gates for various features. Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for joinhelp for join
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--node-name string
Specify the node name.Specify the node name.
--tls-bootstrap-token string
A token used for TLS bootstrapping.A token used for TLS bootstrapping.
--token string
Use this token for both discovery-token and tls-bootstrap-token.Use this token for both discovery-token and tls-bootstrap-token.
+
@@ -23,28 +23,35 @@ kubeadm reset [flags] - + - + + + + + + + + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md index a4dfb9a605466..eaddaa1c5a110 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md @@ -29,7 +29,7 @@ kubeadm token [flags] ### Options -
--cert-dir string     Default: "/etc/kubernetes/pki"
The path to the directory where the certificates are stored. If specified, clean this directory.The path to the directory where the certificates are stored. If specified, clean this directory.
--cri-socket string     Default: "/var/run/dockershim.sock"
The path to the CRI socket to use with crictl when cleaning up containers.The path to the CRI socket to use with crictl when cleaning up containers.
--force
Reset the node without prompting for confirmation.
-h, --help
help for resethelp for reset
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
+
@@ -40,21 +40,21 @@ kubeadm token [flags] - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md index f2622eae9852e..15116185ac9ce 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md @@ -19,7 +19,7 @@ kubeadm token create [token] ### Options -
--dry-run
Whether to enable dry-run mode or notWhether to enable dry-run mode or not
-h, --help
help for tokenhelp for token
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster. If the flag is not set a set of standard locations are searched for an existing KubeConfig file
+
@@ -30,49 +30,49 @@ kubeadm token create [token] - + - + - + - + - + - + - + - + @@ -82,7 +82,7 @@ kubeadm token create [token] ### Options inherited from parent commands -
--config string
Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)Path to kubeadm config file (WARNING: Usage of a configuration file is experimental)
--description string
A human friendly description of how this token is used.A human friendly description of how this token is used.
--groups stringSlice     Default: [system:bootstrappers:kubeadm:default-node-token]
Extra groups that this token will authenticate as when used for authentication. Must match "system:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]".Extra groups that this token will authenticate as when used for authentication. Must match "\\Asystem:bootstrappers:[a-z0-9:-]{0,255}[a-z0-9]\\z"
-h, --help
help for createhelp for create
--print-join-command
Instead of printing only the token, print the full 'kubeadm join' flag needed to join the cluster using the token.Instead of printing only the token, print the full 'kubeadm join' flag needed to join the cluster using the token.
--ttl duration     Default: 24h0m0s--token-ttl duration     Default: 24h0m0s
The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire.The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire
--usages stringSlice     Default: [signing,authentication]
Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication].Describes the ways in which this token can be used. You can pass --usages multiple times or provide a comma separated list of options. Valid options: [signing,authentication]
+
@@ -93,14 +93,14 @@ kubeadm token create [token] - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md index 8a3c1b1624740..8a47b4345dba9 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md @@ -17,7 +17,7 @@ kubeadm token delete [token-value] ### Options -
--dry-run
Whether to enable dry-run mode or notWhether to enable dry-run mode or not
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster. If the flag is not set a set of standard locations are searched for an existing KubeConfig file
+
@@ -28,7 +28,7 @@ kubeadm token delete [token-value] - + @@ -38,7 +38,7 @@ kubeadm token delete [token-value] ### Options inherited from parent commands -
-h, --help
help for deletehelp for delete
+
@@ -49,14 +49,14 @@ kubeadm token delete [token-value] - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md index 35c70727fde15..f76a8d9d1a478 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md @@ -22,7 +22,7 @@ kubeadm token generate [flags] ### Options -
--dry-run
Whether to enable dry-run mode or notWhether to enable dry-run mode or not
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster. If the flag is not set a set of standard locations are searched for an existing KubeConfig file
+
@@ -33,7 +33,7 @@ kubeadm token generate [flags] - + @@ -43,7 +43,7 @@ kubeadm token generate [flags] ### Options inherited from parent commands -
-h, --help
help for generatehelp for generate
+
@@ -54,14 +54,14 @@ kubeadm token generate [flags] - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md index dd1726026bf54..a65b730a28c33 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md @@ -14,7 +14,7 @@ kubeadm token list [flags] ### Options -
--dry-run
Whether to enable dry-run mode or notWhether to enable dry-run mode or not
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster. If the flag is not set a set of standard locations are searched for an existing KubeConfig file
+
@@ -25,7 +25,7 @@ kubeadm token list [flags] - + @@ -35,7 +35,7 @@ kubeadm token list [flags] ### Options inherited from parent commands -
-h, --help
help for listhelp for list
+
@@ -46,14 +46,14 @@ kubeadm token list [flags] - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md index 5c6ba4673d4c6..8bd79242839a8 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md @@ -12,7 +12,7 @@ kubeadm upgrade [flags] ### Options -
--dry-run
Whether to enable dry-run mode or notWhether to enable dry-run mode or not
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the clusterThe KubeConfig file to use when talking to the cluster. If the flag is not set a set of standard locations are searched for an existing KubeConfig file
+
@@ -23,56 +23,56 @@ kubeadm upgrade [flags] - + - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md index df44de32d6744..15ae2a283e7ec 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md @@ -12,7 +12,7 @@ kubeadm upgrade apply [version] ### Options -
--allow-experimental-upgrades
Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.
--allow-release-candidate-upgrades
Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental!Path to kubeadm config file. WARNING: Usage of a configuration file is experimental!
--feature-gates string
A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)		A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
-h, --help
help for upgradehelp for upgrade
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.The KubeConfig file to use when talking to the cluster.
--print-config
Specifies whether the configuration file that will be used in the upgrade should be printed or not.Specifies whether the configuration file that will be used in the upgrade should be printed or not.
+
@@ -23,42 +23,42 @@ kubeadm upgrade apply [version] - + - + - + - + - + - + @@ -68,7 +68,7 @@ kubeadm upgrade apply [version] ### Options inherited from parent commands -
--dry-run
Do not change any state, just output what actions would be performed.Do not change any state, just output what actions would be performed.
--etcd-upgrade     Default: true
Perform the upgrade of etcd.Perform the upgrade of etcd.
-f, --force
Force upgrading although some requirements might not be met. This also implies non-interactive mode.Force upgrading although some requirements might not be met. This also implies non-interactive mode.
-h, --help
help for applyhelp for apply
--image-pull-timeout duration     Default: 15m0s
The maximum amount of time to wait for the control plane pods to be downloaded.The maximum amount of time to wait for the control plane pods to be downloaded.
-y, --yes
Perform the upgrade and do not prompt for confirmation (non-interactive mode).Perform the upgrade and do not prompt for confirmation (non-interactive mode).
+
@@ -79,49 +79,49 @@ kubeadm upgrade apply [version] - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_diff.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_diff.md new file mode 100644 index 0000000000000..64053f17fc07d --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_diff.md @@ -0,0 +1,124 @@ + +Show what differences would be applied to existing static pod manifests. See also: kubeadm upgrade apply --dry-run + +### Synopsis + + +Show what differences would be applied to existing static pod manifests. See also: kubeadm upgrade apply --dry-run + +``` +kubeadm upgrade diff [version] [flags] +``` + +### Options + +
--allow-experimental-upgrades
Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.
--allow-release-candidate-upgrades
Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental!Path to kubeadm config file. WARNING: Usage of a configuration file is experimental!
--feature-gates string
A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)		A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.The KubeConfig file to use when talking to the cluster.
--print-config
Specifies whether the configuration file that will be used in the upgrade should be printed or not.Specifies whether the configuration file that will be used in the upgrade should be printed or not.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--api-server-manifest string     Default: "/etc/kubernetes/manifests/kube-apiserver.yaml"
path to API server manifest
-c, --context-lines int     Default: 3
How many lines of context in the diff
--controller-manager-manifest string     Default: "/etc/kubernetes/manifests/kube-controller-manager.yaml"
path to controller manifest
-h, --help
help for diff
--scheduler-manifest string     Default: "/etc/kubernetes/manifests/kube-scheduler.yaml"
path to scheduler manifest
+ + + +### Options inherited from parent commands + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--allow-experimental-upgrades
Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.
--allow-release-candidate-upgrades
Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental!
--feature-gates string
A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
--print-config
Specifies whether the configuration file that will be used in the upgrade should be printed or not.
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node.md new file mode 100644 index 0000000000000..037a07e56bee7 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node.md @@ -0,0 +1,96 @@ + +Upgrade commands for a node in the cluster. Currently only supports upgrading the configuration, not the kubelet itself. + +### Synopsis + + +Upgrade commands for a node in the cluster. Currently only supports upgrading the configuration, not the kubelet itself. + +``` +kubeadm upgrade node [flags] +``` + +### Options + + + + + + + + + + + + + + + + +
-h, --help
help for node
+ + + +### Options inherited from parent commands + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--allow-experimental-upgrades
Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.
--allow-release-candidate-upgrades
Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental!
--feature-gates string
A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
--print-config
Specifies whether the configuration file that will be used in the upgrade should be printed or not.
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_config.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_config.md new file mode 100644 index 0000000000000..3172348328c12 --- /dev/null +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_node_config.md @@ -0,0 +1,121 @@ + +Downloads the kubelet configuration from the cluster ConfigMap kubelet-config-1.X, where X is the minor version of the kubelet. + +### Synopsis + + +Downloads the kubelet configuration from a ConfigMap of the form "kubelet-config-1.X" in the cluster, where X is the minor version of the kubelet. kubeadm uses the --kubelet-version parameter to determine what the desired kubelet version is. Give + +``` +kubeadm upgrade node config [flags] +``` + +### Examples + +``` + # Downloads the kubelet configuration from the ConfigMap in the cluster. Uses a specific desired kubelet version. + kubeadm upgrade node config --kubelet-version v1.11.0 + + # Simulates the downloading of the kubelet configuration from the ConfigMap in the cluster with a specific desired + # version. Does not change any state locally on the node. + kubeadm upgrade node config --kubelet-version v1.11.0 --dry-run +``` + +### Options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--dry-run
Do not change any state, just output the actions that would be performed.
-h, --help
help for config
--kubelet-version string
The *desired* version for the kubelet after the upgrade.
+ + + +### Options inherited from parent commands + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--allow-experimental-upgrades
Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.
--allow-release-candidate-upgrades
Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental!
--feature-gates string
A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.
--print-config
Specifies whether the configuration file that will be used in the upgrade should be printed or not.
+ + + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md index 55bff85193739..23e42a640141b 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md @@ -1,18 +1,18 @@ -Check which versions are available to upgrade to and validate whether your current cluster is upgradeable. +Check which versions are available to upgrade to and validate whether your current cluster is upgradeable. To skip the internet check, pass in the optional [version] parameter. ### Synopsis -Check which versions are available to upgrade to and validate whether your current cluster is upgradeable. +Check which versions are available to upgrade to and validate whether your current cluster is upgradeable. To skip the internet check, pass in the optional [version] parameter. ``` -kubeadm upgrade plan [flags] +kubeadm upgrade plan [version] [flags] ``` ### Options - +
@@ -23,7 +23,7 @@ kubeadm upgrade plan [flags] - + @@ -33,7 +33,7 @@ kubeadm upgrade plan [flags] ### Options inherited from parent commands -
-h, --help
help for planhelp for plan
+
@@ -44,49 +44,49 @@ kubeadm upgrade plan [flags] - + - + - + - + - + - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md index 52cbb40aa48f5..9d47c24691647 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md +++ b/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md @@ -12,7 +12,7 @@ kubeadm version [flags] ### Options -
--allow-experimental-upgrades
Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.Show unstable versions of Kubernetes as an upgrade alternative and allow upgrading to an alpha/beta/release candidate versions of Kubernetes.
--allow-release-candidate-upgrades
Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.Show release candidate versions of Kubernetes as an upgrade alternative and allow upgrading to a release candidate versions of Kubernetes.
--config string
Path to kubeadm config file. WARNING: Usage of a configuration file is experimental!Path to kubeadm config file. WARNING: Usage of a configuration file is experimental!
--feature-gates string
A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (BETA - default=false)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)		A set of key=value pairs that describe feature gates for various features.Options are:
Auditing=true|false (ALPHA - default=false)
CoreDNS=true|false (default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
SelfHosting=true|false (ALPHA - default=false)
StoreCertsInSecrets=true|false (ALPHA - default=false)
--ignore-preflight-errors stringSlice
A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.A list of checks whose errors will be shown as warnings. Example: 'IsPrivilegedUser,Swap'. Value 'all' ignores errors from all checks.
--kubeconfig string     Default: "/etc/kubernetes/admin.conf"
The KubeConfig file to use when talking to the cluster.The KubeConfig file to use when talking to the cluster.
--print-config
Specifies whether the configuration file that will be used in the upgrade should be printed or not.Specifies whether the configuration file that will be used in the upgrade should be printed or not.
+
@@ -23,14 +23,14 @@ kubeadm version [flags] - + - + diff --git a/content/en/docs/reference/setup-tools/kubeadm/implementation-details.md b/content/en/docs/reference/setup-tools/kubeadm/implementation-details.md index 38dc52bfb37b6..35de6b056b5b6 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/implementation-details.md +++ b/content/en/docs/reference/setup-tools/kubeadm/implementation-details.md @@ -28,7 +28,7 @@ The cluster that `kubeadm init` and `kubeadm join` set up should be: - using secure communication between the control plane components - using secure communication between the API server and the kubelets - lock-down the kubelet API - - locking down access to the API for system components like the kube-proxy and kube-dns + - locking down access to the API for system components like the kube-proxy and CoreDNS - locking down what a Bootstrap Token can access - etc. - **Easy to use**: The user should not have to run anything more than a couple of commands: @@ -234,7 +234,8 @@ The static Pod manifest for the API server is affected by following parameters p Other API server flags that are set unconditionally are: - `--insecure-port=0` to avoid insecure connections to the api server - - `--enable-bootstrap-token-auth=true` to enable the `BootstrapTokenAuthenticator` authentication module. see [TLS Bootstrapping](/docs/admin/kubelet-tls-bootstrapping.md) for more details + - `--enable-bootstrap-token-auth=true` to enable the `BootstrapTokenAuthenticator` authentication module. + See [TLS Bootstrapping](/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping/) for more details - `--allow-privileged` to `true` (required e.g. by kube proxy) - `--requestheader-client-ca-file` to `front-proxy-ca.crt` - `--enable-admission-plugins` to: @@ -282,7 +283,7 @@ The static Pod manifest for the API server is affected by following parameters p Other flags that are set unconditionally are: - `--controllers` enabling all the default controllers plus `BootstrapSigner` and `TokenCleaner` controllers for TLS bootstrap. - see [TLS Bootstrapping](/docs/admin/kubelet-tls-bootstrapping.md) for more details + See [TLS Bootstrapping](/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping/) for more details - `--use-service-account-credentials` to `true` - Flags for using certificates generated in previous steps: - `--root-ca-file` to `ca.crt` @@ -451,16 +452,20 @@ A ServiceAccount for `kube-proxy` is created in the `kube-system` namespace; the #### DNS -A ServiceAccount for `kube-dns` is created in the `kube-system` namespace. +Note that: -Deploy the kube-dns Deployment and Service: +- The CoreDNS service is named `kube-dns`. This is done to prevent any interruption +in service when the user is switching the cluster DNS from kube-dns to CoreDNS or vice-versa +- In Kubernetes version 1.11 and later, CoreDNS is the default DNS server and you must +invoke kubeadm with `--feature-gates=CoreDNS=false` to install kube-dns instead +- In Kubernetes version 1.10 and earlier, you must enable CoreDNS with `--feature-gates=CoreDNS=true` -- It's the upstream kube-dns deployment relatively unmodified -- The `kube-dns` ServiceAccount is bound to the privileges in the `system:kube-dns` ClusterRole +A ServiceAccount for CoreDNS/kube-dns is created in the `kube-system` namespace. -Please note that: +Deploy the `kube-dns` Deployment and Service: -1. If kubeadm is invoked with `--feature-gates=CoreDNS`, CoreDNS is installed instead of `kube-dns` +- It's the upstream CoreDNS deployment relatively unmodified +- The `kube-dns` ServiceAccount is bound to the privileges in the `system:kube-dns` ClusterRole ### (Optional and alpha in v1.9) self-hosting diff --git a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-alpha.md b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-alpha.md index aaa16e1ef5944..ae8afd71dff1a 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-alpha.md +++ b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-alpha.md @@ -118,12 +118,14 @@ Alternatively, you can use [kubeadm config](/docs/reference/setup-tools/kubeadm/ You can install all the available addons with the `all` subcommand, or install them selectively. -Please note that if kubeadm is invoked with `--feature-gates=CoreDNS=true`, [CoreDNS](https://coredns.io/) is installed instead of `kube-dns`. +{{< note >}} +**Note:** If `kubeadm` is invoked with `--feature-gates=CoreDNS=false`, kube-dns is installed. +{{< /note >}} {{< tabs name="tab-addon" >}} {{< tab name="all" include="generated/kubeadm_alpha_phase_addon_all.md" />}} {{< tab name="kube-proxy" include="generated/kubeadm_alpha_phase_addon_kube-proxy.md" />}} -{{< tab name="kube-dns" include="generated/kubeadm_alpha_phase_addon_kube-dns.md" />}} +{{< tab name="coredns" include="generated/kubeadm_alpha_phase_addon_coredns.md" />}} {{< /tabs >}} diff --git a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-config.md b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-config.md index 3d095830c36df..b5e9a19f9315d 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-config.md +++ b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-config.md @@ -16,6 +16,11 @@ You can execute `kubeadm config view` to view the ConfigMap. If you initialized kubeadm v1.7.x or lower, you must use `kubeadm config upload` to create the ConfigMap before you may use `kubeadm upgrade`. +In Kubernetes v1.11.0, some new commands were added. You can use `kubeadm config print-default` +to print the default configuration and `kubeadm config migrate` to convert your old configuration +files to a newer version. `kubeadm config images list` and `kubeadm config images pull` can be used +to list and pull the images that kubeadm requires. + {{% /capture %}} {{% capture body %}} @@ -27,6 +32,19 @@ may use `kubeadm upgrade`. ## kubeadm config view {#cmd-config-view} {{< include "generated/kubeadm_config_view.md" >}} + +## kubeadm config print-default {#cmd-config-print-default} +{{< include "generated/kubeadm_config_print-default.md" >}} + +## kubeadm config migrate {#cmd-config-migrate} +{{< include "generated/kubeadm_config_migrate.md" >}} + +## kubeadm config images list {#cmd-config-images-list} +{{< include "generated/kubeadm_config_images_list.md" >}} + +## kubeadm config images pull {#cmd-config-images-pull} +{{< include "generated/kubeadm_config_images_pull.md" >}} + {{% /capture %}} {{% capture whatsnext %}} 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 9639fb39a7860..0bfef924081b2 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md +++ b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md @@ -29,6 +29,7 @@ following steps: own CA cert and/or key by dropping it in the cert directory configured via `--cert-dir` (`/etc/kubernetes/pki` by default) this step is skipped as described in the [Using custom certificates](#custom-certificates) document. + The APIServer certs will have additional SAN entries for any `--apiserver-cert-extra-sans` arguments, lowercased if necessary. 1. Writes kubeconfig files in `/etc/kubernetes/` for the kubelet, the controller-manager and the scheduler to use to connect to the @@ -67,7 +68,7 @@ following steps: 1. Makes all the necessary configurations for allowing node joining with the [Bootstrap Tokens](/docs/admin/bootstrap-tokens/) and - [TLS Bootstrap](/docs/admin/kubelet-tls-bootstrapping/) + [TLS Bootstrap](/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping/) mechanism: - Write a ConfigMap for making available all the information required @@ -79,14 +80,15 @@ following steps: See [kubeadm join](/docs/reference/setup-tools/kubeadm/kubeadm-join/) for additional info. -1. Installs the internal DNS server (kube-dns) and the kube-proxy addon components via the API server. If kubeadm is invoked with `--feature-gates=CoreDNS=true`, then [CoreDNS](https://coredns.io/) will be installed as the default internal DNS server instead of kube-dns. +1. Installs a DNS server (CoreDNS) and the kube-proxy addon components via the API server. + In Kubernetes version 1.11 and later CoreDNS is the default DNS server. + To install kube-dns instead of CoreDNS, kubeadm must be invoked with `--feature-gates=CoreDNS=false`. Please note that although the DNS server is deployed, it will not be scheduled until CNI is installed. 1. If `kubeadm init` is invoked with the alpha self-hosting feature enabled, (`--feature-gates=SelfHosting=true`), the static Pod based control plane is transformed into a [self-hosted control plane](#self-hosting). - ### Using kubeadm init with a configuration file {#config-file} {{< caution >}} @@ -96,81 +98,160 @@ still considered alpha and may change in future versions. It's possible to configure `kubeadm init` with a configuration file instead of command line flags, and some more advanced features may only be available as -configuration file options. This file is passed in the `--config` option. +configuration file options. This file is passed in the `--config` option. + +In Kubernetes 1.11 and later, the default configuration can be printed out using the +[kubeadm config print-default](/docs/reference/setup-tools/kubeadm/kubeadm-config/) command. + +For more details on each field in the configuration you can navigate to our +[API reference pages.] (https://godoc.org/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm#MasterConfiguration) + +Example of the kubeadm MasterConfiguration version `v1alpha2`: ```yaml -apiVersion: kubeadm.k8s.io/v1alpha1 +apiVersion: kubeadm.k8s.io/v1alpha2 kind: MasterConfiguration +kubernetesVersion: v1.11.0 api: - advertiseAddress: - controlPlaneEndpoint: - bindPort: + advertiseAddress: 192.168.0.102 + bindPort: 6443 + controlPlaneEndpoint: "" +auditPolicy: + logDir: /var/log/kubernetes/audit + logMaxAge: 2 + path: "" +bootstrapTokens: +- groups: + - system:bootstrappers:kubeadm:default-node-token + token: abcdef.0123456789abcdef + ttl: 24h0m0s + usages: + - signing + - authentication +certificatesDir: /etc/kubernetes/pki +clusterName: kubernetes etcd: - endpoints: - - - - - caFile: - certFile: - keyFile: - dataDir: - extraArgs: - : - : - image: - serverCertSANs: - - - - - peerCertSANs: - - - - + local: + dataDir: /var/lib/etcd + image: "" +imageRepository: k8s.gcr.io kubeProxy: config: - mode: - bindAddress: - clusterCIDR: + bindAddress: 0.0.0.0 + clientConnection: + acceptContentTypes: "" + burst: 10 + contentType: application/vnd.kubernetes.protobuf + kubeconfig: /var/lib/kube-proxy/kubeconfig.conf + qps: 5 + clusterCIDR: "" + configSyncPeriod: 15m0s + conntrack: + max: null + maxPerCore: 32768 + min: 131072 + tcpCloseWaitTimeout: 1h0m0s + tcpEstablishedTimeout: 24h0m0s + enableProfiling: false + healthzBindAddress: 0.0.0.0:10256 + hostnameOverride: "" + iptables: + masqueradeAll: false + masqueradeBit: 14 + minSyncPeriod: 0s + syncPeriod: 30s + ipvs: + ExcludeCIDRs: null + minSyncPeriod: 0s + scheduler: "" + syncPeriod: 30s + metricsBindAddress: 127.0.0.1:10249 + mode: "" + nodePortAddresses: null + oomScoreAdj: -999 + portRange: "" + resourceContainer: /kube-proxy + udpIdleTimeout: 250ms +kubeletConfiguration: + baseConfig: + address: 0.0.0.0 + authentication: + anonymous: + enabled: false + webhook: + cacheTTL: 2m0s + enabled: true + x509: + clientCAFile: /etc/kubernetes/pki/ca.crt + authorization: + mode: Webhook + webhook: + cacheAuthorizedTTL: 5m0s + cacheUnauthorizedTTL: 30s + cgroupDriver: cgroupfs + cgroupsPerQOS: true + clusterDNS: + - 10.96.0.10 + clusterDomain: cluster.local + containerLogMaxFiles: 5 + containerLogMaxSize: 10Mi + contentType: application/vnd.kubernetes.protobuf + cpuCFSQuota: true + cpuManagerPolicy: none + cpuManagerReconcilePeriod: 10s + enableControllerAttachDetach: true + enableDebuggingHandlers: true + enforceNodeAllocatable: + - pods + eventBurst: 10 + eventRecordQPS: 5 + evictionHard: + imagefs.available: 15% + memory.available: 100Mi + nodefs.available: 10% + nodefs.inodesFree: 5% + evictionPressureTransitionPeriod: 5m0s + failSwapOn: true + fileCheckFrequency: 20s + hairpinMode: promiscuous-bridge + healthzBindAddress: 127.0.0.1 + healthzPort: 10248 + httpCheckFrequency: 20s + imageGCHighThresholdPercent: 85 + imageGCLowThresholdPercent: 80 + imageMinimumGCAge: 2m0s + iptablesDropBit: 15 + iptablesMasqueradeBit: 14 + kubeAPIBurst: 10 + kubeAPIQPS: 5 + makeIPTablesUtilChains: true + maxOpenFiles: 1000000 + maxPods: 110 + nodeStatusUpdateFrequency: 10s + oomScoreAdj: -999 + podPidsLimit: -1 + port: 10250 + registryBurst: 10 + registryPullQPS: 5 + resolvConf: /etc/resolv.conf + rotateCertificates: true + runtimeRequestTimeout: 2m0s + serializeImagePulls: true + staticPodPath: /etc/kubernetes/manifests + streamingConnectionIdleTimeout: 4h0m0s + syncFrequency: 1m0s + volumeStatsAggPeriod: 1m0s networking: - dnsDomain: - serviceSubnet: - podSubnet: -kubernetesVersion: -cloudProvider: -nodeName: -authorizationModes: -- -- -token: -tokenTTL:
-h, --help
help for versionhelp for version
-o, --output string
Output format; available options are 'yaml', 'json' and 'short'Output format; available options are 'yaml', 'json' and 'short'
- -
- - - + + - - - + + - - - + + - - - + + - - - + + - - - + + + + + +
Possible MessagesPossible ReasonsStatusError MessagePossible Causes

using current: local

when the config source is nil, the Kubelet uses its local config

True

failed to load config, see Kubelet log for details

The Kubelet likely could not parse the downloaded config payload, or encountered a filesystem error attempting to load the payload from disk.

using current: /api/v1/namespaces/${CURRENT_CONFIG_MAP_NAMESPACE}/configmaps/${CURRENT_CONFIG_MAP_NAME}

passing all checks

True

failed to validate config, see Kubelet log for details

The configuration in the payload, combined with any command-line flag overrides, and the sum of feature gates from flags, the config file, and the remote payload, was determined to be invalid by the Kubelet.

using last-known-good: local

 -
    -
  • failed to load current: /api/v1/namespaces/${CURRENT_CONFIG_MAP_NAMESPACE}/configmaps/${CURRENT_CONFIG_MAP_NAME}
    • -
  • failed to parse current: /api/v1/namespaces/${CURRENT_CONFIG_MAP_NAMESPACE}/configmaps/${CURRENT_CONFIG_MAP_NAME}
    • -
  • failed to validate current: /api/v1/namespaces/${CURRENT_CONFIG_MAP_NAMESPACE}/configmaps/${CURRENT_CONFIG_MAP_NAME}
    • -
-

False

invalid NodeConfigSource, exactly one subfield must be non-nil, but all were nil

Since Node.Spec.ConfigSource is validated by the API server to contain at least one non-nil subfield, this likely means that the Kubelet is older than the API server and does not recognize a newer source type.

using last-known-good: /api/v1/namespaces/${LAST_KNOWN_GOOD_CONFIG_MAP_NAMESPACE}/configmaps/${LAST_KNOWN_GOOD_CONFIG_MAP_NAME}

 -
    -
  • failed to load current: /api/v1/namespaces/${CURRENT_CONFIG_MAP_NAMESPACE}/configmaps/${CURRENT_CONFIG_MAP_NAME}
    • -
  • failed to parse current: /api/v1/namespaces/${CURRENT_CONFIG_MAP_NAMESPACE}/configmaps/${CURRENT_CONFIG_MAP_NAME}
    • -
  • failed to validate current: /api/v1/namespaces/${CURRENT_CONFIG_MAP_NAMESPACE}/configmaps/${CURRENT_CONFIG_MAP_NAME}
    • -
-

False

failed to sync: failed to download config, see Kubelet log for details

The Kubelet could not download the config. It is possible that Node.Spec.ConfigSource could not be resolved to a concrete API object, or that network errors disrupted the download attempt. The Kubelet will retry the download when in this error state.
-

- The reasons in the next column could potentially appear for any of - the above messages. -

-

- This condition indicates that the Kubelet is having trouble - reconciling `spec.configSource`, and thus no change to the in-use - configuration has occurred. -

-

- The "failed to sync" reasons are specific to the failure that - occurred, and the next column does not necessarily contain all - possible failure reasons. -

- 		-

failed to sync, reason:

-
    -
  • failed to read Node from informer object cache
    • -
  • failed to reset to local config
    • -
  • invalid NodeConfigSource, exactly one subfield must be non-nil, but all were nil
    • -
  • invalid ObjectReference, all of UID, Name, and Namespace must be specified
    • -
  • invalid ConfigSource.ConfigMapRef.UID: ${UID} does not match ${API_PATH}.UID: ${UID_OF_CONFIG_MAP_AT_API_PATH}
    • -
  • failed to determine whether object ${API_PATH} with UID ${UID} was already checkpointed
    • -
  • failed to download ConfigMap with name ${NAME} from namespace ${NAMESPACE}
    • -
  • failed to save config checkpoint for object ${API_PATH} with UID ${UID}
    • -
  • failed to set current config checkpoint to local config
    • -
  • failed to set current config checkpoint to object ${API_PATH} with UID ${UID}
    • -
-

False

failed to sync: internal failure, see Kubelet log for details

The Kubelet encountered some internal problem and failed to update its config as a result. Examples include filesystem errors and reading objects from the internal informer cache.

internal failure, see Kubelet log for details

The Kubelet encountered some internal problem while manipulating config, outside of the configuration sync loop.
-{{% /capture %}} - - +{{% /capture %}} diff --git a/content/en/docs/tasks/administer-cluster/reserve-compute-resources.md b/content/en/docs/tasks/administer-cluster/reserve-compute-resources.md index bad61545e72f0..21ad5376aa44c 100644 --- a/content/en/docs/tasks/administer-cluster/reserve-compute-resources.md +++ b/content/en/docs/tasks/administer-cluster/reserve-compute-resources.md @@ -4,9 +4,10 @@ reviewers: - derekwaynecarr - dashpole title: Reserve Compute Resources for System Daemons +content_template: templates/task --- -{{< toc >}} +{{% capture overview %}} Kubernetes nodes can be scheduled to `Capacity`. Pods can consume all the available capacity on a node by default. This is an issue because nodes @@ -20,6 +21,18 @@ compute resources for system daemons. Kubernetes recommends cluster administrators to configure `Node Allocatable` based on their workload density on each node. +{{% /capture %}} + +{{< toc >}} + +{{% capture prerequisites %}} + +{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + +{{% /capture %}} + +{{% capture steps %}} + ## Node Allocatable ```text @@ -185,6 +198,10 @@ more features are added. Over time, kubernetes project will attempt to bring down utilization of node system daemons, but that is not a priority as of now. So expect a drop in `Allocatable` capacity in future releases. +{{% /capture %}} + +{{% capture discussion %}} + ## Example Scenario Here is an example to illustrate Node Allocatable computation: @@ -230,3 +247,5 @@ the proper part of the cgroup hierarchy. As of Kubernetes version 1.7, `kubelet` supports specifying `storage` as a resource for `kube-reserved` and `system-reserved`. + +{{% /capture %}} diff --git a/content/en/docs/tasks/administer-cluster/running-cloud-controller.md b/content/en/docs/tasks/administer-cluster/running-cloud-controller.md index f79be347f83a5..d6c3eec4804e4 100644 --- a/content/en/docs/tasks/administer-cluster/running-cloud-controller.md +++ b/content/en/docs/tasks/administer-cluster/running-cloud-controller.md @@ -4,18 +4,23 @@ reviewers: - thockin - wlan0 title: Kubernetes Cloud Controller Manager +content_template: templates/concept --- -{{< feature-state state="alpha" >}} +{{% capture overview %}} -{{< toc >}} - -## Cloud Controller Manager +{{< feature-state state="beta" >}} Kubernetes v1.6 introduced a new binary called `cloud-controller-manager`. `cloud-controller-manager` is a daemon that embeds cloud-specific control loops. These cloud-specific control loops were originally in the `kube-controller-manager`. Since cloud providers develop and release at a different pace compared to the Kubernetes project, abstracting the provider-specific code to the `cloud-controller-manager` binary allows cloud vendors to evolve independently from the core Kubernetes code. The `cloud-controller-manager` can be linked to any cloud provider that satisfies [cloudprovider.Interface](https://git.k8s.io/kubernetes/pkg/cloudprovider/cloud.go). For backwards compatibility, the [cloud-controller-manager](https://github.com/kubernetes/kubernetes/tree/master/cmd/cloud-controller-manager) provided in the core Kubernetes project uses the same cloud libraries as `kube-controller-manager`. Cloud providers already supported in Kubernetes core are expected to use the in-tree cloud-controller-manager to transition out of Kubernetes core. In future Kubernetes releases, all cloud controller managers will be developed outside of the core Kubernetes project managed by sig leads or cloud vendors. +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ## Administration ### Requirements @@ -32,10 +37,11 @@ Successfully running cloud-controller-manager requires some changes to your clus * `kube-apiserver` and `kube-controller-manager` MUST NOT specify the `--cloud-provider` flag. This ensures that it does not run any cloud specific loops that would be run by cloud controller manager. In the future, this flag will be deprecated and removed. * `kubelet` must run with `--cloud-provider=external`. This is to ensure that the kubelet is aware that it must be initialized by the cloud controller manager before it is scheduled any work. -* `kube-apiserver` SHOULD NOT run the `PersistentVolumeLabel` admission controller since the cloud controller manager takes over labeling persistent volumes. To prevent the PersistentVolumeLabel admission plugin from running in `kube-apiserver`, include the `PersistentVolumeLabel` as a listed value in the `--disable-admission-plugins` flag. +* `kube-apiserver` SHOULD NOT run the `PersistentVolumeLabel` admission controller + since the cloud controller manager takes over labeling persistent volumes. * For the `cloud-controller-manager` to label persistent volumes, initializers will need to be enabled and an InitializerConifguration needs to be added to the system. Follow [these instructions](/docs/admin/extensible-admission-controllers.md#enable-initializers-alpha-feature) to enable initializers. Use the following YAML to create the InitializerConfiguration: -{{< code file="persistent-volume-label-initializer-config.yaml" >}} +{{< codenew file="admin/cloud/pvl-initializer-config.yaml" >}} Keep in mind that setting up your cluster to use cloud controller manager will change your cluster behaviour in a few ways: @@ -48,7 +54,7 @@ As of v1.8, cloud controller manager can implement: * node controller - responsible for updating kubernetes nodes using cloud APIs and deleting kubernetes nodes that were deleted on your cloud. * service controller - responsible for loadbalancers on your cloud against services of type LoadBalancer. * route controller - responsible for setting up network routes on your cloud -* [PersistentVolumeLabel Admission Controller](/docs/admin/admission-controllers#persistentvolumelabel) - responsible for labeling persistent volumes on your cloud - ensure that the persistent volume label admission plugin is not enabled on your kube-apiserver. +* persistent valume labels controller - responsible for setting the zone and region labels on PersistentVolumes created in GCP and AWS clouds. * any other features you would like to implement if you are running an out-of-tree provider. @@ -65,7 +71,7 @@ For cloud controller managers not in Kubernetes core, you can find the respectiv For providers already in Kubernetes core, you can run the in-tree cloud controller manager as a Daemonset in your cluster, use the following as a guideline: -{{< code file="cloud-controller-manager-daemonset-example.yaml" >}} +{{< codenew file="admin/cloud/ccm-example.yaml" >}} ## Limitations @@ -91,3 +97,5 @@ As this initiative evolves, changes will be made to address these issues in upco ## Developing your own Cloud Controller Manager To build and develop your own cloud controller manager, read the [Developing Cloud Controller Manager](/docs/tasks/administer-cluster/developing-cloud-controller-manager.md) doc. + +{{% /capture %}} diff --git a/content/en/docs/tasks/administer-cluster/setup-ha-etcd-with-kubeadm.md b/content/en/docs/tasks/administer-cluster/setup-ha-etcd-with-kubeadm.md index b03be78baaa4b..c8915627ac2da 100644 --- a/content/en/docs/tasks/administer-cluster/setup-ha-etcd-with-kubeadm.md +++ b/content/en/docs/tasks/administer-cluster/setup-ha-etcd-with-kubeadm.md @@ -9,7 +9,7 @@ content_template: templates/task Kubeadm defaults to running a single member etcd cluster in a static pod managed by the kubelet on the control plane node. This is not a highly available setup -as the the etcd cluster contains only one member and cannot sustain any members +as the etcd cluster contains only one member and cannot sustain any members becoming unavailable. This task walks through the process of creating a highly available etcd cluster of three members that can be used as an external etcd when using kubeadm to set up a kubernetes cluster. @@ -22,9 +22,10 @@ when using kubeadm to set up a kubernetes cluster. document assumes these default ports. However, they are configurable through the kubeadm config file. * Each host must [have docker, kubelet, and kubeadm installed][toolbox]. -* Some infrastructure to copy files between hosts (e.g., ssh). +* Some infrastructure to copy files between hosts. For example `ssh` and `scp` + can satisfy this requirement. -[toolbox]: /docs/setup/independent/install-kubeadm/ +[toolbox]: /docs/tasks/tools/install-kubeadm/ {{% /capture %}} @@ -33,9 +34,32 @@ when using kubeadm to set up a kubernetes cluster. ## Setting up the cluster The general approach is to generate all certs on one node and only distribute -the *necessary* files to the other nodes. Note that kubeadm contains all the -necessary crytographic machinery to generate the certificates described below; -no other cryptographic tooling is required for this example. +the *necessary* files to the other nodes. + +{{< note >}} +**Note:** kubeadm contains all the necessary crytographic machinery to generate +the certificates described below; no other cryptographic tooling is required for +this example. +{{< /note >}} + + +1. Configure the kubelet to be a service manager for etcd. + + Running etcd is simpler than running kubernetes so you must override the + kubeadm-provided kubelet unit file by creating a new one with a higher + precedence. + + ```sh + cat << EOF > /etc/systemd/system/kubelet.service.d/20-etcd-service-manager.conf + [Service] + ExecStart= + ExecStart=/usr/bin/kubelet --pod-manifest-path=/etc/kubernetes/manifests --allow-privileged=true + Restart=always + EOF + + systemctl daemon-reload + systemctl restart kubelet + ``` 1. Create configuration files for kubeadm. @@ -67,7 +91,7 @@ no other cryptographic tooling is required for this example. peerCertSANs: - "${HOST}" extraArgs: - initial-cluster: infra0=https://${ETCDHOST0}:2380,infra1=https://${ETCDHOST1}:2380,infra2=https://${ETCDHOST2:2380 + initial-cluster: infra0=https://${ETCDHOSTS[0]}:2380,infra1=https://${ETCDHOSTS[1]}:2380,infra2=https://${ETCDHOSTS[2]}:2380 initial-cluster-state: new name: ${NAME} listen-peer-urls: https://${HOST}:2380 @@ -112,7 +136,7 @@ no other cryptographic tooling is required for this example. kubeadm alpha phase certs etcd-peer --config=/tmp/${HOST1}/kubeadmcfg.yaml kubeadm alpha phase certs etcd-healthcheck-client --config=/tmp/${HOST1}/kubeadmcfg.yaml kubeadm alpha phase certs apiserver-etcd-client --config=/tmp/${HOST1}/kubeadmcfg.yaml - cp -R /etc/kubernetes/pki /tmp/${HOST2}/ + cp -R /etc/kubernetes/pki /tmp/${HOST1}/ find /etc/kubernetes/pki -not -name ca.crt -not -name ca.key -type f -delete kubeadm alpha phase certs etcd-server --config=/tmp/${HOST0}/kubeadmcfg.yaml diff --git a/content/en/docs/tasks/administer-cluster/static-pod.md b/content/en/docs/tasks/administer-cluster/static-pod.md index c8d3511b23ce7..139ecf40daf74 100644 --- a/content/en/docs/tasks/administer-cluster/static-pod.md +++ b/content/en/docs/tasks/administer-cluster/static-pod.md @@ -2,8 +2,11 @@ reviewers: - jsafrane title: Static Pods +content_template: templates/concept --- +{{% capture overview %}} + **If you are running clustered Kubernetes and are using static pods to run a pod on every node, you should probably be using a [DaemonSet](/docs/concepts/workloads/controllers/daemonset/)!** *Static pods* are managed directly by kubelet daemon on a specific node, without the API server observing it. It does not have an associated replication controller, and kubelet daemon itself watches it and restarts it when it crashes. There is no health check. Static pods are always bound to one kubelet daemon and always run on the same node with it. @@ -11,6 +14,12 @@ title: Static Pods Kubelet automatically tries to create a *mirror pod* on the Kubernetes API server for each static pod. This means that the pods are visible on the API server but cannot be controlled from there. +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ## Static pod creation Static pod can be created in two ways: either by using configuration file(s) or by HTTP. @@ -108,7 +117,7 @@ static-web-my-node1 1/1 Running 0 12s Back to our `my-node1` host, we can try to stop the container manually and see, that kubelet automatically restarts it in a while: -```shell +```none [joe@host ~] $ ssh my-node1 [joe@my-node1 ~] $ docker stop f6d05272b57e [joe@my-node1 ~] $ sleep 20 @@ -132,3 +141,5 @@ Running kubelet periodically scans the configured directory (`/etc/kubelet.d` in CONTAINER ID IMAGE COMMAND CREATED ... e7a62e3427f1 nginx:latest "nginx -g 'daemon of 27 seconds ago ``` + +{{% /capture %}} diff --git a/content/en/docs/tasks/administer-cluster/storage-object-in-use-protection.md b/content/en/docs/tasks/administer-cluster/storage-object-in-use-protection.md index ae67d40387592..d5e90dd3497b6 100644 --- a/content/en/docs/tasks/administer-cluster/storage-object-in-use-protection.md +++ b/content/en/docs/tasks/administer-cluster/storage-object-in-use-protection.md @@ -7,15 +7,16 @@ content_template: templates/task --- {{% capture overview %}} -{{< feature-state for_k8s_version="v1.10" state="beta" >}} -Persistent volume claims (PVCs) that are in active use by a pod and persistent volumes (PVs) that are bound to PVCs can be protected from pre-mature removal. +Persistent volume claims (PVCs) that are in active use by a pod and persistent volumes (PVs) that are bound to PVCs can be protected from premature removal. {{% /capture %}} {{% capture prerequisites %}} -- The Storage Object in Use Protection feature is enabled in a version of Kubernetes in which it is supported. +The Storage Object in Use Protection feature is enabled in one of the below Kubernetes versions: +- {% assign for_k8s_version = "1.10" %} {% include feature-state-beta.md %} +- {% assign for_k8s_version = "1.11" %} {% include feature-state-stable.md %} {{% /capture %}} @@ -312,5 +313,3 @@ No resources found. {{% /capture %}} - - diff --git a/content/en/docs/tasks/administer-cluster/sysctl-cluster.md b/content/en/docs/tasks/administer-cluster/sysctl-cluster.md index 8ea3e4a30e3f0..3b3d53628e5d1 100644 --- a/content/en/docs/tasks/administer-cluster/sysctl-cluster.md +++ b/content/en/docs/tasks/administer-cluster/sysctl-cluster.md @@ -1,13 +1,15 @@ --- -title: Using Sysctls in a Kubernetes Cluster +title: Using sysctls in a Kubernetes Cluster reviewers: - sttts content_template: templates/task --- {{% capture overview %}} +{{< feature-state for_k8s_version="v1.11" state="beta" >}} -This document describes how sysctls are used within a Kubernetes cluster. +This document describes how to configure and use kernel parameters within a +Kubernetes cluster using the sysctl interface. {{% /capture %}} @@ -74,7 +76,7 @@ application tuning. _Unsafe_ sysctls are enabled on a node-by-node basis with a flag of the kubelet, e.g.: ```shell -$ kubelet --experimental-allowed-unsafe-sysctls \ +$ kubelet --allowed-unsafe-sysctls \ 'kernel.msg*,net.ipv4.route.min_pmtu' ... ``` @@ -89,10 +91,11 @@ Only _namespaced_ sysctls can be enabled this way. ## Setting Sysctls for a Pod A number of sysctls are _namespaced_ in today's Linux kernels. This means that -they can be set independently for each pod on a node. Being namespaced is a -requirement for sysctls to be accessible in a pod context within Kubernetes. +they can be set independently for each pod on a node. Only namespaced sysctls +are configurable via the pod securityContext within Kubernetes. -The following sysctls are known to be _namespaced_: +The following sysctls are known to be namespaced. This list could change +in future versions of the Linux kernel. - `kernel.shm*`, - `kernel.msg*`, @@ -100,25 +103,37 @@ The following sysctls are known to be _namespaced_: - `fs.mqueue.*`, - `net.*`. -Sysctls which are not namespaced are called _node-level_ and must be set -manually by the cluster admin, either by means of the underlying Linux -distribution of the nodes (e.g. via `/etc/sysctls.conf`) or using a DaemonSet -with privileged containers. +Sysctls with no namespace are called _node-level_ sysctls. If you need to set +them, you must manually configure them on each node's operating system, or by +using a DaemonSet with privileged containers. -The sysctl feature is an alpha API. Therefore, sysctls are set using annotations -on pods. They apply to all containers in the same pod. +Use the pod securityContext to configure namespaced sysctls. The securityContext +applies to all containers in the same pod. -Here is an example, with different annotations for _safe_ and _unsafe_ sysctls: +This example uses the pod securityContext to set a safe sysctl +`kernel.shm_rmid_forced` and two unsafe sysctls `net.ipv4.route.min_pmtu` and +`kernel.msgmax` There is no distinction between _safe_ and _unsafe_ sysctls in +the specification. + +{{< warning >}} +Only modify sysctl parameters after you understand their effects, to avoid +destabilizing your operating system. +{{< /warning >}} ```yaml apiVersion: v1 kind: Pod metadata: name: sysctl-example - annotations: - security.alpha.kubernetes.io/sysctls: kernel.shm_rmid_forced=1 - security.alpha.kubernetes.io/unsafe-sysctls: net.ipv4.route.min_pmtu=1000,kernel.msgmax=1 2 3 spec: + securityContext: + sysctls: + - name: kernel.shm_rmid_forced + value: "0" + - name: net.ipv4.route.min_pmtu + value: "552" + - name: kernel.msgmax + value: "65536" ... ``` {{% /capture %}} @@ -143,27 +158,52 @@ is recommended to use [taints on nodes](/docs/concepts/configuration/taint-and-toleration/) to schedule those pods onto the right nodes. -## PodSecurityPolicy Annotations +## PodSecurityPolicy + +You can further control which sysctls can be set in pods by specifying lists of +sysctls or sysctl patterns in the `forbiddenSysctls` and/or +`allowedUnsafeSysctls` fields of the PodSecurityPolicy. A sysctl pattern ends +with a `*` character, such as `kernel.*`. A `*` character on its own matches +all sysctls. + +By default, all safe sysctls are allowed. + +Both `forbiddenSysctls` and `allowedUnsafeSysctls` are lists of plain sysctl names +or sysctl patterns (which end with `*`). The string `*` matches all sysctls. -The use of sysctl in pods can be controlled via annotation on the PodSecurityPolicy. +The `forbiddenSysctls` field excludes specific sysctls. You can forbid a +combination of safe and unsafe sysctls in the list. To forbid setting any +sysctls, use `*` on its own. -Sysctl annotation represents a whitelist of allowed safe and unsafe sysctls -in a pod spec. It's a comma-separated list of plain sysctl names or sysctl patterns -(which end in `*`). The string `*` matches all sysctls. +If you specify any unsafe sysctl in the `allowedUnsafeSysctls` field and it is +not present in the `forbiddenSysctls` field, that sysctl can be used in Pods +using this PodSecurityPolicy. To allow all unsafe sysctls in the +PodSecurityPolicy to be set, use `*` on its own. -Here is an example, it authorizes binding user creating pod with corresponding sysctls. +Do not configure these two fields such that there is overlap, meaning that a +given sysctl is both allowed and forbidden. + +{{< warning >}} +**Warning**: If you whitelist unsafe sysctls via the `allowedUnsafeSysctls` field +in a PodSecurityPolicy, any pod using such a sysctl will fail to start +if the sysctl is not whitelisted via the `--allowed-unsafe-sysctls` kubelet +flag as well on that node. +{{< /warning >}} + +This example allows unsafe sysctls prefixed with `kernel.msg` to be set and +disallows setting of the `kernel.shm_rmid_forced` sysctl. ```yaml apiVersion: policy/v1beta1 kind: PodSecurityPolicy metadata: name: sysctl-psp - annotations: - security.alpha.kubernetes.io/sysctls: 'net.ipv4.route.*,kernel.msg*' spec: + allowedUnsafeSysctls: + - kernel.msg* + forbiddenSysctls: + - kernel.shm_rmid_forced ... ``` {{% /capture %}} - - diff --git a/content/en/docs/tasks/administer-federation/deployment.md b/content/en/docs/tasks/administer-federation/deployment.md index db1a4043dc6d2..4c73ae39aa699 100644 --- a/content/en/docs/tasks/administer-federation/deployment.md +++ b/content/en/docs/tasks/administer-federation/deployment.md @@ -15,9 +15,10 @@ Deployment](/docs/concepts/workloads/controllers/deployment/) and provide the sa Creating them in the federation control plane ensures that the desired number of replicas exist across the registered clusters. -**As of Kubernetes version 1.5, Federated Deployment is an Alpha feature. The core -functionality of Deployment is present, but some features -(such as full rollout compatibility) are still in development.** +{{< feature-state for_k8s_version="1.5" state="alpha" >}} + +Some features +(such as full rollout compatibility) are still in development. {{% /capture %}} {{% capture prerequisites %}} diff --git a/content/en/docs/tasks/administer-federation/events.md b/content/en/docs/tasks/administer-federation/events.md index 4f1a2f23b5fd1..299d36215aff6 100644 --- a/content/en/docs/tasks/administer-federation/events.md +++ b/content/en/docs/tasks/administer-federation/events.md @@ -1,14 +1,20 @@ --- title: Federated Events +content_template: templates/concept --- +{{% capture overview %}} + {{< include "federation-current-state.md" >}} This guide explains how to use events in federation control plane to help in debugging. +{{% /capture %}} {{< toc >}} +{{% capture body %}} + ## Prerequisites This guide assumes that you have a running Kubernetes Cluster @@ -23,7 +29,7 @@ You are also expected to have a basic [working knowledge of Kubernetes](/docs/setup/) in general. -## Overview +## View federation events Events in federation control plane (referred to as "federation events" in this guide) are very similar to the traditional Kubernetes @@ -39,3 +45,5 @@ kubectl --context=federation-cluster get events ``` The standard kubectl get, update, delete commands will all work. + +{{% /capture %}} diff --git a/content/en/docs/tasks/administer-federation/secret.md b/content/en/docs/tasks/administer-federation/secret.md index 48795b0dd11d6..028a1f1624bfb 100644 --- a/content/en/docs/tasks/administer-federation/secret.md +++ b/content/en/docs/tasks/administer-federation/secret.md @@ -1,13 +1,25 @@ --- title: Federated Secrets +content_template: templates/concept --- +{{% capture overview %}} + {{< include "federation-current-state.md" >}} This guide explains how to use secrets in Federation control plane. +Secrets in federation control plane (referred to as "federated secrets" in +this guide) are very similar to the traditional [Kubernetes +Secrets](/docs/concepts/configuration/secret/) providing the same functionality. +Creating them in the federation control plane ensures that they are synchronized +across all the clusters in federation. +{{% /capture %}} + {{< toc >}} +{{% capture body %}} + ## Prerequisites This guide assumes that you have a running Kubernetes Cluster @@ -22,15 +34,6 @@ You are also expected to have a basic [working knowledge of Kubernetes](/docs/setup/) in general and [Secrets](/docs/concepts/configuration/secret/) in particular. -## Overview - -Secrets in federation control plane (referred to as "federated secrets" in -this guide) are very similar to the traditional [Kubernetes -Secrets](/docs/concepts/configuration/secret/) providing the same functionality. -Creating them in the federation control plane ensures that they are synchronized -across all the clusters in federation. - - ## Creating a Federated Secret The API for Federated Secret is 100% compatible with the @@ -86,3 +89,5 @@ Note that at this point, deleting a federated secret will not delete the corresponding secrets from underlying clusters. You must delete the underlying secrets manually. We intend to fix this in the future. + +{{% /capture %}} diff --git a/content/en/docs/tasks/configure-pod-container/assign-cpu-resource.md b/content/en/docs/tasks/configure-pod-container/assign-cpu-resource.md index 8a6eebb01a932..6c9769ec40311 100644 --- a/content/en/docs/tasks/configure-pod-container/assign-cpu-resource.md +++ b/content/en/docs/tasks/configure-pod-container/assign-cpu-resource.md @@ -20,28 +20,32 @@ but is not allowed to use more CPU than its limit. Each node in your cluster must have at least 1 cpu. -A few of the steps on this page require that the -[Heapster](https://github.com/kubernetes/heapster) service is running -in your cluster. But if you don't have Heapster running, you can do most -of the steps, and it won't be a problem if you skip the Heapster steps. +A few of the steps on this page require you to run the +[metrics-server](https://github.com/kubernetes-incubator/metrics-server) +service in your cluster. If you don't have metrics-server +running, you can skip those steps. -If you are running minikube, run the following command to enable heapster: +If you are running minikube, run the following command to enable +metrics-server: ```shell -minikube addons enable heapster +minikube addons enable metrics-server ``` -To see whether the Heapster service is running, enter this command: +To see whether metrics-server (or another provider of the resource metrics +API, `metrics.k8s.io`) is running, enter this command: ```shell -kubectl get services --namespace=kube-system +kubectl get apiservices ``` -If the heapster service is running, it shows in the output: +If the resource metrics API is available, the output will include a +reference to `metrics.k8s.io`. + ```shell -NAMESPACE NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE -kube-system heapster 10.11.240.9 80/TCP 6d +NAME +v1beta1.metrics.k8s.io ``` {{% /capture %}} @@ -67,7 +71,7 @@ In this exercise, you create a Pod that has one Container. The Container has a C request of 0.5 cpu and a CPU limit of 1 cpu. Here's the configuration file for the Pod: -{{< code file="cpu-request-limit.yaml" >}} +{{< codenew file="pods/resource/cpu-request-limit.yaml" >}} In the configuration file, the `args` section provides arguments for the Container when it starts. The `-cpus "2"` argument tells the Container to attempt to use 2 cpus. @@ -75,7 +79,7 @@ The `-cpus "2"` argument tells the Container to attempt to use 2 cpus. Create the Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/cpu-request-limit.yaml --namespace=cpu-example +kubectl create -f https://k8s.io/examples/pods/resource/cpu-request-limit.yaml --namespace=cpu-example ``` Verify that the Pod's Container is running: @@ -101,26 +105,18 @@ resources: cpu: 500m ``` -Start a proxy so that you can call the heapster service: +Use `kubectl top` to fetch the metrics for the pod: ```shell -kubectl proxy -``` - -In another command window, get the CPU usage rate from the heapster service: - -``` -curl http://localhost:8001/api/v1/namespaces/kube-system/services/heapster/proxy/api/v1/model/namespaces/cpu-example/pods/cpu-demo/metrics/cpu/usage_rate +kubectl top pod cpu-demo --namespace=cpu-example ``` The output shows that the Pod is using 974 millicpu, which is just a bit less than the limit of 1 cpu specified in the Pod's configuration file. -```json -{ - "timestamp": "2017-06-22T18:48:00Z", - "value": 974 -} +``` +NAME CPU(cores) MEMORY(bytes) +cpu-demo 974m ``` Recall that by setting `-cpu "2"`, you configured the Container to attempt to use 2 cpus. @@ -171,12 +167,12 @@ the capacity of any Node in your cluster. Here is the configuration file for a P that has one Container. The Container requests 100 cpu, which is likely to exceed the capacity of any Node in your cluster. -{{< code file="cpu-request-limit-2.yaml" >}} +{{< codenew file="pods/resource/cpu-request-limit-2.yaml" >}} Create the Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/cpu-request-limit-2.yaml --namespace=cpu-example +kubectl create -f https://k8s.io/examples/pods/resource/cpu-request-limit-2.yaml --namespace=cpu-example ``` View the Pod's status: diff --git a/content/en/docs/tasks/configure-pod-container/assign-memory-resource.md b/content/en/docs/tasks/configure-pod-container/assign-memory-resource.md index 451e2123f511e..8d03fc86b9fc9 100644 --- a/content/en/docs/tasks/configure-pod-container/assign-memory-resource.md +++ b/content/en/docs/tasks/configure-pod-container/assign-memory-resource.md @@ -19,28 +19,33 @@ but is not allowed to use more memory than its limit. Each node in your cluster must have at least 300 MiB of memory. -A few of the steps on this page require that the -[Heapster](https://github.com/kubernetes/heapster) service is running -in your cluster. But if you don't have Heapster running, you can do most -of the steps, and it won't be a problem if you skip the Heapster steps. +A few of the steps on this page require you to run the +[metrics-server](https://github.com/kubernetes-incubator/metrics-server) +service in your cluster. If you don't have metrics-server ++running, you can skip those steps. -If you are running minikube, run the following command to enable heapster: +If you are running minikube, run the following command to enable +metrics-server: ```shell -minikube addons enable heapster +minikube addons enable metrics-server ``` -To see whether the Heapster service is running, enter this command: +To see whether metrics-server (or another provider of the resource metrics +API, `metrics.k8s.io`) is running, enter this command: ```shell -kubectl get services --namespace=kube-system +kubectl get apiservices ``` -If the Heapster service is running, it shows in the output: +If the resource metrics API is available, the output will include a +reference to `metrics.k8s.io`. + + ```shell -NAMESPACE NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE -kube-system heapster 10.11.240.9 80/TCP 6d +NAME +v1beta1.metrics.k8s.io ``` {{% /capture %}} @@ -66,7 +71,7 @@ In this exercise, you create a Pod that has one Container. The Container has a m request of 100 MiB and a memory limit of 200 MiB. Here's the configuration file for the Pod: -{{< code file="memory-request-limit.yaml" >}} +{{< codenew file="pods/resource/memory-request-limit.yaml" >}} In the configuration file, the `args` section provides arguments for the Container when it starts. The `"--vm-bytes", "150M"` arguments tell the Container to attempt to allocate 150 MiB of memory. @@ -74,7 +79,7 @@ The `"--vm-bytes", "150M"` arguments tell the Container to attempt to allocate 1 Create the Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/memory-request-limit.yaml --namespace=mem-example +kubectl create -f https://k8s.io/examples/pods/resource/memory-request-limit.yaml --namespace=mem-example ``` Verify that the Pod's Container is running: @@ -103,29 +108,20 @@ resources: ... ``` -Start a proxy so that you can call the Heapster service: +Use `kubectl top` to fetch the metrics for the pod: ```shell -kubectl proxy -``` - -In another command window, get the memory usage from the Heapster service: - -``` -curl http://localhost:8001/api/v1/namespaces/kube-system/services/heapster/proxy/api/v1/model/namespaces/mem-example/pods/memory-demo/metrics/memory/usage +kubectl top pod memory-demo ``` The output shows that the Pod is using about 162,900,000 bytes of memory, which is about 150 MiB. This is greater than the Pod's 100 MiB request, but within the Pod's 200 MiB limit. -```json -{ - "timestamp": "2017-06-20T18:54:00Z", - "value": 162856960 -} ``` - +NAME CPU(cores) MEMORY(bytes) +memory-demo 162856960 +``` Delete your Pod: @@ -146,7 +142,7 @@ In this exercise, you create a Pod that attempts to allocate more memory than it Here is the configuration file for a Pod that has one Container. The Container has a memory request of 50 MiB and a memory limit of 100 MiB. -{{< code file="memory-request-limit-2.yaml" >}} +{{< codenew file="pods/resource/memory-request-limit-2.yaml" >}} In the configuration file, in the `args` section, you can see that the Container will attempt to allocate 250 MiB of memory, which is well above the 100 MiB limit. @@ -154,7 +150,7 @@ will attempt to allocate 250 MiB of memory, which is well above the 100 MiB limi Create the Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/memory-request-limit-2.yaml --namespace=mem-example +kubectl create -f https://k8s.io/examples/pods/resource/memory-request-limit-2.yaml --namespace=mem-example ``` View detailed information about the Pod: @@ -257,12 +253,12 @@ capacity of any Node in your cluster. Here is the configuration file for a Pod t Container. The Container requests 1000 GiB of memory, which is likely to exceed the capacity of any Node in your cluster. -{{< code file="memory-request-limit-3.yaml" >}} +{{< codenew file="pods/resource/memory-request-limit-3.yaml" >}} Create the Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/memory-request-limit-3.yaml --namespace=mem-example +kubectl create -f https://k8s.io/examples/pods/resource/memory-request-limit-3.yaml --namespace=mem-example ``` View the Pod's status: diff --git a/content/en/docs/tasks/configure-pod-container/assign-pods-nodes.md b/content/en/docs/tasks/configure-pod-container/assign-pods-nodes.md index c572b2ff2644e..035d2aac61f47 100644 --- a/content/en/docs/tasks/configure-pod-container/assign-pods-nodes.md +++ b/content/en/docs/tasks/configure-pod-container/assign-pods-nodes.md @@ -57,12 +57,12 @@ This pod configuration file describes a pod that has a node selector, `disktype: ssd`. This means that the pod will get scheduled on a node that has a `disktype=ssd` label. -{{< code file="pod.yaml" >}} +{{< codenew file="pods/pod-nginx.yaml" >}} 1. Use the configuration file to create a pod that will get scheduled on your chosen node: - kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/pod.yaml + kubectl create -f https://k8s.io/examples/pods/pod-nginx.yaml 1. Verify that the pod is running on your chosen node: @@ -80,4 +80,3 @@ Learn more about [labels and selectors](/docs/concepts/overview/working-with-objects/labels/). {{% /capture %}} - diff --git a/content/en/docs/tasks/configure-pod-container/attach-handler-lifecycle-event.md b/content/en/docs/tasks/configure-pod-container/attach-handler-lifecycle-event.md index c85f18bbe1b41..85dc63d6ab704 100644 --- a/content/en/docs/tasks/configure-pod-container/attach-handler-lifecycle-event.md +++ b/content/en/docs/tasks/configure-pod-container/attach-handler-lifecycle-event.md @@ -30,7 +30,7 @@ for the postStart and preStop events. Here is the configuration file for the Pod: -{{< code file="lifecycle-events.yaml" >}} +{{< codenew file="pods/lifecycle-events.yaml" >}} In the configuration file, you can see that the postStart command writes a `message` file to the Container's `/usr/share` directory. The preStop command shuts down @@ -38,7 +38,7 @@ nginx gracefully. This is helpful if the Container is being terminated because o Create the Pod: - kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/lifecycle-events.yaml + kubectl create -f https://k8s.io/examples/pods/lifecycle-events.yaml Verify that the Container in the Pod is running: diff --git a/content/en/docs/tasks/configure-pod-container/configure-liveness-readiness-probes.md b/content/en/docs/tasks/configure-pod-container/configure-liveness-readiness-probes.md index 8a8768302e0b7..d3e09d120837b 100644 --- a/content/en/docs/tasks/configure-pod-container/configure-liveness-readiness-probes.md +++ b/content/en/docs/tasks/configure-pod-container/configure-liveness-readiness-probes.md @@ -38,7 +38,7 @@ liveness probes to detect and remedy such situations. In this exercise, you create a Pod that runs a Container based on the `k8s.gcr.io/busybox` image. Here is the configuration file for the Pod: -{{< code file="exec-liveness.yaml" >}} +{{< codenew file="pods/probe/exec-liveness.yaml" >}} In the configuration file, you can see that the Pod has a single Container. The `periodSeconds` field specifies that the kubelet should perform a liveness @@ -62,7 +62,7 @@ code. After 30 seconds, `cat /tmp/healthy` returns a failure code. Create the Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/exec-liveness.yaml +kubectl create -f https://k8s.io/examples/pods/probe/exec-liveness.yaml ``` Within 30 seconds, view the Pod events: @@ -122,7 +122,7 @@ Another kind of liveness probe uses an HTTP GET request. Here is the configurati file for a Pod that runs a container based on the `k8s.gcr.io/liveness` image. -{{< code file="http-liveness.yaml" >}} +{{< codenew file="pods/probe/http-liveness.yaml" >}} In the configuration file, you can see that the Pod has a single Container. The `periodSeconds` field specifies that the kubelet should perform a liveness @@ -163,7 +163,7 @@ checks will fail, and the kubelet will kill and restart the Container. To try the HTTP liveness check, create a Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/http-liveness.yaml +kubectl create -f https://k8s.io/examples/pods/probe/http-liveness.yaml ``` After 10 seconds, view Pod events to verify that liveness probes have failed and @@ -180,7 +180,7 @@ kubelet will attempt to open a socket to your container on the specified port. If it can establish a connection, the container is considered healthy, if it can’t it is considered a failure. -{{< code file="tcp-liveness-readiness.yaml" >}} +{{< codenew file="pods/probe/tcp-liveness-readiness.yaml" >}} As you can see, configuration for a TCP check is quite similar to an HTTP check. This example uses both readiness and liveness probes. The kubelet will send the @@ -198,7 +198,7 @@ will be restarted. To try the TCP liveness check, create a Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/tcp-liveness-readiness.yaml +kubectl create -f https://k8s.io/examples/pods/probe/tcp-liveness-readiness.yaml ``` After 15 seconds, view Pod events to verify that liveness probes: diff --git a/content/en/docs/tasks/configure-pod-container/configure-persistent-volume-storage.md b/content/en/docs/tasks/configure-pod-container/configure-persistent-volume-storage.md index 7d2e6802e8018..f770eacfbcb90 100644 --- a/content/en/docs/tasks/configure-pod-container/configure-persistent-volume-storage.md +++ b/content/en/docs/tasks/configure-pod-container/configure-persistent-volume-storage.md @@ -62,7 +62,7 @@ to set up Here is the configuration file for the hostPath PersistentVolume: -{{< code file="task-pv-volume.yaml" >}} +{{< codenew file="pods/storage/pv-volume.yaml" >}} The configuration file specifies that the volume is at `/mnt/data` on the cluster's Node. The configuration also specifies a size of 10 gibibytes and @@ -73,7 +73,7 @@ PersistentVolumeClaim requests to this PersistentVolume. Create the PersistentVolume: - kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/task-pv-volume.yaml + kubectl create -f https://k8s.io/examples/pods/storage/pv-volume.yaml View information about the PersistentVolume: @@ -94,11 +94,11 @@ access for at least one Node. Here is the configuration file for the PersistentVolumeClaim: -{{< code file="task-pv-claim.yaml" >}} +{{< codenew file="pods/storage/pv-claim.yaml" >}} Create the PersistentVolumeClaim: - kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/task-pv-claim.yaml + kubectl create -f https://k8s.io/examples/pods/storage/pv-claim.yaml After you create the PersistentVolumeClaim, the Kubernetes control plane looks for a PersistentVolume that satisfies the claim's requirements. If the control @@ -130,7 +130,7 @@ The next step is to create a Pod that uses your PersistentVolumeClaim as a volum Here is the configuration file for the Pod: -{{< code file="task-pv-pod.yaml" >}} +{{< codenew file="pods/storage/pv-pod.yaml" >}} Notice that the Pod's configuration file specifies a PersistentVolumeClaim, but it does not specify a PersistentVolume. From the Pod's point of view, the claim @@ -138,7 +138,7 @@ is a volume. Create the Pod: - kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/task-pv-pod.yaml + kubectl create -f https://k8s.io/examples/pods/storage/pv-pod.yaml Verify that the Container in the Pod is running; diff --git a/content/en/docs/tasks/configure-pod-container/configure-pod-configmap.md b/content/en/docs/tasks/configure-pod-container/configure-pod-configmap.md index e1315a727eb08..da9f205286a20 100644 --- a/content/en/docs/tasks/configure-pod-container/configure-pod-configmap.md +++ b/content/en/docs/tasks/configure-pod-container/configure-pod-configmap.md @@ -45,8 +45,8 @@ For example: ```shell mkdir -p configure-pod-container/configmap/kubectl/ -wget https://k8s.io/docs/tasks/configure-pod-container/configmap/kubectl/game.properties -o configure-pod-container/configmap/kubectl/game.properties -wget https://k8s.io/docs/tasks/configure-pod-container/configmap/kubectl/ui.properties -o configure-pod-container/configmap/kubectl/ui.properties +wget https://k8s.io/docs/tasks/configure-pod-container/configmap/kubectl/game.properties -O configure-pod-container/configmap/kubectl/game.properties +wget https://k8s.io/docs/tasks/configure-pod-container/configmap/kubectl/ui.properties -O configure-pod-container/configmap/kubectl/ui.properties kubectl create configmap game-config --from-file=configure-pod-container/configmap/kubectl/ ``` @@ -157,7 +157,7 @@ Use the option `--from-env-file` to create a ConfigMap from an env-file, for exa # Blank lines are ignored. # There is no special handling of quotation marks (i.e. they will be part of the ConfigMap value)). -wget https://k8s.io/docs/tasks/configure-pod-container/configmap/kubectl/game-env-file.properties -o configure-pod-container/configmap/kubectl/game-env-file.properties +wget https://k8s.io/docs/tasks/configure-pod-container/configmap/kubectl/game-env-file.properties -O configure-pod-container/configmap/kubectl/game-env-file.properties cat configure-pod-container/configmap/kubectl/game-env-file.properties enemies=aliens lives=3 @@ -196,7 +196,7 @@ metadata: When passing `--from-env-file` multiple times to create a ConfigMap from multiple data sources, only the last env-file is used: ```shell -wget https://k8s.io/docs/tasks/configure-pod-container/configmap/kubectl/ui-env-file.properties -o configure-pod-container/configmap/kubectl/ui-env-file.properties +wget https://k8s.io/docs/tasks/configure-pod-container/configmap/kubectl/ui-env-file.properties -O configure-pod-container/configmap/kubectl/ui-env-file.properties kubectl create configmap config-multi-env-files \ --from-env-file=configure-pod-container/configmap/kubectl/game-env-file.properties \ --from-env-file=configure-pod-container/configmap/kubectl/ui-env-file.properties diff --git a/content/en/docs/tasks/configure-pod-container/configure-pod-initialization.md b/content/en/docs/tasks/configure-pod-container/configure-pod-initialization.md index c5ac3a21012d2..6ab76afd09f8e 100644 --- a/content/en/docs/tasks/configure-pod-container/configure-pod-initialization.md +++ b/content/en/docs/tasks/configure-pod-container/configure-pod-initialization.md @@ -26,7 +26,7 @@ container starts. Here is the configuration file for the Pod: -{{< code file="init-containers.yaml" >}} +{{< codenew file="pods/init-containers.yaml" >}} In the configuration file, you can see that the Pod has a Volume that the init container and the application container share. @@ -43,7 +43,7 @@ of the nginx server. Create the Pod: - kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/init-containers.yaml + kubectl create -f https://k8s.io/examples/pods/init-containers.yaml Verify that the nginx container is running: diff --git a/content/en/docs/tasks/configure-pod-container/configure-projected-volume-storage.md b/content/en/docs/tasks/configure-pod-container/configure-projected-volume-storage.md index f12bd37dd8284..19c5ecc7446cf 100644 --- a/content/en/docs/tasks/configure-pod-container/configure-projected-volume-storage.md +++ b/content/en/docs/tasks/configure-pod-container/configure-projected-volume-storage.md @@ -8,7 +8,13 @@ weight: 70 --- {{% capture overview %}} -This page shows how to use a [`projected`](/docs/concepts/storage/volumes/#projected) volume to mount several existing volume sources into the same directory. Currently, `secret`, `configMap`, and `downwardAPI` volumes can be projected. +This page shows how to use a [`projected`](/docs/concepts/storage/volumes/#projected) volume to mount +several existing volume sources into the same directory. Currently, `secret`, `configMap`, `downwardAPI`, +and `serviceAccountToken` volumes can be projected. + +{{< note >}} +`serviceAccountToken` is not a volume type. +{{< /note >}} {{% /capture %}} {{% capture prerequisites %}} @@ -22,7 +28,7 @@ In this exercise, you create username and password Secrets from local files. You Here is the configuration file for the Pod: -{{< code file="projected-volume.yaml" >}} +{{< codenew file="pods/storage/projected.yaml" >}} 1. Create the Secrets: ```shell @@ -36,7 +42,7 @@ Here is the configuration file for the Pod: ``` 1. Create the Pod: ```shell - kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/projected-volume.yaml + kubectl create -f https://k8s.io/examples/pods/storage/projected.yaml ``` 1. Verify that the Pod's Container is running, and then watch for changes to the Pod: diff --git a/content/en/docs/tasks/configure-pod-container/configure-service-account.md b/content/en/docs/tasks/configure-pod-container/configure-service-account.md index 2c96fc6b1523c..1586ceed1ff98 100644 --- a/content/en/docs/tasks/configure-pod-container/configure-service-account.md +++ b/content/en/docs/tasks/configure-pod-container/configure-service-account.md @@ -4,9 +4,11 @@ reviewers: - liggitt - thockin title: Configure Service Accounts for Pods +content_template: templates/task weight: 90 --- +{{% capture overview %}} A service account provides an identity for processes that run in a Pod. *This is a user introduction to Service Accounts. See also the @@ -26,6 +28,18 @@ cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, `default`). +{{% /capture %}} + +{{< toc >}} + +{{% capture prerequisites %}} + +{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + +{{% /capture %}} + +{{% capture steps %}} + ## Use the Default Service Account to access the API server. When you create a pod, if you do not specify a service account, it is @@ -181,7 +195,7 @@ myregistrykey   kubernetes.io/.dockerconfigjson   1       1d Next, modify the default service account for the namespace to use this secret as an imagePullSecret. ```shell -kubectl patch serviceaccount default -p '{\"imagePullSecrets\": [{\"name\": \"acrkey\"}]}' +kubectl patch serviceaccount default -p '{\"imagePullSecrets\": [{\"name\": \"myregistrykey\"}]}' ``` Interactive version requiring manual edit: @@ -233,3 +247,14 @@ spec: TODO: Test and explain how to use additional non-K8s secrets with an existing service account. --> + +## Service Account Volume Projection + +Kubernetes 1.11 and higher supports a new way to project a service account token into a Pod. +You can specify a token request with audiences, expirationSeconds. The service account token +becomes invalid when the Pod is deleted. A Projected Volume named +[ServiceAccountToken](/docs/concepts/storage/volumes/#projected) requests and stores the token. + +{{% /capture %}} + + diff --git a/content/en/docs/tasks/configure-pod-container/configure-volume-storage.md b/content/en/docs/tasks/configure-pod-container/configure-volume-storage.md index e3a73199ae04e..32db31cdbb413 100644 --- a/content/en/docs/tasks/configure-pod-container/configure-volume-storage.md +++ b/content/en/docs/tasks/configure-pod-container/configure-volume-storage.md @@ -33,11 +33,11 @@ Volume of type that lasts for the life of the Pod, even if the Container terminates and restarts. Here is the configuration file for the Pod: -{{< code file="pod-redis.yaml" >}} +{{< codenew file="pods/storage/redis.yaml" >}} 1. Create the Pod: - kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/pod-redis.yaml + kubectl create -f https://k8s.io/examples/pods/storage/redis.yaml 1. Verify that the Pod's Container is running, and then watch for changes to the Pod: diff --git a/content/en/docs/tasks/configure-pod-container/extended-resource.md b/content/en/docs/tasks/configure-pod-container/extended-resource.md index 108927af1e4f6..53484c9f451b7 100644 --- a/content/en/docs/tasks/configure-pod-container/extended-resource.md +++ b/content/en/docs/tasks/configure-pod-container/extended-resource.md @@ -36,14 +36,14 @@ descriptive resource name. Here is the configuration file for a Pod that has one Container: -{{< code file="extended-resource-pod.yaml" >}} +{{< codenew file="pods/resource/extended-resource-pod.yaml" >}} In the configuration file, you can see that the Container requests 3 dongles. Create a Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/extended-resource-pod.yaml +kubectl create -f https://k8s.io/examples/pods/resource/extended-resource-pod.yaml ``` Verify that the Pod is running: @@ -72,7 +72,7 @@ Requests: Here is the configuration file for a Pod that has one Container. The Container requests two dongles. -{{< code file="extended-resource-pod-2.yaml" >}} +{{< codenew file="pods/resource/extended-resource-pod-2.yaml" >}} Kubernetes will not be able to satisfy the request for two dongles, because the first Pod used three of the four available dongles. @@ -80,7 +80,7 @@ used three of the four available dongles. Attempt to create a Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/extended-resource-pod-2.yaml +kubectl create -f https://k8s.io/examples/pods/resource/extended-resource-pod-2.yaml ``` Describe the Pod diff --git a/content/en/docs/tasks/configure-pod-container/mem-limit-range.yaml b/content/en/docs/tasks/configure-pod-container/mem-limit-range.yaml deleted file mode 100644 index b98a5ae262561..0000000000000 --- a/content/en/docs/tasks/configure-pod-container/mem-limit-range.yaml +++ /dev/null @@ -1,11 +0,0 @@ -apiVersion: v1 -kind: LimitRange -metadata: - name: mem-limit-range -spec: - limits: - - default: - memory: 512Mi - defaultRequest: - memory: 256Mi - type: Container diff --git a/content/en/docs/tasks/configure-pod-container/pod.yaml b/content/en/docs/tasks/configure-pod-container/pod.yaml deleted file mode 100644 index 134ddae2aa1c8..0000000000000 --- a/content/en/docs/tasks/configure-pod-container/pod.yaml +++ /dev/null @@ -1,13 +0,0 @@ -apiVersion: v1 -kind: Pod -metadata: - name: nginx - labels: - env: test -spec: - containers: - - name: nginx - image: nginx - imagePullPolicy: IfNotPresent - nodeSelector: - disktype: ssd diff --git a/content/en/docs/tasks/configure-pod-container/pull-image-private-registry.md b/content/en/docs/tasks/configure-pod-container/pull-image-private-registry.md index f5022948945b1..877b577cb86e7 100644 --- a/content/en/docs/tasks/configure-pod-container/pull-image-private-registry.md +++ b/content/en/docs/tasks/configure-pod-container/pull-image-private-registry.md @@ -112,11 +112,11 @@ You have successfully set your Docker credentials as a Secret called `regcred` i Here is a configuration file for a Pod that needs access to your Docker credentials in `regcred`: -{{< code file="private-reg-pod.yaml" >}} +{{< codenew file="pods/private-reg-pod.yaml" >}} Download the above file: - wget -O my-private-reg-pod.yaml https://k8s.io/docs/tasks/configure-pod-container/private-reg-pod.yaml + wget -O my-private-reg-pod.yaml https://k8s.io/examples/pods/private-reg-pod.yaml In file `my-private-reg-pod.yaml`, replace `` with the path to an image in a private registry such as: @@ -142,4 +142,3 @@ Create a Pod that uses your Secret, and verify that the Pod is running: {{% /capture %}} - diff --git a/content/en/docs/tasks/configure-pod-container/quality-service-pod.md b/content/en/docs/tasks/configure-pod-container/quality-service-pod.md index 27356fed82aac..14d44096bc1a5 100644 --- a/content/en/docs/tasks/configure-pod-container/quality-service-pod.md +++ b/content/en/docs/tasks/configure-pod-container/quality-service-pod.md @@ -50,12 +50,12 @@ For a Pod to be given a QoS class of Guaranteed: Here is the configuration file for a Pod that has one Container. The Container has a memory limit and a memory request, both equal to 200 MiB. The Container has a cpu limit and a cpu request, both equal to 700 millicpu: -{{< code file="qos-pod.yaml" >}} +{{< codenew file="pods/qos/qos-pod.yaml" >}} Create the Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/qos-pod.yaml --namespace=qos-example +kubectl create -f https://k8s.io/examples/pods/qos/qos-pod.yaml --namespace=qos-example ``` View detailed information about the Pod: @@ -106,12 +106,12 @@ A Pod is given a QoS class of Burstable if: Here is the configuration file for a Pod that has one Container. The Container has a memory limit of 200 MiB and a memory request of 100 MiB. -{{< code file="qos-pod-2.yaml" >}} +{{< codenew file="pods/qos/qos-pod-2.yaml" >}} Create the Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/qos-pod-2.yaml --namespace=qos-example +kubectl create -f https://k8s.io/examples/pods/qos/qos-pod-2.yaml --namespace=qos-example ``` View detailed information about the Pod: @@ -151,12 +151,12 @@ have any memory or cpu limits or requests. Here is the configuration file for a Pod that has one Container. The Container has no memory or cpu limits or requests: -{{< code file="qos-pod-3.yaml" >}} +{{< codenew file="pods/qos/qos-pod-3.yaml" >}} Create the Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/qos-pod-3.yaml --namespace=qos-example +kubectl create -f https://k8s.io/examples/pods/qos/qos-pod-3.yaml --namespace=qos-example ``` View detailed information about the Pod: @@ -187,7 +187,7 @@ kubectl delete pod qos-demo-3 --namespace=qos-example Here is the configuration file for a Pod that has two Containers. One container specifies a memory request of 200 MiB. The other Container does not specify any requests or limits. -{{< code file="qos-pod-4.yaml" >}} +{{< codenew file="pods/qos/qos-pod-4.yaml" >}} Notice that this Pod meets the criteria for QoS class Burstable. That is, it does not meet the criteria for QoS class Guaranteed, and one of its Containers has a memory request. @@ -195,7 +195,7 @@ criteria for QoS class Guaranteed, and one of its Containers has a memory reques Create the Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/qos-pod-4.yaml --namespace=qos-example +kubectl create -f https://k8s.io/examples/pods/qos/qos-pod-4.yaml --namespace=qos-example ``` View detailed information about the Pod: diff --git a/content/en/docs/tasks/configure-pod-container/rq-compute-resources.yaml b/content/en/docs/tasks/configure-pod-container/rq-compute-resources.yaml deleted file mode 100644 index 9757018f19881..0000000000000 --- a/content/en/docs/tasks/configure-pod-container/rq-compute-resources.yaml +++ /dev/null @@ -1,11 +0,0 @@ -apiVersion: v1 -kind: ResourceQuota -metadata: - name: compute-resources -spec: - hard: - pods: "4" - requests.cpu: "1" - requests.memory: 1Gi - limits.cpu: "2" - limits.memory: 2Gi 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 662ba725a161b..a89e0dfa53380 100644 --- a/content/en/docs/tasks/configure-pod-container/security-context.md +++ b/content/en/docs/tasks/configure-pod-container/security-context.md @@ -49,7 +49,7 @@ in the Pod specification. The `securityContext` field is a The security settings that you specify for a Pod apply to all Containers in the Pod. Here is a configuration file for a Pod that has a `securityContext` and an `emptyDir` volume: -{{< code file="security-context.yaml" >}} +{{< codenew file="pods/security/security-context.yaml" >}} In the configuration file, the `runAsUser` field specifies that for any Containers in the Pod, the first process runs with user ID 1000. The `fsGroup` field specifies that @@ -60,7 +60,7 @@ volume. Create the Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/security-context.yaml +kubectl create -f https://k8s.io/examples/pods/security/security-context.yaml ``` Verify that the Pod's Container is running: @@ -141,12 +141,12 @@ there is overlap. Container settings do not affect the Pod's Volumes. Here is the configuration file for a Pod that has one Container. Both the Pod and the Container have a `securityContext` field: -{{< code file="security-context-2.yaml" >}} +{{< codenew file="pods/security/security-context-2.yaml" >}} Create the Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/security-context-2.yaml +kubectl create -f https://k8s.io/examples/pods/security/security-context-2.yaml ``` Verify that the Pod's Container is running: @@ -194,12 +194,12 @@ of the root user. To add or remove Linux capabilities for a Container, include t First, see what happens when you don't include a `capabilities` field. Here is configuration file that does not add or remove any Container capabilities: -{{< code file="security-context-3.yaml" >}} +{{< codenew file="pods/security/security-context-3.yaml" >}} Create the Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/security-context-3.yaml +kubectl create -f https://k8s.io/examples/pods/security/security-context-3.yaml ``` Verify that the Pod's Container is running: @@ -256,12 +256,12 @@ that it has additional capabilities set. Here is the configuration file for a Pod that runs one Container. The configuration adds the `CAP_NET_ADMIN` and `CAP_SYS_TIME` capabilities: -{{< code file="security-context-4.yaml" >}} +{{< codenew file="pods/security/security-context-4.yaml" >}} Create the Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/security-context-4.yaml +kubectl create -f https://k8s.io/examples/pods/security/security-context-4.yaml ``` Get a shell into the running Container: diff --git a/content/en/docs/tasks/configure-pod-container/share-process-namespace.md b/content/en/docs/tasks/configure-pod-container/share-process-namespace.md index 01b18a6d63dd9..1e8d902384666 100644 --- a/content/en/docs/tasks/configure-pod-container/share-process-namespace.md +++ b/content/en/docs/tasks/configure-pod-container/share-process-namespace.md @@ -39,16 +39,21 @@ across the system: `--feature-gates=PodShareProcessNamespace=true`. Process Namespace Sharing is enabled using the `ShareProcessNamespace` field of `v1.PodSpec`. For example: -{{< code file="share-process-namespace.yaml" >}} +{{< codenew file="pods/share-process-namespace.yaml" >}} 1. Create the pod `nginx` on your cluster: - $ kubectl create -f https://k8s.io/docs/tasks/configure-pod-container/share-process-namespace.yaml + kubectl create -f https://k8s.io/examples/pods/share-process-namespace.yaml 1. Attach to the `shell` container and run `ps`: - $ kubectl attach -it nginx -c shell + ``` + kubectl attach -it nginx -c shell + ``` + If you don't see a command prompt, try pressing enter. + + ``` / # ps ax PID USER TIME COMMAND 1 root 0:00 /pause @@ -56,6 +61,7 @@ Process Namespace Sharing is enabled using the `ShareProcessNamespace` field of 14 101 0:00 nginx: worker process 15 root 0:00 sh 21 root 0:00 ps ax + ``` You can signal processes in other containers. For example, send `SIGHUP` to nginx to restart the worker process. This requires the `SYS_PTRACE` capability. diff --git a/content/en/docs/tasks/configure-pod-container/translate-compose-kubernetes.md b/content/en/docs/tasks/configure-pod-container/translate-compose-kubernetes.md index 634a05628bf05..4b6b3c3042576 100644 --- a/content/en/docs/tasks/configure-pod-container/translate-compose-kubernetes.md +++ b/content/en/docs/tasks/configure-pod-container/translate-compose-kubernetes.md @@ -2,129 +2,33 @@ reviewers: - cdrage title: Translate a Docker Compose File to Kubernetes Resources +content_template: templates/task weight: 170 --- -{{< toc >}} - -# Kubernetes + Compose = Kompose +{{% capture overview %}} What's Kompose? It's a conversion tool for all things compose (namely Docker Compose) to container orchestrators (Kubernetes or OpenShift). More information can be found on the Kompose website at [http://kompose.io](http://kompose.io). -In three simple steps, we'll take you from Docker Compose to Kubernetes. - -__1. Take a sample docker-compose.yaml file__ - -```yaml -version: "2" - -services: - - redis-master: - image: k8s.gcr.io/redis:e2e - ports: - - "6379" - - redis-slave: - image: gcr.io/google_samples/gb-redisslave:v1 - ports: - - "6379" - environment: - - GET_HOSTS_FROM=dns - - frontend: - image: gcr.io/google-samples/gb-frontend:v4 - ports: - - "80:80" - environment: - - GET_HOSTS_FROM=dns - labels: - kompose.service.type: LoadBalancer -``` - -__2. Run `kompose up` in the same directory__ - -```bash -$ kompose up -We are going to create Kubernetes Deployments, Services and PersistentVolumeClaims for your Dockerized application. -If you need different kind of resources, use the 'kompose convert' and 'kubectl create -f' commands instead. - -INFO Successfully created Service: redis -INFO Successfully created Service: web -INFO Successfully created Deployment: redis -INFO Successfully created Deployment: web - -Your application has been deployed to Kubernetes. You can run 'kubectl get deployment,svc,pods,pvc' for details. -``` - -__Alternatively, you can run `kompose convert` and deploy with `kubectl`__ - -__2.1. Run `kompose convert` in the same directory__ +{{% /capture %}} -```bash -$ kompose convert -INFO Kubernetes file "frontend-service.yaml" created -INFO Kubernetes file "redis-master-service.yaml" created -INFO Kubernetes file "redis-slave-service.yaml" created -INFO Kubernetes file "frontend-deployment.yaml" created -INFO Kubernetes file "redis-master-deployment.yaml" created -INFO Kubernetes file "redis-slave-deployment.yaml" created -``` - -__2.2. And start it on Kubernetes!__ - -```bash -$ kubectl create -f frontend-service.yaml,redis-master-service.yaml,redis-slave-service.yaml,frontend-deployment.yaml,redis-master-deployment.yaml,redis-slave-deployment.yaml -service "frontend" created -service "redis-master" created -service "redis-slave" created -deployment "frontend" created -deployment "redis-master" created -deployment "redis-slave" created -``` - -__3. View the newly deployed service__ - -Now that your service has been deployed, let's access it. +{{< toc >}} -If you're already using `minikube` for your development process: +{{% capture prerequisites %}} -```bash -$ minikube service frontend -``` +{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} -Otherwise, let's look up what IP your service is using! +{{% /capture %}} -```sh -$ kubectl describe svc frontend -Name: frontend -Namespace: default -Labels: service=frontend -Selector: service=frontend -Type: LoadBalancer -IP: 10.0.0.183 -LoadBalancer Ingress: 123.45.67.89 -Port: 80 80/TCP -NodePort: 80 31144/TCP -Endpoints: 172.17.0.4:80 -Session Affinity: None -No events. - -``` +{{% capture steps %}} -If you're using a cloud provider, your IP will be listed next to `LoadBalancer Ingress`. - -```sh -$ curl http://123.45.67.89 -``` - -# Installation +## Install Kompose We have multiple ways to install Kompose. Our preferred method is downloading the binary from the latest GitHub release. -#### GitHub release +### GitHub release Kompose is released via GitHub on a three-week cycle, you can see all current releases on the [GitHub release page](https://github.com/kubernetes/kompose/releases). @@ -144,7 +48,7 @@ sudo mv ./kompose /usr/local/bin/kompose Alternatively, you can download the [tarball](https://github.com/kubernetes/kompose/releases). -#### Go +### Go Installing using `go get` pulls from the master branch with the latest development changes. @@ -152,7 +56,7 @@ Installing using `go get` pulls from the master branch with the latest developme go get -u github.com/kubernetes/kompose ``` -#### CentOS +### CentOS Kompose is in [EPEL](https://fedoraproject.org/wiki/EPEL) CentOS repository. If you don't have [EPEL](https://fedoraproject.org/wiki/EPEL) repository already installed and enabled you can do it by running `sudo yum install epel-release` @@ -163,14 +67,14 @@ If you have [EPEL](https://fedoraproject.org/wiki/EPEL) enabled in your system, sudo yum -y install kompose ``` -#### Fedora +### Fedora Kompose is in Fedora 24, 25 and 26 repositories. You can install it just like any other package. ```bash sudo dnf -y install kompose ``` -#### macOS +### macOS On macOS you can install latest release via [Homebrew](https://brew.sh): ```bash @@ -178,7 +82,120 @@ brew install kompose ``` -# User Guide +## Use Kompose + +In just a few steps, we'll take you from Docker Compose to Kubernetes. All +you need is an existing `docker-compose.yml` file. + +1. Go to the directory containing your `docker-compose.yml` file. If you don't + have one, test using this one. + + ```yaml + version: "2" + + services: + + redis-master: + image: k8s.gcr.io/redis:e2e + ports: + - "6379" + + redis-slave: + image: gcr.io/google_samples/gb-redisslave:v1 + ports: + - "6379" + environment: + - GET_HOSTS_FROM=dns + + frontend: + image: gcr.io/google-samples/gb-frontend:v4 + ports: + - "80:80" + environment: + - GET_HOSTS_FROM=dns + labels: + kompose.service.type: LoadBalancer + ``` + +2. Run the `kompose up` command to deploy to Kubernetes directly, or skip to + the next step instead to generate a file to use with `kubectl`. + + ```bash + $ kompose up + We are going to create Kubernetes Deployments, Services and PersistentVolumeClaims for your Dockerized application. + If you need different kind of resources, use the 'kompose convert' and 'kubectl create -f' commands instead. + + INFO Successfully created Service: redis + INFO Successfully created Service: web + INFO Successfully created Deployment: redis + INFO Successfully created Deployment: web + + Your application has been deployed to Kubernetes. You can run 'kubectl get deployment,svc,pods,pvc' for details. + ``` + +3. To convert the `docker-compose.yml` file to files that you can use with + `kubectl`, run `kompose convert` and then `kubectl create -f `. + + ```bash + $ kompose convert + INFO Kubernetes file "frontend-service.yaml" created + INFO Kubernetes file "redis-master-service.yaml" created + INFO Kubernetes file "redis-slave-service.yaml" created + INFO Kubernetes file "frontend-deployment.yaml" created + INFO Kubernetes file "redis-master-deployment.yaml" created + INFO Kubernetes file "redis-slave-deployment.yaml" created + ``` + + ```bash + $ kubectl create -f frontend-service.yaml,redis-master-service.yaml,redis-slave-service.yaml,frontend-deployment.yaml,redis-master-deployment.yaml,redis-slave-deployment.yaml + service "frontend" created + service "redis-master" created + service "redis-slave" created + deployment "frontend" created + deployment "redis-master" created + deployment "redis-slave" created + ``` + + Your deployments are running in Kubernetes. + +4. Access your application. + + If you're already using `minikube` for your development process: + + ```bash + $ minikube service frontend + ``` + + Otherwise, let's look up what IP your service is using! + + ```sh + $ kubectl describe svc frontend + Name: frontend + Namespace: default + Labels: service=frontend + Selector: service=frontend + Type: LoadBalancer + IP: 10.0.0.183 + LoadBalancer Ingress: 123.45.67.89 + Port: 80 80/TCP + NodePort: 80 31144/TCP + Endpoints: 172.17.0.4:80 + Session Affinity: None + No events. + + ``` + + If you're using a cloud provider, your IP will be listed next to `LoadBalancer Ingress`. + + ```sh + $ curl http://123.45.67.89 + ``` + +{{% /capture %}} + +{{% capture discussion %}} + +## User Guide - CLI - [`kompose convert`](#kompose-convert) @@ -393,7 +410,7 @@ services: Using `kompose up` with a `build` key: -```sh +```none $ kompose up INFO Build key detected. Attempting to build and push image 'docker.io/foo/bar' INFO Building image 'docker.io/foo/bar' from directory 'build' @@ -568,3 +585,5 @@ Please note that changing service name might break some `docker-compose` files. Kompose supports Docker Compose versions: 1, 2 and 3. We have limited support on versions 2.1 and 3.2 due to their experimental nature. A full list on compatibility between all three versions is listed in our [conversion document](https://github.com/kubernetes/kompose/blob/master/docs/conversion.md) including a list of all incompatible Docker Compose keys. + +{{% /capture %}} diff --git a/content/en/docs/tasks/debug-application-cluster/audit.md b/content/en/docs/tasks/debug-application-cluster/audit.md index f5c406b9c4f37..f941c16d17942 100644 --- a/content/en/docs/tasks/debug-application-cluster/audit.md +++ b/content/en/docs/tasks/debug-application-cluster/audit.md @@ -3,10 +3,11 @@ reviewers: - soltysh - sttts - ericchiang +content_template: templates/concept title: Auditing --- -{{< toc >}} +{{% capture overview %}} {{< feature-state state="beta" >}} @@ -23,6 +24,12 @@ answer the following questions: - from where was it initiated? - to where was it going? +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + [Kube-apiserver][kube-apiserver] performs auditing. Each request on each stage of its execution generates an event, which is then pre-processed according to a certain policy and written to a backend. The policy determines what's recorded @@ -70,7 +77,7 @@ A policy with no (0) rules is treated as illegal. Below is an example audit policy file: -{{< code file="audit-policy.yaml" >}} +{{< codenew file="audit/audit-policy.yaml" >}} You can use a minimal audit policy file to log all requests at the `Metadata` level: @@ -97,6 +104,7 @@ In both cases, audit events structure is defined by the API in the `audit.k8s.io` API group. The current version of the API is [`v1beta1`][auditing-api]. +{{< note >}} **Note:** In case of patches, request body is a JSON array with patch operations, not a JSON object with an appropriate Kubernetes API object. For example, the following request body is a valid patch request to `/apis/batch/v1/namespaces/some-namespace/jobs/some-job-name`. @@ -114,6 +122,7 @@ request to `/apis/batch/v1/namespaces/some-namespace/jobs/some-job-name`. } ] ``` +{{< /note >}} ### Log backend @@ -200,67 +209,67 @@ In this example, we will use fluentd to split audit events by different namespac 1. install [fluentd, fluent-plugin-forest and fluent-plugin-rewrite-tag-filter][fluentd_install_doc] in the kube-apiserver node 1. create a config file for fluentd - ```shell - $ cat < /etc/fluentd/config - # fluentd conf runs in the same host with kube-apiserver - - @type tail - # audit log path of kube-apiserver - path /var/log/audit - pos_file /var/log/audit.pos - format json - time_key time - time_format %Y-%m-%dT%H:%M:%S.%N%z - tag audit - - - - #https://github.com/fluent/fluent-plugin-rewrite-tag-filter/issues/13 - type record_transformer - enable_ruby - - namespace ${record["objectRef"].nil? ? "none":(record["objectRef"]["namespace"].nil? ? "none":record["objectRef"]["namespace"])} - - - - - # route audit according to namespace element in context - @type rewrite_tag_filter - rewriterule1 namespace ^(.+) ${tag}.$1 - - - - @type record_transformer - remove_keys namespace - - - - @type forest - subtype file - remove_prefix audit - - - ``` + ```none + $ cat < /etc/fluentd/config + # fluentd conf runs in the same host with kube-apiserver + + @type tail + # audit log path of kube-apiserver + path /var/log/audit + pos_file /var/log/audit.pos + format json + time_key time + time_format %Y-%m-%dT%H:%M:%S.%N%z + tag audit + + + + #https://github.com/fluent/fluent-plugin-rewrite-tag-filter/issues/13 + type record_transformer + enable_ruby + + namespace ${record["objectRef"].nil? ? "none":(record["objectRef"]["namespace"].nil? ? "none":record["objectRef"]["namespace"])} + + + + + # route audit according to namespace element in context + @type rewrite_tag_filter + rewriterule1 namespace ^(.+) ${tag}.$1 + + + + @type record_transformer + remove_keys namespace + + + + @type forest + subtype file + remove_prefix audit + + + ``` 1. start fluentd - ```shell - $ fluentd -c /etc/fluentd/config -vv - ``` + ```shell + $ fluentd -c /etc/fluentd/config -vv + ``` 1. start kube-apiserver with the following options: - ```shell - --audit-policy-file=/etc/kubernetes/audit-policy.yaml --audit-log-path=/var/log/kube-audit --audit-log-format=json - ``` + ```shell + --audit-policy-file=/etc/kubernetes/audit-policy.yaml --audit-log-path=/var/log/kube-audit --audit-log-format=json + ``` -1. check audits for different namespaces in /var/log/audit-*.log +1. check audits for different namespaces in `/var/log/audit-*.log` ### Use logstash to collect and distribute audit events from webhook backend @@ -271,69 +280,69 @@ different users into different files. 1. install [logstash][logstash_install_doc] 1. create config file for logstash - ```shell - $ cat < /etc/logstash/config - input{ - http{ - #TODO, figure out a way to use kubeconfig file to authenticate to logstash - #https://www.elastic.co/guide/en/logstash/current/plugins-inputs-http.html#plugins-inputs-http-ssl - port=>8888 - } - } - filter{ - split{ - # Webhook audit backend sends several events together with EventList - # split each event here. - field=>[items] - # We only need event subelement, remove others. - remove_field=>[headers, metadata, apiVersion, "@timestamp", kind, "@version", host] - } - mutate{ - rename => {items=>event} - } - } - output{ - file{ - # Audit events from different users will be saved into different files. - path=>"/var/log/kube-audit-%{[event][user][username]}/audit" - } - } - ``` + ```none + $ cat < /etc/logstash/config + input{ + http{ + #TODO, figure out a way to use kubeconfig file to authenticate to logstash + #https://www.elastic.co/guide/en/logstash/current/plugins-inputs-http.html#plugins-inputs-http-ssl + port=>8888 + } + } + filter{ + split{ + # Webhook audit backend sends several events together with EventList + # split each event here. + field=>[items] + # We only need event subelement, remove others. + remove_field=>[headers, metadata, apiVersion, "@timestamp", kind, "@version", host] + } + mutate{ + rename => {items=>event} + } + } + output{ + file{ + # Audit events from different users will be saved into different files. + path=>"/var/log/kube-audit-%{[event][user][username]}/audit" + } + } + ``` 1. start logstash - ```shell - $ bin/logstash -f /etc/logstash/config --path.settings /etc/logstash/ - ``` + ```shell + $ bin/logstash -f /etc/logstash/config --path.settings /etc/logstash/ + ``` 1. create a [kubeconfig file](/docs/tasks/access-application-cluster/authenticate-across-clusters-kubeconfig/) for kube-apiserver webhook audit backend - ```shell - $ cat < /etc/kubernetes/audit-webhook-kubeconfig - apiVersion: v1 - clusters: - - cluster: - server: http://:8888 - name: logstash - contexts: - - context: - cluster: logstash - user: "" - name: default-context - current-context: default-context - kind: Config - preferences: {} - users: [] - EOF - ``` + ```none + $ cat < /etc/kubernetes/audit-webhook-kubeconfig + apiVersion: v1 + clusters: + - cluster: + server: http://:8888 + name: logstash + contexts: + - context: + cluster: logstash + user: "" + name: default-context + current-context: default-context + kind: Config + preferences: {} + users: [] + EOF + ``` 1. start kube-apiserver with the following options: - ```shell - --audit-policy-file=/etc/kubernetes/audit-policy.yaml --audit-webhook-config-file=/etc/kubernetes/audit-webhook-kubeconfig - ``` + ```shell + --audit-policy-file=/etc/kubernetes/audit-policy.yaml --audit-webhook-config-file=/etc/kubernetes/audit-webhook-kubeconfig + ``` -1. check audits in logstash node's directories /var/log/kube-audit-*/audit +1. check audits in logstash node's directories `/var/log/kube-audit-*/audit` Note that in addition to file output plugin, logstash has a variety of outputs that let users route data where they want. For example, users can emit audit events to elasticsearch @@ -392,3 +401,5 @@ and `audit-log-maxage` options. [logstash]: https://www.elastic.co/products/logstash [logstash_install_doc]: https://www.elastic.co/guide/en/logstash/current/installing-logstash.html [kube-aggregator]: /docs/concepts/api-extension/apiserver-aggregation + +{{% /capture %}} diff --git a/content/en/docs/tasks/debug-application-cluster/core-metrics-pipeline.md b/content/en/docs/tasks/debug-application-cluster/core-metrics-pipeline.md index ea1fd9dcad7b6..53185780f3197 100644 --- a/content/en/docs/tasks/debug-application-cluster/core-metrics-pipeline.md +++ b/content/en/docs/tasks/debug-application-cluster/core-metrics-pipeline.md @@ -3,13 +3,22 @@ reviewers: - fgrzadkowski - piosz title: Core metrics pipeline +content_template: templates/concept --- +{{% capture overview %}} + Starting from Kubernetes 1.8, resource usage metrics, such as container CPU and memory usage, are available in Kubernetes through the Metrics API. These metrics can be either accessed directly by user, for example by using `kubectl top` command, or used by a controller in the cluster, e.g. Horizontal Pod Autoscaler, to make decisions. +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ## The Metrics API Through the Metrics API you can get the amount of resource currently used @@ -25,7 +34,9 @@ The API is no different from any other API: The API is defined in [k8s.io/metrics](https://github.com/kubernetes/metrics/blob/master/pkg/apis/metrics/v1beta1/types.go) repository. You can find more information about the API there. +{{< note >}} **Note:** The API requires metrics server to be deployed in the cluster. Otherwise it will be not available. +{{< /note >}} ## Metrics Server @@ -42,3 +53,5 @@ Metrics Server registered in the main API server through which was introduced in Kubernetes 1.7. Learn more about the metrics server in [the design doc](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/instrumentation/metrics-server.md). + +{{% /capture %}} diff --git a/content/en/docs/tasks/debug-application-cluster/counter-pod.yaml b/content/en/docs/tasks/debug-application-cluster/counter-pod.yaml deleted file mode 100644 index f997886386258..0000000000000 --- a/content/en/docs/tasks/debug-application-cluster/counter-pod.yaml +++ /dev/null @@ -1,10 +0,0 @@ -apiVersion: v1 -kind: Pod -metadata: - name: counter -spec: - containers: - - name: count - image: busybox - args: [/bin/sh, -c, - 'i=0; while true; do echo "$i: $(date)"; i=$((i+1)); sleep 1; done'] diff --git a/content/en/docs/tasks/debug-application-cluster/crictl.md b/content/en/docs/tasks/debug-application-cluster/crictl.md new file mode 100644 index 0000000000000..53874f40a722d --- /dev/null +++ b/content/en/docs/tasks/debug-application-cluster/crictl.md @@ -0,0 +1,326 @@ +--- +reviewers: +- Random-Liu +- feiskyer +- mrunalp +title: Debugging Kubernetes nodes with crictl +content_template: templates/task +--- + +{{< toc >}} + +{{% capture overview %}} + +{{< feature-state for_k8s_version="v1.11" state="stable" >}} + +`crictl` is a command-line interface for CRI-compatible container runtimes. +You can use it to inspect and debug container runtimes and applications on a +Kubernetes node. `crictl` and its source are hosted in the +[cri-tools](https://github.com/kubernetes-incubator/cri-tools) repository. + +{{% /capture %}} + +{{% capture prerequisites %}} + +`crictl` requires a Linux operating system with a CRI runtime. + +{{% /capture %}} + +{{% capture steps %}} + +## Installing crictl + +You can download a compressed archive `crictl` from the cri-tools [release +page](https://github.com/kubernetes-incubator/cri-tools/releases), for several +different architectures. Download the version that corresponds to your version +of Kubernetes. Extract it and move it to a location on your system path, such as +`/usr/local/bin/`. + +## General usage + +The `crictl` command has several subcommands and runtime flags. Use +`crictl help` or `crictl help` for more details. + +`crictl` connects to `unix:///var/run/dockershim.sock` by default. For other +runtimes, you can set the endpoint in multiple different ways: + +- By setting flags `--runtime-endpoint` and `--image-endpoint` +- By setting environment variables `CONTAINER_RUNTIME_ENDPOINT` and `IMAGE_SERVICE_ENDPOINT` +- By setting the endpoint in the config file `--config=/etc/crictl.yaml` + +You can also specify timeout values when connecting to the server and enable or +disable debugging, by specifying `timeout` or `debug` values in the configuration +file or using the `--timeout` and `--debug` command-line flags. + +To view or edit the current configuration, view or edit the contents of +`/etc/crictl.yaml`. + +```sh +$ cat /etc/crictl.yaml +runtime-endpoint: unix:///var/run/dockershim.sock +image-endpoint: unix:///var/run/dockershim.sock +timeout: 10 +debug: true +``` + +## Example crictl commands + +The following examples show some `crictl` commands and and example output. + +{{< warning >}} +If you use `crictl` to create pod sandboxes or containers on a running +Kubernetes cluster, the Kubelet will eventually delete them. `crictl` is not a +general purpose workflow tool, but a tool that is useful for debugging. +{{< /warning >}} + +### List pods + +List all pods: + +```bash +crictl pods +``` +```none +POD ID CREATED STATE NAME NAMESPACE ATTEMPT +926f1b5a1d33a About a minute ago Ready sh-84d7dcf559-4r2gq default 0 +4dccb216c4adb About a minute ago Ready nginx-65899c769f-wv2gp default 0 +a86316e96fa89 17 hours ago Ready kube-proxy-gblk4 kube-system 0 +919630b8f81f1 17 hours ago Ready nvidia-device-plugin-zgbbv kube-system 0 +``` + +List pods by name: + +```bash +crictl pods --name nginx-65899c769f-wv2gp +``` +```none +POD ID CREATED STATE NAME NAMESPACE ATTEMPT +4dccb216c4adb 2 minutes ago Ready nginx-65899c769f-wv2gp default 0 +``` + +List pods by label: + +```bash +crictl pods --label run=nginx +``` +```none +POD ID CREATED STATE NAME NAMESPACE ATTEMPT +4dccb216c4adb 2 minutes ago Ready nginx-65899c769f-wv2gp default 0 +``` + +### List images + +List all images: + +```bash +crictl images +``` +```none +IMAGE TAG IMAGE ID SIZE +busybox latest 8c811b4aec35f 1.15MB +k8s-gcrio.azureedge.net/hyperkube-amd64 v1.10.3 e179bbfe5d238 665MB +k8s-gcrio.azureedge.net/pause-amd64 3.1 da86e6ba6ca19 742kB +nginx latest cd5239a0906a6 109MB +``` + +List images by repository: + +```bash +crictl images nginx +``` +```none +IMAGE TAG IMAGE ID SIZE +nginx latest cd5239a0906a6 109MB +``` + +Only list image IDs: + +```bash +crictl images -q +``` +```none +sha256:8c811b4aec35f259572d0f79207bc0678df4c736eeec50bc9fec37ed936a472a +sha256:e179bbfe5d238de6069f3b03fccbecc3fb4f2019af741bfff1233c4d7b2970c5 +sha256:da86e6ba6ca197bf6bc5e9d900febd906b133eaa4750e6bed647b0fbe50ed43e +sha256:cd5239a0906a6ccf0562354852fae04bc5b52d72a2aff9a871ddb6bd57553569 +``` + +### List containers + +List all containers: + +```bash +crictl ps -a +``` +```none +CONTAINER ID IMAGE CREATED STATE NAME ATTEMPT +1f73f2d81bf98 busybox@sha256:141c253bc4c3fd0a201d32dc1f493bcf3fff003b6df416dea4f41046e0f37d47 7 minutes ago Running sh 1 +9c5951df22c78 busybox@sha256:141c253bc4c3fd0a201d32dc1f493bcf3fff003b6df416dea4f41046e0f37d47 8 minutes ago Exited sh 0 +87d3992f84f74 nginx@sha256:d0a8828cccb73397acb0073bf34f4d7d8aa315263f1e7806bf8c55d8ac139d5f 8 minutes ago Running nginx 0 +1941fb4da154f k8s-gcrio.azureedge.net/hyperkube-amd64@sha256:00d814b1f7763f4ab5be80c58e98140dfc69df107f253d7fdd714b30a714260a 18 hours ago Running kube-proxy 0 +``` + +List running containers: + +```bash +crictl ps +``` +```none +CONTAINER ID IMAGE CREATED STATE NAME ATTEMPT +1f73f2d81bf98 busybox@sha256:141c253bc4c3fd0a201d32dc1f493bcf3fff003b6df416dea4f41046e0f37d47 6 minutes ago Running sh 1 +87d3992f84f74 nginx@sha256:d0a8828cccb73397acb0073bf34f4d7d8aa315263f1e7806bf8c55d8ac139d5f 7 minutes ago Running nginx 0 +1941fb4da154f k8s-gcrio.azureedge.net/hyperkube-amd64@sha256:00d814b1f7763f4ab5be80c58e98140dfc69df107f253d7fdd714b30a714260a 17 hours ago Running kube-proxy 0 +``` + +### Execute a command in a running container + +```bash +crictl exec -i -t 1f73f2d81bf98 ls +``` +```none +bin dev etc home proc root sys tmp usr var +``` + +### Get a coontainer's logs + +Get all container logs: + +```bash +crictl logs 87d3992f84f74 +``` +```none +10.240.0.96 - - [06/Jun/2018:02:45:49 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.47.0" "-" +10.240.0.96 - - [06/Jun/2018:02:45:50 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.47.0" "-" +10.240.0.96 - - [06/Jun/2018:02:45:51 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.47.0" "-" +``` + +Get only the latest `N` lines of logs: + +```bash +crictl logs --tail=1 87d3992f84f74 +``` +```none +10.240.0.96 - - [06/Jun/2018:02:45:51 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.47.0" "-" +``` + +### Run a pod sandbox + +Using `crictl` to run a pod sandbox is useful for debugging container runtimes. +On a running Kubernetes cluster, the sandbox will eventually be stopped and +deleted by the Kubelet. + +1. Create a JSON file like the following: + + ```json + { + "metadata": { + "name": "nginx-sandbox", + "namespace": "default", + "attempt": 1, + "uid": "hdishd83djaidwnduwk28bcsb" + }, + "logDirectory": "/tmp", + "linux": { + } + } + ``` + +2. Use the `crictl runp` command to apply the JSON and run the sandbox. + + ```bash + crictl runp pod-config.json + ``` + + The ID of the sandbox is returned. + +### Create a container + +Using `crictl` to create a container is useful for debugging container runtimes. +On a running Kubernetes cluster, the sandbox will eventually be stopped and +deleted by the Kubelet. + +1. Pull a busybox image + + ```bash + crictl pull busybox + Image is up to date for busybox@sha256:141c253bc4c3fd0a201d32dc1f493bcf3fff003b6df416dea4f41046e0f37d47 + ``` + +2. Create configs for the pod and the container: + + **Pod config**: + ```yaml + { + "metadata": { + "name": "nginx-sandbox", + "namespace": "default", + "attempt": 1, + "uid": "hdishd83djaidwnduwk28bcsb" + }, + "log_directory": "/tmp", + "linux": { + } + } + ``` + + **Container config**: + ```yaml + { + "metadata": { + "name": "busybox" + }, + "image":{ + "image": "busybox" + }, + "command": [ + "top" + ], + "log_path":"busybox/0.log", + "linux": { + } + } + ``` + +3. Create the container, passing the ID of the previously-created pod, the + container config file, and the pod config file. The ID of the container is + returned. + + ```bash + crictl create f84dd361f8dc51518ed291fbadd6db537b0496536c1d2d6c05ff943ce8c9a54f container-config.json pod-config.json + ``` + +4. List all containers and verify that the newly-created container has its + state set to `Created`. + + ```bash + crictl ps -a + ``` + ```none + CONTAINER ID IMAGE CREATED STATE NAME ATTEMPT + 3e025dd50a72d busybox 32 seconds ago Created busybox 0 + ``` + +### Start a container + +To start a container, pass its ID to `crictl start`: + +```bash +crictl start 3e025dd50a72d956c4f14881fbb5b1080c9275674e95fb67f965f6478a957d60 +``` +```none +3e025dd50a72d956c4f14881fbb5b1080c9275674e95fb67f965f6478a957d60 + +$ crictl ps +CONTAINER ID IMAGE CREATED STATE NAME ATTEMPT +3e025dd50a72d busybox About a minute ago Running busybox 0 +``` + +{{% /capture %}} + + +{{% capture discussion %}} + +See [kubernetes-incubator/cri-tools](https://github.com/kubernetes-incubator/cri-tools) +for more information. + +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/tasks/debug-application-cluster/debug-application-introspection.md b/content/en/docs/tasks/debug-application-cluster/debug-application-introspection.md index 07c8a135e5987..fbb7f95d1dffb 100644 --- a/content/en/docs/tasks/debug-application-cluster/debug-application-introspection.md +++ b/content/en/docs/tasks/debug-application-cluster/debug-application-introspection.md @@ -2,25 +2,32 @@ reviewers: - janetkuo - thockin +content_template: templates/concept title: Application Introspection and Debugging --- +{{% capture overview %}} + Once your application is running, you'll inevitably need to debug problems with it. Earlier we described how you can use `kubectl get pods` to retrieve simple status information about your pods. But there are a number of ways to get even more information about your application. +{{% /capture %}} + {{< toc >}} +{{% capture body %}} + ## Using `kubectl describe pod` to fetch details about pods For this example we'll use a Deployment to create two pods, similar to the earlier example. -{{< code file="nginx-dep.yaml" >}} +{{< codenew file="application/nginx-with-request.yaml" >}} Create deployment by running following command: ```shell -$ kubectl create -f https://k8s.io/docs/tasks/debug-application-cluster/nginx-dep.yaml +$ kubectl create -f https://k8s.io/examples/application/nginx-with-request.yaml deployment "nginx-deployment" created ``` @@ -255,7 +262,9 @@ kubernetes-node-861h NotReady 1h v1.6.0+fff5156 kubernetes-node-bols Ready 1h v1.6.0+fff5156 kubernetes-node-st6x Ready 1h v1.6.0+fff5156 kubernetes-node-unaj Ready 1h v1.6.0+fff5156 +``` +```shell $ kubectl describe node kubernetes-node-861h Name: kubernetes-node-861h Role @@ -307,8 +316,12 @@ Allocated resources: ------------ ---------- --------------- ------------- 900m (60%) 2200m (146%) 1009286400 (66%) 5681286400 (375%) Events: +``` +```shell $ kubectl get node kubernetes-node-861h -o yaml +``` +```yaml apiVersion: v1 kind: Node metadata: @@ -350,7 +363,9 @@ status: systemUUID: ABE5F6B4-D44B-108B-C46A-24CCE16C8B6E ``` -## What's next? +{{% /capture %}} + +{{% capture whatsnext %}} Learn about additional debugging tools, including: @@ -359,5 +374,6 @@ Learn about additional debugging tools, including: * [Getting into containers via `exec`](/docs/tasks/debug-application-cluster/get-shell-running-container/) * [Connecting to containers via proxies](/docs/tasks/access-kubernetes-api/http-proxy-access-api/) * [Connecting to containers via port forwarding](/docs/tasks/access-application-cluster/port-forward-access-application-cluster/) +* [Inspect Kubernetes node with crictl](/docs/tasks/debug-application-cluster/crictl/) - +{{% /capture %}} diff --git a/content/en/docs/tasks/debug-application-cluster/debug-application.md b/content/en/docs/tasks/debug-application-cluster/debug-application.md index 829b6e2a1e52a..969be001bd866 100644 --- a/content/en/docs/tasks/debug-application-cluster/debug-application.md +++ b/content/en/docs/tasks/debug-application-cluster/debug-application.md @@ -3,14 +3,21 @@ reviewers: - mikedanese - thockin title: Troubleshoot Applications +content_template: templates/concept --- +{{% capture overview %}} + This guide is to help users debug applications that are deployed into Kubernetes and not behaving correctly. This is *not* a guide for people who want to debug their cluster. For that you should check out [this guide](/docs/admin/cluster-troubleshooting). +{{% /capture %}} + {{< toc >}} +{{% capture body %}} + ## Diagnosing the problem The first step in troubleshooting is triage. What is the problem? Is it your Pods, your Replication Controller or @@ -183,8 +190,12 @@ check: * Can you connect to your pods directly? Get the IP address for the Pod, and try to connect directly to that IP. * Is your application serving on the port that you configured? Kubernetes doesn't do port remapping, so if your application serves on 8080, the `containerPort` field needs to be 8080. -#### More information +{{% /capture %}} + +{{% capture whatsnext %}} If none of the above solves your problem, follow the instructions in [Debugging Service document](/docs/user-guide/debugging-services) to make sure that your `Service` is running, has `Endpoints`, and your `Pods` are actually serving; you have DNS working, iptables rules installed, and kube-proxy does not seem to be misbehaving. You may also visit [troubleshooting document](/docs/troubleshooting/) for more information. + +{{% /capture %}} diff --git a/content/en/docs/tasks/debug-application-cluster/debug-cluster.md b/content/en/docs/tasks/debug-application-cluster/debug-cluster.md index 8031cbc9f86aa..01c4b86a441b2 100644 --- a/content/en/docs/tasks/debug-application-cluster/debug-cluster.md +++ b/content/en/docs/tasks/debug-application-cluster/debug-cluster.md @@ -2,13 +2,22 @@ reviewers: - davidopp title: Troubleshoot Clusters +content_template: templates/concept --- +{{% capture overview %}} + This doc is about cluster troubleshooting; we assume you have already ruled out your application as the root cause of the problem you are experiencing. See the [application troubleshooting guide](/docs/tasks/debug-application-cluster/debug-application) for tips on application debugging. You may also visit [troubleshooting document](/docs/troubleshooting/) for more information. +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ## Listing your cluster The first thing to debug in your cluster is if your nodes are all registered correctly. @@ -113,3 +122,5 @@ Mitigations: - Action: [Multiple independent clusters](/docs/concepts/cluster-administration/federation/) (and avoid making risky changes to all clusters at once) - Mitigates: Everything listed above. + +{{% /capture %}} diff --git a/content/en/docs/tasks/debug-application-cluster/debug-pod-replication-controller.md b/content/en/docs/tasks/debug-application-cluster/debug-pod-replication-controller.md index f196853172492..8aec219b4de64 100644 --- a/content/en/docs/tasks/debug-application-cluster/debug-pod-replication-controller.md +++ b/content/en/docs/tasks/debug-application-cluster/debug-pod-replication-controller.md @@ -2,11 +2,10 @@ reviewers: - bprashanth title: Debug Pods and Replication Controllers +content_template: templates/concept --- -{{< toc >}} - -## Debugging pods +{{% capture overview %}} The first step in debugging a pod is taking a look at it. Check the current state of the pod and recent events with the following command: @@ -18,6 +17,12 @@ there been recent restarts? Continue debugging depending on the state of the pods. +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ### My pod stays pending If a pod is stuck in `Pending` it means that it can not be scheduled onto a @@ -105,3 +110,4 @@ or they can't. If they can't create pods, then please refer to the You can also use `kubectl describe rc ${CONTROLLER_NAME}` to inspect events related to the replication controller. +{{% /capture %}} diff --git a/content/en/docs/tasks/debug-application-cluster/debug-service.md b/content/en/docs/tasks/debug-application-cluster/debug-service.md index 67c72c908d5e7..9b9c4ab8f4db4 100644 --- a/content/en/docs/tasks/debug-application-cluster/debug-service.md +++ b/content/en/docs/tasks/debug-application-cluster/debug-service.md @@ -2,16 +2,22 @@ reviewers: - thockin - bowei +content_template: templates/concept title: Debug Services --- +{{% capture overview %}} An issue that comes up rather frequently for new installations of Kubernetes is that a `Service` is not working properly. You've run your `Deployment` and created a `Service`, but you get no response when you try to access it. This document will hopefully help you to figure out what's going wrong. +{{% /capture %}} + {{< toc >}} +{{% capture body %}} + ## Conventions Throughout this doc you will see various commands that you can run. Some @@ -45,7 +51,7 @@ OUTPUT For many steps here you will want to see what a `Pod` running in the cluster sees. The simplest way to do this is to run an interactive busybox `Pod`: -```shell +```none $ kubectl run -it --rm --restart=Never busybox --image=busybox sh If you don't see a command prompt, try pressing enter. / # @@ -291,6 +297,8 @@ and verify it: ```shell $ kubectl get service hostnames -o json +``` +```json { "kind": "Service", "apiVersion": "v1", @@ -430,7 +438,7 @@ depends on your `Node` OS. On some OSes it is a file, such as /var/log/kube-proxy.log, while other OSes use `journalctl` to access logs. You should see something like: -```shell +```none I1027 22:14:53.995134 5063 server.go:200] Running in resource-only container "/kube-proxy" I1027 22:14:53.998163 5063 server.go:247] Using iptables Proxier. I1027 22:14:53.999055 5063 server.go:255] Tearing down userspace rules. Errors here are acceptable. @@ -584,7 +592,7 @@ the permission to operate in `/sys` on node. If everything works properly, you should see something like: ```shell -u@node$ for intf in /sys/devices/virtual/net/cbr0/brif/*; do cat $intf/hairpin_mode; done +for intf in /sys/devices/virtual/net/cbr0/brif/*; do cat $intf/hairpin_mode; done 1 1 1 @@ -603,7 +611,6 @@ UP BROADCAST RUNNING PROMISC MULTICAST MTU:1460 Metric:1 * Seek help if none of above works out. - ## Seek help If you get this far, something very strange is happening. Your `Service` is @@ -617,7 +624,10 @@ Contact us on [email](https://groups.google.com/forum/#!forum/kubernetes-users) or [GitHub](https://github.com/kubernetes/kubernetes). -## More information +{{% /capture %}} + +{{% capture whatsnext %}} Visit [troubleshooting document](/docs/troubleshooting/) for more information. +{{% /capture %}} diff --git a/content/en/docs/tasks/debug-application-cluster/determine-reason-pod-failure.md b/content/en/docs/tasks/debug-application-cluster/determine-reason-pod-failure.md index fad76987fee84..b684ef2ddfff9 100644 --- a/content/en/docs/tasks/debug-application-cluster/determine-reason-pod-failure.md +++ b/content/en/docs/tasks/debug-application-cluster/determine-reason-pod-failure.md @@ -34,11 +34,11 @@ In this exercise, you create a Pod that runs one container. The configuration file specifies a command that runs when the container starts. -{{< code file="termination.yaml" >}} +{{< codenew file="debug/termination.yaml" >}} 1. Create a Pod based on the YAML configuration file: - kubectl create -f https://k8s.io/docs/tasks/debug-application-cluster/termination.yaml + kubectl create -f https://k8s.io/examples/debug/termination.yaml In the YAML file, in the `cmd` and `args` fields, you can see that the container sleeps for 10 seconds and then writes "Sleep expired" to diff --git a/content/en/docs/tasks/debug-application-cluster/events-stackdriver.md b/content/en/docs/tasks/debug-application-cluster/events-stackdriver.md index 0c3ba613bed6a..cc82d0b834751 100644 --- a/content/en/docs/tasks/debug-application-cluster/events-stackdriver.md +++ b/content/en/docs/tasks/debug-application-cluster/events-stackdriver.md @@ -2,10 +2,11 @@ reviewers: - piosz - x13n +content_template: templates/concept title: Events in Stackdriver --- - +{{% capture overview %}} Kubernetes events are objects that provide insight into what is happening inside a cluster, such as what decisions were made by scheduler or why some @@ -23,18 +24,24 @@ to capture events. This article describes a solution that exports Kubernetes events to Stackdriver Logging, where they can be processed and analyzed. -**Note:** it is not guaranteed that all events happening in a cluster will be +{{< note >}} +**Note:** It is not guaranteed that all events happening in a cluster will be exported to Stackdriver. One possible scenario when events will not be exported is when event exporter is not running (e.g. during restart or upgrade). In most cases it's fine to use events for purposes like setting up [metrics][sdLogMetrics] and [alerts][sdAlerts], but you should be aware of the potential inaccuracy. +{{< /note >}} [sdLogMetrics]: https://cloud.google.com/logging/docs/view/logs_based_metrics [sdAlerts]: https://cloud.google.com/logging/docs/view/logs_based_metrics#creating_an_alerting_policy +{{% /capture %}} + {{< toc >}} +{{% capture body %}} + ## Deployment ### Google Kubernetes Engine @@ -53,7 +60,7 @@ average, approximately 100Mb RAM and 100m CPU is needed. Deploy event exporter to your cluster using the following command: ```shell -kubectl create -f https://k8s.io/docs/tasks/debug-application-cluster/event-exporter-deploy.yaml +kubectl create -f https://k8s.io/examples/debug/event-exporter.yaml ``` Since event exporter accesses the Kubernetes API, it requires permissions to @@ -63,7 +70,7 @@ to allow event exporter to read events. To make sure that event exporter pod will not be evicted from the node, you can additionally set up resource requests. As mentioned earlier, 100Mb RAM and 100m CPU should be enough. -{{< code file="event-exporter-deploy.yaml" >}} +{{< codenew file="debug/event-exporter.yaml" >}} ## User Guide @@ -85,4 +92,6 @@ jsonPayload.source.component="default-scheduler" jsonPayload.involvedObject.name:"nginx-deployment" ``` -Filtered events in the Stackdriver Logging interface +{{< figure src="/images/docs/stackdriver-event-exporter-filter.png" alt="Filtered events in the Stackdriver Logging interface" width="500" >}} + +{{% /capture %}} diff --git a/content/en/docs/tasks/debug-application-cluster/get-shell-running-container.md b/content/en/docs/tasks/debug-application-cluster/get-shell-running-container.md index 41b3ab94e9228..776df8bd400a8 100644 --- a/content/en/docs/tasks/debug-application-cluster/get-shell-running-container.md +++ b/content/en/docs/tasks/debug-application-cluster/get-shell-running-container.md @@ -28,12 +28,12 @@ running Container. In this exercise, you create a Pod that has one Container. The Container runs the nginx image. Here is the configuration file for the Pod: -{{< code file="shell-demo.yaml" >}} +{{< codenew file="application/shell-demo.yaml" >}} Create the Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/debug-application-cluster/shell-demo.yaml +kubectl create -f https://k8s.io/examples/application/shell-demo.yaml ``` Verify that the Container is running: diff --git a/content/en/docs/tasks/debug-application-cluster/logging-elasticsearch-kibana.md b/content/en/docs/tasks/debug-application-cluster/logging-elasticsearch-kibana.md index e7729272070f0..78ef4bfe8f9eb 100644 --- a/content/en/docs/tasks/debug-application-cluster/logging-elasticsearch-kibana.md +++ b/content/en/docs/tasks/debug-application-cluster/logging-elasticsearch-kibana.md @@ -2,9 +2,12 @@ reviewers: - piosz - x13n +content_template: templates/concept title: Logging Using Elasticsearch and Kibana --- +{{% capture overview %}} + On the Google Compute Engine (GCE) platform, the default logging support targets [Stackdriver Logging](https://cloud.google.com/logging/), which is described in detail in the [Logging With Stackdriver Logging](/docs/user-guide/logging/stackdriver). @@ -16,6 +19,10 @@ Stackdriver Logging when running on GCE. Note that Elasticsearch and Kibana cannot be setup automatically in the Kubernetes cluster hosted on Google Kubernetes Engine, you have to deploy it manually. +{{% /capture %}} + +{{% capture body %}} + To use Elasticsearch and Kibana for cluster logging, you should set the following environment variable as shown below when creating your cluster with kube-up.sh: @@ -101,6 +108,11 @@ Here is a typical view of ingested logs from the Kibana viewer: ![Kibana logs](/images/docs/kibana-logs.png) +{{% /capture %}} + +{{% capture whatsnext %}} + Kibana opens up all sorts of powerful options for exploring your logs! For some ideas on how to dig into it, check out [Kibana's documentation](https://www.elastic.co/guide/en/kibana/current/discover.html). +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/tasks/debug-application-cluster/logging-stackdriver.md b/content/en/docs/tasks/debug-application-cluster/logging-stackdriver.md index 9085d4cf946dc..7a0516ba2d0ce 100644 --- a/content/en/docs/tasks/debug-application-cluster/logging-stackdriver.md +++ b/content/en/docs/tasks/debug-application-cluster/logging-stackdriver.md @@ -3,15 +3,26 @@ reviewers: - piosz - x13n title: Logging Using Stackdriver +content_template: templates/concept --- +{{% capture overview %}} + Before reading this page, it's highly recommended to familiarize yourself with the [overview of logging in Kubernetes](/docs/concepts/cluster-administration/logging). +{{< note >}} **Note:** By default, Stackdriver logging collects only your container's standard output and standard error streams. To collect any logs your application writes to a file (for example), see the [sidecar approach](/docs/concepts/cluster-administration/logging#sidecar-container-with-a-logging-agent) in the Kubernetes logging overview. +{{< /note >}} + +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} ## Deploying @@ -85,7 +96,7 @@ than Google Kubernetes Engine. Proceed at your own risk. 1. Deploy a `ConfigMap` with the logging agent configuration by running the following command: ``` - kubectl create -f https://k8s.io/docs/tasks/debug-application-cluster/fluentd-gcp-configmap.yaml + kubectl create -f https://k8s.io/examples/debug/fluentd-gcp-configmap.yaml ``` The command creates the `ConfigMap` in the `default` namespace. You can download the file @@ -94,7 +105,7 @@ than Google Kubernetes Engine. Proceed at your own risk. 1. Deploy the logging agent `DaemonSet` by running the following command: ``` - kubectl create -f https://k8s.io/docs/tasks/debug-application-cluster/fluentd-gcp-ds.yaml + kubectl create -f https://k8s.io/examples/debug/fluentd-gcp-ds.yaml ``` You can download and edit this file before using it as well. @@ -118,16 +129,16 @@ default fluentd-gcp-v2.0 3 3 3 beta.kubernetes.i ``` To understand how logging with Stackdriver works, consider the following -synthetic log generator pod specification [counter-pod.yaml](/docs/tasks/debug-application-cluster/counter-pod.yaml): +synthetic log generator pod specification [counter-pod.yaml](/examples/debug/counter-pod.yaml): -{{< code file="counter-pod.yaml" >}} +{{< codenew file="debug/counter-pod.yaml" >}} This pod specification has one container that runs a bash script that writes out the value of a counter and the date once per second, and runs indefinitely. Let's create this pod in the default namespace. ```shell -kubectl create -f https://k8s.io/docs/tasks/debug-application-cluster/counter-pod.yaml +kubectl create -f https://k8s.io/examples/debug/counter-pod.yaml ``` You can observe the running pod: @@ -164,7 +175,7 @@ pod "counter" deleted and then recreating it: ```shell -$ kubectl create -f https://k8s.io/docs/tasks/debug-application-cluster/counter-pod.yaml +$ kubectl create -f https://k8s.io/examples/debug/counter-pod.yaml pod "counter" created ``` @@ -213,7 +224,7 @@ command line interface from the [Google Cloud SDK](https://cloud.google.com/sdk/ It uses Stackdriver Logging [filtering syntax](https://cloud.google.com/logging/docs/view/advanced_filters) to query specific logs. For example, you can run the following command: -```shell +```none $ gcloud beta logging read 'logName="projects/$YOUR_PROJECT_ID/logs/count"' --format json | jq '.[].textPayload' ... "2: Mon Jan 1 00:01:02 UTC 2001\n" @@ -314,7 +325,7 @@ kubectl get cm fluentd-gcp-config --namespace kube-system -o yaml > fluentd-gcp- ``` Then in the value for the key `containers.input.conf` insert a new filter right after -the `source` section. **Note:** order is important. +the `source` section. **Note:** Order is important. Updating `ConfigMap` in the apiserver is more complicated than updating `DaemonSet`. It's better to consider `ConfigMap` to be immutable. Then, in order to update the configuration, you should @@ -335,3 +346,5 @@ with minor changes: Then run `make build push` from this directory. After updating `DaemonSet` to pick up the new image, you can use the plugin you installed in the fluentd configuration. + +{{% /capture %}} diff --git a/content/en/docs/tasks/debug-application-cluster/monitor-node-health.md b/content/en/docs/tasks/debug-application-cluster/monitor-node-health.md index beab96da8e285..c01307216e4a8 100644 --- a/content/en/docs/tasks/debug-application-cluster/monitor-node-health.md +++ b/content/en/docs/tasks/debug-application-cluster/monitor-node-health.md @@ -2,12 +2,11 @@ reviewers: - Random-Liu - dchen1107 +content_template: templates/task title: Monitor Node Health --- -{{< toc >}} - -## Node Problem Detector +{{% capture overview %}} *Node problem detector* is a [DaemonSet](/docs/concepts/workloads/controllers/daemonset/) monitoring the node health. It collects node problems from various daemons and reports them @@ -24,6 +23,16 @@ introduced to deal with node problems. See more information [here](https://github.com/kubernetes/node-problem-detector). +{{% /capture %}} + +{{% capture prerequisites %}} + +{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + +{{% /capture %}} + +{{% capture steps %}} + ## Limitations * The kernel issue detection of node problem detector only supports file based @@ -55,7 +64,7 @@ customized node problems. * **Step 1:** `node-problem-detector.yaml`: -{{< code file="node-problem-detector.yaml" >}} +{{< codenew file="debug/node-problem-detector.yaml" >}} ***Notice that you should make sure the system log directory is right for your @@ -64,7 +73,7 @@ OS distro.*** * **Step 2:** Start node problem detector with `kubectl`: ```shell - kubectl create -f https://k8s.io/docs/tasks/debug-application-cluster/node-problem-detector.yaml + kubectl create -f https://k8s.io/examples/debug/node-problem-detector.yaml ``` ### Addon Pod @@ -89,14 +98,14 @@ following the steps: node-problem-detector-config --from-file=config/`. * **Step 3:** Change the `node-problem-detector.yaml` to use the ConfigMap: -{{< code file="node-problem-detector-configmap.yaml" >}} +{{< codenew file="debug/node-problem-detector-configmap.yaml" >}} * **Step 4:** Re-create the node problem detector with the new yaml file: ```shell - kubectl delete -f https://k8s.io/docs/tasks/debug-application-cluster/node-problem-detector.yaml # If you have a node-problem-detector running - kubectl create -f https://k8s.io/docs/tasks/debug-application-cluster/node-problem-detector-configmap.yaml + kubectl delete -f https://k8s.io/examples/debug/node-problem-detector.yaml # If you have a node-problem-detector running + kubectl create -f https://k8s.io/examples/debug/node-problem-detector-configmap.yaml ``` ***Notice that this approach only applies to node problem detector started with `kubectl`.*** @@ -153,6 +162,10 @@ Kernel monitor uses [`Translator`](https://github.com/kubernetes/node-problem-de plugin to translate kernel log the internal data structure. It is easy to implement a new translator for a new log format. +{{% /capture %}} + +{{% capture discussion %}} + ## Caveats It is recommended to run the node problem detector in your cluster to monitor @@ -163,3 +176,5 @@ resource overhead on each node. Usually this is fine, because: * Resource limit is set for node problem detector. * Even under high load, the resource usage is acceptable. (see [benchmark result](https://github.com/kubernetes/node-problem-detector/issues/2#issuecomment-220255629)) + +{{% /capture %}} diff --git a/content/en/docs/tasks/debug-application-cluster/resource-usage-monitoring.md b/content/en/docs/tasks/debug-application-cluster/resource-usage-monitoring.md index 6435ebaa9b6ce..5d99079d9ba6e 100644 --- a/content/en/docs/tasks/debug-application-cluster/resource-usage-monitoring.md +++ b/content/en/docs/tasks/debug-application-cluster/resource-usage-monitoring.md @@ -1,18 +1,52 @@ --- reviewers: - mikedanese +content_template: templates/concept title: Tools for Monitoring Compute, Storage, and Network Resources --- -Understanding how an application behaves when deployed is crucial to scaling the application and providing a reliable service. In a Kubernetes cluster, application performance can be examined at many different levels: containers, [pods](/docs/user-guide/pods), [services](/docs/user-guide/services), and whole clusters. As part of Kubernetes we want to provide users with detailed resource usage information about their running applications at all these levels. This will give users deep insights into how their applications are performing and where possible application bottlenecks may be found. In comes [Heapster](https://github.com/kubernetes/heapster), a project meant to provide a base monitoring platform on Kubernetes. +{{% capture overview %}} + +To scale and application and provide a reliable service, you need to +understand how an application behaves when it is deployed. You can examine +application performance in a Kubernetes cluster by examining the containers, +[pods](/docs/user-guide/pods), [services](/docs/user-guide/services), and +the characteristics of the overall cluster. Kubernetes provides detailed +information about an application's resource usage at each of these levels. +This information allows you to evaluate your application's performance and +where bottlenecks can be removed to improve overall performance. + +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + +In Kubernetes, application monitoring does not depend on a single monitoring +solution. On new clusters, you can use two separate pipelines to collect +monitoring statistics by default: + +- The **resource metrics pipeline** provides a limited set of metrics related + to cluster components such as the HorizontalPodAutoscaler controller, as well + as the `kubectl top` utility. These metrics are collected by + [metrics-server](https://github.com/kubernetes-incubator/metrics-server) + and are exposed via the `metrics.k8s.io` API. `metrics-server` discovers + all nodes on the cluster and queries each node's [Kubelet](/docs/admin/kubelet) + for CPU and memory usage. The Kubelet fetches the data from + [cAdvisor](https://github.com/google/cadvisor). `metrics-server` is a + lightweight short-term in-memory store. + +- A **full monitoring pipeline**, such as Prometheus, gives you access to richer + metrics. In addition, Kubernetes can respond to these metrics by automatically + scaling or adapting the cluster based on its current state, using mechanisms + such as the Horizontal Pod Autoscaler. The monitoring pipeline fetches + metrics from the Kubelet, and then exposes them to Kubernetes via an adapter + by implementing either the `custom.metrics.k8s.io` or + `external.metrics.k8s.io` API. See + [Full metrics pipeline](#full-metrics-pipelines) for more information about + some popular pipelines that implement these APIs and enable these + capabilities. -## Overview - -Heapster is a cluster-wide aggregator of monitoring and event data. It currently supports Kubernetes natively and works on all Kubernetes setups. Heapster runs as a pod in the cluster, similar to how any Kubernetes application would run. The Heapster pod discovers all nodes in the cluster and queries usage information from the nodes' [Kubelet](/docs/admin/kubelet/)s, the on-machine Kubernetes agent. The Kubelet itself fetches the data from [cAdvisor](https://github.com/google/cadvisor). Heapster groups the information by pod along with the relevant labels. This data is then pushed to a configurable backend for storage and visualization. Currently supported backends include [InfluxDB](http://influxdb.com/) (with [Grafana](http://grafana.org/) for visualization), [Google Cloud Monitoring](https://cloud.google.com/monitoring/) and many others described in more details [here](https://git.k8s.io/heapster/docs/sink-configuration.md). The overall architecture of the service can be seen below: - -![overall monitoring architecture](/images/docs/monitoring-architecture.png) - -Let's look at some of the other components in more detail. ### cAdvisor @@ -26,38 +60,36 @@ On most Kubernetes clusters, cAdvisor exposes a simple UI for on-machine contain The Kubelet acts as a bridge between the Kubernetes master and the nodes. It manages the pods and containers running on a machine. Kubelet translates each pod into its constituent containers and fetches individual container usage statistics from cAdvisor. It then exposes the aggregated pod resource usage statistics via a REST API. -## Storage Backends - -### InfluxDB and Grafana - -A Grafana setup with InfluxDB is a very popular combination for monitoring in the open source world. InfluxDB exposes an easy to use API to write and fetch time series data. Heapster is setup to use this storage backend by default on most Kubernetes clusters. A detailed setup guide can be found [here](https://github.com/GoogleCloudPlatform/heapster/blob/master/docs/influxdb.md). InfluxDB and Grafana run in Pods. The pod exposes itself as a Kubernetes service which is how Heapster discovers it. +## Full Metrics Pipelines -The Grafana container serves Grafana's UI which provides an easy to configure dashboard interface. The default dashboard for Kubernetes contains an example dashboard that monitors resource usage of the cluster and the pods inside of it. This dashboard can easily be customized and expanded. Take a look at the storage schema for InfluxDB [here](https://github.com/GoogleCloudPlatform/heapster/blob/master/docs/storage-schema.md#metrics). +Many full metrics solutions exist for Kubernetes. Prometheus and Google Cloud +Monitoring are two of the most popular. -Here is a video showing how to monitor a Kubernetes cluster using heapster, InfluxDB and Grafana: +### Prometheus -[![How to monitor a Kubernetes cluster using heapster, InfluxDB and Grafana](http://img.youtube.com/vi/SZgqjMrxo3g/0.jpg)](http://www.youtube.com/watch?v=SZgqjMrxo3g) - -Here is a snapshot of the default Kubernetes Grafana dashboard that shows the CPU and Memory usage of the entire cluster, individual pods and containers: - -![snapshot of the default Kubernetes Grafana dashboard](/images/docs/influx.png) +[Prometheus](https://prometheus.io) can natively monitor kubernetes, nodes, and prometheus itself. +The [Prometheus Operator](https://coreos.com/operators/prometheus/docs/latest/) +simplifies Prometheus setup on Kubernetes, and allows you to serve the +custom metrics API using the +[Prometheus adapter](https://github.com/directxman12/k8s-prometheus-adapter). +Prometheus provides a robust query language and a built-in dashboard for +querying and visualizing your data. Prometheus is also a supported +data source for [Grafana](https://prometheus.io/docs/visualization/grafana/). ### Google Cloud Monitoring -Google Cloud Monitoring is a hosted monitoring service that allows you to visualize and alert on important metrics in your application. Heapster can be setup to automatically push all collected metrics to Google Cloud Monitoring. These metrics are then available in the [Cloud Monitoring Console](https://app.google.stackdriver.com/). This storage backend is the easiest to setup and maintain. The monitoring console allows you to easily create and customize dashboards using the exported data. +Google Cloud Monitoring is a hosted monitoring service you can use to +visualize and alert on important metrics in your application. can collect +metrics from Kubernetes, and you can access them +using the [Cloud Monitoring Console](https://app.google.stackdriver.com/). +You can create and customize dashboards to visualize the data gathered +from your Kubernetes cluster. -Here is a video showing how to setup and run a Google Cloud Monitoring backed Heapster: +This video shows how to configure and run a Google Cloud Monitoring backed Heapster: [![how to setup and run a Google Cloud Monitoring backed Heapster](http://img.youtube.com/vi/xSMNR2fcoLs/0.jpg)](http://www.youtube.com/watch?v=xSMNR2fcoLs) -Here is a snapshot of the Google Cloud Monitoring dashboard showing cluster-wide resource usage. - -![Google Cloud Monitoring dashboard](/images/docs/gcm.png) - -## Try it out! -Now that you've learned a bit about Heapster, feel free to try it out on your own clusters! The [Heapster repository](https://github.com/kubernetes/heapster) is available on GitHub. It contains detailed instructions to setup Heapster and its storage backends. Heapster runs by default on most Kubernetes clusters, so you may already have it! Feedback is always welcome. Please let us know if you run into any issues via the troubleshooting [channels](/docs/troubleshooting/). +{{< figure src="/images/docs/gcm.png" alt="Google Cloud Monitoring dashboard example" title="Google Cloud Monitoring dashboard example" caption="This dashboard shows cluster-wide resource usage." >}} -*** -*Authors: Vishnu Kannan and Victor Marmol, Google Software Engineers.* -*This article was originally posted in [Kubernetes Blog](https://kubernetes.io/blog/2015/05/resource-usage-monitoring-kubernetes).* +{{% /capture %}} diff --git a/content/en/docs/tasks/debug-application-cluster/troubleshooting.md b/content/en/docs/tasks/debug-application-cluster/troubleshooting.md index 073884d16f909..c0d98cfeb29cb 100644 --- a/content/en/docs/tasks/debug-application-cluster/troubleshooting.md +++ b/content/en/docs/tasks/debug-application-cluster/troubleshooting.md @@ -2,9 +2,12 @@ reviewers: - brendandburns - davidopp +content_template: templates/concept title: Troubleshooting --- +{{% capture overview %}} + Sometimes things go wrong. This guide is aimed at making them right. It has two sections: @@ -14,6 +17,12 @@ two sections: You should also check the known issues for the [release](https://github.com/kubernetes/kubernetes/releases) you're using. +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ## Getting help If your problem isn't answered by any of the guides above, there are variety of @@ -93,3 +102,5 @@ problem, such as: * Kubernetes version: `kubectl version` * Cloud provider, OS distro, network configuration, and Docker version * Steps to reproduce the problem + +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/tasks/federation/federation-service-discovery.md b/content/en/docs/tasks/federation/federation-service-discovery.md index 01d0e4b396aae..fc905d76a47b5 100644 --- a/content/en/docs/tasks/federation/federation-service-discovery.md +++ b/content/en/docs/tasks/federation/federation-service-discovery.md @@ -2,9 +2,12 @@ reviewers: - bprashanth - quinton-hoole +content_template: templates/task title: Cross-cluster Service Discovery using Federated Services --- +{{% capture overview %}} + {{< include "federation-current-state.md" >}} This guide explains how to use Kubernetes Federated Services to deploy @@ -13,24 +16,6 @@ easy to achieve cross-cluster service discovery and availability zone fault tolerance for your Kubernetes applications. -{{< toc >}} - -## Prerequisites - -This guide assumes that you have a running Kubernetes Cluster -Federation installation. If not, then head over to the -[federation admin guide](/docs/admin/federation/) to learn how to -bring up a cluster federation (or have your cluster administrator do -this for you). Other tutorials, for example -[this one](https://github.com/kelseyhightower/kubernetes-cluster-federation) -by Kelsey Hightower, are also available to help you. - -You are also expected to have a basic -[working knowledge of Kubernetes](/docs/setup/) in -general, and [Services](/docs/concepts/services-networking/service/) in particular. - -## Overview - Federated Services are created in much that same way as traditional [Kubernetes Services](/docs/concepts/services-networking/service/) by making an API call which specifies the desired properties of your service. In the @@ -52,6 +37,32 @@ automatically find the local shard of the Federated Service in their cluster if it exists and is healthy, or the closest healthy shard in a different cluster if it does not. +{{% /capture %}} + +{{< toc >}} + +{{% capture prerequisites %}} + +{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + +{{% /capture %}} + +{{% capture steps %}} + +## Prerequisites + +This guide assumes that you have a running Kubernetes Cluster +Federation installation. If not, then head over to the +[federation admin guide](/docs/admin/federation/) to learn how to +bring up a cluster federation (or have your cluster administrator do +this for you). Other tutorials, for example +[this one](https://github.com/kelseyhightower/kubernetes-cluster-federation) +by Kelsey Hightower, are also available to help you. + +You are also expected to have a basic +[working knowledge of Kubernetes](/docs/setup/) in +general, and [Services](/docs/concepts/services-networking/service/) in particular. + ## Hybrid cloud capabilities Federations of Kubernetes Clusters can include clusters running in @@ -186,7 +197,7 @@ nameServers: - ns-cloud-a4.googledomains.com. ``` -``` shell +```shell $ gcloud dns record-sets list --zone example-dot-com NAME TYPE TTL DATA example.com. NS 21600 ns-cloud-e1.googledomains.com., ns-cloud-e2.googledomains.com. @@ -257,21 +268,22 @@ With the introduction of Federated Services and Cross-Cluster Service Discovery, this concept is extended to cover Kubernetes services running in any other cluster across your Cluster Federation, globally. To take advantage of this extended range, you use a slightly different -DNS name (of the form "..", -e.g. myservice.mynamespace.myfederation) to resolve Federated -Services. Using a different DNS name also avoids having your existing -applications accidentally traversing cross-zone or cross-region -networks and you incurring perhaps unwanted network charges or -latency, without you explicitly opting in to this behavior. +DNS name of the form ```".."``` +to resolve Federated Services. For example, you might use +`myservice.mynamespace.myfederation`. Using a different DNS name also +avoids having your existing applications accidentally traversing +cross-zone or cross-region networks and you incurring perhaps unwanted +network charges or latency, without you explicitly opting in to this +behavior. So, using our NGINX example service above, and the Federated Service DNS name form just described, let's consider an example: A Pod in a cluster in the `us-central1-f` availability zone needs to contact our NGINX service. Rather than use the service's traditional cluster-local -DNS name (```"nginx.mynamespace"```, which is automatically expanded -to ```"nginx.mynamespace.svc.cluster.local"```) it can now use the +DNS name (`"nginx.mynamespace"`, which is automatically expanded +to `"nginx.mynamespace.svc.cluster.local"`) it can now use the service's Federated DNS name, which is -```"nginx.mynamespace.myfederation"```. This will be automatically +`"nginx.mynamespace.myfederation"`. This will be automatically expanded and resolved to the closest healthy shard of my NGINX service, wherever in the world that may be. If a healthy shard exists in the local cluster, that service's cluster-local (typically @@ -343,9 +355,13 @@ endpoint (see e.g. us-central1 above, which has three alternatives) many clients will fail over automatically to one of the alternative IP's in less time than that given appropriate configuration. +{{% /capture %}} + +{{% capture discussion %}} + ## Troubleshooting -#### I cannot connect to my cluster federation API +### I cannot connect to my cluster federation API Check that your 1. Client (typically kubectl) is correctly configured (including API endpoints and login credentials). @@ -354,16 +370,18 @@ Check that your See the [federation admin guide](/docs/admin/federation/) to learn how to bring up a cluster federation correctly (or have your cluster administrator do this for you), and how to correctly configure your client. -#### I can create a federated service successfully against the cluster federation API, but no matching services are created in my underlying clusters +### I can create a federated service successfully against the cluster federation API, but no matching services are created in my underlying clusters Check that: 1. Your clusters are correctly registered in the Cluster Federation API (`kubectl describe clusters`). -2. Your clusters are all 'Active'. This means that the cluster Federation system was able to connect and authenticate against the clusters' endpoints. If not, consult the logs of the federation-controller-manager pod to ascertain what the failure might be. -```kubectl --namespace=federation logs $(kubectl get pods --namespace=federation -l module=federation-controller-manager -o name)``` +2. Your clusters are all 'Active'. This means that the cluster Federation system was able to connect and authenticate against the clusters' endpoints. If not, consult the logs of the federation-controller-manager pod to ascertain what the failure might be. + ``` + kubectl --namespace=federation logs $(kubectl get pods --namespace=federation -l module=federation-controller-manager -o name) + ``` 3. That the login credentials provided to the Cluster Federation API for the clusters have the correct authorization and quota to create services in the relevant namespace in the clusters. Again you should see associated error messages providing more detail in the above log file if this is not the case. 4. Whether any other error is preventing the service creation operation from succeeding (look for `service-controller` errors in the output of `kubectl logs federation-controller-manager --namespace federation`). -#### I can create a federated service successfully, but no matching DNS records are created in my DNS provider. +### I can create a federated service successfully, but no matching DNS records are created in my DNS provider. Check that: 1. Your federation name, DNS provider, DNS domain name are configured correctly. Consult the [federation admin guide](/docs/admin/federation/) or [tutorial](https://github.com/kelseyhightower/kubernetes-cluster-federation) to learn @@ -371,15 +389,16 @@ how to configure your Cluster Federation system's DNS provider (or have your clu 2. Confirm that the Cluster Federation's service-controller is successfully connecting to and authenticating against your selected DNS provider (look for `service-controller` errors or successes in the output of `kubectl logs federation-controller-manager --namespace federation`). 3. Confirm that the Cluster Federation's service-controller is successfully creating DNS records in your DNS provider (or outputting errors in its logs explaining in more detail what's failing). -#### Matching DNS records are created in my DNS provider, but clients are unable to resolve against those names +### Matching DNS records are created in my DNS provider, but clients are unable to resolve against those names Check that: 1. The DNS registrar that manages your federation DNS domain has been correctly configured to point to your configured DNS provider's nameservers. See for example [Google Domains Documentation](https://support.google.com/domains/answer/3290309?hl=en&ref_topic=3251230) and [Google Cloud DNS Documentation](https://cloud.google.com/dns/update-name-servers), or equivalent guidance from your domain registrar and DNS provider. -#### This troubleshooting guide did not help me solve my problem +### This troubleshooting guide did not help me solve my problem -1. Please use one of our [support channels](/docs/tasks/debug-application-cluster/troubleshooting/) to seek assistance. +1. Please use one of our [support channels](/docs/tasks/debug-application-cluster/troubleshooting/) to seek assistance. ## For more information * [Federation proposal](https://git.k8s.io/community/contributors/design-proposals/multicluster/federation.md) details use cases that motivated this work. +{{% /capture %}} diff --git a/content/en/docs/tasks/federation/set-up-cluster-federation-kubefed.md b/content/en/docs/tasks/federation/set-up-cluster-federation-kubefed.md index bba21741bc197..3b9be17f39238 100644 --- a/content/en/docs/tasks/federation/set-up-cluster-federation-kubefed.md +++ b/content/en/docs/tasks/federation/set-up-cluster-federation-kubefed.md @@ -1,13 +1,13 @@ --- reviewers: - madhusudancs +content_template: templates/task title: Set up Cluster Federation with Kubefed --- +{{% capture overview %}} {{< include "federation-current-state.md" >}} -{{< toc >}} - Kubernetes version 1.5 and above includes a new command line tool called [`kubefed`](/docs/admin/kubefed/) to help you administrate your federated clusters. `kubefed` helps you to deploy a new Kubernetes cluster federation @@ -19,6 +19,18 @@ using `kubefed`. > Note: `kubefed` is a beta feature in Kubernetes 1.6. +{{% /capture %}} + +{{< toc >}} + +{{% capture prerequisites %}} + +{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + +{{% /capture %}} + +{{% capture steps %}} + ## Prerequisites This guide assumes that you have a running Kubernetes cluster. Please @@ -535,3 +547,5 @@ kubectl delete ns federation-system --context=rivendell Note that `rivendell` is the host cluster name, replace that with the appropriate name in your configuration. + +{{% /capture %}} diff --git a/content/en/docs/tasks/inject-data-application/commands.yaml b/content/en/docs/tasks/inject-data-application/commands.yaml deleted file mode 100644 index 2327d2582745f..0000000000000 --- a/content/en/docs/tasks/inject-data-application/commands.yaml +++ /dev/null @@ -1,13 +0,0 @@ -apiVersion: v1 -kind: Pod -metadata: - name: command-demo - labels: - purpose: demonstrate-command -spec: - containers: - - name: command-demo-container - image: debian - command: ["printenv"] - args: ["HOSTNAME", "KUBERNETES_PORT"] - restartPolicy: OnFailure diff --git a/content/en/docs/tasks/inject-data-application/define-command-argument-container.md b/content/en/docs/tasks/inject-data-application/define-command-argument-container.md index df2ca34a9c244..a1e0a0bae67c0 100644 --- a/content/en/docs/tasks/inject-data-application/define-command-argument-container.md +++ b/content/en/docs/tasks/inject-data-application/define-command-argument-container.md @@ -37,11 +37,11 @@ with your new arguments. In this exercise, you create a Pod that runs one container. The configuration file for the Pod defines a command and two arguments: -{{< code file="commands.yaml" >}} +{{< codenew file="pods/commands.yaml" >}} 1. Create a Pod based on the YAML configuration file: - kubectl create -f https://k8s.io/docs/tasks/inject-data-application/commands.yaml + kubectl create -f https://k8s.io/examples/pods/commands.yaml 1. List the running Pods: @@ -140,4 +140,3 @@ Here are some examples: {{% /capture %}} - diff --git a/content/en/docs/tasks/inject-data-application/define-environment-variable-container.md b/content/en/docs/tasks/inject-data-application/define-environment-variable-container.md index 7b7820ecca0a8..8d3e3bdab5b2f 100644 --- a/content/en/docs/tasks/inject-data-application/define-environment-variable-container.md +++ b/content/en/docs/tasks/inject-data-application/define-environment-variable-container.md @@ -32,11 +32,11 @@ file for the Pod defines an environment variable with name `DEMO_GREETING` and value `"Hello from the environment"`. Here is the configuration file for the Pod: -{{< code file="envars.yaml" >}} +{{< codenew file="pods/inject/envars.yaml" >}} 1. Create a Pod based on the YAML configuration file: - kubectl create -f https://k8s.io/docs/tasks/inject-data-application/envars.yaml + kubectl create -f https://k8s.io/examples/pods/inject/envars.yaml 1. List the running Pods: diff --git a/content/en/docs/tasks/inject-data-application/distribute-credentials-secure.md b/content/en/docs/tasks/inject-data-application/distribute-credentials-secure.md index 09c2fcc338650..58380b735df55 100644 --- a/content/en/docs/tasks/inject-data-application/distribute-credentials-secure.md +++ b/content/en/docs/tasks/inject-data-application/distribute-credentials-secure.md @@ -35,18 +35,12 @@ and the base-64 representation of your password is `Mzk1MjgkdmRnN0pi`. Here is a configuration file you can use to create a Secret that holds your username and password: -{{< code file="secret.yaml" >}} +{{< codenew file="pods/inject/secret.yaml" >}} 1. Create the Secret - kubectl create -f https://k8s.io/docs/tasks/inject-data-application/secret.yaml + kubectl create -f https://k8s.io/examples/pods/inject/secret.yaml - {{< note >}} - **Note:** If you want to skip the Base64 encoding step, you can create a Secret - by using the `kubectl create secret` command: - {{< /note >}} - - kubectl create secret generic test-secret --from-literal=username='my-app' --from-literal=password='39528$vdg7Jb' 1. View information about the Secret: @@ -76,15 +70,25 @@ username and password: password: 13 bytes username: 7 bytes + +{{< note >}} +**Note:** If you want to skip the Base64 encoding step, you can create a Secret +by using the `kubectl create secret` command: +{{< /note >}} + +```shell +kubectl create secret generic test-secret --from-literal=username='my-app' --from-literal=password='39528$vdg7Jb' +``` + ## Create a Pod that has access to the secret data through a Volume Here is a configuration file you can use to create a Pod: -{{< code file="secret-pod.yaml" >}} +{{< codenew file="pods/inject/secret-pod.yaml" >}} 1. Create the Pod: - kubectl create -f https://k8s.io/docs/tasks/inject-data-application/secret-pod.yaml + kubectl create -f https://k8s.io/examples/pods/inject/secret-pod.yaml 1. Verify that your Pod is running: @@ -127,11 +131,11 @@ is exposed: Here is a configuration file you can use to create a Pod: -{{< code file="secret-envars-pod.yaml" >}} +{{< codenew file="pods/inject/secret-envars-pod.yaml" >}} 1. Create the Pod: - kubectl create -f https://k8s.io/docs/tasks/inject-data-application/secret-envars-pod.yaml + kubectl create -f https://k8s.io/examples/pods/inject/secret-envars-pod.yaml 1. Verify that your Pod is running: diff --git a/content/en/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information.md b/content/en/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information.md index b9927177045ed..07c882500e639 100644 --- a/content/en/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information.md +++ b/content/en/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information.md @@ -36,7 +36,7 @@ Together, these two ways of exposing Pod and Container fields are called the In this exercise, you create a Pod that has one Container. Here is the configuration file for the Pod: -{{< code file="dapi-volume.yaml" >}} +{{< codenew file="pods/inject/dapi-volume.yaml" >}} In the configuration file, you can see that the Pod has a `downwardAPI` Volume, and the Container mounts the Volume at `/etc/podinfo`. @@ -56,7 +56,7 @@ fields of the Container in the Pod. Create the Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/inject-data-application/dapi-volume.yaml +kubectl create -f https://k8s.io/examples/pods/inject/dapi-volume.yaml ``` Verify that Container in the Pod is running: @@ -156,7 +156,7 @@ The preceding exercise, you stored Pod fields in a DownwardAPIVolumeFile. In this next exercise, you store Container fields. Here is the configuration file for a Pod that has one Container: -{{< code file="dapi-volume-resources.yaml" >}} +{{< codenew file="pods/inject/dapi-volume-resources.yaml" >}} In the configuration file, you can see that the Pod has a `downwardAPI` Volume, and the Container mounts the Volume at `/etc/podinfo`. @@ -171,7 +171,7 @@ should be stored in a file named `cpu_limit`. Create the Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/inject-data-application/dapi-volume-resources.yaml +kubectl create -f https://k8s.io/examples/pods/inject/dapi-volume-resources.yaml ``` Get a shell into the Container that is running in your Pod: diff --git a/content/en/docs/tasks/inject-data-application/environment-variable-expose-pod-information.md b/content/en/docs/tasks/inject-data-application/environment-variable-expose-pod-information.md index ee4a959949ea8..cb82dd37582a9 100644 --- a/content/en/docs/tasks/inject-data-application/environment-variable-expose-pod-information.md +++ b/content/en/docs/tasks/inject-data-application/environment-variable-expose-pod-information.md @@ -38,7 +38,7 @@ Together, these two ways of exposing Pod and Container fields are called the In this exercise, you create a Pod that has one Container. Here is the configuration file for the Pod: -{{< code file="dapi-envars-pod.yaml" >}} +{{< codenew file="pods/inject/dapi-envars-pod.yaml" >}} In the configuration file, you can see five environment variables. The `env` field is an array of @@ -55,7 +55,7 @@ Container in the Pod. Create the Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/inject-data-application/dapi-envars-pod.yaml +kubectl create -f https://k8s.io/examples/pods/inject/dapi-envars-pod.yaml ``` Verify that the Container in the Pod is running: @@ -117,7 +117,7 @@ variables. In this next exercise, you use Container fields as the values for environment variables. Here is the configuration file for a Pod that has one container: -{{< code file="dapi-envars-container.yaml" >}} +{{< codenew file="pods/inject/dapi-envars-container.yaml" >}} In the configuration file, you can see four environment variables. The `env` field is an array of @@ -130,7 +130,7 @@ from Container fields. Create the Pod: ```shell -kubectl create -f https://k8s.io/docs/tasks/inject-data-application/dapi-envars-container.yaml +kubectl create -f https://k8s.io/examples/pods/inject/dapi-envars-container.yaml ``` Verify that the Container in the Pod is running: @@ -168,6 +168,3 @@ The output shows the values of selected environment variables: {{% /capture %}} - - - diff --git a/content/en/docs/tasks/inject-data-application/podpreset.md b/content/en/docs/tasks/inject-data-application/podpreset.md index 0a37c92e974b1..d64512751b9fa 100644 --- a/content/en/docs/tasks/inject-data-application/podpreset.md +++ b/content/en/docs/tasks/inject-data-application/podpreset.md @@ -2,17 +2,31 @@ reviewers: - jessfraz title: Inject Information into Pods Using a PodPreset +content_template: templates/task weight: 60 --- +{{% capture overview %}} + You can use a `podpreset` object to inject information like secrets, volume mounts, and environment variables etc into pods at creation time. This task shows some examples on using the `PodPreset` resource. -You can get an overview of PodPresets at -[Understanding Pod Presets](/docs/concepts/workloads/pods/podpreset/). + +{{% /capture %}} {{< toc >}} +{{% capture prerequisites %}} + +Get an overview of PodPresets at +[Understanding Pod Presets](/docs/concepts/workloads/pods/podpreset/). + +{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + +{{% /capture %}} + +{{% capture steps %}} + ## Create a Pod Preset ### Simple Pod Spec Example @@ -20,12 +34,12 @@ You can get an overview of PodPresets at This is a simple example to show how a Pod spec is modified by the Pod Preset. -{{< code file="podpreset-preset.yaml" >}} +{{< codenew file="podpreset/preset.yaml" >}} Create the PodPreset: ```shell -kubectl create -f https://k8s.io/docs/tasks/inject-data-application/podpreset-preset.yaml +kubectl create -f https://k8s.io/examples/podpreset/preset.yaml ``` Examine the created PodPreset: @@ -38,12 +52,12 @@ allow-database 1m The new PodPreset will act upon any pod that has label `role: frontend`. -{{< code file="podpreset-pod.yaml" >}} +{{< codenew file="podpreset/pod.yaml" >}} Create a pod: ```shell -$ kubectl create -f https://k8s.io/docs/tasks/inject-data-application/podpreset-pod.yaml +$ kubectl create -f https://k8s.io/examples/podpreset/pod.yaml ``` List the running Pods: @@ -56,7 +70,7 @@ website 1/1 Running 0 4m **Pod spec after admission controller:** -{{< code file="podpreset-merged.yaml" >}} +{{< codenew file="podpreset/merged.yaml" >}} To see above output, run the following command: @@ -71,19 +85,19 @@ that defines a `ConfigMap` for Environment Variables. **User submitted pod spec:** -{{< code file="podpreset-pod.yaml" >}} +{{< codenew file="podpreset/pod.yaml" >}} **User submitted `ConfigMap`:** -{{< code file="podpreset-configmap.yaml" >}} +{{< codenew file="podpreset/configmap.yaml" >}} **Example Pod Preset:** -{{< code file="podpreset-allow-db.yaml" >}} +{{< codenew file="podpreset/allow-db.yaml" >}} **Pod spec after admission controller:** -{{< code file="podpreset-allow-db-merged.yaml" >}} +{{< codenew file="podpreset/allow-db-merged.yaml" >}} ### ReplicaSet with Pod Spec Example @@ -92,18 +106,18 @@ Preset. **User submitted ReplicaSet:** -{{< code file="podpreset-replicaset.yaml" >}} +{{< codenew file="podpreset/replicaset.yaml" >}} **Example Pod Preset:** -{{< code file="podpreset-preset.yaml" >}} +{{< codenew file="podpreset/preset.yaml" >}} **Pod spec after admission controller:** Note that the ReplicaSet spec was not changed, users have to check individual pods to validate that the PodPreset has been applied. -{{< code file="podpreset-replicaset-merged.yaml" >}} +{{< codenew file="podpreset/replicaset-merged.yaml" >}} ### Multiple PodPreset Example @@ -112,19 +126,19 @@ Injection Policies. **User submitted pod spec:** -{{< code file="podpreset-pod.yaml" >}} +{{< codenew file="podpreset/pod.yaml" >}} **Example Pod Preset:** -{{< code file="podpreset-preset.yaml" >}} +{{< codenew file="podpreset/preset.yaml" >}} **Another Pod Preset:** -{{< code file="podpreset-proxy.yaml" >}} +{{< codenew file="podpreset/proxy.yaml" >}} **Pod spec after admission controller:** -{{< code file="podpreset-multi-merged.yaml" >}} +{{< codenew file="podpreset/multi-merged.yaml" >}} ### Conflict Example @@ -133,15 +147,15 @@ when there is a conflict. **User submitted pod spec:** -{{< code file="podpreset-conflict-pod.yaml" >}} +{{< codenew file="podpreset/conflict-pod.yaml" >}} **Example Pod Preset:** -{{< code file="podpreset-conflict-preset.yaml" >}} +{{< codenew file="podpreset/conflict-preset.yaml" >}} **Pod spec after admission controller will not change because of the conflict:** -{{< code file="podpreset-conflict-pod.yaml" >}} +{{< codenew file="podpreset/conflict-pod.yaml" >}} **If we run `kubectl describe...` we can see the event:** @@ -162,3 +176,4 @@ $ kubectl delete podpreset allow-database podpreset "allow-database" deleted ``` +{{% /capture %}} diff --git a/content/en/docs/tasks/job/_index.md b/content/en/docs/tasks/job/_index.md old mode 100755 new mode 100644 diff --git a/content/en/docs/tasks/job/automated-tasks-with-cron-jobs.md b/content/en/docs/tasks/job/automated-tasks-with-cron-jobs.md old mode 100755 new mode 100644 index dc8cc0d9fd28f..959f8183d5486 --- a/content/en/docs/tasks/job/automated-tasks-with-cron-jobs.md +++ b/content/en/docs/tasks/job/automated-tasks-with-cron-jobs.md @@ -18,7 +18,7 @@ Cron jobs can also schedule individual tasks for a specific time, such as if you You should switch to using `batch/v1beta1`, instead, which is enabled by default in the API server. Examples in this document use `batch/v1beta1` in all examples. -Cron jobs have limitations and idiosyncracies. +Cron jobs have limitations and idiosyncrasies. For example, in certain circumstances, a single cron job can create multiple jobs. Therefore, jobs should be idempotent. For more limitations, see [CronJobs](/docs/concepts/workloads/controllers/cron-jobs). @@ -43,7 +43,7 @@ component. Cron jobs require a config file. This example cron job config `.spec` file prints the current time and a hello message every minute: -{{< code file="cronjob.yaml" >}} +{{< codenew file="application/job/cronjob.yaml" >}} Run the example cron job by downloading the example file and then running this command: @@ -93,7 +93,7 @@ Note that the job name and pod name are different. ```shell # Replace "hello-4111706356" with the job name in your system -$ pods=$(kubectl get pods --selector=job-name=hello-4111706356 --output=jsonpath={.items..metadata.name}) +$ pods=$(kubectl get pods --show-all --selector=job-name=hello-4111706356 --output=jsonpath={.items..metadata.name}) $ echo $pods hello-4111706356-o9qcm diff --git a/content/en/docs/tasks/job/coarse-parallel-processing-work-queue.md b/content/en/docs/tasks/job/coarse-parallel-processing-work-queue.md index 2fde1b5e72bde..9381e26c2daff 100644 --- a/content/en/docs/tasks/job/coarse-parallel-processing-work-queue.md +++ b/content/en/docs/tasks/job/coarse-parallel-processing-work-queue.md @@ -1,20 +1,19 @@ --- title: Coarse Parallel Processing Using a Work Queue +content_template: templates/task weight: 30 --- {{< toc >}} -# Example: Job with Work Queue with Pod Per Work Item +{{% capture overview %}} In this example, we will run a Kubernetes Job with multiple parallel -worker processes. You may want to be familiar with the basic, -non-parallel, use of [Job](/docs/concepts/jobs/run-to-completion-finite-workloads/) first. +worker processes. In this example, as each pod is created, it picks up one unit of work from a task queue, completes it, deletes it from the queue, and exits. - Here is an overview of the steps in this example: 1. **Start a message queue service.** In this example, we use RabbitMQ, but you could use another @@ -24,6 +23,21 @@ Here is an overview of the steps in this example: 1. **Start a Job that works on tasks from the queue**. The Job starts several pods. Each pod takes one task from the message queue, processes it, and repeats until the end of the queue is reached. +{{% /capture %}} + +{{< toc >}} + +{{% capture prerequisites %}} + +Be familiar with the basic, +non-parallel, use of [Job](/docs/concepts/jobs/run-to-completion-finite-workloads/). + +{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + +{{% /capture %}} + +{{% capture steps %}} + ## Starting a message queue service This example uses RabbitMQ, but it should be easy to adapt to another AMQP-type message service. @@ -167,13 +181,13 @@ We will use the `amqp-consume` utility to read the message from the queue and run our actual program. Here is a very simple example program: -{{< code language="python" file="coarse-parallel-processing-work-queue/worker.py" >}} +{{< codenew language="python" file="application/job/rabbitmq/worker.py" >}} Now, build an image. If you are working in the source tree, then change directory to `examples/job/work-queue-1`. Otherwise, make a temporary directory, change to it, -download the [Dockerfile](Dockerfile?raw=true), -and [worker.py](worker.py?raw=true). In either case, +download the [Dockerfile](/examples/application/job/rabbitmq/Dockerfile), +and [worker.py](/examples/application/job/rabbitmq/worker.py). In either case, build the image with this command: ```shell @@ -205,7 +219,7 @@ Here is a job definition. You'll need to make a copy of the Job and edit the image to match the name you used, and call it `./job.yaml`. -{{< code file="coarse-parallel-processing-work-queue/job.yaml" >}} +{{< codenew file="application/job/rabbitmq/job.yaml" >}} In this example, each pod works on one item from the queue and then exits. So, the completion count of the Job corresponds to the number of work items @@ -260,6 +274,9 @@ Events: All our pods succeeded. Yay. +{{% /capture %}} + +{{% capture discussion %}} ## Alternatives @@ -295,3 +312,5 @@ that the message is acknowledged by the amqp-consume command and the time that t exits with success, or if the node crashes before the kubelet is able to post the success of the pod back to the api-server, then the Job will not appear to be complete, even though all items in the queue have been processed. + +{{% /capture %}} diff --git a/content/en/docs/tasks/job/fine-parallel-processing-work-queue.md b/content/en/docs/tasks/job/fine-parallel-processing-work-queue.md index ea8612ce5225d..8cf0d527cf024 100644 --- a/content/en/docs/tasks/job/fine-parallel-processing-work-queue.md +++ b/content/en/docs/tasks/job/fine-parallel-processing-work-queue.md @@ -1,20 +1,17 @@ --- title: Fine Parallel Processing Using a Work Queue +content_template: templates/task weight: 40 --- -{{< toc >}} - -# Example: Job with Work Queue with Multiple Work Items Per Pod +{{% capture overview %}} In this example, we will run a Kubernetes Job with multiple parallel -worker processes. You may want to be familiar with the basic, -non-parallel, use of [Job](/docs/concepts/jobs/run-to-completion-finite-workloads/) first. +worker processes in a given pod. In this example, as each pod is created, it picks up one unit of work from a task queue, processes it, and repeats until the end of the queue is reached. - Here is an overview of the steps in this example: 1. **Start a storage service to hold the work queue.** In this example, we use Redis to store @@ -27,6 +24,24 @@ Here is an overview of the steps in this example: 1. **Start a Job that works on tasks from the queue**. The Job starts several pods. Each pod takes one task from the message queue, processes it, and repeats until the end of the queue is reached. +{{% /capture %}} + +{{< toc >}} + +{{% capture prerequisites %}} + +{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + +{{% /capture %}} + +{{% capture steps %}} + +Be familiar with the basic, +non-parallel, use of [Job](/docs/concepts/jobs/run-to-completion-finite-workloads/). + +{{% /capture %}} + +{{% capture steps %}} ## Starting Redis @@ -34,16 +49,27 @@ For this example, for simplicity, we will start a single instance of Redis. See the [Redis Example](https://github.com/kubernetes/examples/tree/master/guestbook) for an example of deploying Redis scalably and redundantly. -Start a temporary Pod running Redis and a service so we can find it. +If you are working from the website source tree, you can go to the following +directory and start a temporary Pod running Redis and a service so we can find it. ```shell -$ kubectl create -f docs/tasks/job/fine-parallel-processing-work-queue/redis-pod.yaml +$ cd content/en/examples/application/job/redis +$ kubectl create -f ./redis-pod.yaml pod "redis-master" created -$ kubectl create -f docs/tasks/job/fine-parallel-processing-work-queue/redis-service.yaml +$ kubectl create -f ./redis-service.yaml service "redis" created ``` -If you're not working from the source tree, you could also download [`redis-pod.yaml`](redis-pod.yaml?raw=true) and [`redis-service.yaml`](redis-service.yaml?raw=true) directly. +If you're not working from the source tree, you could also download the following +files directly: + +- [`redis-pod.yaml`](/examples/application/job/redis/redis-pod.yaml) +- [`redis-service.yaml`](/examples/application/job/redis/redis-service.yaml) +- [`Dockerfile`](/examples/application/job/redis/Dockerfile) +- [`job.yaml`](/examples/application/job/redis/job.yaml) +- [`rediswq.py`](/examples/application/job/redis/rediswq.py) +- [`worker.py`](/examples/application/job/redis/worker.py) + ## Filling the Queue with tasks @@ -106,17 +132,19 @@ We will use a python worker program with a redis client to read the messages from the message queue. A simple Redis work queue client library is provided, -called rediswq.py ([Download](rediswq.py?raw=true)). +called rediswq.py ([Download](/examples/application/job/redis/rediswq.py)). The "worker" program in each Pod of the Job uses the work queue client library to get work. Here it is: -{{< code language="python" file="fine-parallel-processing-work-queue/worker.py" >}} +{{< codenew language="python" file="application/job/redis/worker.py" >}} -If you are working from the source tree, -change directory to the `docs/tasks/job/fine-parallel-processing-work-queue/` directory. -Otherwise, download [`worker.py`](worker.py?raw=true), [`rediswq.py`](rediswq.py?raw=true), and [`Dockerfile`](Dockerfile?raw=true) -using above links. Then build the image: +If you are working from the source tree, change directory to the +`content/en/examples/application/job/redis/` directory. +Otherwise, download [`worker.py`](/examples/application/job/redis/worker.py), +[`rediswq.py`](/examples/application/job/redis/rediswq.py), and +[`Dockerfile`](/examples/application/job/redis/Dockerfile) files, then build +the image: ```shell docker build -t job-wq-2 . @@ -150,7 +178,7 @@ gcloud docker -- push gcr.io//job-wq-2 Here is the job definition: -{{< code file="fine-parallel-processing-work-queue/job.yaml" >}} +{{< codenew file="application/job/redis/job.yaml" >}} Be sure to edit the job template to change `gcr.io/myproject` to your own path. @@ -212,6 +240,10 @@ Working on lemon As you can see, one of our pods worked on several work units. +{{% /capture %}} + +{{% capture discussion %}} + ## Alternatives If running a queue service or modifying your containers to use a work queue is inconvenient, you may @@ -221,3 +253,5 @@ If you have a continuous stream of background processing work to run, then consider running your background workers with a `replicationController` instead, and consider running a background processing library such as [https://github.com/resque/resque](https://github.com/resque/resque). + +{{% /capture %}} diff --git a/content/en/docs/tasks/job/parallel-processing-expansion.md b/content/en/docs/tasks/job/parallel-processing-expansion.md index 18cd4b4b54cb2..25078d0b86509 100644 --- a/content/en/docs/tasks/job/parallel-processing-expansion.md +++ b/content/en/docs/tasks/job/parallel-processing-expansion.md @@ -1,21 +1,26 @@ --- title: Parallel Processing using Expansions +content_template: templates/concept weight: 20 --- -{{< toc >}} - -# Example: Multiple Job Objects from Template Expansion +{{% capture overview %}} In this example, we will run multiple Kubernetes Jobs created from a common template. You may want to be familiar with the basic, non-parallel, use of [Jobs](/docs/concepts/jobs/run-to-completion-finite-workloads/) first. +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ## Basic Template Expansion -First, download the following template of a job to a file called `job.yaml` +First, download the following template of a job to a file called `job-tmpl.yaml` -{{< code file="job.yaml" >}} +{{< codenew file="application/job/job-tmpl.yaml" >}} Unlike a *pod template*, our *job template* is not a Kubernetes API type. It is just a yaml representation of a Job object that has some placeholders that need to be filled @@ -42,7 +47,7 @@ Next, expand the template into multiple files, one for each item to be processed $ mkdir ./jobs $ for i in apple banana cherry do - cat job.yaml | sed "s/\$ITEM/$i/" > ./jobs/job-$i.yaml + cat job-tmpl.yaml | sed "s/\$ITEM/$i/" > ./jobs/job-$i.yaml done ``` @@ -189,3 +194,5 @@ If you have a large number of job objects, you may find that: In this case, you can consider one of the other [job patterns](/docs/concepts/jobs/run-to-completion-finite-workloads/#job-patterns). + +{{% /capture %}} diff --git a/content/en/docs/tasks/manage-daemon/update-daemon-set.md b/content/en/docs/tasks/manage-daemon/update-daemon-set.md index c2f6f506bdc0c..564f8a8fbb9ee 100644 --- a/content/en/docs/tasks/manage-daemon/update-daemon-set.md +++ b/content/en/docs/tasks/manage-daemon/update-daemon-set.md @@ -7,7 +7,7 @@ content_template: templates/task {{% capture overview %}} -This page shows how to perform a rolling update on a DaemonSet. +This page shows how to perform a rolling update on a DaemonSet. {{% /capture %}} @@ -32,43 +32,32 @@ DaemonSet has two update strategy types: before. * RollingUpdate: With `RollingUpdate` update strategy, after you update a DaemonSet template, old DaemonSet pods will be killed, and new DaemonSet pods - will be created automatically, in a controlled fashion. - -## Caveat: Updating DaemonSet created from Kubernetes version 1.5 or before - -If you try a rolling update on a DaemonSet that was created from Kubernetes -version 1.5 or before, a rollout will be triggered when you *first* change the -DaemonSet update strategy to `RollingUpdate`, no matter if DaemonSet template is -modified or not. If the DaemonSet template is not changed, all existing DaemonSet -pods will be restarted (deleted and created). - -Therefore, make sure you want to trigger a rollout before you first switch the -strategy to `RollingUpdate`. + will be created automatically, in a controlled fashion. ## Performing a Rolling Update To enable the rolling update feature of a DaemonSet, you must set its -`.spec.updateStrategy.type` to `RollingUpdate`. +`.spec.updateStrategy.type` to `RollingUpdate`. -You may want to set `.spec.updateStrategy.rollingUpdate.maxUnavailable` (default -to 1) and `.spec.minReadySeconds` (default to 0) as well. +You may want to set [`.spec.updateStrategy.rollingUpdate.maxUnavailable`](/docs/concepts/workloads/controllers/deployment/#max-unavailable) (default +to 1) and [`.spec.minReadySeconds`](/docs/concepts/workloads/controllers/deployment/#min-ready-seconds) (default to 0) as well. ### Step 1: Checking DaemonSet `RollingUpdate` update strategy -First, check the update strategy of your DaemonSet, and make sure it's set to +First, check the update strategy of your DaemonSet, and make sure it's set to `RollingUpdate`: ```shell kubectl get ds/ -o go-template='{{.spec.updateStrategy.type}}{{"\n"}}' -``` +``` If you haven't created the DaemonSet in the system, check your DaemonSet manifest with the following command instead: ```shell kubectl create -f ds.yaml --dry-run -o go-template='{{.spec.updateStrategy.type}}{{"\n"}}' -``` +``` The output from both commands should be: @@ -91,13 +80,13 @@ kubectl create -f ds.yaml ``` Alternatively, use `kubectl apply` to create the same DaemonSet if you plan to -update the DaemonSet with `kubectl apply`. +update the DaemonSet with `kubectl apply`. ```shell kubectl apply -f ds.yaml ``` -### Step 3: Updating a DaemonSet template +### Step 3: Updating a DaemonSet template Any updates to a `RollingUpdate` DaemonSet `.spec.template` will trigger a rolling update. This can be done with several different `kubectl` commands. @@ -126,7 +115,7 @@ kubectl edit ds/ kubectl patch ds/ -p= ``` -##### Updating only the container image +##### Updating only the container image If you just need to update the container image in the DaemonSet template, i.e. `.spec.template.spec.containers[*].image`, use `kubectl set image`: @@ -139,8 +128,8 @@ kubectl set image ds/ = Finally, watch the rollout status of the latest DaemonSet rolling update: -```shell -kubectl rollout status ds/ +```shell +kubectl rollout status ds/ ``` When the rollout is complete, the output is similar to this: @@ -149,7 +138,7 @@ When the rollout is complete, the output is similar to this: daemonset "" successfully rolled out ``` -## Troubleshooting +## Troubleshooting ### DaemonSet rolling update is stuck @@ -159,20 +148,20 @@ causes: #### Some nodes run out of resources The rollout is stuck because new DaemonSet pods can't be scheduled on at least one -node. This is possible when the node is +node. This is possible when the node is [running out of resources](/docs/tasks/administer-cluster/out-of-resource/). When this happens, find the nodes that don't have the DaemonSet pods scheduled on by comparing the output of `kubectl get nodes` and the output of: ```shell -kubectl get pods -l = -o wide +kubectl get pods -l = -o wide ``` Once you've found those nodes, delete some non-DaemonSet pods from the node to -make room for new DaemonSet pods. Note that this will cause service disruption +make room for new DaemonSet pods. Note that this will cause service disruption if the deleted pods are not controlled by any controllers, or if the pods aren't -replicated. This doesn't respect +replicated. This doesn't respect [PodDisruptionBudget](/docs/tasks/configure-pod-container/configure-pod-disruption-budget/) either. @@ -180,16 +169,16 @@ either. If the recent DaemonSet template update is broken, for example, the container is crash looping, or the container image doesn't exist (often due to a typo), -DaemonSet rollout won't progress. +DaemonSet rollout won't progress. To fix this, just update the DaemonSet template again. New rollout won't be -blocked by previous unhealthy rollouts. +blocked by previous unhealthy rollouts. #### Clock skew -If `.spec.minReadySeconds` is specified in the DaemonSet, clock skew between +If `.spec.minReadySeconds` is specified in the DaemonSet, clock skew between master and nodes will make DaemonSet unable to detect the right rollout -progress. +progress. {{% /capture %}} @@ -202,6 +191,3 @@ progress. * See [Concepts: Creating a DaemonSet to adopt existing DaemonSet pods](/docs/concepts/workloads/controllers/daemonset/) {{% /capture %}} - - - diff --git a/content/en/docs/tasks/manage-gpus/scheduling-gpus.md b/content/en/docs/tasks/manage-gpus/scheduling-gpus.md index 5f548e435269b..52afb97c28375 100644 --- a/content/en/docs/tasks/manage-gpus/scheduling-gpus.md +++ b/content/en/docs/tasks/manage-gpus/scheduling-gpus.md @@ -1,14 +1,23 @@ --- reviewers: - vishh +content_template: templates/concept title: Schedule GPUs --- +{{% capture overview %}} + Kubernetes includes **experimental** support for managing NVIDIA GPUs spread across nodes. The support for NVIDIA GPUs was added in v1.6 and has gone through multiple backwards incompatible iterations. This page describes how users can consume GPUs across different Kubernetes versions and the current limitations. +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ## v1.8 onwards **From 1.8 onwards, the recommended way to consume GPUs is to use [device @@ -143,68 +152,3 @@ spec: This will ensure that the pod will be scheduled to a node that has the GPU type you specified. - -## v1.6 and v1.7 -To enable GPU support in 1.6 and 1.7, a special **alpha** feature gate -`Accelerators` has to be set to true across the system: -`--feature-gates="Accelerators=true"`. It also requires using the Docker -Engine as the container runtime. - -Further, the Kubernetes nodes have to be pre-installed with NVIDIA drivers. -Kubelet will not detect NVIDIA GPUs otherwise. - -When you start Kubernetes components after all the above conditions are true, -Kubernetes will expose `alpha.kubernetes.io/nvidia-gpu` as a schedulable -resource. - -You can consume these GPUs from your containers by requesting -`alpha.kubernetes.io/nvidia-gpu` just like you request `cpu` or `memory`. -However, there are some limitations in how you specify the resource requirements -when using GPUs: -- GPUs are only supposed to be specified in the `limits` section, which means: - * You can specify GPU `limits` without specifying `requests` because - Kubernetes will use the limit as the request value by default. - * You can specify GPU in both `limits` and `requests` but these two values - must be equal. - * You cannot specify GPU `requests` without specifying `limits`. -- Containers (and pods) do not share GPUs. There's no overcommitting of GPUs. -- Each container can request one or more GPUs. It is not possible to request a - fraction of a GPU. - -When using `alpha.kubernetes.io/nvidia-gpu` as the resource, you also have to -mount host directories containing NVIDIA libraries (libcuda.so, libnvidia.so -etc.) to the container. - -Here's an example: - -```yaml -apiVersion: v1 -kind: Pod -metadata: - name: cuda-vector-add -spec: - restartPolicy: OnFailure - containers: - - name: cuda-vector-add - # https://github.com/kubernetes/kubernetes/blob/v1.7.11/test/images/nvidia-cuda/Dockerfile - image: "k8s.gcr.io/cuda-vector-add:v0.1" - resources: - limits: - alpha.kubernetes.io/nvidia-gpu: 1 # requesting 1 GPU - volumeMounts: - - name: "nvidia-libraries" - mountPath: "/usr/local/nvidia/lib64" - volumes: - - name: "nvidia-libraries" - hostPath: - path: "/usr/lib/nvidia-375" -``` - -The `Accelerators` feature gate and `alpha.kubernetes.io/nvidia-gpu` resource -works on 1.8 and 1.9 as well. It will be deprecated in 1.10 and removed in -1.11. - -## Future -- Support for hardware accelerators in Kubernetes is still in alpha. -- Better APIs will be introduced to provision and consume accelerators in a scalable manner. -- Kubernetes will automatically ensure that applications consuming GPUs get the best possible performance. diff --git a/content/en/docs/tasks/run-application/configure-pdb.md b/content/en/docs/tasks/run-application/configure-pdb.md index 1e0a3b67ad4c1..42e7e86fbffb6 100644 --- a/content/en/docs/tasks/run-application/configure-pdb.md +++ b/content/en/docs/tasks/run-application/configure-pdb.md @@ -163,13 +163,13 @@ For example, if the above `zk-pdb` object selects the pods of a StatefulSet of s specifications have the exact same meaning. The use of `maxUnavailable` is recommended as it automatically responds to changes in the number of replicas of the corresponding controller. -# Create the PDB object +## Create the PDB object You can create the PDB object with a command like `kubectl create -f mypdb.yaml`. You cannot update PDB objects. They must be deleted and re-created. -# Check the status of the PDB +## Check the status of the PDB Use kubectl to check that your PDB is created. @@ -213,7 +213,7 @@ status: observedGeneration: 1 ``` -# Arbitrary Controllers and Selectors +## Arbitrary Controllers and Selectors You can skip this section if you only use PDBs with the built-in application controllers (Deployment, ReplicationController, ReplicaSet, and StatefulSet), 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 bc715cd62741e..7d93e432ce4c8 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 @@ -5,10 +5,11 @@ reviewers: - justinsb - directxman12 title: Horizontal Pod Autoscaler Walkthrough +content_template: templates/task weight: 100 --- -{{< toc >}} +{{% capture overview %}} Horizontal Pod Autoscaler automatically scales the number of pods in a replication controller, deployment or replica set based on observed CPU utilization @@ -16,13 +17,18 @@ in a replication controller, deployment or replica set based on observed CPU uti 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/). -## Prerequisites +{{% /capture %}} + +{{< toc >}} + + +{{% capture prerequisites %}} This example requires a running Kubernetes cluster and kubectl, version 1.2 or later. -[Heapster](https://github.com/kubernetes/heapster) monitoring needs to be deployed in the cluster -as Horizontal Pod Autoscaler uses it to collect metrics -(if you followed [getting started on GCE guide](/docs/getting-started-guides/gce), -heapster monitoring will be turned-on by default). +[metrics-server](https://github.com/kubernetes/heapster) monitoring needs to be deployed in the cluster +to provide metrics via the resource metrics API, as Horizontal Pod Autoscaler uses this API to collect metrics +(if you followed [getting started on GCE guide](/docs/getting-started-guides/gce.md), +metrics-server monitoring will be turned-on by default). To specify multiple resource metrics for a Horizontal Pod Autoscaler, you must have a Kubernetes cluster and kubectl at version 1.6 or later. Furthermore, in order to make use of custom metrics, your cluster @@ -31,7 +37,11 @@ not related to any Kubernetes object you must have a Kubernetes cluster at versi 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. -## Step One: Run & expose php-apache server +{{% /capture %}} + +{{% capture steps %}} + +## Run & 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: @@ -62,7 +72,7 @@ service "php-apache" created deployment "php-apache" created ``` -## Step Two: Create Horizontal Pod Autoscaler +## Create Horizontal Pod Autoscaler Now that the server is running, we will create the autoscaler using [kubectl autoscale](https://github.com/kubernetes/kubernetes/blob/{{< param "githubbranch" >}}/docs/user-guide/kubectl/kubectl_autoscale.md). @@ -90,7 +100,7 @@ php-apache Deployment/php-apache/scale 0% / 50% 1 10 1 Please note that the current CPU consumption is 0% as we are not sending any requests to the server (the ``CURRENT`` column shows the average across all the pods controlled by the corresponding deployment). -## Step Three: Increase 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): @@ -125,7 +135,7 @@ php-apache 7 7 7 7 19m Since the amount of load is not controlled in any way it may happen that the final number of replicas will differ from this example. -## Step Four: Stop load +## Stop load We will finish our example by stopping the user load. @@ -146,7 +156,13 @@ 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. +{{< note >}} **Note** autoscaling the replicas may take a few minutes. +{{< /note >}} + +{{% /capture %}} + +{{% capture discussion %}} ## Autoscaling on multiple metrics and custom metrics @@ -196,7 +212,7 @@ Notice that the `targetCPUUtilizationPercentage` field has been replaced with an The CPU utilization metric is a *resource metric*, since it is represented as a percentage of a resource specified on pod containers. Notice that you can specify other resource metrics besides CPU. By default, the only other supported resource metric is memory. These resources do not change names from cluster -to cluster, and should always be available, as long as Heapster is deployed. +to cluster, and should always be available, as long as the `metrics.k8s.io` API is available. You can also specify resource metrics in terms of direct values, instead of as percentages of the requested value. To do so, use the `targetAverageValue` field instead of the `targetAverageUtilization` @@ -369,11 +385,13 @@ HorizontalPodAutoscaler. Instead of using `kubectl autoscale` command to create a HorizontalPodAutoscaler imperatively we can use the following file to create it declaratively: -{{< code file="hpa-php-apache.yaml" >}} +{{< codenew file="application/hpa/php-apache.yaml" >}} We will create the autoscaler by executing the following command: ```shell -$ kubectl create -f https://k8s.io/docs/tasks/run-application/hpa-php-apache.yaml +$ kubectl create -f https://k8s.io/examples/application/hpa/php-apache.yaml horizontalpodautoscaler "php-apache" created ``` + +{{% /capture %}} 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 46f2615624f1a..9bbb1c169f989 100644 --- a/content/en/docs/tasks/run-application/horizontal-pod-autoscale.md +++ b/content/en/docs/tasks/run-application/horizontal-pod-autoscale.md @@ -4,14 +4,11 @@ reviewers: - jszczepkowski - directxman12 title: Horizontal Pod Autoscaler +content_template: templates/concept weight: 90 --- -{{< toc >}} - -This document describes the current state of the Horizontal Pod Autoscaler in Kubernetes. - -## What is the Horizontal Pod Autoscaler? +{{% capture overview %}} The Horizontal Pod Autoscaler automatically scales the number of pods in a replication controller, deployment or replica set based on observed CPU utilization (or, with @@ -24,6 +21,12 @@ 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 average CPU utilization to the target specified by user. +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ## How does the Horizontal Pod Autoscaler work? ![Horizontal Pod Autoscaler diagram](/images/docs/horizontal-pod-autoscaler.svg) @@ -57,19 +60,16 @@ or the custom metrics API (for all other metrics). * For object metrics, a single metric is fetched (which describes the object in question), and compared to the target value, to produce a ratio as above. -The HorizontalPodAutoscaler controller can fetch metrics in two different ways: direct Heapster -access, and REST client access. - -When using direct Heapster access, the HorizontalPodAutoscaler queries Heapster directly -through the API server's service proxy subresource. Heapster needs to be deployed on the -cluster and running in the kube-system namespace. - -See [Support for custom metrics](#support-for-custom-metrics) for more details on REST client access. +The HorizontalPodAutoscaler normally fetches metrics a series of aggregated APIs (`metrics.k8s.io`,\ +`custom.metrics.k8s.io`, and `external.metrics.k8s.io`). It can also fetch metrics directly +from Heapster. Fetching metrics from Heapster is deprecated as of Kubernetes 1.11. -The autoscaler accesses corresponding replication controller, deployment or replica set by 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). +See [Support for metrics APIs](#support-for-metrics-apis) for more details. +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). ## API Object @@ -155,33 +155,34 @@ Kubernetes 1.6 adds support for making use of custom metrics in the Horizontal P You can add custom metrics for the Horizontal Pod Autoscaler to use in the `autoscaling/v2beta1` API. Kubernetes then queries the new custom metrics API to fetch the values of the appropriate custom metrics. -### Requirements +See [Support for metrics APIs](#support-for-metrics-APIs) for the requirements. -To use custom metrics with your Horizontal Pod Autoscaler, you must set the necessary configurations when deploying your cluster: +## Support for metrics APIs -* [Enable the API aggregation layer](/docs/tasks/access-kubernetes-api/configure-aggregation-layer/) if you have not already done so. +By default, the HorizontalPodAutoscaler controller retrieves metrics from a series of APIs. In order for it to access these +APIs, cluster administrators must ensure that: -* Register your resource metrics API, your -custom metrics API and, optionally, external metrics API with the API aggregation layer. All of these API servers must be running *on* your cluster. +* The [API aggregation layer](/docs/tasks/access-kubernetes-api/configure-aggregation-layer/) is enabled. - * *Resource Metrics API*: You can use Heapster's implementation of the resource metrics API, by running Heapster with its `--api-server` flag set to true. +* The corresponding APIs are registered: - * *Custom Metrics API*: This must be provided by a separate component. To get started with boilerplate code, see the [kubernetes-incubator/custom-metrics-apiserver](https://github.com/kubernetes-incubator/custom-metrics-apiserver) and the [k8s.io/metrics](https://github.com/kubernetes/metrics) repositories. + * For resource metrics, this is the `metrics.k8s.io` API, generally provided by [metrics-server](https://github.com/kubernetes-incubator/metrics-server). + It can be launched as a cluster addon. - * *External Metrics API*: Starting from Kubernetes 1.10 you can use this API if you need to autoscale on metrics not related to any Kubernetes object. Similarly to *Custom Metrics API* this must be provided by a separate component. + * 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-incubator/custom-metrics-apiserver) to get started. -* Set the appropriate flags for kube-controller-manager: + * For external metrics, this is the `external.metrics.k8s.io` API. It may be provided by the custom metrics adapters provided above. - * `--horizontal-pod-autoscaler-use-rest-clients` should be true. +* The `--horizontal-pod-autoscaler-use-rest-clients` is `true` or unset. Setting this to false switches to Heapster-based autoscaling, which is deprecated. - * `--kubeconfig ` OR `--master ` +{{% /capture %}} - Note that either the `--master` or `--kubeconfig` flag can be used; `--master` will override `--kubeconfig` if both are specified. These flags specify the location of the API aggregation layer, allowing the controller manager to communicate to the API server. - - In Kubernetes 1.7, the standard aggregation layer that Kubernetes provides runs in-process with the kube-apiserver, so the target IP address can be found with `kubectl get pods --selector k8s-app=kube-apiserver --namespace kube-system -o jsonpath='{.items[0].status.podIP}'`. - -## Further reading +{{% capture whatsnext %}} * 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/). + +{{% /capture %}} diff --git a/content/en/docs/tasks/run-application/rolling-update-replication-controller.md b/content/en/docs/tasks/run-application/rolling-update-replication-controller.md index 027726a3bc159..5e2e2c0b97f80 100644 --- a/content/en/docs/tasks/run-application/rolling-update-replication-controller.md +++ b/content/en/docs/tasks/run-application/rolling-update-replication-controller.md @@ -2,12 +2,11 @@ reviewers: - janetkuo title: Perform Rolling Update Using a Replication Controller +content_template: templates/concept weight: 80 --- -{{< toc >}} - -## Overview +{{% capture overview %}} {{< note >}} **Note**: The preferred way to create a replicated application is to use a @@ -41,6 +40,12 @@ Rolling updates are initiated with the `kubectl rolling-update` command: $ kubectl rolling-update NAME \ ([NEW_NAME] --image=IMAGE | -f FILE) +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + ## Passing a configuration file To initiate a rolling update using a configuration file, pass the new file to @@ -261,3 +266,5 @@ To continue the update from where it failed, retry using the same command. To roll back to the original state before the attempted update, append the `--rollback=true` flag to the original command. This will revert all changes. + +{{% /capture %}} diff --git a/content/en/docs/tasks/run-application/run-replicated-stateful-application.md b/content/en/docs/tasks/run-application/run-replicated-stateful-application.md index 6c43288ebd24e..8ba5248b09dee 100644 --- a/content/en/docs/tasks/run-application/run-replicated-stateful-application.md +++ b/content/en/docs/tasks/run-application/run-replicated-stateful-application.md @@ -60,10 +60,10 @@ and a StatefulSet. Create the ConfigMap from the following YAML configuration file: ```shell -kubectl create -f https://k8s.io/docs/tasks/run-application/mysql-configmap.yaml +kubectl create -f https://k8s.io/examples/application/mysql/mysql-configmap.yaml ``` -{{< code file="mysql-configmap.yaml" >}} +{{< codenew file="application/mysql/mysql-configmap.yaml" >}} This ConfigMap provides `my.cnf` overrides that let you independently control configuration on the MySQL master and slaves. @@ -80,10 +80,10 @@ based on information provided by the StatefulSet controller. Create the Services from the following YAML configuration file: ```shell -kubectl create -f https://k8s.io/docs/tasks/run-application/mysql-services.yaml +kubectl create -f https://k8s.io/examples/application/mysql/mysql-services.yaml ``` -{{< code file="mysql-services.yaml" >}} +{{< codenew file="application/mysql/mysql-services.yaml" >}} The Headless Service provides a home for the DNS entries that the StatefulSet controller creates for each Pod that's part of the set. @@ -106,10 +106,10 @@ writes. Finally, create the StatefulSet from the following YAML configuration file: ```shell -kubectl create -f https://k8s.io/docs/tasks/run-application/mysql-statefulset.yaml +kubectl create -f https://k8s.io/examples/application/mysql/mysql-statefulset.yaml ``` -{{< code file="mysql-statefulset.yaml" >}} +{{< codenew file="application/mysql/mysql-statefulset.yaml" >}} You can watch the startup progress by running: diff --git a/content/en/docs/tasks/run-application/run-single-instance-stateful-application.md b/content/en/docs/tasks/run-application/run-single-instance-stateful-application.md index ea0250264510d..275dcfec0735a 100644 --- a/content/en/docs/tasks/run-application/run-single-instance-stateful-application.md +++ b/content/en/docs/tasks/run-application/run-single-instance-stateful-application.md @@ -48,16 +48,16 @@ Note: The password is defined in the config yaml, and this is insecure. See [Kubernetes Secrets](/docs/concepts/configuration/secret/) for a secure solution. -{{< code file="mysql-deployment.yaml" >}} -{{< code file="mysql-pv.yaml" >}} +{{< codenew file="application/mysql/mysql-deployment.yaml" >}} +{{< codenew file="application/mysql/mysql-pv.yaml" >}} 1. Deploy the PV and PVC of the YAML file: - kubectl create -f https://k8s.io/docs/tasks/run-application/mysql-pv.yaml + kubectl create -f https://k8s.io/examples/application/mysql/mysql-pv.yaml 1. Deploy the contents of the YAML file: - kubectl create -f https://k8s.io/docs/tasks/run-application/mysql-deployment.yaml + kubectl create -f https://k8s.io/examples/application/mysql/mysql-deployment.yaml 1. Display information about the Deployment: @@ -114,7 +114,7 @@ for a secure solution. Namespace: default StorageClass: Status: Bound - Volume: mysql-pv + Volume: mysql-pv-volume Labels: Annotations: pv.kubernetes.io/bind-completed=yes pv.kubernetes.io/bound-by-controller=yes diff --git a/content/en/docs/tasks/run-application/run-stateless-application-deployment.md b/content/en/docs/tasks/run-application/run-stateless-application-deployment.md index 61b2f08f3d619..043c4a089fcba 100644 --- a/content/en/docs/tasks/run-application/run-stateless-application-deployment.md +++ b/content/en/docs/tasks/run-application/run-stateless-application-deployment.md @@ -36,12 +36,12 @@ You can run an application by creating a Kubernetes Deployment object, and you can describe a Deployment in a YAML file. For example, this YAML file describes a Deployment that runs the nginx:1.7.9 Docker image: -{{< code file="deployment.yaml" >}} +{{< codenew file="application/deployment.yaml" >}} 1. Create a Deployment based on the YAML file: - kubectl apply -f https://k8s.io/docs/tasks/run-application/deployment.yaml + kubectl apply -f https://k8s.io/examples/application/deployment.yaml 1. Display information about the Deployment: @@ -99,11 +99,11 @@ a Deployment that runs the nginx:1.7.9 Docker image: You can update the deployment by applying a new YAML file. This YAML file specifies that the deployment should be updated to use nginx 1.8. -{{< code file="deployment-update.yaml" >}} +{{< codenew file="application/deployment-update.yaml" >}} 1. Apply the new YAML file: - kubectl apply -f https://k8s.io/docs/tasks/run-application/deployment-update.yaml + kubectl apply -f https://k8s.io/examples/application/deployment-update.yaml 1. Watch the deployment create pods with new names and delete the old pods: @@ -115,11 +115,11 @@ You can increase the number of pods in your Deployment by applying a new YAML file. This YAML file sets `replicas` to 4, which specifies that the Deployment should have four pods: -{{< code file="deployment-scale.yaml" >}} +{{< codenew file="application/deployment-scale.yaml" >}} 1. Apply the new YAML file: - kubectl apply -f https://k8s.io/docs/tasks/run-application/deployment-scale.yaml + kubectl apply -f https://k8s.io/examples/application/deployment-scale.yaml 1. Verify that the Deployment has four pods: diff --git a/content/en/docs/tasks/run-application/update-api-object-kubectl-patch.md b/content/en/docs/tasks/run-application/update-api-object-kubectl-patch.md index cdf2d73a550b3..d5c3f68213973 100644 --- a/content/en/docs/tasks/run-application/update-api-object-kubectl-patch.md +++ b/content/en/docs/tasks/run-application/update-api-object-kubectl-patch.md @@ -26,12 +26,12 @@ in this task demonstrate a strategic merge patch and a JSON merge patch. Here's the configuration file for a Deployment that has two replicas. Each replica is a Pod that has one container: -{{< code file="deployment-patch-demo.yaml" >}} +{{< codenew file="application/deployment-patch.yaml" >}} Create the Deployment: ```shell -kubectl create -f https://k8s.io/docs/tasks/run-application/deployment-patch-demo.yaml +kubectl create -f https://k8s.io/examples/application/deployment-patch.yaml ``` View the Pods associated with your Deployment: diff --git a/content/en/docs/tasks/tls/managing-tls-in-a-cluster.md b/content/en/docs/tasks/tls/managing-tls-in-a-cluster.md index ce9bc6c0ae53f..14522919972dc 100644 --- a/content/en/docs/tasks/tls/managing-tls-in-a-cluster.md +++ b/content/en/docs/tasks/tls/managing-tls-in-a-cluster.md @@ -1,14 +1,13 @@ --- title: Manage TLS Certificates in a Cluster +content_template: templates/task reviewers: - mikedanese - beacham - liggit --- -{{< toc >}} - -## Overview +{{% capture overview %}} Every Kubernetes cluster has a cluster root Certificate Authority (CA). The CA is generally used by cluster components to validate the API server's @@ -20,6 +19,18 @@ can request a certificate signing using the `certificates.k8s.io` API using a protocol that is similar to the [ACME draft](https://github.com/ietf-wg-acme/acme/). +{{% /capture %}} + +{{< toc >}} + +{{% capture prerequisites %}} + +{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + +{{% /capture %}} + +{{% capture steps %}} + ## Trusting TLS in a Cluster Trusting the cluster root CA from an application running as a pod usually @@ -43,12 +54,12 @@ Kubernetes service accessed through DNS. **Note:** This tutorial uses CFSSL: Cloudflare's PKI and TLS toolkit [click here](https://blog.cloudflare.com/introducing-cfssl/) to know more. {{< /note >}} -### Step 0. Download and install CFSSL +## Download and install CFSSL The cfssl tools used in this example can be downloaded at [https://pkg.cfssl.org/](https://pkg.cfssl.org/). -### Step 1. Create a Certificate Signing Request +## Create a Certificate Signing Request Generate a private key and certificate signing request (or CSR) by running the following command: @@ -88,7 +99,7 @@ encoded [pkcs#10](https://tools.ietf.org/html/rfc2986) certification request, and `server-key.pem` containing the PEM encoded key to the certificate that is still to be created. -### Step 2. Create a Certificate Signing Request object to send to the Kubernetes API +## Create a Certificate Signing Request object to send to the Kubernetes API Generate a CSR yaml blob and send it to the apiserver by running the following command: @@ -139,13 +150,13 @@ Subject Alternative Names: Events: ``` -### Step 3. Get the Certificate Signing Request Approved +## Get the Certificate Signing Request Approved Approving the certificate signing request is either done by an automated approval process or on a one off basis by a cluster administrator. More information on what this involves is covered below. -### Step 4. Download the Certificate and Use It +## Download the Certificate and Use It Once the CSR is signed and approved you should see the following: @@ -206,3 +217,5 @@ Kubernetes controller manager provides a default implementation of a signer. To enable it, pass the `--cluster-signing-cert-file` and `--cluster-signing-key-file` parameters to the controller manager with paths to your Certificate Authority's keypair. + +{{% /capture %}} diff --git a/content/en/docs/tasks/tools/install-kubeadm.md b/content/en/docs/tasks/tools/install-kubeadm.md index 492e70e5c03d4..07e54f1762036 100644 --- a/content/en/docs/tasks/tools/install-kubeadm.md +++ b/content/en/docs/tasks/tools/install-kubeadm.md @@ -52,22 +52,20 @@ route, we recommend you add IP route(s) so Kubernetes cluster addresses go via t ### Master node(s) -| Protocol | Direction | Port Range | Purpose | -|----------|-----------|------------|-------------------------| -| TCP | Inbound | 6443* | Kubernetes API server | -| TCP | Inbound | 2379-2380 | etcd server client API | -| TCP | Inbound | 10250 | Kubelet API | -| TCP | Inbound | 10251 | kube-scheduler | -| TCP | Inbound | 10252 | kube-controller-manager | -| TCP | Inbound | 10255 | Read-only Kubelet API | +| Protocol | Direction | Port Range | Purpose | Used By | +|----------|-----------|------------|-------------------------|---------------------------| +| TCP | Inbound | 6443* | Kubernetes API server | All | +| TCP | Inbound | 2379-2380 | etcd server client API | kube-apiserver, etcd | +| TCP | Inbound | 10250 | Kubelet API | Self, Control plane | +| TCP | Inbound | 10251 | kube-scheduler | Self | +| TCP | Inbound | 10252 | kube-controller-manager | Self | ### Worker node(s) -| Protocol | Direction | Port Range | Purpose | -|----------|-----------|-------------|-----------------------| -| TCP | Inbound | 10250 | Kubelet API | -| TCP | Inbound | 10255 | Read-only Kubelet API | -| TCP | Inbound | 30000-32767 | NodePort Services** | +| Protocol | Direction | Port Range | Purpose | Used By | +|----------|-----------|-------------|-----------------------|-------------------------| +| TCP | Inbound | 10250 | Kubelet API | Self, Control plane | +| TCP | Inbound | 30000-32767 | NodePort Services** | All | ** Default port range for [NodePort Services](/docs/concepts/services-networking/service/). diff --git a/content/en/docs/tasks/tools/install-kubectl.md b/content/en/docs/tasks/tools/install-kubectl.md index 73a2de1d11d95..d95dc654d1e70 100644 --- a/content/en/docs/tasks/tools/install-kubectl.md +++ b/content/en/docs/tasks/tools/install-kubectl.md @@ -61,7 +61,7 @@ kubectl is available as a [snap](https://snapcraft.io/) application. 1. If you are on macOS and using [Homebrew](https://brew.sh/) package manager, you can install with: - brew install kubectl + brew install kubernetes-cli 2. Run `kubectl version` to verify that the version you've installed is sufficiently up-to-date. diff --git a/content/en/docs/tasks/tools/install-minikube.md b/content/en/docs/tasks/tools/install-minikube.md index 830469052f35c..a825d09dd05d4 100644 --- a/content/en/docs/tasks/tools/install-minikube.md +++ b/content/en/docs/tasks/tools/install-minikube.md @@ -32,7 +32,7 @@ If you do not already have a hypervisor installed, install one now. [KVM](http://www.linux-kvm.org/). {{< note >}} - **Note:** Minikube also supports a `--vm-driver=none` option that runs the Kubernetes components on the host and not in a VM. Docker is required to use this driver but a hypervisor is not required. + **Note:** Minikube also supports a `-\-vm-driver=none` option that runs the Kubernetes components on the host and not in a VM. Docker is required to use this driver but a hypervisor is not required. {{< /note >}} * For Windows, install diff --git a/content/en/docs/tutorials/configuration/configure-redis-using-configmap.md b/content/en/docs/tutorials/configuration/configure-redis-using-configmap.md index 2c11bbff1ed2a..fa22162dd2573 100644 --- a/content/en/docs/tutorials/configuration/configure-redis-using-configmap.md +++ b/content/en/docs/tutorials/configuration/configure-redis-using-configmap.md @@ -95,7 +95,7 @@ You can follow the steps below to configure a Redis cache using data stored in a 1. Create the pod: ```shell - kubectl create -f https://k8s.io/tutorials/configuration/configmap/redis/redis-pod.yaml + kubectl create -f https://k8s.io/docs/tutorials/configuration/configmap/redis/redis-pod.yaml ``` In the example, the config volume is mounted at `/redis-master`. diff --git a/content/en/docs/tutorials/deployment.yaml b/content/en/docs/tutorials/deployment.yaml deleted file mode 100644 index 485be0dabcdf2..0000000000000 --- a/content/en/docs/tutorials/deployment.yaml +++ /dev/null @@ -1,21 +0,0 @@ -apiVersion: apps/v1 -kind: Deployment -metadata: - name: nginx-deployment -spec: - selector: - matchLabels: - app: nginx - replicas: 2 # tells deployment to run 2 pods matching the template - template: # create pods using pod definition in this template - metadata: - # unlike pod-nginx.yaml, the name is not included in the meta data as a unique name is - # generated from the deployment name - labels: - app: nginx - spec: - containers: - - name: nginx - image: nginx:1.7.9 - ports: - - containerPort: 80 diff --git a/content/en/docs/tutorials/hello-minikube.md b/content/en/docs/tutorials/hello-minikube.md index b0ef031ba551f..4e99229e8f152 100644 --- a/content/en/docs/tutorials/hello-minikube.md +++ b/content/en/docs/tutorials/hello-minikube.md @@ -82,7 +82,7 @@ Use Homebrew to download the `kubectl` command-line tool, which you can use to interact with Kubernetes clusters: ```shell -brew install kubectl +brew install kubernetes-cli ``` Determine whether you can access sites like [https://cloud.google.com/container-registry/](https://cloud.google.com/container-registry/) directly without a proxy, by opening a new terminal and using @@ -148,7 +148,7 @@ minikube dashboard The next step is to write the application. Save this code in a folder named `hellonode` with the filename `server.js`: -{{< code language="js" file="server.js" >}} +{{< codenew language="js" file="minikube/server.js" >}} Run your application: @@ -168,7 +168,7 @@ Create a file, also in the `hellonode` folder, named `Dockerfile`. A Dockerfile the image that you want to build. You can build a Docker container image by extending an existing image. The image in this tutorial extends an existing Node.js image. -{{< code language="conf" file="Dockerfile" >}} +{{< codenew language="conf" file="minikube/Dockerfile" >}} This recipe for the Docker image starts from the official Node.js LTS image found in the Docker registry, exposes port 8080, copies your `server.js` file @@ -183,8 +183,10 @@ sure you are using the Minikube Docker daemon: eval $(minikube docker-env) ``` +{{< note >}} **Note:** Later, when you no longer wish to use the Minikube host, you can undo this change by running `eval $(minikube docker-env -u)`. +{{< /note >}} Build your Docker image, using the Minikube Docker daemon (mind the trailing dot): @@ -204,10 +206,12 @@ Pod and restarts the Pod's Container if it terminates. Deployments are the recommended way to manage the creation and scaling of Pods. Use the `kubectl run` command to create a Deployment that manages a Pod. The -Pod runs a Container based on your `hello-node:v1` Docker image: +Pod runs a Container based on your `hello-node:v1` Docker image. Set the +`--image-pull-policy` flag to `Never` to always use the local image, rather than +pulling it from your Docker registry (since you haven't pushed it there): ```shell -kubectl run hello-node --image=hello-node:v1 --port=8080 +kubectl run hello-node --image=hello-node:v1 --port=8080 --image-pull-policy=Never ``` View the Deployment: diff --git a/content/en/docs/tutorials/k8s101.md b/content/en/docs/tutorials/k8s101.md index 20b686121f6cd..14982540786d7 100644 --- a/content/en/docs/tutorials/k8s101.md +++ b/content/en/docs/tutorials/k8s101.md @@ -35,7 +35,7 @@ For more information, see [Pods](/docs/concepts/workloads/pods/pod/). The simplest Pod definition describes the deployment of a single container. For example, an nginx web server Pod might be defined as: -{{< code file="pod-nginx.yaml" >}} +{{< codenew file="pods/simple-pod.yaml" >}} A Pod definition is a declaration of a _desired state_. Desired state is a very important concept in the Kubernetes model. Many things present a desired state to the system, and Kubernetes' ensures that the current state matches the desired state. For example, when you create a Pod and declare that the containers in it to be running. If the containers happen not to be running because of a program failure, Kubernetes continues to (re-)create the Pod in order to drive the pod to the desired state. This process continues until you delete the Pod. @@ -44,10 +44,10 @@ For more information, see [Kubernetes Design Documents and Proposals](https://gi #### Pod Management -Create a Pod containing an nginx server ([pod-nginx.yaml](/docs/tutorials/pod-nginx.yaml)): +Create a Pod containing an nginx server ([simple-pod.yaml](/examples/pods/simple-pod.yaml)): ```shell -$ kubectl create -f docs/tutorials/pod-nginx.yaml +$ kubectl create -f https://k8s.io/examples/pods/simple-pod.yaml ``` List all Pods: @@ -85,27 +85,25 @@ In this example you can create a Redis Pod with a named volume, and a volume mou 1. Define a Volume: -```yaml -volumes: - - name: redis-persistent-storage - emptyDir: {} -``` - -2. Define a Volume mount within a container definition: - -```yaml -volumeMounts: -    # name must match the volume name defined in volumes -    - name: redis-persistent-storage - # mount path within the container - mountPath: /data/redis -``` + ```yaml + volumes: + - name: redis-storage + emptyDir: {} + ``` +1. Define a Volume mount within a container definition: -Here is an example of Redis Pod definition with a persistent storage volume ([pod-redis.yaml](/docs/tutorials/pod-redis.yaml)): + ```yaml + volumeMounts: +  # name must match the volume name defined in volumes +  - name: redis-storage + # mount path within the container + mountPath: /data/redis + ``` +Here is an example of Redis Pod definition with a persistent storage volume ([redis.yaml](/examples/pods/storage/redis.yaml)): -{{< code file="pod-redis.yaml" >}} +{{< codenew file="pods/storage/redis.yaml" >}} Where: diff --git a/content/en/docs/tutorials/k8s201.md b/content/en/docs/tutorials/k8s201.md index b0b165aeeea8e..fe62d1a04cbb5 100644 --- a/content/en/docs/tutorials/k8s201.md +++ b/content/en/docs/tutorials/k8s201.md @@ -5,6 +5,8 @@ reviewers: title: Kubernetes 201 --- +{{< toc >}} + ## Labels, Deployments, Services and Health Checking If you went through [Kubernetes 101](/docs/tutorials/k8s101/), you learned about kubectl, Pods, Volumes, and multiple containers. @@ -15,9 +17,6 @@ scaling. In order for the kubectl usage examples to work, make sure you have an examples directory locally, either from [a release](https://github.com/kubernetes/kubernetes/releases) or [the source](https://github.com/kubernetes/kubernetes). -* TOC -{{< toc >}} - ## Labels @@ -27,29 +26,29 @@ To add a label, add a labels section under metadata in the Pod definition: ```yaml labels: - app: nginx + env: test ``` -For example, here is the nginx Pod definition with labels ([pod-nginx-with-label.yaml](/docs/tutorials/pod-nginx-with-label.yaml)): +For example, here is the nginx Pod definition with labels ([pod-nginx.yaml](/examples/pods/pod-nginx.yaml)): -{{< code file="pod-nginx-with-label.yaml" >}} +{{< codenew file="pods/pod-nginx.yaml" >}} -Create the labeled Pod ([pod-nginx-with-label.yaml](/docs/tutorials/pod-nginx-with-label.yaml)): +Create the labeled Pod: ```shell -kubectl create -f https://k8s.io/docs/tutorials/pod-nginx-with-label.yaml +kubectl create -f https://k8s.io/examples/pods/pod-nginx.yaml ``` -List all Pods with the label `app=nginx`: +List all Pods with the label `env=test`: ```shell -kubectl get pods -l app=nginx +kubectl get pods -l env=test ``` Delete the Pod by label: ```shell -kubectl delete pod -l app=nginx +kubectl delete pod -l env=test ``` For more information, see [Labels](/docs/concepts/overview/working-with-objects/labels/). @@ -66,7 +65,7 @@ A Deployment object defines a Pod creation template (a "cookie-cutter" if you wi Here is a Deployment that instantiates two nginx Pods: -{{< code file="deployment.yaml" >}} +{{< codenew file="application/deployment.yaml" >}} ### Deployment Management @@ -74,7 +73,7 @@ Here is a Deployment that instantiates two nginx Pods: Create an nginx Deployment: ```shell -kubectl create -f https://k8s.io/docs/tutorials/deployment.yaml +kubectl create -f https://k8s.io/examples/application/deployment.yaml ``` List all Deployments: @@ -92,10 +91,10 @@ kubectl get pods -l app=nginx Upgrade the nginx container from 1.7.9 to 1.8 by changing the Deployment and calling `apply`. The following config contains the desired changes: -{{< code file="deployment-update.yaml" >}} +{{< codenew file="application/deployment-update.yaml" >}} ```shell -kubectl apply -f https://k8s.io/docs/tutorials/deployment-update.yaml +kubectl apply -f https://k8s.io/examples/application/deployment-update.yaml ``` Watch the Deployment create Pods with new names and delete the old Pods: @@ -117,17 +116,17 @@ For more information, such as how to rollback Deployment changes to a previous v Once you have a replicated set of Pods, you need an abstraction that enables connectivity between the layers of your application. For example, if you have a Deployment managing your backend jobs, you don't want to have to reconfigure your front-ends whenever you re-scale your backends. Likewise, if the Pods in your backends are scheduled (or rescheduled) onto different machines, you can't be required to re-configure your front-ends. In Kubernetes, the service abstraction achieves these goals. A service provides a way to refer to a set of Pods (selected by labels) with a single static IP address. It may also provide load balancing, if supported by the provider. -For example, here is a service that balances across the Pods created in the previous nginx Deployment example ([service.yaml](/docs/tutorials/service.yaml)): +For example, here is a service that balances across the Pods created in the previous nginx Deployment example ([service.yaml](/examples/service/nginx-service.yaml)): -{{< code file="service.yaml" >}} +{{< codenew file="service/nginx-service.yaml" >}} ### Service Management -Create an nginx service ([service.yaml](/docs/tutorials/service.yaml)): +Create an nginx Service: ```shell -kubectl create -f https://k8s.io/docs/tutorials/service.yaml +kubectl create -f https://k8s.io/examples/service/nginx-service.yaml ``` List all services: @@ -222,13 +221,15 @@ In all cases, if the Kubelet discovers a failure the container is restarted. The container health checks are configured in the `livenessProbe` section of your container config. There you can also specify an `initialDelaySeconds` that is a grace period from when the container is started to when health checks are performed, to enable your container to perform any necessary initialization. -Here is an example config for a Pod with an HTTP health check ([pod-with-http-healthcheck.yaml](/docs/tutorials/pod-with-http-healthcheck.yaml)): +Here is an example config for a Pod with an HTTP health check +([pod-with-http-healthcheck.yaml](/examples/pods/probe/pod-with-http-healthcheck.yaml)): -{{< code file="pod-with-http-healthcheck.yaml" >}} +{{< codenew file="pods/probe/pod-with-http-healthcheck.yaml" >}} -And here is an example config for a Pod with a TCP Socket health check ([pod-with-tcp-socket-healthcheck.yaml](/docs/tutorials/pod-with-tcp-socket-healthcheck.yaml)): +And here is an example config for a Pod with a TCP Socket health check +([pod-with-tcp-socket-healthcheck.yaml](/examples/pods/probe/pod-with-tcp-socket-healthcheck.yaml)): -{{< code file="pod-with-tcp-socket-healthcheck.yaml" >}} +{{< codenew file="pods/probe/pod-with-tcp-socket-healthcheck.yaml" >}} For more information about health checking, see [Container Probes](/docs/user-guide/pod-states/#container-probes). diff --git a/content/en/docs/tutorials/pod-nginx-with-label.yaml b/content/en/docs/tutorials/pod-nginx-with-label.yaml deleted file mode 100644 index 7053af0be4b34..0000000000000 --- a/content/en/docs/tutorials/pod-nginx-with-label.yaml +++ /dev/null @@ -1,12 +0,0 @@ -apiVersion: v1 -kind: Pod -metadata: - name: nginx - labels: - app: nginx -spec: - containers: - - name: nginx - image: nginx - ports: - - containerPort: 80 diff --git a/content/en/docs/tutorials/pod-redis.yaml b/content/en/docs/tutorials/pod-redis.yaml deleted file mode 100644 index f000658079bf7..0000000000000 --- a/content/en/docs/tutorials/pod-redis.yaml +++ /dev/null @@ -1,14 +0,0 @@ -apiVersion: v1 -kind: Pod -metadata: - name: redis -spec: - containers: - - name: redis - image: redis - volumeMounts: - - name: redis-persistent-storage - mountPath: /data/redis - volumes: - - name: redis-persistent-storage - emptyDir: {} diff --git a/content/en/docs/tutorials/stateful-application/Dockerfile b/content/en/docs/tutorials/stateful-application/Dockerfile deleted file mode 100644 index 8016958d830c1..0000000000000 --- a/content/en/docs/tutorials/stateful-application/Dockerfile +++ /dev/null @@ -1,17 +0,0 @@ -# This is an image with Percona XtraBackup, mysql-client and ncat installed. -FROM debian:jessie - -RUN \ - echo "deb http://repo.percona.com/apt jessie main" > /etc/apt/sources.list.d/percona.list \ - && echo "deb-src http://repo.percona.com/apt jessie main" >> /etc/apt/sources.list.d/percona.list \ - && apt-key adv --keyserver keys.gnupg.net --recv-keys 8507EFA5 - -RUN \ - apt-get update && apt-get install -y --no-install-recommends \ - percona-xtrabackup-24 \ - mysql-client \ - nmap \ - && rm -rf /var/lib/apt/lists/* - -CMD ["bash"] - diff --git a/content/en/docs/tutorials/stateful-application/basic-stateful-set.md b/content/en/docs/tutorials/stateful-application/basic-stateful-set.md index ea2e70eecf38b..629a132f366e6 100644 --- a/content/en/docs/tutorials/stateful-application/basic-stateful-set.md +++ b/content/en/docs/tutorials/stateful-application/basic-stateful-set.md @@ -60,7 +60,7 @@ example presented in the It creates a [Headless Service](/docs/concepts/services-networking/service/#headless-services), `nginx`, to publish the IP addresses of Pods in the StatefulSet, `web`. -{{< code file="web.yaml" >}} +{{< codenew file="application/web/web.yaml" >}} Download the example above, and save it to a file named `web.yaml` @@ -283,7 +283,8 @@ web-0 web-1 ``` -Note, if you instead see 403 Forbidden responses for the above curl command, +{{< note >}} +**Note:** If you instead see 403 Forbidden responses for the above curl command, you will need to fix the permissions of the directory mounted by the `volumeMounts` (due to a [bug when using hostPath volumes](https://github.com/kubernetes/kubernetes/issues/2630)) with: @@ -292,6 +293,7 @@ for i in 0 1; do kubectl exec web-$i -- chmod 755 /usr/share/nginx/html; done ``` before retrying the curl command above. +{{< /note >}} In one terminal, watch the StatefulSet's Pods. @@ -449,7 +451,9 @@ strategy used is determined by the `spec.updateStrategy` field of the StatefulSet API Object. This feature can be used to upgrade the container images, resource requests and/or limits, labels, and annotations of the Pods in a StatefulSet. There are two valid update strategies, `RollingUpdate` and -`OnDelete`. +`OnDelete`. + +`RollingUpdate` update strategy is the default for StatefulSets. ### Rolling Update @@ -927,9 +931,9 @@ terminate all Pods in parallel, and not to wait for Pods to become Running and Ready or completely terminated prior to launching or terminating another Pod. -{{< code file="webp.yaml" >}} +{{< codenew file="application/web/web-parallel.yaml" >}} -Download the example above, and save it to a file named `webp.yaml` +Download the example above, and save it to a file named `web-parallel.yaml` This manifest is identical to the one you downloaded above except that the `.spec.podManagementPolicy` of the `web` StatefulSet is set to `Parallel`. @@ -943,7 +947,7 @@ kubectl get po -l app=nginx -w In another terminal, create the StatefulSet and Service in the manifest. ```shell -kubectl create -f webp.yaml +kubectl create -f web-parallel.yaml service "nginx" created statefulset "web" created ``` diff --git a/content/en/docs/tutorials/stateful-application/cassandra.md b/content/en/docs/tutorials/stateful-application/cassandra.md index fc9b617cdf45d..88b3aa5212bc2 100644 --- a/content/en/docs/tutorials/stateful-application/cassandra.md +++ b/content/en/docs/tutorials/stateful-application/cassandra.md @@ -15,7 +15,10 @@ Deploying stateful distributed applications, like Cassandra, within a clustered The Pods use the [`gcr.io/google-samples/cassandra:v13`](https://github.com/kubernetes/examples/blob/master/cassandra/image/Dockerfile) image from Google's [container registry](https://cloud.google.com/container-registry/docs/). -The docker image above is based on [debian-base](https://github.com/kubernetes/kubernetes/tree/master/build/debian-base) and includes OpenJDK 8. This image includes a standard Cassandra installation from the Apache Debian repo. By using environment variables you can change values that are inserted into `cassandra.yaml`. +The docker image above is based on [debian-base](https://github.com/kubernetes/kubernetes/tree/master/build/debian-base) +and includes OpenJDK 8. +This image includes a standard Cassandra installation from the Apache Debian repo. +By using environment variables you can change values that are inserted into `cassandra.yaml`. | ENV VAR | DEFAULT VALUE | | ------------- |:-------------: | @@ -38,7 +41,8 @@ To complete this tutorial, you should already have a basic familiarity with [Pod * [Install and Configure](/docs/tasks/tools/install-kubectl/) the `kubectl` command line -* Download [cassandra-service.yaml](/docs/tutorials/stateful-application/cassandra/cassandra-service.yaml) and [cassandra-statefulset.yaml](/docs/tutorials/stateful-application/cassandra/cassandra-statefulset.yaml) +* Download [cassandra-service.yaml](/examples/application/cassandra/cassandra-service.yaml) + and [cassandra-statefulset.yaml](/examples/application/cassandra/cassandra-statefulset.yaml) * Have a supported Kubernetes Cluster running @@ -64,12 +68,14 @@ A Kubernetes [Service](/docs/concepts/services-networking/service/) describes a The following `Service` is used for DNS lookups between Cassandra Pods and clients within the Kubernetes Cluster. -1. Launch a terminal window in the directory you downloaded the manifest files. -2. Create a `Service` to track all Cassandra StatefulSet Nodes from the `cassandra-service.yaml` file: +{{< codenew file="application/cassandra/cassandra-service.yaml" >}} - kubectl create -f cassandra-service.yaml +1. Launch a terminal window in the directory you downloaded the manifest files. +1. Create a `Service` to track all Cassandra StatefulSet Nodes from the `cassandra-service.yaml` file: -{{< code file="cassandra/cassandra-service.yaml" >}} + ```shell + kubectl create -f https://k8s.io/examples/application/cassandra/cassandra-service.yaml + ``` ### Validating (optional) @@ -92,106 +98,127 @@ The StatefulSet manifest, included below, creates a Cassandra ring that consists **Note:** This example uses the default provisioner for Minikube. Please update the following StatefulSet for the cloud you are working with. {{< /note >}} -1. Update the StatefulSet if necessary. -2. Create the Cassandra StatefulSet from the `cassandra-statefulset.yaml` file: +{{< codenew file="application/cassandra/cassandra-statefulset.yaml" >}} - kubectl create -f cassandra-statefulset.yaml +1. Update the StatefulSet if necessary. +1. Create the Cassandra StatefulSet from the `cassandra-statefulset.yaml` file: -{{< code file="cassandra/cassandra-statefulset.yaml" >}} + ```shell + kubectl create -f https://k8s.io/examples/application/cassandra/cassandra-statefulset.yaml + ``` ## Validating The Cassandra StatefulSet 1. Get the Cassandra StatefulSet: - kubectl get statefulset cassandra + ``` + kubectl get statefulset cassandra + ``` - The response should be + The response should be - NAME DESIRED CURRENT AGE - cassandra 3 0 13s + ``` + NAME DESIRED CURRENT AGE + cassandra 3 0 13s + ``` - The StatefulSet resource deploys Pods sequentially. + The StatefulSet resource deploys Pods sequentially. -2. Get the Pods to see the ordered creation status: +1. Get the Pods to see the ordered creation status: - kubectl get pods -l="app=cassandra" + ```shell + kubectl get pods -l="app=cassandra" + ``` - The response should be - - NAME READY STATUS RESTARTS AGE - cassandra-0 1/1 Running 0 1m - cassandra-1 0/1 ContainerCreating 0 8s + The response should be + + ``` + NAME READY STATUS RESTARTS AGE + cassandra-0 1/1 Running 0 1m + cassandra-1 0/1 ContainerCreating 0 8s + ``` - {{< note >}} - **Note:** It can take up to ten minutes for all three Pods to deploy. - {{< /note >}} + **Note:** It can take up to ten minutes for all three Pods to deploy. - Once all Pods are deployed, the same command returns: + Once all Pods are deployed, the same command returns: - NAME READY STATUS RESTARTS AGE - cassandra-0 1/1 Running 0 10m - cassandra-1 1/1 Running 0 9m - cassandra-2 1/1 Running 0 8m + ``` + NAME READY STATUS RESTARTS AGE + cassandra-0 1/1 Running 0 10m + cassandra-1 1/1 Running 0 9m + cassandra-2 1/1 Running 0 8m + ``` -3. Run the Cassandra utility nodetool to display the status of the ring. +1. Run the Cassandra utility nodetool to display the status of the ring. - kubectl exec cassandra-0 -- nodetool status + ```shell + kubectl exec cassandra-0 -- nodetool status + ``` - The response is: + The response is: - Datacenter: DC1-K8Demo - ====================== - Status=Up/Down - |/ State=Normal/Leaving/Joining/Moving - -- Address Load Tokens Owns (effective) Host ID Rack - UN 172.17.0.5 83.57 KiB 32 74.0% e2dd09e6-d9d3-477e-96c5-45094c08db0f Rack1-K8Demo - UN 172.17.0.4 101.04 KiB 32 58.8% f89d6835-3a42-4419-92b3-0e62cae1479c Rack1-K8Demo - UN 172.17.0.6 84.74 KiB 32 67.1% a6a1e8c2-3dc5-4417-b1a0-26507af2aaad Rack1-K8Demo + ``` + Datacenter: DC1-K8Demo + ====================== + Status=Up/Down + |/ State=Normal/Leaving/Joining/Moving + -- Address Load Tokens Owns (effective) Host ID Rack + UN 172.17.0.5 83.57 KiB 32 74.0% e2dd09e6-d9d3-477e-96c5-45094c08db0f Rack1-K8Demo + UN 172.17.0.4 101.04 KiB 32 58.8% f89d6835-3a42-4419-92b3-0e62cae1479c Rack1-K8Demo + UN 172.17.0.6 84.74 KiB 32 67.1% a6a1e8c2-3dc5-4417-b1a0-26507af2aaad Rack1-K8Demo + ``` ## Modifying the Cassandra StatefulSet + Use `kubectl edit` to modify the size of a Cassandra StatefulSet. 1. Run the following command: - kubectl edit statefulset cassandra + ``` + kubectl edit statefulset cassandra + ``` - This command opens an editor in your terminal. The line you need to change is the `replicas` field. + This command opens an editor in your terminal. The line you need to change is the `replicas` field. - {{< note >}} - **Note:** The following sample is an excerpt of the StatefulSet file. - {{< /note >}} - - # Please edit the object below. Lines beginning with a '#' will be ignored, - # and an empty file will abort the edit. If an error occurs while saving this file will be - # reopened with the relevant failures. - # - apiVersion: apps/v1 # for versions before 1.9.0 use apps/v1beta2 - kind: StatefulSet - metadata: - creationTimestamp: 2016-08-13T18:40:58Z - generation: 1 - labels: - app: cassandra - name: cassandra - namespace: default - resourceVersion: "323" - selfLink: /apis/apps/v1/namespaces/default/statefulsets/cassandra - uid: 7a219483-6185-11e6-a910-42010a8a0fc0 - spec: - replicas: 3 - -2. Change the number of replicas to 4, and then save the manifest. + **Note:** The following sample is an excerpt of the StatefulSet file. + + ``` + # Please edit the object below. Lines beginning with a '#' will be ignored, + # and an empty file will abort the edit. If an error occurs while saving this file will be + # reopened with the relevant failures. + # + apiVersion: apps/v1 # for versions before 1.9.0 use apps/v1beta2 + kind: StatefulSet + metadata: + creationTimestamp: 2016-08-13T18:40:58Z + generation: 1 + labels: + app: cassandra + name: cassandra + namespace: default + resourceVersion: "323" + selfLink: /apis/apps/v1/namespaces/default/statefulsets/cassandra + uid: 7a219483-6185-11e6-a910-42010a8a0fc0 + spec: + replicas: 3 + ``` + +1. Change the number of replicas to 4, and then save the manifest. The StatefulSet now contains 4 Pods. -3. Get the Cassandra StatefulSet to verify: +1. Get the Cassandra StatefulSet to verify: - kubectl get statefulset cassandra + ```shell + kubectl get statefulset cassandra + ``` - The response should be + The response should be - NAME DESIRED CURRENT AGE - cassandra 4 4 36m + ``` + NAME DESIRED CURRENT AGE + cassandra 4 4 36m + ``` {{% /capture %}} @@ -204,19 +231,24 @@ Deleting or scaling a StatefulSet down does not delete the volumes associated wi 1. Run the following commands to delete everything in a `StatefulSet`: - grace=$(kubectl get po cassandra-0 -o=jsonpath='{.spec.terminationGracePeriodSeconds}') \ + ```shell + grace=$(kubectl get po cassandra-0 -o=jsonpath='{.spec.terminationGracePeriodSeconds}') \ && kubectl delete statefulset -l app=cassandra \ && echo "Sleeping $grace" \ && sleep $grace \ && kubectl delete pvc -l app=cassandra + ``` -2. Run the following command to delete the Cassandra `Service`. +1. Run the following command to delete the Cassandra `Service`. - kubectl delete service -l app=cassandra + ``` + kubectl delete service -l app=cassandra + ``` {{% /capture %}} {{% capture whatsnext %}} + * Learn how to [Scale a StatefulSet](/docs/tasks/run-application/scale-stateful-set/). * Learn more about the [KubernetesSeedProvider](https://github.com/kubernetes/examples/blob/master/cassandra/java/src/main/java/io/k8s/cassandra/KubernetesSeedProvider.java) * See more custom [Seed Provider Configurations](https://git.k8s.io/examples/cassandra/java/README.md) diff --git a/content/en/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md b/content/en/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md index 398b3b9e143cf..f4345dcac9b44 100644 --- a/content/en/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md +++ b/content/en/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md @@ -36,9 +36,9 @@ A [PersistentVolume](/docs/concepts/storage/persistent-volumes/) (PV) is a piece Download the following configuration files: -1. [mysql-deployment.yaml](/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/mysql-deployment.yaml) +1. [mysql-deployment.yaml](/examples/application/wordpress/mysql-deployment.yaml) -1. [wordpress-deployment.yaml](/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/wordpress-deployment.yaml) +1. [wordpress-deployment.yaml](/examples/application/wordpress/wordpress-deployment.yaml) {{% /capture %}} @@ -71,13 +71,13 @@ A [Secret](/docs/concepts/configuration/secret/) is an object that stores a piec 1. Create the Secret object from the following command. You will need to replace `YOUR_PASSWORD` with the password you want to use. - ``` + ```shell kubectl create secret generic mysql-pass --from-literal=password=YOUR_PASSWORD ``` 2. Verify that the Secret exists by running the following command: - ``` + ```shell kubectl get secrets ``` @@ -96,18 +96,18 @@ A [Secret](/docs/concepts/configuration/secret/) is an object that stores a piec The following manifest describes a single-instance MySQL Deployment. The MySQL container mounts the PersistentVolume at /var/lib/mysql. The `MYSQL_ROOT_PASSWORD` environment variable sets the database password from the Secret. -{{< code file="mysql-wordpress-persistent-volume/mysql-deployment.yaml" >}} +{{< codenew file="application/wordpress/mysql-deployment.yaml" >}} 1. Deploy MySQL from the `mysql-deployment.yaml` file: - ``` - kubectl create -f mysql-deployment.yaml + ```shell + kubectl create -f https://k8s.io/examples/application/wordpress/mysql-deployment.yaml ``` 2. Verify that a PersistentVolume got dynamically provisioned. Note that it can It can take up to a few minutes for the PVs to be provisioned and bound. - ``` + ```shell kubectl get pvc ``` @@ -120,11 +120,11 @@ The following manifest describes a single-instance MySQL Deployment. The MySQL c 3. Verify that the Pod is running by running the following command: - ``` + ```shell kubectl get pods ``` - **Note:** It can take up to a few minutes for the Pod's Status to be `RUNNING`. + {{< note >}}**Note:** It can take up to a few minutes for the Pod's Status to be `RUNNING`.{{< /note >}} The response should be like this: @@ -137,21 +137,21 @@ The following manifest describes a single-instance MySQL Deployment. The MySQL c The following manifest describes a single-instance WordPress Deployment and Service. It uses many of the same features like a PVC for persistent storage and a Secret for the password. But it also uses a different setting: `type: LoadBalancer`. This setting exposes WordPress to traffic from outside of the cluster. -{{< code file="mysql-wordpress-persistent-volume/wordpress-deployment.yaml" >}} +{{< codenew file="application/wordpress/wordpress-deployment.yaml" >}} 1. Create a WordPress Service and Deployment from the `wordpress-deployment.yaml` file: - ``` - kubectl create -f wordpress-deployment.yaml + ```shell + kubectl create -f https://k8s.io/examples/wordpress/wordpress-deployment.yaml ``` 2. Verify that a PersistentVolume got dynamically provisioned: - ``` + ```shell kubectl get pvc ``` - **Note:** It can take up to a few minutes for the PVs to be provisioned and bound. + {{< note >}}**Note:** It can take up to a few minutes for the PVs to be provisioned and bound.{{< /note >}} The response should be like this: @@ -162,7 +162,7 @@ The following manifest describes a single-instance WordPress Deployment and Serv 3. Verify that the Service is running by running the following command: - ``` + ```shell kubectl get services wordpress ``` @@ -173,15 +173,11 @@ The following manifest describes a single-instance WordPress Deployment and Serv wordpress 10.0.0.89 80:32406/TCP 4m ``` - **Note:** Minikube can only expose Services through `NodePort`. - - ``` - The EXTERNAL-IP is always . - ``` + {{< note >}}**Note:** Minikube can only expose Services through `NodePort`. The EXTERNAL-IP is always pending.{{< /note >}} 4. Run the following command to get the IP Address for the WordPress Service: - ``` + ```shell minikube service wordpress --url ``` @@ -207,20 +203,20 @@ The following manifest describes a single-instance WordPress Deployment and Serv 1. Run the following command to delete your Secret: - ``` + ```shell kubectl delete secret mysql-pass ``` 2. Run the following commands to delete all Deployments and Services: - ``` + ```shell kubectl delete deployment -l app=wordpress kubectl delete service -l app=wordpress ``` 3. Run the following commands to delete the PersistentVolumeClaims. The dynamically provisioned PersistentVolumes will be automatically deleted. - ``` + ```shell kubectl delete pvc -l app=wordpress ``` @@ -235,4 +231,3 @@ The following manifest describes a single-instance WordPress Deployment and Serv {{% /capture %}} - diff --git a/content/en/docs/tutorials/stateful-application/zookeeper.md b/content/en/docs/tutorials/stateful-application/zookeeper.md index 394fb0cae360b..3fad9a04a3494 100644 --- a/content/en/docs/tutorials/stateful-application/zookeeper.md +++ b/content/en/docs/tutorials/stateful-application/zookeeper.md @@ -76,14 +76,14 @@ a [Service](/docs/concepts/services-networking/service/), a [PodDisruptionBudget](/docs/concepts/workloads/pods/disruptions//#specifying-a-poddisruptionbudget), and a [StatefulSet](/docs/concepts/workloads/controllers/statefulset/). -{{< code file="zookeeper.yaml" >}} +{{< codenew file="application/zookeeper/zookeeper.yaml" >}} Open a terminal, and use the [`kubectl apply`](/docs/reference/generated/kubectl/kubectl-commands/#apply) command to create the manifest. ```shell -kubectl apply -f https://k8s.io/docs/tutorials/stateful-application/zookeeper.yaml +kubectl apply -f https://k8s.io/examples/application/zookeeper/zookeeper.yaml ``` This creates the `zk-hs` Headless Service, the `zk-cs` Service, @@ -343,7 +343,7 @@ zk-0 0/1 Terminating 0 11m Reapply the manifest in `zookeeper.yaml`. ```shell -kubectl apply -f https://k8s.io/docs/tutorials/stateful-application/zookeeper.yaml +kubectl apply -f https://k8s.io/examples/application/zookeeper/zookeeper.yaml ``` This creates the `zk` StatefulSet object, but the other API objects in the manifest are not modified because they already exist. @@ -792,14 +792,14 @@ For a ZooKeeper server, liveness implies readiness. Therefore, the readiness probe from the `zookeeper.yaml` manifest is identical to the liveness probe. ```yaml - readinessProbe: - exec: - command: - - sh - - -c - - "zookeeper-ready 2181" - initialDelaySeconds: 15 - timeoutSeconds: 5 + readinessProbe: + exec: + command: + - sh + - -c + - "zookeeper-ready 2181" + initialDelaySeconds: 15 + timeoutSeconds: 5 ``` Even though the liveness and readiness probes are identical, it is important @@ -1065,7 +1065,11 @@ Attempt to drain the node on which `zk-2` is scheduled. ```shell kubectl drain $(kubectl get pod zk-2 --template {{.spec.nodeName}}) --ignore-daemonsets --force --delete-local-data +``` + +The output: +``` node "kubernetes-minion-group-i4c4" already cordoned WARNING: Deleting pods not managed by ReplicationController, ReplicaSet, Job, or DaemonSet: fluentd-cloud-logging-kubernetes-minion-group-i4c4, kube-proxy-kubernetes-minion-group-i4c4; Ignoring DaemonSet-managed pods: node-problem-detector-v0.1-dyrog pod "heapster-v1.2.0-2604621511-wht1r" deleted @@ -1079,7 +1083,9 @@ Uncordon the second node to allow `zk-2` to be rescheduled. ```shell kubectl uncordon kubernetes-minion-group-ixsl +``` +``` node "kubernetes-minion-group-ixsl" uncordoned ``` @@ -1089,10 +1095,11 @@ You can use `kubectl drain` in conjunction with `PodDisruptionBudgets` to ensure {{% capture cleanup %}} -- Use `kubectl uncordon` to uncordon all the nodes in your cluster. -- You will need to delete the persistent storage media for the PersistentVolumes - used in this tutorial. Follow the necessary steps, based on your environment, - storage configuration, and provisioning method, to ensure that all storage is - reclaimed. - {{% /capture %}} +- Use `kubectl uncordon` to uncordon all the nodes in your cluster. +- You will need to delete the persistent storage media for the PersistentVolumes + used in this tutorial. Follow the necessary steps, based on your environment, + storage configuration, and provisioning method, to ensure that all storage is + reclaimed. + +{{% /capture %}} diff --git a/content/en/docs/tutorials/stateless-application/deployment.yaml b/content/en/docs/tutorials/stateless-application/deployment.yaml deleted file mode 100644 index 485be0dabcdf2..0000000000000 --- a/content/en/docs/tutorials/stateless-application/deployment.yaml +++ /dev/null @@ -1,21 +0,0 @@ -apiVersion: apps/v1 -kind: Deployment -metadata: - name: nginx-deployment -spec: - selector: - matchLabels: - app: nginx - replicas: 2 # tells deployment to run 2 pods matching the template - template: # create pods using pod definition in this template - metadata: - # unlike pod-nginx.yaml, the name is not included in the meta data as a unique name is - # generated from the deployment name - labels: - app: nginx - spec: - containers: - - name: nginx - image: nginx:1.7.9 - ports: - - containerPort: 80 diff --git a/content/en/docs/tutorials/stateless-application/guestbook.md b/content/en/docs/tutorials/stateless-application/guestbook.md index 2657f43f7b634..36052973dd293 100644 --- a/content/en/docs/tutorials/stateless-application/guestbook.md +++ b/content/en/docs/tutorials/stateless-application/guestbook.md @@ -28,12 +28,12 @@ This tutorial shows you how to build and deploy a simple, multi-tier web applica {{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} Download the following configuration files: -1. [redis-master-deployment.yaml](/docs/tutorials/stateless-application/guestbook/redis-master-deployment.yaml) -1. [redis-master-service.yaml](/docs/tutorials/stateless-application/guestbook/redis-master-service.yaml) -1. [redis-slave-deployment.yaml](/docs/tutorials/stateless-application/guestbook/redis-slave-deployment.yaml) -1. [redis-slave-service.yaml](/docs/tutorials/stateless-application/guestbook/redis-slave-service.yaml) -1. [frontend-deployment.yaml](/docs/tutorials/stateless-application/guestbook/frontend-deployment.yaml) -1. [frontend-service.yaml](/docs/tutorials/stateless-application/guestbook/frontend-service.yaml) +1. [redis-master-deployment.yaml](/examples/application/guestbook/redis-master-deployment.yaml) +1. [redis-master-service.yaml](/examples/application/guestbook/redis-master-service.yaml) +1. [redis-slave-deployment.yaml](/examples/application/guestbook/redis-slave-deployment.yaml) +1. [redis-slave-service.yaml](/examples/application/guestbook/redis-slave-service.yaml) +1. [frontend-deployment.yaml](/examples/application/guestbook/frontend-deployment.yaml) +1. [frontend-service.yaml](/examples/application/guestbook/frontend-service.yaml) {{% /capture %}} @@ -47,27 +47,34 @@ The guestbook application uses Redis to store its data. It writes its data to a The manifest file, included below, specifies a Deployment controller that runs a single replica Redis master Pod. +{{< codenew file="application/guestbook/redis-master-deployment.yaml" >}} + 1. Launch a terminal window in the directory you downloaded the manifest files. -2. Apply the Redis Master Deployment from the `redis-master-deployment.yaml` file: - ``` - kubectl apply -f redis-master-deployment.yaml - ``` - {{< code file="guestbook/redis-master-deployment.yaml" >}} - -3. Query the list of Pods to verify that the Redis Master Pod is running: - ``` - kubectl get pods - ``` - The response should be similar to this: - ``` - NAME READY STATUS RESTARTS AGE - redis-master-1068406935-3lswp 1/1 Running 0 28s - ``` - -4. Run the following command to view the logs from the Redis Master Pod: - ``` - kubectl logs -f POD-NAME - ``` +1. Apply the Redis Master Deployment from the `redis-master-deployment.yaml` file: + + ``` + kubectl apply -f https://k8s.io/examples/application/guestbook/redis-master-deployment.yaml + ``` + +1. Query the list of Pods to verify that the Redis Master Pod is running: + + ```shell + kubectl get pods + ``` + + The response should be similar to this: + + ```shell + NAME READY STATUS RESTARTS AGE + redis-master-1068406935-3lswp 1/1 Running 0 28s + ``` + +1. Run the following command to view the logs from the Redis Master Pod: + + ```shell + kubectl logs -f POD-NAME + ``` + {{< note >}} **Note:** Replace POD-NAME with the name of your Pod. {{< /note >}} @@ -76,29 +83,32 @@ The manifest file, included below, specifies a Deployment controller that runs a The guestbook applications needs to communicate to the Redis master to write its data. You need to apply a [Service](/docs/concepts/services-networking/service/) to proxy the traffic to the Redis master Pod. A Service defines a policy to access the Pods. +{{< codenew file="application/guestbook/redis-master-service.yaml" >}} + 1. Apply the Redis Master Service from the following `redis-master-service.yaml` file: - ``` - kubectl apply -f redis-master-service.yaml - ``` - {{< code file="guestbook/redis-master-service.yaml" >}} -{{< note >}} -**Note:** This manifest file creates a Service named `redis-master` with a set of labels that match the labels previously defined, so the Service routes network traffic to the Redis master Pod. -{{< /note >}} + ```shell + kubectl apply -f https://k8s.io/examples/application/guestbook/redis-master-service.yaml + ``` + +1. Query the list of Services to verify that the Redis Master Service is running: -2. Query the list of Services to verify that the Redis Master Service is running: + ```shell + kubectl get service + ``` - ``` - kubectl get service - ``` + The response should be similar to this: - The response should be similar to this: + ```shell + NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE + kubernetes 10.0.0.1 443/TCP 1m + redis-master 10.0.0.151 6379/TCP 8s + ``` + +{{< note >}} +**Note:** This manifest file creates a Service named `redis-master` with a set of labels that match the labels previously defined, so the Service routes network traffic to the Redis master Pod. +{{< /note >}} - ``` - NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE - kubernetes 10.0.0.1 443/TCP 1m - redis-master 10.0.0.151 6379/TCP 8s - ``` ## Start up the Redis Slaves @@ -110,55 +120,55 @@ Deployments scale based off of the configurations set in the manifest file. In t If there are not any replicas running, this Deployment would start the two replicas on your container cluster. Conversely, if there are more than two replicas are running, it would scale down until two replicas are running. +{{< codenew file="application/guestbook/redis-slave-deployment.yaml" >}} + 1. Apply the Redis Slave Deployment from the `redis-slave-deployment.yaml` file: - ``` - kubectl apply -f redis-slave-deployment.yaml - ``` + ```shell + kubectl apply -f https://k8s.io/examples/application/guestbook/redis-slave-deployment.yaml + ``` - {{< code file="guestbook/redis-slave-deployment.yaml" >}} +1. Query the list of Pods to verify that the Redis Slave Pods are running: -2. Query the list of Pods to verify that the Redis Slave Pods are running: + ```shell + kubectl get pods + ``` - ``` - kubectl get pods - ``` + The response should be similar to this: - The response should be similar to this: + ```shell + NAME READY STATUS RESTARTS AGE + redis-master-1068406935-3lswp 1/1 Running 0 1m + redis-slave-2005841000-fpvqc 0/1 ContainerCreating 0 6s + redis-slave-2005841000-phfv9 0/1 ContainerCreating 0 6s + ``` - ``` - NAME READY STATUS RESTARTS AGE - redis-master-1068406935-3lswp 1/1 Running 0 1m - redis-slave-2005841000-fpvqc 0/1 ContainerCreating 0 6s - redis-slave-2005841000-phfv9 0/1 ContainerCreating 0 6s - ``` - ### Creating the Redis Slave Service The guestbook application needs to communicate to Redis slaves to read data. To make the Redis slaves discoverable, you need to set up a Service. A Service provides transparent load balancing to a set of Pods. -1. Apply the Redis Slave Service from the following `redis-slave-service.yaml` file: +{{< codenew file="application/guestbook/redis-slave-service.yaml" >}} - ``` - kubectl apply -f redis-slave-service.yaml - ``` +1. Apply the Redis Slave Service from the following `redis-slave-service.yaml` file: - {{< code file="guestbook/redis-slave-service.yaml" >}} + ```shell + kubectl apply -f https://k8s.io/examples/application/guestbook/redis-slave-service.yaml + ``` -2. Query the list of Services to verify that the Redis Slave Service is running: +1. Query the list of Services to verify that the Redis slave service is running: - ``` - kubectl get services - ``` + ```shell + kubectl get services + ``` - The response should be similar to this: + The response should be similar to this: - ``` - NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE - kubernetes 10.0.0.1 443/TCP 2m - redis-master 10.0.0.151 6379/TCP 1m - redis-slave 10.0.0.223 6379/TCP 6s - ``` + ``` + NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE + kubernetes 10.0.0.1 443/TCP 2m + redis-master 10.0.0.151 6379/TCP 1m + redis-slave 10.0.0.223 6379/TCP 6s + ``` ## Set up and Expose the Guestbook Frontend @@ -166,28 +176,28 @@ The guestbook application has a web frontend serving the HTTP requests written i ### Creating the Guestbook Frontend Deployment -1. Apply the frontend Deployment from the following `frontend-deployment.yaml` file: +{{< codenew file="application/guestbook/frontend-deployment.yaml" >}} - ``` - kubectl apply -f frontend-deployment.yaml - ``` +1. Apply the frontend Deployment from the `frontend-deployment.yaml` file: - {{< code file="guestbook/frontend-deployment.yaml" >}} + ```shell + kubectl apply -f https://k8s.io/examples/application/guestbook/frontend-deployment.yaml + ``` -2. Query the list of Pods to verify that the three frontend replicas are running: +1. Query the list of Pods to verify that the three frontend replicas are running: - ``` - kubectl get pods -l app=guestbook -l tier=frontend - ``` + ```shell + kubectl get pods -l app=guestbook -l tier=frontend + ``` - The response should be similar to this: + The response should be similar to this: - ``` - NAME READY STATUS RESTARTS AGE - frontend-3823415956-dsvc5 1/1 Running 0 54s - frontend-3823415956-k22zn 1/1 Running 0 54s - frontend-3823415956-w9gbt 1/1 Running 0 54s - ``` + ``` + NAME READY STATUS RESTARTS AGE + frontend-3823415956-dsvc5 1/1 Running 0 54s + frontend-3823415956-k22zn 1/1 Running 0 54s + frontend-3823415956-w9gbt 1/1 Running 0 54s + ``` ### Creating the Frontend Service @@ -199,29 +209,29 @@ If you want guests to be able to access your guestbook, you must configure the f **Note:** Some cloud providers, like Google Compute Engine or Google Kubernetes Engine, support external load balancers. If your cloud provider supports load balancers and you want to use it, simply delete or comment out `type: NodePort`, and uncomment `type: LoadBalancer`. {{< /note >}} -1. Apply the frontend Service from the following `frontend-service.yaml` file: +{{< codenew file="application/guestbook/frontend-service.yaml" >}} - ``` - kubectl apply -f frontend-service.yaml - ``` - - {{< code file="guestbook/frontend-service.yaml" >}} +1. Apply the frontend Service from the `frontend-service.yaml` file: -2. Query the list of Services to verify that the frontend Service is running: + ```shell + kubectl apply -f https://k8s.io/examples/application/guestbook/frontend-service.yaml + ``` - ``` - kubectl get services - ``` +1. Query the list of Services to verify that the frontend Service is running: - The response should be similar to this: + ```shell + kubectl get services + ``` - ``` - NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE - frontend 10.0.0.112 80:31323/TCP 6s - kubernetes 10.0.0.1 443/TCP 4m - redis-master 10.0.0.151 6379/TCP 2m - redis-slave 10.0.0.223 6379/TCP 1m - ``` + The response should be similar to this: + + ``` + NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE + frontend 10.0.0.112 80:31323/TCP 6s + kubernetes 10.0.0.1 443/TCP 4m + redis-master 10.0.0.151 6379/TCP 2m + redis-slave 10.0.0.223 6379/TCP 1m + ``` ### Viewing the Frontend Service via `NodePort` @@ -229,17 +239,17 @@ If you deployed this application to Minikube or a local cluster, you need to fin 1. Run the following command to get the IP address for the frontend Service. - ``` - minikube service frontend --url - ``` + ```shell + minikube service frontend --url + ``` - The response should be similar to this: + The response should be similar to this: - ``` - http://192.168.99.100:31323 - ``` + ``` + http://192.168.99.100:31323 + ``` -2. Copy the IP address, and load the page in your browser to view your guestbook. +1. Copy the IP address, and load the page in your browser to view your guestbook. ### Viewing the Frontend Service via `LoadBalancer` @@ -247,18 +257,18 @@ If you deployed the `frontend-service.yaml` manifest with type: `LoadBalancer` y 1. Run the following command to get the IP address for the frontend Service. - ``` - kubectl get service frontend - ``` + ```shell + kubectl get service frontend + ``` - The response should be similar to this: + The response should be similar to this: - ``` - NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE - frontend 10.51.242.136 109.197.92.229 80:32372/TCP 1m - ``` + ``` + NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE + frontend 10.51.242.136 109.197.92.229 80:32372/TCP 1m + ``` -2. Copy the External IP address, and load the page in your browser to view your guestbook. +1. Copy the external IP address, and load the page in your browser to view your guestbook. ## Scale the Web Frontend @@ -266,52 +276,52 @@ Scaling up or down is easy because your servers are defined as a Service that us 1. Run the following command to scale up the number of frontend Pods: - ``` - kubectl scale deployment frontend --replicas=5 - ``` + ```shell + kubectl scale deployment frontend --replicas=5 + ``` -2. Query the list of Pods to verify the number of frontend Pods running: +1. Query the list of Pods to verify the number of frontend Pods running: - ``` - kubectl get pods - ``` + ```shell + kubectl get pods + ``` - The response should look similar to this: + The response should look similar to this: - ``` - NAME READY STATUS RESTARTS AGE - frontend-3823415956-70qj5 1/1 Running 0 5s - frontend-3823415956-dsvc5 1/1 Running 0 54m - frontend-3823415956-k22zn 1/1 Running 0 54m - frontend-3823415956-w9gbt 1/1 Running 0 54m - frontend-3823415956-x2pld 1/1 Running 0 5s - redis-master-1068406935-3lswp 1/1 Running 0 56m - redis-slave-2005841000-fpvqc 1/1 Running 0 55m - redis-slave-2005841000-phfv9 1/1 Running 0 55m - ``` + ``` + NAME READY STATUS RESTARTS AGE + frontend-3823415956-70qj5 1/1 Running 0 5s + frontend-3823415956-dsvc5 1/1 Running 0 54m + frontend-3823415956-k22zn 1/1 Running 0 54m + frontend-3823415956-w9gbt 1/1 Running 0 54m + frontend-3823415956-x2pld 1/1 Running 0 5s + redis-master-1068406935-3lswp 1/1 Running 0 56m + redis-slave-2005841000-fpvqc 1/1 Running 0 55m + redis-slave-2005841000-phfv9 1/1 Running 0 55m + ``` -3. Run the following command to scale down the number of frontend Pods: +1. Run the following command to scale down the number of frontend Pods: - ``` - kubectl scale deployment frontend --replicas=2 - ``` + ```shell + kubectl scale deployment frontend --replicas=2 + ``` -4. Query the list of Pods to verify the number of frontend Pods running: +1. Query the list of Pods to verify the number of frontend Pods running: - ``` - kubectl get pods - ``` + ```shell + kubectl get pods + ``` - The response should look similar to this: + The response should look similar to this: - ``` - NAME READY STATUS RESTARTS AGE - frontend-3823415956-k22zn 1/1 Running 0 1h - frontend-3823415956-w9gbt 1/1 Running 0 1h - redis-master-1068406935-3lswp 1/1 Running 0 1h - redis-slave-2005841000-fpvqc 1/1 Running 0 1h - redis-slave-2005841000-phfv9 1/1 Running 0 1h - ``` + ``` + NAME READY STATUS RESTARTS AGE + frontend-3823415956-k22zn 1/1 Running 0 1h + frontend-3823415956-w9gbt 1/1 Running 0 1h + redis-master-1068406935-3lswp 1/1 Running 0 1h + redis-slave-2005841000-fpvqc 1/1 Running 0 1h + redis-slave-2005841000-phfv9 1/1 Running 0 1h + ``` {{% /capture %}} @@ -320,36 +330,36 @@ Deleting the Deployments and Services also deletes any running Pods. Use labels 1. Run the following commands to delete all Pods, Deployments, and Services. - ``` - kubectl delete deployment -l app=redis - kubectl delete service -l app=redis - kubectl delete deployment -l app=guestbook - kubectl delete service -l app=guestbook - ``` - - The responses should be: - - ``` - deployment "redis-master" deleted - deployment "redis-slave" deleted - service "redis-master" deleted - service "redis-slave" deleted - deployment "frontend" deleted - service "frontend" deleted - ``` + ```shell + kubectl delete deployment -l app=redis + kubectl delete service -l app=redis + kubectl delete deployment -l app=guestbook + kubectl delete service -l app=guestbook + ``` + + The responses should be: + + ``` + deployment "redis-master" deleted + deployment "redis-slave" deleted + service "redis-master" deleted + service "redis-slave" deleted + deployment "frontend" deleted + service "frontend" deleted + ``` -2. Query the list of Pods to verify that no Pods are running: +1. Query the list of Pods to verify that no Pods are running: - ``` - kubectl get pods - ``` - - The response should be this: + ```shell + kubectl get pods + ``` + + The response should be this: + + ``` + No resources found. + ``` - ``` - No resources found. - ``` - {{% /capture %}} {{% capture whatsnext %}} diff --git a/content/en/docs/user-journeys/_index.md b/content/en/docs/user-journeys/_index.md deleted file mode 100644 index cfcbab5728fcb..0000000000000 --- a/content/en/docs/user-journeys/_index.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -toc_hide: true ---- diff --git a/content/en/docs/user-journeys/users/application-developer/_index.md b/content/en/docs/user-journeys/users/application-developer/_index.md deleted file mode 100755 index cb7beac793b94..0000000000000 --- a/content/en/docs/user-journeys/users/application-developer/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Application Developer" -weight: 10 ---- - diff --git a/content/en/docs/user-journeys/users/cluster-operator/_index.md b/content/en/docs/user-journeys/users/cluster-operator/_index.md deleted file mode 100755 index 1748e90fb4da0..0000000000000 --- a/content/en/docs/user-journeys/users/cluster-operator/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Cluster Operator" -weight: 20 ---- - diff --git a/content/en/docs/user-journeys/users/cluster-operator/intermediate.md b/content/en/docs/user-journeys/users/cluster-operator/intermediate.md index 68761eb7399e9..124e13dfbfd19 100644 --- a/content/en/docs/user-journeys/users/cluster-operator/intermediate.md +++ b/content/en/docs/user-journeys/users/cluster-operator/intermediate.md @@ -89,7 +89,7 @@ Kubernetes also supports a [core metrics pipeline](/docs/tasks/debug-application A common configuration on [Minikube](https://github.com/kubernetes/minikube) and some Kubernetes clusters uses [Heapster](https://github.com/kubernetes/heapster) [along with InfluxDB and Grafana](https://github.com/kubernetes/heapster/blob/master/docs/influxdb.md). There is a [walkthrough of how to install this configuration in your cluster](https://blog.kublr.com/how-to-utilize-the-heapster-influxdb-grafana-stack-in-kubernetes-for-monitoring-pods-4a553f4d36c9). -As of Kubernetes 1.9, the [sig-instrumentation](https://github.com/kubernetes/community/tree/master/sig-instrumentation) team is shifting away from an all-inclusive monitoring pattern with heapster, described in [Prometheus vs. Heapster vs. Kubernetes Metrics APIs](https://brancz.com/2018/01/05/prometheus-vs-heapster-vs-kubernetes-metrics-apis/). +As of Kubernetes 1.11, Heapster is deprecated, as per [sig-instrumentation](https://github.com/kubernetes/community/tree/master/sig-instrumentation). See [Prometheus vs. Heapster vs. Kubernetes Metrics APIs](https://brancz.com/2018/01/05/prometheus-vs-heapster-vs-kubernetes-metrics-apis/) for more information alternatives. Hosted data analytics services such as [Datadog](https://docs.datadoghq.com/integrations/kubernetes/) also offer Kubernetes integration. diff --git a/content/en/docs/tasks/administer-cluster/cloud-controller-manager-daemonset-example.yaml b/content/en/examples/admin/cloud/ccm-example.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/cloud-controller-manager-daemonset-example.yaml rename to content/en/examples/admin/cloud/ccm-example.yaml diff --git a/content/en/docs/tasks/administer-cluster/persistent-volume-label-initializer-config.yaml b/content/en/examples/admin/cloud/pvl-initializer-config.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/persistent-volume-label-initializer-config.yaml rename to content/en/examples/admin/cloud/pvl-initializer-config.yaml diff --git a/content/en/docs/tasks/administer-cluster/busybox.yaml b/content/en/examples/admin/dns/busybox.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/busybox.yaml rename to content/en/examples/admin/dns/busybox.yaml diff --git a/content/en/docs/tasks/administer-cluster/dns-horizontal-autoscaler.yaml b/content/en/examples/admin/dns/dns-horizontal-autoscaler.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/dns-horizontal-autoscaler.yaml rename to content/en/examples/admin/dns/dns-horizontal-autoscaler.yaml diff --git a/content/en/docs/tasks/administer-cluster/namespace-dev.json b/content/en/examples/admin/namespace-dev.json similarity index 100% rename from content/en/docs/tasks/administer-cluster/namespace-dev.json rename to content/en/examples/admin/namespace-dev.json diff --git a/content/en/docs/tasks/administer-cluster/namespace-prod.json b/content/en/examples/admin/namespace-prod.json similarity index 100% rename from content/en/docs/tasks/administer-cluster/namespace-prod.json rename to content/en/examples/admin/namespace-prod.json diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/cpu-constraints-pod-2.yaml b/content/en/examples/admin/resource/cpu-constraints-pod-2.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/cpu-constraints-pod-2.yaml rename to content/en/examples/admin/resource/cpu-constraints-pod-2.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/cpu-constraints-pod-3.yaml b/content/en/examples/admin/resource/cpu-constraints-pod-3.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/cpu-constraints-pod-3.yaml rename to content/en/examples/admin/resource/cpu-constraints-pod-3.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/cpu-constraints-pod-4.yaml b/content/en/examples/admin/resource/cpu-constraints-pod-4.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/cpu-constraints-pod-4.yaml rename to content/en/examples/admin/resource/cpu-constraints-pod-4.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/cpu-constraints-pod.yaml b/content/en/examples/admin/resource/cpu-constraints-pod.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/cpu-constraints-pod.yaml rename to content/en/examples/admin/resource/cpu-constraints-pod.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/cpu-constraints.yaml b/content/en/examples/admin/resource/cpu-constraints.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/cpu-constraints.yaml rename to content/en/examples/admin/resource/cpu-constraints.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/cpu-defaults-pod-2.yaml b/content/en/examples/admin/resource/cpu-defaults-pod-2.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/cpu-defaults-pod-2.yaml rename to content/en/examples/admin/resource/cpu-defaults-pod-2.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/cpu-defaults-pod-3.yaml b/content/en/examples/admin/resource/cpu-defaults-pod-3.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/cpu-defaults-pod-3.yaml rename to content/en/examples/admin/resource/cpu-defaults-pod-3.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/cpu-defaults-pod.yaml b/content/en/examples/admin/resource/cpu-defaults-pod.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/cpu-defaults-pod.yaml rename to content/en/examples/admin/resource/cpu-defaults-pod.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/cpu-defaults.yaml b/content/en/examples/admin/resource/cpu-defaults.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/cpu-defaults.yaml rename to content/en/examples/admin/resource/cpu-defaults.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/memory-constraints-pod-2.yaml b/content/en/examples/admin/resource/memory-constraints-pod-2.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/memory-constraints-pod-2.yaml rename to content/en/examples/admin/resource/memory-constraints-pod-2.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/memory-constraints-pod-3.yaml b/content/en/examples/admin/resource/memory-constraints-pod-3.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/memory-constraints-pod-3.yaml rename to content/en/examples/admin/resource/memory-constraints-pod-3.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/memory-constraints-pod-4.yaml b/content/en/examples/admin/resource/memory-constraints-pod-4.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/memory-constraints-pod-4.yaml rename to content/en/examples/admin/resource/memory-constraints-pod-4.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/memory-constraints-pod.yaml b/content/en/examples/admin/resource/memory-constraints-pod.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/memory-constraints-pod.yaml rename to content/en/examples/admin/resource/memory-constraints-pod.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/memory-constraints.yaml b/content/en/examples/admin/resource/memory-constraints.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/memory-constraints.yaml rename to content/en/examples/admin/resource/memory-constraints.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/memory-defaults-pod-2.yaml b/content/en/examples/admin/resource/memory-defaults-pod-2.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/memory-defaults-pod-2.yaml rename to content/en/examples/admin/resource/memory-defaults-pod-2.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/memory-defaults-pod-3.yaml b/content/en/examples/admin/resource/memory-defaults-pod-3.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/memory-defaults-pod-3.yaml rename to content/en/examples/admin/resource/memory-defaults-pod-3.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/memory-defaults-pod.yaml b/content/en/examples/admin/resource/memory-defaults-pod.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/memory-defaults-pod.yaml rename to content/en/examples/admin/resource/memory-defaults-pod.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/memory-defaults.yaml b/content/en/examples/admin/resource/memory-defaults.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/memory-defaults.yaml rename to content/en/examples/admin/resource/memory-defaults.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/quota-mem-cpu-pod-2.yaml b/content/en/examples/admin/resource/quota-mem-cpu-pod-2.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/quota-mem-cpu-pod-2.yaml rename to content/en/examples/admin/resource/quota-mem-cpu-pod-2.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/quota-mem-cpu-pod.yaml b/content/en/examples/admin/resource/quota-mem-cpu-pod.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/quota-mem-cpu-pod.yaml rename to content/en/examples/admin/resource/quota-mem-cpu-pod.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/quota-mem-cpu.yaml b/content/en/examples/admin/resource/quota-mem-cpu.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/quota-mem-cpu.yaml rename to content/en/examples/admin/resource/quota-mem-cpu.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/quota-objects-pvc-2.yaml b/content/en/examples/admin/resource/quota-objects-pvc-2.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/quota-objects-pvc-2.yaml rename to content/en/examples/admin/resource/quota-objects-pvc-2.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/quota-objects-pvc.yaml b/content/en/examples/admin/resource/quota-objects-pvc.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/quota-objects-pvc.yaml rename to content/en/examples/admin/resource/quota-objects-pvc.yaml diff --git a/content/en/docs/tasks/administer-cluster/quota-objects.yaml b/content/en/examples/admin/resource/quota-objects.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/quota-objects.yaml rename to content/en/examples/admin/resource/quota-objects.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/quota-pod-deployment.yaml b/content/en/examples/admin/resource/quota-pod-deployment.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/quota-pod-deployment.yaml rename to content/en/examples/admin/resource/quota-pod-deployment.yaml diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/quota-pod.yaml b/content/en/examples/admin/resource/quota-pod.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/manage-resources/quota-pod.yaml rename to content/en/examples/admin/resource/quota-pod.yaml diff --git a/content/en/docs/tasks/administer-cluster/my-scheduler.yaml b/content/en/examples/admin/sched/my-scheduler.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/my-scheduler.yaml rename to content/en/examples/admin/sched/my-scheduler.yaml diff --git a/content/en/docs/tasks/administer-cluster/pod1.yaml b/content/en/examples/admin/sched/pod1.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/pod1.yaml rename to content/en/examples/admin/sched/pod1.yaml diff --git a/content/en/docs/tasks/administer-cluster/pod2.yaml b/content/en/examples/admin/sched/pod2.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/pod2.yaml rename to content/en/examples/admin/sched/pod2.yaml diff --git a/content/en/docs/tasks/administer-cluster/pod3.yaml b/content/en/examples/admin/sched/pod3.yaml similarity index 100% rename from content/en/docs/tasks/administer-cluster/pod3.yaml rename to content/en/examples/admin/sched/pod3.yaml diff --git a/content/en/docs/tutorials/stateful-application/cassandra/cassandra-service.yaml b/content/en/examples/application/cassandra/cassandra-service.yaml similarity index 100% rename from content/en/docs/tutorials/stateful-application/cassandra/cassandra-service.yaml rename to content/en/examples/application/cassandra/cassandra-service.yaml diff --git a/content/en/docs/tutorials/stateful-application/cassandra/cassandra-statefulset.yaml b/content/en/examples/application/cassandra/cassandra-statefulset.yaml similarity index 100% rename from content/en/docs/tutorials/stateful-application/cassandra/cassandra-statefulset.yaml rename to content/en/examples/application/cassandra/cassandra-statefulset.yaml diff --git a/content/en/docs/tasks/run-application/deployment-patch-demo.yaml b/content/en/examples/application/deployment-patch.yaml similarity index 100% rename from content/en/docs/tasks/run-application/deployment-patch-demo.yaml rename to content/en/examples/application/deployment-patch.yaml diff --git a/content/en/docs/tasks/run-application/deployment-scale.yaml b/content/en/examples/application/deployment-scale.yaml similarity index 100% rename from content/en/docs/tasks/run-application/deployment-scale.yaml rename to content/en/examples/application/deployment-scale.yaml diff --git a/content/en/docs/tasks/run-application/deployment-update.yaml b/content/en/examples/application/deployment-update.yaml similarity index 100% rename from content/en/docs/tasks/run-application/deployment-update.yaml rename to content/en/examples/application/deployment-update.yaml diff --git a/content/en/docs/tasks/run-application/deployment.yaml b/content/en/examples/application/deployment.yaml similarity index 66% rename from content/en/docs/tasks/run-application/deployment.yaml rename to content/en/examples/application/deployment.yaml index c682fe12bd81f..0f526b16c0ad2 100644 --- a/content/en/docs/tasks/run-application/deployment.yaml +++ b/content/en/examples/application/deployment.yaml @@ -7,10 +7,8 @@ spec: matchLabels: app: nginx replicas: 2 # tells deployment to run 2 pods matching the template - template: # create pods using pod definition in this template + template: metadata: - # unlike pod-nginx.yaml, the name is not included in the meta data as a unique name is - # generated from the deployment name labels: app: nginx spec: diff --git a/content/en/docs/tutorials/stateless-application/guestbook/frontend-deployment.yaml b/content/en/examples/application/guestbook/frontend-deployment.yaml similarity index 100% rename from content/en/docs/tutorials/stateless-application/guestbook/frontend-deployment.yaml rename to content/en/examples/application/guestbook/frontend-deployment.yaml diff --git a/content/en/docs/tutorials/stateless-application/guestbook/frontend-service.yaml b/content/en/examples/application/guestbook/frontend-service.yaml similarity index 100% rename from content/en/docs/tutorials/stateless-application/guestbook/frontend-service.yaml rename to content/en/examples/application/guestbook/frontend-service.yaml diff --git a/content/en/docs/tutorials/stateless-application/guestbook/redis-master-deployment.yaml b/content/en/examples/application/guestbook/redis-master-deployment.yaml similarity index 100% rename from content/en/docs/tutorials/stateless-application/guestbook/redis-master-deployment.yaml rename to content/en/examples/application/guestbook/redis-master-deployment.yaml diff --git a/content/en/docs/tutorials/stateless-application/guestbook/redis-master-service.yaml b/content/en/examples/application/guestbook/redis-master-service.yaml similarity index 100% rename from content/en/docs/tutorials/stateless-application/guestbook/redis-master-service.yaml rename to content/en/examples/application/guestbook/redis-master-service.yaml diff --git a/content/en/docs/tutorials/stateless-application/guestbook/redis-slave-deployment.yaml b/content/en/examples/application/guestbook/redis-slave-deployment.yaml similarity index 100% rename from content/en/docs/tutorials/stateless-application/guestbook/redis-slave-deployment.yaml rename to content/en/examples/application/guestbook/redis-slave-deployment.yaml diff --git a/content/en/docs/tutorials/stateless-application/guestbook/redis-slave-service.yaml b/content/en/examples/application/guestbook/redis-slave-service.yaml similarity index 100% rename from content/en/docs/tutorials/stateless-application/guestbook/redis-slave-service.yaml rename to content/en/examples/application/guestbook/redis-slave-service.yaml diff --git a/content/en/docs/tasks/run-application/hpa-php-apache.yaml b/content/en/examples/application/hpa/php-apache.yaml similarity index 100% rename from content/en/docs/tasks/run-application/hpa-php-apache.yaml rename to content/en/examples/application/hpa/php-apache.yaml diff --git a/content/en/docs/tasks/job/cronjob.yaml b/content/en/examples/application/job/cronjob.yaml similarity index 100% rename from content/en/docs/tasks/job/cronjob.yaml rename to content/en/examples/application/job/cronjob.yaml diff --git a/content/en/docs/tasks/job/job.yaml b/content/en/examples/application/job/job-tmpl.yaml similarity index 100% rename from content/en/docs/tasks/job/job.yaml rename to content/en/examples/application/job/job-tmpl.yaml diff --git a/content/en/docs/tasks/job/coarse-parallel-processing-work-queue/Dockerfile b/content/en/examples/application/job/rabbitmq/Dockerfile similarity index 100% rename from content/en/docs/tasks/job/coarse-parallel-processing-work-queue/Dockerfile rename to content/en/examples/application/job/rabbitmq/Dockerfile diff --git a/content/en/docs/tasks/job/coarse-parallel-processing-work-queue/job.yaml b/content/en/examples/application/job/rabbitmq/job.yaml similarity index 100% rename from content/en/docs/tasks/job/coarse-parallel-processing-work-queue/job.yaml rename to content/en/examples/application/job/rabbitmq/job.yaml diff --git a/content/en/docs/tasks/job/coarse-parallel-processing-work-queue/worker.py b/content/en/examples/application/job/rabbitmq/worker.py similarity index 100% rename from content/en/docs/tasks/job/coarse-parallel-processing-work-queue/worker.py rename to content/en/examples/application/job/rabbitmq/worker.py diff --git a/content/en/docs/tasks/job/fine-parallel-processing-work-queue/Dockerfile b/content/en/examples/application/job/redis/Dockerfile similarity index 100% rename from content/en/docs/tasks/job/fine-parallel-processing-work-queue/Dockerfile rename to content/en/examples/application/job/redis/Dockerfile diff --git a/content/en/docs/tasks/job/fine-parallel-processing-work-queue/job.yaml b/content/en/examples/application/job/redis/job.yaml similarity index 100% rename from content/en/docs/tasks/job/fine-parallel-processing-work-queue/job.yaml rename to content/en/examples/application/job/redis/job.yaml diff --git a/content/en/docs/tasks/job/fine-parallel-processing-work-queue/redis-pod.yaml b/content/en/examples/application/job/redis/redis-pod.yaml similarity index 100% rename from content/en/docs/tasks/job/fine-parallel-processing-work-queue/redis-pod.yaml rename to content/en/examples/application/job/redis/redis-pod.yaml diff --git a/content/en/docs/tasks/job/fine-parallel-processing-work-queue/redis-service.yaml b/content/en/examples/application/job/redis/redis-service.yaml similarity index 100% rename from content/en/docs/tasks/job/fine-parallel-processing-work-queue/redis-service.yaml rename to content/en/examples/application/job/redis/redis-service.yaml diff --git a/content/en/docs/tasks/job/fine-parallel-processing-work-queue/rediswq.py b/content/en/examples/application/job/redis/rediswq.py similarity index 100% rename from content/en/docs/tasks/job/fine-parallel-processing-work-queue/rediswq.py rename to content/en/examples/application/job/redis/rediswq.py diff --git a/content/en/docs/tasks/job/fine-parallel-processing-work-queue/worker.py b/content/en/examples/application/job/redis/worker.py similarity index 100% rename from content/en/docs/tasks/job/fine-parallel-processing-work-queue/worker.py rename to content/en/examples/application/job/redis/worker.py diff --git a/content/en/docs/tasks/run-application/mysql-configmap.yaml b/content/en/examples/application/mysql/mysql-configmap.yaml similarity index 100% rename from content/en/docs/tasks/run-application/mysql-configmap.yaml rename to content/en/examples/application/mysql/mysql-configmap.yaml diff --git a/content/en/docs/tasks/run-application/mysql-deployment.yaml b/content/en/examples/application/mysql/mysql-deployment.yaml similarity index 100% rename from content/en/docs/tasks/run-application/mysql-deployment.yaml rename to content/en/examples/application/mysql/mysql-deployment.yaml diff --git a/content/en/docs/tasks/run-application/mysql-pv.yaml b/content/en/examples/application/mysql/mysql-pv.yaml similarity index 100% rename from content/en/docs/tasks/run-application/mysql-pv.yaml rename to content/en/examples/application/mysql/mysql-pv.yaml diff --git a/content/en/docs/tasks/run-application/mysql-services.yaml b/content/en/examples/application/mysql/mysql-services.yaml similarity index 100% rename from content/en/docs/tasks/run-application/mysql-services.yaml rename to content/en/examples/application/mysql/mysql-services.yaml diff --git a/content/en/docs/tasks/run-application/mysql-statefulset.yaml b/content/en/examples/application/mysql/mysql-statefulset.yaml similarity index 100% rename from content/en/docs/tasks/run-application/mysql-statefulset.yaml rename to content/en/examples/application/mysql/mysql-statefulset.yaml diff --git a/content/en/docs/tasks/debug-application-cluster/nginx-dep.yaml b/content/en/examples/application/nginx-with-request.yaml similarity index 100% rename from content/en/docs/tasks/debug-application-cluster/nginx-dep.yaml rename to content/en/examples/application/nginx-with-request.yaml diff --git a/content/en/docs/tasks/debug-application-cluster/shell-demo.yaml b/content/en/examples/application/shell-demo.yaml similarity index 100% rename from content/en/docs/tasks/debug-application-cluster/shell-demo.yaml rename to content/en/examples/application/shell-demo.yaml diff --git a/content/en/docs/tutorials/stateful-application/webp.yaml b/content/en/examples/application/web/web-parallel.yaml similarity index 100% rename from content/en/docs/tutorials/stateful-application/webp.yaml rename to content/en/examples/application/web/web-parallel.yaml diff --git a/content/en/docs/tutorials/stateful-application/web.yaml b/content/en/examples/application/web/web.yaml similarity index 100% rename from content/en/docs/tutorials/stateful-application/web.yaml rename to content/en/examples/application/web/web.yaml diff --git a/content/en/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/mysql-deployment.yaml b/content/en/examples/application/wordpress/mysql-deployment.yaml similarity index 100% rename from content/en/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/mysql-deployment.yaml rename to content/en/examples/application/wordpress/mysql-deployment.yaml diff --git a/content/en/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/wordpress-deployment.yaml b/content/en/examples/application/wordpress/wordpress-deployment.yaml similarity index 100% rename from content/en/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/wordpress-deployment.yaml rename to content/en/examples/application/wordpress/wordpress-deployment.yaml diff --git a/content/en/docs/tutorials/stateful-application/zookeeper.yaml b/content/en/examples/application/zookeeper/zookeeper.yaml similarity index 100% rename from content/en/docs/tutorials/stateful-application/zookeeper.yaml rename to content/en/examples/application/zookeeper/zookeeper.yaml diff --git a/content/en/docs/tasks/debug-application-cluster/audit-policy.yaml b/content/en/examples/audit/audit-policy.yaml similarity index 100% rename from content/en/docs/tasks/debug-application-cluster/audit-policy.yaml rename to content/en/examples/audit/audit-policy.yaml diff --git a/content/en/docs/concepts/workloads/controllers/daemonset.yaml b/content/en/examples/controllers/daemonset.yaml similarity index 100% rename from content/en/docs/concepts/workloads/controllers/daemonset.yaml rename to content/en/examples/controllers/daemonset.yaml diff --git a/content/en/docs/concepts/workloads/controllers/frontend.yaml b/content/en/examples/controllers/frontend.yaml similarity index 100% rename from content/en/docs/concepts/workloads/controllers/frontend.yaml rename to content/en/examples/controllers/frontend.yaml diff --git a/content/en/docs/concepts/workloads/controllers/hpa-rs.yaml b/content/en/examples/controllers/hpa-rs.yaml similarity index 100% rename from content/en/docs/concepts/workloads/controllers/hpa-rs.yaml rename to content/en/examples/controllers/hpa-rs.yaml diff --git a/content/en/docs/concepts/workloads/controllers/job.yaml b/content/en/examples/controllers/job.yaml similarity index 100% rename from content/en/docs/concepts/workloads/controllers/job.yaml rename to content/en/examples/controllers/job.yaml diff --git a/content/en/docs/concepts/workloads/controllers/nginx-deployment.yaml b/content/en/examples/controllers/nginx-deployment.yaml similarity index 100% rename from content/en/docs/concepts/workloads/controllers/nginx-deployment.yaml rename to content/en/examples/controllers/nginx-deployment.yaml diff --git a/content/en/docs/concepts/workloads/controllers/my-repset.yaml b/content/en/examples/controllers/replicaset.yaml similarity index 100% rename from content/en/docs/concepts/workloads/controllers/my-repset.yaml rename to content/en/examples/controllers/replicaset.yaml diff --git a/content/en/docs/concepts/workloads/controllers/replication.yaml b/content/en/examples/controllers/replication.yaml similarity index 100% rename from content/en/docs/concepts/workloads/controllers/replication.yaml rename to content/en/examples/controllers/replication.yaml diff --git a/content/en/docs/concepts/cluster-administration/counter-pod.yaml b/content/en/examples/debug/counter-pod.yaml similarity index 100% rename from content/en/docs/concepts/cluster-administration/counter-pod.yaml rename to content/en/examples/debug/counter-pod.yaml diff --git a/content/en/docs/tasks/debug-application-cluster/event-exporter-deploy.yaml b/content/en/examples/debug/event-exporter.yaml similarity index 100% rename from content/en/docs/tasks/debug-application-cluster/event-exporter-deploy.yaml rename to content/en/examples/debug/event-exporter.yaml diff --git a/content/en/docs/tasks/debug-application-cluster/fluentd-gcp-configmap.yaml b/content/en/examples/debug/fluentd-gcp-configmap.yaml similarity index 100% rename from content/en/docs/tasks/debug-application-cluster/fluentd-gcp-configmap.yaml rename to content/en/examples/debug/fluentd-gcp-configmap.yaml diff --git a/content/en/docs/tasks/debug-application-cluster/fluentd-gcp-ds.yaml b/content/en/examples/debug/fluentd-gcp-ds.yaml similarity index 100% rename from content/en/docs/tasks/debug-application-cluster/fluentd-gcp-ds.yaml rename to content/en/examples/debug/fluentd-gcp-ds.yaml diff --git a/content/en/docs/tasks/debug-application-cluster/node-problem-detector-configmap.yaml b/content/en/examples/debug/node-problem-detector-configmap.yaml similarity index 100% rename from content/en/docs/tasks/debug-application-cluster/node-problem-detector-configmap.yaml rename to content/en/examples/debug/node-problem-detector-configmap.yaml diff --git a/content/en/docs/tasks/debug-application-cluster/node-problem-detector.yaml b/content/en/examples/debug/node-problem-detector.yaml similarity index 100% rename from content/en/docs/tasks/debug-application-cluster/node-problem-detector.yaml rename to content/en/examples/debug/node-problem-detector.yaml diff --git a/content/en/docs/tasks/debug-application-cluster/termination.yaml b/content/en/examples/debug/termination.yaml similarity index 100% rename from content/en/docs/tasks/debug-application-cluster/termination.yaml rename to content/en/examples/debug/termination.yaml diff --git a/content/en/docs/tutorials/Dockerfile b/content/en/examples/minikube/Dockerfile similarity index 100% rename from content/en/docs/tutorials/Dockerfile rename to content/en/examples/minikube/Dockerfile diff --git a/content/en/docs/tutorials/server.js b/content/en/examples/minikube/server.js similarity index 100% rename from content/en/docs/tutorials/server.js rename to content/en/examples/minikube/server.js diff --git a/content/en/docs/tasks/inject-data-application/podpreset-allow-db-merged.yaml b/content/en/examples/podpreset/allow-db-merged.yaml similarity index 100% rename from content/en/docs/tasks/inject-data-application/podpreset-allow-db-merged.yaml rename to content/en/examples/podpreset/allow-db-merged.yaml diff --git a/content/en/docs/tasks/inject-data-application/podpreset-allow-db.yaml b/content/en/examples/podpreset/allow-db.yaml similarity index 100% rename from content/en/docs/tasks/inject-data-application/podpreset-allow-db.yaml rename to content/en/examples/podpreset/allow-db.yaml diff --git a/content/en/docs/tasks/inject-data-application/podpreset-configmap.yaml b/content/en/examples/podpreset/configmap.yaml similarity index 100% rename from content/en/docs/tasks/inject-data-application/podpreset-configmap.yaml rename to content/en/examples/podpreset/configmap.yaml diff --git a/content/en/docs/tasks/inject-data-application/podpreset-conflict-pod.yaml b/content/en/examples/podpreset/conflict-pod.yaml similarity index 100% rename from content/en/docs/tasks/inject-data-application/podpreset-conflict-pod.yaml rename to content/en/examples/podpreset/conflict-pod.yaml diff --git a/content/en/docs/tasks/inject-data-application/podpreset-conflict-preset.yaml b/content/en/examples/podpreset/conflict-preset.yaml similarity index 100% rename from content/en/docs/tasks/inject-data-application/podpreset-conflict-preset.yaml rename to content/en/examples/podpreset/conflict-preset.yaml diff --git a/content/en/docs/tasks/inject-data-application/podpreset-merged.yaml b/content/en/examples/podpreset/merged.yaml similarity index 100% rename from content/en/docs/tasks/inject-data-application/podpreset-merged.yaml rename to content/en/examples/podpreset/merged.yaml diff --git a/content/en/docs/tasks/inject-data-application/podpreset-multi-merged.yaml b/content/en/examples/podpreset/multi-merged.yaml similarity index 100% rename from content/en/docs/tasks/inject-data-application/podpreset-multi-merged.yaml rename to content/en/examples/podpreset/multi-merged.yaml diff --git a/content/en/docs/tasks/inject-data-application/podpreset-pod.yaml b/content/en/examples/podpreset/pod.yaml similarity index 100% rename from content/en/docs/tasks/inject-data-application/podpreset-pod.yaml rename to content/en/examples/podpreset/pod.yaml diff --git a/content/en/docs/tasks/inject-data-application/podpreset-preset.yaml b/content/en/examples/podpreset/preset.yaml similarity index 100% rename from content/en/docs/tasks/inject-data-application/podpreset-preset.yaml rename to content/en/examples/podpreset/preset.yaml diff --git a/content/en/docs/tasks/inject-data-application/podpreset-proxy.yaml b/content/en/examples/podpreset/proxy.yaml similarity index 100% rename from content/en/docs/tasks/inject-data-application/podpreset-proxy.yaml rename to content/en/examples/podpreset/proxy.yaml diff --git a/content/en/docs/tasks/inject-data-application/podpreset-replicaset-merged.yaml b/content/en/examples/podpreset/replicaset-merged.yaml similarity index 100% rename from content/en/docs/tasks/inject-data-application/podpreset-replicaset-merged.yaml rename to content/en/examples/podpreset/replicaset-merged.yaml diff --git a/content/en/docs/tasks/inject-data-application/podpreset-replicaset.yaml b/content/en/examples/podpreset/replicaset.yaml similarity index 100% rename from content/en/docs/tasks/inject-data-application/podpreset-replicaset.yaml rename to content/en/examples/podpreset/replicaset.yaml diff --git a/content/en/docs/concepts/configuration/commands.yaml b/content/en/examples/pods/commands.yaml similarity index 100% rename from content/en/docs/concepts/configuration/commands.yaml rename to content/en/examples/pods/commands.yaml diff --git a/content/en/docs/tasks/configure-pod-container/init-containers.yaml b/content/en/examples/pods/init-containers.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/init-containers.yaml rename to content/en/examples/pods/init-containers.yaml diff --git a/content/en/docs/tasks/inject-data-application/dapi-envars-container.yaml b/content/en/examples/pods/inject/dapi-envars-container.yaml similarity index 100% rename from content/en/docs/tasks/inject-data-application/dapi-envars-container.yaml rename to content/en/examples/pods/inject/dapi-envars-container.yaml diff --git a/content/en/docs/tasks/inject-data-application/dapi-envars-pod.yaml b/content/en/examples/pods/inject/dapi-envars-pod.yaml similarity index 100% rename from content/en/docs/tasks/inject-data-application/dapi-envars-pod.yaml rename to content/en/examples/pods/inject/dapi-envars-pod.yaml diff --git a/content/en/docs/tasks/inject-data-application/dapi-volume-resources.yaml b/content/en/examples/pods/inject/dapi-volume-resources.yaml similarity index 100% rename from content/en/docs/tasks/inject-data-application/dapi-volume-resources.yaml rename to content/en/examples/pods/inject/dapi-volume-resources.yaml diff --git a/content/en/docs/tasks/inject-data-application/dapi-volume.yaml b/content/en/examples/pods/inject/dapi-volume.yaml similarity index 100% rename from content/en/docs/tasks/inject-data-application/dapi-volume.yaml rename to content/en/examples/pods/inject/dapi-volume.yaml diff --git a/content/en/docs/tasks/inject-data-application/envars.yaml b/content/en/examples/pods/inject/envars.yaml similarity index 100% rename from content/en/docs/tasks/inject-data-application/envars.yaml rename to content/en/examples/pods/inject/envars.yaml diff --git a/content/en/docs/tasks/inject-data-application/secret-envars-pod.yaml b/content/en/examples/pods/inject/secret-envars-pod.yaml similarity index 100% rename from content/en/docs/tasks/inject-data-application/secret-envars-pod.yaml rename to content/en/examples/pods/inject/secret-envars-pod.yaml diff --git a/content/en/docs/tasks/inject-data-application/secret-pod.yaml b/content/en/examples/pods/inject/secret-pod.yaml similarity index 100% rename from content/en/docs/tasks/inject-data-application/secret-pod.yaml rename to content/en/examples/pods/inject/secret-pod.yaml diff --git a/content/en/docs/tasks/inject-data-application/secret.yaml b/content/en/examples/pods/inject/secret.yaml similarity index 100% rename from content/en/docs/tasks/inject-data-application/secret.yaml rename to content/en/examples/pods/inject/secret.yaml diff --git a/content/en/docs/tasks/configure-pod-container/lifecycle-events.yaml b/content/en/examples/pods/lifecycle-events.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/lifecycle-events.yaml rename to content/en/examples/pods/lifecycle-events.yaml diff --git a/content/en/docs/concepts/configuration/pod.yaml b/content/en/examples/pods/pod-nginx.yaml similarity index 100% rename from content/en/docs/concepts/configuration/pod.yaml rename to content/en/examples/pods/pod-nginx.yaml diff --git a/content/en/docs/concepts/configuration/pod-with-node-affinity.yaml b/content/en/examples/pods/pod-with-node-affinity.yaml similarity index 100% rename from content/en/docs/concepts/configuration/pod-with-node-affinity.yaml rename to content/en/examples/pods/pod-with-node-affinity.yaml diff --git a/content/en/docs/concepts/configuration/pod-with-pod-affinity.yaml b/content/en/examples/pods/pod-with-pod-affinity.yaml similarity index 100% rename from content/en/docs/concepts/configuration/pod-with-pod-affinity.yaml rename to content/en/examples/pods/pod-with-pod-affinity.yaml diff --git a/content/en/docs/tasks/configure-pod-container/private-reg-pod.yaml b/content/en/examples/pods/private-reg-pod.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/private-reg-pod.yaml rename to content/en/examples/pods/private-reg-pod.yaml diff --git a/content/en/docs/tasks/configure-pod-container/exec-liveness.yaml b/content/en/examples/pods/probe/exec-liveness.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/exec-liveness.yaml rename to content/en/examples/pods/probe/exec-liveness.yaml diff --git a/content/en/docs/tasks/configure-pod-container/http-liveness.yaml b/content/en/examples/pods/probe/http-liveness.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/http-liveness.yaml rename to content/en/examples/pods/probe/http-liveness.yaml diff --git a/content/en/docs/tutorials/pod-with-http-healthcheck.yaml b/content/en/examples/pods/probe/pod-with-http-healthcheck.yaml similarity index 100% rename from content/en/docs/tutorials/pod-with-http-healthcheck.yaml rename to content/en/examples/pods/probe/pod-with-http-healthcheck.yaml diff --git a/content/en/docs/tutorials/pod-with-tcp-socket-healthcheck.yaml b/content/en/examples/pods/probe/pod-with-tcp-socket-healthcheck.yaml similarity index 100% rename from content/en/docs/tutorials/pod-with-tcp-socket-healthcheck.yaml rename to content/en/examples/pods/probe/pod-with-tcp-socket-healthcheck.yaml diff --git a/content/en/docs/tasks/configure-pod-container/tcp-liveness-readiness.yaml b/content/en/examples/pods/probe/tcp-liveness-readiness.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/tcp-liveness-readiness.yaml rename to content/en/examples/pods/probe/tcp-liveness-readiness.yaml diff --git a/content/en/docs/tasks/configure-pod-container/qos-pod-2.yaml b/content/en/examples/pods/qos/qos-pod-2.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/qos-pod-2.yaml rename to content/en/examples/pods/qos/qos-pod-2.yaml diff --git a/content/en/docs/tasks/configure-pod-container/qos-pod-3.yaml b/content/en/examples/pods/qos/qos-pod-3.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/qos-pod-3.yaml rename to content/en/examples/pods/qos/qos-pod-3.yaml diff --git a/content/en/docs/tasks/configure-pod-container/qos-pod-4.yaml b/content/en/examples/pods/qos/qos-pod-4.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/qos-pod-4.yaml rename to content/en/examples/pods/qos/qos-pod-4.yaml diff --git a/content/en/docs/tasks/configure-pod-container/qos-pod.yaml b/content/en/examples/pods/qos/qos-pod.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/qos-pod.yaml rename to content/en/examples/pods/qos/qos-pod.yaml diff --git a/content/en/docs/tasks/configure-pod-container/cpu-request-limit-2.yaml b/content/en/examples/pods/resource/cpu-request-limit-2.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/cpu-request-limit-2.yaml rename to content/en/examples/pods/resource/cpu-request-limit-2.yaml diff --git a/content/en/docs/tasks/configure-pod-container/cpu-request-limit.yaml b/content/en/examples/pods/resource/cpu-request-limit.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/cpu-request-limit.yaml rename to content/en/examples/pods/resource/cpu-request-limit.yaml diff --git a/content/en/docs/tasks/configure-pod-container/extended-resource-pod-2.yaml b/content/en/examples/pods/resource/extended-resource-pod-2.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/extended-resource-pod-2.yaml rename to content/en/examples/pods/resource/extended-resource-pod-2.yaml diff --git a/content/en/docs/tasks/configure-pod-container/extended-resource-pod.yaml b/content/en/examples/pods/resource/extended-resource-pod.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/extended-resource-pod.yaml rename to content/en/examples/pods/resource/extended-resource-pod.yaml diff --git a/content/en/docs/tasks/configure-pod-container/memory-request-limit-2.yaml b/content/en/examples/pods/resource/memory-request-limit-2.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/memory-request-limit-2.yaml rename to content/en/examples/pods/resource/memory-request-limit-2.yaml diff --git a/content/en/docs/tasks/configure-pod-container/memory-request-limit-3.yaml b/content/en/examples/pods/resource/memory-request-limit-3.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/memory-request-limit-3.yaml rename to content/en/examples/pods/resource/memory-request-limit-3.yaml diff --git a/content/en/docs/tasks/configure-pod-container/memory-request-limit.yaml b/content/en/examples/pods/resource/memory-request-limit.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/memory-request-limit.yaml rename to content/en/examples/pods/resource/memory-request-limit.yaml diff --git a/content/en/docs/tasks/configure-pod-container/security-context-2.yaml b/content/en/examples/pods/security/security-context-2.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/security-context-2.yaml rename to content/en/examples/pods/security/security-context-2.yaml diff --git a/content/en/docs/tasks/configure-pod-container/security-context-3.yaml b/content/en/examples/pods/security/security-context-3.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/security-context-3.yaml rename to content/en/examples/pods/security/security-context-3.yaml diff --git a/content/en/docs/tasks/configure-pod-container/security-context-4.yaml b/content/en/examples/pods/security/security-context-4.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/security-context-4.yaml rename to content/en/examples/pods/security/security-context-4.yaml diff --git a/content/en/docs/tasks/configure-pod-container/security-context.yaml b/content/en/examples/pods/security/security-context.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/security-context.yaml rename to content/en/examples/pods/security/security-context.yaml diff --git a/content/en/docs/tasks/configure-pod-container/share-process-namespace.yaml b/content/en/examples/pods/share-process-namespace.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/share-process-namespace.yaml rename to content/en/examples/pods/share-process-namespace.yaml diff --git a/content/en/docs/tutorials/pod-nginx.yaml b/content/en/examples/pods/simple-pod.yaml similarity index 100% rename from content/en/docs/tutorials/pod-nginx.yaml rename to content/en/examples/pods/simple-pod.yaml diff --git a/content/en/docs/tasks/configure-pod-container/projected-volume.yaml b/content/en/examples/pods/storage/projected.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/projected-volume.yaml rename to content/en/examples/pods/storage/projected.yaml diff --git a/content/en/docs/tasks/configure-pod-container/task-pv-claim.yaml b/content/en/examples/pods/storage/pv-claim.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/task-pv-claim.yaml rename to content/en/examples/pods/storage/pv-claim.yaml diff --git a/content/en/docs/tasks/configure-pod-container/task-pv-pod.yaml b/content/en/examples/pods/storage/pv-pod.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/task-pv-pod.yaml rename to content/en/examples/pods/storage/pv-pod.yaml diff --git a/content/en/docs/tasks/configure-pod-container/task-pv-volume.yaml b/content/en/examples/pods/storage/pv-volume.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/task-pv-volume.yaml rename to content/en/examples/pods/storage/pv-volume.yaml diff --git a/content/en/docs/tasks/configure-pod-container/pod-redis.yaml b/content/en/examples/pods/storage/redis.yaml similarity index 100% rename from content/en/docs/tasks/configure-pod-container/pod-redis.yaml rename to content/en/examples/pods/storage/redis.yaml diff --git a/content/en/docs/tasks/access-application-cluster/two-container-pod.yaml b/content/en/examples/pods/two-container-pod.yaml similarity index 100% rename from content/en/docs/tasks/access-application-cluster/two-container-pod.yaml rename to content/en/examples/pods/two-container-pod.yaml diff --git a/content/en/docs/concepts/policy/example-psp.yaml b/content/en/examples/policy/example-psp.yaml similarity index 100% rename from content/en/docs/concepts/policy/example-psp.yaml rename to content/en/examples/policy/example-psp.yaml diff --git a/content/en/docs/concepts/policy/privileged-psp.yaml b/content/en/examples/policy/privileged-psp.yaml similarity index 100% rename from content/en/docs/concepts/policy/privileged-psp.yaml rename to content/en/examples/policy/privileged-psp.yaml diff --git a/content/en/docs/concepts/policy/restricted-psp.yaml b/content/en/examples/policy/restricted-psp.yaml similarity index 100% rename from content/en/docs/concepts/policy/restricted-psp.yaml rename to content/en/examples/policy/restricted-psp.yaml diff --git a/content/en/docs/tasks/access-application-cluster/frontend/Dockerfile b/content/en/examples/service/access/Dockerfile similarity index 100% rename from content/en/docs/tasks/access-application-cluster/frontend/Dockerfile rename to content/en/examples/service/access/Dockerfile diff --git a/content/en/docs/tasks/access-application-cluster/frontend/frontend.conf b/content/en/examples/service/access/frontend.conf similarity index 100% rename from content/en/docs/tasks/access-application-cluster/frontend/frontend.conf rename to content/en/examples/service/access/frontend.conf diff --git a/content/en/docs/tasks/access-application-cluster/frontend.yaml b/content/en/examples/service/access/frontend.yaml similarity index 100% rename from content/en/docs/tasks/access-application-cluster/frontend.yaml rename to content/en/examples/service/access/frontend.yaml diff --git a/content/en/docs/tasks/access-application-cluster/hello-service.yaml b/content/en/examples/service/access/hello-service.yaml similarity index 100% rename from content/en/docs/tasks/access-application-cluster/hello-service.yaml rename to content/en/examples/service/access/hello-service.yaml diff --git a/content/en/docs/tasks/access-application-cluster/hello.yaml b/content/en/examples/service/access/hello.yaml similarity index 100% rename from content/en/docs/tasks/access-application-cluster/hello.yaml rename to content/en/examples/service/access/hello.yaml diff --git a/content/en/docs/tutorials/service.yaml b/content/en/examples/service/nginx-service.yaml similarity index 100% rename from content/en/docs/tutorials/service.yaml rename to content/en/examples/service/nginx-service.yaml diff --git a/content/en/docs/getting-started-guides/windows/configmap-pod.yaml b/content/en/examples/windows/configmap-pod.yaml similarity index 100% rename from content/en/docs/getting-started-guides/windows/configmap-pod.yaml rename to content/en/examples/windows/configmap-pod.yaml diff --git a/content/en/examples/windows/daemonset.yaml b/content/en/examples/windows/daemonset.yaml new file mode 100644 index 0000000000000..d3a7bb6636ebb --- /dev/null +++ b/content/en/examples/windows/daemonset.yaml @@ -0,0 +1,21 @@ +apiVersion: apps/v1 +kind: DaemonSet +metadata: + name: my-daemonset + labels: + app: foo +spec: + selector: + matchLabels: + app: foo + template: + metadata: + labels: + app: foo + spec: + containers: + - name: foo + image: microsoft/windowsservercore:1709 + nodeSelector: + beta.kubernetes.io/os: windows + diff --git a/content/en/examples/windows/deploy-hyperv.yaml b/content/en/examples/windows/deploy-hyperv.yaml new file mode 100644 index 0000000000000..c8b71ce8cbddf --- /dev/null +++ b/content/en/examples/windows/deploy-hyperv.yaml @@ -0,0 +1,22 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: iis +spec: + selector: + matchLabels: + app: iis + replicas: 3 + template: + metadata: + labels: + app: iis + annotations: + experimental.windows.kubernetes.io/isolation-type: hyperv + spec: + containers: + - name: iis + image: microsoft/iis + ports: + - containerPort: 80 + diff --git a/content/en/docs/tutorials/deployment-update.yaml b/content/en/examples/windows/deploy-resource.yaml similarity index 50% rename from content/en/docs/tutorials/deployment-update.yaml rename to content/en/examples/windows/deploy-resource.yaml index 14a7dc473b0d5..81207a3804a49 100644 --- a/content/en/docs/tutorials/deployment-update.yaml +++ b/content/en/examples/windows/deploy-resource.yaml @@ -1,19 +1,24 @@ apiVersion: apps/v1 kind: Deployment metadata: - name: nginx-deployment + name: iis spec: + replicas: 3 selector: matchLabels: - app: nginx - replicas: 2 + app: iis template: metadata: labels: - app: nginx + app: iis spec: containers: - - name: nginx - image: nginx:1.8 # Update the version of nginx from 1.7.9 to 1.8 + - name: iis + image: microsoft/iis + resources: + limits: + memory: "128Mi" + cpu: 2 ports: - containerPort: 80 + diff --git a/content/en/examples/windows/emptydir-pod.yaml b/content/en/examples/windows/emptydir-pod.yaml new file mode 100644 index 0000000000000..3210576a59cf4 --- /dev/null +++ b/content/en/examples/windows/emptydir-pod.yaml @@ -0,0 +1,20 @@ + apiVersion: v1 + kind: Pod + metadata: + name: my-empty-dir-pod + spec: + containers: + - image: microsoft/windowsservercore:1709 + name: my-empty-dir-pod + volumeMounts: + - mountPath: /cache + name: cache-volume + - mountPath: C:/scratch + name: scratch-volume + volumes: + - name: cache-volume + emptyDir: {} + - name: scratch-volume + emptyDir: {} + nodeSelector: + beta.kubernetes.io/os: windows diff --git a/content/en/docs/getting-started-guides/windows/hostpath-volume-pod.yaml b/content/en/examples/windows/hostpath-volume-pod.yaml similarity index 63% rename from content/en/docs/getting-started-guides/windows/hostpath-volume-pod.yaml rename to content/en/examples/windows/hostpath-volume-pod.yaml index 994b48e6f040b..843250c80c613 100644 --- a/content/en/docs/getting-started-guides/windows/hostpath-volume-pod.yaml +++ b/content/en/examples/windows/hostpath-volume-pod.yaml @@ -4,15 +4,15 @@ metadata: name: hostpath-volume-pod spec: containers: - - name: hostpath-redis - image: redis:3.0-nanoserver + - name: my-hostpath-volume-pod + image: microsoft/windowsservercore:1709 volumeMounts: - - name: blah + - name: foo mountPath: "C:\\etc\\foo" readOnly: true nodeSelector: beta.kubernetes.io/os: windows volumes: - - name: blah + - name: foo hostPath: - path: "C:\\etc\\foo" + path: "C:\\etc\\foo" diff --git a/content/en/docs/getting-started-guides/windows/secret-pod.yaml b/content/en/examples/windows/secret-pod.yaml similarity index 78% rename from content/en/docs/getting-started-guides/windows/secret-pod.yaml rename to content/en/examples/windows/secret-pod.yaml index 4bbfb671b280a..f4a8122c0a694 100644 --- a/content/en/docs/getting-started-guides/windows/secret-pod.yaml +++ b/content/en/examples/windows/secret-pod.yaml @@ -12,11 +12,11 @@ data: apiVersion: v1 kind: Pod metadata: - name: mypod-secret + name: my-secret-pod spec: containers: - - name: mypod-secret - image: redis:3.0-nanoserver + - name: my-secret-pod + image: microsoft/windowsservercore:1709 env: - name: USERNAME valueFrom: @@ -29,4 +29,4 @@ spec: name: mysecret key: password nodeSelector: - beta.kubernetes.io/os: windows \ No newline at end of file + beta.kubernetes.io/os: windows diff --git a/content/en/examples/windows/simple-pod.yaml b/content/en/examples/windows/simple-pod.yaml new file mode 100644 index 0000000000000..f056f3cf0ab50 --- /dev/null +++ b/content/en/examples/windows/simple-pod.yaml @@ -0,0 +1,14 @@ +apiVersion: v1 +kind: Pod +metadata: + name: iis + labels: + name: iis +spec: + containers: + - name: iis + image: microsoft/iis:windowsservercore-1709 + ports: + - containerPort: 80 + nodeSelector: + "beta.kubernetes.io/os": windows diff --git a/data/concepts.yml b/data/concepts.yml index bf6f8b53e842e..4519addde536b 100644 --- a/data/concepts.yml +++ b/data/concepts.yml @@ -17,6 +17,7 @@ toc: - docs/concepts/overview/working-with-objects/namespaces.md - docs/concepts/overview/working-with-objects/labels.md - docs/concepts/overview/working-with-objects/annotations.md + - docs/concepts/overview/working-with-objects/common-labels.md - title: Object Management Using kubectl section: - docs/concepts/overview/object-management-kubectl/overview.md diff --git a/data/setup.yml b/data/setup.yml index f09b31417d87f..5a99ed9e5570b 100644 --- a/data/setup.yml +++ b/data/setup.yml @@ -134,7 +134,7 @@ toc: path: /docs/admin/cluster-large/ - title: Running in Multiple Zones - path: /docs/admin/multiple-zones/ + path: /docs/setup/multiple-zones/ - title: Building High-Availability Clusters path: /docs/admin/high-availability/building/ diff --git a/layouts/docs/baseof.html b/layouts/docs/baseof.html index 829457a79c808..43483af580c92 100644 --- a/layouts/docs/baseof.html +++ b/layouts/docs/baseof.html @@ -16,29 +16,38 @@ {{ block "side-menu" . }}{{ end }}
{{ block "content" . }}{{ end }} -
-

Analytics

- {{ if and (ne .Kind "404") (not (strings.Contains .Path "search")) }} - {{ if not .Params.no_issue }} - - Create an Issue - {{ end }} - {{ end }} - {{ if not .Params.noedit }} - Edit this Page - {{ end }} -
+ {{ partialCached "footer.html" . }} {{ partialCached "footer-scripts.html" . }} diff --git a/layouts/shortcodes/codenew.html b/layouts/shortcodes/codenew.html new file mode 100644 index 0000000000000..80a1d5017f2b0 --- /dev/null +++ b/layouts/shortcodes/codenew.html @@ -0,0 +1,38 @@ +{{ $p := .Page }} +{{ $file := .Get "file" }} +{{ $codelang := .Get "language" | default (path.Ext $file | strings.TrimPrefix ".") }} +{{ $fileDir := path.Split $file }} +{{ $bundlePath := path.Join .Page.Dir $fileDir.Dir }} +{{ $filename := printf "/content/%s/examples/%s" .Page.Lang $file | safeURL }} +{{ $ghlink := printf "https://%s/master%s" .Page.Site.Params.githubWebsiteRaw $filename | safeURL }} +{{/* First assume this is a bundle and the file is inside it. */}} +{{ $resource := $p.Resources.GetMatch (printf "%s*" $file ) }} +{{ with $resource }} +{{ $.Scratch.Set "content" .Content }} +{{ else }} +{{/* Read the file relative to the content root. */}} +{{ $resource := readFile $filename}} +{{ with $resource }}{{ $.Scratch.Set "content" . }}{{ end }} +{{ end }} +{{ if not ($.Scratch.Get "content") }} +{{ errorf "[%s] %q not found in %q" $p.Site.Language.Lang $fileDir.File $bundlePath }} +{{ end }} +{{ with $.Scratch.Get "content" }} + + + + + + + + + + + +
+ {{ with $ghlink }}{{ end }} + {{ $file }} + {{ if $ghlink }}{{ end }} + +
{{ highlight . $codelang "" }}
+{{ end }} diff --git a/netlify.toml b/netlify.toml index 904f6956c9b0f..dc01c1d2a3244 100644 --- a/netlify.toml +++ b/netlify.toml @@ -1,7 +1,7 @@ [build] # This default build command adds the robots noindex directive to the site headers publish = "public" -command = "hugo && cp netlify_noindex_headers.txt public/_headers" +command = "hugo --enableGitInfo && cp netlify_noindex_headers.txt public/_headers" [context.production.environment] HUGO_BASEURL = "https://kubernetes.io/" @@ -10,13 +10,13 @@ HUGO_ENV = "production" HUGO_ENABLEGITINFO = "true" [context.deploy-preview] -command = "hugo -b $DEPLOY_PRIME_URL" +command = "hugo --enableGitInfo -b $DEPLOY_PRIME_URL" [context.deploy-preview.environment] HUGO_VERSION = "0.40.3" [context.branch-deploy] -command = "hugo -b $DEPLOY_PRIME_URL" +command = "hugo --enableGitInfo -b $DEPLOY_PRIME_URL" [context.branch-deploy.environment] HUGO_VERSION = "0.40.3" diff --git a/static/_redirects b/static/_redirects index 304d17d12e27f..7ad757c00d8d1 100644 --- a/static/_redirects +++ b/static/_redirects @@ -32,6 +32,7 @@ /docs/admin/ha-master-gce.md/ /docs/tasks/administer-cluster/highly-available-master/ 301 /docs/admin/high-availability/ /docs/admin/high-availability/building/ 301 /docs/admin/kubeadm-upgrade-1-7/ /docs/tasks/administer-cluster/upgrade-downgrade/kubeadm-upgrade-1-7/ 301 +/docs/admin/kubelet-authentication-authorization/ /docs/reference/command-line-tools-reference/kubelet-authentication-authorization/ 301 /docs/admin/limitrange/ /docs/tasks/administer-cluster/cpu-memory-limit/ 301 /docs/admin/limitrange/Limits/ /docs/tasks/administer-cluster/limit-storage-consumption/#limitrange-to-limit-requests-for-storage/ 301 /docs/admin/master-node-communication/ /docs/concepts/architecture/master-node-communication/ 301 @@ -223,6 +224,8 @@ /docs/tasks/access-application-cluster/access-cluster.md /docs/tasks/access-application-cluster/access-cluster/ 301 /docs/tasks/access-application-cluster/authenticate-across-clusters-kubeconfig/ /docs/tasks/access-application-cluster/configure-access-multiple-clusters/ 301 /docs/tasks/access-kubernetes-api/access-kubernetes-api/http-proxy-access-api/ /docs/tasks/access-kubernetes-api/http-proxy-access-api/ 301 +/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/ /docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/ 301 +/docs/tasks/access-kubernetes-api/migrate-third-party-resource/ /docs/tasks/access-kubernetes-api/custom-resources/migrate-third-party-resource/ 301 /docs/tasks/administer-cluster/apply-resource-quota-limit/ /docs/tasks/administer-cluster/quota-api-object/ 301 /docs/tasks/administer-cluster/assign-pods-nodes/ /docs/tasks/configure-pod-container/assign-pods-nodes/ 301 @@ -495,7 +498,7 @@ https://kubernetes-io-v1-7.netlify.com/* https://v1-7.docs.kubernetes.io/:spl /docs/reference/generated/kubeadm/ /docs/reference/setup-tools/kubeadm/kubeadm/ 301 -/editdocs/ /docs/home/contribute/ 301 +/editdocs/ /docs/home/contribute/ 301 /docs/admin/accessing-the-api/ /docs/reference/access-authn-authz/controlling-access/ 301 /docs/admin/admission-controllers/ /docs/reference/access-authn-authz/admission-controllers/ 301 @@ -510,3 +513,4 @@ https://kubernetes-io-v1-7.netlify.com/* https://v1-7.docs.kubernetes.io/:spl /docs/admin/authorization/ /docs/reference/access-authn-authz/authorization/ 301 /docs/admin/high-availability/building/ /docs/setup/independent/high-availability/ 301 +/code-of-conduct/ /community/code-of-conduct/ 301 diff --git a/static/css/case_study_styles.css b/static/css/case_study_styles.css index c056d2c97e888..2a604f7f18fe2 100644 --- a/static/css/case_study_styles.css +++ b/static/css/case_study_styles.css @@ -767,7 +767,7 @@ hr { background-color: #999999; } h2 { margin-bottom: 15px !important; } -.subhead { padding-bottom: 2% !important; padding-top: 0% !important; } +.subhead { padding-bottom: 2% !important; padding-top: 1% !important; } .details { margin-left: 1.9%; padding-right: 5%; font-size: 16px !important; padding-bottom: 2% !important; } diff --git a/static/css/community.css b/static/css/community.css new file mode 100644 index 0000000000000..9bd94d3dab95d --- /dev/null +++ b/static/css/community.css @@ -0,0 +1,19 @@ +div.community_main h1, h2, h3 { + border-bottom: 1px solid #cccccc; + margin-bottom: 30px; + padding-bottom: 10px; + padding-top: 10px; +} + +div.community_main { + padding: 50px 100px; +} + +div.community_main ul, +div.community_main li { + list-style: disc; + list-style-position: inside; + padding: 10px 0; + font-size: 16px; + font-weight: 400; +} diff --git a/static/css/style_case_studies.css b/static/css/style_case_studies.css index f8a97f2bc83d7..815e1da7d2797 100644 --- a/static/css/style_case_studies.css +++ b/static/css/style_case_studies.css @@ -35,7 +35,7 @@ h1 { .subhead { font-size:26px; - font-weight:100; + font-weight:300; line-height:40px; padding-bottom:1%; padding-top:0.5%; diff --git a/static/css/styles.css b/static/css/styles.css index c012f730815ca..f18ef1b1843a3 100644 --- a/static/css/styles.css +++ b/static/css/styles.css @@ -476,6 +476,7 @@ dd { margin-bottom: 16px; } #docsContent #TableOfContents ul, #docsContent #TableOfContents li { list-style: disk; } + .fixed footer { position: fixed; bottom: 0; } #miceType { clear: both; font-size: 11px; line-height: 18px; color: #aaa; } @@ -754,13 +755,13 @@ html.search #docsContent h1 { margin-bottom: 0; border-bottom: 0; padding-bottom #home #caseStudiesWrapper div { position: relative; display: inline-block; vertical-align: top; width: 100%; min-height: 230px; padding: 125px 10px 15px; margin-bottom: 30px; background-position: top center; background-repeat: no-repeat; } -#home #caseStudiesWrapper div:nth-child(1) { background-image: url(/images/community_logos/pearson_logo.png); } +#home #caseStudiesWrapper div:nth-child(1) { background-image: url(/images/community_logos/capitalone.png); } -#home #caseStudiesWrapper div:nth-child(2) { background-image: url(/images/community_logos/box_logo.png); } +#home #caseStudiesWrapper div:nth-child(2) { background-image: url(/images/community_logos/ing.png); } -#home #caseStudiesWrapper div:nth-child(3) { background-image: url(/images/community_logos/ebay_logo.png); } +#home #caseStudiesWrapper div:nth-child(3) { background-image: url(/images/community_logos/northwestern-mutual.png); } -#home #caseStudiesWrapper div:nth-child(4) { background-image: url(/images/community_logos/wikimedia_foundation_logo.png); } +#home #caseStudiesWrapper div:nth-child(4) { background-image: url(/images/community_logos/openai.png); } #home #caseStudiesWrapper p { font-size: 20px; } @@ -855,6 +856,22 @@ html.search #docsContent h1 { margin-bottom: 0; border-bottom: 0; padding-bottom #docs .flyout-button { display: none; } #docs .logo { position: relative; float: left; display: block; width: 180px; height: 88px; top: 0; left: 0; transform: none; background-image: url(../images/nav_logo.svg); } #docs.flip-nav .logo, #docs.open-nav .logo { background-image: url(../images/nav_logo2.svg); } + div#pre-footer { + background-color: #fff; + text-align: center; + } + div#pre-footer .issue-button-container { + padding-bottom: 10px; + } + div#pre-footer div#lastedit.lastedit { + padding: 0 0 10px 20px; + color: #bbb; + font-size: 13px; + } + div#pre-footer div#lastedit.lastedit a { + color: #3371e3; + text-decoration: underline; + } #encyclopedia { padding: 50px 50px 100px 100px; clear: both; } #docsToc { position: relative; float: left; padding: 0 20px; left: 0; width: 350px; z-index: auto; } #docsToc .push-menu-close-button { display: none; } diff --git a/static/docs/reference/generated/kubectl/kubectl-commands.html b/static/docs/reference/generated/kubectl/kubectl-commands.html index 97b6efc8e80cc..c060bb0cef3b6 100644 --- a/static/docs/reference/generated/kubectl/kubectl-commands.html +++ b/static/docs/reference/generated/kubectl/kubectl-commands.html @@ -11,7 +11,7 @@ - +
  • example

GETTING STARTED

@@ -25,71 +25,26 @@ WORKING WITH APPS section to inspect them.

-

run

-
-

Start a single instance of nginx.

-
-
kubectl run nginx --image=nginx
-
-
-

Start a single instance of hazelcast and let the container expose port 5701 .

-
-
kubectl run hazelcast --image=hazelcast --port=5701
-
-
-

Start a single instance of hazelcast and set environment variables "DNS_DOMAIN=cluster" and "POD_NAMESPACE=default" in the container.

-
-
kubectl run hazelcast --image=hazelcast --env="DNS_DOMAIN=cluster" --env="POD_NAMESPACE=default"
-
-
-

Start a single instance of hazelcast and set labels "app=hazelcast" and "env=prod" in the container.

-
-
kubectl run hazelcast --image=nginx --labels="app=hazelcast,env=prod"
-
-
-

Start a replicated instance of nginx.

-
-
kubectl run nginx --image=nginx --replicas=5
-
-
-

Dry run. Print the corresponding API objects without creating them.

-
-
kubectl run nginx --image=nginx --dry-run
-
-
-

Start a single instance of nginx, but overload the spec of the deployment with a partial set of values parsed from JSON.

-
-
kubectl run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }'
-
-
-

Start a pod of busybox and keep it in the foreground, don't restart it if it exits.

-
-
kubectl run -i -t busybox --image=busybox --restart=Never
-
-
-

Start the nginx container using the default command, but use custom arguments (arg1 .. argN) for that command.

-
-
kubectl run nginx --image=nginx -- <arg1> <arg2> ... <argN>
-
+

create

-

Start the nginx container using a different command and custom arguments.

+

Create a pod using the data in pod.json.

-
kubectl run nginx --image=nginx --command -- <cmd> <arg1> ... <argN>
+
kubectl create -f ./pod.json
 

 

-
 Start the perl container to compute π to 2000 places and print it out.

+
 Create a pod based on the JSON passed into stdin.

 

-
kubectl run pi --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
+
cat pod.json | kubectl create -f -
 

 

-
 Start the cron job to compute π to 2000 places and print it out every 5 minutes.

+
 Edit the data in docker-registry.yaml in JSON then create the resource using the edited data.

 

-
kubectl run pi --schedule="0/5 * * * ?" --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
+
kubectl create -f docker-registry.yaml --edit -o json
 

-
Create and run a particular image, possibly replicated. 

-
Creates a deployment or job to manage the created container(s).

+
Create a resource from a file or from stdin. 

+
JSON and YAML formats are accepted.

 
Usage

-
$ run NAME --image=image [--env="key=value"] [--port=port] [--replicas=replicas] [--dry-run=bool] [--overrides=inline-json] [--command] -- [COMMAND] [args...]

+
$ create -f FILENAME

 
Flags

 
@@ -108,154 +63,166 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
+
-
-
-
-
+
+
+
+
-
-
+
+
-
+
-
+
-
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
-
+
-
+
-
-
+
+
-
+
-
+
-
-
-
-
-
-
-
+
-
-
+
-
+
+
-
-
+
-
+
+
+
+

 
 
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
attachfalseIf true, wait for the Pod to start running, and then attach to the Pod as if 'kubectl attach ...' were called.  Default false, unless '-i/--stdin' is set, in which case the default is true. With '--restart=Never' the exit code of the container process is returned. 
commandfalseIf true and extra arguments are present, use them as the 'command' field in the container, rather than the 'args' field which is the default. 

 dry-run
 
 false
 If true, only print the object that would be sent, without sending it. 
 

 
env[]Environment variables to set in the container 
exposeedit
 
 falseIf true, a public, external service is created for the container(s) which are run 
generatorThe name of the API generator to use, see http://kubernetes.io/docs/user-guide/kubectl-conventions/#generators for a list. Edit the API resource before creating 
 

 
hostport-1The host port mapping for the container port. To demonstrate a single-machine container. filenamef[]Filename, directory, or URL to files to use to create the resource 
 

 
imageoutputo
 The image for the container to run. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
image-pull-policyraw
 
 The image pull policy for the container. If left empty, this value will not be specified by the client and defaulted by the server Raw URI to POST to the server.  Uses the transport specified by the kubeconfig file. 
 

 
include-extended-apisrecord
 trueIf true, include definitions of new APIs via calls to the API server. [default true] falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
 

 
labelslComma separated labels to apply to the pod(s). Will override previous values. recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
leave-stdin-opensave-config
 
 falseIf the pod is started in interactive mode or with stdin, leave stdin open after the first attach completes. By default, stdin will be closed after the first attach completes. If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
limitsselectorl
 The resource requirement limits for this container.  For example, 'cpu=200m,memory=512Mi'.  Note that server side components may assign limits depending on the server configuration, such as limit ranges. Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
 

 
no-headerstemplate
 falseWhen using the default or custom-column output format, don't print headers (default print headers). 
outputo
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
output-versionvalidate
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). trueIf true, use a schema to validate the input before sending it 
 

 
overrideswindows-line-endings
 An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. falseOnly relevant if --edit=true. Defaults to the line ending native to your platform. 
 

+

+
clusterrole

+

+
 Create a ClusterRole named "pod-reader" that allows user to perform "get", "watch" and "list" on pods

+

+
kubectl create clusterrole pod-reader --verb=get,list,watch --resource=pods
+

+

+
 Create a ClusterRole named "pod-reader" with ResourceName specified

+

+
kubectl create clusterrole pod-reader --verb=get --resource=pods --resource-name=readablepod --resource-name=anotherpod
+

+

+
 Create a ClusterRole named "foo" with API Group specified

+

+
kubectl create clusterrole foo --verb=get,list,watch --resource=rs.extensions
+

+

+
 Create a ClusterRole named "foo" with SubResource specified

+

+
kubectl create clusterrole foo --verb=get,list,watch --resource=pods,pods/status
+

+

+
 Create a ClusterRole name "foo" with NonResourceURL specified

+

+
kubectl create clusterrole "foo" --verb=get --non-resource-url=/logs/*
+

+

+
 Create a ClusterRole name "monitoring" with AggregationRule specified

+

+
kubectl create clusterrole monitoring --aggregation-rule="rbac.example.com/aggregate-to-monitoring=true"
+

+
Create a ClusterRole.

+
Usage

+
$ clusterrole NAME --verb=verb --resource=resource.group [--resource-name=resourcename] [--dry-run]

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
+
-
+
-
+
-
-
+
+
-
+
-
+
-
-
-
-
+
+
+
+
-
-
+
+
-
+
-
+
-
-
+
+
-
+
-
-
+
+
@@ -264,52 +231,93 @@ 
Flags

-
+
-
+
-
+
-
-
+
+
-
-
+
-
+
+
-
-
-
-
-
+
+

 
pod-running-timeout1m0sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running NameShorthandDefaultUsage
 

 
portaggregation-rule
 
 The port that this container exposes.  If --expose is true, this is also the port used by the service that is created. An aggregation label selector for combining ClusterRoles. 
 

 
quietallow-missing-template-keys
 falseIf true, suppress prompt messages. trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
recorddry-run
 
 falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. If true, only print the object that would be sent, without sending it. 
 

 
replicasr1Number of replicas to create for this container. Default is 1. non-resource-url[]A partial url that user should have access to. 
 

 
requestsoutputo
 The resource requirement requests for this container.  For example, 'cpu=100m,memory=256Mi'.  Note that server side components may assign requests depending on the server configuration, such as limit ranges. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
restartresource
 AlwaysThe restart policy for this Pod.  Legal values [Always, OnFailure, Never].  If set to 'Always' a deployment is created, if set to 'OnFailure' a job is created, if set to 'Never', a regular pod is created. For the latter two --replicas must be 1.  Default 'Always', for CronJobs Never. []Resource that the rule applies to 
 

 
rmresource-name
 falseIf true, delete resources created in this command for attached containers. []Resource in the white list that the rule applies to, repeat this flag for multiple items 
 

 

 save-config
 If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
scheduletemplate
 
 A schedule in the Cron format the job should be run with. Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
service-generatorvalidate
 service/v2The name of the generator to use for creating a service.  Only used if --expose is true trueIf true, use a schema to validate the input before sending it 
 

 
service-overridesverb
 An inline JSON override for the generated service object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.  Only used if --expose is true. []Verb that applies to the resources contained in the rule 
 
serviceaccountService account to set in the pod spec 

+

+
clusterrolebinding

+

+
 Create a ClusterRoleBinding for user1, user2, and group1 using the cluster-admin ClusterRole

+

+
kubectl create clusterrolebinding cluster-admin --clusterrole=cluster-admin --user=user1 --user=user2 --group=group1
+

+
Create a ClusterRoleBinding for a particular ClusterRole.

+
Usage

+
$ clusterrolebinding NAME --clusterrole=NAME [--user=username] [--group=groupname] [--serviceaccount=namespace:serviceaccountname] [--dry-run]

+
Flags

+
+
+
+
+
+
+
+
+
-
-
+
+
-
+
-
+
+
+
+
+
+
+
-
+
-
+
+
+
+
+
+
-
+
+
-
-
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
@@ -318,79 +326,46 @@ 
Flags

-
-
-
-
+
+
+
+
NameShorthandDefaultUsage
 

 
show-allaallow-missing-template-keys
 trueWhen printing, show all resources (default show all pods including terminated one.) If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
show-labelsclusterroleClusterRole this ClusterRoleBinding should reference 
dry-run
 
 falseWhen printing, show all labels as the last column (default hide labels column) If true, only print the object that would be sent, without sending it. 
 

 
sort-bygenerator
 clusterrolebinding.rbac.authorization.k8s.io/v1alpha1The name of the API generator to use. 
group
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. []Groups to bind to the role 
 

 
stdinioutputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
save-config
 falseKeep stdin open on the container(s) in the pod, even if nothing is attached. If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
serviceaccount[]Service accounts to bind to the role, in the format : 
 

 

 template
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
ttytfalseAllocated a TTY for each container in the pod. validatetrueIf true, use a schema to validate the input before sending it 
 

 
 

 

-
run-container

-

-
 Start a single instance of nginx.

-

-
kubectl run nginx --image=nginx
-

-

-
 Start a single instance of hazelcast and let the container expose port 5701 .

-

-
kubectl run hazelcast --image=hazelcast --port=5701
-

-

-
 Start a single instance of hazelcast and set environment variables "DNS_DOMAIN=cluster" and "POD_NAMESPACE=default" in the container.

-

-
kubectl run hazelcast --image=hazelcast --env="DNS_DOMAIN=cluster" --env="POD_NAMESPACE=default"
-

-

-
 Start a single instance of hazelcast and set labels "app=hazelcast" and "env=prod" in the container.

-

-
kubectl run hazelcast --image=nginx --labels="app=hazelcast,env=prod"
-

-

-
 Start a replicated instance of nginx.

-

-
kubectl run nginx --image=nginx --replicas=5
-

-

-
 Dry run. Print the corresponding API objects without creating them.

-

-
kubectl run nginx --image=nginx --dry-run
-

-

-
 Start a single instance of nginx, but overload the spec of the deployment with a partial set of values parsed from JSON.

-

-
kubectl run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }'
-

+
configmap

 

-
 Start a pod of busybox and keep it in the foreground, don't restart it if it exits.

+
 Create a new configmap named my-config based on folder bar

 

-
kubectl run -i -t busybox --image=busybox --restart=Never
+
kubectl create configmap my-config --from-file=path/to/bar
 

 

-
 Start the nginx container using the default command, but use custom arguments (arg1 .. argN) for that command.

+
 Create a new configmap named my-config with specified keys instead of file basenames on disk

 

-
kubectl run nginx --image=nginx -- <arg1> <arg2> ... <argN>
+
kubectl create configmap my-config --from-file=key1=/path/to/bar/file1.txt --from-file=key2=/path/to/bar/file2.txt
 

 

-
 Start the nginx container using a different command and custom arguments.

+
 Create a new configmap named my-config with key1=config1 and key2=config2

 

-
kubectl run nginx --image=nginx --command -- <cmd> <arg1> ... <argN>
+
kubectl create configmap my-config --from-literal=key1=config1 --from-literal=key2=config2
 

 

-
 Start the perl container to compute π to 2000 places and print it out.

+
 Create a new configmap named my-config from the key=value pairs in the file

 

-
kubectl run pi --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
+
kubectl create configmap my-config --from-file=path/to/bar
 

 

-
 Start the cron job to compute π to 2000 places and print it out every 5 minutes.

+
 Create a new configmap named my-config from an env file

 

-
kubectl run pi --schedule="0/5 * * * ?" --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
+
kubectl create configmap my-config --from-env-file=path/to/bar.env
 

-
Create and run a particular image, possibly replicated. 

-
Creates a deployment or job to manage the created container(s).

+
Create a configmap based on a file, directory, or specified literal value. 

+
A single configmap may package one or more key/value pairs. 

+
When creating a configmap based on a file, the key will default to the basename of the file, and the value will default to the file content.  If the basename is an invalid key, you may specify an alternate key. 

+
When creating a configmap based on a directory, each file whose basename is a valid key in the directory will be packaged into the configmap.  Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).

 
Usage

-
$ run-container

+
$ configmap NAME [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run]

 
Flags

 
@@ -409,88 +384,111 @@ 
Flags

-
+
-
+
-
+
-
+
-
+
-
-
+
+
-
+
-
+
-
+
-
-
+
+
-
-
+
+
-
+
+
-
-
+
-
-
+
-
+
+
-
+
-
+
-
+
-
+
+
+
+

 
 
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
attachappend-hash
 
 falseIf true, wait for the Pod to start running, and then attach to the Pod as if 'kubectl attach ...' were called.  Default false, unless '-i/--stdin' is set, in which case the default is true. With '--restart=Never' the exit code of the container process is returned. Append a hash of the configmap to its name. 
 

 
commanddry-run
 
 falseIf true and extra arguments are present, use them as the 'command' field in the container, rather than the 'args' field which is the default. If true, only print the object that would be sent, without sending it. 
 

 
dry-runfrom-env-file
 falseIf true, only print the object that would be sent, without sending it. Specify the path to a file to read lines of key=val pairs to create a configmap (i.e. a Docker .env file). 
 

 
envfrom-file
 
 []Environment variables to set in the container Key file can be specified using its file path, in which case file basename will be used as configmap key, or optionally with a key and file path, in which case the given key will be used.  Specifying a directory will iterate each named file in the directory whose basename is a valid configmap key. 
 

 
exposefrom-literal
 falseIf true, a public, external service is created for the container(s) which are run []Specify a key and literal value to insert in configmap (i.e. mykey=somevalue) 
 

 

 generator
 The name of the API generator to use, see http://kubernetes.io/docs/user-guide/kubectl-conventions/#generators for a list. configmap/v1The name of the API generator to use. 
 

 
hostportoutputo
 -1The host port mapping for the container port. To demonstrate a single-machine container. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
imagesave-config
 The image for the container to run. falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
image-pull-policytemplate
 
 The image pull policy for the container. If left empty, this value will not be specified by the client and defaulted by the server Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
include-extended-apisvalidate
 
 trueIf true, include definitions of new APIs via calls to the API server. [default true] If true, use a schema to validate the input before sending it 

+

+
deployment

+

+
 Create a new deployment named my-dep that runs the busybox image.

+

+
kubectl create deployment my-dep --image=busybox
+

+
Create a deployment with the specified name.

+
Usage

+
$ deployment NAME --image=image [--dry-run]

+
Flags

+
+
+
+
+
+
+
+
+
-
-
+
-
+
+
-
+
-
+
-
+
-
+
-
+
-
-
+
+
@@ -499,64 +497,69 @@ 
Flags

-
-
+
-
+
+
-
-
+
-
-
-
-
-
-
+
-
-
+
-
-
-
-
-
-
-
+
+
+
+
NameShorthandDefaultUsage
 

 
labelslallow-missing-template-keys
 Comma separated labels to apply to the pod(s). Will override previous values. trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
leave-stdin-opendry-run
 
 falseIf the pod is started in interactive mode or with stdin, leave stdin open after the first attach completes. By default, stdin will be closed after the first attach completes. If true, only print the object that would be sent, without sending it. 
 

 
limitsgenerator
 
 The resource requirement limits for this container.  For example, 'cpu=200m,memory=512Mi'.  Note that server side components may assign limits depending on the server configuration, such as limit ranges. The name of the API generator to use. 
 

 
no-headersimage
 falseWhen using the default or custom-column output format, don't print headers (default print headers). []Image name to run. 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionsave-config
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
overridestemplate
 An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. 
pod-running-timeout
 1m0sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
portvalidate
 The port that this container exposes.  If --expose is true, this is also the port used by the service that is created. 
quietfalseIf true, suppress prompt messages. trueIf true, use a schema to validate the input before sending it 
 

+

+
job

+

+
 Create a job from a CronJob named "a-cronjob"

+

+
kubectl create job test-job --from=cronjob/a-cronjob
+

+
Create a job with the specified name.

+
Usage

+
$ job NAME [--from=CRONJOB]

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
-
-
-
+
+
+
+
-
-
+
-
+
+
-
+
-
-
+
+
-
+
+
-
-
+
@@ -565,52 +568,69 @@ 
Flags

-
+
-
+
-
+
-
-
+
+
+
+

 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. NameShorthandDefaultUsage
 

 
replicasr1Number of replicas to create for this container. Default is 1. allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
requestsdry-run
 The resource requirement requests for this container.  For example, 'cpu=100m,memory=256Mi'.  Note that server side components may assign requests depending on the server configuration, such as limit ranges. falseIf true, only print the object that would be sent, without sending it. 
 

 
restartfrom
 AlwaysThe restart policy for this Pod.  Legal values [Always, OnFailure, Never].  If set to 'Always' a deployment is created, if set to 'OnFailure' a job is created, if set to 'Never', a regular pod is created. For the latter two --replicas must be 1.  Default 'Always', for CronJobs Never. The name of the resource to create a Job from (only cronjob is supported). 
 

 
rmoutputo
 falseIf true, delete resources created in this command for attached containers. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 

 save-config
 If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
scheduletemplate
 
 A schedule in the Cron format the job should be run with. Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
service-generatorvalidate
 service/v2The name of the generator to use for creating a service.  Only used if --expose is true trueIf true, use a schema to validate the input before sending it 
 

+

+
namespace

+

+
 Create a new namespace named my-namespace

+

+
kubectl create namespace my-namespace
+

+
Create a namespace with the specified name.

+
Usage

+
$ namespace NAME [--dry-run]

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
-
+
-
-
-
-
-
-
+
-
+
-
+
-
+
+
+
+
+
+
+
-
+
-
-
+
+
-
+
@@ -619,56 +639,28 @@ 
Flags

-
-
-
-
+
+
+
+

 
service-overridesAn inline JSON override for the generated service object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.  Only used if --expose is true. NameShorthandDefaultUsage
 

 
serviceaccountallow-missing-template-keys
 Service account to set in the pod spec 
show-alla
 trueWhen printing, show all resources (default show all pods including terminated one.) If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
show-labelsdry-run
 
 falseWhen printing, show all labels as the last column (default hide labels column) If true, only print the object that would be sent, without sending it. 
 

 
sort-bygenerator
 namespace/v1The name of the API generator to use. 
outputo
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
stdinisave-config
 falseKeep stdin open on the container(s) in the pod, even if nothing is attached. If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 

 template
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
ttytfalseAllocated a TTY for each container in the pod. validatetrueIf true, use a schema to validate the input before sending it 
 

 
 

 

-
expose

-

-
 Create a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000.

-

-
kubectl expose rc nginx --port=80 --target-port=8000
-

-

-
 Create a service for a replication controller identified by type and name specified in "nginx-controller.yaml", which serves on port 80 and connects to the containers on port 8000.

-

-
kubectl expose -f nginx-controller.yaml --port=80 --target-port=8000
-

-

-
 Create a service for a pod valid-pod, which serves on port 444 with the name "frontend"

-

-
kubectl expose pod valid-pod --port=444 --name=frontend
-

-

-
 Create a second service based on the above service, exposing the container port 8443 as port 443 with the name "nginx-https"

-

-
kubectl expose service nginx --port=443 --target-port=8443 --name=nginx-https
-

-

-
 Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video-stream'.

-

-
kubectl expose rc streamer --port=4100 --protocol=udp --name=video-stream
-

+
poddisruptionbudget

 

-
 Create a service for a replicated nginx using replica set, which serves on port 80 and connects to the containers on port 8000.

+
 Create a pod disruption budget named my-pdb that will select all pods with the app=rails label # and require at least one of them being available at any point in time.

 

-
kubectl expose rs nginx --port=80 --target-port=8000
+
kubectl create poddisruptionbudget my-pdb --selector=app=rails --min-available=1
 

 

-
 Create a service for an nginx deployment, which serves on port 80 and connects to the containers on port 8000.

+
 Create a pod disruption budget named my-pdb that will select all pods with the app=nginx label # and require at least half of the pods selected to be available at any point in time.

 

-
kubectl expose deployment nginx --port=80 --target-port=8000
+
kubectl create pdb my-pdb --selector=app=nginx --min-available=50%
 

-
Expose a resource as a new Kubernetes service. 

-
Looks up a deployment, service, replica set, replication controller or pod by name and uses the selector for that resource as the selector for a new service on the specified port. A deployment or replica set will be exposed as a service only if its selector is convertible to a selector that service supports, i.e. when the selector contains only the matchLabels component. Note that if no port is specified via --port and the exposed resource has multiple ports, all will be re-used by the new service. Also if no labels are specified, the new service will re-use the labels from the resource it exposes. 

-
Possible resources include (case insensitive): 

-
pod (po), service (svc), replicationcontroller (rc), deployment (deploy), replicaset (rs)

+
Create a pod disruption budget with the specified name, selector, and desired minimum available pods

 
Usage

-
$ expose (-f FILENAME | TYPE NAME) [--port=port] [--protocol=TCP|UDP] [--target-port=number-or-name] [--name=name] [--external-ip=external-ip-of-service] [--type=type]

+
$ poddisruptionbudget NAME --selector=SELECTOR --min-available=N [--dry-run]

 
Flags

 
@@ -687,64 +679,28 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
+
-
+
-
-
+
-
-
-
-
-
-
+
@@ -753,42 +709,6 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -798,132 +718,37 @@ 
Flags

-
+
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
+

 
 
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
cluster-ipClusterIP to be assigned to the service. Leave empty to auto-allocate, or set to 'None' to create a headless service. 
container-portSynonym for --target-port 

 dry-run
 
 false
 If true, only print the object that would be sent, without sending it. 
 

 
external-ipAdditional external IP address (not managed by Kubernetes) to accept for the service. If this IP is routed to a node, the service can be accessed by this IP in addition to its generated service IP. 
filenamef[]Filename, directory, or URL to files identifying the resource to expose a service 

 generator
 service/v2The name of the API generator to use. There are 2 generators: 'service/v1' and 'service/v2'. The only difference between them is that service port in v1 is named 'default', while it is left unnamed in v2. Default is 'service/v2'. 
labelslLabels to apply to the service created by this call. poddisruptionbudget/v1beta1/v2The name of the API generator to use. 
 

 
load-balancer-ipmax-unavailable
 
 IP to assign to the LoadBalancer. If empty, an ephemeral IP will be created and used (cloud-provider specific). The maximum number or percentage of unavailable pods this budget requires. 
 

 
namemin-available
 The name for the newly created object. 
no-headers
 falseWhen using the default or custom-column output format, don't print headers (default print headers). The minimum number or percentage of available pods this budget requires. 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
overridesAn inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. 
portThe port that the service should serve on. Copied from the resource being exposed, if unspecified 
protocolThe network protocol for the service to be created. Default is 'TCP'. 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 

 save-config
 
 false
 selector
 
 A label selector to use for this service. Only equality-based selector requirements are supported. If empty (the default) infer the selector from the replication controller or replica set.) A label selector to use for this budget. Only equality-based selector requirements are supported. 
 

 
session-affinitytemplate
 
 If non-empty, set the session affinity for the service to this; legal values: 'None', 'ClientIP' Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 
target-portName or number for the port on the container that the service should direct traffic to. Optional. 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
typevalidate
 Type for this service: ClusterIP, NodePort, LoadBalancer, or ExternalName. Default is 'ClusterIP'. trueIf true, use a schema to validate the input before sending it 
 

 
 

-
APP MANAGEMENT

-
This section contains commands for creating, updating, deleting, and
-viewing your workloads in a Kubernetes cluster.

 

-
annotate

-

-
 Update pod 'foo' with the annotation 'description' and the value 'my frontend'. # If the same annotation is set multiple times, only the last value will be applied

-

-
kubectl annotate pods foo description='my frontend'
-

-

-
 Update a pod identified by type and name in "pod.json"

-

-
kubectl annotate -f pod.json description='my frontend'
-

-

-
 Update pod 'foo' with the annotation 'description' and the value 'my frontend running nginx', overwriting any existing value.

-

-
kubectl annotate --overwrite pods foo description='my frontend running nginx'
-

-

-
 Update all pods in the namespace

-

-
kubectl annotate pods --all description='my frontend running nginx'
-

+
priorityclass

 

-
 Update pod 'foo' only if the resource is unchanged from version 1.

+
 Create a priorityclass named high-priority

 

-
kubectl annotate pods foo description='my frontend running nginx' --resource-version=1
+
kubectl create priorityclass default-priority --value=1000 --description="high priority"
 

 

-
 Update pod 'foo' by removing an annotation named 'description' if it exists. # Does not require the --overwrite flag.

+
 Create a priorityclass named default-priority that considered as the global default priority

 

-
kubectl annotate pods foo description-
+
kubectl create priorityclass default-priority --value=1000 --global-default=true --description="default priority"
 

-
Update the annotations on one or more resources 

-
All Kubernetes objects support the ability to store additional data with the object as annotations. Annotations are key/value pairs that can be larger than labels and include arbitrary string values such as structured JSON. Tools and system extensions may use annotations to store their own data. 

-
Attempting to set an annotation that already exists will fail unless --overwrite is set. If --resource-version is specified and does not match the current resource version on the server the command will fail.

-
Valid resource types include: 

-
    
-
  • all  
    • 
-
  • certificatesigningrequests (aka 'csr')  
    • 
-
  • clusterrolebindings  
    • 
-
  • clusterroles  
    • 
-
  • componentstatuses (aka 'cs')  
    • 
-
  • configmaps (aka 'cm')  
    • 
-
  • controllerrevisions  
    • 
-
  • cronjobs  
    • 
-
  • customresourcedefinition (aka 'crd')  
    • 
-
  • daemonsets (aka 'ds')  
    • 
-
  • deployments (aka 'deploy')  
    • 
-
  • endpoints (aka 'ep')  
    • 
-
  • events (aka 'ev')  
    • 
-
  • horizontalpodautoscalers (aka 'hpa')  
    • 
-
  • ingresses (aka 'ing')  
    • 
-
  • jobs  
    • 
-
  • limitranges (aka 'limits')  
    • 
-
  • namespaces (aka 'ns')  
    • 
-
  • networkpolicies (aka 'netpol')  
    • 
-
  • nodes (aka 'no')  
    • 
-
  • persistentvolumeclaims (aka 'pvc')  
    • 
-
  • persistentvolumes (aka 'pv')  
    • 
-
  • poddisruptionbudgets (aka 'pdb')  
    • 
-
  • podpreset  
    • 
-
  • pods (aka 'po')  
    • 
-
  • podsecuritypolicies (aka 'psp')  
    • 
-
  • podtemplates  
    • 
-
  • replicasets (aka 'rs')  
    • 
-
  • replicationcontrollers (aka 'rc')  
    • 
-
  • resourcequotas (aka 'quota')  
    • 
-
  • rolebindings  
    • 
-
  • roles  
    • 
-
  • secrets  
    • 
-
  • serviceaccounts (aka 'sa')  
    • 
-
  • services (aka 'svc')  
    • 
-
  • statefulsets (aka 'sts')  
    • 
-
  • storageclasses (aka 'sc')
    • 
-

+
Create a priorityclass with the specified name, value, globalDefault and description

 
Usage

-
$ annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]

+
$ priorityclass NAME --value=VALUE --global-default=BOOL [--dry-run]

 
Flags

 
@@ -936,112 +761,134 @@ 
Flags

-
-
-
-
-
-
+
+
+
+
+
+
-
-
-
-
-
-
-
+
-
-
+
+
-
+
-
+
-
+
+
-
-
+
-
+
-
+
-
-
+
-
+
+
-
-
+
-
+
+
-
+
-
-
+
+
+
+
+

 
 
 
 
allfalseSelect all resources, including uninitialized ones, in the namespace of the specified resource types. 

 allow-missing-template-keys
 
 true
 If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
descriptiondescription is an arbitrary string that usually provides guidelines on when this priority class should be used. 

 dry-run
 
 false
 If true, only print the object that would be sent, without sending it. 
 

 
filenamef[]Filename, directory, or URL to files identifying the resource to update the annotation 
include-extended-apisgenerator
 trueIf true, include definitions of new APIs via calls to the API server. [default true] priorityclass/v1alpha1The name of the API generator to use. 
 

 
include-uninitializedglobal-default
 
 falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. global-default specifies whether this PriorityClass should be considered as the default priority. 
 

 
localoutputo
 falseIf true, annotation will NOT contact api-server but run locally. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
no-headerssave-config
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
outputotemplate
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
output-versionvalidate
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). trueIf true, use a schema to validate the input before sending it 
 

 
overwritevalue
 falseIf true, allow annotations to be overwritten, otherwise reject annotation updates that overwrite existing annotations. 0the value of this priority class. 

+

+
quota

+

+
 Create a new resourcequota named my-quota

+

+
kubectl create quota my-quota --hard=cpu=1,memory=1G,pods=2,services=3,replicationcontrollers=2,resourcequotas=1,secrets=5,persistentvolumeclaims=10
+

+

+
 Create a new resourcequota named best-effort

+

+
kubectl create quota best-effort --hard=pods=100 --scopes=BestEffort
+

+
Create a resourcequota with the specified name, hard limits and optional scopes

+
Usage

+
$ quota NAME [--hard=key1=value1,key2=value2] [--scopes=Scope1,Scope2] [--dry-run=bool]

+
Flags

+
+
+
+
+
+
+
+
+
-
+
-
-
+
+
-
-
+
+
-
+
-
-
+
-
+
+
-
-
+
-
+
+
-
-
-
-
+
+
+
+
-
+
-
+
-
+
-
+
@@ -1049,24 +896,39 @@ 
Flags

+
+
+
+
+
+
NameShorthandDefaultUsage
 

 
recordallow-missing-template-keys
 falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
recursiveRdry-run
 falseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. If true, only print the object that would be sent, without sending it. 
 

 
resource-versiongenerator
 If non-empty, the annotation update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. resourcequotas/v1The name of the API generator to use. 
 

 
selectorlhard
 Selector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). A comma-delimited set of resource=quantity pairs that define a hard limit. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
show-labelssave-config
 
 falseWhen printing, show all labels as the last column (default hide labels column) If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
sort-byscopes
 
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. A comma-delimited set of quota scopes that must all match each object tracked by the quota. 
 

 

 template
 
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 
validatetrueIf true, use a schema to validate the input before sending it 

 
 

 

-
autoscale

+
role

 

-
 Auto scale a deployment "foo", with the number of pods between 2 and 10, no target CPU utilization specified so a default autoscaling policy will be used:

+
 Create a Role named "pod-reader" that allows user to perform "get", "watch" and "list" on pods

 

-
kubectl autoscale deployment foo --min=2 --max=10
+
kubectl create role pod-reader --verb=get --verb=list --verb=watch --resource=pods
 

 

-
 Auto scale a replication controller "foo", with the number of pods between 1 and 5, target CPU utilization at 80%:

+
 Create a Role named "pod-reader" with ResourceName specified

 

-
kubectl autoscale rc foo --max=5 --cpu-percent=80
+
kubectl create role pod-reader --verb=get --resource=pods --resource-name=readablepod --resource-name=anotherpod
 

-
Creates an autoscaler that automatically chooses and sets the number of pods that run in a kubernetes cluster. 

-
Looks up a Deployment, ReplicaSet, or ReplicationController by name and creates an autoscaler that uses the given resource as a reference. An autoscaler can automatically increase or decrease number of pods deployed within the system as needed.

+

+
 Create a Role named "foo" with API Group specified

+

+
kubectl create role foo --verb=get,list,watch --resource=rs.extensions
+

+

+
 Create a Role named "foo" with SubResource specified

+

+
kubectl create role foo --verb=get,list,watch --resource=pods,pods/status
+

+
Create a role with single rule.

 
Usage

-
$ autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU]

+
$ role NAME --verb=verb --resource=resource.group/subresource [--resource-name=resourcename] [--dry-run]

 
Flags

 
@@ -1085,106 +947,129 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
+
-
+
-
-
+
+
-
-
+
-
+
+
+
+
+

 
 
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
cpu-percent-1The target average CPU utilization (represented as a percent of requested CPU) over all the pods. If it's not specified or negative, a default autoscaling policy will be used. 

 dry-run
 
 false
 If true, only print the object that would be sent, without sending it. 
 

 
filenamef[]Filename, directory, or URL to files identifying the resource to autoscale. 
generatoroutputo
 horizontalpodautoscaler/v1The name of the API generator to use. Currently there is only 1 generator. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
include-extended-apisresource
 trueIf true, include definitions of new APIs via calls to the API server. [default true] []Resource that the rule applies to 
 

 
maxresource-name
 -1The upper limit for the number of pods that can be set by the autoscaler. Required. []Resource in the white list that the rule applies to, repeat this flag for multiple items 
 

 
minsave-config
 -1The lower limit for the number of pods that can be set by the autoscaler. If it's not specified or negative, the server will apply a default value. falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
nametemplate
 
 The name for the newly created object. If not specified, the name of the input resource will be used. Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
no-headersvalidate
 falseWhen using the default or custom-column output format, don't print headers (default print headers). trueIf true, use a schema to validate the input before sending it 
 

 
outputoverb
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. []Verb that applies to the resources contained in the rule 

+

+
rolebinding

+

+
 Create a RoleBinding for user1, user2, and group1 using the admin ClusterRole

+

+
kubectl create rolebinding admin --clusterrole=admin --user=user1 --user=user2 --group=group1
+

+
Create a RoleBinding for a particular Role or ClusterRole.

+
Usage

+
$ rolebinding NAME --clusterrole=NAME|--role=NAME [--user=username] [--group=groupname] [--serviceaccount=namespace:serviceaccountname] [--dry-run]

+
Flags

+
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
-
+
-
+
-
+
-
-
-
-
+
+
+
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
-
+
-
-
+
+
-
+
+
+
+
+
+
-
+
+
@@ -1192,30 +1077,36 @@ 
Flags

+
+
+
+
+
+
NameShorthandDefaultUsage
 

 
output-versionallow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
clusterrole
 
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). ClusterRole this RoleBinding should reference 
 

 
recorddry-run
 
 falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. If true, only print the object that would be sent, without sending it. 
 

 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. generatorrolebinding.rbac.authorization.k8s.io/v1alpha1The name of the API generator to use. 
 

 
save-configgroup
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. []Groups to bind to the role 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
show-labelsrole
 falseWhen printing, show all labels as the last column (default hide labels column) Role this RoleBinding should reference 
 

 
sort-bysave-config
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
serviceaccount
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. []Service accounts to bind to the role, in the format : 
 

 

 template
 
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 
validatetrueIf true, use a schema to validate the input before sending it 

 
 

 

-
convert

-

-
 Convert 'pod.yaml' to latest version and print to stdout.

-

-
kubectl convert -f pod.yaml
-

-

-
 Convert the live state of the resource specified by 'pod.yaml' to the latest version # and print to stdout in JSON format.

-

-
kubectl convert -f pod.yaml --local -o json
-

+
secret

+
Create a secret using specified subcommand.

+
Usage

+
$ secret

+

+
secret docker-registry

 

-
 Convert all files under current directory to latest version and create them all.

+
 If you don't already have a .dockercfg file, you can create a dockercfg secret directly by using:

 

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

-
Convert config files between different API versions. Both YAML and JSON formats are accepted. 

-
The command takes filename, directory, or URL as input, and convert it into format of version specified by --output-version flag. If target version is not specified or not supported, convert to latest version. 

-
The default output will be printed to stdout in YAML format. One can use -o option to change to output destination.

+
Create a new secret for use with Docker registries.

+
  Dockercfg secrets are used to authenticate against Docker registries.

+
  When using the Docker command line to push images, you can authenticate to a given registry by running:
+      '$ docker login DOCKER_REGISTRY_SERVER --username=DOCKER_USER --password=DOCKER_PASSWORD --email=DOCKER_EMAIL'.

+
That produces a ~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to authenticate to the registry. The email address is optional. 

+
  When creating applications, you may have a Docker registry that requires authentication.  In order for the
+  nodes to pull images on your behalf, they have to have the credentials.  You can provide this information
+  by creating a dockercfg secret and attaching it to your service account.

 
Usage

-
$ convert -f FILENAME

+
$ docker-registry NAME --docker-username=user --docker-password=password --docker-email=email [--docker-server=string] [--from-literal=key1=value1] [--dry-run]

 
Flags

 
@@ -1234,64 +1125,64 @@ 
Flags

-
-
-
-
-
-
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
-
+
-
+
+
-
+
-
+
-
-
+
+
-
+
-
-
-
-
+
+
+
+
-
+
-
-
+
+
-
+
+
+
+
+
+
-
+
+
@@ -1308,26 +1199,38 @@ 
Flags

 
 
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
filenamef[]Filename, directory, or URL to files to need to get converted. 
include-extended-apisappend-hash
 trueIf true, include definitions of new APIs via calls to the API server. [default true] falseAppend a hash of the secret to its name. 
 

 
localdocker-email
 trueIf true, convert will NOT try to contact api-server but run locally. Email for Docker registry 
 

 
no-headersdocker-password
 falseWhen using the default or custom-column output format, don't print headers (default print headers). Password for Docker registry authentication 
 

 
outputodocker-server
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. https://index.docker.io/v1/Server location for Docker registry 
 

 
output-versiondocker-username
 
 Output the formatted object with the given group version (for ex: 'extensions/v1beta1').) Username for Docker registry authentication 
 

 
recursiveRdry-run
 falseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. If true, only print the object that would be sent, without sending it. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) from-file[]Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used.  Specifying a directory will iterate each named file in the directory that is a valid secret key. 
 

 
show-labelsgenerator
 falseWhen printing, show all labels as the last column (default hide labels column) secret-for-docker-registry/v1The name of the API generator to use. 
 

 
sort-byoutputo
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
save-config
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 

 template
 
 

 

-
create

+
secret generic

 

-
 Create a pod using the data in pod.json.

+
 Create a new secret named my-secret with keys for each file in folder bar

 

-
kubectl create -f ./pod.json
+
kubectl create secret generic my-secret --from-file=path/to/bar
 

 

-
 Create a pod based on the JSON passed into stdin.

+
 Create a new secret named my-secret with specified keys instead of names on disk

 

-
cat pod.json | kubectl create -f -
+
kubectl create secret generic my-secret --from-file=ssh-privatekey=~/.ssh/id_rsa --from-file=ssh-publickey=~/.ssh/id_rsa.pub
+

+

+
 Create a new secret named my-secret with key1=supersecret and key2=topsecret

+

+
kubectl create secret generic my-secret --from-literal=key1=supersecret --from-literal=key2=topsecret
 

 

-
 Edit the data in docker-registry.yaml in JSON using the v1 API format then create the resource using the edited data.

+
 Create a new secret named my-secret using a combination of a file and a literal

 

-
kubectl create -f docker-registry.yaml --edit --output-version=v1 -o json
+
kubectl create secret generic my-secret --from-file=ssh-privatekey=~/.ssh/id_rsa --from-literal=passphrase=topsecret
 

-
Create a resource from a file or from stdin. 

-
JSON and YAML formats are accepted.

+

+
 Create a new secret named my-secret from an env file

+

+
kubectl create secret generic my-secret --from-env-file=path/to/bar.env
+

+
Create a secret based on a file, directory, or specified literal value. 

+
A single secret may package one or more key/value pairs. 

+
When creating a secret based on a file, the key will default to the basename of the file, and the value will default to the file content. If the basename is an invalid key or you wish to chose your own, you may specify an alternate key. 

+
When creating a secret based on a directory, each file whose basename is a valid key in the directory will be packaged into the secret. Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).

 
Usage

-
$ create -f FILENAME

+
$ generic NAME [--type=string] [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run]

 
Flags

 
@@ -1346,34 +1249,40 @@ 
Flags

+
+
+
+
+
+
-
+
-
-
+
+
-
-
+
+
-
+
-
+
-
-
+
+
-
+
-
-
+
+
@@ -1382,64 +1291,22 @@ 
Flags

-
-
+
-
+
+
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
@@ -1447,44 +1314,19 @@ 
Flags

-
-
-
-
-
-

 
 
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
append-hashfalseAppend a hash of the secret to its name. 

 dry-run
 
 false
 If true, only print the object that would be sent, without sending it. 
 

 
editfrom-env-file
 falseEdit the API resource before creating Specify the path to a file to read lines of key=val pairs to create a secret (i.e. a Docker .env file). 
 

 
filenameffrom-file
 []Filename, directory, or URL to files to use to create the resource Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used.  Specifying a directory will iterate each named file in the directory that is a valid secret key. 
 

 
include-extended-apisfrom-literal
 trueIf true, include definitions of new APIs via calls to the API server. [default true] []Specify a key and literal value to insert in secret (i.e. mykey=somevalue) 
 

 
no-headersgenerator
 falseWhen using the default or custom-column output format, don't print headers (default print headers). secret/v1The name of the API generator to use. 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionsave-config
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
rawtemplate
 
 Raw URI to POST to the server.  Uses the transport specified by the kubeconfig file. Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
save-configfalseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
selectorlSelector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 
templatetype
 
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. The type of secret to create 
 

 

 validate
 true
 If true, use a schema to validate the input before sending it 
 
windows-line-endingsfalseOnly relevant if --edit=true. Defaults to the line ending native to your platform. 

 
 

 

-
clusterrole

-

-
 Create a ClusterRole named "pod-reader" that allows user to perform "get", "watch" and "list" on pods

-

-
kubectl create clusterrole pod-reader --verb=get,list,watch --resource=pods
-

-

-
 Create a ClusterRole named "pod-reader" with ResourceName specified

-

-
kubectl create clusterrole pod-reader --verb=get,list,watch --resource=pods --resource-name=readablepod --resource-name=anotherpod
-

-

-
 Create a ClusterRole named "foo" with API Group specified

-

-
kubectl create clusterrole foo --verb=get,list,watch --resource=rs.extensions
-

-

-
 Create a ClusterRole named "foo" with SubResource specified

-

-
kubectl create clusterrole foo --verb=get,list,watch --resource=pods,pods/status
-

+
secret tls

 

-
 Create a ClusterRole name "foo" with NonResourceURL specified

+
 Create a new TLS secret named tls-secret with the given key pair:

 

-
kubectl create clusterrole "foo" --verb=get --non-resource-url=/logs/*
+
kubectl create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.key
 

-
Create a ClusterRole.

+
Create a TLS secret from the given public/private key pair. 

+
The public/private key pair must exist before hand. The public key certificate must be .PEM encoded and match the given private key.

 
Usage

-
$ clusterrole NAME --verb=verb --resource=resource.group [--resource-name=resourcename] [--dry-run]

+
$ tls NAME --cert=path/to/cert/file --key=path/to/key/file [--dry-run]

 
Flags

 
@@ -1503,46 +1345,40 @@ 
Flags

-
+
-
+
-
+
-
-
-
-
-
-
-
+
-
-
+
-
+
+
-
-
+
-
+
+
-
+
-
-
+
+
-
+
+
-
-
+
@@ -1551,24 +1387,6 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -1580,24 +1398,28 @@ 
Flags

-
-
-
-
-
-

 
 
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
dry-runappend-hash
 
 falseIf true, only print the object that would be sent, without sending it. Append a hash of the secret to its name. 
 

 
no-headerscert
 falseWhen using the default or custom-column output format, don't print headers (default print headers). 
non-resource-url
 []A partial url that user should have access to. Path to PEM encoded public key certificate. 
 

 
outputodry-run
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. falseIf true, only print the object that would be sent, without sending it. 
 

 
output-versiongenerator
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). secret-for-tls/v1The name of the API generator to use. 
 

 
resourcekey
 []Resource that the rule applies to Path to private key associated with given certificate. 
 

 
resource-nameoutputo
 []Resource in the white list that the rule applies to, repeat this flag for multiple items Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 

 save-config
 If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 

 template
 
 
 true
 If true, use a schema to validate the input before sending it 
 
verb[]Verb that applies to the resources contained in the rule 

 
 

 

-
clusterrolebinding

+
service

+
Create a service using specified subcommand.

+
Usage

+
$ service

+

+
service clusterip

 

-
 Create a ClusterRoleBinding for user1, user2, and group1 using the cluster-admin ClusterRole

+
 Create a new ClusterIP service named my-cs

 

-
kubectl create clusterrolebinding cluster-admin --clusterrole=cluster-admin --user=user1 --user=user2 --group=group1
+
kubectl create service clusterip my-cs --tcp=5678:8080
 

-
Create a ClusterRoleBinding for a particular ClusterRole.

+

+
 Create a new ClusterIP service named my-cs (in headless mode)

+

+
kubectl create service clusterip my-cs --clusterip="None"
+

+
Create a ClusterIP service with the specified name.

 
Usage

-
$ clusterrolebinding NAME --clusterrole=NAME [--user=username] [--group=groupname] [--serviceaccount=namespace:serviceaccountname] [--dry-run]

+
$ clusterip NAME [--tcp=<port>:<targetPort>] [--dry-run]

 
Flags

 
@@ -1616,10 +1438,10 @@ 
Flags

-
+
-
+
@@ -1630,62 +1452,26 @@ 
Flags

-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -1702,38 +1488,16 @@ 
Flags

 
 
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
clusterroleclusterip
 
 ClusterRole this ClusterRoleBinding should reference Assign your own ClusterIP or set to 'None' for a 'headless' service (no loadbalancing). 
 

 

 dry-run
 

 generator
 clusterrolebinding.rbac.authorization.k8s.io/v1alpha1service-clusterip/v1
 The name of the API generator to use. 
 

 
group[]Groups to bind to the role 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). 

 output
 o
 
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 

 save-config
 
 false
 If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
serviceaccounttcp
 
 []Service accounts to bind to the role, in the format : 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Port pairs can be specified as ':'. 
 

 

 template
 
 

 

-
configmap

-

-
 Create a new configmap named my-config based on folder bar

-

-
kubectl create configmap my-config --from-file=path/to/bar
-

-

-
 Create a new configmap named my-config with specified keys instead of file basenames on disk

-

-
kubectl create configmap my-config --from-file=key1=/path/to/bar/file1.txt --from-file=key2=/path/to/bar/file2.txt
-

-

-
 Create a new configmap named my-config with key1=config1 and key2=config2

-

-
kubectl create configmap my-config --from-literal=key1=config1 --from-literal=key2=config2
-

-

-
 Create a new configmap named my-config from the key=value pairs in the file

-

-
kubectl create configmap my-config --from-file=path/to/bar
-

+
service externalname

 

-
 Create a new configmap named my-config from an env file

+
 Create a new ExternalName service named my-ns

 

-
kubectl create configmap my-config --from-env-file=path/to/bar.env
+
kubectl create service externalname my-ns --external-name bar.com
 

-
Create a configmap based on a file, directory, or specified literal value. 

-
A single configmap may package one or more key/value pairs. 

-
When creating a configmap based on a file, the key will default to the basename of the file, and the value will default to the file content.  If the basename is an invalid key, you may specify an alternate key. 

-
When creating a configmap based on a directory, each file whose basename is a valid key in the directory will be packaged into the configmap.  Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).

+
Create an ExternalName service with the specified name. 

+
ExternalName service references to an external DNS address instead of only pods, which will allow application authors to reference services that exist off platform, on other clusters, or locally.

 
Usage

-
$ configmap NAME [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run]

+
$ externalname NAME --external-name external.name [--dry-run]

 
Flags

 
@@ -1752,82 +1516,40 @@ 
Flags

-
-
-
-
-
-
-
+
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
+
@@ -1844,15 +1566,15 @@ 
Flags

 
 
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
append-hashfalseAppend a hash of the configmap to its name. 

 dry-run
 
 false
 If true, only print the object that would be sent, without sending it. 
 

 
from-env-fileexternal-name
 
 Specify the path to a file to read lines of key=val pairs to create a configmap (i.e. a Docker .env file). External name of service 
 

 
from-filegenerator
 []Key file can be specified using its file path, in which case file basename will be used as configmap key, or optionally with a key and file path, in which case the given key will be used.  Specifying a directory will iterate each named file in the directory whose basename is a valid configmap key. 
from-literal[]Specify a key and literal value to insert in configmap (i.e. mykey=somevalue) 
generatorconfigmap/v1service-externalname/v1
 The name of the API generator to use. 
 

 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). 

 output
 o
 
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 

 save-config
 
 false
 If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-bytcp
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. []Port pairs can be specified as ':'. 
 

 

 template
 
 

 

-
deployment

+
service loadbalancer

 

-
 Create a new deployment named my-dep that runs the busybox image.

+
 Create a new LoadBalancer service named my-lbs

 

-
kubectl create deployment my-dep --image=busybox
+
kubectl create service loadbalancer my-lbs --tcp=5678:8080
 

-
Create a deployment with the specified name.

+
Create a LoadBalancer service with the specified name.

 
Usage

-
$ deployment NAME --image=image [--dry-run]

+
$ loadbalancer NAME [--tcp=port:targetPort] [--dry-run]

 
Flags

 
@@ -1879,56 +1601,26 @@ 
Flags

-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
+
@@ -1945,15 +1637,15 @@ 
Flags

 
 

 generator
 deployment-basic/v1beta1service-loadbalancer/v1
 The name of the API generator to use. 
 

 
image[]Image name to run. 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). 

 output
 o
 
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 

 save-config
 
 false
 If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-bytcp
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. []Port pairs can be specified as ':'. 
 

 

 template
 
 

 

-
job

+
service nodeport

 

-
 Create a job from a CronJob named "a-cronjob"

+
 Create a new NodePort service named my-ns

 

-
kubectl create job --from=cronjob/a-cronjob
+
kubectl create service nodeport my-ns --tcp=5678:8080
 

-
Create a job with the specified name.

+
Create a NodePort service with the specified name.

 
Usage

-
$ job NAME [--from-cronjob=CRONJOB]

+
$ nodeport NAME [--tcp=port:targetPort] [--dry-run]

 
Flags

 
@@ -1972,16 +1664,22 @@ 
Flags

-
+
+
+
+
+
+
-
+
+
-
+
-
-
+
+
@@ -1990,34 +1688,16 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
+
@@ -2034,15 +1714,15 @@ 
Flags

 
 
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
fromdry-run
 falseIf true, only print the object that would be sent, without sending it. 
generator
 The name of the resource to create a Job from (only cronjob is supported). service-nodeport/v1The name of the API generator to use. 
 

 
no-headersnode-port
 falseWhen using the default or custom-column output format, don't print headers (default print headers). 0Port used to expose the service on each node in a cluster. 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 

 save-config
 
 false
 If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-bytcp
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. []Port pairs can be specified as ':'. 
 

 

 template
 
 

 

-
namespace

+
serviceaccount

 

-
 Create a new namespace named my-namespace

+
 Create a new service account named my-service-account

 

-
kubectl create namespace my-namespace
+
kubectl create serviceaccount my-service-account
 

-
Create a namespace with the specified name.

+
Create a service account with the specified name.

 
Usage

-
$ namespace NAME [--dry-run]

+
$ serviceaccount NAME [--dry-run]

 
Flags

 
@@ -2069,52 +1749,22 @@ 
Flags

-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -2129,20 +1779,59 @@ 
Flags

 
 

 generator
 namespace/v1serviceaccount/v1
 The name of the API generator to use. 
 

 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). 

 output
 o
 
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 

 save-config
 
 false
 If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 

 template
 
 
 
 

 

-
poddisruptionbudget

+
get

 

-
 Create a pod disruption budget named my-pdb that will select all pods with the app=rails label # and require at least one of them being available at any point in time.

+
 List all pods in ps output format.

 

-
kubectl create poddisruptionbudget my-pdb --selector=app=rails --min-available=1
+
kubectl get pods
 

 

-
 Create a pod disruption budget named my-pdb that will select all pods with the app=nginx label # and require at least half of the pods selected to be available at any point in time.

+
 List all pods in ps output format with more information (such as node name).

 

-
kubectl create pdb my-pdb --selector=app=nginx --min-available=50%
+
kubectl get pods -o wide
 

-
Create a pod disruption budget with the specified name, selector, and desired minimum available pods

+

+
 List a single replication controller with specified NAME in ps output format.

+

+
kubectl get replicationcontroller web
+

+

+
 List deployments in JSON output format, in the "v1" version of the "apps" API group:

+

+
kubectl get deployments.v1.apps -o json
+

+

+
 List a single pod in JSON output format.

+

+
kubectl get -o json pod web-pod-13je7
+

+

+
 List a pod identified by type and name specified in "pod.yaml" in JSON output format.

+

+
kubectl get -f pod.yaml -o json
+

+

+
 Return only the phase value of the specified pod.

+

+
kubectl get -o template pod/web-pod-13je7 --template={{.status.phase}}
+

+

+
 List all replication controllers and services together in ps output format.

+

+
kubectl get rc,services
+

+

+
 List one or more resources by their type and names.

+

+
kubectl get rc/web service/frontend pods/web-pod-13je7
+

+
Display one or many resources 

+
Prints a table of the most important information about the specified resources. You can filter the list using a label selector and the --selector flag. If the desired resource type is namespaced you will only see results in your current namespace unless you pass --all-namespaces. 

+
Uninitialized objects are not shown unless --include-uninitialized is passed. 

+
By specifying the output as 'template' and providing a Go template as the value of the --template flag, you can filter the attributes of the fetched resources.

+
Use "kubectl api-resources" for a complete list of supported resources.

 
Usage

-
$ poddisruptionbudget NAME --selector=SELECTOR --min-available=N [--dry-run]

+
$ get [(-o|--output=)json|yaml|wide|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=...] (TYPE[.VERSION][.GROUP] [NAME | -l label] | TYPE[.VERSION][.GROUP]/NAME ...) [flags]

 
Flags

 
@@ -2155,37 +1844,61 @@ 
Flags

+
+
+
+
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
+
-
-
-
-
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -2197,22 +1910,28 @@ 
Flags

-
+
-
+
-
-
+
+
-
+
+
+
+
+
+
-
+
+
@@ -2221,6 +1940,12 @@ 
Flags

+
+
+
+
+
+
@@ -2239,28 +1964,91 @@ 
Flags

-
+
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+

 
 
 
 
all-namespacesfalseIf present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. 

 allow-missing-template-keys
 
 true
 If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
dry-runchunk-size
 falseIf true, only print the object that would be sent, without sending it. 500Return large lists in chunks rather than all at once. Pass 0 to disable. This flag is beta and may change in the future. 
 

 
generatorexport
 poddisruptionbudget/v1beta1/v2The name of the API generator to use. falseIf true, use 'export' for the resources.  Exported resources are stripped of cluster-specific information. 
 

 
max-unavailablefield-selector
 
 The maximum number or percentage of unavailable pods this budget requires. Selector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type. 
 

 
min-availableThe minimum number or percentage of available pods this budget requires. filenamef[]Filename, directory, or URL to files identifying the resource to get from a server. 
 

 
no-headersignore-not-foundfalseIf the requested object does not exist the command will return exit code 0. 
include-uninitializedfalseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
label-columnsL[]Accepts a comma separated list of labels that are going to be presented as columns. Names are case-sensitive. You can also use multiple flag options like -L label1 -L label2... 
no-headers
 
 false
 When using the default or custom-column output format, don't print headers (default print headers). 
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionraw
 
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). Raw URI to request from the server.  Uses the transport specified by the kubeconfig file. 
 

 
save-configrecursiveR
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 

 selectorl
 Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
server-print
 A label selector to use for this budget. Only equality-based selector requirements are supported. trueIf true, have the server return the appropriate table output. Supports extension APIs and CRDs. 
 

 

 show-all
 When printing, show all resources (default show all pods including terminated one.) 
 

 
show-kindfalseIf present, list the resource type for the requested object(s). 

 show-labels
 
 false
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
validateuse-openapi-print-columns
 trueIf true, use a schema to validate the input before sending it falseIf true, use x-kubernetes-print-column metadata (if present) from the OpenAPI schema for displaying a resource. 
watchwfalseAfter listing/getting the requested object, watch for changes. Uninitialized objects are excluded if no object name is provided. 
watch-onlyfalseWatch for changes to the requested object(s), without listing/getting first. 
 

 
 

 

-
priorityclass

+
run

 

-
 Create a priorityclass named high-priority

+
 Start a single instance of nginx.

 

-
kubectl create priorityclass default-priority --value=1000 --description="high priority"
+
kubectl run nginx --image=nginx
 

 

-
 Create a priorityclass named default-priority that considered as the global default priority

+
 Start a single instance of hazelcast and let the container expose port 5701 .

 

-
kubectl create priorityclass default-priority --value=1000 --global-default=true --description="default priority"
+
kubectl run hazelcast --image=hazelcast --port=5701
 

-
Create a priorityclass with the specified name, value, globalDefault and description

+

+
 Start a single instance of hazelcast and set environment variables "DNS_DOMAIN=cluster" and "POD_NAMESPACE=default" in the container.

+

+
kubectl run hazelcast --image=hazelcast --env="DNS_DOMAIN=cluster" --env="POD_NAMESPACE=default"
+

+

+
 Start a single instance of hazelcast and set labels "app=hazelcast" and "env=prod" in the container.

+

+
kubectl run hazelcast --image=nginx --labels="app=hazelcast,env=prod"
+

+

+
 Start a replicated instance of nginx.

+

+
kubectl run nginx --image=nginx --replicas=5
+

+

+
 Dry run. Print the corresponding API objects without creating them.

+

+
kubectl run nginx --image=nginx --dry-run
+

+

+
 Start a single instance of nginx, but overload the spec of the deployment with a partial set of values parsed from JSON.

+

+
kubectl run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }'
+

+

+
 Start a pod of busybox and keep it in the foreground, don't restart it if it exits.

+

+
kubectl run -i -t busybox --image=busybox --restart=Never
+

+

+
 Start the nginx container using the default command, but use custom arguments (arg1 .. argN) for that command.

+

+
kubectl run nginx --image=nginx -- <arg1> <arg2> ... <argN>
+

+

+
 Start the nginx container using a different command and custom arguments.

+

+
kubectl run nginx --image=nginx --command -- <cmd> <arg1> ... <argN>
+

+

+
 Start the perl container to compute π to 2000 places and print it out.

+

+
kubectl run pi --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
+

+

+
 Start the cron job to compute π to 2000 places and print it out every 5 minutes.

+

+
kubectl run pi --schedule="0/5 * * * ?" --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
+

+
Create and run a particular image, possibly replicated. 

+
Creates a deployment or job to manage the created container(s).

 
Usage

-
$ priorityclass NAME --value=VALUE --global-default=BOOL [--dry-run]

+
$ run NAME --image=image [--env="key=value"] [--port=port] [--replicas=replicas] [--dry-run=bool] [--overrides=inline-json] [--command] -- [COMMAND] [args...]

 
Flags

 
@@ -2273,16 +2061,22 @@ 
Flags

-
+
-
-
+
+
-
+
+
+
+
+
+
-
+
+
@@ -2291,146 +2085,142 @@ 
Flags

-
+
-
-
+
+
-
+
-
+
-
-
-
-
+
+
+
+
-
-
+
-
+
+
-
+
-
+
-
+
-
-
-
-
-
-
-
-
+
+
-
+
-
-
+
+
-
+
-
+
-
+
-
+
-
+
+
-
-
+
-
+
-
-
+
+
-
-

 
 
 
 
allow-missing-template-keysattach
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. falseIf true, wait for the Pod to start running, and then attach to the Pod as if 'kubectl attach ...' were called.  Default false, unless '-i/--stdin' is set, in which case the default is true. With '--restart=Never' the exit code of the container process is returned. 
 

 
descriptioncascade
 trueIf true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController).  Default true. 
command
 description is an arbitrary string that usually provides guidelines on when this priority class should be used. falseIf true and extra arguments are present, use them as the 'command' field in the container, rather than the 'args' field which is the default. 
 

 

 dry-run
 If true, only print the object that would be sent, without sending it. 
 

 
generatorenv
 priorityclass/v1alpha1The name of the API generator to use. []Environment variables to set in the container 
 

 
global-defaultexpose
 
 falseglobal-default specifies whether this PriorityClass should be considered as the default priority. If true, a public, external service is created for the container(s) which are run 
 

 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). filenamef[]to use to replace the resource. 
 

 
outputoforce
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. falseOnly used when grace-period=0. If true, immediately remove resources from API and bypass graceful deletion. Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation. 
 

 
output-versiongenerator
 
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). The name of the API generator to use, see http://kubernetes.io/docs/user-guide/kubectl-conventions/#generators for a list. 
 

 
save-configgrace-period
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) -1Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. Set to 1 for immediate shutdown. Can only be set to 0 when --force is true (force deletion). 
 

 
show-labelshostport
 falseWhen printing, show all labels as the last column (default hide labels column) -1The host port mapping for the container port. To demonstrate a single-machine container. 
 

 
sort-byimage
 
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. The image for the container to run. 
 

 
templateimage-pull-policy
 
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. The image pull policy for the container. If left empty, this value will not be specified by the client and defaulted by the server 
 

 
validatelabelsl
 trueIf true, use a schema to validate the input before sending it Comma separated labels to apply to the pod(s). Will override previous values. 
 

 
valueleave-stdin-open
 0the value of this priority class. falseIf the pod is started in interactive mode or with stdin, leave stdin open after the first attach completes. By default, stdin will be closed after the first attach completes. 
 

-

-
quota

-

-
 Create a new resourcequota named my-quota

-

-
kubectl create quota my-quota --hard=cpu=1,memory=1G,pods=2,services=3,replicationcontrollers=2,resourcequotas=1,secrets=5,persistentvolumeclaims=10
-

-

-
 Create a new resourcequota named best-effort

-

-
kubectl create quota best-effort --hard=pods=100 --scopes=BestEffort
-

-
Create a resourcequota with the specified name, hard limits and optional scopes

-
Usage

-
$ quota NAME [--hard=key1=value1,key2=value2] [--scopes=Scope1,Scope2] [--dry-run=bool]

-
Flags

-
-
-
-
-
-
+
+
+
+
-
-
-
+
+
-
-
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
+
-
+
-
+
-
-
+
-
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
@@ -2439,68 +2229,98 @@ 
Flags

-
+
-
+
-
-
-
-
+
+
+
+
-
+
-
-
+
+
-
+
-
+
-
-
+
+
+
+
+
+
+
-
+
+
-
+
+
+
+
+
+
+
-
-
+
+

 
NameShorthandDefaultUsagelimitsThe resource requirement limits for this container.  For example, 'cpu=200m,memory=512Mi'.  Note that server side components may assign limits depending on the server configuration, such as limit ranges. 
 

 
allow-missing-template-keysoutputo
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
dry-runoverrides
 falseIf true, only print the object that would be sent, without sending it. An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. 
 

 
generatorpod-running-timeout
 resourcequotas/v1The name of the API generator to use. 1m0sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running 
 

 
hardport
 
 A comma-delimited set of resource=quantity pairs that define a hard limit. The port that this container exposes.  If --expose is true, this is also the port used by the service that is created. 
 

 
no-headersquiet
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). If true, suppress prompt messages. 
 

 
outputorecord
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
 

 
output-versionrecursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
replicasr1Number of replicas to create for this container. Default is 1. 
requestsThe resource requirement requests for this container.  For example, 'cpu=100m,memory=256Mi'.  Note that server side components may assign requests depending on the server configuration, such as limit ranges. 
restart
 AlwaysThe restart policy for this Pod.  Legal values [Always, OnFailure, Never].  If set to 'Always' a deployment is created, if set to 'OnFailure' a job is created, if set to 'Never', a regular pod is created. For the latter two --replicas must be 1.  Default 'Always', for CronJobs Never. 
rm
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). falseIf true, delete resources created in this command for attached containers. 
 

 

 save-config
 If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
scopesschedule
 
 A comma-delimited set of quota scopes that must all match each object tracked by the quota. A schedule in the Cron format the job should be run with. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) service-generatorservice/v2The name of the generator to use for creating a service.  Only used if --expose is true 
 

 
show-labelsservice-overrides
 falseWhen printing, show all labels as the last column (default hide labels column) An inline JSON override for the generated service object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.  Only used if --expose is true. 
 

 
sort-byserviceaccount
 
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Service account to set in the pod spec 
 

 
templatestdinifalseKeep stdin open on the container(s) in the pod, even if nothing is attached. 
timeout
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 0sThe length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object 
 

 
validatettytfalseAllocated a TTY for each container in the pod. 
wait
 trueIf true, use a schema to validate the input before sending it falseIf true, wait for resources to be gone before returning. This waits for finalizers. 
 

 
 

 

-
role

+
expose

 

-
 Create a Role named "pod-reader" that allows user to perform "get", "watch" and "list" on pods

+
 Create a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000.

 

-
kubectl create role pod-reader --verb=get --verb=list --verb=watch --resource=pods
+
kubectl expose rc nginx --port=80 --target-port=8000
 

 

-
 Create a Role named "pod-reader" with ResourceName specified

+
 Create a service for a replication controller identified by type and name specified in "nginx-controller.yaml", which serves on port 80 and connects to the containers on port 8000.

 

-
kubectl create role pod-reader --verb=get,list,watch --resource=pods --resource-name=readablepod --resource-name=anotherpod
+
kubectl expose -f nginx-controller.yaml --port=80 --target-port=8000
 

 

-
 Create a Role named "foo" with API Group specified

+
 Create a service for a pod valid-pod, which serves on port 444 with the name "frontend"

 

-
kubectl create role foo --verb=get,list,watch --resource=rs.extensions
+
kubectl expose pod valid-pod --port=444 --name=frontend
 

 

-
 Create a Role named "foo" with SubResource specified

+
 Create a second service based on the above service, exposing the container port 8443 as port 443 with the name "nginx-https"

 

-
kubectl create role foo --verb=get,list,watch --resource=pods,pods/status
+
kubectl expose service nginx --port=443 --target-port=8443 --name=nginx-https
 

-
Create a role with single rule.

+

+
 Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video-stream'.

+

+
kubectl expose rc streamer --port=4100 --protocol=udp --name=video-stream
+

+

+
 Create a service for a replicated nginx using replica set, which serves on port 80 and connects to the containers on port 8000.

+

+
kubectl expose rs nginx --port=80 --target-port=8000
+

+

+
 Create a service for an nginx deployment, which serves on port 80 and connects to the containers on port 8000.

+

+
kubectl expose deployment nginx --port=80 --target-port=8000
+

+
Expose a resource as a new Kubernetes service. 

+
Looks up a deployment, service, replica set, replication controller or pod by name and uses the selector for that resource as the selector for a new service on the specified port. A deployment or replica set will be exposed as a service only if its selector is convertible to a selector that service supports, i.e. when the selector contains only the matchLabels component. Note that if no port is specified via --port and the exposed resource has multiple ports, all will be re-used by the new service. Also if no labels are specified, the new service will re-use the labels from the resource it exposes. 

+
Possible resources include (case insensitive): 

+
pod (po), service (svc), replicationcontroller (rc), deployment (deploy), replicaset (rs)

 
Usage

-
$ role NAME --verb=verb --resource=resource.group/subresource [--resource-name=resourcename] [--dry-run]

+
$ expose (-f FILENAME | TYPE NAME) [--port=port] [--protocol=TCP|UDP] [--target-port=number-or-name] [--name=name] [--external-ip=external-ip-of-service] [--type=type]

 
Flags

 
@@ -2513,230 +2333,171 @@ 
Flags

-
+
-
-
-
-
-
-
-
+
-
+
-
-
-
-
-
-
-
+
-
-
+
-
+
+
-
+
-
-
+
+
-
-
+
+
-
+
-
+
-
-
-
-
-
-
-
-
+
+
-
+
+
-
-
+
-
+
-
+
-
+
-
+
-
+
+
-
-
+
-
+
-
-
-
-
-

 
 
 
 
allow-missing-template-keyscluster-ip
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
dry-run
 falseIf true, only print the object that would be sent, without sending it. ClusterIP to be assigned to the service. Leave empty to auto-allocate, or set to 'None' to create a headless service. 
 

 
no-headerscontainer-port
 falseWhen using the default or custom-column output format, don't print headers (default print headers). 
outputo
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. Synonym for --target-port 
 

 
output-versiondry-run
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). falseIf true, only print the object that would be sent, without sending it. 
 

 
resourceexternal-ip
 []Resource that the rule applies to Additional external IP address (not managed by Kubernetes) to accept for the service. If this IP is routed to a node, the service can be accessed by this IP in addition to its generated service IP. 
 

 
resource-namefilenamef
 []Resource in the white list that the rule applies to, repeat this flag for multiple items Filename, directory, or URL to files identifying the resource to expose a service 
 

 
save-configgenerator
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) service/v2The name of the API generator to use. There are 2 generators: 'service/v1' and 'service/v2'. The only difference between them is that service port in v1 is named 'default', while it is left unnamed in v2. Default is 'service/v2'. 
 

 
show-labelslabelsl
 falseWhen printing, show all labels as the last column (default hide labels column) Labels to apply to the service created by this call. 
 

 
sort-byload-balancer-ip
 
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. IP to assign to the LoadBalancer. If empty, an ephemeral IP will be created and used (cloud-provider specific). 
 

 
templatename
 
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. The name for the newly created object. 
 

 
validateoutputo
 trueIf true, use a schema to validate the input before sending it Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
verboverrides
 []Verb that applies to the resources contained in the rule 

-

-
rolebinding

-

-
 Create a RoleBinding for user1, user2, and group1 using the admin ClusterRole

-

-
kubectl create rolebinding admin --clusterrole=admin --user=user1 --user=user2 --group=group1
-

-
Create a RoleBinding for a particular Role or ClusterRole.

-
Usage

-
$ rolebinding NAME --clusterrole=NAME|--role=NAME [--user=username] [--group=groupname] [--serviceaccount=namespace:serviceaccountname] [--dry-run]

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
+
-
+
-
-
-
-
-
-
-
+
-
+
-
-
+
+
-
-
+
+
-
+
-
-
+
-
+
+
-
+
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
+
-
-
+
-
-
-
-
-
-
+
NameShorthandDefaultUsage
allow-missing-template-keys
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. 
 

 
clusterroleport
 
 ClusterRole this RoleBinding should reference The port that the service should serve on. Copied from the resource being exposed, if unspecified 
 

 
dry-runprotocol
 falseIf true, only print the object that would be sent, without sending it. 
generator
 rolebinding.rbac.authorization.k8s.io/v1alpha1The name of the API generator to use. The network protocol for the service to be created. Default is 'TCP'. 
 

 
grouprecord
 []Groups to bind to the role falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
 

 
no-headersrecursiveR
 falseWhen using the default or custom-column output format, don't print headers (default print headers). Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
outputosave-config
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
output-versionselector
 
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). A label selector to use for this service. Only equality-based selector requirements are supported. If empty (the default) infer the selector from the replication controller or replica set.) 
 

 
rolesession-affinity
 
 Role this RoleBinding should reference 
save-configfalseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
serviceaccount[]Service accounts to bind to the role, in the format : 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) If non-empty, set the session affinity for the service to this; legal values: 'None', 'ClientIP' 
 

 
sort-bytarget-port
 
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Name or number for the port on the container that the service should direct traffic to. Optional. 
 

 
templatetype
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
validate
 trueIf true, use a schema to validate the input before sending it Type for this service: ClusterIP, NodePort, LoadBalancer, or ExternalName. Default is 'ClusterIP'. 
 

 
 

 

-
secret

-
Create a secret using specified subcommand.

-
Usage

-
$ secret

-

-
secret docker-registry

+
delete

 

-
 If you don't already have a .dockercfg file, you can create a dockercfg secret directly by using:

+
 Delete a pod using the type and name specified in pod.json.

 

-
kubectl create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL
+
kubectl delete -f ./pod.json
+

+

+
 Delete a pod based on the type and name in the JSON passed into stdin.

+

+
cat pod.json | kubectl delete -f -
+

+

+
 Delete pods and services with same names "baz" and "foo"

+

+
kubectl delete pod,service baz foo
+

+

+
 Delete pods and services with label name=myLabel.

+

+
kubectl delete pods,services -l name=myLabel
+

+

+
 Delete a pod with minimal delay

+

+
kubectl delete pod foo --now
+

+

+
 Force delete a pod on a dead node

+

+
kubectl delete pod foo --grace-period=0 --force
+

+

+
 Delete all pods

+

+
kubectl delete pods --all
 

-
Create a new secret for use with Docker registries. 

-
Dockercfg secrets are used to authenticate against Docker registries. 

-
When using the Docker command line to push images, you can authenticate to a given registry by running: '$ docker login DOCKER REGISTRY SERVER --username=DOCKER USER --password=DOCKER PASSWORD --email=DOCKER _EMAIL'. 

-
  That produces a ~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to

-
authenticate to the registry. The email address is optional. 

-
When creating applications, you may have a Docker registry that requires authentication.  In order for the nodes to pull images on your behalf, they have to have the credentials.  You can provide this information by creating a dockercfg secret and attaching it to your service account.

+
Delete resources by filenames, stdin, resources and names, or by resources and label selector. 

+
JSON and YAML formats are accepted. Only one type of the arguments may be specified: filenames, resources and names, or resources and label selector. 

+
Some resources, such as pods, support graceful deletion. These resources define a default period before they are forcibly terminated (the grace period) but you may override that value with the --grace-period flag, or pass --now to set a grace-period of 1. Because these resources often represent entities in the cluster, deletion may not be acknowledged immediately. If the node hosting a pod is down or cannot reach the API server, termination may take significantly longer than the grace period. To force delete a resource, you must pass a grace period of 0 and specify the --force flag. 

+
IMPORTANT: Force deleting pods does not wait for confirmation that the pod's processes have been terminated, which can leave those processes running until the node detects the deletion and completes graceful deletion. If your processes use shared storage or talk to a remote API and depend on the name of the pod to identify themselves, force deleting those pods may result in multiple processes running on different machines using the same identification which may lead to data corruption or inconsistency. Only force delete pods when you are sure the pod is terminated, or if your application can tolerate multiple copies of the same pod running at once. Also, if you force delete pods the scheduler may place new pods on those nodes before the node has released those resources and causing those pods to be evicted immediately. 

+
Note that the delete command does NOT do resource version checks, so if someone submits an update to a resource right when you submit a delete, their update will be lost along with the rest of the resource.

 
Usage

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

+
$ delete ([-f FILENAME] | TYPE [(NAME | -l label | --all)])

 
Flags

 
@@ -2749,148 +2510,121 @@ 
Flags

-
-
-
-
-
-
-
+
-
+
-
-
+
-
+
+
-
+
-
+
-
-
-
-
+
+
+
+
-
-
+
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
-
+
+
-
+
-
+

 
 
 
 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
append-hashall
 
 falseAppend a hash of the secret to its name. Delete all resources, including uninitialized ones, in the namespace of the specified resource types. 
 

 
docker-emailcascade
 Email for Docker registry trueIf true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController).  Default true. 
 

 
docker-passwordfield-selector
 
 Password for Docker registry authentication Selector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type. 
 

 
docker-serverhttps://index.docker.io/v1/Server location for Docker registry filenamef[]containing the resource to delete. 
 

 
docker-usernameforce
 Username for Docker registry authentication falseOnly used when grace-period=0. If true, immediately remove resources from API and bypass graceful deletion. Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation. 
 

 
dry-rungrace-period
 falseIf true, only print the object that would be sent, without sending it. -1Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. Set to 1 for immediate shutdown. Can only be set to 0 when --force is true (force deletion). 
 

 
generatorignore-not-found
 secret-for-docker-registry/v1The name of the API generator to use. falseTreat "resource not found" as a successful delete. Defaults to "true" when --all is specified. 
 

 
include-extended-apisinclude-uninitialized
 trueIf true, include definitions of new APIs via calls to the API server. [default true] falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
 

 
no-headersnow
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). If true, resources are signaled for immediate shutdown (same as --grace-period=1). 
 

 

 output
 o
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
save-configfalseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) Output mode. Use "-o name" for shorter output (resource/name). 
 

 
show-labelsrecursiveR
 falseWhen printing, show all labels as the last column (default hide labels column) Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
sort-byselectorl
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Selector (label query) to filter on, not including uninitialized ones. 
 

 
templatetimeout
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 0sThe length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object 
 

 
validatewait
 
 trueIf true, use a schema to validate the input before sending it If true, wait for resources to be gone before returning. This waits for finalizers. 
 

 
 

+
APP MANAGEMENT

+
This section contains commands for creating, updating, deleting, and
+viewing your workloads in a Kubernetes cluster.

 

-
secret generic

-

-
 Create a new secret named my-secret with keys for each file in folder bar

-

-
kubectl create secret generic my-secret --from-file=path/to/bar
-

+
apply

 

-
 Create a new secret named my-secret with specified keys instead of names on disk

+
 Apply the configuration in pod.json to a pod.

 

-
kubectl create secret generic my-secret --from-file=ssh-privatekey=~/.ssh/id_rsa --from-file=ssh-publickey=~/.ssh/id_rsa.pub
+
kubectl apply -f ./pod.json
 

 

-
 Create a new secret named my-secret with key1=supersecret and key2=topsecret

+
 Apply the JSON passed into stdin to a pod.

 

-
kubectl create secret generic my-secret --from-literal=key1=supersecret --from-literal=key2=topsecret
+
cat pod.json | kubectl apply -f -
 

 

-
 Create a new secret named my-secret using a combination of a file and a literal

+
 Note: --prune is still in Alpha # Apply the configuration in manifest.yaml that matches label app=nginx and delete all the other resources that are not in the file and match label app=nginx.

 

-
kubectl create secret generic my-secret --from-file=ssh-privatekey=~/.ssh/id_rsa --from-literal=passphrase=topsecret
+
kubectl apply --prune -f manifest.yaml -l app=nginx
 

 

-
 Create a new secret named my-secret from an env file

+
 Apply the configuration in manifest.yaml and delete all the other configmaps that are not in the file.

 

-
kubectl create secret generic my-secret --from-env-file=path/to/bar.env
+
kubectl apply --prune -f manifest.yaml --all --prune-whitelist=core/v1/ConfigMap
 

-
Create a secret based on a file, directory, or specified literal value. 

-
A single secret may package one or more key/value pairs. 

-
When creating a secret based on a file, the key will default to the basename of the file, and the value will default to the file content. If the basename is an invalid key or you wish to chose your own, you may specify an alternate key. 

-
When creating a secret based on a directory, each file whose basename is a valid key in the directory will be packaged into the secret. Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).

+
Apply a configuration to a resource by filename or stdin. The resource name must be specified. This resource will be created if it doesn't exist yet. To use 'apply', always create the resource initially with either 'apply' or 'create --save-config'. 

+
JSON and YAML formats are accepted. 

+
Alpha Disclaimer: the --prune functionality is not yet complete. Do not use unless you are aware of what the current state is. See https://issues.k8s.io/34274.

 
Usage

-
$ generic NAME [--type=string] [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run]

+
$ apply -f FILENAME

 
Flags

 
@@ -2903,16 +2637,16 @@ 
Flags

-
+
-
-
+
+
-
+
-
-
+
+
@@ -2921,34 +2655,34 @@ 
Flags

-
-
-
-
+
+
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
@@ -2957,46 +2691,46 @@ 
Flags

-
-
+
-
+
+
-
+
-
+
-
-
-
-
+
+
+
+
-
+
-
+
-
-
-
-
+
+
+
+
-
-
+
+
-
+
-
-
+
-
+
+
@@ -3004,19 +2738,33 @@ 
Flags

+
+
+
+
+
+

 
 
 
 
allow-missing-template-keysall
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. falseSelect all resources in the namespace of the specified resource types. 
 

 
append-hashcascade
 falseAppend a hash of the secret to its name. trueIf true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController).  Default true. 
 

 

 dry-run
 If true, only print the object that would be sent, without sending it. 
 

 
from-env-fileSpecify the path to a file to read lines of key=val pairs to create a secret (i.e. a Docker .env file). filenamef[]that contains the configuration to apply 
 

 
from-fileforce
 []Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used.  Specifying a directory will iterate each named file in the directory that is a valid secret key. falseOnly used when grace-period=0. If true, immediately remove resources from API and bypass graceful deletion. Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation. 
 

 
from-literalgrace-period
 []Specify a key and literal value to insert in secret (i.e. mykey=somevalue) -1Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. Set to 1 for immediate shutdown. Can only be set to 0 when --force is true (force deletion). 
 

 
generatorinclude-uninitialized
 secret/v1The name of the API generator to use. falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
 

 
no-headersopenapi-patch
 falseWhen using the default or custom-column output format, don't print headers (default print headers). trueIf true, use openapi to calculate diff when the openapi presents and the resource can be found in the openapi spec. Otherwise, fall back to use baked-in types. 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionoverwrite
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). trueAutomatically resolve conflicts between the modified and live configuration by using values from the modified configuration 
 

 
save-configprune
 
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. Automatically delete resource objects, including the uninitialized ones, that do not appear in the configs and are created by either apply or create --save-config. Should be used with either -l or --all. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) prune-whitelist[]Overwrite the default whitelist with  for --prune 
 

 
show-labelsrecord
 
 falseWhen printing, show all labels as the last column (default hide labels column) Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
 

 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
templateselectorl
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
 

 
typetimeout
 The type of secret to create 0sThe length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object 
 

 

 validate
 true
 If true, use a schema to validate the input before sending it 
 
waitfalseIf true, wait for resources to be gone before returning. This waits for finalizers. 

 
 

 

-
secret tls

+
edit-last-applied

 

-
 Create a new TLS secret named tls-secret with the given key pair:

+
 Edit the last-applied-configuration annotations by type/name in YAML.

 

-
kubectl create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.key
+
kubectl apply edit-last-applied deployment/nginx
 

-
Create a TLS secret from the given public/private key pair. 

-
The public/private key pair must exist before hand. The public key certificate must be .PEM encoded and match the given private key.

+

+
 Edit the last-applied-configuration annotations by file in JSON.

+

+
kubectl apply edit-last-applied -f deploy.yaml -o json
+

+
Edit the latest last-applied-configuration annotations of resources from the default editor. 

+
The edit-last-applied command allows you to directly edit any API resource you can retrieve via the command line tools. It will open the editor defined by your KUBE _EDITOR, or EDITOR environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multiple objects, although changes are applied one at a time. The command accepts filenames as well as command line arguments, although the files you point to must be previously saved versions of resources. 

+
The default format is YAML. To edit in JSON, specify "-o json". 

+
The flag --windows-line-endings can be used to force Windows line endings, otherwise the default for your operating system will be used. 

+
In the event an error occurs while updating, a temporary file will be created on disk that contains your unapplied changes. The most common error when updating a resource is another editor changing the resource on the server. When this occurs, you will have to apply your changes to the newer version of the resource, or update your temporary saved copy to include the latest resource version.

 
Usage

-
$ tls NAME --cert=path/to/cert/file --key=path/to/key/file [--dry-run]

+
$ edit-last-applied (RESOURCE/NAME | -f FILENAME)

 
Flags

 
@@ -3029,117 +2777,63 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
-
+
-
+
-
-
-
-
-
-
-
-
+
+
-
+
-
-
-
-
-
-
-
+
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
-
+
+

 
 
 
 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
append-hashfalseAppend a hash of the secret to its name. 
certPath to PEM encoded public key certificate. 
dry-runfalseIf true, only print the object that would be sent, without sending it. 
generatorsecret-for-tls/v1The name of the API generator to use. 
keyPath to private key associated with given certificate. filenamef[]Filename, directory, or URL to files to use to edit the resource 
 

 
no-headersinclude-uninitialized
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). If true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
 

 

 output
 oOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). yamlOutput format. One of: yaml|json. 
 

 
save-configrecord
 
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
 

 
show-labelsrecursiveR
 falseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
validatewindows-line-endings
 trueIf true, use a schema to validate the input before sending it falseDefaults to the line ending native to your platform. 
 

 
 

 

-
service

-
Create a service using specified subcommand.

-
Usage

-
$ service

-

-
service clusterip

+
set-last-applied

 

-
 Create a new ClusterIP service named my-cs

+
 Set the last-applied-configuration of a resource to match the contents of a file.

 

-
kubectl create service clusterip my-cs --tcp=5678:8080
+
kubectl apply set-last-applied -f deploy.yaml
 

 

-
 Create a new ClusterIP service named my-cs (in headless mode)

+
 Execute set-last-applied against each configuration file in a directory.

 

-
kubectl create service clusterip my-cs --clusterip="None"
+
kubectl apply set-last-applied -f path/
 

-
Create a ClusterIP service with the specified name.

+

+
 Set the last-applied-configuration of a resource to match the contents of a file, will create the annotation if it does not already exist.

+

+
kubectl apply set-last-applied -f deploy.yaml --create-annotation=true
+

+
Set the latest last-applied-configuration annotations by setting it to match the contents of a file. This results in the last-applied-configuration being updated as though 'kubectl apply -f ' was run, without updating any other parts of the object.

 
Usage

-
$ clusterip NAME [--tcp=<port>:<targetPort>] [--dry-run]

+
$ set-last-applied -f FILENAME

 
Flags

 
@@ -3152,16 +2846,10 @@ 
Flags

-
-
-
-
-
-
-
-
+
-
+
+
@@ -3170,16 +2858,10 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
+
+
+
+
@@ -3187,67 +2869,105 @@ 
Flags

+
+

 
 
 
 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
clusteripcreate-annotation
 Assign your own ClusterIP or set to 'None' for a 'headless' service (no loadbalancing). falseWill create 'last-applied-configuration' annotations if current objects doesn't have one 
 

 

 dry-run
 If true, only print the object that would be sent, without sending it. 
 

 
generatorservice-clusterip/v1The name of the API generator to use. 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). filenamef[]Filename, directory, or URL to files that contains the last-applied-configuration annotations 
 

 

 output
 
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

+

+
view-last-applied

+

+
 View the last-applied-configuration annotations by type/name in YAML.

+

+
kubectl apply view-last-applied deployment/nginx
+

+

+
 View the last-applied-configuration annotations by file in JSON

+

+
kubectl apply view-last-applied -f deploy.yaml -o json
+

+
View the latest last-applied-configuration annotations by type/name or file. 

+
The default output will be printed to stdout in YAML format. One can use -o option to change output format.

+
Usage

+
$ view-last-applied (TYPE [NAME | -l label] | TYPE/NAME | -f FILENAME)

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
+
-
+
-
-
-
-
+
+
+
+
-
-
-
-
+
+
+
+
-
-
-
-
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-
+

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). NameShorthandDefaultUsage
 

 
save-configall
 
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. Select all resources in the namespace of the specified resource types 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) filenamef[]Filename, directory, or URL to files that contains the last-applied-configuration annotations 
 

 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) outputoyamlOutput format. Must be one of yaml|json 
 

 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
tcp[]Port pairs can be specified as ':'. 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
validateselectorl
 trueIf true, use a schema to validate the input before sending it Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
 

 
 

 

-
service externalname

+
annotate

 

-
 Create a new ExternalName service named my-ns

+
 Update pod 'foo' with the annotation 'description' and the value 'my frontend'. # If the same annotation is set multiple times, only the last value will be applied

 

-
kubectl create service externalname my-ns --external-name bar.com
+
kubectl annotate pods foo description='my frontend'
 

-
Create an ExternalName service with the specified name. 

-
ExternalName service references to an external DNS address instead of only pods, which will allow application authors to reference services that exist off platform, on other clusters, or locally.

+

+
 Update a pod identified by type and name in "pod.json"

+

+
kubectl annotate -f pod.json description='my frontend'
+

+

+
 Update pod 'foo' with the annotation 'description' and the value 'my frontend running nginx', overwriting any existing value.

+

+
kubectl annotate --overwrite pods foo description='my frontend running nginx'
+

+

+
 Update all pods in the namespace

+

+
kubectl annotate pods --all description='my frontend running nginx'
+

+

+
 Update pod 'foo' only if the resource is unchanged from version 1.

+

+
kubectl annotate pods foo description='my frontend running nginx' --resource-version=1
+

+

+
 Update pod 'foo' by removing an annotation named 'description' if it exists. # Does not require the --overwrite flag.

+

+
kubectl annotate pods foo description-
+

+
Update the annotations on one or more resources 

+
All Kubernetes objects support the ability to store additional data with the object as annotations. Annotations are key/value pairs that can be larger than labels and include arbitrary string values such as structured JSON. Tools and system extensions may use annotations to store their own data. 

+
Attempting to set an annotation that already exists will fail unless --overwrite is set. If --resource-version is specified and does not match the current resource version on the server the command will fail.

+
Use "kubectl api-resources" for a complete list of supported resources.

 
Usage

-
$ externalname NAME --external-name external.name [--dry-run]

+
$ annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]

 
Flags

 
@@ -3260,10 +2980,10 @@ 
Flags

-
+
-
-
+
+
@@ -3272,22 +2992,28 @@ 
Flags

-
+
-
+
-
+
+
+
+
+
+
+
-
-
+
+
-
+
-
+
@@ -3296,65 +3022,53 @@ 
Flags

-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
+
-
+
-
-
-
-
-
-
-
+
-
-
-
-
+
+
+
+
-
+
-
+
-
+
+
-
-
+

 
 
 
 
allow-missing-template-keysall
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. falseSelect all resources, including uninitialized ones, in the namespace of the specified resource types. 
 

 

 dry-run
 If true, only print the object that would be sent, without sending it. 
 

 
external-namefield-selector
 
 External name of service Selector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type. 
 

 
generatorfilenamef[]Filename, directory, or URL to files identifying the resource to update the annotation 
include-uninitialized
 service-externalname/v1The name of the API generator to use. falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
 

 
no-headerslocal
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). If true, annotation will NOT contact api-server but run locally. 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
save-configoverwrite
 
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) If true, allow annotations to be overwritten, otherwise reject annotation updates that overwrite existing annotations. 
 

 
show-labelsrecord
 
 falseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
 

 
tcp[]Port pairs can be specified as ':'. recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
templateresource-version
 
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. If non-empty, the annotation update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. 
 

 
validateselectorl
 trueIf true, use a schema to validate the input before sending it Selector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). 
 

 
 

 

-
service loadbalancer

+
autoscale

 

-
 Create a new LoadBalancer service named my-lbs

+
 Auto scale a deployment "foo", with the number of pods between 2 and 10, no target CPU utilization specified so a default autoscaling policy will be used:

 

-
kubectl create service loadbalancer my-lbs --tcp=5678:8080
+
kubectl autoscale deployment foo --min=2 --max=10
 

-
Create a LoadBalancer service with the specified name.

+

+
 Auto scale a replication controller "foo", with the number of pods between 1 and 5, target CPU utilization at 80%:

+

+
kubectl autoscale rc foo --max=5 --cpu-percent=80
+

+
Creates an autoscaler that automatically chooses and sets the number of pods that run in a kubernetes cluster. 

+
Looks up a Deployment, ReplicaSet, or ReplicationController by name and creates an autoscaler that uses the given resource as a reference. An autoscaler can automatically increase or decrease number of pods deployed within the system as needed.

 
Usage

-
$ loadbalancer NAME [--tcp=port:targetPort] [--dry-run]

+
$ autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU]

 
Flags

 
@@ -3367,10 +3081,10 @@ 
Flags

-
+
-
-
+
+
@@ -3379,83 +3093,83 @@ 
Flags

-
-
-
-
+
+
+
+
-
+
-
-
+
+
-
-
+
-
+
+
-
-
+
-
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
+
+
-
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
-
+
-
-
+
+

 
 
 
 
allow-missing-template-keyscpu-percent
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. -1The target average CPU utilization (represented as a percent of requested CPU) over all the pods. If it's not specified or negative, a default autoscaling policy will be used. 
 

 

 dry-run
 If true, only print the object that would be sent, without sending it. 
 

 
generatorservice-loadbalancer/v1The name of the API generator to use. filenamef[]Filename, directory, or URL to files identifying the resource to autoscale. 
 

 
no-headersgenerator
 falseWhen using the default or custom-column output format, don't print headers (default print headers). horizontalpodautoscaler/v1The name of the API generator to use. Currently there is only 1 generator. 
 

 
outputomax
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. -1The upper limit for the number of pods that can be set by the autoscaler. Required. 
 

 
output-versionmin
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). -1The lower limit for the number of pods that can be set by the autoscaler. If it's not specified or negative, the server will apply a default value. 
 

 
save-configname
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labels
 falseWhen printing, show all labels as the last column (default hide labels column) The name for the newly created object. If not specified, the name of the input resource will be used. 
 

 
sort-byoutputo
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
tcprecord
 []Port pairs can be specified as ':'. falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
 

 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
validatesave-config
 trueIf true, use a schema to validate the input before sending it falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
 

 

-
service nodeport

+
convert

 

-
 Create a new NodePort service named my-ns

+
 Convert 'pod.yaml' to latest version and print to stdout.

 

-
kubectl create service nodeport my-ns --tcp=5678:8080
+
kubectl convert -f pod.yaml
 

-
Create a NodePort service with the specified name.

+

+
 Convert the live state of the resource specified by 'pod.yaml' to the latest version # and print to stdout in JSON format.

+

+
kubectl convert -f pod.yaml --local -o json
+

+

+
 Convert all files under current directory to latest version and create them all.

+

+
kubectl convert -f . | kubectl create -f -
+

+
Convert config files between different API versions. Both YAML and JSON formats are accepted. 

+
The command takes filename, directory, or URL as input, and convert it into format of version specified by --output-version flag. If target version is not specified or not supported, convert to latest version. 

+
The default output will be printed to stdout in YAML format. One can use -o option to change to output destination.

 
Usage

-
$ nodeport NAME [--tcp=port:targetPort] [--dry-run]

+
$ convert -f FILENAME

 
Flags

 
@@ -3468,82 +3182,34 @@ 
Flags

-
+
+
+
+
+
+
+
-
+
-
-
-
-
+
+
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -3554,15 +3220,35 @@ 
Flags

 
 
 
 
allow-missing-template-keysfilenamef[]Filename, directory, or URL to files to need to get converted. 
local
 
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. If true, convert will NOT try to contact api-server but run locally. 
 

 
dry-runfalseIf true, only print the object that would be sent, without sending it. outputoyamlOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
generatoroutput-version
 service-nodeport/v1The name of the API generator to use. 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). 
node-port0Port used to expose the service on each node in a cluster. 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
save-config
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) Output the formatted object with the given group version (for ex: 'extensions/v1beta1').) 
 

 
show-labelsrecursiveR
 falseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 
tcp[]Port pairs can be specified as ':'. 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 

 validate
 

 

 

-
serviceaccount

+
edit

 

-
 Create a new service account named my-service-account

+
 Edit the service named 'docker-registry':

 

-
kubectl create serviceaccount my-service-account
+
kubectl edit svc/docker-registry
 

-
Create a service account with the specified name.

+

+
 Use an alternative editor

+

+
KUBE_EDITOR="nano" kubectl edit svc/docker-registry
+

+

+
 Edit the job 'myjob' in JSON using the v1 API format:

+

+
kubectl edit job.v1.batch/myjob -o json
+

+

+
 Edit the deployment 'mydeployment' in YAML and save the modified config in its annotation:

+

+
kubectl edit deployment/mydeployment -o yaml --save-config
+

+
Edit a resource from the default editor. 

+
The edit command allows you to directly edit any API resource you can retrieve via the command line tools. It will open the editor defined by your KUBE _EDITOR, or EDITOR environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multiple objects, although changes are applied one at a time. The command accepts filenames as well as command line arguments, although the files you point to must be previously saved versions of resources. 

+
Editing is done with the API version used to fetch the resource. To edit using a specific API version, fully-qualify the resource, version, and group. 

+
The default format is YAML. To edit in JSON, specify "-o json". 

+
The flag --windows-line-endings can be used to force Windows line endings, otherwise the default for your operating system will be used. 

+
In the event an error occurs while updating, a temporary file will be created on disk that contains your unapplied changes. The most common error when updating a resource is another editor changing the resource on the server. When this occurs, you will have to apply your changes to the newer version of the resource, or update your temporary saved copy to include the latest resource version.

 
Usage

-
$ serviceaccount NAME [--dry-run]

+
$ edit (RESOURCE/NAME | -f FILENAME)

 
Flags

 
@@ -3575,34 +3261,16 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
-
+
-
+
@@ -3611,40 +3279,28 @@ 
Flags

-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
+
-
+
-
+
-
-
-
-
+
+
+
+
-
-
+
-
+
+
@@ -3652,52 +3308,55 @@ 
Flags

+
+
+
+
+
+

 
 
 
 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
dry-runfalseIf true, only print the object that would be sent, without sending it. 
generatorserviceaccount/v1The name of the API generator to use. 
include-extended-apistrueIf true, include definitions of new APIs via calls to the API server. [default true] filenamef[]Filename, directory, or URL to files to use to edit the resource 
 

 
no-headersinclude-uninitialized
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). If true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
save-configoutput-patch
 
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) Output the patch if the resource is edited. 
 

 
show-labelsrecord
 
 falseWhen printing, show all labels as the last column (default hide labels column) Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
 

 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
templatesave-config
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 

 validate
 true
 If true, use a schema to validate the input before sending it 
 
windows-line-endingsfalseDefaults to the line ending native to your platform. 

 
 

 

-
delete

-

-
 Delete a pod using the type and name specified in pod.json.

-

-
kubectl delete -f ./pod.json
-

+
label

 

-
 Delete a pod based on the type and name in the JSON passed into stdin.

+
 Update pod 'foo' with the label 'unhealthy' and the value 'true'.

 

-
cat pod.json | kubectl delete -f -
+
kubectl label pods foo unhealthy=true
 

 

-
 Delete pods and services with same names "baz" and "foo"

+
 Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value.

 

-
kubectl delete pod,service baz foo
+
kubectl label --overwrite pods foo status=unhealthy
 

 

-
 Delete pods and services with label name=myLabel.

+
 Update all pods in the namespace

 

-
kubectl delete pods,services -l name=myLabel
+
kubectl label pods --all status=unhealthy
 

 

-
 Delete a pod with minimal delay

+
 Update a pod identified by the type and name in "pod.json"

 

-
kubectl delete pod foo --now
+
kubectl label -f pod.json status=unhealthy
 

 

-
 Force delete a pod on a dead node

+
 Update pod 'foo' only if the resource is unchanged from version 1.

 

-
kubectl delete pod foo --grace-period=0 --force
+
kubectl label pods foo status=unhealthy --resource-version=1
 

 

-
 Delete all pods

+
 Update pod 'foo' by removing a label named 'bar' if it exists. # Does not require the --overwrite flag.

 

-
kubectl delete pods --all
+
kubectl label pods foo bar-
 

-
Delete resources by filenames, stdin, resources and names, or by resources and label selector. 

-
JSON and YAML formats are accepted. Only one type of the arguments may be specified: filenames, resources and names, or resources and label selector. 

-
Some resources, such as pods, support graceful deletion. These resources define a default period before they are forcibly terminated (the grace period) but you may override that value with the --grace-period flag, or pass --now to set a grace-period of 1. Because these resources often represent entities in the cluster, deletion may not be acknowledged immediately. If the node hosting a pod is down or cannot reach the API server, termination may take significantly longer than the grace period. To force delete a resource, you must pass a grace period of 0 and specify the --force flag. 

-
IMPORTANT: Force deleting pods does not wait for confirmation that the pod's processes have been terminated, which can leave those processes running until the node detects the deletion and completes graceful deletion. If your processes use shared storage or talk to a remote API and depend on the name of the pod to identify themselves, force deleting those pods may result in multiple processes running on different machines using the same identification which may lead to data corruption or inconsistency. Only force delete pods when you are sure the pod is terminated, or if your application can tolerate multiple copies of the same pod running at once. Also, if you force delete pods the scheduler may place new pods on those nodes before the node has released those resources and causing those pods to be evicted immediately. 

-
Note that the delete command does NOT do resource version checks, so if someone submits an update to a resource right when you submit a delete, their update will be lost along with the rest of the resource.

+
Update the labels on a resource. 

+
    
+
  • A label key and value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to  63 characters each.  
    • 
+
  • Optionally, the key can begin with a DNS subdomain prefix and a single '/', like example.com/my-app  
    • 
+
  • If --overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error.  
    • 
+
  • If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used.
    • 
+

 
Usage

-
$ delete ([-f FILENAME] | TYPE [(NAME | -l label | --all)])

+
$ label [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]

 
Flags

 
@@ -3713,61 +3372,61 @@ 
Flags

-
+
-
+
-
-
+
+
+
+
+
+
+
+
-
+
-
+
-
+
-
+
-
-
+
+
-
+
-
+
-
+
+
-
-
+
-
+
-
+
-
+
-
-
-
-
-
-
-
+
@@ -3776,49 +3435,51 @@ 
Flags

-
-
+
-
+
+
-
+
+
-
-
+

 
 
all
 
 falseDelete all resources, including uninitialized ones, in the namespace of the specified resource types. Select all resources, including uninitialized ones, in the namespace of the specified resource types 
 

 
cascadedry-run
 trueIf true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController).  Default true. falseIf true, only print the object that would be sent, without sending it. 
field-selectorSelector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type. 
 

 

 filename
 f
 []Filename, directory, or URL to files containing the resource to delete. Filename, directory, or URL to files identifying the resource to update the labels 
 

 
forceinclude-uninitialized
 
 falseImmediate deletion of some resources may result in inconsistency or data loss and requires confirmation. If true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
 

 
grace-periodlist
 -1Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. falseIf true, display the labels for a given resource. 
 

 
ignore-not-foundlocal
 
 falseTreat "resource not found" as a successful delete. Defaults to "true" when --all is specified. If true, label will NOT contact api-server but run locally. 
 

 
include-extended-apisoutputo
 trueIf true, include definitions of new APIs via calls to the API server. [default true] Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
include-uninitializedoverwrite
 
 falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. If true, allow labels to be overwritten, otherwise reject label updates that overwrite existing labels. 
 

 
nowrecord
 
 falseIf true, resources are signaled for immediate shutdown (same as --grace-period=1). 
outputoOutput mode. Use "-o name" for shorter output (resource/name). Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
 

 

 recursive
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
selectorlresource-version
 Selector (label query) to filter on, not including uninitialized ones. If non-empty, the labels update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. 
 

 
timeoutselectorl
 0sThe length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object Selector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). 
 

 
 

 

-
edit

+
patch

 

-
 Edit the service named 'docker-registry':

+
 Partially update a node using a strategic merge patch. Specify the patch as JSON.

 

-
kubectl edit svc/docker-registry
+
kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}'
 

 

-
 Use an alternative editor

+
 Partially update a node using a strategic merge patch. Specify the patch as YAML.

 

-
KUBE_EDITOR="nano" kubectl edit svc/docker-registry
+
kubectl patch node k8s-node-1 -p $'spec:\n unschedulable: true'
 

 

-
 Edit the job 'myjob' in JSON using the v1 API format:

+
 Partially update a node identified by the type and name specified in "node.json" using strategic merge patch.

 

-
kubectl edit job.v1.batch/myjob -o json
+
kubectl patch -f node.json -p '{"spec":{"unschedulable":true}}'
 

 

-
 Edit the deployment 'mydeployment' in YAML and save the modified config in its annotation:

+
 Update a container's image; spec.containers[*].name is required because it's a merge key.

 

-
kubectl edit deployment/mydeployment -o yaml --save-config
+
kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}'
 

-
Edit a resource from the default editor. 

-
The edit command allows you to directly edit any API resource you can retrieve via the command line tools. It will open the editor defined by your KUBE _EDITOR, or EDITOR environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multiple objects, although changes are applied one at a time. The command accepts filenames as well as command line arguments, although the files you point to must be previously saved versions of resources. 

-
Editing is done with the API version used to fetch the resource. To edit using a specific API version, fully-qualify the resource, version, and group. 

-
The default format is YAML. To edit in JSON, specify "-o json". 

-
The flag --windows-line-endings can be used to force Windows line endings, otherwise the default for your operating system will be used. 

-
In the event an error occurs while updating, a temporary file will be created on disk that contains your unapplied changes. The most common error when updating a resource is another editor changing the resource on the server. When this occurs, you will have to apply your changes to the newer version of the resource, or update your temporary saved copy to include the latest resource version.

+

+
 Update a container's image using a json patch with positional arrays.

+

+
kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]'
+

+
Update field(s) of a resource using strategic merge patch, a JSON merge patch, or a JSON patch. 

+
JSON and YAML formats are accepted. 

+
Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/HEAD/docs/api-reference/v1/definitions.html to find if a field is mutable.

 
Usage

-
$ edit (RESOURCE/NAME | -f FILENAME)

+
$ patch (-f FILENAME | TYPE NAME) -p PATCH

 
Flags

 
@@ -3831,34 +3492,34 @@ 
Flags

+
+
+
+
+
+
-
-
-
-
-
-
-
+
-
+
-
+
-
-
+
+
-
+
+
-
-
+
@@ -3873,118 +3534,41 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
+
+

 
 
 
 
dry-runfalseIf true, only print the object that would be sent, without sending it. 

 filename
 f
 []Filename, directory, or URL to files to use to edit the resource 
include-extended-apistrueIf true, include definitions of new APIs via calls to the API server. [default true] Filename, directory, or URL to files identifying the resource to update 
 

 
include-uninitializedlocal
 
 falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. If true, patch will operate on the content of the file, not the server-side resource. 
 

 

 output
 oyamlOutput format. One of: yaml|json. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-patchpatchp
 falseOutput the patch if the resource is edited. The patch to be applied to the resource JSON file. 
 

 

 record
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
save-configfalseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
validatetrueIf true, use a schema to validate the input before sending it 
windows-line-endingstype
 falseDefaults to the line ending native to your platform. strategicThe type of patch being provided; one of [json merge strategic] 
 

 
 

 

-
get

-

-
 List all pods in ps output format.

-

-
kubectl get pods
-

-

-
 List all pods in ps output format with more information (such as node name).

-

-
kubectl get pods -o wide
-

-

-
 List a single replication controller with specified NAME in ps output format.

-

-
kubectl get replicationcontroller web
-

-

-
 List a single pod in JSON output format.

-

-
kubectl get -o json pod web-pod-13je7
-

-

-
 List a pod identified by type and name specified in "pod.yaml" in JSON output format.

-

-
kubectl get -f pod.yaml -o json
-

+
replace

 

-
 Return only the phase value of the specified pod.

+
 Replace a pod using the data in pod.json.

 

-
kubectl get -o template pod/web-pod-13je7 --template={{.status.phase}}
+
kubectl replace -f ./pod.json
 

 

-
 List all replication controllers and services together in ps output format.

+
 Replace a pod based on the JSON passed into stdin.

 

-
kubectl get rc,services
+
cat pod.json | kubectl replace -f -
 

 

-
 List one or more resources by their type and names.

+
 Update a single-container pod's image version (tag) to v4

 

-
kubectl get rc/web service/frontend pods/web-pod-13je7
+
kubectl get pod mypod -o yaml | sed 's/\(image: myimage\):.*$/\1:v4/' | kubectl replace -f -
 

 

-
 List all resources with different types.

+
 Force replace, delete and then re-create the resource

 

-
kubectl get all
+
kubectl replace --force -f ./pod.json
 

-
Display one or many resources 

-
Prints a table of the most important information about the specified resources. You can filter the list using a label selector and the --selector flag. If the desired resource type is namespaced you will only see results in your current namespace unless you pass --all-namespaces. 

-
Uninitialized objects are not shown unless --include-uninitialized is passed. 

-
By specifying the output as 'template' and providing a Go template as the value of the --template flag, you can filter the attributes of the fetched resources.

-
Valid resource types include: 

-
    
-
  • all  
    • 
-
  • certificatesigningrequests (aka 'csr')  
    • 
-
  • clusterrolebindings  
    • 
-
  • clusterroles  
    • 
-
  • componentstatuses (aka 'cs')  
    • 
-
  • configmaps (aka 'cm')  
    • 
-
  • controllerrevisions  
    • 
-
  • cronjobs  
    • 
-
  • customresourcedefinition (aka 'crd')  
    • 
-
  • daemonsets (aka 'ds')  
    • 
-
  • deployments (aka 'deploy')  
    • 
-
  • endpoints (aka 'ep')  
    • 
-
  • events (aka 'ev')  
    • 
-
  • horizontalpodautoscalers (aka 'hpa')  
    • 
-
  • ingresses (aka 'ing')  
    • 
-
  • jobs  
    • 
-
  • limitranges (aka 'limits')  
    • 
-
  • namespaces (aka 'ns')  
    • 
-
  • networkpolicies (aka 'netpol')  
    • 
-
  • nodes (aka 'no')  
    • 
-
  • persistentvolumeclaims (aka 'pvc')  
    • 
-
  • persistentvolumes (aka 'pv')  
    • 
-
  • poddisruptionbudgets (aka 'pdb')  
    • 
-
  • podpreset  
    • 
-
  • pods (aka 'po')  
    • 
-
  • podsecuritypolicies (aka 'psp')  
    • 
-
  • podtemplates  
    • 
-
  • replicasets (aka 'rs')  
    • 
-
  • replicationcontrollers (aka 'rc')  
    • 
-
  • resourcequotas (aka 'quota')  
    • 
-
  • rolebindings  
    • 
-
  • roles  
    • 
-
  • secrets  
    • 
-
  • serviceaccounts (aka 'sa')  
    • 
-
  • services (aka 'svc')  
    • 
-
  • statefulsets (aka 'sts')  
    • 
-
  • storageclasses (aka 'sc')
    • 
-

+
Replace a resource by filename or stdin. 

+
JSON and YAML formats are accepted. If replacing an existing resource, the complete resource spec must be provided. This can be obtained by 

+
  $ kubectl get TYPE NAME -o yaml

+
Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/HEAD/docs/api-reference/v1/definitions.html to find if a field is mutable.

 
Usage

-
$ get [(-o|--output=)json|yaml|wide|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=...] (TYPE [NAME | -l label] | TYPE/NAME ...) [flags]

+
$ replace -f FILENAME

 
Flags

 
@@ -3997,76 +3581,28 @@ 
Flags

-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
-
-
-
-
-
-
+
-
+
-
-
+
+
@@ -4075,120 +3611,73 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
+
-
-
+
-
+
+
-
+
-
-
-
-
-
-
-
+
-
+
-
+

 
 
 
 
all-namespacesfalseIf present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. 
allow-missing-template-keyscascade
 
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
chunk-size500Return large lists in chunks rather than all at once. Pass 0 to disable. This flag is beta and may change in the future. 
experimental-server-printfalseIf true, have the server return the appropriate table output. Supports extension APIs and CRD. Experimental. 
exportfalseIf true, use 'export' for the resources.  Exported resources are stripped of cluster-specific information. 
field-selectorSelector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type. If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController).  Default true. 
 

 

 filename
 f
 []Filename, directory, or URL to files identifying the resource to get from a server. 
ignore-not-foundfalseIf the requested object does not exist the command will return exit code 0. 
include-extended-apistrueIf true, include definitions of new APIs via calls to the API server. [default true] to use to replace the resource. 
 

 
include-uninitializedforce
 
 falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
label-columnsL[]Accepts a comma separated list of labels that are going to be presented as columns. Names are case-sensitive. You can also use multiple flag options like -L label1 -L label2... Only used when grace-period=0. If true, immediately remove resources from API and bypass graceful deletion. Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation. 
 

 
no-headersgrace-period
 falseWhen using the default or custom-column output format, don't print headers (default print headers). -1Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. Set to 1 for immediate shutdown. Can only be set to 0 when --force is true (force deletion). 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
rawRaw URI to request from the server.  Uses the transport specified by the kubeconfig file. 

 recursive
 R
 false
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
selectorlSelector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-kindfalseIf present, list the resource type for the requested object(s). 
show-labelssave-config
 
 falseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
templatetimeout
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 0sThe length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object 
 

 
use-openapi-print-columnsvalidate
 
 trueIf true, use x-kubernetes-print-column metadata (if present) from the OpenAPI schema for displaying a resource. 
watchwfalseAfter listing/getting the requested object, watch for changes. Uninitialized objects are excluded if no object name is provided. If true, use a schema to validate the input before sending it 
 

 
watch-onlywait
 
 falseWatch for changes to the requested object(s), without listing/getting first. If true, wait for resources to be gone before returning. This waits for finalizers. 
 

 
 

 

-
label

+
rollout

 

-
 Update pod 'foo' with the label 'unhealthy' and the value 'true'.

+
 Rollback to the previous deployment

 

-
kubectl label pods foo unhealthy=true
+
kubectl rollout undo deployment/abc
 

 

-
 Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value.

+
 Check the rollout status of a daemonset

 

-
kubectl label --overwrite pods foo status=unhealthy
-

-

-
 Update all pods in the namespace

-

-
kubectl label pods --all status=unhealthy
-

-

-
 Update a pod identified by the type and name in "pod.json"

-

-
kubectl label -f pod.json status=unhealthy
+
kubectl rollout status daemonset/foo
 

+
Manage the rollout of a resource.

+
Valid resource types include: 

+
    
+
  • deployments  
    • 
+
  • daemonsets  
    • 
+
  • statefulsets
    • 
+

+
Usage

+
$ rollout SUBCOMMAND

+

+
history

 

-
 Update pod 'foo' only if the resource is unchanged from version 1.

+
 View the rollout history of a deployment

 

-
kubectl label pods foo status=unhealthy --resource-version=1
+
kubectl rollout history deployment/abc
 

 

-
 Update pod 'foo' by removing a label named 'bar' if it exists. # Does not require the --overwrite flag.

+
 View the details of daemonset revision 3

 

-
kubectl label pods foo bar-
+
kubectl rollout history daemonset/abc --revision=3
 

-
Update the labels on a resource. 

-
    
-
  • A label key and value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to  63 characters each.  
    • 
-
  • Optionally, the key can begin with a DNS subdomain prefix and a single '/', like example.com/my-app  
    • 
-
  • If --overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error.  
    • 
-
  • If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used.
    • 
-

+
View previous rollout revisions and configurations.

 
Usage

-
$ label [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]

+
$ history (TYPE NAME | TYPE/NAME) [flags]

 
Flags

 
@@ -4201,82 +3690,88 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
+
+
-
+
-
+
-
-
+
+
+
+

 
 
 
 
allfalseSelect all resources, including uninitialized ones, in the namespace of the specified resource types 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
dry-runfalseIf true, only print the object that would be sent, without sending it. 

 filename
 f
 []Filename, directory, or URL to files identifying the resource to update the labels 
include-extended-apistrueIf true, include definitions of new APIs via calls to the API server. [default true] 
include-uninitializedfalseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. Filename, directory, or URL to files identifying the resource to get from a server. 
 

 
listrecursiveR
 falseIf true, display the labels for a given resource. Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
localrevision
 falseIf true, label will NOT contact api-server but run locally. 0See the details, including podTemplate of the revision specified 
 

+

+
pause

+

+
 Mark the nginx deployment as paused. Any current state of # the deployment will continue its function, new updates to the deployment will not # have an effect as long as the deployment is paused.

+

+
kubectl rollout pause deployment/nginx
+

+
Mark the provided resource as paused 

+
Paused resources will not be reconciled by a controller. Use "kubectl rollout resume" to resume a paused resource. Currently only deployments support being paused.

+
Usage

+
$ pause RESOURCE

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
-
-
-
+
+
+
+
-
-
-
-
+
+
+
+
+
+

 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). NameShorthandDefaultUsage
 

 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. filenamef[]Filename, directory, or URL to files identifying the resource to get from a server. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

+

+
resume

+

+
 Resume an already paused deployment

+

+
kubectl rollout resume deployment/nginx
+

+
Resume a paused resource 

+
Paused resources will not be reconciled by a controller. By resuming a resource, we allow it to be reconciled again. Currently only deployments support being resumed.

+
Usage

+
$ resume RESOURCE

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
-
-
-
+
+
+
+
@@ -4284,76 +3779,76 @@ 
Flags

+
+

 
overwritefalseIf true, allow labels to be overwritten, otherwise reject label updates that overwrite existing labels. NameShorthandDefaultUsage
 

 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. filenamef[]Filename, directory, or URL to files identifying the resource to get from a server. 
 

 

 recursive
 false
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

+

+
status

+

+
 Watch the rollout status of a deployment

+

+
kubectl rollout status deployment/nginx
+

+
Show the status of the rollout. 

+
By default 'rollout status' will watch the status of the latest rollout until it's done. If you don't want to wait for the rollout to finish then you can use --watch=false. Note that if a new rollout starts in-between, then 'rollout status' will continue watching the latest revision. If you want to pin to a specific revision and abort if it is rolled over by another revision, use --revision=N where N is the revision you need to watch for.

+
Usage

+
$ status (TYPE NAME | TYPE/NAME) [flags]

+
Flags

+
+
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-
-
-
-
+
+
+
+
-
-
+
+
-
+
-
-
+
-
+
+
-
-
-
-
+
+
+
+

 
resource-versionIf non-empty, the labels update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. 
selectorlSelector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). NameShorthandDefaultUsage
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) filenamef[]Filename, directory, or URL to files identifying the resource to get from a server. 
 

 
show-labelsrecursiveR
 falseWhen printing, show all labels as the last column (default hide labels column) Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
sort-byrevision
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 0Pin to a specific revision for showing its status. Defaults to 0 (last revision). 
 

 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. watchwtrueWatch the status of the rollout until it's done. 
 

 
 

 

-
patch

-

-
 Partially update a node using a strategic merge patch. Specify the patch as JSON.

-

-
kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}'
-

-

-
 Partially update a node using a strategic merge patch. Specify the patch as YAML.

-

-
kubectl patch node k8s-node-1 -p $'spec:\n unschedulable: true'
-

+
undo

 

-
 Partially update a node identified by the type and name specified in "node.json" using strategic merge patch.

+
 Rollback to the previous deployment

 

-
kubectl patch -f node.json -p '{"spec":{"unschedulable":true}}'
+
kubectl rollout undo deployment/abc
 

 

-
 Update a container's image; spec.containers[*].name is required because it's a merge key.

+
 Rollback to daemonset revision 3

 

-
kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}'
+
kubectl rollout undo daemonset/abc --to-revision=3
 

 

-
 Update a container's image using a json patch with positional arrays.

+
 Rollback to the previous deployment with dry-run

 

-
kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]'
+
kubectl rollout undo --dry-run=true deployment/abc
 

-
Update field(s) of a resource using strategic merge patch, a JSON merge patch, or a JSON patch. 

-
JSON and YAML formats are accepted. 

-
Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/HEAD/docs/api-reference/v1/definitions.html to find if a field is mutable.

+
Rollback to a previous rollout.

 
Usage

-
$ patch (-f FILENAME | TYPE NAME) -p PATCH

+
$ undo (TYPE NAME | TYPE/NAME) [flags]

 
Flags

 
@@ -4366,58 +3861,16 @@ 
Flags

-
+
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -4426,65 +3879,45 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
+
+

 
 
 
 
allow-missing-template-keysdry-run
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. falseIf true, only print the object that would be sent, without sending it. 
 

 

 filename
 f
 []Filename, directory, or URL to files identifying the resource to update 
include-extended-apistrueIf true, include definitions of new APIs via calls to the API server. [default true] 
localfalseIf true, patch will operate on the content of the file, not the server-side resource. 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
patchpThe patch to be applied to the resource JSON file. 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. Filename, directory, or URL to files identifying the resource to get from a server. 
 

 

 recursive
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
typeto-revision
 strategicThe type of patch being provided; one of [json merge strategic] 0The revision to rollback to. Default to 0 (last revision). 
 

 
 

 

-
replace

+
scale

 

-
 Replace a pod using the data in pod.json.

+
 Scale a replicaset named 'foo' to 3.

 

-
kubectl replace -f ./pod.json
+
kubectl scale --replicas=3 rs/foo
 

 

-
 Replace a pod based on the JSON passed into stdin.

+
 Scale a resource identified by type and name specified in "foo.yaml" to 3.

 

-
cat pod.json | kubectl replace -f -
+
kubectl scale --replicas=3 -f foo.yaml
 

 

-
 Update a single-container pod's image version (tag) to v4

+
 If the deployment named mysql's current size is 2, scale mysql to 3.

 

-
kubectl get pod mypod -o yaml | sed 's/\(image: myimage\):.*$/\1:v4/' | kubectl replace -f -
+
kubectl scale --current-replicas=2 --replicas=3 deployment/mysql
 

 

-
 Force replace, delete and then re-create the resource

+
 Scale multiple replication controllers.

 

-
kubectl replace --force -f ./pod.json
+
kubectl scale --replicas=5 rc/foo rc/bar rc/baz
 

-
Replace a resource by filename or stdin. 

-
JSON and YAML formats are accepted. If replacing an existing resource, the complete resource spec must be provided. This can be obtained by 

-
  $ kubectl get TYPE NAME -o yaml

-
Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/HEAD/docs/api-reference/v1/definitions.html to find if a field is mutable.

+

+
 Scale statefulset named 'web' to 3.

+

+
kubectl scale --replicas=3 statefulset/web
+

+
Set a new size for a Deployment, ReplicaSet, Replication Controller, or StatefulSet. 

+
Scale also allows users to specify one or more preconditions for the scale action. 

+
If --current-replicas or --resource-version is specified, it is validated before the scale is attempted, and it is guaranteed that the precondition holds true when the scale is sent to the server.

 
Usage

-
$ replace -f FILENAME

+
$ scale [--resource-version=version] [--current-replicas=count] --replicas=COUNT (-f FILENAME | TYPE NAME)

 
Flags

 
@@ -4497,40 +3930,28 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
+
-
+
-
-
-
-
+
+
+
+
-
+
@@ -4545,57 +3966,101 @@ 
Flags

-
+
-
-
+
+
-
+
-
-
+
+
-
+
+
-
-
+
+
+
+
+
+
+

 
 
 
 
cascadefalseOnly relevant during a force replace. If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController). 
filenamef[]Filename, directory, or URL to files to use to replace the resource. 
forceall
 
 falseDelete and re-create the specified resource Select all resources in the namespace of the specified resource types 
 

 
grace-periodcurrent-replicas
 
 -1Only relevant during a force replace. Period of time in seconds given to the old resource to terminate gracefully. Ignored if negative. Precondition for current size. Requires that the current size of the resource match this value in order to scale. 
 

 
include-extended-apistrueIf true, include definitions of new APIs via calls to the API server. [default true] filenamef[]Filename, directory, or URL to files identifying the resource to set a new size 
 

 

 output
 o
 Output mode. Use "-o name" for shorter output (resource/name). Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 

 record
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
save-configreplicas
 falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 0The new desired number of replicas. Required. 
 

 
timeoutresource-version
 0sOnly relevant during a force replace. The length of time to wait before giving up on a delete of the old resource, zero means determine a timeout from the size of the object. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). Precondition for resource version. Requires that the current resource version match this value in order to scale. 
 

 
validateselectorl
 trueIf true, use a schema to validate the input before sending it Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
timeout0sThe length of time to wait before giving up on a scale operation, zero means don't wait. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). 
 

 
 

 

-
rolling-update

+
set

+
Configure application resources 

+
These commands help you make changes to existing application resources.

+
Usage

+
$ set SUBCOMMAND

+

+
env

 

-
 Update pods of frontend-v1 using new replication controller data in frontend-v2.json.

+
 Update deployment 'registry' with a new environment variable

 

-
kubectl rolling-update frontend-v1 -f frontend-v2.json
+
kubectl set env deployment/registry STORAGE_DIR=/local
 

 

-
 Update pods of frontend-v1 using JSON data passed into stdin.

+
 List the environment variables defined on a deployments 'sample-build'

 

-
cat frontend-v2.json | kubectl rolling-update frontend-v1 -f -
+
kubectl set env deployment/sample-build --list
 

 

-
 Update the pods of frontend-v1 to frontend-v2 by just changing the image, and switching the # name of the replication controller.

+
 List the environment variables defined on all pods

 

-
kubectl rolling-update frontend-v1 frontend-v2 --image=image:v2
+
kubectl set env pods --all --list
 

 

-
 Update the pods of frontend by just changing the image, and keeping the old name.

+
 Output modified deployment in YAML, and does not alter the object on the server

 

-
kubectl rolling-update frontend --image=image:v2
+
kubectl set env deployment/sample-build STORAGE_DIR=/data -o yaml
 

 

-
 Abort and reverse an existing rollout in progress (from frontend-v1 to frontend-v2).

+
 Update all containers in all replication controllers in the project to have ENV=prod

 

-
kubectl rolling-update frontend-v1 frontend-v2 --rollback
+
kubectl set env rc --all ENV=prod
 

-
Perform a rolling update of the given ReplicationController. 

-
Replaces the specified replication controller with a new replication controller by updating one pod at a time to use the new PodTemplate. The new-controller.json must specify the same namespace as the existing replication controller and overwrite at least one (common) label in its replicaSelector. 

-
! http://kubernetes.io/images/docs/kubectl_rollingupdate.svg

+

+
 Import environment from a secret

+

+
kubectl set env --from=secret/mysecret deployment/myapp
+

+

+
 Import environment from a config map with a prefix

+

+
kubectl set env --from=configmap/myconfigmap --prefix=MYSQL_ deployment/myapp
+

+

+
 Import specific keys from a config map

+

+
kubectl set env --keys=my-example-key --from=configmap/myconfigmap deployment/myapp
+

+

+
 Remove the environment variable ENV from container 'c1' in all deployment configs

+

+
kubectl set env deployments --all --containers="c1" ENV-
+

+

+
 Remove the environment variable ENV from a deployment definition on disk and # update the deployment config on the server

+

+
kubectl set env -f deploy.json ENV-
+

+

+
 Set some of the local shell environment into a deployment config on the server

+

+
env | grep RAILS_ | kubectl set env -e - deployment/registry
+

+
Update environment variables on a pod template. 

+
List environment variable definitions in one or more pods, pod templates. Add, update, or remove container environment variable definitions in one or more pod templates (within replication controllers or deployment configurations). View or modify the environment variable definitions on all containers in the specified pods or pod templates, or just those that match a wildcard. 

+
If "--env -" is passed, environment variables can be read from STDIN using the standard env syntax. 

+
Possible resources include (case insensitive): 

+
  pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), job, replicaset (rs)

 
Usage

-
$ rolling-update OLD_CONTROLLER_NAME ([NEW_CONTROLLER_NAME] --image=NEW_CONTAINER_IMAGE | -f NEW_CONTROLLER_SPEC)

+
$ env RESOURCE/NAME KEY_1=VAL_1 ... KEY_N=VAL_N

 
Flags

 
@@ -4608,22 +4073,16 @@ 
Flags

-
-
-
-
-
-
-
-
+
-
+
+
-
-
-
-
+
+
+
+
@@ -4632,34 +4091,40 @@ 
Flags

+
+
+
+
+
+
-
+
-
+
-
+
-
-
+
-
+
+
-
+
-
-
+
+
-
+
-
+
@@ -4668,103 +4133,64 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
+
-
-
-
-
+
+
+
+
-
+
-
-
+
+
-
+
+
-
-
+

 
 
 
 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
containerall
 Container name which will have its image upgraded. Only relevant when --image is specified, ignored otherwise. Required when using --image on a multi-container pod falseIf true, select all resources in the namespace of the specified resource types 
 

 
deployment-label-keydeploymentThe key to use to differentiate between two different controllers, default 'deployment'.  Only relevant when --image is specified, ignored otherwise containersc*The names of containers in the selected pod templates to change - may use wildcards 
 

 

 dry-run
 If true, only print the object that would be sent, without sending it. 
 

 
enve[]Specify a key-value pair for an environment variable to set into each container. 

 filename
 f
 []Filename or URL to file to use to create the new replication controller. Filename, directory, or URL to files the resource to update the env 
 

 
imagefrom
 
 Image to use for upgrading the replication controller. Must be distinct from the existing image (either new image or new image tag).  Can not be used with --filename/-f The name of a resource from which to inject environment variables 
 

 
image-pull-policykeys
 Explicit policy for when to pull container images. Required when --image is same as existing image, ignored otherwise. []Comma-separated list of keys to import from specified resource 
 

 
include-extended-apislist
 trueIf true, include definitions of new APIs via calls to the API server. [default true] falseIf true, display the environment and any changes in the standard format. this flag will removed when we have kubectl view env. 
 

 
no-headerslocal
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). If true, set env will NOT contact api-server but run locally. 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
poll-interval3sTime delay between polling for replication controller status after the update. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". 
rollbackoverwrite
 falseIf true, this is a request to abort an existing rollout that is partially rolled out. It effectively reverses current and next and runs a rollout 
show-alla
 trueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. If true, allow environment to be overwritten, otherwise reject updates that overwrite existing environment. 
 

 
templateprefix
 
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. Prefix to append to variable names 
 

 
timeout5m0sMax time to wait for a replication controller to update before giving up. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
update-periodresolve
 1m0sTime to wait between updating pods. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". falseIf true, show secret or configmap references when listing variables 
 

 
validateselectorl
 trueIf true, use a schema to validate the input before sending it Selector (label query) to filter on 
 

 
 

 

-
rollout

+
image

 

-
 Rollback to the previous deployment

+
 Set a deployment's nginx container image to 'nginx:1.9.1', and its busybox container image to 'busybox'.

 

-
kubectl rollout undo deployment/abc
+
kubectl set image deployment/nginx busybox=busybox nginx=nginx:1.9.1
 

 

-
 Check the rollout status of a daemonset

+
 Update all deployments' and rc's nginx container's image to 'nginx:1.9.1'

 

-
kubectl rollout status daemonset/foo
+
kubectl set image deployments,rc nginx=nginx:1.9.1 --all
 

-
Manage the rollout of a resource.

-
Valid resource types include: 

-
    
-
  • deployments  
    • 
-
  • daemonsets  
    • 
-
  • statefulsets
    • 
-

-
Usage

-
$ rollout SUBCOMMAND

-

-
history

 

-
 View the rollout history of a deployment

+
 Update image of all containers of daemonset abc to 'nginx:1.9.1'

 

-
kubectl rollout history deployment/abc
+
kubectl set image daemonset abc *=nginx:1.9.1
 

 

-
 View the details of daemonset revision 3

+
 Print result (in yaml format) of updating nginx container image from local file, without hitting the server

 

-
kubectl rollout history daemonset/abc --revision=3
+
kubectl set image -f path/to/file.yaml nginx=nginx:1.9.1 --local -o yaml
 

-
View previous rollout revisions and configurations.

+
Update existing container image(s) of resources. 

+
Possible resources include (case insensitive): 

+
  pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), replicaset (rs)

 
Usage

-
$ history (TYPE NAME | TYPE/NAME) [flags]

+
$ image (-f FILENAME | TYPE NAME) CONTAINER_NAME_1=CONTAINER_IMAGE_1 ... CONTAINER_NAME_N=CONTAINER_IMAGE_N

 
Flags

 
@@ -4777,36 +4203,88 @@ 
Flags

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
-
-
+

 
 
 
 
allfalseSelect all resources, including uninitialized ones, in the namespace of the specified resource types 
dry-runfalseIf true, only print the object that would be sent, without sending it. 

 filename
 f
 []
 Filename, directory, or URL to files identifying the resource to get from a server. 
 

 
include-uninitializedfalseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
localfalseIf true, set image will NOT contact api-server but run locally. 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 

 recursive
 R
 false
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
revisionselectorl
 0See the details, including podTemplate of the revision specified Selector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
 

 
 

 

-
pause

+
resources

 

-
 Mark the nginx deployment as paused. Any current state of # the deployment will continue its function, new updates to the deployment will not # have an effect as long as the deployment is paused.

+
 Set a deployments nginx container cpu limits to "200m" and memory to "512Mi"

 

-
kubectl rollout pause deployment/nginx
+
kubectl set resources deployment nginx -c=nginx --limits=cpu=200m,memory=512Mi
 

-
Mark the provided resource as paused 

-
Paused resources will not be reconciled by a controller. Use "kubectl rollout resume" to resume a paused resource. Currently only deployments support being paused.

+

+
 Set the resource request and limits for all containers in nginx

+

+
kubectl set resources deployment nginx --limits=cpu=200m,memory=512Mi --requests=cpu=100m,memory=256Mi
+

+

+
 Remove the resource requests for resources on containers in nginx

+

+
kubectl set resources deployment nginx --limits=cpu=0,memory=0 --requests=cpu=0,memory=0
+

+

+
 Print the result (in yaml format) of updating nginx container limits from a local, without hitting the server

+

+
kubectl set resources -f path/to/file.yaml --limits=cpu=200m,memory=512Mi --local -o yaml
+

+
Specify compute resource requirements (cpu, memory) for any resource that defines a pod template.  If a pod is successfully scheduled, it is guaranteed the amount of resource requested, but may burst up to its specified limits. 

+
for each compute resource, if a limit is specified and a request is omitted, the request will default to the limit. 

+
Possible resources include (case insensitive): Use "kubectl api-resources" for a complete list of supported resources..

 
Usage

-
$ pause RESOURCE

+
$ resources (-f FILENAME | TYPE NAME)  ([--limits=LIMITS & --requests=REQUESTS]

 
Flags

 
@@ -4819,30 +4297,91 @@ 
Flags

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

 
 
 
 
allfalseSelect all resources, including uninitialized ones, in the namespace of the specified resource types 
containersc*The names of containers in the selected pod templates to change, all containers are selected by default - may use wildcards 
dry-runfalseIf true, only print the object that would be sent, without sending it. 

 filename
 f
 []
 Filename, directory, or URL to files identifying the resource to get from a server. 
 

 
include-uninitializedfalseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
limitsThe resource requirement requests for this container.  For example, 'cpu=100m,memory=256Mi'.  Note that server side components may assign requests depending on the server configuration, such as limit ranges. 
localfalseIf true, set resources will NOT contact api-server but run locally. 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 

 recursive
 R
 false
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 
requestsThe resource requirement requests for this container.  For example, 'cpu=100m,memory=256Mi'.  Note that server side components may assign requests depending on the server configuration, such as limit ranges. 
selectorlSelector (label query) to filter on, not including uninitialized ones,supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 

 
 

 

-
resume

+
selector

 

-
 Resume an already paused deployment

+
 set the labels and selector before creating a deployment/service pair.

 

-
kubectl rollout resume deployment/nginx
+
kubectl create service clusterip my-svc --clusterip="None" -o yaml --dry-run | kubectl set selector --local -f - 'environment=qa' -o yaml | kubectl create -f -
+kubectl create deployment my-dep -o yaml --dry-run | kubectl label --local -f - environment=qa -o yaml | kubectl create -f -
 

-
Resume a paused resource 

-
Paused resources will not be reconciled by a controller. By resuming a resource, we allow it to be reconciled again. Currently only deployments support being resumed.

+
Set the selector on a resource. Note that the new selector will overwrite the old selector if the resource had one prior to the invocation of 'set selector'. 

+
A selector must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to  63 characters. If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used. Note: currently selectors can only be set on Service objects.

 
Usage

-
$ resume RESOURCE

+
$ selector (-f FILENAME | TYPE NAME) EXPRESSIONS [--resource-version=version]

 
Flags

 
@@ -4855,30 +4394,78 @@ 
Flags

+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
+
+
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

 
 
 
 
allfalseSelect all resources in the namespace of the specified resource types 
dry-runfalseIf true, only print the object that would be sent, without sending it. 

 filename
 f
 []Filename, directory, or URL to files identifying the resource to get from a server. identifying the resource. 
 

 
recursiveRinclude-uninitialized
 falseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. If true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
 
localfalseIf true, annotation will NOT contact api-server but run locally. 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
recursiveRtrueProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
resource-versionIf non-empty, the selectors update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. 

 

 

-
status

+
serviceaccount

 

-
 Watch the rollout status of a deployment

+
 Set Deployment nginx-deployment's ServiceAccount to serviceaccount1

 

-
kubectl rollout status deployment/nginx
+
kubectl set serviceaccount deployment nginx-deployment serviceaccount1
 

-
Show the status of the rollout. 

-
By default 'rollout status' will watch the status of the latest rollout until it's done. If you don't want to wait for the rollout to finish then you can use --watch=false. Note that if a new rollout starts in-between, then 'rollout status' will continue watching the latest revision. If you want to pin to a specific revision and abort if it is rolled over by another revision, use --revision=N where N is the revision you need to watch for.

+

+
 Print the result (in yaml format) of updated nginx deployment with serviceaccount from local file, without hitting apiserver

+

+
kubectl set sa -f nginx-deployment.yaml serviceaccount1 --local --dry-run -o yaml
+

+
Update ServiceAccount of pod template resources. 

+
Possible resources (case insensitive) can be: 

+
replicationcontroller (rc), deployment (deploy), daemonset (ds), job, replicaset (rs), statefulset

 
Usage

-
$ status (TYPE NAME | TYPE/NAME) [flags]

+
$ serviceaccount (-f FILENAME | TYPE NAME) SERVICE_ACCOUNT

 
Flags

 
@@ -4891,51 +4478,75 @@ 
Flags

+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
-
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

 
 
 
 
allfalseSelect all resources, including uninitialized ones, in the namespace of the specified resource types 
dry-runfalseIf true, only print the object that would be sent, without sending it. 

 filename
 f
 []
 Filename, directory, or URL to files identifying the resource to get from a server. 
 

 
recursiveRinclude-uninitialized
 falseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. If true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
 

 
revisionlocal
 0Pin to a specific revision for showing its status. Defaults to 0 (last revision). falseIf true, set serviceaccount will NOT contact api-server but run locally. 
 

 
watchwtrueWatch the status of the rollout until it's done. outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
 

 

-
undo

+
subject

 

-
 Rollback to the previous deployment

+
 Update a ClusterRoleBinding for serviceaccount1

 

-
kubectl rollout undo deployment/abc
+
kubectl set subject clusterrolebinding admin --serviceaccount=namespace:serviceaccount1
 

 

-
 Rollback to daemonset revision 3

+
 Update a RoleBinding for user1, user2, and group1

 

-
kubectl rollout undo daemonset/abc --to-revision=3
+
kubectl set subject rolebinding admin --user=user1 --user=user2 --group=group1
 

 

-
 Rollback to the previous deployment with dry-run

+
 Print the result (in yaml format) of updating rolebinding subjects from a local, without hitting the server

 

-
kubectl rollout undo --dry-run=true deployment/abc
+
kubectl create rolebinding admin --role=admin --user=admin -o yaml --dry-run | kubectl set subject --local -f - --user=foo -o yaml
 

-
Rollback to a previous rollout.

+
Update User, Group or ServiceAccount in a RoleBinding/ClusterRoleBinding.

 
Usage

-
$ undo (TYPE NAME | TYPE/NAME) [flags]

+
$ subject (-f FILENAME | TYPE NAME) [--user=username] [--group=groupname] [--serviceaccount=namespace:serviceaccountname] [--dry-run]

 
Flags

 
@@ -4948,6 +4559,12 @@ 
Flags

+
+
+
+
+
+
@@ -4957,7 +4574,31 @@ 
Flags

-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -4966,45 +4607,23 @@ 
Flags

-
+
+
-
-
+
+
+
+
+
+
+

 
 
 
 
allfalseSelect all resources, including uninitialized ones, in the namespace of the specified resource types 

 dry-run
 
 false
 filename
 f
 []Filename, directory, or URL to files identifying the resource to get from a server. Filename, directory, or URL to files the resource to update the subjects 
group[]Groups to bind to the role 
include-uninitializedfalseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
localfalseIf true, set subject will NOT contact api-server but run locally. 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 

 recursive
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
to-revisionselectorl
 0The revision to rollback to. Default to 0 (last revision). Selector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
serviceaccount[]Service accounts to bind to the role 
 

 
 

 

-
scale

-

-
 Scale a replicaset named 'foo' to 3.

-

-
kubectl scale --replicas=3 rs/foo
-

-

-
 Scale a resource identified by type and name specified in "foo.yaml" to 3.

-

-
kubectl scale --replicas=3 -f foo.yaml
-

-

-
 If the deployment named mysql's current size is 2, scale mysql to 3.

-

-
kubectl scale --current-replicas=2 --replicas=3 deployment/mysql
-

-

-
 Scale multiple replication controllers.

-

-
kubectl scale --replicas=5 rc/foo rc/bar rc/baz
-

-

-
 Scale statefulset named 'web' to 3.

-

-
kubectl scale --replicas=3 statefulset/web
-

-
Set a new size for a Deployment, ReplicaSet, Replication Controller, or StatefulSet. 

-
Scale also allows users to specify one or more preconditions for the scale action. 

-
If --current-replicas or --resource-version is specified, it is validated before the scale is attempted, and it is guaranteed that the precondition holds true when the scale is sent to the server.

+
wait

 
Usage

-
$ scale [--resource-version=version] [--current-replicas=count] --replicas=COUNT (-f FILENAME | TYPE NAME)

+
$ wait resource.group/name [--for=delete|--for condition=available]

 
Flags

 
@@ -5017,60 +4636,36 @@ 
Flags

-
+
-
-
-
-
-
-
-
+
-
+
-
+
-
-
+
+
-
-
-
-
-
-
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
@@ -5079,76 +4674,122 @@ 
Flags

-
-
+
+

 
 
 
 
allall-namespaces
 
 falseSelect all resources in the namespace of the specified resource types 
current-replicas-1Precondition for current size. Requires that the current size of the resource match this value in order to scale. If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. 
 

 

 filename
 f
 []Filename, directory, or URL to files identifying the resource to set a new size identifying the resource. 
 

 
include-extended-apisfor
 trueIf true, include definitions of new APIs via calls to the API server. [default true] The condition to wait on: [delete|condition=condition-name]. 
 

 

 output
 o
 Output mode. Use "-o name" for shorter output (resource/name). 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 

 recursive
 Rfalsetrue
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
replicas-1The new desired number of replicas. Required. 
resource-versionPrecondition for resource version. Requires that the current resource version match this value in order to scale. 

 selector
 l
 
 

 timeout
 0sThe length of time to wait before giving up on a scale operation, zero means don't wait. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). 30sThe length of time to wait before giving up.  Zero means check once and don't wait, negative means wait for a week. 
 

 
 

+
WORKING WITH APPS

+
This section contains commands for inspecting and debugging your
+applications.

+
    
+
  • logs will print the logs from the specified pod + container.
    • 
+
  • exec can be used to get an interactive shell on a pod + container.
    • 
+
  • describe will print debug information about the given resource.
    • 
+

 

-
set

-
Configure application resources 

-
These commands help you make changes to existing application resources.

-
Usage

-
$ set SUBCOMMAND

-

-
env

+
attach

 

-
 Update deployment 'registry' with a new environment variable

+
 Get output from running pod 123456-7890, using the first container by default

 

-
kubectl set env deployment/registry STORAGE_DIR=/local
+
kubectl attach 123456-7890
 

 

-
 List the environment variables defined on a deployments 'sample-build'

+
 Get output from ruby-container from pod 123456-7890

 

-
kubectl set env deployment/sample-build --list
+
kubectl attach 123456-7890 -c ruby-container
 

 

-
 List the environment variables defined on all pods

+
 Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-7890 # and sends stdout/stderr from 'bash' back to the client

 

-
kubectl set env pods --all --list
+
kubectl attach 123456-7890 -c ruby-container -i -t
 

 

-
 Output modified deployment in YAML, and does not alter the object on the server

+
 Get output from the first pod of a ReplicaSet named nginx

 

-
kubectl set env deployment/sample-build STORAGE_DIR=/data -o yaml
+
kubectl attach rs/nginx
 

-

-
 Update all containers in all replication controllers in the project to have ENV=prod

+
Attach to a process that is already running inside an existing container.

+
Usage

+
$ attach (POD | TYPE/NAME) -c CONTAINER

+
Flags

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameShorthandDefaultUsage
containercContainer name. If omitted, the first container in the pod will be chosen 
pod-running-timeout1m0sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running 
stdinifalsePass stdin to the container 
ttytfalseStdin is a TTY 

+

+
auth

+
Inspect authorization

+
Usage

+
$ auth

+

+
can-i

+

+
 Check to see if I can create pods in any namespace

 

-
kubectl set env rc --all ENV=prod
+
kubectl auth can-i create pods --all-namespaces
 

 

-
 Import environment from a secret

+
 Check to see if I can list deployments in my current namespace

 

-
kubectl set env --from=secret/mysecret deployment/myapp
+
kubectl auth can-i list deployments.extensions
 

 

-
 Import environment from a config map with a prefix

+
 Check to see if I can do everything in my current namespace ("*" means all)

 

-
kubectl set env --from=configmap/myconfigmap --prefix=MYSQL_ deployment/myapp
+
kubectl auth can-i '*' '*'
 

 

-
 Remove the environment variable ENV from container 'c1' in all deployment configs

+
 Check to see if I can get the job named "bar" in namespace "foo"

 

-
kubectl set env deployments --all --containers="c1" ENV-
+
kubectl auth can-i list jobs.batch/bar -n foo
 

 

-
 Remove the environment variable ENV from a deployment definition on disk and # update the deployment config on the server

+
 Check to see if I can read pod logs

 

-
kubectl set env -f deploy.json ENV-
+
kubectl auth can-i get pods --subresource=log
 

 

-
 Set some of the local shell environment into a deployment config on the server

+
 Check to see if I can access the URL /logs/

 

-
env | grep RAILS_ | kubectl set env -e - deployment/registry
+
kubectl auth can-i get /logs/
 

-
Update environment variables on a pod template. 

-
List environment variable definitions in one or more pods, pod templates. Add, update, or remove container environment variable definitions in one or more pod templates (within replication controllers or deployment configurations). View or modify the environment variable definitions on all containers in the specified pods or pod templates, or just those that match a wildcard. 

-
If "--env -" is passed, environment variables can be read from STDIN using the standard env syntax. 

-
Possible resources include (case insensitive): 

-
  pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), job, replicaset (rs)

+
Check whether an action is allowed. 

+
VERB is a logical Kubernetes API verb like 'get', 'list', 'watch', 'delete', etc. TYPE is a Kubernetes resource. Shortcuts and groups will be resolved. NONRESOURCEURL is a partial URL starts with "/". NAME is the name of a particular Kubernetes resource.

 
Usage

-
$ env RESOURCE/NAME KEY_1=VAL_1 ... KEY_N=VAL_N

+
$ can-i VERB [TYPE | TYPE/NAME | NONRESOURCEURL]

 
Flags

 
@@ -5161,64 +4802,58 @@ 
Flags

-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
+
+
+

 
 
 
 
allall-namespaces
 
 falseIf true, select all resources in the namespace of the specified resource types 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
containersc*The names of containers in the selected pod templates to change - may use wildcards If true, check the specified action in all namespaces. 
 

 
dry-runquietq
 falseIf true, only print the object that would be sent, without sending it. 
enve[]Specify a key-value pair for an environment variable to set into each container. 
filenamef[]Filename, directory, or URL to files the resource to update the env If true, suppress output and just return the exit code. 
 

 
fromsubresource
 
 The name of a resource from which to inject environment variables SubResource such as pod/log or deployment/scale 
 

+

+
reconcile

+

+
 Reconcile rbac resources from a file

+

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

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

+
This is preferred to 'apply' for RBAC resources so that proper rule coverage checks are done.

+
Usage

+
$ reconcile -f FILENAME

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -5227,94 +4862,38 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

 
listfalseIf true, display the environment and any changes in the standard format. this flag will removed when we have kubectl view env. NameShorthandDefaultUsage
 

 
localdry-run
 
 falseIf true, set env will NOT contact api-server but run locally. If true, display results but do not submit changes 
 

 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). filenamef[]Filename, directory, or URL to files identifying the resource to reconcile. 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
overwritetrueIf true, allow environment to be overwritten, otherwise reject updates that overwrite existing environment. 
prefixPrefix to append to variable names 

 recursive
 R
 false
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 
resolvefalseIf true, show secret or configmap references when listing variables 
selectorlSelector (label query) to filter on 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 

 
 

 

-
image

+
cp

 

-
 Set a deployment's nginx container image to 'nginx:1.9.1', and its busybox container image to 'busybox'.

+
 !!!Important Note!!! # Requires that the 'tar' binary is present in your container # image.  If 'tar' is not present, 'kubectl cp' will fail. # Copy /tmp/foo_dir local directory to /tmp/bar_dir in a remote pod in the default namespace

 

-
kubectl set image deployment/nginx busybox=busybox nginx=nginx:1.9.1
+
kubectl cp /tmp/foo_dir <some-pod>:/tmp/bar_dir
 

 

-
 Update all deployments' and rc's nginx container's image to 'nginx:1.9.1'

+
 Copy /tmp/foo local file to /tmp/bar in a remote pod in a specific container

 

-
kubectl set image deployments,rc nginx=nginx:1.9.1 --all
+
kubectl cp /tmp/foo <some-pod>:/tmp/bar -c <specific-container>
 

 

-
 Update image of all containers of daemonset abc to 'nginx:1.9.1'

+
 Copy /tmp/foo local file to /tmp/bar in a remote pod in namespace 

 

-
kubectl set image daemonset abc *=nginx:1.9.1
+
kubectl cp /tmp/foo <some-namespace>/<some-pod>:/tmp/bar
 

 

-
 Print result (in yaml format) of updating nginx container image from local file, without hitting the server

+
 Copy /tmp/foo from a remote pod to /tmp/bar locally

 

-
kubectl set image -f path/to/file.yaml nginx=nginx:1.9.1 --local -o yaml
+
kubectl cp <some-namespace>/<some-pod>:/tmp/foo /tmp/bar
 

-
Update existing container image(s) of resources. 

-
Possible resources include (case insensitive): 

-
  pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), replicaset (rs)

+
Copy files and directories to and from containers.

 
Usage

-
$ image (-f FILENAME | TYPE NAME) CONTAINER_NAME_1=CONTAINER_IMAGE_1 ... CONTAINER_NAME_N=CONTAINER_IMAGE_N

+
$ cp <file-spec-src> <file-spec-dest>

 
Flags

 
@@ -5327,64 +4906,80 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+

 
 
 
 
allfalseSelect all resources, including uninitialized ones, in the namespace of the specified resource types 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
dry-runcontainerc
 falseIf true, only print the object that would be sent, without sending it. 
filenamef[]Filename, directory, or URL to files identifying the resource to get from a server. 
include-uninitializedfalseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. Container name. If omitted, the first container in the pod will be chosen 
 

+

+
describe

+

+
 Describe a node

+

+
kubectl describe nodes kubernetes-node-emt8.c.myproject.internal
+

+

+
 Describe a pod

+

+
kubectl describe pods/nginx
+

+

+
 Describe a pod identified by type and name in "pod.json"

+

+
kubectl describe -f pod.json
+

+

+
 Describe all pods

+

+
kubectl describe pods
+

+

+
 Describe pods by label name=myLabel

+

+
kubectl describe po -l name=myLabel
+

+

+
 Describe all pods managed by the 'frontend' replication controller (rc-created pods # get the name of the rc as a prefix in the pod the name).

+

+
kubectl describe pods frontend
+

+
Show details of a specific resource or group of resources 

+
Print a detailed description of the selected resources, including related resources such as events or controllers. You may select a single object by name, all objects of that type, provide a name prefix, or label selector. For example: 

+
  $ kubectl describe TYPE NAME_PREFIX

+
will first check for an exact match on TYPE and NAME PREFIX. If no such resource exists, it will output details for every resource that has a name prefixed with NAME PREFIX.

+
Use "kubectl api-resources" for a complete list of supported resources.

+
Usage

+
$ describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME)

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
+
-
-
-
-
-
-
-
+
-
-
-
-
+
+
+
+
-
+
-
+
@@ -5396,61 +4991,128 @@ 
Flags

-
+
-
-
+
+
-
+
+
+

 
localfalseIf true, set image will NOT contact api-server but run locally. NameShorthandDefaultUsage
 

 
no-headersall-namespaces
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). filenamef[]Filename, directory, or URL to files containing the resource to describe 
 

 
recordinclude-uninitialized
 
 falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. If true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
 

 

 recursive
 selector
 l
 Selector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
 

 
show-allashow-events
 trueWhen printing, show all resources (default show all pods including terminated one.) If true, display events related to the described object. 
 

+

+
exec

+

+
 Get output from running 'date' from pod 123456-7890, using the first container by default

+

+
kubectl exec 123456-7890 date
+

+

+
 Get output from running 'date' in ruby-container from pod 123456-7890

+

+
kubectl exec 123456-7890 -c ruby-container date
+

+

+
 Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-7890 # and sends stdout/stderr from 'bash' back to the client

+

+
kubectl exec 123456-7890 -c ruby-container -i -t -- bash -il
+

+

+
 List contents of /usr from the first container of pod 123456-7890 and sort by modification time. # If the command you want to execute in the pod has any flags in common (e.g. -i), # you must use two dashes (--) to separate your command's flags/arguments. # Also note, do not surround your command and its flags/arguments with quotes # unless that is how you would execute it normally (i.e., do ls -t /usr, not "ls -t /usr").

+

+
kubectl exec 123456-7890 -i -t -- ls -t /usr
+

+
Execute a command in a container.

+
Usage

+
$ exec POD [-c CONTAINER] -- COMMAND [args...]

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
-
+
+
-
+
-
-
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+

 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) NameShorthandDefaultUsage
 

 
sort-bycontainerc
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Container name. If omitted, the first container in the pod will be chosen 
 

 
templatepodp
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. Pod name 
stdinifalsePass stdin to the container 
ttytfalseStdin is a TTY 
 

 
 

 

-
resources

+
logs

 

-
 Set a deployments nginx container cpu limits to "200m" and memory to "512Mi"

+
 Return snapshot logs from pod nginx with only one container

 

-
kubectl set resources deployment nginx -c=nginx --limits=cpu=200m,memory=512Mi
+
kubectl logs nginx
 

 

-
 Set the resource request and limits for all containers in nginx

+
 Return snapshot logs from pod nginx with multi containers

 

-
kubectl set resources deployment nginx --limits=cpu=200m,memory=512Mi --requests=cpu=100m,memory=256Mi
+
kubectl logs nginx --all-containers=true
 

 

-
 Remove the resource requests for resources on containers in nginx

+
 Return snapshot logs from all containers in pods defined by label app=nginx

 

-
kubectl set resources deployment nginx --limits=cpu=0,memory=0 --requests=cpu=0,memory=0
+
kubectl logs -lapp=nginx --all-containers=true
 

 

-
 Print the result (in yaml format) of updating nginx container limits from a local, without hitting the server

+
 Return snapshot of previous terminated ruby container logs from pod web-1

 

-
kubectl set resources -f path/to/file.yaml --limits=cpu=200m,memory=512Mi --local -o yaml
+
kubectl logs -p -c ruby web-1
 

-
Specify compute resource requirements (cpu, memory) for any resource that defines a pod template.  If a pod is successfully scheduled, it is guaranteed the amount of resource requested, but may burst up to its specified limits. 

-
for each compute resource, if a limit is specified and a request is omitted, the request will default to the limit. 

-
Possible resources include (case insensitive): replicationcontroller, deployment, daemonset, job, replicaset.

+

+
 Begin streaming the logs of the ruby container in pod web-1

+

+
kubectl logs -f -c ruby web-1
+

+

+
 Display only the most recent 20 lines of output in pod nginx

+

+
kubectl logs --tail=20 nginx
+

+

+
 Show all logs from pod nginx written in the last hour

+

+
kubectl logs --since=1h nginx
+

+

+
 Return snapshot logs from first container of a job named hello

+

+
kubectl logs job/hello
+

+

+
 Return snapshot logs from container nginx-1 of a deployment named nginx

+

+
kubectl logs deployment/nginx -c nginx-1
+

+
Print the logs for a container in a pod or specified resource. If the pod has only one container, the container name is optional.

 
Usage

-
$ resources (-f FILENAME | TYPE NAME)  ([--limits=LIMITS & --requests=REQUESTS]

+
$ logs [-f] [-p] (POD | TYPE/NAME) [-c CONTAINER]

 
Flags

 
@@ -5463,133 +5125,160 @@ 
Flags

-
+
-
-
-
-
-
-
-
+
-
+
-
-
-
-
-
-
-
+
-
+
-
-
+
+
-
+
-
+
-
-
+
-
+
+
-
+
+
+
+
+
+
+
-
+
-
+
+
-
-
+
-
-
+
-
+
+
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
+
+
-
+
-
+
+
+

 
 
 
 
allall-containers
 
 falseSelect all resources, including uninitialized ones, in the namespace of the specified resource types 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. Get all containers's logs in the pod(s). 
 

 
containerscontainer
 c*The names of containers in the selected pod templates to change, all containers are selected by default - may use wildcards 
dry-run
 falseIf true, only print the object that would be sent, without sending it. Print the logs of this container 
 

 
filenamefollow
 f[]Filename, directory, or URL to files identifying the resource to get from a server. falseSpecify if the logs should be streamed. 
 

 
include-uninitializedinteractive
 
 falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. If true, prompt the user for input when required. 
 

 
limitslimit-bytes
 The resource requirement requests for this container.  For example, 'cpu=100m,memory=256Mi'.  Note that server side components may assign requests depending on the server configuration, such as limit ranges. 0Maximum bytes of logs to return. Defaults to no limit. 
 

 
localpod-running-timeout
 20sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running 
previousp
 falseIf true, set resources will NOT contact api-server but run locally. If true, print the logs for the previous instance of the container in a pod if it exists. 
 

 
no-headersselectorl
 falseWhen using the default or custom-column output format, don't print headers (default print headers). Selector (label query) to filter on. 
 

 
outputosince
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 0sOnly return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since-time / since may be used. 
 

 
output-versionsince-time
 
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since-time / since may be used. 
 

 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
requestsThe resource requirement requests for this container.  For example, 'cpu=100m,memory=256Mi'.  Note that server side components may assign requests depending on the server configuration, such as limit ranges. 
selectorltail
 Selector (label query) to filter on, not including uninitialized ones,supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) -1Lines of recent log file to display. Defaults to -1 with no selector, showing all log lines otherwise 10, if a selector is provided. 
 

 
show-labelstimestamps
 
 falseWhen printing, show all labels as the last column (default hide labels column) Include timestamps on each line in the log output 
 

+

+
port-forward

+

+
 Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod

+

+
kubectl port-forward pod/mypod 5000 6000
+

+

+
 Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in a pod selected by the deployment

+

+
kubectl port-forward deployment/mydeployment 5000 6000
+

+

+
 Listen on port 8888 locally, forwarding to 5000 in the pod

+

+
kubectl port-forward pod/mypod 8888:5000
+

+

+
 Listen on a random port locally, forwarding to 5000 in the pod

+

+
kubectl port-forward pod/mypod :5000
+

+
Forward one or more local ports to a pod. 

+
Use resource type/name such as deployment/mydeployment to select a pod. Resource type defaults to 'pod' if omitted. 

+
If there are multiple pods matching the criteria, a pod will be selected automatically. The forwarding session ends when the selected pod terminates, and rerun of the command is needed to resume forwarding.

+
Usage

+
$ port-forward TYPE/NAME [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMOTE_PORT_N]

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
-
+
-
+
+

 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. NameShorthandDefaultUsage
 

 
templatepod-running-timeout
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 1m0sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running 
 

 
 

 

-
selector

+
proxy

 

-
 set the labels and selector before creating a deployment/service pair.

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

 

-
kubectl create service clusterip my-svc --clusterip="None" -o yaml --dry-run | kubectl set selector --local -f - 'environment=qa' -o yaml | kubectl create -f -
-kubectl create deployment my-dep -o yaml --dry-run | kubectl label --local -f - environment=qa -o yaml | kubectl create -f -
+
$ kubectl proxy --api-prefix=/
 

-
Set the selector on a resource. Note that the new selector will overwrite the old selector if the resource had one prior to the invocation of 'set selector'. 

-
A selector must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to  63 characters. If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used. Note: currently selectors can only be set on Service objects.

+

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

+

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

+

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

+

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

+

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

+

+
kubectl proxy --port=8011 --www=./local/www/
+

+

+
 Run a proxy to kubernetes apiserver on an arbitrary local port. # The chosen port for the server will be output to stdout.

+

+
kubectl proxy --port=0
+

+

+
 Run a proxy to kubernetes apiserver, changing the api prefix to k8s-api # This makes e.g. the pods api available at localhost:8001/k8s-api/v1/pods/

+

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

+
Creates a proxy server or application-level gateway between localhost and the Kubernetes API Server. It also allows serving static content over specified HTTP path. All incoming data enters through one port and gets forwarded to the remote kubernetes API Server port, except for the path matching the static content path.

 
Usage

-
$ selector (-f FILENAME | TYPE NAME) EXPRESSIONS [--resource-version=version]

+
$ proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--api-prefix=prefix]

 
Flags

 
@@ -5602,120 +5291,96 @@ 
Flags

-
-
-
-
-
-
-
+
-
-
+
+
-
+
-
-
-
-
-
-
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
-
-
-
-
-
+
-
-
-
-
+
+
+
+
-
+
-
-
-
-
-
-
-
-
+
+
-
-
+
-
-
-
-
-
-
-
+
+
-
+
+
-
-
+
-
-
+
+
-
+
-
-
-
-
+
+
+
+

 
 
 
 
allfalseSelect all resources, including uninitialized ones, in the namespace of the specified resource types 
allow-missing-template-keysaccept-hosts
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. ^localhost$,^127.0.0.1$,^[::1]$Regular expression for hosts that the proxy should accept. 
 

 
dry-runaccept-paths
 falseIf true, only print the object that would be sent, without sending it. 
filenamef[]Filename, directory, or URL to files the resource to update the selectors ^.*Regular expression for paths that the proxy should accept. 
 

 
include-uninitializedaddress
 falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 127.0.0.1The IP address on which to serve on. 
 

 
localapi-prefix
 falseIf true, set selector will NOT contact api-server but run locally. /Prefix to serve the proxied API under. 
 

 
no-headersdisable-filter
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. If true, disable request filtering in the proxy. This is dangerous, and can leave you vulnerable to XSRF attacks, when used with an accessible port. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). portp8001The port on which to run the proxy. Set to 0 to pick a random port. 
 

 
recordreject-methods
 falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. ^$Regular expression for HTTP methods that the proxy should reject (example --reject-methods='POST,PUT,PATCH').  
 

 
resource-versionreject-paths
 If non-empty, the selectors update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) ^/api/./pods/./exec,^/api/./pods/./attachRegular expression for paths that the proxy should reject. Paths specified here will be rejected even accepted by --accept-paths. 
 

 
show-labelsunix-socketu
 falseWhen printing, show all labels as the last column (default hide labels column) Unix socket on which to run the proxy. 
 

 
sort-bywwww
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Also serve static files from the given directory under the specified prefix. 
 

 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. www-prefixP/static/Prefix to serve static files under, if static file directory is specified. 
 

 
 

 

-
serviceaccount

+
top

+
Display Resource (CPU/Memory/Storage) usage. 

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

+
This command requires Heapster to be correctly configured and working on the server.

+
Usage

+
$ top

+

+
node

 

-
 Set Deployment nginx-deployment's ServiceAccount to serviceaccount1

+
 Show metrics for all nodes

 

-
kubectl set serviceaccount deployment nginx-deployment serviceaccount1
+
kubectl top node
 

 

-
 Print the result (in yaml format) of updated nginx deployment with serviceaccount from local file, without hitting apiserver

+
 Show metrics for a given node

 

-
kubectl set sa -f nginx-deployment.yaml serviceaccount1 --local --dry-run -o yaml
+
kubectl top node NODE_NAME
 

-
Update ServiceAccount of pod template resources. 

-
Possible resources (case insensitive) can be: 

-
replicationcontroller (rc), deployment (deploy), daemonset (ds), job, replicaset (rs), statefulset

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

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

 
Usage

-
$ serviceaccount (-f FILENAME | TYPE NAME) SERVICE_ACCOUNT

+
$ node [NAME | -l label]

 
Flags

 
@@ -5728,117 +5393,142 @@ 
Flags

-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
-
+
+
-
-
+
+
+

 
 
 
 
allheapster-namespace
 falseSelect all resources, including uninitialized ones, in the namespace of the specified resource types kube-systemNamespace Heapster service is located in 
 

 
allow-missing-template-keysheapster-port
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. Port name in service to use 
 

 
dry-runheapster-scheme
 falseIf true, only print the object that would be sent, without sending it. httpScheme (http or https) to connect to Heapster as 
 

 
filenamef[]Filename, directory, or URL to files identifying the resource to get from a server. heapster-serviceheapsterName of Heapster service 
 

 
include-uninitializedselectorl
 falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
 

+

+
pod

+

+
 Show metrics for all pods in the default namespace

+

+
kubectl top pod
+

+

+
 Show metrics for all pods in the given namespace

+

+
kubectl top pod --namespace=NAMESPACE
+

+

+
 Show metrics for a given pod and its containers

+

+
kubectl top pod POD_NAME --containers
+

+

+
 Show metrics for the pods defined by label name=myLabel

+

+
kubectl top pod -l name=myLabel
+

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

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

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

+
Usage

+
$ pod [NAME | -l label]

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
+
-
+
-
-
+
-
+
+
-
-
+
-
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
+
-
-
+
+
-
-
+
-
+
+
-
-
+
+
-
+

 
localfalseIf true, set serviceaccount will NOT contact api-server but run locally. NameShorthandDefaultUsage
 

 
no-headersall-namespaces
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. 
 

 
outputocontainers
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. falseIf present, print usage of containers within a pod. 
 

 
output-versionheapster-namespace
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). kube-systemNamespace Heapster service is located in 
 

 
recordheapster-port
 falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) Port name in service to use 
 

 
show-labelsheapster-scheme
 falseWhen printing, show all labels as the last column (default hide labels column) httpScheme (http or https) to connect to Heapster as 
 

 
sort-byheapster-service
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. heapsterName of Heapster service 
 

 
templateselectorl
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
 

 
 

+
CLUSTER MANAGEMENT

 

-
subject

-

-
 Update a ClusterRoleBinding for serviceaccount1

-

-
kubectl set subject clusterrolebinding admin --serviceaccount=namespace:serviceaccount1
-

-

-
 Update a RoleBinding for user1, user2, and group1

-

-
kubectl set subject rolebinding admin --user=user1 --user=user2 --group=group1
-

+
api-versions

 

-
 Print the result (in yaml format) of updating rolebinding subjects from a local, without hitting the server

+
 Print the supported API versions

 

-
kubectl create rolebinding admin --role=admin --user=admin -o yaml --dry-run | kubectl set subject --local -f - --user=foo -o yaml
+
kubectl api-versions
 

-
Update User, Group or ServiceAccount in a RoleBinding/ClusterRoleBinding.

+
Print the supported API versions on the server, in the form of "group/version"

 
Usage

-
$ subject (-f FILENAME | TYPE NAME) [--user=username] [--group=groupname] [--serviceaccount=namespace:serviceaccountname] [--dry-run]

+
$ api-versions

+

+
certificate

+
Modify certificate resources.

+
Usage

+
$ certificate SUBCOMMAND

+

+
approve

+
Approve a certificate signing request. 

+
kubectl certificate approve allows a cluster admin to approve a certificate signing request (CSR). This action tells a certificate signing controller to issue a certificate to the requestor with the attributes requested in the CSR. 

+
SECURITY NOTICE: Depending on the requested attributes, the issued certificate can potentially grant a requester access to cluster resources or to authenticate as a requested identity. Before approving a CSR, ensure you understand what the signed certificate can do.

+
Usage

+
$ approve (-f FILENAME | NAME)

 
Flags

 
@@ -5851,52 +5541,16 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
+
@@ -5905,83 +5559,92 @@ 
Flags

-
-
-
-
-
-
+
+

 
 
 
 
allfalseSelect all resources, including uninitialized ones, in the namespace of the specified resource types 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
dry-runfalseIf true, only print the object that would be sent, without sending it. 

 filename
 f
 []Filename, directory, or URL to files the resource to update the subjects 
group[]Groups to bind to the role 
include-uninitializedfalseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. 
localfalseIf true, set subject will NOT contact api-server but run locally. Filename, directory, or URL to files identifying the resource to update 
 

 
no-headersforce
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). Update the CSR even if it is already approved. 
 

 

 output
 Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 

 recursive
 R
 false
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

+

+
deny

+
Deny a certificate signing request. 

+
kubectl certificate deny allows a cluster admin to deny a certificate signing request (CSR). This action tells a certificate signing controller to not to issue a certificate to the requestor.

+
Usage

+
$ deny (-f FILENAME | NAME)

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
-
+
+
-
-
-
-
-
-
-
+
-
+
-
+
-
-
+
+
-
+
-
-
-
-
+
+
+
+

 
selectorlSelector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) NameShorthandDefaultUsage
 

 
serviceaccountfilenamef
 []Service accounts to bind to the role 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) Filename, directory, or URL to files identifying the resource to update 
 

 
show-labelsforce
 
 falseWhen printing, show all labels as the last column (default hide labels column) Update the CSR even if it is already denied. 
 

 
sort-byoutputo
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
 

-
DECLARATIVE APP MANAGEMENT

 

-
apply

+
cluster-info

 

-
 Apply the configuration in pod.json to a pod.

+
 Print the address of the master and cluster services

 

-
kubectl apply -f ./pod.json
+
kubectl cluster-info
 

+
Display addresses of the master and services with label kubernetes.io/cluster-service=true To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.

+
Usage

+
$ cluster-info

+

+
dump

 

-
 Apply the JSON passed into stdin to a pod.

+
 Dump current cluster state to stdout

 

-
cat pod.json | kubectl apply -f -
+
kubectl cluster-info dump
 

 

-
 Note: --prune is still in Alpha # Apply the configuration in manifest.yaml that matches label app=nginx and delete all the other resources that are not in the file and match label app=nginx.

+
 Dump current cluster state to /path/to/cluster-state

 

-
kubectl apply --prune -f manifest.yaml -l app=nginx
+
kubectl cluster-info dump --output-directory=/path/to/cluster-state
 

 

-
 Apply the configuration in manifest.yaml and delete all the other configmaps that are not in the file.

+
 Dump all namespaces to stdout

 

-
kubectl apply --prune -f manifest.yaml --all --prune-whitelist=core/v1/ConfigMap
+
kubectl cluster-info dump --all-namespaces
 

-
Apply a configuration to a resource by filename or stdin. The resource name must be specified. This resource will be created if it doesn't exist yet. To use 'apply', always create the resource initially with either 'apply' or 'create --save-config'. 

-
JSON and YAML formats are accepted. 

-
Alpha Disclaimer: the --prune functionality is not yet complete. Do not use unless you are aware of what the current state is. See https://issues.k8s.io/34274.

+

+
 Dump a set of namespaces to /path/to/cluster-state

+

+
kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state
+

+
Dumps cluster info out suitable for debugging and diagnosing cluster problems.  By default, dumps everything to stdout. You can optionally specify a directory with --output-directory.  If you specify a directory, kubernetes will build a set of files in that directory.  By default only dumps things in the 'kube-system' namespace, but you can switch to a different namespace with the --namespaces flag, or specify --all-namespaces to dump all namespaces. 

+
The command also dumps the logs of all of the pods in the cluster, these logs are dumped into different directories based on namespace and pod name.

 
Usage

-
$ apply -f FILENAME

+
$ dump

 
Flags

 
@@ -5994,176 +5657,179 @@ 
Flags

-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
-
-
-
-
-
-
+
-
+
-
-
-
-
-
-
-
+
-
+
-
-
+
+
+
+

 
 
 
 
allall-namespaces
 
 falseSelect all resources in the namespace of the specified resource types. 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
cascadetrueOnly relevant during a prune or a force apply. If true, cascade the deletion of the resources managed by pruned or deleted resources (e.g. Pods created by a ReplicationController). If true, dump all namespaces.  If true, --namespaces is ignored. 
 

 
dry-runnamespaces
 falseIf true, only print the object that would be sent, without sending it. 
filenamef
 []Filename, directory, or URL to files that contains the configuration to apply A comma separated list of namespaces to dump. 
 

 
forceoutput-directory
 falseDelete and re-create the specified resource, when PATCH encounters conflict and has retried for 5 times. 
grace-period
 -1Only relevant during a prune or a force apply. Period of time in seconds given to pruned or deleted resources to terminate gracefully. Ignored if negative. Where to output the files.  If empty or '-' uses stdout, otherwise creates a directory hierarchy in that directory 
 

 
include-extended-apispod-running-timeout
 trueIf true, include definitions of new APIs via calls to the API server. [default true] 20sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running 
 

+

+
cordon

+

+
 Mark node "foo" as unschedulable.

+

+
kubectl cordon foo
+

+
Mark node as unschedulable.

+
Usage

+
$ cordon NODE

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
+
+
-
+
+
+

 
include-uninitializedfalseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. NameShorthandDefaultUsage
 

 
no-headersdry-run
 
 falseWhen using the default or custom-column output format, don't print headers (default print headers). 
openapi-patchtrueIf true, use openapi to calculate diff when the openapi presents and the resource can be found in the openapi spec. Otherwise, fall back to use baked-in types. 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. If true, only print the object that would be sent, without sending it. 
 

 
output-versionselectorl
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). Selector (label query) to filter on 
 

+

+
drain

+

+
 Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet on it.

+

+
$ kubectl drain foo --force
+

+

+
 As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet, and use a grace period of 15 minutes.

+

+
$ kubectl drain foo --grace-period=900
+

+
Drain node in preparation for maintenance. 

+
The given node will be marked unschedulable to prevent new pods from arriving. 'drain' evicts the pods if the APIServer supports eviction (http://kubernetes.io/docs/admin/disruptions/). Otherwise, it will use normal DELETE to delete the pods. The 'drain' evicts or deletes all pods except mirror pods (which cannot be deleted through the API server).  If there are DaemonSet-managed pods, drain will not proceed without --ignore-daemonsets, and regardless it will not delete any DaemonSet-managed pods, because those pods would be immediately replaced by the DaemonSet controller, which ignores unschedulable markings.  If there are any pods that are neither mirror pods nor managed by ReplicationController, ReplicaSet, DaemonSet, StatefulSet or Job, then drain will not delete any pods unless you use --force.  --force will also allow deletion to proceed if the managing resource of one or more pods is missing. 

+
'drain' waits for graceful termination. You should not operate on the machine until the command completes. 

+
When you are ready to put the node back into service, use kubectl uncordon, which will make the node schedulable again. 

+
! http://kubernetes.io/images/docs/kubectl_drain.svg

+
Usage

+
$ drain NODE

+
Flags

+
+
-
-
-
-
+
+
+
+
+
+
-
+
-
-
-
-
-
-
-
+
-
+
-
+
-
-
+
+
-
+
-
-
+
-
-
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
-
+
+
-
+
-
-
-
-
-
-
-
+

 
overwritetrueAutomatically resolve conflicts between the modified and live configuration by using values from the modified configuration NameShorthandDefaultUsage
 

 
prunedelete-local-data
 
 falseAutomatically delete resource objects, including the uninitialized ones, that do not appear in the configs and are created by either apply or create --save-config. Should be used with either -l or --all. 
prune-whitelist[]Overwrite the default whitelist with  for --prune Continue even if there are pods using emptyDir (local data that will be deleted when the node is drained). 
 

 
recorddry-run
 
 falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. If true, only print the object that would be sent, without sending it. 
 

 
recursiveRforce
 falseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. Continue even if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet. 
 

 
selectorlgrace-period
 Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) -1Period of time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used. 
 

 
show-labelsignore-daemonsets
 
 falseWhen printing, show all labels as the last column (default hide labels column) Ignore DaemonSet-managed pods. 
 

 
sort-bypod-selector
 
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. Label selector to filter pods on the node 
 

 
templateselectorl
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. Selector (label query) to filter on 
 

 

 timeout
 
 0sOnly relevant during a force apply. The length of time to wait before giving up on a delete of the old resource, zero means determine a timeout from the size of the object. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). 
validatetrueIf true, use a schema to validate the input before sending it The length of time to wait before giving up, zero means infinite 
 

 
 

 

-
edit-last-applied

+
taint

 

-
 Edit the last-applied-configuration annotations by type/name in YAML.

+
 Update node 'foo' with a taint with key 'dedicated' and value 'special-user' and effect 'NoSchedule'. # If a taint with that key and effect already exists, its value is replaced as specified.

 

-
kubectl apply edit-last-applied deployment/nginx
+
kubectl taint nodes foo dedicated=special-user:NoSchedule
 

 

-
 Edit the last-applied-configuration annotations by file in JSON.

+
 Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists.

 

-
kubectl apply edit-last-applied -f deploy.yaml -o json
+
kubectl taint nodes foo dedicated:NoSchedule-
 

-
Edit the latest last-applied-configuration annotations of resources from the default editor. 

-
The edit-last-applied command allows you to directly edit any API resource you can retrieve via the command line tools. It will open the editor defined by your KUBE _EDITOR, or EDITOR environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multiple objects, although changes are applied one at a time. The command accepts filenames as well as command line arguments, although the files you point to must be previously saved versions of resources. 

-
The default format is YAML. To edit in JSON, specify "-o json". 

-
The flag --windows-line-endings can be used to force Windows line endings, otherwise the default for your operating system will be used. 

-
In the event an error occurs while updating, a temporary file will be created on disk that contains your unapplied changes. The most common error when updating a resource is another editor changing the resource on the server. When this occurs, you will have to apply your changes to the newer version of the resource, or update your temporary saved copy to include the latest resource version.

+

+
 Remove from node 'foo' all the taints with key 'dedicated'

+

+
kubectl taint nodes foo dedicated-
+

+

+
 Add a taint with key 'dedicated' on nodes having label mylabel=X

+

+
kubectl taint node -l myLabel=X  dedicated=foo:PreferNoSchedule
+

+
Update the taints on one or more nodes. 

+
    
+
  • A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect.  
    • 
+
  • The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to  253 characters.  
    • 
+
  • Optionally, the key can begin with a DNS subdomain prefix and a single '/', like example.com/my-app  
    • 
+
  • The value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to  63 characters.  
    • 
+
  • The effect must be NoSchedule, PreferNoSchedule or NoExecute.  
    • 
+
  • Currently taint can only apply to node.
    • 
+

 
Usage

-
$ edit-last-applied (RESOURCE/NAME | -f FILENAME)

+
$ taint NODE NAME KEY_1=VAL_1:TAINT_EFFECT_1 ... KEY_N=VAL_N:TAINT_EFFECT_N

 
Flags

 
@@ -6176,63 +5842,47 @@ 
Flags

-
-
-
-
-
-
-
+
-
+
-
-
+
+
-
+
-
+
-
-
-
-
+
+
+
+
-
+
-
-
+
+

 
 
 
 
filenamef[]Filename, directory, or URL to files to use to edit the resource 
include-uninitializedall
 
 falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. Select all nodes in the cluster 
 

 

 output
 oyamlOutput format. One of: yaml|json. Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
recordoverwrite
 
 falseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. If true, allow taints to be overwritten, otherwise reject taint updates that overwrite existing taints. 
 

 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. selectorlSelector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
 

 
windows-line-endingsvalidate
 falseDefaults to the line ending native to your platform. trueIf true, use a schema to validate the input before sending it 
 

 
 

 

-
set-last-applied

+
uncordon

 

-
 Set the last-applied-configuration of a resource to match the contents of a file.

+
 Mark node "foo" as schedulable.

 

-
kubectl apply set-last-applied -f deploy.yaml
-

-

-
 Execute set-last-applied against each configuration file in a directory.

-

-
kubectl apply set-last-applied -f path/
-

-

-
 Set the last-applied-configuration of a resource to match the contents of a file, will create the annotation if it does not already exist.

-

-
kubectl apply set-last-applied -f deploy.yaml --create-annotation=true
+
$ kubectl uncordon foo
 

-
Set the latest last-applied-configuration annotations by setting it to match the contents of a file. This results in the last-applied-configuration being updated as though 'kubectl apply -f ' was run, without updating any other parts of the object.

+
Mark node as schedulable.

 
Usage

-
$ set-last-applied -f FILENAME

+
$ uncordon NODE

 
Flags

 
@@ -6245,95 +5895,48 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
+

 
 
 
 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
create-annotationfalseWill create 'last-applied-configuration' annotations if current objects doesn't have one 

 dry-run
 
 false
 If true, only print the object that would be sent, without sending it. 
 

 
filenamef[]Filename, directory, or URL to files that contains the last-applied-configuration annotations 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
recordfalseRecord current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 
templateselectorl
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. Selector (label query) to filter on 
 

 
 

+
KUBECTL SETTINGS AND USAGE

 

-
view-last-applied

+
alpha

+
These commands correspond to alpha features that are not enabled in Kubernetes clusters by default.

+
Usage

+
$ alpha

+

+
diff

 

-
 View the last-applied-configuration annotations by type/name in YAML.

+
 Diff resources included in pod.json. By default, it will diff LOCAL and LIVE versions

 

-
kubectl apply view-last-applied deployment/nginx
+
kubectl alpha diff -f pod.json
 

 

-
 View the last-applied-configuration annotations by file in JSON

+
 When one version is specified, diff that version against LIVE

 

-
kubectl apply view-last-applied -f deploy.yaml -o json
+
cat service.yaml | kubectl alpha diff -f - MERGED
 

-
View the latest last-applied-configuration annotations by type/name or file. 

-
The default output will be printed to stdout in YAML format. One can use -o option to change output format.

+

+
 Or specify both versions

+

+
kubectl alpha diff -f pod.json -f service.yaml LAST LOCAL
+

+
Diff configurations specified by filename or stdin between their local, last-applied, live and/or "merged" versions. 

+
LOCAL and LIVE versions are diffed by default. Other available keywords are MERGED and LAST. 

+
Output is always YAML. 

+
KUBERNETES EXTERNAL DIFF environment variable can be used to select your own diff command. By default, the "diff" command available in your path will be run with "-u" (unicode) and "-N" (treat new files as empty) options.

 
Usage

-
$ view-last-applied (TYPE [NAME | -l label] | TYPE/NAME | -f FILENAME)

+
$ diff -f FILENAME

 
Flags

 
@@ -6346,22 +5949,10 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -6369,47 +5960,38 @@ 
Flags

-
-
-
-
-
-

 
 
 
 
allfalseSelect all resources in the namespace of the specified resource types 

 filename
 f
 []Filename, directory, or URL to files that contains the last-applied-configuration annotations 
outputoOutput format. Must be one of yaml|json Filename, directory, or URL to files contains the configuration to diff 
 

 

 recursive
 false
 Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 
selectorlSelector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 

 
 

-
WORKING WITH APPS

-
This section contains commands for inspecting and debugging your
-applications.

-
    
-
  • logs will print the logs from the specified pod + container.
    • 
-
  • exec can be used to get an interactive shell on a pod + container.
    • 
-
  • describe will print debug information about the given resource.
    • 
-

 

-
attach

+
api-resources

 

-
 Get output from running pod 123456-7890, using the first container by default

+
 Print the supported API Resources

 

-
kubectl attach 123456-7890
+
kubectl api-resources
 

 

-
 Get output from ruby-container from pod 123456-7890

+
 Print the supported API Resources with more information

 

-
kubectl attach 123456-7890 -c ruby-container
+
kubectl api-resources -o wide
 

 

-
 Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-7890 # and sends stdout/stderr from 'bash' back to the client

+
 Print the supported namespaced resources

 

-
kubectl attach 123456-7890 -c ruby-container -i -t
+
kubectl api-resources --namespaced=true
 

 

-
 Get output from the first pod of a ReplicaSet named nginx

+
 Print the supported non-namespaced resources

 

-
kubectl attach rs/nginx
+
kubectl api-resources --namespaced=false
 

-
Attach to a process that is already running inside an existing container.

+

+
 Print the supported API Resources with specific APIGroup

+

+
kubectl api-resources --api-group=extensions
+

+
Print the supported API resources on the server

 
Usage

-
$ attach (POD | TYPE/NAME) -c CONTAINER

+
$ api-resources

 
Flags

 
@@ -6422,77 +6004,164 @@ 
Flags

-
-
+
-
+
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
-
-
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+

 
 
 
 
containercapi-group
 Container name. If omitted, the first container in the pod will be chosen Limit to resources in the specified API group. 
 

 
pod-running-timeoutcached
 1m0sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running falseUse the cached list of resources if available. 
 

 
stdinifalsePass stdin to the container namespacedtrueIf false, non-namespaced resources will be returned, otherwise returning namespaced resources by default. 
 

 
ttytno-headers
 falseStdin is a TTY When using the default or custom-column output format, don't print headers (default print headers). 
outputoOutput format. One of: wide|name. 
verbs[]Limit to resources that support the specified verbs. 
 

 
 

 

-
auth

-
Inspect authorization

-
Usage

-
$ auth

-

-
can-i

+
completion

 

-
 Check to see if I can create pods in any namespace

+
 Installing bash completion on macOS using homebrew ## If running Bash 3.2 included with macOS

 

-
kubectl auth can-i create pods --all-namespaces
+
brew install bash-completion
+

+

+
 or, if running Bash 4.1+

+

+
brew install bash-completion@2
+

+

+
 If kubectl is installed via homebrew, this should start working immediately. ## If you've installed via other means, you may need add the completion to your completion directory

+

+
kubectl completion bash > $(brew --prefix)/etc/bash_completion.d/kubectl
 

 

-
 Check to see if I can list deployments in my current namespace

+
 Installing bash completion on Linux ## Load the kubectl completion code for bash into the current shell

 

-
kubectl auth can-i list deployments.extensions
+
source <(kubectl completion bash)
+

+

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

+

+
kubectl completion bash > ~/.kube/completion.bash.inc
+printf "
 

 

-
 Check to see if I can do everything in my current namespace ("*" means all)

+
 Kubectl shell completion

 

-
kubectl auth can-i '*' '*'
+
source '$HOME/.kube/completion.bash.inc'
+" >> $HOME/.bash_profile
+source $HOME/.bash_profile
 

 

-
 Check to see if I can get the job named "bar" in namespace "foo"

+
 Load the kubectl completion code for zsh[1] into the current shell

 

-
kubectl auth can-i list jobs.batch/bar -n foo
+
source <(kubectl completion zsh)
 

 

-
 Check to see if I can read pod logs

+
 Set the kubectl completion code for zsh[1] to autoload on startup

 

-
kubectl auth can-i get pods --subresource=log
+
kubectl completion zsh > "${fpath[1]}/_kubectl"
 

+
Output shell completion code for the specified shell (bash or zsh). The shell code must be evaluated to provide interactive completion of kubectl commands.  This can be done by sourcing it from the .bash _profile. 

+
Detailed instructions on how to do this are available here: https://kubernetes.io/docs/tasks/tools/install-kubectl/#enabling-shell-autocompletion 

+
Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2

+
Usage

+
$ completion SHELL

+

+
config

+
Modify kubeconfig files using subcommands like "kubectl config set current-context my-context" 

+
The loading order follows these rules: 

+
    
+
  1. If the --kubeconfig flag is set, then only that file is loaded.  The flag may only be set once and no merging takes place.  
    2. 
+
  2. If $KUBECONFIG environment variable is set, then it is used a list of paths (normal path delimitting rules for your system).  These paths are merged.  When a value is modified, it is modified in the file that defines the stanza.  When a value is created, it is created in the first file that exists.  If no files in the chain exist, then it creates the last file in the list.  
    3. 
+
  3. Otherwise, ${HOME}/.kube/config is used and no merging takes place.
    4. 
+

+
Usage

+
$ config SUBCOMMAND

+

+
current-context

 

-
 Check to see if I can access the URL /logs/

+
 Display the current-context

 

-
kubectl auth can-i get /logs/
+
kubectl config current-context
 

-
Check whether an action is allowed. 

-
VERB is a logical Kubernetes API verb like 'get', 'list', 'watch', 'delete', etc. TYPE is a Kubernetes resource. Shortcuts and groups will be resolved. NONRESOURCEURL is a partial URL starts with "/". NAME is the name of a particular Kubernetes resource.

+
Displays the current-context

 
Usage

-
$ can-i VERB [TYPE | TYPE/NAME | NONRESOURCEURL]

-
Flags

-
-
-
-
+
$ current-context

+

+
delete-cluster

+

+
 Delete the minikube cluster

+

+
kubectl config delete-cluster minikube
+

+
Delete the specified cluster from the kubeconfig

+
Usage

+
$ delete-cluster NAME

+

+
delete-context

+

+
 Delete the context for the minikube cluster

+

+
kubectl config delete-context minikube
+

+
Delete the specified context from the kubeconfig

+
Usage

+
$ delete-context NAME

+

+
get-clusters

+

+
 List the clusters kubectl knows about

+

+
kubectl config get-clusters
+

+
Display clusters defined in the kubeconfig.

+
Usage

+
$ get-clusters

+

+
get-contexts

+

+
 List all the contexts in your kubeconfig file

+

+
kubectl config get-contexts
+

+

+
 Describe one context in your kubeconfig file.

+

+
kubectl config get-contexts my-context
+

+
Displays one or many contexts from the kubeconfig file.

+
Usage

+
$ get-contexts [(-o|--output=)name)]

+
Flags

+
Name

+
+
+
@@ -6500,36 +6169,39 @@ 
Flags

-
+
-
-
-
-
-
-
-
+
-
-
+
+
-
+
Name
 Shorthand
 Default
 Usage
 

 
 
all-namespacesno-headers
 
 falseIf true, check the specified action in all namespaces. 
quietqfalseIf true, suppress output and just return the exit code. When using the default or custom-column output format, don't print headers (default print headers). 
 

 
subresourceoutputo
 SubResource such as pod/log or deployment/scale Output format. One of: name 
 

 
 

 

-
reconcile

+
rename-context

 

-
 Reconcile rbac resources from a file

+
 Rename the context 'old-name' to 'new-name' in your kubeconfig file

 

-
kubectl auth reconcile -f my-rbac-rules.yaml
+
kubectl config rename-context old-name new-name
 

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

-
This is preferred to 'apply' for RBAC resources so that proper rule coverage checks are done.

+
Renames a context from the kubeconfig file. 

+
CONTEXT _NAME is the context name that you wish change. 

+
NEW _NAME is the new name you wish to set. 

+
Note: In case the context being renamed is the 'current-context', this field will also be updated.

 
Usage

-
$ reconcile -f FILENAME

+
$ rename-context CONTEXT_NAME NEW_NAME

+

+
set

+
Sets an individual value in a kubeconfig file 

+
PROPERTY _NAME is a dot delimited name where each token represents either an attribute name or a map key.  Map keys may not contain dots. 

+
PROPERTY _VALUE is the new value you wish to set. Binary fields such as 'certificate-authority-data' expect a base64 encoded string unless the --set-raw-bytes flag is used.

+
Usage

+
$ set PROPERTY_NAME PROPERTY_VALUE

 
Flags

 
@@ -6542,92 +6214,34 @@ 
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
+

 
 
 
 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
filenamef[]Filename, directory, or URL to files identifying the resource to reconcile. 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsset-raw-bytes
 
 falseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. When writing a []byte PROPERTY_VALUE, write the given string directly without base64 decoding. 
 

 
 

 

-
cp

-

-
 !!!Important Note!!! # Requires that the 'tar' binary is present in your container # image.  If 'tar' is not present, 'kubectl cp' will fail. # Copy /tmp/foo_dir local directory to /tmp/bar_dir in a remote pod in the default namespace

-

-
kubectl cp /tmp/foo_dir <some-pod>:/tmp/bar_dir
-

+
set-cluster

 

-
 Copy /tmp/foo local file to /tmp/bar in a remote pod in a specific container

+
 Set only the server field on the e2e cluster entry without touching other values.

 

-
kubectl cp /tmp/foo <some-pod>:/tmp/bar -c <specific-container>
+
kubectl config set-cluster e2e --server=https://1.2.3.4
 

 

-
 Copy /tmp/foo local file to /tmp/bar in a remote pod in namespace 

+
 Embed certificate authority data for the e2e cluster entry

 

-
kubectl cp /tmp/foo <some-namespace>/<some-pod>:/tmp/bar
+
kubectl config set-cluster e2e --certificate-authority=~/.kube/e2e/kubernetes.ca.crt
 

 

-
 Copy /tmp/foo from a remote pod to /tmp/bar locally

+
 Disable cert checking for the dev cluster entry

 

-
kubectl cp <some-namespace>/<some-pod>:/tmp/foo /tmp/bar
+
kubectl config set-cluster e2e --insecure-skip-tls-verify=true
 

-
Copy files and directories to and from containers.

+
Sets a cluster entry in kubeconfig. 

+
Specifying a name that already exists will merge new fields on top of existing values for those fields.

 
Usage

-
$ cp <file-spec-src> <file-spec-dest>

+
$ set-cluster NAME [--server=server] [--certificate-authority=path/to/certificate/authority] [--insecure-skip-tls-verify=true]

 
Flags

 
@@ -6640,91 +6254,67 @@ 
Flags

-
-
+
-
+
+

 
 
 
 
containercembed-certs
 Container name. If omitted, the first container in the pod will be chosen falseembed-certs for the cluster entry in kubeconfig 
 

 
 

 

-
describe

+
set-context

 

-
 Describe a node

+
 Set the user field on the gce context entry without touching other values

 

-
kubectl describe nodes kubernetes-node-emt8.c.myproject.internal
+
kubectl config set-context gce --user=cluster-admin
 

+
Sets a context entry in kubeconfig 

+
Specifying a name that already exists will merge new fields on top of existing values for those fields.

+
Usage

+
$ set-context NAME [--cluster=cluster_nickname] [--user=user_nickname] [--namespace=namespace]

+

+
set-credentials

 

-
 Describe a pod

+
 Set only the "client-key" field on the "cluster-admin" # entry, without touching other values:

 

-
kubectl describe pods/nginx
+
kubectl config set-credentials cluster-admin --client-key=~/.kube/admin.key
 

 

-
 Describe a pod identified by type and name in "pod.json"

+
 Set basic auth for the "cluster-admin" entry

 

-
kubectl describe -f pod.json
+
kubectl config set-credentials cluster-admin --username=admin --password=uXFGweU9l35qcif
 

 

-
 Describe all pods

+
 Embed client certificate data in the "cluster-admin" entry

 

-
kubectl describe pods
+
kubectl config set-credentials cluster-admin --client-certificate=~/.kube/admin.crt --embed-certs=true
 

 

-
 Describe pods by label name=myLabel

+
 Enable the Google Compute Platform auth provider for the "cluster-admin" entry

 

-
kubectl describe po -l name=myLabel
+
kubectl config set-credentials cluster-admin --auth-provider=gcp
 

 

-
 Describe all pods managed by the 'frontend' replication controller (rc-created pods # get the name of the rc as a prefix in the pod the name).

+
 Enable the OpenID Connect auth provider for the "cluster-admin" entry with additional args

 

-
kubectl describe pods frontend
+
kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-id=foo --auth-provider-arg=client-secret=bar
 

-
Show details of a specific resource or group of resources 

-
Print a detailed description of the selected resources, including related resources such as events or controllers. You may select a single object by name, all objects of that type, provide a name prefix, or label selector. For example: 

-
  $ kubectl describe TYPE NAME_PREFIX

-
will first check for an exact match on TYPE and NAME PREFIX. If no such resource exists, it will output details for every resource that has a name prefixed with NAME PREFIX.

-
Valid resource types include: 

-
    
-
  • all  
    • 
-
  • certificatesigningrequests (aka 'csr')  
    • 
-
  • clusterrolebindings  
    • 
-
  • clusterroles  
    • 
-
  • componentstatuses (aka 'cs')  
    • 
-
  • configmaps (aka 'cm')  
    • 
-
  • controllerrevisions  
    • 
-
  • cronjobs  
    • 
-
  • customresourcedefinition (aka 'crd')  
    • 
-
  • daemonsets (aka 'ds')  
    • 
-
  • deployments (aka 'deploy')  
    • 
-
  • endpoints (aka 'ep')  
    • 
-
  • events (aka 'ev')  
    • 
-
  • horizontalpodautoscalers (aka 'hpa')  
    • 
-
  • ingresses (aka 'ing')  
    • 
-
  • jobs  
    • 
-
  • limitranges (aka 'limits')  
    • 
-
  • namespaces (aka 'ns')  
    • 
-
  • networkpolicies (aka 'netpol')  
    • 
-
  • nodes (aka 'no')  
    • 
-
  • persistentvolumeclaims (aka 'pvc')  
    • 
-
  • persistentvolumes (aka 'pv')  
    • 
-
  • poddisruptionbudgets (aka 'pdb')  
    • 
-
  • podpreset  
    • 
-
  • pods (aka 'po')  
    • 
-
  • podsecuritypolicies (aka 'psp')  
    • 
-
  • podtemplates  
    • 
-
  • replicasets (aka 'rs')  
    • 
-
  • replicationcontrollers (aka 'rc')  
    • 
-
  • resourcequotas (aka 'quota')  
    • 
-
  • rolebindings  
    • 
-
  • roles  
    • 
-
  • secrets  
    • 
-
  • serviceaccounts (aka 'sa')  
    • 
-
  • services (aka 'svc')  
    • 
-
  • statefulsets (aka 'sts')  
    • 
-
  • storageclasses (aka 'sc')
    • 
-

+

+
 Remove the "client-secret" config value for the OpenID Connect auth provider for the "cluster-admin" entry

+

+
kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-secret-
+

+
Sets a user entry in kubeconfig 

+
Specifying a name that already exists will merge new fields on top of existing values. 

+
  Client-certificate flags:
+  --client-certificate=certfile --client-key=keyfile

+
  Bearer token flags:
+    --token=bearer_token

+
  Basic auth flags:
+    --username=basic_user --password=basic_password

+
Bearer token and basic auth are mutually exclusive.

 
Usage

-
$ describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME)

+
$ set-credentials NAME [--client-certificate=path/to/certfile] [--client-key=path/to/keyfile] [--token=bearer_token] [--username=basic_user] [--password=basic_password] [--auth-provider=provider_name] [--auth-provider-arg=key=value]

 
Flags

 
@@ -6737,74 +6327,84 @@ 
Flags

-
+
-
-
+
+
-
-
+
+
-
+
-
+
-
-
+
+
-
+
-
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+

 
 
 
 
all-namespacesauth-provider
 falseIf present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. Auth provider for the user entry in kubeconfig 
 

 
filenamefauth-provider-arg
 []Filename, directory, or URL to files containing the resource to describe 'key=value' arguments for the auth provider 
 

 
include-extended-apisembed-certs
 trueIf true, include definitions of new APIs via calls to the API server. [default true] falseEmbed client cert/key for the user entry in kubeconfig 
 

 
include-uninitializedpassword
 falseIf true, the kubectl command applies to uninitialized objects. If explicitly set to false, this flag overrides other flags that make the kubectl commands apply to uninitialized objects, e.g., "--all". Objects with empty metadata.initializers are regarded as initialized. password for the user entry in kubeconfig 
 

 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
selectorlSelector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
show-eventstrueIf true, display events related to the described object. usernameusername for the user entry in kubeconfig 
 

 
 

 

-
exec

+
unset

 

-
 Get output from running 'date' from pod 123456-7890, using the first container by default

+
 Unset the current-context.

 

-
kubectl exec 123456-7890 date
+
kubectl config unset current-context
 

 

-
 Get output from running 'date' in ruby-container from pod 123456-7890

+
 Unset namespace in foo context.

 

-
kubectl exec 123456-7890 -c ruby-container date
+
kubectl config unset contexts.foo.namespace
 

+
Unsets an individual value in a kubeconfig file 

+
PROPERTY _NAME is a dot delimited name where each token represents either an attribute name or a map key.  Map keys may not contain dots.

+
Usage

+
$ unset PROPERTY_NAME

+

+
use-context

 

-
 Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-7890 # and sends stdout/stderr from 'bash' back to the client

+
 Use the context for the minikube cluster

 

-
kubectl exec 123456-7890 -c ruby-container -i -t -- bash -il
+
kubectl config use-context minikube
+

+
Sets the current-context in a kubeconfig file

+
Usage

+
$ use-context CONTEXT_NAME

+

+
view

+

+
 Show merged kubeconfig settings.

+

+
kubectl config view
 

 

-
 List contents of /usr from the first container of pod 123456-7890 and sort by modification time. # If the command you want to execute in the pod has any flags in common (e.g. -i), # you must use two dashes (--) to separate your command's flags/arguments. # Also note, do not surround your command and its flags/arguments with quotes # unless that is how you would execute it normally (i.e., do ls -t /usr, not "ls -t /usr").

+
 Show merged kubeconfig settings and raw certificate data.

 

-
kubectl exec 123456-7890 -i -t -- ls -t /usr
+
kubectl config view --raw
 

-
Execute a command in a container.

+

+
 Get the password for the e2e user

+

+
kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}'
+

+
Display merged kubeconfig settings or a specified kubeconfig file. 

+
You can use --output jsonpath={...} to extract specific values using a jsonpath expression.

 
Usage

-
$ exec POD [-c CONTAINER] -- COMMAND [args...]

+
$ view

 
Flags

 
@@ -6817,76 +6417,183 @@ 
Flags

-
-
+
-
+
+
-
-
+
-
+
+
-
-
+
+
+
+
+
+
+
+
-
+
-
-
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+

 
 
 
 
containercallow-missing-template-keys
 Container name. If omitted, the first container in the pod will be chosen trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
 

 
podpflatten
 Pod name falseFlatten the resulting kubeconfig file into self-contained output (useful for creating portable kubeconfig files) 
 

 
stdinimergetrueMerge the full hierarchy of kubeconfig files 
minify
 falsePass stdin to the container Remove all information not used by current-context from the output 
 

 
ttytoutputoyamlOutput format. One of: json|yaml|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
raw
 falseStdin is a TTY Display raw byte data 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
 

 
 

 

-
logs

+
explain

 

-
 Return snapshot logs from pod nginx with only one container

+
 Get the documentation of the resource and its fields

 

-
kubectl logs nginx
+
kubectl explain pods
+

+

+
 Get the documentation of a specific field of a resource

+

+
kubectl explain pods.spec.containers
 

+
List the fields for supported resources 

+
This command describes the fields associated with each supported API resource. Fields are identified via a simple JSONPath identifier: 

+
  .[.]

+
Add the --recursive flag to display all of the fields at once without descriptions. Information about each field is retrieved from the server in OpenAPI format.

+
Use "kubectl api-resources" for a complete list of supported resources.

+
Usage

+
$ explain RESOURCE

+
Flags

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameShorthandDefaultUsage
api-versionGet different explanations for particular API version 
recursivefalsePrint the fields of fields (Currently only 1 level deep) 

+

+
options

 

-
 Return snapshot logs for the pods defined by label app=nginx

+
 Print flags inherited by all commands

 

-
kubectl logs -lapp=nginx
+
kubectl options
 

+
Print the list of flags inherited by all commands

+
Usage

+
$ options

+

+
plugin

+
Runs a command-line plugin. 

+
Plugins are subcommands that are not part of the major command-line distribution and can even be provided by third-parties. Please refer to the documentation and examples for more information about how to install and write your own plugins.

+
Usage

+
$ plugin NAME

+

+
version

 

-
 Return snapshot of previous terminated ruby container logs from pod web-1

+
 Print the client and server versions for the current context

 

-
kubectl logs -p -c ruby web-1
+
kubectl version
 

+
Print the client and server version information for the current context

+
Usage

+
$ version

+
Flags

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameShorthandDefaultUsage
clientcfalseClient version only (no server required). 
outputoOne of 'yaml' or 'json'. 
shortfalsePrint just the version number. 

+
DEPRECATED COMMANDS

+

+
rolling-update

 

-
 Begin streaming the logs of the ruby container in pod web-1

+
 Update pods of frontend-v1 using new replication controller data in frontend-v2.json.

 

-
kubectl logs -f -c ruby web-1
+
kubectl rolling-update frontend-v1 -f frontend-v2.json
 

 

-
 Display only the most recent 20 lines of output in pod nginx

+
 Update pods of frontend-v1 using JSON data passed into stdin.

 

-
kubectl logs --tail=20 nginx
+
cat frontend-v2.json | kubectl rolling-update frontend-v1 -f -
 

 

-
 Show all logs from pod nginx written in the last hour

+
 Update the pods of frontend-v1 to frontend-v2 by just changing the image, and switching the # name of the replication controller.

 

-
kubectl logs --since=1h nginx
+
kubectl rolling-update frontend-v1 frontend-v2 --image=image:v2
 

 

-
 Return snapshot logs from first container of a job named hello

+
 Update the pods of frontend by just changing the image, and keeping the old name.

 

-
kubectl logs job/hello
+
kubectl rolling-update frontend --image=image:v2
 

 

-
 Return snapshot logs from container nginx-1 of a deployment named nginx

+
 Abort and reverse an existing rollout in progress (from frontend-v1 to frontend-v2).

 

-
kubectl logs deployment/nginx -c nginx-1
+
kubectl rolling-update frontend-v1 frontend-v2 --rollback
 

-
Print the logs for a container in a pod or specified resource. If the pod has only one container, the container name is optional.

+
Perform a rolling update of the given ReplicationController. 

+
Replaces the specified replication controller with a new replication controller by updating one pod at a time to use the new PodTemplate. The new-controller.json must specify the same namespace as the existing replication controller and overwrite at least one (common) label in its replicaSelector. 

+
! http://kubernetes.io/images/docs/kubectl_rollingupdate.svg

 
Usage

-
$ logs [-f] [-p] (POD | TYPE/NAME) [-c CONTAINER]

+
$ rolling-update OLD_CONTROLLER_NAME ([NEW_CONTROLLER_NAME] --image=NEW_CONTAINER_IMAGE | -f NEW_CONTROLLER_SPEC)

 
Flags

 
@@ -6900,159 +6607,144 @@ 
Flags

-
-
-
-
-
-
-
-
+
+
-
+
-
-
+
+
-
+
-
+
-
+
+
+
+
+
+
+
-
-
+
+
-
+
-
-
+
+
-
-
-
-
+
+
+
+
-
-
+
-
+
+
-
+
-
-
+
+
-
-
+
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+

 
 
 

 containerc
 Print the logs of this container 
followffalseSpecify if the logs should be streamed. Container name which will have its image upgraded. Only relevant when --image is specified, ignored otherwise. Required when using --image on a multi-container pod 
 

 
include-extended-apisdeployment-label-key
 trueIf true, include definitions of new APIs via calls to the API server. [default true] deploymentThe key to use to differentiate between two different controllers, default 'deployment'.  Only relevant when --image is specified, ignored otherwise 
 

 
interactivedry-run
 
 falseIf true, prompt the user for input when required. If true, only print the object that would be sent, without sending it. 
 

 
limit-bytesfilenamef[]Filename or URL to file to use to create the new replication controller. 
image
 0Maximum bytes of logs to return. Defaults to no limit. Image to use for upgrading the replication controller. Must be distinct from the existing image (either new image or new image tag).  Can not be used with --filename/-f 
 

 
pod-running-timeoutimage-pull-policy
 20sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running Explicit policy for when to pull container images. Required when --image is same as existing image, ignored otherwise. 
 

 
previouspfalseIf true, print the logs for the previous instance of the container in a pod if it exists. outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
selectorlpoll-interval
 Selector (label query) to filter on. 3sTime delay between polling for replication controller status after the update. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". 
 

 
sincerollback
 0sOnly return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since-time / since may be used. falseIf true, this is a request to abort an existing rollout that is partially rolled out. It effectively reverses current and next and runs a rollout 
 

 
since-timetimeout
 Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since-time / since may be used. 5m0sMax time to wait for a replication controller to update before giving up. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". 
 

 
tailupdate-period
 -1Lines of recent log file to display. Defaults to -1 with no selector, showing all log lines otherwise 10, if a selector is provided. 1m0sTime to wait between updating pods. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". 
 

 
timestampsvalidate
 falseInclude timestamps on each line in the log output trueIf true, use a schema to validate the input before sending it 
 

 
 

 

-
port-forward

+
run-container

 

-
 Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod

+
 Start a single instance of nginx.

 

-
kubectl port-forward pod/mypod 5000 6000
+
kubectl run nginx --image=nginx
 

 

-
 Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in a pod selected by the deployment

+
 Start a single instance of hazelcast and let the container expose port 5701 .

 

-
kubectl port-forward deployment/mydeployment 5000 6000
+
kubectl run hazelcast --image=hazelcast --port=5701
 

 

-
 Listen on port 8888 locally, forwarding to 5000 in the pod

+
 Start a single instance of hazelcast and set environment variables "DNS_DOMAIN=cluster" and "POD_NAMESPACE=default" in the container.

 

-
kubectl port-forward pod/mypod 8888:5000
+
kubectl run hazelcast --image=hazelcast --env="DNS_DOMAIN=cluster" --env="POD_NAMESPACE=default"
 

 

-
 Listen on a random port locally, forwarding to 5000 in the pod

+
 Start a single instance of hazelcast and set labels "app=hazelcast" and "env=prod" in the container.

 

-
kubectl port-forward pod/mypod :5000
+
kubectl run hazelcast --image=nginx --labels="app=hazelcast,env=prod"
 

-
Forward one or more local ports to a pod. 

-
Use resource type/name such as deployment/mydeployment to select a pod. Resource type defaults to 'pod' if omitted. 

-
If there are multiple pods matching the criteria, a pod will be selected automatically. The forwarding session ends when the selected pod terminates, and rerun of the command is needed to resume forwarding.

-
Usage

-
$ port-forward TYPE/NAME [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMOTE_PORT_N]

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
pod-running-timeout1m0sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running 

-

-
proxy

 

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

+
 Start a replicated instance of nginx.

 

-
$ kubectl proxy --api-prefix=/
+
kubectl run nginx --image=nginx --replicas=5
 

 

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

+
 Dry run. Print the corresponding API objects without creating them.

 

-
$ kubectl proxy --www=/my/files --www-prefix=/static/ --api-prefix=/api/
+
kubectl run nginx --image=nginx --dry-run
 

 

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

+
 Start a single instance of nginx, but overload the spec of the deployment with a partial set of values parsed from JSON.

 

-
$ kubectl proxy --api-prefix=/custom/
+
kubectl run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }'
 

 

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

+
 Start a pod of busybox and keep it in the foreground, don't restart it if it exits.

 

-
kubectl proxy --port=8011 --www=./local/www/
+
kubectl run -i -t busybox --image=busybox --restart=Never
 

 

-
 Run a proxy to kubernetes apiserver on an arbitrary local port. # The chosen port for the server will be output to stdout.

+
 Start the nginx container using the default command, but use custom arguments (arg1 .. argN) for that command.

 

-
kubectl proxy --port=0
+
kubectl run nginx --image=nginx -- <arg1> <arg2> ... <argN>
 

 

-
 Run a proxy to kubernetes apiserver, changing the api prefix to k8s-api # This makes e.g. the pods api available at localhost:8001/k8s-api/v1/pods/

+
 Start the nginx container using a different command and custom arguments.

 

-
kubectl proxy --api-prefix=/k8s-api
+
kubectl run nginx --image=nginx --command -- <cmd> <arg1> ... <argN>
 

-
Creates a proxy server or application-level gateway between localhost and the Kubernetes API Server. It also allows serving static content over specified HTTP path. All incoming data enters through one port and gets forwarded to the remote kubernetes API Server port, except for the path matching the static content path.

+

+
 Start the perl container to compute π to 2000 places and print it out.

+

+
kubectl run pi --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
+

+

+
 Start the cron job to compute π to 2000 places and print it out every 5 minutes.

+

+
kubectl run pi --schedule="0/5 * * * ?" --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
+

+
Create and run a particular image, possibly replicated. 

+
Creates a deployment or job to manage the created container(s).

 
Usage

-
$ proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--api-prefix=prefix]

+
$ run-container

 
Flags

 
@@ -7065,1317 +6757,223 @@ 
Flags

-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
+
+
+
+
+
+
-
+
-
-
-
-
+
+
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
-
+
-
+
+
-
-
+
-
+
+
-
-
-
-
+
+
+
+
-
-

 
 
 
 
accept-hostsattach
 ^localhost$,^127.0.0.1$,^[::1]$Regular expression for hosts that the proxy should accept. falseIf true, wait for the Pod to start running, and then attach to the Pod as if 'kubectl attach ...' were called.  Default false, unless '-i/--stdin' is set, in which case the default is true. With '--restart=Never' the exit code of the container process is returned. 
 

 
accept-pathscascade
 ^.*Regular expression for paths that the proxy should accept. trueIf true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController).  Default true. 
 

 
addresscommand
 127.0.0.1The IP address on which to serve on. falseIf true and extra arguments are present, use them as the 'command' field in the container, rather than the 'args' field which is the default. 
 

 
api-prefixdry-run
 /Prefix to serve the proxied API under. falseIf true, only print the object that would be sent, without sending it. 
 

 
disable-filterenv[]Environment variables to set in the container 
expose
 
 falseIf true, disable request filtering in the proxy. This is dangerous, and can leave you vulnerable to XSRF attacks, when used with an accessible port. If true, a public, external service is created for the container(s) which are run 
 

 
portp8001The port on which to run the proxy. Set to 0 to pick a random port. filenamef[]to use to replace the resource. 
 

 
reject-methodsforce
 ^$Regular expression for HTTP methods that the proxy should reject (example --reject-methods='POST,PUT,PATCH').  falseOnly used when grace-period=0. If true, immediately remove resources from API and bypass graceful deletion. Note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation. 
 

 
reject-pathsgenerator
 ^/api/./pods/./exec,^/api/./pods/./attachRegular expression for paths that the proxy should reject. Paths specified here will be rejected even accepted by --accept-paths. The name of the API generator to use, see http://kubernetes.io/docs/user-guide/kubectl-conventions/#generators for a list. 
 

 
unix-socketugrace-period
 Unix socket on which to run the proxy. -1Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. Set to 1 for immediate shutdown. Can only be set to 0 when --force is true (force deletion). 
 

 
wwwwhostport
 Also serve static files from the given directory under the specified prefix. -1The host port mapping for the container port. To demonstrate a single-machine container. 
 

 
www-prefixP/static/Prefix to serve static files under, if static file directory is specified. imageThe image for the container to run. 
 

-

-
top

-
Display Resource (CPU/Memory/Storage) usage. 

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

-
This command requires Heapster to be correctly configured and working on the server.

-
Usage

-
$ top

-

-
node

-

-
 Show metrics for all nodes

-

-
kubectl top node
-

-

-
 Show metrics for a given node

-

-
kubectl top node NODE_NAME
-

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

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

-
Usage

-
$ node [NAME | -l label]

-
Flags

-
-
-
-
-
-
+
+
+
+
-
-
-
+
+
-
-
+
-
-
+
-
+
+
-
+
-
-
+
+
-
+
+
-
-
+
-
-
+
-
-
-
-

 
NameShorthandDefaultUsageimage-pull-policyThe image pull policy for the container. If left empty, this value will not be specified by the client and defaulted by the server 
 

 
heapster-namespacelabelsl
 kube-systemNamespace Heapster service is located in Comma separated labels to apply to the pod(s). Will override previous values. 
 

 
heapster-portleave-stdin-open
 Port name in service to use falseIf the pod is started in interactive mode or with stdin, leave stdin open after the first attach completes. By default, stdin will be closed after the first attach completes. 
 

 
heapster-schemelimits
 httpScheme (http or https) to connect to Heapster as The resource requirement limits for this container.  For example, 'cpu=200m,memory=512Mi'.  Note that server side components may assign limits depending on the server configuration, such as limit ranges. 
 

 
heapster-serviceoutputo
 heapsterName of Heapster service Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
 

 
selectorloverrides
 Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 

-

-
pod

-

-
 Show metrics for all pods in the default namespace

-

-
kubectl top pod
-

-

-
 Show metrics for all pods in the given namespace

-

-
kubectl top pod --namespace=NAMESPACE
-

-

-
 Show metrics for a given pod and its containers

-

-
kubectl top pod POD_NAME --containers
-

-

-
 Show metrics for the pods defined by label name=myLabel

-

-
kubectl top pod -l name=myLabel
-

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

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

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

-
Usage

-
$ pod [NAME | -l label]

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
all-namespacesfalseIf present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. 
containersfalseIf present, print usage of containers within a pod. 
heapster-namespacekube-systemNamespace Heapster service is located in 
heapster-portPort name in service to use 
heapster-schemehttpScheme (http or https) to connect to Heapster as 
heapster-serviceheapsterName of Heapster service 
selectorlSelector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 

-
CLUSTER MANAGEMENT

-

-
api-versions

-

-
 Print the supported API versions

-

-
kubectl api-versions
-

-
Print the supported API versions on the server, in the form of "group/version"

-
Usage

-
$ api-versions

-

-
certificate

-
Modify certificate resources.

-
Usage

-
$ certificate SUBCOMMAND

-

-
approve

-
Approve a certificate signing request. 

-
kubectl certificate approve allows a cluster admin to approve a certificate signing request (CSR). This action tells a certificate signing controller to issue a certificate to the requestor with the attributes requested in the CSR. 

-
SECURITY NOTICE: Depending on the requested attributes, the issued certificate can potentially grant a requester access to cluster resources or to authenticate as a requested identity. Before approving a CSR, ensure you understand what the signed certificate can do.

-
Usage

-
$ approve (-f FILENAME | NAME)

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
filenamef[]Filename, directory, or URL to files identifying the resource to update 
outputoOutput mode. Use "-o name" for shorter output (resource/name). 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 

-

-
deny

-
Deny a certificate signing request. 

-
kubectl certificate deny allows a cluster admin to deny a certificate signing request (CSR). This action tells a certificate signing controller to not to issue a certificate to the requestor.

-
Usage

-
$ deny (-f FILENAME | NAME)

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
filenamef[]Filename, directory, or URL to files identifying the resource to update 
outputoOutput mode. Use "-o name" for shorter output (resource/name). 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 

-

-
cluster-info

-

-
 Print the address of the master and cluster services

-

-
kubectl cluster-info
-

-
Display addresses of the master and services with label kubernetes.io/cluster-service=true To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.

-
Usage

-
$ cluster-info

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
include-extended-apistrueIf true, include definitions of new APIs via calls to the API server. [default true] 

-

-
dump

-

-
 Dump current cluster state to stdout

-

-
kubectl cluster-info dump
-

-

-
 Dump current cluster state to /path/to/cluster-state

-

-
kubectl cluster-info dump --output-directory=/path/to/cluster-state
-

-

-
 Dump all namespaces to stdout

-

-
kubectl cluster-info dump --all-namespaces
-

-

-
 Dump a set of namespaces to /path/to/cluster-state

-

-
kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state
-

-
Dumps cluster info out suitable for debugging and diagnosing cluster problems.  By default, dumps everything to stdout. You can optionally specify a directory with --output-directory.  If you specify a directory, kubernetes will build a set of files in that directory.  By default only dumps things in the 'kube-system' namespace, but you can switch to a different namespace with the --namespaces flag, or specify --all-namespaces to dump all namespaces. 

-
The command also dumps the logs of all of the pods in the cluster, these logs are dumped into different directories based on namespace and pod name.

-
Usage

-
$ dump

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
all-namespacesfalseIf true, dump all namespaces.  If true, --namespaces is ignored. 
namespaces[]A comma separated list of namespaces to dump. 
output-directoryWhere to output the files.  If empty or '-' uses stdout, otherwise creates a directory hierarchy in that directory 
pod-running-timeout20sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running 

-

-
cordon

-

-
 Mark node "foo" as unschedulable.

-

-
kubectl cordon foo
-

-
Mark node as unschedulable.

-
Usage

-
$ cordon NODE

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
dry-runfalseIf true, only print the object that would be sent, without sending it. 
selectorlSelector (label query) to filter on 

-

-
drain

-

-
 Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet on it.

-

-
$ kubectl drain foo --force
-

-

-
 As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet, and use a grace period of 15 minutes.

-

-
$ kubectl drain foo --grace-period=900
-

-
Drain node in preparation for maintenance. 

-
The given node will be marked unschedulable to prevent new pods from arriving. 'drain' evicts the pods if the APIServer supports eviction (http://kubernetes.io/docs/admin/disruptions/). Otherwise, it will use normal DELETE to delete the pods. The 'drain' evicts or deletes all pods except mirror pods (which cannot be deleted through the API server).  If there are DaemonSet-managed pods, drain will not proceed without --ignore-daemonsets, and regardless it will not delete any DaemonSet-managed pods, because those pods would be immediately replaced by the DaemonSet controller, which ignores unschedulable markings.  If there are any pods that are neither mirror pods nor managed by ReplicationController, ReplicaSet, DaemonSet, StatefulSet or Job, then drain will not delete any pods unless you use --force.  --force will also allow deletion to proceed if the managing resource of one or more pods is missing. 

-
'drain' waits for graceful termination. You should not operate on the machine until the command completes. 

-
When you are ready to put the node back into service, use kubectl uncordon, which will make the node schedulable again. 

-
! http://kubernetes.io/images/docs/kubectl_drain.svg

-
Usage

-
$ drain NODE

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
delete-local-datafalseContinue even if there are pods using emptyDir (local data that will be deleted when the node is drained). 
dry-runfalseIf true, only print the object that would be sent, without sending it. 
forcefalseContinue even if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet. 
grace-period-1Period of time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used. 
ignore-daemonsetsfalseIgnore DaemonSet-managed pods. 
pod-selectorLabel selector to filter pods on the node 
selectorlSelector (label query) to filter on 
timeout0sThe length of time to wait before giving up, zero means infinite 

-

-
taint

-

-
 Update node 'foo' with a taint with key 'dedicated' and value 'special-user' and effect 'NoSchedule'. # If a taint with that key and effect already exists, its value is replaced as specified.

-

-
kubectl taint nodes foo dedicated=special-user:NoSchedule
-

-

-
 Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists.

-

-
kubectl taint nodes foo dedicated:NoSchedule-
-

-

-
 Remove from node 'foo' all the taints with key 'dedicated'

-

-
kubectl taint nodes foo dedicated-
-

-

-
 Add a taint with key 'dedicated' on nodes having label mylabel=X

-

-
kubectl taint node -l myLabel=X  dedicated=foo:PreferNoSchedule
-

-
Update the taints on one or more nodes. 

-
    
-
  • A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect.  
    • 
-
  • The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to  253 characters.  
    • 
-
  • Optionally, the key can begin with a DNS subdomain prefix and a single '/', like example.com/my-app  
    • 
-
  • The value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to  63 characters.  
    • 
-
  • The effect must be NoSchedule, PreferNoSchedule or NoExecute.  
    • 
-
  • Currently taint can only apply to node.
    • 
-

-
Usage

-
$ taint NODE NAME KEY_1=VAL_1:TAINT_EFFECT_1 ... KEY_N=VAL_N:TAINT_EFFECT_N

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
allfalseSelect all nodes in the cluster 
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
include-extended-apistrueIf true, include definitions of new APIs via calls to the API server. [default true] 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 
output-versionDEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). 
overwritefalseIf true, allow taints to be overwritten, otherwise reject taint updates that overwrite existing taints. 
selectorlSelector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) 
show-labelsfalseWhen printing, show all labels as the last column (default hide labels column) 
sort-byIf non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. 
templateTemplate string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. 
validatetrueIf true, use a schema to validate the input before sending it 

-

-
uncordon

-

-
 Mark node "foo" as schedulable.

-

-
$ kubectl uncordon foo
-

-
Mark node as schedulable.

-
Usage

-
$ uncordon NODE

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
dry-runfalseIf true, only print the object that would be sent, without sending it. 
selectorlSelector (label query) to filter on 

-
KUBECTL SETTINGS AND USAGE

-

-
alpha

-
These commands correspond to alpha features that are not enabled in Kubernetes clusters by default.

-
Usage

-
$ alpha

-

-
diff

-

-
 Diff resources included in pod.json. By default, it will diff LOCAL and LIVE versions

-

-
kubectl alpha diff -f pod.json
-

-

-
 When one version is specified, diff that version against LIVE

-

-
cat service.yaml | kubectl alpha diff -f - MERGED
-

-

-
 Or specify both versions

-

-
kubectl alpha diff -f pod.json -f service.yaml LAST LOCAL
-

-
Diff configurations specified by filename or stdin between their local, last-applied, live and/or "merged" versions. 

-
LOCAL and LIVE versions are diffed by default. Other available keywords are MERGED and LAST. 

-
Output is always YAML. 

-
KUBERNETES EXTERNAL DIFF environment variable can be used to select your own diff command. By default, the "diff" command available in your path will be run with "-u" (unicode) and "-N" (treat new files as empty) options.

-
Usage

-
$ diff -f FILENAME

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
filenamef[]Filename, directory, or URL to files contains the configuration to diff 
recursiveRfalseProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 

-

-
completion

-

-
 Installing bash completion on macOS using homebrew ## If running Bash 3.2 included with macOS

-

-
brew install bash-completion
-

-

-
 or, if running Bash 4.1+

-

-
brew install bash-completion@2
-

-

-
 If kubectl is installed via homebrew, this should start working immediately. ## If you've installed via other means, you may need add the completion to your completion directory

-

-
kubectl completion bash > $(brew --prefix)/etc/bash_completion.d/kubectl
-

-

-
 Installing bash completion on Linux ## Load the kubectl completion code for bash into the current shell

-

-
source <(kubectl completion bash)
-

-

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

-

-
kubectl completion bash > ~/.kube/completion.bash.inc
-printf "
-

-

-
 Kubectl shell completion

-

-
source '$HOME/.kube/completion.bash.inc'
-" >> $HOME/.bash_profile
-source $HOME/.bash_profile
-

-

-
 Load the kubectl completion code for zsh[1] into the current shell

-

-
source <(kubectl completion zsh)
-

-

-
 Set the kubectl completion code for zsh[1] to autoload on startup

-

-
kubectl completion zsh > "${fpath[1]}/_kubectl"
-

-
Output shell completion code for the specified shell (bash or zsh). The shell code must be evaluated to provide interactive completion of kubectl commands.  This can be done by sourcing it from the .bash _profile. 

-
Detailed instructions on how to do this are available here: https://kubernetes.io/docs/tasks/tools/install-kubectl/#enabling-shell-autocompletion 

-
Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2

-
Usage

-
$ completion SHELL

-

-
config

-
Modify kubeconfig files using subcommands like "kubectl config set current-context my-context" 

-
The loading order follows these rules: 

-
    
-
  1. If the --kubeconfig flag is set, then only that file is loaded.  The flag may only be set once and no merging takes place.  
    2. 
-
  2. If $KUBECONFIG environment variable is set, then it is used a list of paths (normal path delimitting rules for your system).  These paths are merged.  When a value is modified, it is modified in the file that defines the stanza.  When a value is created, it is created in the first file that exists.  If no files in the chain exist, then it creates the last file in the list.  
    3. 
-
  3. Otherwise, ${HOME}/.kube/config is used and no merging takes place.
    4. 
-

-
Usage

-
$ config SUBCOMMAND

-

-
current-context

-

-
 Display the current-context

-

-
kubectl config current-context
-

-
Displays the current-context

-
Usage

-
$ current-context

-

-
delete-cluster

-

-
 Delete the minikube cluster

-

-
kubectl config delete-cluster minikube
-

-
Delete the specified cluster from the kubeconfig

-
Usage

-
$ delete-cluster NAME

-

-
delete-context

-

-
 Delete the context for the minikube cluster

-

-
kubectl config delete-context minikube
-

-
Delete the specified context from the kubeconfig

-
Usage

-
$ delete-context NAME

-

-
get-clusters

-

-
 List the clusters kubectl knows about

-

-
kubectl config get-clusters
-

-
Display clusters defined in the kubeconfig.

-
Usage

-
$ get-clusters

-

-
get-contexts

-

-
 List all the contexts in your kubeconfig file

-

-
kubectl config get-contexts
-

-

-
 Describe one context in your kubeconfig file.

-

-
kubectl config get-contexts my-context
-

-
Displays one or many contexts from the kubeconfig file.

-
Usage

-
$ get-contexts [(-o|--output=)name)]

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
allow-missing-template-keystrueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. 
no-headersfalseWhen using the default or custom-column output format, don't print headers (default print headers). 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. 

-

-
rename-context

-

-
 Rename the context 'old-name' to 'new-name' in your kubeconfig file

-

-
kubectl config rename-context old-name new-name
-

-
Renames a context from the kubeconfig file. 

-
CONTEXT _NAME is the context name that you wish change. 

-
NEW _NAME is the new name you wish to set. 

-
Note: In case the context being renamed is the 'current-context', this field will also be updated.

-
Usage

-
$ rename-context CONTEXT_NAME NEW_NAME

-

-
set

-
Sets an individual value in a kubeconfig file 

-
PROPERTY _NAME is a dot delimited name where each token represents either an attribute name or a map key.  Map keys may not contain dots. 

-
PROPERTY _VALUE is the new value you wish to set. Binary fields such as 'certificate-authority-data' expect a base64 encoded string unless the --set-raw-bytes flag is used.

-
Usage

-
$ set PROPERTY_NAME PROPERTY_VALUE

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
set-raw-bytesfalseWhen writing a []byte PROPERTY_VALUE, write the given string directly without base64 decoding. 

-

-
set-cluster

-

-
 Set only the server field on the e2e cluster entry without touching other values.

-

-
kubectl config set-cluster e2e --server=https://1.2.3.4
-

-

-
 Embed certificate authority data for the e2e cluster entry

-

-
kubectl config set-cluster e2e --certificate-authority=~/.kube/e2e/kubernetes.ca.crt
-

-

-
 Disable cert checking for the dev cluster entry

-

-
kubectl config set-cluster e2e --insecure-skip-tls-verify=true
-

-
Sets a cluster entry in kubeconfig. 

-
Specifying a name that already exists will merge new fields on top of existing values for those fields.

-
Usage

-
$ set-cluster NAME [--server=server] [--certificate-authority=path/to/certificate/authority] [--insecure-skip-tls-verify=true]

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
NameShorthandDefaultUsage
embed-certsfalseembed-certs for the cluster entry in kubeconfig 

-

-
set-context

-

-
 Set the user field on the gce context entry without touching other values

-

-
kubectl config set-context gce --user=cluster-admin
-

-
Sets a context entry in kubeconfig 

-
Specifying a name that already exists will merge new fields on top of existing values for those fields.

-
Usage

-
$ set-context NAME [--cluster=cluster_nickname] [--user=user_nickname] [--namespace=namespace]

-

-
set-credentials

-

-
 Set only the "client-key" field on the "cluster-admin" # entry, without touching other values:

-

-
kubectl config set-credentials cluster-admin --client-key=~/.kube/admin.key
-

-

-
 Set basic auth for the "cluster-admin" entry

-

-
kubectl config set-credentials cluster-admin --username=admin --password=uXFGweU9l35qcif
-

-

-
 Embed client certificate data in the "cluster-admin" entry

-

-
kubectl config set-credentials cluster-admin --client-certificate=~/.kube/admin.crt --embed-certs=true
-

-

-
 Enable the Google Compute Platform auth provider for the "cluster-admin" entry

-

-
kubectl config set-credentials cluster-admin --auth-provider=gcp
-

-

-
 Enable the OpenID Connect auth provider for the "cluster-admin" entry with additional args

-

-
kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-id=foo --auth-provider-arg=client-secret=bar
-

-

-
 Remove the "client-secret" config value for the OpenID Connect auth provider for the "cluster-admin" entry

-

-
kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-secret-
-

-
Sets a user entry in kubeconfig 

-
Specifying a name that already exists will merge new fields on top of existing values. 

-
  Client-certificate flags:
-  --client-certificate=certfile --client-key=keyfile

-
  Bearer token flags:
-    --token=bearer_token

-
  Basic auth flags:
-    --username=basic_user --password=basic_password

-
Bearer token and basic auth are mutually exclusive.

-
Usage

-
$ set-credentials NAME [--client-certificate=path/to/certfile] [--client-key=path/to/keyfile] [--token=bearer_token] [--username=basic_user] [--password=basic_password] [--auth-provider=provider_name] [--auth-provider-arg=key=value]

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
-
+
+
-
+
-
-
-
-
-
NameShorthandDefaultUsage
auth-provider
 Auth provider for the user entry in kubeconfig An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. 
 

 
auth-provider-argpod-running-timeout
 []'key=value' arguments for the auth provider 1m0sThe length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running 
 

 
embed-certsport
 falseEmbed client cert/key for the user entry in kubeconfig 

-

-
unset

-

-
 Unset the current-context.

-

-
kubectl config unset current-context
-

-

-
 Unset namespace in foo context.

-

-
kubectl config unset contexts.foo.namespace
-

-
Unsets an individual value in a kubeconfig file 

-
PROPERTY _NAME is a dot delimited name where each token represents either an attribute name or a map key.  Map keys may not contain dots.

-
Usage

-
$ unset PROPERTY_NAME

-

-
use-context

-

-
 Use the context for the minikube cluster

-

-
kubectl config use-context minikube
-

-
Sets the current-context in a kubeconfig file

-
Usage

-
$ use-context CONTEXT_NAME

-

-
view

-

-
 Show Merged kubeconfig settings.

-

-
kubectl config view
-

-

-
 Get the password for the e2e user

-

-
kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}'
-

-
Display merged kubeconfig settings or a specified kubeconfig file. 

-
You can use --output jsonpath={...} to extract specific values using a jsonpath expression.

-
Usage

-
$ view

-
Flags

-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
-
-
-
-
-
-
+
-
+
-
+
-
-
+
+
-
+
-
-
-
-
+
+
+
+
-
+
-
+
-
+
-
-
-
-
-
-
-
-
+
+
-
+
-
+
-
-
+
-
+
+
-
+
-
+
-
-
NameShorthandDefaultUsage
allow-missing-template-keys
 trueIf true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. The port that this container exposes.  If --expose is true, this is also the port used by the service that is created. 
 

 
flattenquiet
 
 falseFlatten the resulting kubeconfig file into self-contained output (useful for creating portable kubeconfig files) 
mergetrueMerge the full hierarchy of kubeconfig files If true, suppress prompt messages. 
 

 
minifyrecord
 
 falseRemove all information not used by current-context from the output Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. 
 

 
no-headersrecursiveR
 falseWhen using the default or custom-column output format, don't print headers (default print headers). Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 
 

 
outputoOutput format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. replicasr1Number of replicas to create for this container. Default is 1. 
 

 
output-versionrequests
 
 DEPRECATED: To use a specific API version, fully-qualify the resource, version, and group (for example: 'jobs.v1.batch/myjob'). The resource requirement requests for this container.  For example, 'cpu=100m,memory=256Mi'.  Note that server side components may assign requests depending on the server configuration, such as limit ranges. 
 

 
rawrestart
 falseDisplay raw byte data 
show-allatrueWhen printing, show all resources (default show all pods including terminated one.) AlwaysThe restart policy for this Pod.  Legal values [Always, OnFailure, Never].  If set to 'Always' a deployment is created, if set to 'OnFailure' a job is created, if set to 'Never', a regular pod is created. For the latter two --replicas must be 1.  Default 'Always', for CronJobs Never. 
 

 
show-labelsrm
 
 falseWhen printing, show all labels as the last column (default hide labels column) If true, delete resources created in this command for attached containers. 
 

 
sort-bysave-config
 If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. falseIf true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. 
 

 
templateschedule
 
 Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. A schedule in the Cron format the job should be run with. 
 

-

-
explain

-

-
 Get the documentation of the resource and its fields

-

-
kubectl explain pods
-

-

-
 Get the documentation of a specific field of a resource

-

-
kubectl explain pods.spec.containers
-

-
List the fields for supported resources 

-
This command describes the fields associated with each supported API resource. Fields are identified via a simple JSONPath identifier: 

-
  .[.]

-
Add the --recursive flag to display all of the fields at once without descriptions. Information about each field is retrieved from the server in OpenAPI format.

-
Valid resource types include: 

-
    
-
  • all  
    • 
-
  • certificatesigningrequests (aka 'csr')  
    • 
-
  • clusterrolebindings  
    • 
-
  • clusterroles  
    • 
-
  • componentstatuses (aka 'cs')  
    • 
-
  • configmaps (aka 'cm')  
    • 
-
  • controllerrevisions  
    • 
-
  • cronjobs  
    • 
-
  • customresourcedefinition (aka 'crd')  
    • 
-
  • daemonsets (aka 'ds')  
    • 
-
  • deployments (aka 'deploy')  
    • 
-
  • endpoints (aka 'ep')  
    • 
-
  • events (aka 'ev')  
    • 
-
  • horizontalpodautoscalers (aka 'hpa')  
    • 
-
  • ingresses (aka 'ing')  
    • 
-
  • jobs  
    • 
-
  • limitranges (aka 'limits')  
    • 
-
  • namespaces (aka 'ns')  
    • 
-
  • networkpolicies (aka 'netpol')  
    • 
-
  • nodes (aka 'no')  
    • 
-
  • persistentvolumeclaims (aka 'pvc')  
    • 
-
  • persistentvolumes (aka 'pv')  
    • 
-
  • poddisruptionbudgets (aka 'pdb')  
    • 
-
  • podpreset  
    • 
-
  • pods (aka 'po')  
    • 
-
  • podsecuritypolicies (aka 'psp')  
    • 
-
  • podtemplates  
    • 
-
  • replicasets (aka 'rs')  
    • 
-
  • replicationcontrollers (aka 'rc')  
    • 
-
  • resourcequotas (aka 'quota')  
    • 
-
  • rolebindings  
    • 
-
  • roles  
    • 
-
  • secrets  
    • 
-
  • serviceaccounts (aka 'sa')  
    • 
-
  • services (aka 'svc')  
    • 
-
  • statefulsets (aka 'sts')  
    • 
-
  • storageclasses (aka 'sc')
    • 
-

-
Usage

-
$ explain RESOURCE

-
Flags

-
-
-
-
-
-
+
+
+
+
-
-
-
+
-
+
-
+
-
-
+
+
-
-
+
+
-
+
-
-

 
NameShorthandDefaultUsageservice-generatorservice/v2The name of the generator to use for creating a service.  Only used if --expose is true 
 

 
api-versionservice-overrides
 
 Get different explanations for particular API version An inline JSON override for the generated service object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.  Only used if --expose is true. 
 

 
include-extended-apisserviceaccount
 trueIf true, include definitions of new APIs via calls to the API server. [default true] Service account to set in the pod spec 
 

 
recursivestdini
 falsePrint the fields of fields (Currently only 1 level deep) Keep stdin open on the container(s) in the pod, even if nothing is attached. 
 

-

-
options

-

-
 Print flags inherited by all commands

-

-
kubectl options
-

-
Print the list of flags inherited by all commands

-
Usage

-
$ options

-

-
version

-

-
 Print the client and server versions for the current context

-

-
kubectl version
-

-
Print the client and server version information for the current context

-
Usage

-
$ version

-
Flags

-
-
-
-
-
-
+
+
+
+
-
-
-
-
+
+
-
-
-
-
-
-
-
+
-
+
-
+

 
NameShorthandDefaultUsagetimeout0sThe length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object 
 

 
clientcttyt
 falseClient version only (no server required). 
outputoOne of 'yaml' or 'json'. Allocated a TTY for each container in the pod. 
 

 
shortwait
 
 falsePrint just the version number. If true, wait for resources to be gone before returning. This waits for finalizers. 
 

 
 

-

-
plugin

-
Runs a command-line plugin. 

-
Plugins are subcommands that are not part of the major command-line distribution and can even be provided by third-parties. Please refer to the documentation and examples for more information about how to install and write your own plugins.

-
Usage

-
$ plugin NAME

-
DEPRECATED COMMANDS
diff --git a/static/docs/reference/generated/kubectl/navData.js b/static/docs/reference/generated/kubectl/navData.js index 213410f5107cc..4df43b4b82ea0 100644 --- a/static/docs/reference/generated/kubectl/navData.js +++ b/static/docs/reference/generated/kubectl/navData.js @@ -1 +1 @@ -(function(){navData = {"toc":[{"section":"-strong-deprecated-commands-strong-","subsections":[]},{"section":"plugin","subsections":[]},{"section":"version","subsections":[]},{"section":"options","subsections":[]},{"section":"explain","subsections":[]},{"section":"config","subsections":[{"section":"-em-view-em-"},{"section":"-em-use-context-em-"},{"section":"-em-unset-em-"},{"section":"-em-set-credentials-em-"},{"section":"-em-set-context-em-"},{"section":"-em-set-cluster-em-"},{"section":"-em-set-em-"},{"section":"-em-rename-context-em-"},{"section":"-em-get-contexts-em-"},{"section":"-em-get-clusters-em-"},{"section":"-em-delete-context-em-"},{"section":"-em-delete-cluster-em-"},{"section":"-em-current-context-em-"}]},{"section":"completion","subsections":[]},{"section":"alpha","subsections":[{"section":"-em-diff-em-"}]},{"section":"-strong-kubectl-settings-and-usage-strong-","subsections":[]},{"section":"uncordon","subsections":[]},{"section":"taint","subsections":[]},{"section":"drain","subsections":[]},{"section":"cordon","subsections":[]},{"section":"cluster-info","subsections":[{"section":"-em-dump-em-"}]},{"section":"certificate","subsections":[{"section":"-em-deny-em-"},{"section":"-em-approve-em-"}]},{"section":"api-versions","subsections":[]},{"section":"-strong-cluster-management-strong-","subsections":[]},{"section":"top","subsections":[{"section":"-em-pod-em-"},{"section":"-em-node-em-"}]},{"section":"proxy","subsections":[]},{"section":"port-forward","subsections":[]},{"section":"logs","subsections":[]},{"section":"exec","subsections":[]},{"section":"describe","subsections":[]},{"section":"cp","subsections":[]},{"section":"auth","subsections":[{"section":"-em-reconcile-em-"},{"section":"-em-can-i-em-"}]},{"section":"attach","subsections":[]},{"section":"-strong-working-with-apps-strong-","subsections":[]},{"section":"apply","subsections":[{"section":"-em-view-last-applied-em-"},{"section":"-em-set-last-applied-em-"},{"section":"-em-edit-last-applied-em-"}]},{"section":"-strong-declarative-app-management-strong-","subsections":[]},{"section":"set","subsections":[{"section":"-em-subject-em-"},{"section":"-em-serviceaccount-em--1"},{"section":"-em-selector-em-"},{"section":"-em-resources-em-"},{"section":"-em-image-em-"},{"section":"-em-env-em-"}]},{"section":"scale","subsections":[]},{"section":"rollout","subsections":[{"section":"-em-undo-em-"},{"section":"-em-status-em-"},{"section":"-em-resume-em-"},{"section":"-em-pause-em-"},{"section":"-em-history-em-"}]},{"section":"rolling-update","subsections":[]},{"section":"replace","subsections":[]},{"section":"patch","subsections":[]},{"section":"label","subsections":[]},{"section":"get","subsections":[]},{"section":"edit","subsections":[]},{"section":"delete","subsections":[]},{"section":"create","subsections":[{"section":"-em-serviceaccount-em-"},{"section":"-em-service-nodeport-em-"},{"section":"-em-service-loadbalancer-em-"},{"section":"-em-service-externalname-em-"},{"section":"-em-service-clusterip-em-"},{"section":"-em-service-em-"},{"section":"-em-secret-tls-em-"},{"section":"-em-secret-generic-em-"},{"section":"-em-secret-docker-registry-em-"},{"section":"-em-secret-em-"},{"section":"-em-rolebinding-em-"},{"section":"-em-role-em-"},{"section":"-em-quota-em-"},{"section":"-em-priorityclass-em-"},{"section":"-em-poddisruptionbudget-em-"},{"section":"-em-namespace-em-"},{"section":"-em-job-em-"},{"section":"-em-deployment-em-"},{"section":"-em-configmap-em-"},{"section":"-em-clusterrolebinding-em-"},{"section":"-em-clusterrole-em-"}]},{"section":"convert","subsections":[]},{"section":"autoscale","subsections":[]},{"section":"annotate","subsections":[]},{"section":"-strong-app-management-strong-","subsections":[]},{"section":"expose","subsections":[]},{"section":"run-container","subsections":[]},{"section":"run","subsections":[]},{"section":"-strong-getting-started-strong-","subsections":[]}],"flatToc":["-strong-deprecated-commands-strong-","plugin","version","options","explain","-em-view-em-","-em-use-context-em-","-em-unset-em-","-em-set-credentials-em-","-em-set-context-em-","-em-set-cluster-em-","-em-set-em-","-em-rename-context-em-","-em-get-contexts-em-","-em-get-clusters-em-","-em-delete-context-em-","-em-delete-cluster-em-","-em-current-context-em-","config","completion","-em-diff-em-","alpha","-strong-kubectl-settings-and-usage-strong-","uncordon","taint","drain","cordon","-em-dump-em-","cluster-info","-em-deny-em-","-em-approve-em-","certificate","api-versions","-strong-cluster-management-strong-","-em-pod-em-","-em-node-em-","top","proxy","port-forward","logs","exec","describe","cp","-em-reconcile-em-","-em-can-i-em-","auth","attach","-strong-working-with-apps-strong-","-em-view-last-applied-em-","-em-set-last-applied-em-","-em-edit-last-applied-em-","apply","-strong-declarative-app-management-strong-","-em-subject-em-","-em-serviceaccount-em--1","-em-selector-em-","-em-resources-em-","-em-image-em-","-em-env-em-","set","scale","-em-undo-em-","-em-status-em-","-em-resume-em-","-em-pause-em-","-em-history-em-","rollout","rolling-update","replace","patch","label","get","edit","delete","-em-serviceaccount-em-","-em-service-nodeport-em-","-em-service-loadbalancer-em-","-em-service-externalname-em-","-em-service-clusterip-em-","-em-service-em-","-em-secret-tls-em-","-em-secret-generic-em-","-em-secret-docker-registry-em-","-em-secret-em-","-em-rolebinding-em-","-em-role-em-","-em-quota-em-","-em-priorityclass-em-","-em-poddisruptionbudget-em-","-em-namespace-em-","-em-job-em-","-em-deployment-em-","-em-configmap-em-","-em-clusterrolebinding-em-","-em-clusterrole-em-","create","convert","autoscale","annotate","-strong-app-management-strong-","expose","run-container","run","-strong-getting-started-strong-"]};})(); \ No newline at end of file +(function(){navData = {"toc":[{"section":"run-container","subsections":[]},{"section":"rolling-update","subsections":[]},{"section":"-strong-deprecated-commands-strong-","subsections":[]},{"section":"version","subsections":[]},{"section":"plugin","subsections":[]},{"section":"options","subsections":[]},{"section":"explain","subsections":[]},{"section":"config","subsections":[{"section":"-em-view-em-"},{"section":"-em-use-context-em-"},{"section":"-em-unset-em-"},{"section":"-em-set-credentials-em-"},{"section":"-em-set-context-em-"},{"section":"-em-set-cluster-em-"},{"section":"-em-set-em-"},{"section":"-em-rename-context-em-"},{"section":"-em-get-contexts-em-"},{"section":"-em-get-clusters-em-"},{"section":"-em-delete-context-em-"},{"section":"-em-delete-cluster-em-"},{"section":"-em-current-context-em-"}]},{"section":"completion","subsections":[]},{"section":"api-resources","subsections":[]},{"section":"alpha","subsections":[{"section":"-em-diff-em-"}]},{"section":"-strong-kubectl-settings-and-usage-strong-","subsections":[]},{"section":"uncordon","subsections":[]},{"section":"taint","subsections":[]},{"section":"drain","subsections":[]},{"section":"cordon","subsections":[]},{"section":"cluster-info","subsections":[{"section":"-em-dump-em-"}]},{"section":"certificate","subsections":[{"section":"-em-deny-em-"},{"section":"-em-approve-em-"}]},{"section":"api-versions","subsections":[]},{"section":"-strong-cluster-management-strong-","subsections":[]},{"section":"top","subsections":[{"section":"-em-pod-em-"},{"section":"-em-node-em-"}]},{"section":"proxy","subsections":[]},{"section":"port-forward","subsections":[]},{"section":"logs","subsections":[]},{"section":"exec","subsections":[]},{"section":"describe","subsections":[]},{"section":"cp","subsections":[]},{"section":"auth","subsections":[{"section":"-em-reconcile-em-"},{"section":"-em-can-i-em-"}]},{"section":"attach","subsections":[]},{"section":"-strong-working-with-apps-strong-","subsections":[]},{"section":"wait","subsections":[]},{"section":"set","subsections":[{"section":"-em-subject-em-"},{"section":"-em-serviceaccount-em--1"},{"section":"-em-selector-em-"},{"section":"-em-resources-em-"},{"section":"-em-image-em-"},{"section":"-em-env-em-"}]},{"section":"scale","subsections":[]},{"section":"rollout","subsections":[{"section":"-em-undo-em-"},{"section":"-em-status-em-"},{"section":"-em-resume-em-"},{"section":"-em-pause-em-"},{"section":"-em-history-em-"}]},{"section":"replace","subsections":[]},{"section":"patch","subsections":[]},{"section":"label","subsections":[]},{"section":"edit","subsections":[]},{"section":"convert","subsections":[]},{"section":"autoscale","subsections":[]},{"section":"annotate","subsections":[]},{"section":"apply","subsections":[{"section":"-em-view-last-applied-em-"},{"section":"-em-set-last-applied-em-"},{"section":"-em-edit-last-applied-em-"}]},{"section":"-strong-app-management-strong-","subsections":[]},{"section":"delete","subsections":[]},{"section":"expose","subsections":[]},{"section":"run","subsections":[]},{"section":"get","subsections":[]},{"section":"create","subsections":[{"section":"-em-serviceaccount-em-"},{"section":"-em-service-nodeport-em-"},{"section":"-em-service-loadbalancer-em-"},{"section":"-em-service-externalname-em-"},{"section":"-em-service-clusterip-em-"},{"section":"-em-service-em-"},{"section":"-em-secret-tls-em-"},{"section":"-em-secret-generic-em-"},{"section":"-em-secret-docker-registry-em-"},{"section":"-em-secret-em-"},{"section":"-em-rolebinding-em-"},{"section":"-em-role-em-"},{"section":"-em-quota-em-"},{"section":"-em-priorityclass-em-"},{"section":"-em-poddisruptionbudget-em-"},{"section":"-em-namespace-em-"},{"section":"-em-job-em-"},{"section":"-em-deployment-em-"},{"section":"-em-configmap-em-"},{"section":"-em-clusterrolebinding-em-"},{"section":"-em-clusterrole-em-"}]},{"section":"-strong-getting-started-strong-","subsections":[]}],"flatToc":["run-container","rolling-update","-strong-deprecated-commands-strong-","version","plugin","options","explain","-em-view-em-","-em-use-context-em-","-em-unset-em-","-em-set-credentials-em-","-em-set-context-em-","-em-set-cluster-em-","-em-set-em-","-em-rename-context-em-","-em-get-contexts-em-","-em-get-clusters-em-","-em-delete-context-em-","-em-delete-cluster-em-","-em-current-context-em-","config","completion","api-resources","-em-diff-em-","alpha","-strong-kubectl-settings-and-usage-strong-","uncordon","taint","drain","cordon","-em-dump-em-","cluster-info","-em-deny-em-","-em-approve-em-","certificate","api-versions","-strong-cluster-management-strong-","-em-pod-em-","-em-node-em-","top","proxy","port-forward","logs","exec","describe","cp","-em-reconcile-em-","-em-can-i-em-","auth","attach","-strong-working-with-apps-strong-","wait","-em-subject-em-","-em-serviceaccount-em--1","-em-selector-em-","-em-resources-em-","-em-image-em-","-em-env-em-","set","scale","-em-undo-em-","-em-status-em-","-em-resume-em-","-em-pause-em-","-em-history-em-","rollout","replace","patch","label","edit","convert","autoscale","annotate","-em-view-last-applied-em-","-em-set-last-applied-em-","-em-edit-last-applied-em-","apply","-strong-app-management-strong-","delete","expose","run","get","-em-serviceaccount-em-","-em-service-nodeport-em-","-em-service-loadbalancer-em-","-em-service-externalname-em-","-em-service-clusterip-em-","-em-service-em-","-em-secret-tls-em-","-em-secret-generic-em-","-em-secret-docker-registry-em-","-em-secret-em-","-em-rolebinding-em-","-em-role-em-","-em-quota-em-","-em-priorityclass-em-","-em-poddisruptionbudget-em-","-em-namespace-em-","-em-job-em-","-em-deployment-em-","-em-configmap-em-","-em-clusterrolebinding-em-","-em-clusterrole-em-","create","-strong-getting-started-strong-"]};})(); \ No newline at end of file diff --git a/static/docs/reference/generated/kubectl/scroll.js b/static/docs/reference/generated/kubectl/scroll.js index 6639f62895616..67fee8729e449 100644 --- a/static/docs/reference/generated/kubectl/scroll.js +++ b/static/docs/reference/generated/kubectl/scroll.js @@ -187,10 +187,10 @@ $(document).ready(function() { var scrollPosition = $(window).scrollTop(); scrollActions(scrollPosition); checkActiveElement(flatToc, scrollPosition); - // TODO: prevent scroll on sidebar from propagating to window + // TODO: prevent scroll on sidebar from propogating to window $(window).on('scroll', function(event) { var scrollPosition = $(window).scrollTop(); var activeSectionTokens = scrollActions(scrollPosition); var activeElemToken = checkActiveElement(flatToc, scrollPosition); }); -}); +}); \ No newline at end of file diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/index.html b/static/docs/reference/generated/kubernetes-api/v1.11/index.html new file mode 100755 index 0000000000000..e427398de5707 --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.11/index.html @@ -0,0 +1,113523 @@ + + + + +Kubernetes API Reference Docs + + + + + + + + + +
+
  • kubectl
  • curl
+

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:

+
    +
  • 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. Only kubernetes components should fill +this in
    • +
  • 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)
    • +
+
+

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.

+
+

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.10 image
+image: nginx:1.10
+
+
+

Container Config to run nginx (must be embedded in a PodSpec to run).

+
+

+name: nginx
+# Run the nginx:1.10 image
+image: nginx:1.10
+
+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Container
+ + + + + + +

A single application container that you want to run within a pod.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
args
string array		Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
command
string array		Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
env
EnvVar array
patch type: merge
patch merge key: name		List of environment variables to set in the container. Cannot be updated.
envFrom
EnvFromSource array		List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
image
string		Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
imagePullPolicy
string		Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
lifecycle
Lifecycle		Actions that the management system should take in response to container lifecycle events. Cannot be updated.
livenessProbe
Probe		Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
name
string		Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
ports
ContainerPort array
patch type: 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/storage/persistent-volumes#resources
securityContext
SecurityContext		Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
stdin
boolean		Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
stdinOnce
boolean		Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
terminationMessagePath
string		Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
terminationMessagePolicy
string		Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
tty
boolean		Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
volumeDevices
VolumeDevice array
patch type: merge
patch merge key: devicePath		volumeDevices is the list of block devices to be used by the container. This is an alpha feature and may change in the future.
volumeMounts
VolumeMount array
patch type: 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

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

CronJob v1beta1 batch

+ + + + + + + + + + + + + + + +
GroupVersionKind
batchv1beta1CronJob
+ + + +

CronJob represents the configuration of a single cron job.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#spec-and-status
status
CronJobStatus		Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

CronJobSpec v1beta1 batch

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

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

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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CronJob
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CronJob		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CronJob
+

Response

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

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CronJob		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind CronJob

+

HTTP Request

+

GET /apis/batch/v1beta1/cronjobs

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind CronJob

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of CronJob

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of CronJob

+

HTTP Request

+

GET /apis/batch/v1beta1/watch/cronjobs

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CronJob		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

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: extensions/v1beta1
+kind: DaemonSet
+metadata:
+  # Unique key of the DaemonSet instance
+  name: daemonset-example
+spec:
+  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
+
+
+

DaemonSet Config to print the hostname on each Node in the cluster every 10 seconds.

+
+

+apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+  # Unique key of the DaemonSet instance
+  name: daemonset-example
+spec:
+  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
+ + + +

DaemonSet represents the configuration of a daemon set.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
DaemonSetSpec		The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#spec-and-status
+

DaemonSetSpec v1 apps

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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 type: merge
patch merge key: type		Represents the latest available observations of a DaemonSet's current state.
currentNumberScheduled
integer		The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
desiredNumberScheduled
integer		The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
numberAvailable
integer		The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds)
numberMisscheduled
integer		The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
numberReady
integer		The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
numberUnavailable
integer		The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds)
observedGeneration
integer		The most recent generation observed by the daemon set controller.
updatedNumberScheduled
integer		The total number of nodes that are running updated daemon pod
+

DaemonSetList v1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

RollingUpdateDaemonSet v1 apps

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

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+$ echo 'apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+  name: daemonset-example
+spec:
+  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: extensions/v1beta1
+kind: DaemonSet
+metadata:
+  name: daemonset-example
+spec:
+  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": "extensions/v1beta1",
+  "metadata": {
+    "name": "daemonset-example",
+    "namespace": "default",
+    "selfLink": "/apis/extensions/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DaemonSet
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

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

Output

+
+

+
+
+

Response Body

+
+

+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind DaemonSet

+

HTTP Request

+

GET /apis/apps/v1/daemonsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind DaemonSet

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of DaemonSet

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of DaemonSet

+

HTTP Request

+

GET /apis/apps/v1/watch/daemonsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

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/v1beta1
+kind: Deployment
+metadata:
+  # Unique key of the Deployment instance
+  name: deployment-example
+spec:
+  # 3 Pods should exist at all times.
+  replicas: 3
+  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.10
+
+
+

Deployment Config to run 3 nginx instances (max rollback set to 10 revisions).

+
+

+apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  # Unique key of the Deployment instance
+  name: deployment-example
+spec:
+  # 3 Pods should exist at all times.
+  replicas: 3
+  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.10
+
+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1Deployment
+ + + +

Deployment enables declarative updates for Pods and ReplicaSets.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata.
spec
DeploymentSpec		Specification of the desired behavior of the Deployment.
status
DeploymentStatus		Most recently observed status of the Deployment.
+

DeploymentSpec v1 apps

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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 type: merge
patch merge key: type		Represents the latest available observations of a deployment's current state.
observedGeneration
integer		The generation observed by the deployment controller.
readyReplicas
integer		Total number of ready pods targeted by this deployment.
replicas
integer		Total number of non-terminated pods targeted by this deployment (their labels match the selector).
unavailableReplicas
integer		Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
updatedReplicas
integer		Total number of non-terminated pods targeted by this deployment that have the desired template spec.
+

DeploymentList v1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata.
+

DeploymentStrategy v1 apps

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

RollingUpdateDeployment v1 apps

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

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.10
+        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/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.10
+        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/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/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.10",
+            "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.
+

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.11"}]}}}}'
+
+
+

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.11"}]}}}}' \
+    'http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/deployment-example'
+
+
+

Output

+
+

+"deployment-example" patched
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/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.11",
+            "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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

Replace

+
+

kubectl Command

+
+

+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.11
+        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/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.11
+        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/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/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.11",
+            "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.
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

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/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/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.10",
+            "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/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/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.10",
+            "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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

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.10",
+                "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.10",
+                "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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Deployment

+

HTTP Request

+

GET /apis/apps/v1/deployments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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/v1beta1",
+        "metadata": {
+            "name": "deployment-example",
+            "namespace": "default",
+            "selfLink": "/apis/apps/v1beta1/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.10",
+                            "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/v1beta1",
+        "metadata": {
+            "name": "deployment-example",
+            "namespace": "default",
+            "selfLink": "/apis/apps/v1beta1/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.10",
+                            "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

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Deployment

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Deployment

+

HTTP Request

+

GET /apis/apps/v1/watch/deployments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Deployment
+

Response

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

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

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

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+
+

Job v1 batch

+
+

Job Config to print pi up to 2000 digits (then exit).

+
+

+apiVersion: batch/v1
+kind: Job
+metadata:
+  # Unique key of the Job instance
+  name: example-job
+spec:
+  template:
+    metadata:
+      name: example-job
+    spec:
+      containers:
+      - name: pi
+        image: perl
+        command: ["perl"]
+        args: ["-Mbignum=bpi", "-wle", "print bpi(2000)"]
+      # Do not restart containers after they exit
+      restartPolicy: Never
+
+
+

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
+

Job represents the configuration of a single job.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
JobSpec		Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
status
JobStatus		Current status of a job. More info: https://git.k8s.io/community/contributors/devel/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 active before the system tries to terminate it; value must be positive integer
backoffLimit
integer		Specifies the number of retries before marking this job failed. Defaults to 6
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
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/
+

JobStatus v1 batch

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
active
integer		The number of actively running pods.
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.
conditions
JobCondition array
patch type: merge
patch merge key: type		The latest available observations of an object's current state. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
failed
integer		The number of pods which reached phase Failed.
startTime
Time		Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
succeeded
integer		The number of pods which reached phase Succeeded.
+

JobList v1 batch

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Job
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Job		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Job

+

HTTP Request

+

GET /apis/batch/v1/jobs

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Job

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Job

+

HTTP Request

+

GET /apis/batch/v1/watch/jobs

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Job		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

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

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

Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
PodSpec		Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/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/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 type: 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'.
hostAliases
HostAlias array
patch type: 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 type: 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 type: 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, or Liveness 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/
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://github.com/kubernetes/community/blob/master/keps/sig-network/0007-pod-ready%2B%2B.md
restartPolicy
string		Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
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/
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. This field is alpha-level and is honored only by servers that enable the PodShareProcessNamespace feature.
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 delete immediately. 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.
volumes
Volume array
patch type: 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

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

PodList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
Pod array		List of pods. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Pod
+

Response

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

Create Eviction

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Eviction
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Pod		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Pod
+

Response

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

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Pod		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Pod

+

HTTP Request

+

GET /api/v1/pods

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Pod

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Pod

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Pod

+

HTTP Request

+

GET /api/v1/watch/pods

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Pod		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Pod
+

Response

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

Proxy Operations

+

See supported operations below...

+

Create Connect Portforward

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect POST requests to portforward of Pod

+

HTTP Request

+

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

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect POST requests to proxy of Pod

+

HTTP Request

+

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

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect POST requests to proxy of Pod

+

HTTP Request

+

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

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect DELETE requests to proxy of Pod

+

HTTP Request

+

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

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect DELETE requests to proxy of Pod

+

HTTP Request

+

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

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect GET requests to portforward of Pod

+

HTTP Request

+

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

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect GET requests to proxy of Pod

+

HTTP Request

+

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

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect GET requests to proxy of Pod

+

HTTP Request

+

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

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect HEAD requests to proxy of Pod

+

HTTP Request

+

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

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect HEAD requests to proxy of Pod

+

HTTP Request

+

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

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect PUT requests to proxy of Pod

+

HTTP Request

+

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

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect PUT requests to proxy of Pod

+

HTTP Request

+

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

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Pod
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

+

See supported operations below...

+

Read Log

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
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: extensions/v1beta1
+kind: ReplicaSet
+metadata:
+  # Unique key of the ReplicaSet instance
+  name: replicaset-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.10
+
+
+

ReplicaSet Config to run 3 nginx instances.

+
+

+apiVersion: extensions/v1beta1
+kind: ReplicaSet
+metadata:
+  # Unique key of the ReplicaSet instance
+  name: replicaset-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.10
+
+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1ReplicaSet
+ + + + + + +

ReplicaSet ensures that a specified number of pod replicas are running at any given time.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/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/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/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/api-conventions.md#spec-and-status
+

ReplicaSetSpec v1 apps

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

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

ReplicaSetList v1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicaSet
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicaSet
+

Response

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

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1/replicasets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ReplicaSet

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ReplicaSet

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1/watch/replicasets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicaSet
+

Response

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

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

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

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+
+

ReplicationController v1 core

+
+

ReplicationController Config to run 3 nginx instances.

+
+

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

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.10
+
+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ReplicationController
+ + + + + + +

ReplicationController represents the configuration of a replication controller.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/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/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/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/api-conventions.md#spec-and-status
+

ReplicationControllerSpec v1 core

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
availableReplicas
integer		The number of available replicas (ready for at least minReadySeconds) for this replication controller.
conditions
ReplicationControllerCondition array
patch type: 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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicationController
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicationController		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicationController
+

Response

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

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicationController		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ReplicationController

+

HTTP Request

+

GET /api/v1/replicationcontrollers

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ReplicationController

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ReplicationController

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ReplicationController

+

HTTP Request

+

GET /api/v1/watch/replicationcontrollers

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicationController		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicationController
+

Response

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

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

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

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+
+

StatefulSet v1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1StatefulSet
+ + + +

StatefulSet represents a set of pods with consistent identities. Identities are defined as:

+
    +
  • Network: A single stable DNS and hostname.
    • +
  • Storage: As many VolumeClaims as requested. +The StatefulSet guarantees that a given network identity will always map to the same storage identity.
    • +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
StatefulSetSpec		Spec defines the desired identities of pods in this set.
status
StatefulSetStatus		Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.
+

StatefulSetSpec v1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
podManagementPolicy
string		podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
replicas
integer		replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
revisionHistoryLimit
integer		revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
selector
LabelSelector		selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
serviceName
string		serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
template
PodTemplateSpec		template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
updateStrategy
StatefulSetUpdateStrategy		updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
volumeClaimTemplates
PersistentVolumeClaim array		volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
+

StatefulSetStatus v1 apps

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

StatefulSetList v1 apps

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

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StatefulSet
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StatefulSet
+

Response

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

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind StatefulSet

+

HTTP Request

+

GET /apis/apps/v1/statefulsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind StatefulSet

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of StatefulSet

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of StatefulSet

+

HTTP Request

+

GET /apis/apps/v1/watch/statefulsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StatefulSet
+

Response

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

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

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

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+

DISCOVERY & LOAD BALANCING

+

Discovery and Load Balancing 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
+

Endpoints is a collection of endpoints that implement the actual service. Example: + Name: "mysvc", + Subsets: [ + { + Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], + Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] + }, + { + Addresses: [{"ip": "10.10.3.3"}], + Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] + }, + ]

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Endpoints
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Endpoints		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Endpoints
+

Response

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

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Endpoints		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Endpoints

+

HTTP Request

+

GET /api/v1/endpoints

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Endpoints

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Endpoints

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Endpoints

+

HTTP Request

+

GET /api/v1/watch/endpoints

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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 v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1Ingress
+

Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
IngressSpec		Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#spec-and-status
+

IngressSpec v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
backend
IngressBackend		A default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default.
rules
IngressRule array		A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.
tls
IngressTLS array		TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.
+

IngressStatus v1beta1 extensions

+ + + + + + + + + + + + + + + +
FieldDescription
loadBalancer
LoadBalancerStatus		LoadBalancer contains the current status of the load-balancer.
+

IngressList v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create an Ingress

+

HTTP Request

+

POST /apis/extensions/v1beta1/namespaces/{namespace}/ingresses

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Ingress
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified Ingress

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Ingress		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified Ingress

+

HTTP Request

+

PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Ingress
+

Response

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

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete an Ingress

+

HTTP Request

+

DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of Ingress

+

HTTP Request

+

DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified Ingress

+

HTTP Request

+

GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Ingress		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Ingress

+

HTTP Request

+

GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Ingress

+

HTTP Request

+

GET /apis/extensions/v1beta1/ingresses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Ingress

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses/{name}

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Ingress

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Ingress

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/ingresses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified Ingress

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Ingress		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified Ingress

+

HTTP Request

+

GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status

+

Path Parameters

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

Query Parameters

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

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Ingress		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified Ingress

+

HTTP Request

+

PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Ingress
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
Ingress		Created
200
Ingress		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
+
+
+

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
+

Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
ServiceSpec		Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/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/api-conventions.md#spec-and-status
+

ServiceSpec v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
clusterIP
string		clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. 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 kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires Type to be ExternalName.
externalTrafficPolicy
string		externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading.
healthCheckNodePort
integer		healthCheckNodePort specifies the healthcheck nodePort for the service. If not specified, HealthCheckNodePort is created by the service api backend with the allocated nodePort. Will use user-specified nodePort value if specified by the client. Only effects when Type is set to LoadBalancer and ExternalTrafficPolicy is set to Local.
loadBalancerIP
string		Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature.
loadBalancerSourceRanges
string array		If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/
ports
ServicePort array
patch type: 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, when set to true, indicates that DNS implementations must publish the notReadyAddresses of subsets for the Endpoints associated with the Service. The default value is false. The primary use case for setting this field is to use a StatefulSet's Headless Service to propagate SRV records for its Pods without respect to their readiness for purpose of peer discovery.
selector
object		Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/
sessionAffinity
string		Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
sessionAffinityConfig
SessionAffinityConfig		sessionAffinityConfig contains the configurations of session affinity.
type
string		type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "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. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services---service-types
+

ServiceStatus v1 core

+ + + + + + + + + + + + + + + +
FieldDescription
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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

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

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Service		OK
+

Replace

+
+

kubectl Command

+
+

+$ echo 'apiVersion: v1
+kind: Service
+metadata:
+  name: deployment-example
+  resourceVersion: "2205995"
+spec:
+  clusterIP: 10.183.250.161
+  ports:
+  - name: http
+    nodePort: 32417
+    port: 80
+    protocol: TCP
+    targetPort: 8080
+  selector:
+    app: nginx
+  sessionAffinity: None
+  type: LoadBalancer
+' | kubectl replace -f -
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+$ kubectl proxy
+$ curl -X PUT -H 'Content-Type: application/yaml' --data '
+apiVersion: v1
+kind: Service
+metadata:
+  name: deployment-example
+  resourceVersion: "2205995"
+spec:
+  clusterIP: 10.183.250.161
+  ports:
+  - name: http
+    nodePort: 32417
+    port: 80
+    protocol: TCP
+    targetPort: 8080
+  selector:
+    app: nginx
+  sessionAffinity: None
+  type: LoadBalancer
+' http://127.0.0.1:8001/api/v1/namespaces/default/services/deployment-example
+
+
+

Output

+
+

+service "deployment-example" replaced
+
+
+

Response Body

+
+

+{
+  "kind": "Service",
+  "apiVersion": "v1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/api/v1/namespaces/default/services/deployment-example",
+    "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+    "resourceVersion": "2208672",
+    "creationTimestamp": "2016-10-28T17:04:24Z"
+  },
+  "spec": {
+    "ports": [
+      {
+        "name": "http",
+        "protocol": "TCP",
+        "port": 80,
+        "targetPort": 8080,
+        "nodePort": 32417
+      }
+    ],
+    "selector": {
+      "app": "nginx"
+    },
+    "clusterIP": "10.183.250.161",
+    "type": "LoadBalancer",
+    "sessionAffinity": "None"
+  },
+  "status": {
+    "loadBalancer": {
+      "ingress": [
+        {
+          "ip": "104.198.186.106"
+        }
+      ]
+    }
+  }
+}
+
+

replace the specified Service

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/services/{name}

+

Path Parameters

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

Query Parameters

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

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Read Operations

+

See supported operations below...

+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

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

Output

+
+

+
+
+

Response Body

+
+

+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Service

+

HTTP Request

+

GET /api/v1/services

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Service

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Service

+

HTTP Request

+

GET /api/v1/watch/services

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Service		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Service
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
Service		Created
200
Service		OK
+

Proxy Operations

+

See supported operations below...

+

Create Connect Proxy

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect POST requests to proxy of Service

+

HTTP Request

+

POST /api/v1/namespaces/{namespace}/services/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect POST requests to proxy of Service

+

HTTP Request

+

POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect DELETE requests to proxy of Service

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect DELETE requests to proxy of Service

+

HTTP Request

+

DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect GET requests to proxy of Service

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/services/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect GET requests to proxy of Service

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect HEAD requests to proxy of Service

+

HTTP Request

+

HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect HEAD requests to proxy of Service

+

HTTP Request

+

HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect PUT requests to proxy of Service

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/services/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect PUT requests to proxy of Service

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
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
+

ConfigMap holds configuration data for pods to consume.

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

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ConfigMap
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ConfigMap		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ConfigMap
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ConfigMap		OK
201
ConfigMap		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ConfigMap		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ConfigMap

+

HTTP Request

+

GET /api/v1/configmaps

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ConfigMap

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ConfigMap

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ConfigMap

+

HTTP Request

+

GET /api/v1/watch/configmaps

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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
+

Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
stringData
object		stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.
type
string		Used to facilitate programmatic handling of secret data.
+

SecretList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Secret
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Secret		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Secret
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Secret		OK
201
Secret		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Secret		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Secret

+

HTTP Request

+

GET /api/v1/secrets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Secret

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Secret

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Secret

+

HTTP Request

+

GET /api/v1/watch/secrets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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
+ + + + + +

PersistentVolumeClaim is a user's request for and claim to a persistent volume

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/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
resources
ResourceRequirements		Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
selector
LabelSelector		A label query over volumes to consider for binding.
storageClassName
string		Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
volumeMode
string		volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is an alpha feature and may change in the future.
volumeName
string		VolumeName is the binding reference to the PersistentVolume backing this claim.
+

PersistentVolumeClaimStatus v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
accessModes
string array		AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
capacity
object		Represents the actual resources of the underlying volume.
conditions
PersistentVolumeClaimCondition array
patch type: merge
patch merge key: type		Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.
phase
string		Phase represents the current phase of PersistentVolumeClaim.
+

PersistentVolumeClaimList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PersistentVolumeClaim
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PersistentVolumeClaim		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PersistentVolumeClaim
+

Response

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

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PersistentVolumeClaim		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PersistentVolumeClaim

+

HTTP Request

+

GET /api/v1/persistentvolumeclaims

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind PersistentVolumeClaim

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PersistentVolumeClaim

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PersistentVolumeClaim

+

HTTP Request

+

GET /api/v1/watch/persistentvolumeclaims

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PersistentVolumeClaim		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PersistentVolumeClaim
+

Response

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

StorageClass v1 storage.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
storage.k8s.iov1StorageClass
+ + + +

StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.

+

StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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 alpha-level and is only honored by servers that enable the DynamicProvisioningScheduling 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/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/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 alpha-level and 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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a StorageClass

+

HTTP Request

+

POST /apis/storage.k8s.io/v1/storageclasses

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StorageClass
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StorageClass		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StorageClass
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
StorageClass		OK
201
StorageClass		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StorageClass		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind StorageClass

+

HTTP Request

+

GET /apis/storage.k8s.io/v1/watch/storageclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of StorageClass

+

HTTP Request

+

GET /apis/storage.k8s.io/v1/watch/storageclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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
+

Volume represents a named volume in a pod that may be accessed by any container in the pod.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
configMap
ConfigMapVolumeSource		ConfigMap represents a configMap that should populate this volume
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
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://releases.k8s.io/HEAD/examples/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://releases.k8s.io/HEAD/examples/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://releases.k8s.io/HEAD/examples/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 v1beta1 storage.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
storage.k8s.iov1beta1VolumeAttachment
+ + + +

VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.

+

VolumeAttachment objects are non-namespaced.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
VolumeAttachmentSpec		Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.
status
VolumeAttachmentStatus		Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.
+

VolumeAttachmentSpec v1beta1 storage

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
attacher
string		Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().
nodeName
string		The node that the volume should be attached to.
source
VolumeAttachmentSource		Source represents the volume that should be attached.
+

VolumeAttachmentStatus v1beta1 storage

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
attachError
VolumeError		The last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
attached
boolean		Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
attachmentMetadata
object		Upon successful attach, this field is populated with any information returned by the attach operation that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
detachError
VolumeError		The last error encountered during detach operation, if any. This field must only be set by the entity completing the detach operation, i.e. the external-attacher.
+

VolumeAttachmentList v1beta1 storage

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a VolumeAttachment

+

HTTP Request

+

POST /apis/storage.k8s.io/v1beta1/volumeattachments

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
VolumeAttachment
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified VolumeAttachment

+

HTTP Request

+

PATCH /apis/storage.k8s.io/v1beta1/volumeattachments/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
VolumeAttachment		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified VolumeAttachment

+

HTTP Request

+

PUT /apis/storage.k8s.io/v1beta1/volumeattachments/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
VolumeAttachment
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
VolumeAttachment		OK
201
VolumeAttachment		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a VolumeAttachment

+

HTTP Request

+

DELETE /apis/storage.k8s.io/v1beta1/volumeattachments/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of VolumeAttachment

+

HTTP Request

+

DELETE /apis/storage.k8s.io/v1beta1/volumeattachments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified VolumeAttachment

+

HTTP Request

+

GET /apis/storage.k8s.io/v1beta1/volumeattachments/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
VolumeAttachment		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind VolumeAttachment

+

HTTP Request

+

GET /apis/storage.k8s.io/v1beta1/volumeattachments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind VolumeAttachment

+

HTTP Request

+

GET /apis/storage.k8s.io/v1beta1/watch/volumeattachments/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of VolumeAttachment

+

HTTP Request

+

GET /apis/storage.k8s.io/v1beta1/watch/volumeattachments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+

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.
    • +
  • ThirdPartyResource for extending the Kubernetes APIs with your own types
    • +
  • Event for notification of resource lifecycle events in the cluster.
    • +
+
+
+

ControllerRevision v1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1ControllerRevision
+ + + +

ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/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/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/api-conventions.md#types-kinds
metadata
ListMeta		More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ControllerRevision
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ControllerRevision		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ControllerRevision
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
ControllerRevision		Created
200
ControllerRevision		OK
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ControllerRevision		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1/controllerrevisions

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ControllerRevision

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ControllerRevision

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1/watch/controllerrevisions

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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 v1beta1 apiextensions.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1CustomResourceDefinition
+

CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
CustomResourceDefinitionSpec		Spec describes how the user wants the resources to appear
status
CustomResourceDefinitionStatus		Status indicates the actual state of the CustomResourceDefinition
+

CustomResourceDefinitionSpec v1beta1 apiextensions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
additionalPrinterColumns
CustomResourceColumnDefinition array		AdditionalPrinterColumns are additional columns shown e.g. in kubectl next to the name. Defaults to a created-at column.
group
string		Group is the group this resource belongs in
names
CustomResourceDefinitionNames		Names are the names used to describe this custom resource
scope
string		Scope indicates whether this resource is cluster or namespace scoped. Default is namespaced
subresources
CustomResourceSubresources		Subresources describes the subresources for CustomResources
validation
CustomResourceValidation		Validation describes the validation methods for CustomResources
version
string		Version is the version this resource belongs in Should be always first item in Versions field if provided. Optional, but at least one of Version or Versions must be set. Deprecated: Please use Versions.
versions
CustomResourceDefinitionVersion array		Versions is the list of all supported versions for this resource. If Version field is provided, this field is optional. Validation: All versions must use the same validation schema for now. i.e., top level Validation field is applied to all of these versions. Order: The version name will be used to compute the order. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.
+

CustomResourceDefinitionStatus v1beta1 apiextensions

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
acceptedNames
CustomResourceDefinitionNames		AcceptedNames are the names that are actually being used to serve discovery They may be different than the names in spec.
conditions
CustomResourceDefinitionCondition array		Conditions indicate state for particular aspects of a CustomResourceDefinition
storedVersions
string array		StoredVersions are 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 the migration controller can first finish a migration to another version (i.e. that no old objects are left in the storage), and then remove the rest of the versions from this list. None of the versions in this list can be removed from the spec.Versions field.
+

CustomResourceDefinitionList v1beta1 apiextensions

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

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a CustomResourceDefinition

+

HTTP Request

+

POST /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CustomResourceDefinition
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified CustomResourceDefinition

+

HTTP Request

+

PATCH /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CustomResourceDefinition		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified CustomResourceDefinition

+

HTTP Request

+

PUT /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CustomResourceDefinition
+

Response

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

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a CustomResourceDefinition

+

HTTP Request

+

DELETE /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of CustomResourceDefinition

+

HTTP Request

+

DELETE /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified CustomResourceDefinition

+

HTTP Request

+

GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CustomResourceDefinition		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind CustomResourceDefinition

+

HTTP Request

+

GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind CustomResourceDefinition

+

HTTP Request

+

GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of CustomResourceDefinition

+

HTTP Request

+

GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified CustomResourceDefinition

+

HTTP Request

+

PATCH /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CustomResourceDefinition		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified CustomResourceDefinition

+

HTTP Request

+

GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

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

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CustomResourceDefinition		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified CustomResourceDefinition

+

HTTP Request

+

PUT /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CustomResourceDefinition
+

Response

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

Event v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Event
+ + + +

Event is a report of an event somewhere in the cluster.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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/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/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/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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Event
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Event		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Event
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
Event		Created
200
Event		OK
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Event		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Event

+

HTTP Request

+

GET /api/v1/events

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Event

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Event

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Event

+

HTTP Request

+

GET /api/v1/watch/events

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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
+

LimitRange sets resource usage limits for each kind of resource in a Namespace.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
LimitRangeSpec		Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

LimitRangeSpec v1 core

+ + + + + + + + + + + + + + + +
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/api-conventions.md#resources
items
LimitRange array		Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
LimitRange
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
LimitRange		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
LimitRange
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
LimitRange		OK
201
LimitRange		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
LimitRange		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind LimitRange

+

HTTP Request

+

GET /api/v1/limitranges

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind LimitRange

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of LimitRange

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of LimitRange

+

HTTP Request

+

GET /api/v1/watch/limitranges

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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
+ + + +

configuration of a horizontal pod autoscaler.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
HorizontalPodAutoscalerSpec		behaviour of autoscaler. More info: https://git.k8s.io/community/contributors/devel/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		lower limit for the number of pods that can be set by the autoscaler, default 1.
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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
HorizontalPodAutoscaler
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
HorizontalPodAutoscaler		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
HorizontalPodAutoscaler
+

Response

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

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
HorizontalPodAutoscaler		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind HorizontalPodAutoscaler

+

HTTP Request

+

GET /apis/autoscaling/v1/horizontalpodautoscalers

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind HorizontalPodAutoscaler

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of HorizontalPodAutoscaler

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of HorizontalPodAutoscaler

+

HTTP Request

+

GET /apis/autoscaling/v1/watch/horizontalpodautoscalers

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
HorizontalPodAutoscaler		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
HorizontalPodAutoscaler
+

Response

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

InitializerConfiguration v1alpha1 admissionregistration.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
admissionregistration.k8s.iov1alpha1InitializerConfiguration
+

InitializerConfiguration describes the configuration of initializers.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
initializers
Initializer array
patch type: merge
patch merge key: name		Initializers is a list of resources and their default initializers Order-sensitive. When merging multiple InitializerConfigurations, we sort the initializers from different InitializerConfigurations by the name of the InitializerConfigurations; the order of the initializers from the same InitializerConfiguration is preserved.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
+

InitializerConfigurationList v1alpha1 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/api-conventions.md#resources
items
InitializerConfiguration array		List of InitializerConfiguration.
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create an InitializerConfiguration

+

HTTP Request

+

POST /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
InitializerConfiguration
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified InitializerConfiguration

+

HTTP Request

+

PATCH /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the InitializerConfiguration
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
InitializerConfiguration		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified InitializerConfiguration

+

HTTP Request

+

PUT /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the InitializerConfiguration
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
InitializerConfiguration
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
InitializerConfiguration		Created
200
InitializerConfiguration		OK
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete an InitializerConfiguration

+

HTTP Request

+

DELETE /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the InitializerConfiguration
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of InitializerConfiguration

+

HTTP Request

+

DELETE /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations

+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified InitializerConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the InitializerConfiguration
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
InitializerConfiguration		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind InitializerConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1alpha1/initializerconfigurations

+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
InitializerConfigurationList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind InitializerConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1alpha1/watch/initializerconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the InitializerConfiguration
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of InitializerConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1alpha1/watch/initializerconfigurations

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

MutatingWebhookConfiguration v1beta1 admissionregistration.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
admissionregistration.k8s.iov1beta1MutatingWebhookConfiguration
+

MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
webhooks
Webhook array
patch type: merge
patch merge key: name		Webhooks is a list of webhooks and the affected resources and operations.
+

MutatingWebhookConfigurationList v1beta1 admissionregistration

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a MutatingWebhookConfiguration

+

HTTP Request

+

POST /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
MutatingWebhookConfiguration
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified MutatingWebhookConfiguration

+

HTTP Request

+

PATCH /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the MutatingWebhookConfiguration
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
MutatingWebhookConfiguration		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified MutatingWebhookConfiguration

+

HTTP Request

+

PUT /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the MutatingWebhookConfiguration
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
MutatingWebhookConfiguration
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
MutatingWebhookConfiguration		OK
201
MutatingWebhookConfiguration		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a MutatingWebhookConfiguration

+

HTTP Request

+

DELETE /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the MutatingWebhookConfiguration
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of MutatingWebhookConfiguration

+

HTTP Request

+

DELETE /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified MutatingWebhookConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the MutatingWebhookConfiguration
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
MutatingWebhookConfiguration		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind MutatingWebhookConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind MutatingWebhookConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1beta1/watch/mutatingwebhookconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the MutatingWebhookConfiguration
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of MutatingWebhookConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1beta1/watch/mutatingwebhookconfigurations

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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 v1beta1 admissionregistration.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
admissionregistration.k8s.iov1beta1ValidatingWebhookConfiguration
+

ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
webhooks
Webhook array
patch type: merge
patch merge key: name		Webhooks is a list of webhooks and the affected resources and operations.
+

ValidatingWebhookConfigurationList v1beta1 admissionregistration

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ValidatingWebhookConfiguration

+

HTTP Request

+

POST /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ValidatingWebhookConfiguration
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ValidatingWebhookConfiguration

+

HTTP Request

+

PATCH /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ValidatingWebhookConfiguration
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ValidatingWebhookConfiguration		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ValidatingWebhookConfiguration

+

HTTP Request

+

PUT /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ValidatingWebhookConfiguration
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ValidatingWebhookConfiguration
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ValidatingWebhookConfiguration		OK
201
ValidatingWebhookConfiguration		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ValidatingWebhookConfiguration

+

HTTP Request

+

DELETE /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ValidatingWebhookConfiguration
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ValidatingWebhookConfiguration

+

HTTP Request

+

DELETE /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ValidatingWebhookConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ValidatingWebhookConfiguration
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ValidatingWebhookConfiguration		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ValidatingWebhookConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ValidatingWebhookConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1beta1/watch/validatingwebhookconfigurations/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ValidatingWebhookConfiguration
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ValidatingWebhookConfiguration

+

HTTP Request

+

GET /apis/admissionregistration.k8s.io/v1beta1/watch/validatingwebhookconfigurations

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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
+

PodTemplate describes a template for creating copies of a predefined pod.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/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/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/api-conventions.md#metadata
spec
PodSpec		Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodTemplate
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodTemplate		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodTemplate
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
PodTemplate		OK
201
PodTemplate		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodTemplate		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PodTemplate

+

HTTP Request

+

GET /api/v1/podtemplates

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind PodTemplate

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PodTemplate

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PodTemplate

+

HTTP Request

+

GET /api/v1/watch/podtemplates

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

PodDisruptionBudget v1beta1 policy

+ + + + + + + + + + + + + + + +
GroupVersionKind
policyv1beta1PodDisruptionBudget
+

PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
PodDisruptionBudgetSpec		Specification of the desired behavior of the PodDisruptionBudget.
status
PodDisruptionBudgetStatus		Most recently observed status of the PodDisruptionBudget.
+

PodDisruptionBudgetSpec v1beta1 policy

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
maxUnavailableAn eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable".
minAvailableAn eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%".
selector
LabelSelector		Label query over pods whose evictions are managed by the disruption budget.
+

PodDisruptionBudgetStatus v1beta1 policy

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
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. PodDisruptionsAllowed and other status informatio 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/api-conventions.md#resources
items
PodDisruptionBudget array
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodDisruptionBudget
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodDisruptionBudget		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodDisruptionBudget
+

Response

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

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodDisruptionBudget		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PodDisruptionBudget

+

HTTP Request

+

GET /apis/policy/v1beta1/poddisruptionbudgets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind PodDisruptionBudget

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PodDisruptionBudget

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PodDisruptionBudget

+

HTTP Request

+

GET /apis/policy/v1beta1/watch/poddisruptionbudgets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodDisruptionBudget		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodDisruptionBudget
+

Response

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

PriorityClass v1beta1 scheduling.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
scheduling.k8s.iov1beta1PriorityClass
+ + + + + + +

PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
value
integer		The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec.
+

PriorityClassList v1beta1 scheduling

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a PriorityClass

+

HTTP Request

+

POST /apis/scheduling.k8s.io/v1beta1/priorityclasses

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PriorityClass
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified PriorityClass

+

HTTP Request

+

PATCH /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PriorityClass		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified PriorityClass

+

HTTP Request

+

PUT /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PriorityClass
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
PriorityClass		OK
201
PriorityClass		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a PriorityClass

+

HTTP Request

+

DELETE /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of PriorityClass

+

HTTP Request

+

DELETE /apis/scheduling.k8s.io/v1beta1/priorityclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified PriorityClass

+

HTTP Request

+

GET /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PriorityClass		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PriorityClass

+

HTTP Request

+

GET /apis/scheduling.k8s.io/v1beta1/priorityclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind PriorityClass

+

HTTP Request

+

GET /apis/scheduling.k8s.io/v1beta1/watch/priorityclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PriorityClass

+

HTTP Request

+

GET /apis/scheduling.k8s.io/v1beta1/watch/priorityclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

PodPreset v1alpha1 settings.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
settings.k8s.iov1alpha1PodPreset
+ + + + + + +

PodPreset is a policy resource that defines additional runtime requirements for a Pod.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
PodPresetSpec
+

PodPresetSpec v1alpha1 settings

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
env
EnvVar array		Env defines the collection of EnvVar to inject into containers.
envFrom
EnvFromSource array		EnvFrom defines the collection of EnvFromSource to inject into containers.
selector
LabelSelector		Selector is a label query over a set of resources, in this case pods. Required.
volumeMounts
VolumeMount array		VolumeMounts defines the collection of VolumeMount to inject into containers.
volumes
Volume array		Volumes defines the collection of Volume to inject into the pod.
+

PodPresetList v1alpha1 settings

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
items
PodPreset 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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a PodPreset

+

HTTP Request

+

POST /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets

+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodPreset
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified PodPreset

+

HTTP Request

+

PATCH /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodPreset		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified PodPreset

+

HTTP Request

+

PUT /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodPreset
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
PodPreset		OK
201
PodPreset		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a PodPreset

+

HTTP Request

+

DELETE /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of PodPreset

+

HTTP Request

+

DELETE /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets

+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified PodPreset

+

HTTP Request

+

GET /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets/{name}

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodPreset		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PodPreset

+

HTTP Request

+

GET /apis/settings.k8s.io/v1alpha1/namespaces/{namespace}/podpresets

+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodPresetList		OK
+

List All Namespaces

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PodPreset

+

HTTP Request

+

GET /apis/settings.k8s.io/v1alpha1/podpresets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodPresetList		OK
+

Watch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind PodPreset

+

HTTP Request

+

GET /apis/settings.k8s.io/v1alpha1/watch/namespaces/{namespace}/podpresets/{name}

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PodPreset

+

HTTP Request

+

GET /apis/settings.k8s.io/v1alpha1/watch/namespaces/{namespace}/podpresets

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PodPreset

+

HTTP Request

+

GET /apis/settings.k8s.io/v1alpha1/watch/podpresets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1PodSecurityPolicy
+

PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container. Deprecated: use PodSecurityPolicy from policy API Group instead.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
PodSecurityPolicySpec		spec defines the policy enforced.
+

PodSecurityPolicySpec v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
allowPrivilegeEscalation
boolean		allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true.
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 a whitelist of allowed 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 a white list of allowed host paths. Empty indicates that all host paths may be used.
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 whitelist 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.
runAsUser
RunAsUserStrategyOptions		runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set.
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 a white list of allowed volume plugins. Empty indicates that no volumes may be used. To allow all volumes you may use '*'.
+

PodSecurityPolicyList v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a PodSecurityPolicy

+

HTTP Request

+

POST /apis/extensions/v1beta1/podsecuritypolicies

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodSecurityPolicy
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified PodSecurityPolicy

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/podsecuritypolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PodSecurityPolicy
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodSecurityPolicy		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified PodSecurityPolicy

+

HTTP Request

+

PUT /apis/extensions/v1beta1/podsecuritypolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PodSecurityPolicy
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodSecurityPolicy
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
PodSecurityPolicy		OK
201
PodSecurityPolicy		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a PodSecurityPolicy

+

HTTP Request

+

DELETE /apis/extensions/v1beta1/podsecuritypolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PodSecurityPolicy
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of PodSecurityPolicy

+

HTTP Request

+

DELETE /apis/extensions/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified PodSecurityPolicy

+

HTTP Request

+

GET /apis/extensions/v1beta1/podsecuritypolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PodSecurityPolicy
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodSecurityPolicy		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PodSecurityPolicy

+

HTTP Request

+

GET /apis/extensions/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind PodSecurityPolicy

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/podsecuritypolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PodSecurityPolicy
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PodSecurityPolicy

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/podsecuritypolicies

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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
+ + + +

APIService represents a server for a particular GroupVersion. Name must be "version.group".

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
APIServiceSpec		Spec contains information for locating and communicating with a server
status
APIServiceStatus		Status contains derived information about an API server
+

APIServiceSpec v1 apiregistration

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
caBundle
string		CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate.
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

+ + + + + + + + + + + + + + + +
FieldDescription
conditions
APIServiceCondition array
patch type: 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/api-conventions.md#resources
items
APIService array
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create an APIService

+

HTTP Request

+

POST /apis/apiregistration.k8s.io/v1/apiservices

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
APIService
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
APIService
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
201
APIService		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind APIService

+

HTTP Request

+

GET /apis/apiregistration.k8s.io/v1/watch/apiservices/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of APIService

+

HTTP Request

+

GET /apis/apiregistration.k8s.io/v1/watch/apiservices

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
APIService
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
201
APIService		Created
+
+

Binding v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Binding
+

Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
target
ObjectReference		The target object that you want to bind to the standard object.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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
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 v1beta1 certificates.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
certificates.k8s.iov1beta1CertificateSigningRequest
+

Describes a certificate signing request

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
CertificateSigningRequestSpec		The certificate request itself and any additional information.
status
CertificateSigningRequestStatus		Derived information about the request.
+

CertificateSigningRequestSpec v1beta1 certificates

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
extra
object		Extra information about the requesting user. See user.Info interface for details.
groups
string array		Group information about the requesting user. See user.Info interface for details.
request
string		Base64-encoded PKCS#10 CSR data
uid
string		UID information about the requesting user. See user.Info interface for details.
usages
string array		allowedUsages specifies a set of usage contexts the key will be valid for. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 https://tools.ietf.org/html/rfc5280#section-4.2.1.12
username
string		Information about the requesting user. See user.Info interface for details.
+

CertificateSigningRequestStatus v1beta1 certificates

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
certificate
string		If request was approved, the controller will place the issued certificate here.
conditions
CertificateSigningRequestCondition array		Conditions applied to the request, such as approval or denial.
+

CertificateSigningRequestList v1beta1 certificates

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

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a CertificateSigningRequest

+

HTTP Request

+

POST /apis/certificates.k8s.io/v1beta1/certificatesigningrequests

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CertificateSigningRequest
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified CertificateSigningRequest

+

HTTP Request

+

PATCH /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CertificateSigningRequest		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified CertificateSigningRequest

+

HTTP Request

+

PUT /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CertificateSigningRequest
+

Response

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

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a CertificateSigningRequest

+

HTTP Request

+

DELETE /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of CertificateSigningRequest

+

HTTP Request

+

DELETE /apis/certificates.k8s.io/v1beta1/certificatesigningrequests

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified CertificateSigningRequest

+

HTTP Request

+

GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CertificateSigningRequest		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind CertificateSigningRequest

+

HTTP Request

+

GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind CertificateSigningRequest

+

HTTP Request

+

GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of CertificateSigningRequest

+

HTTP Request

+

GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified CertificateSigningRequest

+

HTTP Request

+

PATCH /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CertificateSigningRequest		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified CertificateSigningRequest

+

HTTP Request

+

GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

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

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CertificateSigningRequest		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified CertificateSigningRequest

+

HTTP Request

+

PUT /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CertificateSigningRequest
+

Response

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

ClusterRole v1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1ClusterRole
+ + + +

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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/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/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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ClusterRole

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1/clusterroles

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRole
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRole		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRole
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
ClusterRole		Created
200
ClusterRole		OK
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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
+ + + +

ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ClusterRoleBinding

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1/clusterrolebindings

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRoleBinding
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBinding		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRoleBinding
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBinding		OK
201
ClusterRoleBinding		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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
+

ComponentStatus (and ComponentStatusList) holds the cluster validation info.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
conditions
ComponentCondition array
patch type: 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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list objects of kind ComponentStatus

+

HTTP Request

+

GET /api/v1/componentstatuses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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
+
+

LocalSubjectAccessReview v1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1LocalSubjectAccessReview
+ + + +

LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
SubjectAccessReviewSpec		Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted.
status
SubjectAccessReviewStatus		Status is filled in by the server and indicates whether the request is allowed or not
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Namespace provides a scope for Names. Use of multiple namespaces is optional.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
NamespaceSpec		Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#spec-and-status
+

NamespaceSpec v1 core

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

+ + + + + + + + + + + + + + + +
FieldDescription
phase
string		Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
+

NamespaceList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a Namespace

+

HTTP Request

+

POST /api/v1/namespaces

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Namespace
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Namespace		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Namespace
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
Namespace		Created
200
Namespace		OK
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Namespace		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Namespace

+

HTTP Request

+

GET /api/v1/namespaces

+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Namespace

+

HTTP Request

+

GET /api/v1/watch/namespaces/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Namespace
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Namespace

+

HTTP Request

+

GET /api/v1/watch/namespaces

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Namespace		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Namespace
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
Namespace		Created
200
Namespace		OK
+
+

Node v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Node
+

Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
NodeSpec		Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/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/api-conventions.md#spec-and-status
+

NodeSpec v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
configSource
NodeConfigSource		If specified, the source to get node configuration from The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field
externalID
string		Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966
podCIDR
string		PodCIDR represents the pod IP range assigned to the node.
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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
addresses
NodeAddress array
patch type: 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
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 type: merge
patch merge key: type		Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition
config
NodeConfigStatus		Status of the config assigned to the node via the dynamic Kubelet config feature.
daemonEndpoints
NodeDaemonEndpoints		Endpoints of daemons running on the Node.
images
ContainerImage array		List of container images on this node
nodeInfo
NodeSystemInfo		Set of ids/uuids to uniquely identify the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#info
phase
string		NodePhase is the recently observed lifecycle phase of the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#phase The field is never populated, and now is deprecated.
volumesAttached
AttachedVolume array		List of volumes that are attached to the node.
volumesInUse
string array		List of attachable volumes in use (mounted) by the node.
+

NodeList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a Node

+

HTTP Request

+

POST /api/v1/nodes

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Node
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Node		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Node
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
Node		Created
200
Node		OK
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Node		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Node

+

HTTP Request

+

GET /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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Node

+

HTTP Request

+

GET /api/v1/watch/nodes/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Node
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Node

+

HTTP Request

+

GET /api/v1/watch/nodes

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Node		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Node
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Node		OK
201
Node		Created
+

Proxy Operations

+

See supported operations below...

+

Create Connect Proxy

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect POST requests to proxy of Node

+

HTTP Request

+

POST /api/v1/nodes/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Node
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect POST requests to proxy of Node

+

HTTP Request

+

POST /api/v1/nodes/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Node
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect DELETE requests to proxy of Node

+

HTTP Request

+

DELETE /api/v1/nodes/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Node
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect DELETE requests to proxy of Node

+

HTTP Request

+

DELETE /api/v1/nodes/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Node
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect GET requests to proxy of Node

+

HTTP Request

+

GET /api/v1/nodes/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Node
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect GET requests to proxy of Node

+

HTTP Request

+

GET /api/v1/nodes/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Node
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect HEAD requests to proxy of Node

+

HTTP Request

+

HEAD /api/v1/nodes/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Node
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect HEAD requests to proxy of Node

+

HTTP Request

+

HEAD /api/v1/nodes/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Node
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect PUT requests to proxy of Node

+

HTTP Request

+

PUT /api/v1/nodes/{name}/proxy

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the Node
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

connect PUT requests to proxy of Node

+

HTTP Request

+

PUT /api/v1/nodes/{name}/proxy/{path}

+

Path Parameters

+ + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Node
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
+ + + + + +

PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/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://releases.k8s.io/HEAD/examples/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 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
GlusterfsVolumeSource		Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md
hostPath
HostPathVolumeSource		HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
iscsi
ISCSIPersistentVolumeSource		ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin.
local
LocalVolumeSource		Local represents directly-attached storage with node affinity
mountOptions
string array		A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
nfs
NFSVolumeSource		NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
nodeAffinity
VolumeNodeAffinity		NodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume.
persistentVolumeReclaimPolicy
string		What happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
photonPersistentDisk
PhotonPersistentDiskVolumeSource		PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
portworxVolume
PortworxVolumeSource		PortworxVolume represents a portworx volume attached and mounted on kubelets host machine
quobyte
QuobyteVolumeSource		Quobyte represents a Quobyte mount on the host that shares a pod's lifetime
rbd
RBDPersistentVolumeSource		RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://releases.k8s.io/HEAD/examples/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://releases.k8s.io/HEAD/examples/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. This is an alpha feature and may change in the future.
vsphereVolume
VsphereVirtualDiskVolumeSource		VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
+

PersistentVolumeStatus v1 core

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
message
string		A human-readable message indicating details about why the volume is in this state.
phase
string		Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase
reason
string		Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.
+

PersistentVolumeList v1 core

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a PersistentVolume

+

HTTP Request

+

POST /api/v1/persistentvolumes

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PersistentVolume
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PersistentVolume		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PersistentVolume
+

Response

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

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PersistentVolume		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PersistentVolume

+

HTTP Request

+

GET /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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind PersistentVolume

+

HTTP Request

+

GET /api/v1/watch/persistentvolumes/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PersistentVolume
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PersistentVolume

+

HTTP Request

+

GET /api/v1/watch/persistentvolumes

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PersistentVolume		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PersistentVolume
+

Response

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

ResourceQuota v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ResourceQuota
+

ResourceQuota sets aggregate quota restrictions enforced per namespace

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
ResourceQuotaSpec		Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/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/api-conventions.md#spec-and-status
+

ResourceQuotaSpec v1 core

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

+ + + + + + + + + + + + + + + + + + + +
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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ResourceQuota
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ResourceQuota		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ResourceQuota
+

Response

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

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ResourceQuota		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ResourceQuota

+

HTTP Request

+

GET /api/v1/resourcequotas

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ResourceQuota

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ResourceQuota

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ResourceQuota

+

HTTP Request

+

GET /api/v1/watch/resourcequotas

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ResourceQuota		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ResourceQuota
+

Response

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

Role v1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1Role
+ + + +

Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Role
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Role		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Role
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Role		OK
201
Role		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/roles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Role

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Role

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/watch/roles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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
+ + + +

RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
RoleBinding
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleBinding		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
RoleBinding
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
RoleBinding		OK
201
RoleBinding		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/rolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind RoleBinding

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of RoleBinding

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1/watch/rolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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
+ + + +

SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
SelfSubjectAccessReviewSpec		Spec holds information about the request being evaluated. user and groups must be empty
status
SubjectAccessReviewStatus		Status is filled in by the server and indicates whether the request is allowed or not
+

SelfSubjectAccessReviewSpec v1 authorization

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
nonResourceAttributes
NonResourceAttributes		NonResourceAttributes describes information for a non-resource access request
resourceAttributes
ResourceAttributes		ResourceAuthorizationAttributes describes information for a resource access request
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a SelfSubjectAccessReview

+

HTTP Request

+

POST /apis/authorization.k8s.io/v1/selfsubjectaccessreviews

+

Query Parameters

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

SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
SelfSubjectRulesReviewSpec		Spec holds information about the request being evaluated.
status
SubjectRulesReviewStatus		Status is filled in by the server and indicates the set of actions a user can perform.
+

SelfSubjectRulesReviewSpec v1 authorization

+ + + + + + + + + + + + + + + +
FieldDescription
namespace
string		Namespace to evaluate rules for. Required.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a SelfSubjectRulesReview

+

HTTP Request

+

POST /apis/authorization.k8s.io/v1/selfsubjectrulesreviews

+

Query Parameters

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

ServiceAccount binds together: a name, understood by users, and perhaps by peripheral systems, for an identity a principal that can be authenticated and authorized * a set of secrets

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
secrets
ObjectReference array
patch type: 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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ServiceAccount
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ServiceAccount		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ServiceAccount
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ServiceAccount		OK
201
ServiceAccount		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ServiceAccount		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ServiceAccount

+

HTTP Request

+

GET /api/v1/serviceaccounts

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ServiceAccount

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ServiceAccount

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ServiceAccount

+

HTTP Request

+

GET /api/v1/watch/serviceaccounts

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

SubjectAccessReview v1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1SubjectAccessReview
+ + + +

SubjectAccessReview checks whether or not a user or group can perform an action.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
SubjectAccessReviewSpec		Spec holds information about the request being evaluated
status
SubjectAccessReviewStatus		Status is filled in by the server and indicates whether the request is allowed or not
+

SubjectAccessReviewSpec v1 authorization

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
extra
object		Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here.
groups
string array		Groups is the groups you're testing for.
nonResourceAttributes
NonResourceAttributes		NonResourceAttributes describes information for a non-resource access request
resourceAttributes
ResourceAttributes		ResourceAuthorizationAttributes describes information for a resource access request
uid
string		UID information about the requesting user.
user
string		User is the user you're testing for. If you specify "User" but not "Groups", then is it interpreted as "What if User were not a member of any groups
+

SubjectAccessReviewStatus v1 authorization

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
allowed
boolean		Allowed is required. True if the action would be allowed, false otherwise.
denied
boolean		Denied is optional. True if the action would be denied, otherwise false. If both allowed is false and denied is false, then the authorizer has no opinion on whether to authorize the action. Denied may not be true if Allowed is true.
evaluationError
string		EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request.
reason
string		Reason is optional. It indicates why a request was allowed or denied.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a SubjectAccessReview

+

HTTP Request

+

POST /apis/authorization.k8s.io/v1/subjectaccessreviews

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
SubjectAccessReview
+

Response

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

TokenReview v1 authentication.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authentication.k8s.iov1TokenReview
+ + + +

TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
TokenReviewSpec		Spec holds information about the request being evaluated
status
TokenReviewStatus		Status is filled in by the server and indicates whether the request can be authenticated.
+

TokenReviewSpec v1 authentication

+ + + + + + + + + + + + + + + +
FieldDescription
token
string		Token is the opaque bearer token.
+

TokenReviewStatus v1 authentication

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

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a TokenReview

+

HTTP Request

+

POST /apis/authentication.k8s.io/v1/tokenreviews

+

Query Parameters

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

NetworkPolicy describes what network traffic is allowed for a set of Pods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
NetworkPolicySpec		Specification of the desired behavior for this NetworkPolicy.
+

NetworkPolicySpec v1 networking

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
NetworkPolicy
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
NetworkPolicy		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
NetworkPolicy
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
NetworkPolicy		OK
201
NetworkPolicy		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
NetworkPolicy		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind NetworkPolicy

+

HTTP Request

+

GET /apis/networking.k8s.io/v1/networkpolicies

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind NetworkPolicy

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of NetworkPolicy

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of NetworkPolicy

+

HTTP Request

+

GET /apis/networking.k8s.io/v1/watch/networkpolicies

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/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.

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

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiregistration.k8s.iov1APIServiceCondition
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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/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/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.

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

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1AggregationRule
+ + +

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole

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

AllowedFlexVolume v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1AllowedFlexVolume
+

AllowedFlexVolume represents a single Flexvolume that is allowed to be used. Deprecated: use AllowedFlexVolume from policy API Group instead.

+ + + + + + + + + + + + + + + +
FieldDescription
driver
string		driver is the name of the Flexvolume driver.
+

AllowedHostPath v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1AllowedHostPath
+

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. Deprecated: use AllowedHostPath from policy API Group instead.

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

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

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

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

CSIPersistentVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1CSIPersistentVolumeSource
+

Represents storage that is managed by an external CSI volume driver (Beta feature)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
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". Implicitly inferred to be "ext4" if unspecified.
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.
+

Capabilities v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Capabilities
+

Adds and removes POSIX capabilities from running containers.

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
monitors
string array		Required: Monitors is a collection of Ceph monitors More info: https://releases.k8s.io/HEAD/examples/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://releases.k8s.io/HEAD/examples/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://releases.k8s.io/HEAD/examples/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://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
user
string		Optional: User is the rados user name, default is admin More info: https://releases.k8s.io/HEAD/examples/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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
monitors
string array		Required: Monitors is a collection of Ceph monitors More info: https://releases.k8s.io/HEAD/examples/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://releases.k8s.io/HEAD/examples/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://releases.k8s.io/HEAD/examples/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://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
user
string		Optional: User is the rados user name, default is admin More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it
+

CertificateSigningRequestCondition v1beta1 certificates

+ + + + + + + + + + + + + + + +
GroupVersionKind
certificates.k8s.iov1beta1CertificateSigningRequestCondition
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastUpdateTime
Time		timestamp for the last update to this condition
message
string		human readable message with details about the request state
reason
string		brief reason for the request state
type
string		request approval state, currently Approved or Denied.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
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://releases.k8s.io/HEAD/examples/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://releases.k8s.io/HEAD/examples/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://releases.k8s.io/HEAD/examples/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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
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://releases.k8s.io/HEAD/examples/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://releases.k8s.io/HEAD/examples/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://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md
+

ClientIPConfig v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ClientIPConfig
+

ClientIPConfig represents the configurations of Client IP based session affinity.

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

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

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.

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

+ + + + + + + + + + + + + + + + + + + + + + + +
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 it's key must be defined
+

ConfigMapNodeConfigSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ConfigMapNodeConfigSource
+

ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node.

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

+ + + + + + + + + + + + + + + + + + + + + + + +
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 it's 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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
defaultMode
integer		Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. 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 it's keys must be defined
+

ContainerImage v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ContainerImage
+

Describe a container image

+ + + + + + + + + + + + + + + + + + + +
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 or TCP. Defaults to "TCP".
+

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.

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

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

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

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

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		API version of the referent
kind
string		Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds&#34;
name
string		Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
+

CustomResourceColumnDefinition v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1CustomResourceColumnDefinition
+

CustomResourceColumnDefinition specifies a column for server side printing.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
JSONPath
string		JSONPath is a simple JSON path, i.e. with array notation.
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 more.
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 higher priority.
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 more.
+

CustomResourceDefinitionCondition v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1CustomResourceDefinitionCondition
+

CustomResourceDefinitionCondition contains details for the current condition of this pod.

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

CustomResourceDefinitionNames v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1CustomResourceDefinitionNames
+

CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
categories
string array		Categories is a list of grouped resources custom resources belong to (e.g. 'all')
kind
string		Kind is the serialized kind of the resource. It is normally CamelCase and singular.
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. It must match the name of the CustomResourceDefinition-registration too: plural.group and it must be all lowercase.
shortNames
string array		ShortNames are short names for the resource. It must be all lowercase.
singular
string		Singular is the singular name of the resource. It must be all lowercase Defaults to lowercased <kind>
+

CustomResourceDefinitionVersion v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1CustomResourceDefinitionVersion
+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		Name is the version name, e.g. “v1”, “v2beta1”, etc.
served
boolean		Served is a flag enabling/disabling this version from being served via REST APIs
storage
boolean		Storage flags the version as storage version. There must be exactly one flagged as storage version.
+

CustomResourceSubresourceScale v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1CustomResourceSubresourceScale
+

CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
labelSelectorPath
string		LabelSelectorPath defines the JSON path inside of a CustomResource that corresponds to Scale.Status.Selector. Only JSON paths without the array notation are allowed. Must be a JSON Path under .status. Must be set to work with HPA. If there is no value under the given path in the CustomResource, the status label selector value in the /scale subresource will default to the empty string.
specReplicasPath
string		SpecReplicasPath defines the JSON path inside of a CustomResource 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 CustomResource, the /scale subresource will return an error on GET.
statusReplicasPath
string		StatusReplicasPath defines the JSON path inside of a CustomResource 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 CustomResource, the status replica value in the /scale subresource will default to 0.
+

CustomResourceSubresourceStatus v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1CustomResourceSubresourceStatus
+

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 v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1CustomResourceSubresources
+

CustomResourceSubresources defines the status and scale subresources for CustomResources.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
scale
CustomResourceSubresourceScale		Scale denotes the scale subresource for CustomResources
status
CustomResourceSubresourceStatus		Status denotes the status subresource for CustomResources
+

CustomResourceValidation v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1CustomResourceValidation
+

CustomResourceValidation is a list of validation methods for CustomResources.

+ + + + + + + + + + + + + + + +
FieldDescription
openAPIV3Schema
JSONSchemaProps		OpenAPIV3Schema is the OpenAPI v3 schema to be validated against.
+

DaemonEndpoint v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1DaemonEndpoint
+

DaemonEndpoint contains information about a single Daemon endpoint.

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

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

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
rollingUpdate
RollingUpdateDaemonSet		Rolling update config params. Present only if type = "RollingUpdate".
type
string		Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate.
+

DeleteOptions v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1DeleteOptions
+

DeleteOptions may be provided when deleting an API object.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
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/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.

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

+ + + + + + + + + + + + + + + +
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 to use on this file, must be a value between 0 and 0777. 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.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
defaultMode
integer		Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. 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.

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

EndpointAddress v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1EndpointAddress
+

EndpointAddress is a tuple that describes single IP address.

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

EndpointPort v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1EndpointPort
+

EndpointPort is a tuple that describes a single port.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		The name of this port (corresponds to ServicePort.Name). 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 or TCP. Default is TCP.
+

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 ]

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
addresses
EndpointAddress array		IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize.
notReadyAddresses
EndpointAddress array		IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check.
ports
EndpointPort array		Port numbers available on the related IP addresses.
+

EnvFromSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1EnvFromSource
+

EnvFromSource represents the source of a set of ConfigMaps

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
configMapRef
ConfigMapEnvSource		The ConfigMap to select from
prefix
string		An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
secretRef
SecretEnvSource		The Secret to select from
+

EnvVar v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1EnvVar
+

EnvVar represents an environment variable present in a Container.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		Name of the environment variable. Must be a C_IDENTIFIER.
value
string		Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
valueFrom
EnvVarSource		Source for the environment variable's value. Cannot be used if value is not empty.
+

EnvVarSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1EnvVarSource
+

EnvVarSource represents a source for the value of an EnvVar.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
configMapKeyRef
ConfigMapKeySelector		Selects a key of a ConfigMap.
fieldRef
ObjectFieldSelector		Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP.
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
+

EventSeries v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1EventSeries
+ + +

EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
count
integer		Number of occurrences in this series up to the last heartbeat time
lastObservedTime
MicroTime		Time of the last occurrence observed
state
string		State of this Series: Ongoing or Finished
+

EventSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1EventSource
+

EventSource contains information for an event.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
component
string		Component from which the event is generated.
host
string		Node name on which the event is generated.
+

Eviction v1beta1 policy

+ + + + + + + + + + + + + + + +
GroupVersionKind
policyv1beta1Eviction
+

Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods/<pod name>/evictions.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/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 v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1ExternalDocumentation
+

ExternalDocumentation allows referencing an external resource for extended documentation.

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

ExternalMetricSource v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1ExternalMetricSource
+

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). Exactly one "target" type should be set.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
metricName
string		metricName is the name of the metric in question.
metricSelector
LabelSelector		metricSelector is used to identify a specific time series within a given metric.
targetAverageValue
Quantity		targetAverageValue is the target per-pod value of global metric (as a quantity). Mutually exclusive with TargetValue.
targetValue
Quantity		targetValue is the target value of the metric (as a quantity). Mutually exclusive with TargetAverageValue.
+

ExternalMetricStatus v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1ExternalMetricStatus
+

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

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

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 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1FSGroupStrategyOptions
+

FSGroupStrategyOptions defines the strategy type and options used to create the strategy. Deprecated: use FSGroupStrategyOptions from policy API Group instead.

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

FlexPersistentVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1FlexPersistentVolumeSource
+

FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.

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

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

GCEPersistentDiskVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1GCEPersistentDiskVolumeSource
+

Represents a Persistent Disk resource in Google Compute Engine.

+

A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
fsType
string		Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
partition
integer		The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
pdName
string		Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
readOnly
boolean		ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+

GitRepoVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1GitRepoVolumeSource
+

Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.

+

DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

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

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
endpoints
string		EndpointsName is the endpoint name that details Glusterfs topology. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
path
string		Path is the Glusterfs volume path. More info: https://releases.k8s.io/HEAD/examples/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://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod
+

GroupVersionForDiscovery v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1GroupVersionForDiscovery
+

GroupVersion contains the "group/version" and "version" string of a version. It is made a struct to keep extensibility.

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

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

HTTPHeader v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1HTTPHeader
+

HTTPHeader describes a custom header to be used in HTTP probes

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		The header field name
value
string		The header field value
+

HTTPIngressPath v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1HTTPIngressPath
+

HTTPIngressPath associates a path regex 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 an extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) 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 '/'. If unspecified, the path defaults to a catch all sending traffic to the backend.
+

HTTPIngressRuleValue v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1HTTPIngressRuleValue
+

HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart&gt; -> 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 '#'.

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

Handler v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Handler
+

Handler defines a specific action that should be taken

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
exec
ExecAction		One and only one of the following should be specified. Exec specifies the action to take.
httpGet
HTTPGetAction		HTTPGet specifies the http request to perform.
tcpSocket
TCPSocketAction		TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
+

HorizontalPodAutoscalerCondition v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1HorizontalPodAutoscalerCondition
+

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

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

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

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1HostPortRange
+

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. Deprecated: use HostPortRange from policy API Group instead.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
max
integer		max is the end of the range, inclusive.
min
integer		min is the start of the range, inclusive.
+

IDRange v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1IDRange
+

IDRange provides a min/max of an allowed range of IDs. Deprecated: use IDRange from policy API Group instead.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
max
integer		max is the end of the range, inclusive.
min
integer		min is the start of the range, inclusive.
+

IPBlock v1 networking

+ + + + + + + + + + + + + + + +
GroupVersionKind
networking.k8s.iov1IPBlock
+ + +

IPBlock describes a particular CIDR (Ex. "192.168.1.1/24") 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"
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" 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.

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

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

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1IngressBackend
+

IngressBackend describes all endpoints for a given service and port.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
serviceName
string		Specifies the name of the referenced service.
servicePortSpecifies the port of the referenced service.
+

IngressRule v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1IngressRule
+

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.

+ + + + + + + + + + + + + + + + + + + +
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 the RFC: 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.
http
HTTPIngressRuleValue
+

IngressTLS v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1IngressTLS
+

IngressTLS describes the transport layer security associated with an Ingress.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
hosts
string array		Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified.
secretName
string		SecretName is the name of the secret used to terminate SSL traffic on 443. Field is left optional to allow SSL routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing.
+

Initializer v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1Initializer
+ + +

Initializer is information about an initializer that has not yet completed.

+ + + + + + + + + + + + + + + +
FieldDescription
name
string		name of the process that is responsible for initializing this object.
+

Initializers v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1Initializers
+

Initializers tracks the progress of initialization.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
pending
Initializer array
patch type: merge
patch merge key: name		Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.
result
Status		If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion.
+

JSON v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1JSON
+

JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.

+ + + + + + + + + + + + + + + +
FieldDescription
Raw
string
+

JSONSchemaProps v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1JSONSchemaProps
+

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
definitions
object
dependencies
object
description
string
enum
JSON array
example
JSON
exclusiveMaximum
boolean
exclusiveMinimum
boolean
externalDocs
ExternalDocumentation
format
string
id
string
items
JSONSchemaPropsOrArray
maxItems
integer
maxLength
integer
maxProperties
integer
maximum
number
minItems
integer
minLength
integer
minProperties
integer
minimum
number
multipleOf
number
not
JSONSchemaProps
oneOf
JSONSchemaProps array
pattern
string
patternProperties
object
properties
object
required
string array
title
string
type
string
uniqueItems
boolean
+

JSONSchemaPropsOrArray v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1JSONSchemaPropsOrArray
+

JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
JSONSchemas
JSONSchemaProps array
Schema
JSONSchemaProps
+

JSONSchemaPropsOrBool v1beta1 apiextensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1JSONSchemaPropsOrBool
+

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

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
Allows
boolean
Schema
JSONSchemaProps
+

JobCondition v1 batch

+ + + + + + + + + + + + + + + +
GroupVersionKind
batchv1JobCondition
+

JobCondition describes current state of a job.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastProbeTime
Time		Last time the condition was checked.
lastTransitionTime
Time		Last time the condition transit from one status to another.
message
string		Human readable message indicating details about last transition.
reason
string		(brief) reason for the condition's last transition.
status
string		Status of the condition, one of True, False, Unknown.
type
string		Type of job condition, Complete or Failed.
+

JobTemplateSpec v1beta1 batch

+ + + + + + + + + + + + + + + +
GroupVersionKind
batchv1beta1JobTemplateSpec
+ + +

JobTemplateSpec describes the data a Job should have when created from a template

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
metadata
ObjectMeta		Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
JobSpec		Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/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 to use on this file, must be a value between 0 and 0777. 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.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
key
string
patch type: merge
patch merge key: key		key is the label key that the selector applies to.
operator
string		operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values
string array		values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
+

Lifecycle v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Lifecycle
+

Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
postStart
Handler		PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
preStop
Handler		PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
+

LimitRangeItem v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1LimitRangeItem
+

LimitRangeItem defines a min/max usage limit for any resource that matches on kind.

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

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

+ + + + + + + + + + + + + + + + + + + + + + + +
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 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.
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/api-conventions.md#concurrency-control-and-consistency
selfLink
string		selfLink is a URL representing this object. Populated by the system. Read-only.
+

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.

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

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)

+ + + + + + + + + + + + + + + +
FieldDescription
path
string		The full path to the volume on the node. It can be either a directory or block device (disk, partition, ...). Directories can be represented only by PersistentVolume with VolumeMode=Filesystem. Block devices can be represented only by VolumeMode=Block, which also requires the BlockVolume alpha feature gate to be enabled.
+

MetricSpec v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1MetricSpec
+

MetricSpec specifies how to scale based on a single metric (only type and one other matching field should be set at once).

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
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 "Object", "Pods" or "Resource", each mapping to a matching field in the object.
+

MetricStatus v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1MetricStatus
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
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 "Object", "Pods" or "Resource", each corresponds to a matching field in the object.
+

MicroTime v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1MicroTime
+ + + + + + + + + + + + + + +
FieldDescription
+

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
+

NetworkPolicyEgressRule v1 networking

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

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

+ + + + + + + + + + + + + + + +
GroupVersionKind
networking.k8s.iov1NetworkPolicyPeer
+ + +

NetworkPolicyPeer describes a peer to allow traffic 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

+ + + + + + + + + + + + + + + +
GroupVersionKind
networking.k8s.iov1NetworkPolicyPort
+ + +

NetworkPolicyPort describes a port to allow traffic on

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
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.
protocol
string		The protocol (TCP or UDP) 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.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
address
string		The node address.
type
string		Node address type, one of Hostname, ExternalIP or InternalIP.
+

NodeAffinity v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1NodeAffinity
+

Node affinity is a group of node affinity scheduling rules.

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastHeartbeatTime
Time		Last time we got an update on a given condition.
lastTransitionTime
Time		Last time the condition transit from one status to another.
message
string		Human readable message indicating details about last transition.
reason
string		(brief) reason for the condition's last transition.
status
string		Status of the condition, one of True, False, Unknown.
type
string		Type of node condition.
+

NodeConfigSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1NodeConfigSource
+

NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil.

+ + + + + + + + + + + + + + + +
FieldDescription
configMap
ConfigMapNodeConfigSource		ConfigMap is a reference to a Node's ConfigMap
+

NodeConfigStatus v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1NodeConfigStatus
+

NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.

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

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

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
key
string		The label key that the selector applies to.
operator
string		Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values
string array		An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
+

NodeSelectorTerm v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1NodeSelectorTerm
+

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
matchExpressions
NodeSelectorRequirement array		A list of node selector requirements by node's labels.
matchFields
NodeSelectorRequirement array		A list of node selector requirements by node's fields.
+

NodeSystemInfo v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1NodeSystemInfo
+

NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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/getting-system-uuid.html
+

NonResourceAttributes v1 authorization

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

NonResourceRule v1 authorization

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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/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/api-conventions.md#metadata
finalizers
string array
patch type: 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.
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/api-conventions.md#idempotency
generation
integer		A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
initializers
Initializers		An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects. When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.
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
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 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 type: 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/api-conventions.md#concurrency-control-and-consistency
selfLink
string		SelfLink is a URL representing this object. Populated by the system. Read-only.
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 v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1ObjectMetricSource
+

ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
metricName
string		metricName is the name of the metric in question.
target
CrossVersionObjectReference		target is the described Kubernetes object.
targetValue
Quantity		targetValue is the target value of the metric (as a quantity).
+

ObjectMetricStatus v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1ObjectMetricStatus
+

ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
currentValue
Quantity		currentValue is the current value of the metric (as a quantity).
metricName
string		metricName is the name of the metric in question.
target
CrossVersionObjectReference		target is the described Kubernetes object.
+

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

OwnerReference v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1OwnerReference
+

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

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

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

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

+ + + + + + + + + + + + + + + + + + + +
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.
namespaces
string array		namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list 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.

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastProbeTime
Time		Last time we probed the condition.
lastTransitionTime
Time		Last time the condition transitioned from one status to another.
message
string		Human-readable message indicating details about last transition.
reason
string		Unique, one-word, CamelCase reason for the condition's last transition.
status
string		Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
type
string		Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
+

PodDNSConfig v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1PodDNSConfig
+

PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.

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

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		Required.
value
string
+

PodReadinessGate v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1PodReadinessGate
+

PodReadinessGate contains the reference to a pod condition

+ + + + + + + + + + + + + + + +
FieldDescription
conditionType
string		ConditionType refers to a condition in the pod's condition list with matching type.
+

PodSecurityContext v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1PodSecurityContext
+

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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.
runAsGroup
integer		The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
runAsNonRoot
boolean		Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsUser
integer		The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
seLinuxOptions
SELinuxOptions		The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
supplementalGroups
integer array		A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.
sysctls
Sysctl array		Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.
+

PodsMetricSource v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1PodsMetricSource
+

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.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
metricName
string		metricName is the name of the metric in question
targetAverageValue
Quantity		targetAverageValue is the target value of the average of the metric across all relevant pods (as a quantity)
+

PodsMetricStatus v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1PodsMetricStatus
+

PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).

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

PolicyRule v1 rbac

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiGroups
string array		APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
nonResourceURLs
string array		NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
resourceNames
string array		ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
resources
string array		Resources is a list of resources this rule applies to. ResourceAll represents all resources.
verbs
string array		Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
+

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.

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

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

Probe v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Probe
+

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
exec
ExecAction		One and only one of the following should be specified. Exec specifies the action to take.
failureThreshold
integer		Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
httpGet
HTTPGetAction		HTTPGet specifies the http request to perform.
initialDelaySeconds
integer		Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
periodSeconds
integer		How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
successThreshold
integer		Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.
tcpSocket
TCPSocketAction		TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
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

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
defaultMode
integer		Mode bits to use on created files by default. Must be a value between 0 and 0777. 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
+ + + + + + + + + + + + + + +
FieldDescription
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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://releases.k8s.io/HEAD/examples/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://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
monitors
string array		A collection of Ceph monitors. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
pool
string		The rados pool name. Default is rbd. More info: https://releases.k8s.io/HEAD/examples/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://releases.k8s.io/HEAD/examples/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://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
user
string		The rados user name. Default is admin. More info: https://releases.k8s.io/HEAD/examples/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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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://releases.k8s.io/HEAD/examples/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://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
monitors
string array		A collection of Ceph monitors. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
pool
string		The rados pool name. Default is rbd. More info: https://releases.k8s.io/HEAD/examples/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://releases.k8s.io/HEAD/examples/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://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it
user
string		The rados user name. Default is admin. More info: https://releases.k8s.io/HEAD/examples/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.

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

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

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1ResourceMetricSource
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		name is the name of the resource in question.
targetAverageUtilization
integer		targetAverageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
targetAverageValue
Quantity		targetAverageValue is the target value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type.
+

ResourceMetricStatus v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1ResourceMetricStatus
+

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.

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

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-compute-resources-container/
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-compute-resources-container/
+

ResourceRule v1 authorization

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

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

RollbackConfig v1beta1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta1RollbackConfig
+

DEPRECATED.

+ + + + + + + + + + + + + + + +
FieldDescription
revision
integer		The revision to rollback to. If set to 0, rollback to the last revision.
+

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

Rule v1alpha1 admissionregistration

+ + + + + + + + + + + + + + + +
GroupVersionKind
admissionregistration.k8s.iov1alpha1Rule
+

Rule is a tuple of APIGroups, APIVersion, 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.
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.
+

RuleWithOperations v1beta1 admissionregistration

+ + + + + + + + + + + + + + + +
GroupVersionKind
admissionregistration.k8s.iov1beta1RuleWithOperations
+

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, or for all operations. 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.
+

RunAsUserStrategyOptions v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1RunAsUserStrategyOptions
+

RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy. Deprecated: use RunAsUserStrategyOptions from policy API Group instead.

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

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 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1SELinuxStrategyOptions
+

SELinuxStrategyOptions defines the strategy type and any options used to create the strategy. Deprecated: use SELinuxStrategyOptions from policy API Group instead.

+ + + + + + + + + + + + + + + + + + + +
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/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
spec
ScaleSpec		defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status.
status
ScaleStatus		current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only.
+

ScaleIOPersistentVolumeSource v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ScaleIOPersistentVolumeSource
+

ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume

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

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

ScopeSelector v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ScopeSelector
+

A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements.

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

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
operator
string		Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.
scopeName
string		The name of the scope that the selector applies to.
values
string array		An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
+

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.

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

+ + + + + + + + + + + + + + + + + + + + + + + +
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 it's 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.

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
defaultMode
integer		Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. 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 it's keys must be defined
secretName
string		Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+

SecurityContext v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1SecurityContext
+

SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
allowPrivilegeEscalation
boolean		AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN
capabilities
Capabilities		The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
privileged
boolean		Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
readOnlyRootFilesystem
boolean		Whether this container has a read-only root filesystem. Default is false.
runAsGroup
integer		The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsNonRoot
boolean		Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsUser
integer		The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
seLinuxOptions
SELinuxOptions		The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+

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

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

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

ServicePort v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1ServicePort
+

ServicePort contains information on service's port.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
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. This maps to the 'Name' field in EndpointPort objects. 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=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. 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" and "UDP". Default is TCP.
targetPortNumber or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
+

ServiceReference v1 apiregistration

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiregistration.k8s.iov1ServiceReference
+ + +

ServiceReference holds a reference to Service.legacy.k8s.io

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		Name is the name of the service
namespace
string		Namespace is the namespace of the service
+

SessionAffinityConfig v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1SessionAffinityConfig
+

SessionAffinityConfig represents the configurations of session affinity.

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastTransitionTime
Time		Last time the condition transitioned from one status to another.
message
string		A human readable message indicating details about the transition.
reason
string		The reason for the condition's last transition.
status
string		Status of the condition, one of True, False, Unknown.
type
string		Type of statefulset condition.
+

StatefulSetUpdateStrategy v1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1StatefulSetUpdateStrategy
+ + +

StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
rollingUpdate
RollingUpdateStatefulSetStrategy		RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
type
string		Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.
+

Status v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1Status
+

Status is a return value for calls that don't return other objects.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/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/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/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.

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

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

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

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

Subject v1 rbac

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1Subject
+ + +

Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.

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

SubjectRulesReviewStatus v1 authorization

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

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1SupplementalGroupsStrategyOptions
+

SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy. Deprecated: use SupplementalGroupsStrategyOptions from policy API Group instead.

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

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
effect
string		Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
key
string		Required. The taint key to be applied to a node.
timeAdded
Time		TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.
value
string		Required. The taint value corresponding to the taint key.
+

Time v1 meta

+ + + + + + + + + + + + + + + +
GroupVersionKind
metav1Time
+ + + + + + + + + + + + + + +
FieldDescription
+

Toleration v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1Toleration
+

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
effect
string		Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
key
string		Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
operator
string		Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
tolerationSeconds
integer		TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
value
string		Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
+

TopologySelectorLabelRequirement v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1TopologySelectorLabelRequirement
+

A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
key
string		The label key that the selector applies to.
values
string array		An array of string values. One value must match the label to be selected. Each entry in Values is ORed.
+

TopologySelectorTerm v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1TopologySelectorTerm
+

A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.

+ + + + + + + + + + + + + + + +
FieldDescription
matchLabelExpressions
TopologySelectorLabelRequirement array		A list of topology selector requirements by labels.
+

UserInfo v1 authentication

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

VolumeAttachmentSource v1beta1 storage

+ + + + + + + + + + + + + + + +
GroupVersionKind
storage.k8s.iov1beta1VolumeAttachmentSource
+ + +

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
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 v1beta1 storage

+ + + + + + + + + + + + + + + +
GroupVersionKind
storage.k8s.iov1beta1VolumeError
+ + +

VolumeError captures an error encountered during a volume operation.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
message
string		String detailing the error encountered during Attach or Detach operation. This string maybe logged, so it should not contain sensitive information.
time
Time		Time the error was encountered.
+

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, MountPropagationHostToContainer 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).
+

VolumeNodeAffinity v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1VolumeNodeAffinity
+

VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.

+ + + + + + + + + + + + + + + +
FieldDescription
required
NodeSelector		Required specifies hard node constraints that must be met.
+

VolumeProjection v1 core

+ + + + + + + + + + + + + + + +
GroupVersionKind
corev1VolumeProjection
+

Projection that may be projected along with other supported volume types

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

Webhook v1beta1 admissionregistration

+ + + + + + + + + + + + + + + +
GroupVersionKind
admissionregistration.k8s.iov1beta1Webhook
+

Webhook describes an admission webhook and the resources and operations it applies to.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
clientConfig
WebhookClientConfig		ClientConfig defines how to communicate with the hook. Required
failurePolicy
string		FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Ignore.
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.
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.
+

WebhookClientConfig v1beta1 admissionregistration

+ + + + + + + + + + + + + + + +
GroupVersionKind
admissionregistration.k8s.iov1beta1WebhookClientConfig
+

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. Required.
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. Port 443 will be used if it is open, otherwise it is an error.
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://&#34;. 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.
+

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

OLD API VERSIONS

+

This section contains older versions of resources shown above.

+
+

APIService v1beta1 apiregistration.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiregistration.k8s.iov1beta1APIService
+ + + +

APIService represents a server for a particular GroupVersion. Name must be "version.group".

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
APIServiceSpec		Spec contains information for locating and communicating with a server
status
APIServiceStatus		Status contains derived information about an API server
+

APIServiceSpec v1beta1 apiregistration

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
caBundle
string		CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate.
group
string		Group is the API group name this server hosts
groupPriorityMinimum
integer		GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s
insecureSkipTLSVerify
boolean		InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead.
service
ServiceReference		Service is a reference to the service for this API server. It must communicate on port 443 If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled.
version
string		Version is the API version this server hosts. For example, "v1"
versionPriority
integer		VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.
+

APIServiceStatus v1beta1 apiregistration

+ + + + + + + + + + + + + + + +
FieldDescription
conditions
APIServiceCondition array
patch type: merge
patch merge key: type		Current service state of apiService.
+

APIServiceList v1beta1 apiregistration

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

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create an APIService

+

HTTP Request

+

POST /apis/apiregistration.k8s.io/v1beta1/apiservices

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
APIService
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified APIService

+

HTTP Request

+

PATCH /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified APIService

+

HTTP Request

+

PUT /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
APIService
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
201
APIService		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete an APIService

+

HTTP Request

+

DELETE /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of APIService

+

HTTP Request

+

DELETE /apis/apiregistration.k8s.io/v1beta1/apiservices

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified APIService

+

HTTP Request

+

GET /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind APIService

+

HTTP Request

+

GET /apis/apiregistration.k8s.io/v1beta1/apiservices

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind APIService

+

HTTP Request

+

GET /apis/apiregistration.k8s.io/v1beta1/watch/apiservices/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of APIService

+

HTTP Request

+

GET /apis/apiregistration.k8s.io/v1beta1/watch/apiservices

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified APIService

+

HTTP Request

+

PATCH /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified APIService

+

HTTP Request

+

GET /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

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

Response

+ + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified APIService

+

HTTP Request

+

PUT /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
APIService
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
APIService		OK
201
APIService		Created
+
+

APIServiceCondition v1beta1 apiregistration.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiregistration.k8s.iov1beta1APIServiceCondition
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
lastTransitionTime
Time		Last time the condition transitioned from one status to another.
message
string		Human-readable message indicating details about last transition.
reason
string		Unique, one-word, CamelCase reason for the condition's last transition.
status
string		Status is the status of the condition. Can be True, False, Unknown.
type
string		Type is the type of the condition.
+
+

AggregationRule v1beta1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1beta1AggregationRule
+ + + +

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole

+ + + + + + + + + + + + + + + +
FieldDescription
clusterRoleSelectors
LabelSelector array		ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added
+
+

AggregationRule v1alpha1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1alpha1AggregationRule
+ + + +

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole

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

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

ClusterRole v1beta1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1beta1ClusterRole
+ + + +

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata.
rules
PolicyRule array		Rules holds all the PolicyRules for this ClusterRole
+

ClusterRoleList v1beta1 rbac

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ClusterRole

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1beta1/clusterroles

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRole
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ClusterRole

+

HTTP Request

+

PATCH /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRole		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ClusterRole

+

HTTP Request

+

PUT /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRole
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ClusterRole		OK
201
ClusterRole		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ClusterRole

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ClusterRole

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterroles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

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

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRole		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/clusterroles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterroles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

ClusterRole v1alpha1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1alpha1ClusterRole
+ + + +

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata.
rules
PolicyRule array		Rules holds all the PolicyRules for this ClusterRole
+

ClusterRoleList v1alpha1 rbac

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ClusterRole

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRole
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ClusterRole

+

HTTP Request

+

PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRole		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ClusterRole

+

HTTP Request

+

PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRole
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ClusterRole		OK
201
ClusterRole		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ClusterRole

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ClusterRole

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

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

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRole		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ClusterRole

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

ClusterRoleBinding v1beta1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1beta1ClusterRoleBinding
+ + + +

ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata.
roleRef
RoleRef		RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
subjects
Subject array		Subjects holds references to the objects the role applies to.
+

ClusterRoleBindingList v1beta1 rbac

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ClusterRoleBinding

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRoleBinding
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ClusterRoleBinding

+

HTTP Request

+

PATCH /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBinding		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ClusterRoleBinding

+

HTTP Request

+

PUT /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRoleBinding
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBinding		OK
201
ClusterRoleBinding		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ClusterRoleBinding

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ClusterRoleBinding

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

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

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBinding		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterrolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

ClusterRoleBinding v1alpha1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1alpha1ClusterRoleBinding
+ + + +

ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata.
roleRef
RoleRef		RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
subjects
Subject array		Subjects holds references to the objects the role applies to.
+

ClusterRoleBindingList v1alpha1 rbac

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ClusterRoleBinding

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRoleBinding
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ClusterRoleBinding

+

HTTP Request

+

PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBinding		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ClusterRoleBinding

+

HTTP Request

+

PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ClusterRoleBinding
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBinding		OK
201
ClusterRoleBinding		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ClusterRoleBinding

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ClusterRoleBinding

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

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

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ClusterRoleBinding		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ClusterRoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

ControllerRevision v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2ControllerRevision
+ + + +

DEPRECATED - This group version of ControllerRevision is deprecated by apps/v1/ControllerRevision. See the release notes for more information. ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
revision
integer		Revision indicates the revision of the state represented by Data.
+

ControllerRevisionList v1beta2 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/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/api-conventions.md#types-kinds
metadata
ListMeta		More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ControllerRevision

+

HTTP Request

+

POST /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ControllerRevision
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ControllerRevision

+

HTTP Request

+

PATCH /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ControllerRevision		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ControllerRevision

+

HTTP Request

+

PUT /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ControllerRevision
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
ControllerRevision		Created
200
ControllerRevision		OK
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ControllerRevision

+

HTTP Request

+

DELETE /apis/apps/v1beta2/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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ControllerRevision

+

HTTP Request

+

DELETE /apis/apps/v1beta2/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta2/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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ControllerRevision		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta2/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta2/controllerrevisions

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta2/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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/namespaces/{namespace}/controllerrevisions

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/controllerrevisions

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

ControllerRevision v1beta1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta1ControllerRevision
+ + + +

DEPRECATED - This group version of ControllerRevision is deprecated by apps/v1beta2/ControllerRevision. See the release notes for more information. ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
revision
integer		Revision indicates the revision of the state represented by Data.
+

ControllerRevisionList v1beta1 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/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/api-conventions.md#types-kinds
metadata
ListMeta		More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ControllerRevision

+

HTTP Request

+

POST /apis/apps/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ControllerRevision
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ControllerRevision

+

HTTP Request

+

PATCH /apis/apps/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ControllerRevision		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ControllerRevision

+

HTTP Request

+

PUT /apis/apps/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ControllerRevision
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
ControllerRevision		OK
201
ControllerRevision		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ControllerRevision

+

HTTP Request

+

DELETE /apis/apps/v1beta1/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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ControllerRevision

+

HTTP Request

+

DELETE /apis/apps/v1beta1/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta1/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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ControllerRevision		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta1/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta1/controllerrevisions

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta1/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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta1/watch/namespaces/{namespace}/controllerrevisions

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ControllerRevision

+

HTTP Request

+

GET /apis/apps/v1beta1/watch/controllerrevisions

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

CronJob v2alpha1 batch

+ + + + + + + + + + + + + + + +
GroupVersionKind
batchv2alpha1CronJob
+ + + +

CronJob represents the configuration of a single cron job.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#spec-and-status
status
CronJobStatus		Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

CronJobSpec v2alpha1 batch

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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.
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.
suspend
boolean		This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.
+

CronJobStatus v2alpha1 batch

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

CronJobList v2alpha1 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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a CronJob

+

HTTP Request

+

POST /apis/batch/v2alpha1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CronJob
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified CronJob

+

HTTP Request

+

PATCH /apis/batch/v2alpha1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CronJob		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified CronJob

+

HTTP Request

+

PUT /apis/batch/v2alpha1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CronJob
+

Response

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

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a CronJob

+

HTTP Request

+

DELETE /apis/batch/v2alpha1/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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of CronJob

+

HTTP Request

+

DELETE /apis/batch/v2alpha1/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified CronJob

+

HTTP Request

+

GET /apis/batch/v2alpha1/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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CronJob		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind CronJob

+

HTTP Request

+

GET /apis/batch/v2alpha1/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind CronJob

+

HTTP Request

+

GET /apis/batch/v2alpha1/cronjobs

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind CronJob

+

HTTP Request

+

GET /apis/batch/v2alpha1/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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of CronJob

+

HTTP Request

+

GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of CronJob

+

HTTP Request

+

GET /apis/batch/v2alpha1/watch/cronjobs

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified CronJob

+

HTTP Request

+

PATCH /apis/batch/v2alpha1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
CronJob		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified CronJob

+

HTTP Request

+

GET /apis/batch/v2alpha1/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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified CronJob

+

HTTP Request

+

PUT /apis/batch/v2alpha1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
CronJob
+

Response

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

CrossVersionObjectReference v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1CrossVersionObjectReference
+ + + +

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

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		API version of the referent
kind
string		Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds&#34;
name
string		Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
+
+

DaemonSet v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2DaemonSet
+ + + +

DEPRECATED - This group version of DaemonSet is deprecated by apps/v1/DaemonSet. See the release notes for more information. DaemonSet represents the configuration of a daemon set.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
DaemonSetSpec		The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#spec-and-status
+

DaemonSetSpec v1beta2 apps

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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 type: merge
patch merge key: type		Represents the latest available observations of a DaemonSet's current state.
currentNumberScheduled
integer		The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
desiredNumberScheduled
integer		The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
numberAvailable
integer		The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds)
numberMisscheduled
integer		The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
numberReady
integer		The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
numberUnavailable
integer		The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds)
observedGeneration
integer		The most recent generation observed by the daemon set controller.
updatedNumberScheduled
integer		The total number of nodes that are running updated daemon pod
+

DaemonSetList v1beta2 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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

RollingUpdateDaemonSet v1beta2 apps

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

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+$ echo 'apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+  name: daemonset-example
+spec:
+  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: extensions/v1beta1
+kind: DaemonSet
+metadata:
+  name: daemonset-example
+spec:
+  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/v1beta2/namespaces/default/daemonsets
+
+
+

Output

+
+

+daemonset "daemonset-example" created
+
+
+

Response Body

+
+

+{
+  "kind": "DaemonSet",
+  "apiVersion": "extensions/v1beta1",
+  "metadata": {
+    "name": "daemonset-example",
+    "namespace": "default",
+    "selfLink": "/apis/extensions/v1beta1/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/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DaemonSet
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified DaemonSet

+

HTTP Request

+

PATCH /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified DaemonSet

+

HTTP Request

+

PUT /apis/apps/v1beta2/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.
+

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/v1beta2/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/v1beta2/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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of DaemonSet

+

HTTP Request

+

DELETE /apis/apps/v1beta2/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

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/v1beta2/namespaces/default/daemonsets/daemonset-example
+
+
+

Output

+
+

+
+
+

Response Body

+
+

+
+

read the specified DaemonSet

+

HTTP Request

+

GET /apis/apps/v1beta2/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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind DaemonSet

+

HTTP Request

+

GET /apis/apps/v1beta2/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind DaemonSet

+

HTTP Request

+

GET /apis/apps/v1beta2/daemonsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind DaemonSet

+

HTTP Request

+

GET /apis/apps/v1beta2/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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of DaemonSet

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/namespaces/{namespace}/daemonsets

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of DaemonSet

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/daemonsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified DaemonSet

+

HTTP Request

+

PATCH /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified DaemonSet

+

HTTP Request

+

GET /apis/apps/v1beta2/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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified DaemonSet

+

HTTP Request

+

PUT /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DaemonSet
+

Response

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

DaemonSet v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1DaemonSet
+ + + +

DEPRECATED - This group version of DaemonSet is deprecated by apps/v1beta2/DaemonSet. See the release notes for more information. DaemonSet represents the configuration of a daemon set.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
DaemonSetSpec		The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#spec-and-status
+

DaemonSetSpec v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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. If empty, defaulted to labels on Pod template. 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
templateGeneration
integer		DEPRECATED. A sequence number representing a specific generation of the template. Populated by the system. It can be set only during the creation.
updateStrategy
DaemonSetUpdateStrategy		An update strategy to replace existing DaemonSet pods with new pods.
+

DaemonSetStatus v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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 type: merge
patch merge key: type		Represents the latest available observations of a DaemonSet's current state.
currentNumberScheduled
integer		The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
desiredNumberScheduled
integer		The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
numberAvailable
integer		The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds)
numberMisscheduled
integer		The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
numberReady
integer		The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
numberUnavailable
integer		The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds)
observedGeneration
integer		The most recent generation observed by the daemon set controller.
updatedNumberScheduled
integer		The total number of nodes that are running updated daemon pod
+

DaemonSetList v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

RollingUpdateDaemonSet v1beta1 extensions

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

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+$ echo 'apiVersion: extensions/v1beta1
+kind: DaemonSet
+metadata:
+  name: daemonset-example
+spec:
+  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: extensions/v1beta1
+kind: DaemonSet
+metadata:
+  name: daemonset-example
+spec:
+  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/extensions/v1beta1/namespaces/default/daemonsets
+
+
+

Output

+
+

+daemonset "daemonset-example" created
+
+
+

Response Body

+
+

+{
+  "kind": "DaemonSet",
+  "apiVersion": "extensions/v1beta1",
+  "metadata": {
+    "name": "daemonset-example",
+    "namespace": "default",
+    "selfLink": "/apis/extensions/v1beta1/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/extensions/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DaemonSet
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified DaemonSet

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified DaemonSet

+

HTTP Request

+

PUT /apis/extensions/v1beta1/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.
+

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/extensions/v1beta1/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/extensions/v1beta1/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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of DaemonSet

+

HTTP Request

+

DELETE /apis/extensions/v1beta1/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

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/extensions/v1beta1/namespaces/default/daemonsets/daemonset-example
+
+
+

Output

+
+

+
+
+

Response Body

+
+

+
+

read the specified DaemonSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind DaemonSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind DaemonSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/daemonsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind DaemonSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of DaemonSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of DaemonSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/daemonsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified DaemonSet

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified DaemonSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified DaemonSet

+

HTTP Request

+

PUT /apis/extensions/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DaemonSet
+

Response

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

DaemonSetCondition v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2DaemonSetCondition
+ + + +

DaemonSetCondition describes the state of a DaemonSet 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.
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.
+
+

DaemonSetCondition v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1DaemonSetCondition
+ + + +

DaemonSetCondition describes the state of a DaemonSet 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.
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 v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2DaemonSetUpdateStrategy
+ + + +

DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.

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

DaemonSetUpdateStrategy v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1DaemonSetUpdateStrategy
+ + + + + + + + + + + + + + + + + + + + + + + + +
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 OnDelete.
+
+

Deployment v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2Deployment
+ + + +

DEPRECATED - This group version of Deployment is deprecated by apps/v1/Deployment. See the release notes for more information. Deployment enables declarative updates for Pods and ReplicaSets.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata.
spec
DeploymentSpec		Specification of the desired behavior of the Deployment.
status
DeploymentStatus		Most recently observed status of the Deployment.
+

DeploymentSpec v1beta2 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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		The deployment strategy to use to replace existing pods with new ones.
template
PodTemplateSpec		Template describes the pods that will be created.
+

DeploymentStatus v1beta2 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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 type: merge
patch merge key: type		Represents the latest available observations of a deployment's current state.
observedGeneration
integer		The generation observed by the deployment controller.
readyReplicas
integer		Total number of ready pods targeted by this deployment.
replicas
integer		Total number of non-terminated pods targeted by this deployment (their labels match the selector).
unavailableReplicas
integer		Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
updatedReplicas
integer		Total number of non-terminated pods targeted by this deployment that have the desired template spec.
+

DeploymentList v1beta2 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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata.
+

DeploymentStrategy v1beta2 apps

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

RollingUpdateDeployment v1beta2 apps

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

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.10
+        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/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.10
+        ports:
+        - containerPort: 80
+' http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/deployments
+
+
+

Output

+
+

+deployment "deployment-example" created
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/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.10",
+            "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/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Deployment
+

Response

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

Patch

+
+

kubectl Command

+
+

+$ kubectl patch deployment deployment-example -p \
+    '{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}'
+
+
+

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.11"}]}}}}' \
+    'http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/deployments/deployment-example'
+
+
+

Output

+
+

+"deployment-example" patched
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/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.11",
+            "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/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

Replace

+
+

kubectl Command

+
+

+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.11
+        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/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.11
+        ports:
+        - containerPort: 80
+' http://127.0.0.1:8001/apis/apps/v1beta2/namespaces/default/deployments/deployment-example
+
+
+

Output

+
+

+deployment "deployment-example" replaced
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/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.11",
+            "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/v1beta2/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.
+

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/v1beta2/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/v1beta2/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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of Deployment

+

HTTP Request

+

DELETE /apis/apps/v1beta2/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

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/v1beta2/namespaces/default/deployments/deployment-example
+
+
+

Output

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/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.10",
+            "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/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/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.10",
+            "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/v1beta2/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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

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/v1beta2/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.10",
+                "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.10",
+                "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/v1beta2/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Deployment

+

HTTP Request

+

GET /apis/apps/v1beta2/deployments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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/v1beta2/watch/namespaces/default/deployments/deployment-example'
+
+
+

Output

+
+

+{
+    "type": "ADDED",
+    "object": {
+        "kind": "Deployment",
+        "apiVersion": "apps/v1beta1",
+        "metadata": {
+            "name": "deployment-example",
+            "namespace": "default",
+            "selfLink": "/apis/apps/v1beta1/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.10",
+                            "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/v1beta1",
+        "metadata": {
+            "name": "deployment-example",
+            "namespace": "default",
+            "selfLink": "/apis/apps/v1beta1/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.10",
+                            "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

+

HTTP Request

+

GET /apis/apps/v1beta2/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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Deployment

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/namespaces/{namespace}/deployments

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Deployment

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/deployments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified Deployment

+

HTTP Request

+

PATCH /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified Deployment

+

HTTP Request

+

GET /apis/apps/v1beta2/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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified Deployment

+

HTTP Request

+

PUT /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Deployment
+

Response

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

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read scale of the specified Deployment

+

HTTP Request

+

GET /apis/apps/v1beta2/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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace scale of the specified Deployment

+

HTTP Request

+

PUT /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

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

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update scale of the specified Deployment

+

HTTP Request

+

PATCH /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+
+

Deployment v1beta1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta1Deployment
+ + + +

DEPRECATED - This group version of Deployment is deprecated by apps/v1beta2/Deployment. See the release notes for more information. Deployment enables declarative updates for Pods and ReplicaSets.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata.
spec
DeploymentSpec		Specification of the desired behavior of the Deployment.
status
DeploymentStatus		Most recently observed status of the Deployment.
+

DeploymentSpec v1beta1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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 2.
rollbackTo
RollbackConfig		DEPRECATED. The config this deployment is rolling back to. Will be cleared after rollback is done.
selector
LabelSelector		Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.
strategy
DeploymentStrategy		The deployment strategy to use to replace existing pods with new ones.
template
PodTemplateSpec		Template describes the pods that will be created.
+

DeploymentStatus v1beta1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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 type: merge
patch merge key: type		Represents the latest available observations of a deployment's current state.
observedGeneration
integer		The generation observed by the deployment controller.
readyReplicas
integer		Total number of ready pods targeted by this deployment.
replicas
integer		Total number of non-terminated pods targeted by this deployment (their labels match the selector).
unavailableReplicas
integer		Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
updatedReplicas
integer		Total number of non-terminated pods targeted by this deployment that have the desired template spec.
+

DeploymentList v1beta1 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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata.
+

DeploymentStrategy v1beta1 apps

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

DeploymentRollback v1beta1 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/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/api-conventions.md#types-kinds
name
string		Required: This must match the Name of a deployment.
rollbackTo
RollbackConfig		The config of this deployment rollback.
updatedAnnotations
object		The annotations to be updated to a deployment
+

RollingUpdateDeployment v1beta1 apps

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

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.10
+        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/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.10
+        ports:
+        - containerPort: 80
+' http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments
+
+
+

Output

+
+

+deployment "deployment-example" created
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/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.10",
+            "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/v1beta1/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.
+

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.11"}]}}}}'
+
+
+

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.11"}]}}}}' \
+    'http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments/deployment-example'
+
+
+

Output

+
+

+"deployment-example" patched
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/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.11",
+            "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/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

Replace

+
+

kubectl Command

+
+

+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.11
+        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/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.11
+        ports:
+        - containerPort: 80
+' http://127.0.0.1:8001/apis/apps/v1beta1/namespaces/default/deployments/deployment-example
+
+
+

Output

+
+

+deployment "deployment-example" replaced
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/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.11",
+            "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/v1beta1/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.
+

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/v1beta1/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/v1beta1/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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of Deployment

+

HTTP Request

+

DELETE /apis/apps/v1beta1/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

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/v1beta1/namespaces/default/deployments/deployment-example
+
+
+

Output

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/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.10",
+            "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/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/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.10",
+            "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/v1beta1/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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

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/v1beta1/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.10",
+                "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.10",
+                "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/v1beta1/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Deployment

+

HTTP Request

+

GET /apis/apps/v1beta1/deployments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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/v1beta1/watch/namespaces/default/deployments/deployment-example'
+
+
+

Output

+
+

+{
+    "type": "ADDED",
+    "object": {
+        "kind": "Deployment",
+        "apiVersion": "apps/v1beta1",
+        "metadata": {
+            "name": "deployment-example",
+            "namespace": "default",
+            "selfLink": "/apis/apps/v1beta1/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.10",
+                            "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/v1beta1",
+        "metadata": {
+            "name": "deployment-example",
+            "namespace": "default",
+            "selfLink": "/apis/apps/v1beta1/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.10",
+                            "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

+

HTTP Request

+

GET /apis/apps/v1beta1/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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Deployment

+

HTTP Request

+

GET /apis/apps/v1beta1/watch/namespaces/{namespace}/deployments

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Deployment

+

HTTP Request

+

GET /apis/apps/v1beta1/watch/deployments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified Deployment

+

HTTP Request

+

PATCH /apis/apps/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified Deployment

+

HTTP Request

+

GET /apis/apps/v1beta1/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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified Deployment

+

HTTP Request

+

PUT /apis/apps/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Deployment
+

Response

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

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read scale of the specified Deployment

+

HTTP Request

+

GET /apis/apps/v1beta1/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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace scale of the specified Deployment

+

HTTP Request

+

PUT /apis/apps/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

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

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update scale of the specified Deployment

+

HTTP Request

+

PATCH /apis/apps/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+

Rollback

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create rollback of a Deployment

+

HTTP Request

+

POST /apis/apps/v1beta1/namespaces/{namespace}/deployments/{name}/rollback

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeploymentRollback
+

Response

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

Deployment v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1Deployment
+ + + +

DEPRECATED - This group version of Deployment is deprecated by apps/v1beta2/Deployment. See the release notes for more information. Deployment enables declarative updates for Pods and ReplicaSets.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata.
spec
DeploymentSpec		Specification of the desired behavior of the Deployment.
status
DeploymentStatus		Most recently observed status of the Deployment.
+

DeploymentSpec v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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 and will not be processed by the deployment controller.
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. This is not set by default.
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.
rollbackTo
RollbackConfig		DEPRECATED. The config this deployment is rolling back to. Will be cleared after rollback is done.
selector
LabelSelector		Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.
strategy
DeploymentStrategy
patch type: retainKeys		The deployment strategy to use to replace existing pods with new ones.
template
PodTemplateSpec		Template describes the pods that will be created.
+

DeploymentStatus v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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 type: merge
patch merge key: type		Represents the latest available observations of a deployment's current state.
observedGeneration
integer		The generation observed by the deployment controller.
readyReplicas
integer		Total number of ready pods targeted by this deployment.
replicas
integer		Total number of non-terminated pods targeted by this deployment (their labels match the selector).
unavailableReplicas
integer		Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
updatedReplicas
integer		Total number of non-terminated pods targeted by this deployment that have the desired template spec.
+

DeploymentList v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata.
+

DeploymentStrategy v1beta1 extensions

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

DeploymentRollback v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
name
string		Required: This must match the Name of a deployment.
rollbackTo
RollbackConfig		The config of this deployment rollback.
updatedAnnotations
object		The annotations to be updated to a deployment
+

RollingUpdateDeployment v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + +
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. By default, a value of 1 is used. Example: when this is set to 30%, the new RC 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 RC can be scaled up further, ensuring that total number of pods running at any time during the update is atmost 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. By default, a fixed value of 1 is used. Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old RC can be scaled down further, followed by scaling up the new RC, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.10
+        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/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.10
+        ports:
+        - containerPort: 80
+' http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/deployments
+
+
+

Output

+
+

+deployment "deployment-example" created
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/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.10",
+            "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/extensions/v1beta1/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.
+

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.11"}]}}}}'
+
+
+

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.11"}]}}}}' \
+    'http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/deployments/deployment-example'
+
+
+

Output

+
+

+"deployment-example" patched
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/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.11",
+            "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/extensions/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

Replace

+
+

kubectl Command

+
+

+$ echo 'apiVersion: apps/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.11
+        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/v1beta1
+kind: Deployment
+metadata:
+  name: deployment-example
+spec:
+  replicas: 3
+  revisionHistoryLimit: 10
+  template:
+    metadata:
+      labels:
+        app: nginx
+    spec:
+      containers:
+      - name: nginx
+        image: nginx:1.11
+        ports:
+        - containerPort: 80
+' http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/deployments/deployment-example
+
+
+

Output

+
+

+deployment "deployment-example" replaced
+
+
+

Response Body

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/v1beta1/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.11",
+            "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/extensions/v1beta1/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.
+

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/extensions/v1beta1/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/extensions/v1beta1/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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of Deployment

+

HTTP Request

+

DELETE /apis/extensions/v1beta1/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

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/extensions/v1beta1/namespaces/default/deployments/deployment-example
+
+
+

Output

+
+

+{
+  "kind": "Deployment",
+  "apiVersion": "apps/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/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.10",
+            "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/v1beta1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/apis/apps/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.10",
+            "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/extensions/v1beta1/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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

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/extensions/v1beta1/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.10",
+                "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.10",
+                "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/extensions/v1beta1/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Deployment

+

HTTP Request

+

GET /apis/extensions/v1beta1/deployments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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/extensions/v1beta1/watch/namespaces/default/deployments/deployment-example'
+
+
+

Output

+
+

+{
+    "type": "ADDED",
+    "object": {
+        "kind": "Deployment",
+        "apiVersion": "apps/v1beta1",
+        "metadata": {
+            "name": "deployment-example",
+            "namespace": "default",
+            "selfLink": "/apis/apps/v1beta1/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.10",
+                            "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/v1beta1",
+        "metadata": {
+            "name": "deployment-example",
+            "namespace": "default",
+            "selfLink": "/apis/apps/v1beta1/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.10",
+                            "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

+

HTTP Request

+

GET /apis/extensions/v1beta1/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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Deployment

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/deployments

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Deployment

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/deployments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified Deployment

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Deployment		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified Deployment

+

HTTP Request

+

GET /apis/extensions/v1beta1/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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified Deployment

+

HTTP Request

+

PUT /apis/extensions/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Deployment
+

Response

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

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read scale of the specified Deployment

+

HTTP Request

+

GET /apis/extensions/v1beta1/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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace scale of the specified Deployment

+

HTTP Request

+

PUT /apis/extensions/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

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

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update scale of the specified Deployment

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+

Rollback

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create rollback of a Deployment

+

HTTP Request

+

POST /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/rollback

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DeploymentRollback
+

Response

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

DeploymentCondition v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2DeploymentCondition
+ + + +

DeploymentCondition describes the state of a deployment at a certain point.

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

DeploymentCondition v1beta1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta1DeploymentCondition
+ + + +

DeploymentCondition describes the state of a deployment at a certain point.

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

DeploymentCondition v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1DeploymentCondition
+ + + +

DeploymentCondition describes the state of a deployment at a certain point.

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

Event v1beta1 events.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
events.k8s.iov1beta1Event
+ + + +

Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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/api-conventions.md#resources
deprecatedCount
integer		Deprecated field assuring backward compatibility with core.v1 Event type
deprecatedFirstTimestamp
Time		Deprecated field assuring backward compatibility with core.v1 Event type
deprecatedLastTimestamp
Time		Deprecated field assuring backward compatibility with core.v1 Event type
deprecatedSource
EventSource		Deprecated field assuring backward compatibility with core.v1 Event type
eventTime
MicroTime		Required. Time when this Event was first 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/api-conventions.md#types-kinds
metadata
ObjectMeta
note
string		Optional. 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		Why the action was taken.
regarding
ObjectReference		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		Optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object.
reportingController
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.
type
string		Type of this event (Normal, Warning), new types could be added in the future.
+

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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Event
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Event		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Event
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
201
Event		Created
200
Event		OK
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Event		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Event

+

HTTP Request

+

GET /apis/events.k8s.io/v1beta1/events

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Event

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Event

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Event

+

HTTP Request

+

GET /apis/events.k8s.io/v1beta1/watch/events

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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 v1beta1 events.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
events.k8s.iov1beta1EventSeries
+ + + +

EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time.

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
count
integer		Number of occurrences in this series up to the last heartbeat time
lastObservedTime
MicroTime		Time when last Event from the series was seen before last heartbeat.
state
string		Information whether this series is ongoing or finished.
+
+

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

HorizontalPodAutoscaler v2beta1 autoscaling

+ + + + + + + + + + + + + + + +
GroupVersionKind
autoscalingv2beta1HorizontalPodAutoscaler
+ + + +

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/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/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.
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/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/api-conventions.md#types-kinds
metadata
ListMeta		metadata is the standard list metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
HorizontalPodAutoscaler
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
HorizontalPodAutoscaler		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
HorizontalPodAutoscaler
+

Response

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

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
HorizontalPodAutoscaler		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind HorizontalPodAutoscaler

+

HTTP Request

+

GET /apis/autoscaling/v2beta1/horizontalpodautoscalers

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind HorizontalPodAutoscaler

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of HorizontalPodAutoscaler

+

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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of HorizontalPodAutoscaler

+

HTTP Request

+

GET /apis/autoscaling/v2beta1/watch/horizontalpodautoscalers

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
HorizontalPodAutoscaler		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
HorizontalPodAutoscaler
+

Response

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

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 v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1IPBlock
+ + + +

DEPRECATED 1.9 - This group version of IPBlock is deprecated by networking/v1/IPBlock. IPBlock describes a particular CIDR (Ex. "192.168.1.1/24") 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"
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" Except values will be rejected if they are outside the CIDR range
+
+

Initializer v1alpha1 admissionregistration.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
admissionregistration.k8s.iov1alpha1Initializer
+ + + +

Initializer describes the name and the failure policy of an initializer, and what resources it applies to.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		Name is the identifier of the initializer. It will be added to the object that needs to be initialized. Name should be fully qualified, e.g., alwayspullimages.kubernetes.io, where "alwayspullimages" is the name of the webhook, and kubernetes.io is the name of the organization. Required
rules
Rule array		Rules describes what resources/subresources the initializer cares about. The initializer cares about an operation if it matches any Rule. Rule.Resources must not include subresources.
+
+

JobTemplateSpec v2alpha1 batch

+ + + + + + + + + + + + + + + +
GroupVersionKind
batchv2alpha1JobTemplateSpec
+ + + +

JobTemplateSpec describes the data a Job should have when created from a template

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
metadata
ObjectMeta		Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
JobSpec		Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+
+

LocalSubjectAccessReview v1beta1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1beta1LocalSubjectAccessReview
+ + + +

LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
SubjectAccessReviewSpec		Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted.
status
SubjectAccessReviewStatus		Status is filled in by the server and indicates whether the request is allowed or not
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a LocalSubjectAccessReview

+

HTTP Request

+

POST /apis/authorization.k8s.io/v1beta1/namespaces/{namespace}/localsubjectaccessreviews

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
LocalSubjectAccessReview
+

Response

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

NetworkPolicy v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1NetworkPolicy
+ + + +

DEPRECATED 1.9 - This group version of NetworkPolicy is deprecated by networking/v1/NetworkPolicy. NetworkPolicy describes what network traffic is allowed for a set of Pods

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
NetworkPolicySpec		Specification of the desired behavior for this NetworkPolicy.
+

NetworkPolicySpec v1beta1 extensions

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

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a NetworkPolicy

+

HTTP Request

+

POST /apis/extensions/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
NetworkPolicy
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified NetworkPolicy

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
NetworkPolicy		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified NetworkPolicy

+

HTTP Request

+

PUT /apis/extensions/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
NetworkPolicy
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
NetworkPolicy		OK
201
NetworkPolicy		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a NetworkPolicy

+

HTTP Request

+

DELETE /apis/extensions/v1beta1/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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of NetworkPolicy

+

HTTP Request

+

DELETE /apis/extensions/v1beta1/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified NetworkPolicy

+

HTTP Request

+

GET /apis/extensions/v1beta1/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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
NetworkPolicy		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind NetworkPolicy

+

HTTP Request

+

GET /apis/extensions/v1beta1/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind NetworkPolicy

+

HTTP Request

+

GET /apis/extensions/v1beta1/networkpolicies

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind NetworkPolicy

+

HTTP Request

+

GET /apis/extensions/v1beta1/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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of NetworkPolicy

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of NetworkPolicy

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/networkpolicies

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

NetworkPolicyEgressRule v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1NetworkPolicyEgressRule
+ + + +

DEPRECATED 1.9 - This group version of NetworkPolicyEgressRule is deprecated by networking/v1/NetworkPolicyEgressRule. 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 v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1NetworkPolicyIngressRule
+ + + +

DEPRECATED 1.9 - This group version of NetworkPolicyIngressRule is deprecated by networking/v1/NetworkPolicyIngressRule. This NetworkPolicyIngressRule matches traffic if and only if the traffic matches 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 on 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 v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1NetworkPolicyPeer
+ + + +

DEPRECATED 1.9 - This group version of NetworkPolicyPeer is deprecated by networking/v1/NetworkPolicyPeer.

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

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1NetworkPolicyPort
+ + + +

DEPRECATED 1.9 - This group version of NetworkPolicyPort is deprecated by networking/v1/NetworkPolicyPort.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
portIf specified, the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.
protocol
string		Optional. The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.
+
+

NonResourceAttributes v1beta1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1beta1NonResourceAttributes
+ + + +

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

NonResourceRule v1beta1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1beta1NonResourceRule
+ + + +

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

PodSecurityPolicy v1beta1 policy

+ + + + + + + + + + + + + + + +
GroupVersionKind
policyv1beta1PodSecurityPolicy
+

PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/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.
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 a whitelist of allowed 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 a white list of allowed host paths. Empty indicates that all host paths may be used.
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 whitelist 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.
runAsUser
RunAsUserStrategyOptions		runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set.
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 a white list of allowed 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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a PodSecurityPolicy

+

HTTP Request

+

POST /apis/policy/v1beta1/podsecuritypolicies

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodSecurityPolicy
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodSecurityPolicy		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PodSecurityPolicy
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
PodSecurityPolicy		OK
201
PodSecurityPolicy		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PodSecurityPolicy		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

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.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind PodSecurityPolicy

+

HTTP Request

+

GET /apis/policy/v1beta1/watch/podsecuritypolicies/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PodSecurityPolicy
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PodSecurityPolicy

+

HTTP Request

+

GET /apis/policy/v1beta1/watch/podsecuritypolicies

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

PolicyRule v1beta1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1beta1PolicyRule
+ + + +

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiGroups
string array		APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
nonResourceURLs
string array		NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
resourceNames
string array		ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
resources
string array		Resources is a list of resources this rule applies to. '*' represents all resources in the specified apiGroups. '*/foo' represents the subresource 'foo' for all resources in the specified apiGroups.
verbs
string array		Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
+
+

PolicyRule v1alpha1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1alpha1PolicyRule
+ + + +

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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 This name is intentionally different than the internal type so that the DefaultConvert works nicely and because the ordering may be different. Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
resourceNames
string array		ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
resources
string array		Resources is a list of resources this rule applies to. ResourceAll represents all resources.
verbs
string array		Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
+
+

PriorityClass v1alpha1 scheduling.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
scheduling.k8s.iov1alpha1PriorityClass
+ + + +

PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
value
integer		The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec.
+

PriorityClassList v1alpha1 scheduling

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a PriorityClass

+

HTTP Request

+

POST /apis/scheduling.k8s.io/v1alpha1/priorityclasses

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PriorityClass
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified PriorityClass

+

HTTP Request

+

PATCH /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PriorityClass		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified PriorityClass

+

HTTP Request

+

PUT /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
PriorityClass
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
PriorityClass		OK
201
PriorityClass		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a PriorityClass

+

HTTP Request

+

DELETE /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of PriorityClass

+

HTTP Request

+

DELETE /apis/scheduling.k8s.io/v1alpha1/priorityclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified PriorityClass

+

HTTP Request

+

GET /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
PriorityClass		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind PriorityClass

+

HTTP Request

+

GET /apis/scheduling.k8s.io/v1alpha1/priorityclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind PriorityClass

+

HTTP Request

+

GET /apis/scheduling.k8s.io/v1alpha1/watch/priorityclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of PriorityClass

+

HTTP Request

+

GET /apis/scheduling.k8s.io/v1alpha1/watch/priorityclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

ReplicaSet v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2ReplicaSet
+ + + +

DEPRECATED - This group version of ReplicaSet is deprecated by apps/v1/ReplicaSet. See the release notes for more information. ReplicaSet ensures that a specified number of pod replicas are running at any given time.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/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/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/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/api-conventions.md#spec-and-status
+

ReplicaSetSpec v1beta2 apps

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

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

ReplicaSetList v1beta2 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/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ReplicaSet

+

HTTP Request

+

POST /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicaSet
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ReplicaSet

+

HTTP Request

+

PATCH /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ReplicaSet

+

HTTP Request

+

PUT /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicaSet
+

Response

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

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ReplicaSet

+

HTTP Request

+

DELETE /apis/apps/v1beta2/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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ReplicaSet

+

HTTP Request

+

DELETE /apis/apps/v1beta2/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1beta2/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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1beta2/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1beta2/replicasets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1beta2/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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/namespaces/{namespace}/replicasets

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/replicasets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified ReplicaSet

+

HTTP Request

+

PATCH /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1beta2/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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified ReplicaSet

+

HTTP Request

+

PUT /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicaSet
+

Response

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

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read scale of the specified ReplicaSet

+

HTTP Request

+

GET /apis/apps/v1beta2/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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace scale of the specified ReplicaSet

+

HTTP Request

+

PUT /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

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

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update scale of the specified ReplicaSet

+

HTTP Request

+

PATCH /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+
+

ReplicaSet v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1ReplicaSet
+ + + +

DEPRECATED - This group version of ReplicaSet is deprecated by apps/v1beta2/ReplicaSet. See the release notes for more information. ReplicaSet ensures that a specified number of pod replicas are running at any given time.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/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/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/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/api-conventions.md#spec-and-status
+

ReplicaSetSpec v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
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. If the 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 replica set. 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 v1beta1 extensions

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

ReplicaSetList v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a ReplicaSet

+

HTTP Request

+

POST /apis/extensions/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicaSet
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified ReplicaSet

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified ReplicaSet

+

HTTP Request

+

PUT /apis/extensions/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicaSet
+

Response

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

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a ReplicaSet

+

HTTP Request

+

DELETE /apis/extensions/v1beta1/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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of ReplicaSet

+

HTTP Request

+

DELETE /apis/extensions/v1beta1/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified ReplicaSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ReplicaSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind ReplicaSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/replicasets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind ReplicaSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ReplicaSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of ReplicaSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/watch/replicasets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified ReplicaSet

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
ReplicaSet		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified ReplicaSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified ReplicaSet

+

HTTP Request

+

PUT /apis/extensions/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
ReplicaSet
+

Response

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

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read scale of the specified ReplicaSet

+

HTTP Request

+

GET /apis/extensions/v1beta1/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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace scale of the specified ReplicaSet

+

HTTP Request

+

PUT /apis/extensions/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

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

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update scale of the specified ReplicaSet

+

HTTP Request

+

PATCH /apis/extensions/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+
+

ReplicaSetCondition v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2ReplicaSetCondition
+ + + +

ReplicaSetCondition describes the state of a replica set 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 replica set condition.
+
+

ReplicaSetCondition v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1ReplicaSetCondition
+ + + +

ReplicaSetCondition describes the state of a replica set 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 replica set condition.
+
+

ResourceAttributes v1beta1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1beta1ResourceAttributes
+ + + +

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

ResourceRule v1beta1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1beta1ResourceRule
+ + + +

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

Role v1beta1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1beta1Role
+ + + +

Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata.
rules
PolicyRule array		Rules holds all the PolicyRules for this Role
+

RoleList v1beta1 rbac

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a Role

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Role
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified Role

+

HTTP Request

+

PATCH /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Role		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified Role

+

HTTP Request

+

PUT /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Role
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Role		OK
201
Role		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a Role

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of Role

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}

+

Path Parameters

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

Query Parameters

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

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Role		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/roles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/roles/{name}

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/roles

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/watch/roles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

Role v1alpha1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1alpha1Role
+ + + +

Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata.
rules
PolicyRule array		Rules holds all the PolicyRules for this Role
+

RoleList v1alpha1 rbac

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a Role

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Role
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified Role

+

HTTP Request

+

PATCH /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Role		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified Role

+

HTTP Request

+

PUT /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Role
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
Role		OK
201
Role		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a Role

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of Role

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}

+

Path Parameters

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

Query Parameters

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

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Role		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/roles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles/{name}

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Role

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/roles

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

RoleBinding v1beta1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1beta1RoleBinding
+ + + +

RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata.
roleRef
RoleRef		RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
subjects
Subject array		Subjects holds references to the objects the role applies to.
+

RoleBindingList v1beta1 rbac

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a RoleBinding

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
RoleBinding
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified RoleBinding

+

HTTP Request

+

PATCH /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleBinding		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified RoleBinding

+

HTTP Request

+

PUT /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
RoleBinding
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
RoleBinding		OK
201
RoleBinding		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a RoleBinding

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of RoleBinding

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

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

Query Parameters

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

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleBinding		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/rolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1beta1/watch/rolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

RoleBinding v1alpha1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1alpha1RoleBinding
+ + + +

RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata.
roleRef
RoleRef		RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
subjects
Subject array		Subjects holds references to the objects the role applies to.
+

RoleBindingList v1alpha1 rbac

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard object's metadata.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a RoleBinding

+

HTTP Request

+

POST /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
RoleBinding
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified RoleBinding

+

HTTP Request

+

PATCH /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleBinding		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified RoleBinding

+

HTTP Request

+

PUT /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
RoleBinding
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
RoleBinding		OK
201
RoleBinding		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a RoleBinding

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of RoleBinding

+

HTTP Request

+

DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

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

Query Parameters

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

Response

+ + + + + + + + + + + + + +
CodeDescription
200
RoleBinding		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/rolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings/{name}

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of RoleBinding

+

HTTP Request

+

GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/rolebindings

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

RoleRef v1beta1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1beta1RoleRef
+ + + +

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

RoleRef v1alpha1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1alpha1RoleRef
+ + + +

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

RollbackConfig v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1RollbackConfig
+

DEPRECATED.

+ + + + + + + + + + + + + + + +
FieldDescription
revision
integer		The revision to rollback to. If set to 0, rollback to the last revision.
+
+

RollingUpdateStatefulSetStrategy v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2RollingUpdateStatefulSetStrategy
+ + + +

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

RollingUpdateStatefulSetStrategy v1beta1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta1RollingUpdateStatefulSetStrategy
+ + + +

RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.

+ + + + + + + + + + + + + + + +
FieldDescription
partition
integer		Partition indicates the ordinal at which the StatefulSet should be partitioned.
+
+

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

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 v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2Scale
+ + + +

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/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
spec
ScaleSpec		defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status.
status
ScaleStatus		current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only.
+

ScaleSpec v1beta2 apps

+ + + + + + + + + + + + + + + +
FieldDescription
replicas
integer		desired number of instances for the scaled object.
+

ScaleStatus v1beta2 apps

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
replicas
integer		actual number of observed instances of the scaled object.
selector
object		label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
targetSelector
string		label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
+
+

Scale v1beta1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta1Scale
+ + + +

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/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
spec
ScaleSpec		defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status.
status
ScaleStatus		current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only.
+

ScaleSpec v1beta1 apps

+ + + + + + + + + + + + + + + +
FieldDescription
replicas
integer		desired number of instances for the scaled object.
+

ScaleStatus v1beta1 apps

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
replicas
integer		actual number of observed instances of the scaled object.
selector
object		label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
targetSelector
string		label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
+
+

Scale v1beta1 extensions

+ + + + + + + + + + + + + + + +
GroupVersionKind
extensionsv1beta1Scale
+ + + +

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/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata.
spec
ScaleSpec		defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status.
status
ScaleStatus		current status of the scale. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status. Read-only.
+

ScaleSpec v1beta1 extensions

+ + + + + + + + + + + + + + + +
FieldDescription
replicas
integer		desired number of instances for the scaled object.
+

ScaleStatus v1beta1 extensions

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
replicas
integer		actual number of observed instances of the scaled object.
selector
object		label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
targetSelector
string		label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
+
+

SelfSubjectAccessReview v1beta1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1beta1SelfSubjectAccessReview
+ + + +

SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
SelfSubjectAccessReviewSpec		Spec holds information about the request being evaluated. user and groups must be empty
status
SubjectAccessReviewStatus		Status is filled in by the server and indicates whether the request is allowed or not
+

SelfSubjectAccessReviewSpec v1beta1 authorization

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
nonResourceAttributes
NonResourceAttributes		NonResourceAttributes describes information for a non-resource access request
resourceAttributes
ResourceAttributes		ResourceAuthorizationAttributes describes information for a resource access request
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a SelfSubjectAccessReview

+

HTTP Request

+

POST /apis/authorization.k8s.io/v1beta1/selfsubjectaccessreviews

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
SelfSubjectAccessReview
+

Response

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

SelfSubjectRulesReview v1beta1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1beta1SelfSubjectRulesReview
+ + + +

SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
SelfSubjectRulesReviewSpec		Spec holds information about the request being evaluated.
status
SubjectRulesReviewStatus		Status is filled in by the server and indicates the set of actions a user can perform.
+

SelfSubjectRulesReviewSpec v1beta1 authorization

+ + + + + + + + + + + + + + + +
FieldDescription
namespace
string		Namespace to evaluate rules for. Required.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a SelfSubjectRulesReview

+

HTTP Request

+

POST /apis/authorization.k8s.io/v1beta1/selfsubjectrulesreviews

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
SelfSubjectRulesReview
+

Response

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

ServiceReference v1beta1 admissionregistration.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
admissionregistration.k8s.iov1beta1ServiceReference
+ + + +

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

ServiceReference v1beta1 apiregistration.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
apiregistration.k8s.iov1beta1ServiceReference
+ + + +

ServiceReference holds a reference to Service.legacy.k8s.io

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
name
string		Name is the name of the service
namespace
string		Namespace is the namespace of the service
+
+

StatefulSet v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2StatefulSet
+ + + +

DEPRECATED - This group version of StatefulSet is deprecated by apps/v1/StatefulSet. See the release notes for more information. StatefulSet represents a set of pods with consistent identities. Identities are defined as:

+
    +
  • Network: A single stable DNS and hostname.
    • +
  • Storage: As many VolumeClaims as requested. +The StatefulSet guarantees that a given network identity will always map to the same storage identity.
    • +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
StatefulSetSpec		Spec defines the desired identities of pods in this set.
status
StatefulSetStatus		Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.
+

StatefulSetSpec v1beta2 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
podManagementPolicy
string		podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
replicas
integer		replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
revisionHistoryLimit
integer		revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
selector
LabelSelector		selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
serviceName
string		serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
template
PodTemplateSpec		template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
updateStrategy
StatefulSetUpdateStrategy		updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
volumeClaimTemplates
PersistentVolumeClaim array		volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
+

StatefulSetStatus v1beta2 apps

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

StatefulSetList v1beta2 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/api-conventions.md#resources
items
StatefulSet array
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a StatefulSet

+

HTTP Request

+

POST /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StatefulSet
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified StatefulSet

+

HTTP Request

+

PATCH /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified StatefulSet

+

HTTP Request

+

PUT /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StatefulSet
+

Response

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

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a StatefulSet

+

HTTP Request

+

DELETE /apis/apps/v1beta2/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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of StatefulSet

+

HTTP Request

+

DELETE /apis/apps/v1beta2/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta2/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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta2/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta2/statefulsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta2/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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/namespaces/{namespace}/statefulsets

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta2/watch/statefulsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified StatefulSet

+

HTTP Request

+

PATCH /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta2/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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified StatefulSet

+

HTTP Request

+

PUT /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StatefulSet
+

Response

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

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read scale of the specified StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta2/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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace scale of the specified StatefulSet

+

HTTP Request

+

PUT /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

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

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update scale of the specified StatefulSet

+

HTTP Request

+

PATCH /apis/apps/v1beta2/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+
+

StatefulSet v1beta1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta1StatefulSet
+ + + +

DEPRECATED - This group version of StatefulSet is deprecated by apps/v1beta2/StatefulSet. See the release notes for more information. StatefulSet represents a set of pods with consistent identities. Identities are defined as:

+
    +
  • Network: A single stable DNS and hostname.
    • +
  • Storage: As many VolumeClaims as requested. +The StatefulSet guarantees that a given network identity will always map to the same storage identity.
    • +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
StatefulSetSpec		Spec defines the desired identities of pods in this set.
status
StatefulSetStatus		Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.
+

StatefulSetSpec v1beta1 apps

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
podManagementPolicy
string		podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
replicas
integer		replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
revisionHistoryLimit
integer		revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
selector
LabelSelector		selector is a label query over pods that should match the replica count. If empty, defaulted to labels on the pod template. 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 v1beta1 apps

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

StatefulSetList v1beta1 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/api-conventions.md#resources
items
StatefulSet array
kind
string		Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata
ListMeta
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a StatefulSet

+

HTTP Request

+

POST /apis/apps/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StatefulSet
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified StatefulSet

+

HTTP Request

+

PATCH /apis/apps/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified StatefulSet

+

HTTP Request

+

PUT /apis/apps/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StatefulSet
+

Response

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

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a StatefulSet

+

HTTP Request

+

DELETE /apis/apps/v1beta1/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.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of StatefulSet

+

HTTP Request

+

DELETE /apis/apps/v1beta1/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta1/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.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta1/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 indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta1/statefulsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta1/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
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta1/watch/namespaces/{namespace}/statefulsets

+

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta1/watch/statefulsets

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified StatefulSet

+

HTTP Request

+

PATCH /apis/apps/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StatefulSet		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta1/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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified StatefulSet

+

HTTP Request

+

PUT /apis/apps/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StatefulSet
+

Response

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

Misc Operations

+

See supported operations below...

+

Read Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read scale of the specified StatefulSet

+

HTTP Request

+

GET /apis/apps/v1beta1/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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace scale of the specified StatefulSet

+

HTTP Request

+

PUT /apis/apps/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Scale
+

Response

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

Patch Scale

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update scale of the specified StatefulSet

+

HTTP Request

+

PATCH /apis/apps/v1beta1/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.
+

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Scale		OK
+
+

StatefulSetCondition v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2StatefulSetCondition
+ + + +

StatefulSetCondition describes the state of a statefulset 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.
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.
+
+

StatefulSetCondition v1beta1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta1StatefulSetCondition
+ + + +

StatefulSetCondition describes the state of a statefulset 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.
reason
string		The reason for the condition's last transition.
status
string		Status of the condition, one of True, False, Unknown.
type
string		Type of statefulset condition.
+
+

StatefulSetUpdateStrategy v1beta2 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta2StatefulSetUpdateStrategy
+ + + +

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.

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

StatefulSetUpdateStrategy v1beta1 apps

+ + + + + + + + + + + + + + + +
GroupVersionKind
appsv1beta1StatefulSetUpdateStrategy
+ + + +

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.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
rollingUpdate
RollingUpdateStatefulSetStrategy		RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
type
string		Type indicates the type of the StatefulSetUpdateStrategy.
+
+

StorageClass v1beta1 storage.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
storage.k8s.iov1beta1StorageClass
+ + + +

StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.

+

StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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 alpha-level and is only honored by servers that enable the DynamicProvisioningScheduling 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/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/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 alpha-level and is only honored by servers that enable the VolumeScheduling feature.
+

StorageClassList v1beta1 storage

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a StorageClass

+

HTTP Request

+

POST /apis/storage.k8s.io/v1beta1/storageclasses

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StorageClass
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified StorageClass

+

HTTP Request

+

PATCH /apis/storage.k8s.io/v1beta1/storageclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StorageClass		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified StorageClass

+

HTTP Request

+

PUT /apis/storage.k8s.io/v1beta1/storageclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
StorageClass
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
StorageClass		OK
201
StorageClass		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a StorageClass

+

HTTP Request

+

DELETE /apis/storage.k8s.io/v1beta1/storageclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of StorageClass

+

HTTP Request

+

DELETE /apis/storage.k8s.io/v1beta1/storageclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified StorageClass

+

HTTP Request

+

GET /apis/storage.k8s.io/v1beta1/storageclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
StorageClass		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind StorageClass

+

HTTP Request

+

GET /apis/storage.k8s.io/v1beta1/storageclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind StorageClass

+

HTTP Request

+

GET /apis/storage.k8s.io/v1beta1/watch/storageclasses/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of StorageClass

+

HTTP Request

+

GET /apis/storage.k8s.io/v1beta1/watch/storageclasses

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

Subject v1beta1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1beta1Subject
+ + + +

Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiGroup
string		APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
kind
string		Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
name
string		Name of the object being referenced.
namespace
string		Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
+
+

Subject v1alpha1 rbac.authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1alpha1Subject
+ + + +

Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion holds the API group and version of the referenced subject. Defaults to "v1" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io/v1alpha1" for User and Group subjects.
kind
string		Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
name
string		Name of the object being referenced.
namespace
string		Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
+
+

SubjectAccessReview v1beta1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1beta1SubjectAccessReview
+ + + +

SubjectAccessReview checks whether or not a user or group can perform an action.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
SubjectAccessReviewSpec		Spec holds information about the request being evaluated
status
SubjectAccessReviewStatus		Status is filled in by the server and indicates whether the request is allowed or not
+

SubjectAccessReviewSpec v1beta1 authorization

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
extra
object		Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here.
group
string array		Groups is the groups you're testing for.
nonResourceAttributes
NonResourceAttributes		NonResourceAttributes describes information for a non-resource access request
resourceAttributes
ResourceAttributes		ResourceAuthorizationAttributes describes information for a resource access request
uid
string		UID information about the requesting user.
user
string		User is the user you're testing for. If you specify "User" but not "Group", then is it interpreted as "What if User were not a member of any groups
+

SubjectAccessReviewStatus v1beta1 authorization

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
allowed
boolean		Allowed is required. True if the action would be allowed, false otherwise.
denied
boolean		Denied is optional. True if the action would be denied, otherwise false. If both allowed is false and denied is false, then the authorizer has no opinion on whether to authorize the action. Denied may not be true if Allowed is true.
evaluationError
string		EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request.
reason
string		Reason is optional. It indicates why a request was allowed or denied.
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a SubjectAccessReview

+

HTTP Request

+

POST /apis/authorization.k8s.io/v1beta1/subjectaccessreviews

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
SubjectAccessReview
+

Response

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

SubjectRulesReviewStatus v1beta1 authorization.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authorization.k8s.iov1beta1SubjectRulesReviewStatus
+ + + +

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

TokenReview v1beta1 authentication.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authentication.k8s.iov1beta1TokenReview
+ + + +

TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
TokenReviewSpec		Spec holds information about the request being evaluated
status
TokenReviewStatus		Status is filled in by the server and indicates whether the request can be authenticated.
+

TokenReviewSpec v1beta1 authentication

+ + + + + + + + + + + + + + + +
FieldDescription
token
string		Token is the opaque bearer token.
+

TokenReviewStatus v1beta1 authentication

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

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a TokenReview

+

HTTP Request

+

POST /apis/authentication.k8s.io/v1beta1/tokenreviews

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
TokenReview
+

Response

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

UserInfo v1beta1 authentication.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
authentication.k8s.iov1beta1UserInfo
+ + + +

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

VolumeAttachment v1alpha1 storage.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
storage.k8s.iov1alpha1VolumeAttachment
+ + + +

VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.

+

VolumeAttachment objects are non-namespaced.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ObjectMeta		Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
VolumeAttachmentSpec		Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system.
status
VolumeAttachmentStatus		Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher.
+

VolumeAttachmentSpec v1alpha1 storage

+ + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
attacher
string		Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName().
nodeName
string		The node that the volume should be attached to.
source
VolumeAttachmentSource		Source represents the volume that should be attached.
+

VolumeAttachmentStatus v1alpha1 storage

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
attachError
VolumeError		The last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
attached
boolean		Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
attachmentMetadata
object		Upon successful attach, this field is populated with any information returned by the attach operation that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher.
detachError
VolumeError		The last error encountered during detach operation, if any. This field must only be set by the entity completing the detach operation, i.e. the external-attacher.
+

VolumeAttachmentList v1alpha1 storage

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
apiVersion
string		APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/api-conventions.md#types-kinds
metadata
ListMeta		Standard list metadata More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
+

Write Operations

+

See supported operations below...

+

Create

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

create a VolumeAttachment

+

HTTP Request

+

POST /apis/storage.k8s.io/v1alpha1/volumeattachments

+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
VolumeAttachment
+

Response

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

Patch

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update the specified VolumeAttachment

+

HTTP Request

+

PATCH /apis/storage.k8s.io/v1alpha1/volumeattachments/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
VolumeAttachment		OK
+

Replace

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace the specified VolumeAttachment

+

HTTP Request

+

PUT /apis/storage.k8s.io/v1alpha1/volumeattachments/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

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

Body Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
VolumeAttachment
+

Response

+ + + + + + + + + + + + + + + + + +
CodeDescription
200
VolumeAttachment		OK
201
VolumeAttachment		Created
+

Delete

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete a VolumeAttachment

+

HTTP Request

+

DELETE /apis/storage.k8s.io/v1alpha1/volumeattachments/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, 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
+

Delete Collection

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

delete collection of VolumeAttachment

+

HTTP Request

+

DELETE /apis/storage.k8s.io/v1alpha1/volumeattachments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Status		OK
+

Read Operations

+

See supported operations below...

+

Read

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read the specified VolumeAttachment

+

HTTP Request

+

GET /apis/storage.k8s.io/v1alpha1/volumeattachments/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
exactShould the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
exportShould this value be exported. Export strips fields that a user can not specify.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
VolumeAttachment		OK
+

List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

list or watch objects of kind VolumeAttachment

+

HTTP Request

+

GET /apis/storage.k8s.io/v1alpha1/volumeattachments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch changes to an object of kind VolumeAttachment

+

HTTP Request

+

GET /apis/storage.k8s.io/v1alpha1/watch/volumeattachments/{name}

+

Path Parameters

+ + + + + + + + + + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for 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

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of VolumeAttachment

+

HTTP Request

+

GET /apis/storage.k8s.io/v1alpha1/watch/volumeattachments

+

Query Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSecondsTimeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
WatchEvent		OK
+
+

VolumeAttachmentSource v1alpha1 storage.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
storage.k8s.iov1alpha1VolumeAttachmentSource
+ + + +

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
persistentVolumeName
string		Name of the persistent volume to attach.
+
+

VolumeError v1alpha1 storage.k8s.io

+ + + + + + + + + + + + + + + +
GroupVersionKind
storage.k8s.iov1alpha1VolumeError
+ + + +

VolumeError captures an error encountered during a volume operation.

+ + + + + + + + + + + + + + + + + + + +
FieldDescription
message
string		String detailing the error encountered during Attach or Detach operation. This string maybe logged, so it should not contain sensitive information.
time
Time		Time the error was encountered.
+
+
+ + + + + + + + \ No newline at end of file diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/navData.js b/static/docs/reference/generated/kubernetes-api/v1.11/navData.js new file mode 100755 index 0000000000000..1a29afefb46b5 --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.11/navData.js @@ -0,0 +1 @@ +(function(){navData = {"toc":[{"section":"volumeerror-v1alpha1-storage-k8s-io","subsections":[]},{"section":"volumeattachmentsource-v1alpha1-storage-k8s-io","subsections":[]},{"section":"volumeattachment-v1alpha1-storage-k8s-io","subsections":[{"section":"-strong-read-operations-strong--1045","subsections":[{"section":"watch-list-1049"},{"section":"watch-1048"},{"section":"list-1047"},{"section":"read-1046"}]},{"section":"-strong-write-operations-strong--1039","subsections":[{"section":"delete-collection-1044"},{"section":"delete-1043"},{"section":"replace-1042"},{"section":"patch-1041"},{"section":"create-1040"}]}]},{"section":"userinfo-v1beta1-authentication-k8s-io","subsections":[]},{"section":"tokenreview-v1beta1-authentication-k8s-io","subsections":[{"section":"-strong-write-operations-strong--1037","subsections":[{"section":"create-1038"}]}]},{"section":"supplementalgroupsstrategyoptions-v1beta1-policy","subsections":[]},{"section":"subjectrulesreviewstatus-v1beta1-authorization-k8s-io","subsections":[]},{"section":"subjectaccessreview-v1beta1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-strong--1035","subsections":[{"section":"create-1036"}]}]},{"section":"subject-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"subject-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"storageclass-v1beta1-storage-k8s-io","subsections":[{"section":"-strong-read-operations-strong--1030","subsections":[{"section":"watch-list-1034"},{"section":"watch-1033"},{"section":"list-1032"},{"section":"read-1031"}]},{"section":"-strong-write-operations-strong--1024","subsections":[{"section":"delete-collection-1029"},{"section":"delete-1028"},{"section":"replace-1027"},{"section":"patch-1026"},{"section":"create-1025"}]}]},{"section":"statefulsetupdatestrategy-v1beta1-apps","subsections":[]},{"section":"statefulsetupdatestrategy-v1beta2-apps","subsections":[]},{"section":"statefulsetcondition-v1beta1-apps","subsections":[]},{"section":"statefulsetcondition-v1beta2-apps","subsections":[]},{"section":"statefulset-v1beta1-apps","subsections":[{"section":"-strong-misc-operations-strong--1020","subsections":[{"section":"patch-scale-1023"},{"section":"replace-scale-1022"},{"section":"read-scale-1021"}]},{"section":"-strong-status-operations-strong--1016","subsections":[{"section":"replace-status-1019"},{"section":"read-status-1018"},{"section":"patch-status-1017"}]},{"section":"-strong-read-operations-strong--1009","subsections":[{"section":"watch-list-all-namespaces-1015"},{"section":"watch-list-1014"},{"section":"watch-1013"},{"section":"list-all-namespaces-1012"},{"section":"list-1011"},{"section":"read-1010"}]},{"section":"-strong-write-operations-strong--1003","subsections":[{"section":"delete-collection-1008"},{"section":"delete-1007"},{"section":"replace-1006"},{"section":"patch-1005"},{"section":"create-1004"}]}]},{"section":"statefulset-v1beta2-apps","subsections":[{"section":"-strong-misc-operations-strong--999","subsections":[{"section":"patch-scale-1002"},{"section":"replace-scale-1001"},{"section":"read-scale-1000"}]},{"section":"-strong-status-operations-strong--995","subsections":[{"section":"replace-status-998"},{"section":"read-status-997"},{"section":"patch-status-996"}]},{"section":"-strong-read-operations-strong--988","subsections":[{"section":"watch-list-all-namespaces-994"},{"section":"watch-list-993"},{"section":"watch-992"},{"section":"list-all-namespaces-991"},{"section":"list-990"},{"section":"read-989"}]},{"section":"-strong-write-operations-strong--982","subsections":[{"section":"delete-collection-987"},{"section":"delete-986"},{"section":"replace-985"},{"section":"patch-984"},{"section":"create-983"}]}]},{"section":"servicereference-v1beta1-apiregistration-k8s-io","subsections":[]},{"section":"servicereference-v1beta1-admissionregistration-k8s-io","subsections":[]},{"section":"selfsubjectrulesreview-v1beta1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-strong--980","subsections":[{"section":"create-981"}]}]},{"section":"selfsubjectaccessreview-v1beta1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-strong--978","subsections":[{"section":"create-979"}]}]},{"section":"scale-v1beta1-extensions","subsections":[]},{"section":"scale-v1beta1-apps","subsections":[]},{"section":"scale-v1beta2-apps","subsections":[]},{"section":"selinuxstrategyoptions-v1beta1-policy","subsections":[]},{"section":"runasuserstrategyoptions-v1beta1-policy","subsections":[]},{"section":"rollingupdatestatefulsetstrategy-v1beta1-apps","subsections":[]},{"section":"rollingupdatestatefulsetstrategy-v1beta2-apps","subsections":[]},{"section":"rollbackconfig-v1beta1-extensions","subsections":[]},{"section":"roleref-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"roleref-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"rolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--971","subsections":[{"section":"watch-list-all-namespaces-977"},{"section":"watch-list-976"},{"section":"watch-975"},{"section":"list-all-namespaces-974"},{"section":"list-973"},{"section":"read-972"}]},{"section":"-strong-write-operations-strong--965","subsections":[{"section":"delete-collection-970"},{"section":"delete-969"},{"section":"replace-968"},{"section":"patch-967"},{"section":"create-966"}]}]},{"section":"rolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--958","subsections":[{"section":"watch-list-all-namespaces-964"},{"section":"watch-list-963"},{"section":"watch-962"},{"section":"list-all-namespaces-961"},{"section":"list-960"},{"section":"read-959"}]},{"section":"-strong-write-operations-strong--952","subsections":[{"section":"delete-collection-957"},{"section":"delete-956"},{"section":"replace-955"},{"section":"patch-954"},{"section":"create-953"}]}]},{"section":"role-v1alpha1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--945","subsections":[{"section":"watch-list-all-namespaces-951"},{"section":"watch-list-950"},{"section":"watch-949"},{"section":"list-all-namespaces-948"},{"section":"list-947"},{"section":"read-946"}]},{"section":"-strong-write-operations-strong--939","subsections":[{"section":"delete-collection-944"},{"section":"delete-943"},{"section":"replace-942"},{"section":"patch-941"},{"section":"create-940"}]}]},{"section":"role-v1beta1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--932","subsections":[{"section":"watch-list-all-namespaces-938"},{"section":"watch-list-937"},{"section":"watch-936"},{"section":"list-all-namespaces-935"},{"section":"list-934"},{"section":"read-933"}]},{"section":"-strong-write-operations-strong--926","subsections":[{"section":"delete-collection-931"},{"section":"delete-930"},{"section":"replace-929"},{"section":"patch-928"},{"section":"create-927"}]}]},{"section":"resourcerule-v1beta1-authorization-k8s-io","subsections":[]},{"section":"resourceattributes-v1beta1-authorization-k8s-io","subsections":[]},{"section":"replicasetcondition-v1beta1-extensions","subsections":[]},{"section":"replicasetcondition-v1beta2-apps","subsections":[]},{"section":"replicaset-v1beta1-extensions","subsections":[{"section":"-strong-misc-operations-strong--922","subsections":[{"section":"patch-scale-925"},{"section":"replace-scale-924"},{"section":"read-scale-923"}]},{"section":"-strong-status-operations-strong--918","subsections":[{"section":"replace-status-921"},{"section":"read-status-920"},{"section":"patch-status-919"}]},{"section":"-strong-read-operations-strong--911","subsections":[{"section":"watch-list-all-namespaces-917"},{"section":"watch-list-916"},{"section":"watch-915"},{"section":"list-all-namespaces-914"},{"section":"list-913"},{"section":"read-912"}]},{"section":"-strong-write-operations-strong--905","subsections":[{"section":"delete-collection-910"},{"section":"delete-909"},{"section":"replace-908"},{"section":"patch-907"},{"section":"create-906"}]}]},{"section":"replicaset-v1beta2-apps","subsections":[{"section":"-strong-misc-operations-strong--901","subsections":[{"section":"patch-scale-904"},{"section":"replace-scale-903"},{"section":"read-scale-902"}]},{"section":"-strong-status-operations-strong--897","subsections":[{"section":"replace-status-900"},{"section":"read-status-899"},{"section":"patch-status-898"}]},{"section":"-strong-read-operations-strong--890","subsections":[{"section":"watch-list-all-namespaces-896"},{"section":"watch-list-895"},{"section":"watch-894"},{"section":"list-all-namespaces-893"},{"section":"list-892"},{"section":"read-891"}]},{"section":"-strong-write-operations-strong--884","subsections":[{"section":"delete-collection-889"},{"section":"delete-888"},{"section":"replace-887"},{"section":"patch-886"},{"section":"create-885"}]}]},{"section":"priorityclass-v1alpha1-scheduling-k8s-io","subsections":[{"section":"-strong-read-operations-strong--879","subsections":[{"section":"watch-list-883"},{"section":"watch-882"},{"section":"list-881"},{"section":"read-880"}]},{"section":"-strong-write-operations-strong--873","subsections":[{"section":"delete-collection-878"},{"section":"delete-877"},{"section":"replace-876"},{"section":"patch-875"},{"section":"create-874"}]}]},{"section":"policyrule-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"policyrule-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"podsecuritypolicy-v1beta1-policy","subsections":[{"section":"-strong-read-operations-strong--868","subsections":[{"section":"watch-list-872"},{"section":"watch-871"},{"section":"list-870"},{"section":"read-869"}]},{"section":"-strong-write-operations-strong--862","subsections":[{"section":"delete-collection-867"},{"section":"delete-866"},{"section":"replace-865"},{"section":"patch-864"},{"section":"create-863"}]}]},{"section":"nonresourcerule-v1beta1-authorization-k8s-io","subsections":[]},{"section":"nonresourceattributes-v1beta1-authorization-k8s-io","subsections":[]},{"section":"networkpolicyport-v1beta1-extensions","subsections":[]},{"section":"networkpolicypeer-v1beta1-extensions","subsections":[]},{"section":"networkpolicyingressrule-v1beta1-extensions","subsections":[]},{"section":"networkpolicyegressrule-v1beta1-extensions","subsections":[]},{"section":"networkpolicy-v1beta1-extensions","subsections":[{"section":"-strong-read-operations-strong--855","subsections":[{"section":"watch-list-all-namespaces-861"},{"section":"watch-list-860"},{"section":"watch-859"},{"section":"list-all-namespaces-858"},{"section":"list-857"},{"section":"read-856"}]},{"section":"-strong-write-operations-strong--849","subsections":[{"section":"delete-collection-854"},{"section":"delete-853"},{"section":"replace-852"},{"section":"patch-851"},{"section":"create-850"}]}]},{"section":"localsubjectaccessreview-v1beta1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-strong--847","subsections":[{"section":"create-848"}]}]},{"section":"jobtemplatespec-v2alpha1-batch","subsections":[]},{"section":"initializer-v1alpha1-admissionregistration-k8s-io","subsections":[]},{"section":"ipblock-v1beta1-extensions","subsections":[]},{"section":"idrange-v1beta1-policy","subsections":[]},{"section":"hostportrange-v1beta1-policy","subsections":[]},{"section":"horizontalpodautoscaler-v2beta1-autoscaling","subsections":[{"section":"-strong-status-operations-strong--843","subsections":[{"section":"replace-status-846"},{"section":"read-status-845"},{"section":"patch-status-844"}]},{"section":"-strong-read-operations-strong--836","subsections":[{"section":"watch-list-all-namespaces-842"},{"section":"watch-list-841"},{"section":"watch-840"},{"section":"list-all-namespaces-839"},{"section":"list-838"},{"section":"read-837"}]},{"section":"-strong-write-operations-strong--830","subsections":[{"section":"delete-collection-835"},{"section":"delete-834"},{"section":"replace-833"},{"section":"patch-832"},{"section":"create-831"}]}]},{"section":"fsgroupstrategyoptions-v1beta1-policy","subsections":[]},{"section":"eventseries-v1beta1-events-k8s-io","subsections":[]},{"section":"event-v1beta1-events-k8s-io","subsections":[{"section":"-strong-read-operations-strong--823","subsections":[{"section":"watch-list-all-namespaces-829"},{"section":"watch-list-828"},{"section":"watch-827"},{"section":"list-all-namespaces-826"},{"section":"list-825"},{"section":"read-824"}]},{"section":"-strong-write-operations-strong--817","subsections":[{"section":"delete-collection-822"},{"section":"delete-821"},{"section":"replace-820"},{"section":"patch-819"},{"section":"create-818"}]}]},{"section":"deploymentcondition-v1beta1-extensions","subsections":[]},{"section":"deploymentcondition-v1beta1-apps","subsections":[]},{"section":"deploymentcondition-v1beta2-apps","subsections":[]},{"section":"deployment-v1beta1-extensions","subsections":[{"section":"-strong-misc-operations-strong--812","subsections":[{"section":"rollback-816"},{"section":"patch-scale-815"},{"section":"replace-scale-814"},{"section":"read-scale-813"}]},{"section":"-strong-status-operations-strong--808","subsections":[{"section":"replace-status-811"},{"section":"read-status-810"},{"section":"patch-status-809"}]},{"section":"-strong-read-operations-strong--801","subsections":[{"section":"watch-list-all-namespaces-807"},{"section":"watch-list-806"},{"section":"watch-805"},{"section":"list-all-namespaces-804"},{"section":"list-803"},{"section":"read-802"}]},{"section":"-strong-write-operations-strong--795","subsections":[{"section":"delete-collection-800"},{"section":"delete-799"},{"section":"replace-798"},{"section":"patch-797"},{"section":"create-796"}]}]},{"section":"deployment-v1beta1-apps","subsections":[{"section":"-strong-misc-operations-strong--791","subsections":[{"section":"rollback"},{"section":"patch-scale-794"},{"section":"replace-scale-793"},{"section":"read-scale-792"}]},{"section":"-strong-status-operations-strong--787","subsections":[{"section":"replace-status-790"},{"section":"read-status-789"},{"section":"patch-status-788"}]},{"section":"-strong-read-operations-strong--780","subsections":[{"section":"watch-list-all-namespaces-786"},{"section":"watch-list-785"},{"section":"watch-784"},{"section":"list-all-namespaces-783"},{"section":"list-782"},{"section":"read-781"}]},{"section":"-strong-write-operations-strong--774","subsections":[{"section":"delete-collection-779"},{"section":"delete-778"},{"section":"replace-777"},{"section":"patch-776"},{"section":"create-775"}]}]},{"section":"deployment-v1beta2-apps","subsections":[{"section":"-strong-misc-operations-strong--770","subsections":[{"section":"patch-scale-773"},{"section":"replace-scale-772"},{"section":"read-scale-771"}]},{"section":"-strong-status-operations-strong--766","subsections":[{"section":"replace-status-769"},{"section":"read-status-768"},{"section":"patch-status-767"}]},{"section":"-strong-read-operations-strong--759","subsections":[{"section":"watch-list-all-namespaces-765"},{"section":"watch-list-764"},{"section":"watch-763"},{"section":"list-all-namespaces-762"},{"section":"list-761"},{"section":"read-760"}]},{"section":"-strong-write-operations-strong--753","subsections":[{"section":"delete-collection-758"},{"section":"delete-757"},{"section":"replace-756"},{"section":"patch-755"},{"section":"create-754"}]}]},{"section":"daemonsetupdatestrategy-v1beta1-extensions","subsections":[]},{"section":"daemonsetupdatestrategy-v1beta2-apps","subsections":[]},{"section":"daemonsetcondition-v1beta1-extensions","subsections":[]},{"section":"daemonsetcondition-v1beta2-apps","subsections":[]},{"section":"daemonset-v1beta1-extensions","subsections":[{"section":"-strong-status-operations-strong--749","subsections":[{"section":"replace-status-752"},{"section":"read-status-751"},{"section":"patch-status-750"}]},{"section":"-strong-read-operations-strong--742","subsections":[{"section":"watch-list-all-namespaces-748"},{"section":"watch-list-747"},{"section":"watch-746"},{"section":"list-all-namespaces-745"},{"section":"list-744"},{"section":"read-743"}]},{"section":"-strong-write-operations-strong--736","subsections":[{"section":"delete-collection-741"},{"section":"delete-740"},{"section":"replace-739"},{"section":"patch-738"},{"section":"create-737"}]}]},{"section":"daemonset-v1beta2-apps","subsections":[{"section":"-strong-status-operations-strong--732","subsections":[{"section":"replace-status-735"},{"section":"read-status-734"},{"section":"patch-status-733"}]},{"section":"-strong-read-operations-strong--725","subsections":[{"section":"watch-list-all-namespaces-731"},{"section":"watch-list-730"},{"section":"watch-729"},{"section":"list-all-namespaces-728"},{"section":"list-727"},{"section":"read-726"}]},{"section":"-strong-write-operations-strong--719","subsections":[{"section":"delete-collection-724"},{"section":"delete-723"},{"section":"replace-722"},{"section":"patch-721"},{"section":"create-720"}]}]},{"section":"crossversionobjectreference-v2beta1-autoscaling","subsections":[]},{"section":"cronjob-v2alpha1-batch","subsections":[{"section":"-strong-status-operations-strong--715","subsections":[{"section":"replace-status-718"},{"section":"read-status-717"},{"section":"patch-status-716"}]},{"section":"-strong-read-operations-strong--708","subsections":[{"section":"watch-list-all-namespaces-714"},{"section":"watch-list-713"},{"section":"watch-712"},{"section":"list-all-namespaces-711"},{"section":"list-710"},{"section":"read-709"}]},{"section":"-strong-write-operations-strong--702","subsections":[{"section":"delete-collection-707"},{"section":"delete-706"},{"section":"replace-705"},{"section":"patch-704"},{"section":"create-703"}]}]},{"section":"controllerrevision-v1beta1-apps","subsections":[{"section":"-strong-read-operations-strong--695","subsections":[{"section":"watch-list-all-namespaces-701"},{"section":"watch-list-700"},{"section":"watch-699"},{"section":"list-all-namespaces-698"},{"section":"list-697"},{"section":"read-696"}]},{"section":"-strong-write-operations-strong--689","subsections":[{"section":"delete-collection-694"},{"section":"delete-693"},{"section":"replace-692"},{"section":"patch-691"},{"section":"create-690"}]}]},{"section":"controllerrevision-v1beta2-apps","subsections":[{"section":"-strong-read-operations-strong--682","subsections":[{"section":"watch-list-all-namespaces-688"},{"section":"watch-list-687"},{"section":"watch-686"},{"section":"list-all-namespaces-685"},{"section":"list-684"},{"section":"read-683"}]},{"section":"-strong-write-operations-strong--676","subsections":[{"section":"delete-collection-681"},{"section":"delete-680"},{"section":"replace-679"},{"section":"patch-678"},{"section":"create-677"}]}]},{"section":"clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--671","subsections":[{"section":"watch-list-675"},{"section":"watch-674"},{"section":"list-673"},{"section":"read-672"}]},{"section":"-strong-write-operations-strong--665","subsections":[{"section":"delete-collection-670"},{"section":"delete-669"},{"section":"replace-668"},{"section":"patch-667"},{"section":"create-666"}]}]},{"section":"clusterrolebinding-v1beta1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--660","subsections":[{"section":"watch-list-664"},{"section":"watch-663"},{"section":"list-662"},{"section":"read-661"}]},{"section":"-strong-write-operations-strong--654","subsections":[{"section":"delete-collection-659"},{"section":"delete-658"},{"section":"replace-657"},{"section":"patch-656"},{"section":"create-655"}]}]},{"section":"clusterrole-v1alpha1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--649","subsections":[{"section":"watch-list-653"},{"section":"watch-652"},{"section":"list-651"},{"section":"read-650"}]},{"section":"-strong-write-operations-strong--643","subsections":[{"section":"delete-collection-648"},{"section":"delete-647"},{"section":"replace-646"},{"section":"patch-645"},{"section":"create-644"}]}]},{"section":"clusterrole-v1beta1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--638","subsections":[{"section":"watch-list-642"},{"section":"watch-641"},{"section":"list-640"},{"section":"read-639"}]},{"section":"-strong-write-operations-strong--632","subsections":[{"section":"delete-collection-637"},{"section":"delete-636"},{"section":"replace-635"},{"section":"patch-634"},{"section":"create-633"}]}]},{"section":"allowedhostpath-v1beta1-policy","subsections":[]},{"section":"allowedflexvolume-v1beta1-policy","subsections":[]},{"section":"aggregationrule-v1alpha1-rbac-authorization-k8s-io","subsections":[]},{"section":"aggregationrule-v1beta1-rbac-authorization-k8s-io","subsections":[]},{"section":"apiservicecondition-v1beta1-apiregistration-k8s-io","subsections":[]},{"section":"apiservice-v1beta1-apiregistration-k8s-io","subsections":[{"section":"-strong-status-operations-strong--628","subsections":[{"section":"replace-status-631"},{"section":"read-status-630"},{"section":"patch-status-629"}]},{"section":"-strong-read-operations-strong--623","subsections":[{"section":"watch-list-627"},{"section":"watch-626"},{"section":"list-625"},{"section":"read-624"}]},{"section":"-strong-write-operations-strong--617","subsections":[{"section":"delete-collection-622"},{"section":"delete-621"},{"section":"replace-620"},{"section":"patch-619"},{"section":"create-618"}]}]},{"section":"-strong-old-api-versions-strong-","subsections":[]},{"section":"-strong-definitions-strong-","subsections":[{"section":"weightedpodaffinityterm-v1-core"},{"section":"webhookclientconfig-v1beta1-admissionregistration"},{"section":"webhook-v1beta1-admissionregistration"},{"section":"watchevent-v1-meta"},{"section":"vspherevirtualdiskvolumesource-v1-core"},{"section":"volumeprojection-v1-core"},{"section":"volumenodeaffinity-v1-core"},{"section":"volumemount-v1-core"},{"section":"volumeerror-v1beta1-storage"},{"section":"volumedevice-v1-core"},{"section":"volumeattachmentsource-v1beta1-storage"},{"section":"userinfo-v1-authentication"},{"section":"topologyselectorterm-v1-core"},{"section":"topologyselectorlabelrequirement-v1-core"},{"section":"toleration-v1-core"},{"section":"time-v1-meta"},{"section":"taint-v1-core"},{"section":"tcpsocketaction-v1-core"},{"section":"sysctl-v1-core"},{"section":"supplementalgroupsstrategyoptions-v1beta1-extensions"},{"section":"subjectrulesreviewstatus-v1-authorization"},{"section":"subject-v1-rbac"},{"section":"storageosvolumesource-v1-core"},{"section":"storageospersistentvolumesource-v1-core"},{"section":"statusdetails-v1-meta"},{"section":"statuscause-v1-meta"},{"section":"status-v1-meta"},{"section":"statefulsetupdatestrategy-v1-apps"},{"section":"statefulsetcondition-v1-apps"},{"section":"sessionaffinityconfig-v1-core"},{"section":"servicereference-v1-apiregistration"},{"section":"serviceport-v1-core"},{"section":"serviceaccounttokenprojection-v1-core"},{"section":"serveraddressbyclientcidr-v1-meta"},{"section":"securitycontext-v1-core"},{"section":"secretvolumesource-v1-core"},{"section":"secretreference-v1-core"},{"section":"secretprojection-v1-core"},{"section":"secretkeyselector-v1-core"},{"section":"secretenvsource-v1-core"},{"section":"scopedresourceselectorrequirement-v1-core"},{"section":"scopeselector-v1-core"},{"section":"scaleiovolumesource-v1-core"},{"section":"scaleiopersistentvolumesource-v1-core"},{"section":"scale-v1-autoscaling"},{"section":"selinuxstrategyoptions-v1beta1-extensions"},{"section":"selinuxoptions-v1-core"},{"section":"runasuserstrategyoptions-v1beta1-extensions"},{"section":"rulewithoperations-v1beta1-admissionregistration"},{"section":"rule-v1alpha1-admissionregistration"},{"section":"rollingupdatestatefulsetstrategy-v1-apps"},{"section":"rollbackconfig-v1beta1-apps"},{"section":"roleref-v1-rbac"},{"section":"resourcerule-v1-authorization"},{"section":"resourcerequirements-v1-core"},{"section":"resourcemetricstatus-v2beta1-autoscaling"},{"section":"resourcemetricsource-v2beta1-autoscaling"},{"section":"resourcefieldselector-v1-core"},{"section":"resourceattributes-v1-authorization"},{"section":"replicationcontrollercondition-v1-core"},{"section":"replicasetcondition-v1-apps"},{"section":"rbdvolumesource-v1-core"},{"section":"rbdpersistentvolumesource-v1-core"},{"section":"quobytevolumesource-v1-core"},{"section":"quantity-resource-core"},{"section":"projectedvolumesource-v1-core"},{"section":"probe-v1-core"},{"section":"preferredschedulingterm-v1-core"},{"section":"preconditions-v1-meta"},{"section":"portworxvolumesource-v1-core"},{"section":"policyrule-v1-rbac"},{"section":"podsmetricstatus-v2beta1-autoscaling"},{"section":"podsmetricsource-v2beta1-autoscaling"},{"section":"podsecuritycontext-v1-core"},{"section":"podreadinessgate-v1-core"},{"section":"poddnsconfigoption-v1-core"},{"section":"poddnsconfig-v1-core"},{"section":"podcondition-v1-core"},{"section":"podantiaffinity-v1-core"},{"section":"podaffinityterm-v1-core"},{"section":"podaffinity-v1-core"},{"section":"photonpersistentdiskvolumesource-v1-core"},{"section":"persistentvolumeclaimvolumesource-v1-core"},{"section":"persistentvolumeclaimcondition-v1-core"},{"section":"patch-v1-meta"},{"section":"ownerreference-v1-meta"},{"section":"objectreference-v1-core"},{"section":"objectmetricstatus-v2beta1-autoscaling"},{"section":"objectmetricsource-v2beta1-autoscaling"},{"section":"objectmeta-v1-meta"},{"section":"objectfieldselector-v1-core"},{"section":"nonresourcerule-v1-authorization"},{"section":"nonresourceattributes-v1-authorization"},{"section":"nodesysteminfo-v1-core"},{"section":"nodeselectorterm-v1-core"},{"section":"nodeselectorrequirement-v1-core"},{"section":"nodeselector-v1-core"},{"section":"nodedaemonendpoints-v1-core"},{"section":"nodeconfigstatus-v1-core"},{"section":"nodeconfigsource-v1-core"},{"section":"nodecondition-v1-core"},{"section":"nodeaffinity-v1-core"},{"section":"nodeaddress-v1-core"},{"section":"networkpolicyport-v1-networking"},{"section":"networkpolicypeer-v1-networking"},{"section":"networkpolicyingressrule-v1-networking"},{"section":"networkpolicyegressrule-v1-networking"},{"section":"nfsvolumesource-v1-core"},{"section":"microtime-v1-meta"},{"section":"metricstatus-v2beta1-autoscaling"},{"section":"metricspec-v2beta1-autoscaling"},{"section":"localvolumesource-v1-core"},{"section":"localobjectreference-v1-core"},{"section":"loadbalancerstatus-v1-core"},{"section":"loadbalanceringress-v1-core"},{"section":"listmeta-v1-meta"},{"section":"limitrangeitem-v1-core"},{"section":"lifecycle-v1-core"},{"section":"labelselectorrequirement-v1-meta"},{"section":"labelselector-v1-meta"},{"section":"keytopath-v1-core"},{"section":"jobtemplatespec-v1beta1-batch"},{"section":"jobcondition-v1-batch"},{"section":"jsonschemapropsorbool-v1beta1-apiextensions"},{"section":"jsonschemapropsorarray-v1beta1-apiextensions"},{"section":"jsonschemaprops-v1beta1-apiextensions"},{"section":"json-v1beta1-apiextensions"},{"section":"initializers-v1-meta"},{"section":"initializer-v1-meta"},{"section":"ingresstls-v1beta1-extensions"},{"section":"ingressrule-v1beta1-extensions"},{"section":"ingressbackend-v1beta1-extensions"},{"section":"iscsivolumesource-v1-core"},{"section":"iscsipersistentvolumesource-v1-core"},{"section":"ipblock-v1-networking"},{"section":"idrange-v1beta1-extensions"},{"section":"hostportrange-v1beta1-extensions"},{"section":"hostpathvolumesource-v1-core"},{"section":"hostalias-v1-core"},{"section":"horizontalpodautoscalercondition-v2beta1-autoscaling"},{"section":"handler-v1-core"},{"section":"httpingressrulevalue-v1beta1-extensions"},{"section":"httpingresspath-v1beta1-extensions"},{"section":"httpheader-v1-core"},{"section":"httpgetaction-v1-core"},{"section":"groupversionfordiscovery-v1-meta"},{"section":"glusterfsvolumesource-v1-core"},{"section":"gitrepovolumesource-v1-core"},{"section":"gcepersistentdiskvolumesource-v1-core"},{"section":"flockervolumesource-v1-core"},{"section":"flexvolumesource-v1-core"},{"section":"flexpersistentvolumesource-v1-core"},{"section":"fsgroupstrategyoptions-v1beta1-extensions"},{"section":"fcvolumesource-v1-core"},{"section":"externalmetricstatus-v2beta1-autoscaling"},{"section":"externalmetricsource-v2beta1-autoscaling"},{"section":"externaldocumentation-v1beta1-apiextensions"},{"section":"execaction-v1-core"},{"section":"eviction-v1beta1-policy"},{"section":"eventsource-v1-core"},{"section":"eventseries-v1-core"},{"section":"envvarsource-v1-core"},{"section":"envvar-v1-core"},{"section":"envfromsource-v1-core"},{"section":"endpointsubset-v1-core"},{"section":"endpointport-v1-core"},{"section":"endpointaddress-v1-core"},{"section":"emptydirvolumesource-v1-core"},{"section":"downwardapivolumesource-v1-core"},{"section":"downwardapivolumefile-v1-core"},{"section":"downwardapiprojection-v1-core"},{"section":"deploymentcondition-v1-apps"},{"section":"deleteoptions-v1-meta"},{"section":"daemonsetupdatestrategy-v1-apps"},{"section":"daemonsetcondition-v1-apps"},{"section":"daemonendpoint-v1-core"},{"section":"customresourcevalidation-v1beta1-apiextensions"},{"section":"customresourcesubresources-v1beta1-apiextensions"},{"section":"customresourcesubresourcestatus-v1beta1-apiextensions"},{"section":"customresourcesubresourcescale-v1beta1-apiextensions"},{"section":"customresourcedefinitionversion-v1beta1-apiextensions"},{"section":"customresourcedefinitionnames-v1beta1-apiextensions"},{"section":"customresourcedefinitioncondition-v1beta1-apiextensions"},{"section":"customresourcecolumndefinition-v1beta1-apiextensions"},{"section":"crossversionobjectreference-v1-autoscaling"},{"section":"containerstatewaiting-v1-core"},{"section":"containerstateterminated-v1-core"},{"section":"containerstaterunning-v1-core"},{"section":"containerstate-v1-core"},{"section":"containerport-v1-core"},{"section":"containerimage-v1-core"},{"section":"configmapvolumesource-v1-core"},{"section":"configmapprojection-v1-core"},{"section":"configmapnodeconfigsource-v1-core"},{"section":"configmapkeyselector-v1-core"},{"section":"configmapenvsource-v1-core"},{"section":"componentcondition-v1-core"},{"section":"clientipconfig-v1-core"},{"section":"cindervolumesource-v1-core"},{"section":"cinderpersistentvolumesource-v1-core"},{"section":"certificatesigningrequestcondition-v1beta1-certificates"},{"section":"cephfsvolumesource-v1-core"},{"section":"cephfspersistentvolumesource-v1-core"},{"section":"capabilities-v1-core"},{"section":"csipersistentvolumesource-v1-core"},{"section":"azurefilevolumesource-v1-core"},{"section":"azurefilepersistentvolumesource-v1-core"},{"section":"azurediskvolumesource-v1-core"},{"section":"attachedvolume-v1-core"},{"section":"allowedhostpath-v1beta1-extensions"},{"section":"allowedflexvolume-v1beta1-extensions"},{"section":"aggregationrule-v1-rbac"},{"section":"affinity-v1-core"},{"section":"awselasticblockstorevolumesource-v1-core"},{"section":"apiversions-v1-meta"},{"section":"apiservicecondition-v1-apiregistration"},{"section":"apiresource-v1-meta"},{"section":"apigroup-v1-meta"}]},{"section":"networkpolicy-v1-networking-k8s-io","subsections":[{"section":"-strong-read-operations-strong--610","subsections":[{"section":"watch-list-all-namespaces-616"},{"section":"watch-list-615"},{"section":"watch-614"},{"section":"list-all-namespaces-613"},{"section":"list-612"},{"section":"read-611"}]},{"section":"-strong-write-operations-strong--604","subsections":[{"section":"delete-collection-609"},{"section":"delete-608"},{"section":"replace-607"},{"section":"patch-606"},{"section":"create-605"}]}]},{"section":"tokenreview-v1-authentication-k8s-io","subsections":[{"section":"-strong-write-operations-strong--602","subsections":[{"section":"create-603"}]}]},{"section":"subjectaccessreview-v1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-strong--600","subsections":[{"section":"create-601"}]}]},{"section":"serviceaccount-v1-core","subsections":[{"section":"-strong-read-operations-strong--593","subsections":[{"section":"watch-list-all-namespaces-599"},{"section":"watch-list-598"},{"section":"watch-597"},{"section":"list-all-namespaces-596"},{"section":"list-595"},{"section":"read-594"}]},{"section":"-strong-write-operations-strong--587","subsections":[{"section":"delete-collection-592"},{"section":"delete-591"},{"section":"replace-590"},{"section":"patch-589"},{"section":"create-588"}]}]},{"section":"selfsubjectrulesreview-v1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-strong--585","subsections":[{"section":"create-586"}]}]},{"section":"selfsubjectaccessreview-v1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-strong--583","subsections":[{"section":"create-584"}]}]},{"section":"rolebinding-v1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--576","subsections":[{"section":"watch-list-all-namespaces-582"},{"section":"watch-list-581"},{"section":"watch-580"},{"section":"list-all-namespaces-579"},{"section":"list-578"},{"section":"read-577"}]},{"section":"-strong-write-operations-strong--570","subsections":[{"section":"delete-collection-575"},{"section":"delete-574"},{"section":"replace-573"},{"section":"patch-572"},{"section":"create-571"}]}]},{"section":"role-v1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--563","subsections":[{"section":"watch-list-all-namespaces-569"},{"section":"watch-list-568"},{"section":"watch-567"},{"section":"list-all-namespaces-566"},{"section":"list-565"},{"section":"read-564"}]},{"section":"-strong-write-operations-strong--557","subsections":[{"section":"delete-collection-562"},{"section":"delete-561"},{"section":"replace-560"},{"section":"patch-559"},{"section":"create-558"}]}]},{"section":"resourcequota-v1-core","subsections":[{"section":"-strong-status-operations-strong--553","subsections":[{"section":"replace-status-556"},{"section":"read-status-555"},{"section":"patch-status-554"}]},{"section":"-strong-read-operations-strong--546","subsections":[{"section":"watch-list-all-namespaces-552"},{"section":"watch-list-551"},{"section":"watch-550"},{"section":"list-all-namespaces-549"},{"section":"list-548"},{"section":"read-547"}]},{"section":"-strong-write-operations-strong--540","subsections":[{"section":"delete-collection-545"},{"section":"delete-544"},{"section":"replace-543"},{"section":"patch-542"},{"section":"create-541"}]}]},{"section":"persistentvolume-v1-core","subsections":[{"section":"-strong-status-operations-strong--536","subsections":[{"section":"replace-status-539"},{"section":"read-status-538"},{"section":"patch-status-537"}]},{"section":"-strong-read-operations-strong--531","subsections":[{"section":"watch-list-535"},{"section":"watch-534"},{"section":"list-533"},{"section":"read-532"}]},{"section":"-strong-write-operations-strong--525","subsections":[{"section":"delete-collection-530"},{"section":"delete-529"},{"section":"replace-528"},{"section":"patch-527"},{"section":"create-526"}]}]},{"section":"node-v1-core","subsections":[{"section":"-strong-proxy-operations-strong--514","subsections":[{"section":"replace-connect-proxy-path-524"},{"section":"replace-connect-proxy-523"},{"section":"head-connect-proxy-path-522"},{"section":"head-connect-proxy-521"},{"section":"get-connect-proxy-path-520"},{"section":"get-connect-proxy-519"},{"section":"delete-connect-proxy-path-518"},{"section":"delete-connect-proxy-517"},{"section":"create-connect-proxy-path-516"},{"section":"create-connect-proxy-515"}]},{"section":"-strong-status-operations-strong--510","subsections":[{"section":"replace-status-513"},{"section":"read-status-512"},{"section":"patch-status-511"}]},{"section":"-strong-read-operations-strong--505","subsections":[{"section":"watch-list-509"},{"section":"watch-508"},{"section":"list-507"},{"section":"read-506"}]},{"section":"-strong-write-operations-strong--499","subsections":[{"section":"delete-collection-504"},{"section":"delete-503"},{"section":"replace-502"},{"section":"patch-501"},{"section":"create-500"}]}]},{"section":"namespace-v1-core","subsections":[{"section":"-strong-status-operations-strong--495","subsections":[{"section":"replace-status-498"},{"section":"read-status-497"},{"section":"patch-status-496"}]},{"section":"-strong-read-operations-strong--490","subsections":[{"section":"watch-list-494"},{"section":"watch-493"},{"section":"list-492"},{"section":"read-491"}]},{"section":"-strong-write-operations-strong--485","subsections":[{"section":"delete-489"},{"section":"replace-488"},{"section":"patch-487"},{"section":"create-486"}]}]},{"section":"localsubjectaccessreview-v1-authorization-k8s-io","subsections":[{"section":"-strong-write-operations-strong--483","subsections":[{"section":"create-484"}]}]},{"section":"componentstatus-v1-core","subsections":[{"section":"-strong-read-operations-strong--480","subsections":[{"section":"list-482"},{"section":"read-481"}]}]},{"section":"clusterrolebinding-v1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--475","subsections":[{"section":"watch-list-479"},{"section":"watch-478"},{"section":"list-477"},{"section":"read-476"}]},{"section":"-strong-write-operations-strong--469","subsections":[{"section":"delete-collection-474"},{"section":"delete-473"},{"section":"replace-472"},{"section":"patch-471"},{"section":"create-470"}]}]},{"section":"clusterrole-v1-rbac-authorization-k8s-io","subsections":[{"section":"-strong-read-operations-strong--464","subsections":[{"section":"watch-list-468"},{"section":"watch-467"},{"section":"list-466"},{"section":"read-465"}]},{"section":"-strong-write-operations-strong--458","subsections":[{"section":"delete-collection-463"},{"section":"delete-462"},{"section":"replace-461"},{"section":"patch-460"},{"section":"create-459"}]}]},{"section":"certificatesigningrequest-v1beta1-certificates-k8s-io","subsections":[{"section":"-strong-status-operations-strong--454","subsections":[{"section":"replace-status-457"},{"section":"read-status-456"},{"section":"patch-status-455"}]},{"section":"-strong-read-operations-strong--449","subsections":[{"section":"watch-list-453"},{"section":"watch-452"},{"section":"list-451"},{"section":"read-450"}]},{"section":"-strong-write-operations-strong--443","subsections":[{"section":"delete-collection-448"},{"section":"delete-447"},{"section":"replace-446"},{"section":"patch-445"},{"section":"create-444"}]}]},{"section":"binding-v1-core","subsections":[{"section":"-strong-write-operations-strong--441","subsections":[{"section":"create-442"}]}]},{"section":"apiservice-v1-apiregistration-k8s-io","subsections":[{"section":"-strong-status-operations-strong--437","subsections":[{"section":"replace-status-440"},{"section":"read-status-439"},{"section":"patch-status-438"}]},{"section":"-strong-read-operations-strong--432","subsections":[{"section":"watch-list-436"},{"section":"watch-435"},{"section":"list-434"},{"section":"read-433"}]},{"section":"-strong-write-operations-strong--426","subsections":[{"section":"delete-collection-431"},{"section":"delete-430"},{"section":"replace-429"},{"section":"patch-428"},{"section":"create-427"}]}]},{"section":"-strong-cluster-strong-","subsections":[]},{"section":"podsecuritypolicy-v1beta1-extensions","subsections":[{"section":"-strong-read-operations-strong--421","subsections":[{"section":"watch-list-425"},{"section":"watch-424"},{"section":"list-423"},{"section":"read-422"}]},{"section":"-strong-write-operations-strong--415","subsections":[{"section":"delete-collection-420"},{"section":"delete-419"},{"section":"replace-418"},{"section":"patch-417"},{"section":"create-416"}]}]},{"section":"podpreset-v1alpha1-settings-k8s-io","subsections":[{"section":"-strong-read-operations-strong--408","subsections":[{"section":"watch-list-all-namespaces-414"},{"section":"watch-list-413"},{"section":"watch-412"},{"section":"list-all-namespaces-411"},{"section":"list-410"},{"section":"read-409"}]},{"section":"-strong-write-operations-strong--402","subsections":[{"section":"delete-collection-407"},{"section":"delete-406"},{"section":"replace-405"},{"section":"patch-404"},{"section":"create-403"}]}]},{"section":"priorityclass-v1beta1-scheduling-k8s-io","subsections":[{"section":"-strong-read-operations-strong--397","subsections":[{"section":"watch-list-401"},{"section":"watch-400"},{"section":"list-399"},{"section":"read-398"}]},{"section":"-strong-write-operations-strong--391","subsections":[{"section":"delete-collection-396"},{"section":"delete-395"},{"section":"replace-394"},{"section":"patch-393"},{"section":"create-392"}]}]},{"section":"poddisruptionbudget-v1beta1-policy","subsections":[{"section":"-strong-status-operations-strong--387","subsections":[{"section":"replace-status-390"},{"section":"read-status-389"},{"section":"patch-status-388"}]},{"section":"-strong-read-operations-strong--380","subsections":[{"section":"watch-list-all-namespaces-386"},{"section":"watch-list-385"},{"section":"watch-384"},{"section":"list-all-namespaces-383"},{"section":"list-382"},{"section":"read-381"}]},{"section":"-strong-write-operations-strong--374","subsections":[{"section":"delete-collection-379"},{"section":"delete-378"},{"section":"replace-377"},{"section":"patch-376"},{"section":"create-375"}]}]},{"section":"podtemplate-v1-core","subsections":[{"section":"-strong-read-operations-strong--367","subsections":[{"section":"watch-list-all-namespaces-373"},{"section":"watch-list-372"},{"section":"watch-371"},{"section":"list-all-namespaces-370"},{"section":"list-369"},{"section":"read-368"}]},{"section":"-strong-write-operations-strong--361","subsections":[{"section":"delete-collection-366"},{"section":"delete-365"},{"section":"replace-364"},{"section":"patch-363"},{"section":"create-362"}]}]},{"section":"validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[{"section":"-strong-read-operations-strong--356","subsections":[{"section":"watch-list-360"},{"section":"watch-359"},{"section":"list-358"},{"section":"read-357"}]},{"section":"-strong-write-operations-strong--350","subsections":[{"section":"delete-collection-355"},{"section":"delete-354"},{"section":"replace-353"},{"section":"patch-352"},{"section":"create-351"}]}]},{"section":"mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","subsections":[{"section":"-strong-read-operations-strong--345","subsections":[{"section":"watch-list-349"},{"section":"watch-348"},{"section":"list-347"},{"section":"read-346"}]},{"section":"-strong-write-operations-strong--339","subsections":[{"section":"delete-collection-344"},{"section":"delete-343"},{"section":"replace-342"},{"section":"patch-341"},{"section":"create-340"}]}]},{"section":"initializerconfiguration-v1alpha1-admissionregistration-k8s-io","subsections":[{"section":"-strong-read-operations-strong--334","subsections":[{"section":"watch-list-338"},{"section":"watch-337"},{"section":"list-336"},{"section":"read-335"}]},{"section":"-strong-write-operations-strong--328","subsections":[{"section":"delete-collection-333"},{"section":"delete-332"},{"section":"replace-331"},{"section":"patch-330"},{"section":"create-329"}]}]},{"section":"horizontalpodautoscaler-v1-autoscaling","subsections":[{"section":"-strong-status-operations-strong--324","subsections":[{"section":"replace-status-327"},{"section":"read-status-326"},{"section":"patch-status-325"}]},{"section":"-strong-read-operations-strong--317","subsections":[{"section":"watch-list-all-namespaces-323"},{"section":"watch-list-322"},{"section":"watch-321"},{"section":"list-all-namespaces-320"},{"section":"list-319"},{"section":"read-318"}]},{"section":"-strong-write-operations-strong--311","subsections":[{"section":"delete-collection-316"},{"section":"delete-315"},{"section":"replace-314"},{"section":"patch-313"},{"section":"create-312"}]}]},{"section":"limitrange-v1-core","subsections":[{"section":"-strong-read-operations-strong--304","subsections":[{"section":"watch-list-all-namespaces-310"},{"section":"watch-list-309"},{"section":"watch-308"},{"section":"list-all-namespaces-307"},{"section":"list-306"},{"section":"read-305"}]},{"section":"-strong-write-operations-strong--298","subsections":[{"section":"delete-collection-303"},{"section":"delete-302"},{"section":"replace-301"},{"section":"patch-300"},{"section":"create-299"}]}]},{"section":"event-v1-core","subsections":[{"section":"-strong-read-operations-strong--291","subsections":[{"section":"watch-list-all-namespaces-297"},{"section":"watch-list-296"},{"section":"watch-295"},{"section":"list-all-namespaces-294"},{"section":"list-293"},{"section":"read-292"}]},{"section":"-strong-write-operations-strong--285","subsections":[{"section":"delete-collection-290"},{"section":"delete-289"},{"section":"replace-288"},{"section":"patch-287"},{"section":"create-286"}]}]},{"section":"customresourcedefinition-v1beta1-apiextensions-k8s-io","subsections":[{"section":"-strong-status-operations-strong--281","subsections":[{"section":"replace-status-284"},{"section":"read-status-283"},{"section":"patch-status-282"}]},{"section":"-strong-read-operations-strong--276","subsections":[{"section":"watch-list-280"},{"section":"watch-279"},{"section":"list-278"},{"section":"read-277"}]},{"section":"-strong-write-operations-strong--270","subsections":[{"section":"delete-collection-275"},{"section":"delete-274"},{"section":"replace-273"},{"section":"patch-272"},{"section":"create-271"}]}]},{"section":"controllerrevision-v1-apps","subsections":[{"section":"-strong-read-operations-strong--263","subsections":[{"section":"watch-list-all-namespaces-269"},{"section":"watch-list-268"},{"section":"watch-267"},{"section":"list-all-namespaces-266"},{"section":"list-265"},{"section":"read-264"}]},{"section":"-strong-write-operations-strong--257","subsections":[{"section":"delete-collection-262"},{"section":"delete-261"},{"section":"replace-260"},{"section":"patch-259"},{"section":"create-258"}]}]},{"section":"-strong-metadata-strong-","subsections":[]},{"section":"volumeattachment-v1beta1-storage-k8s-io","subsections":[{"section":"-strong-read-operations-strong--252","subsections":[{"section":"watch-list-256"},{"section":"watch-255"},{"section":"list-254"},{"section":"read-253"}]},{"section":"-strong-write-operations-strong--246","subsections":[{"section":"delete-collection-251"},{"section":"delete-250"},{"section":"replace-249"},{"section":"patch-248"},{"section":"create-247"}]}]},{"section":"volume-v1-core","subsections":[]},{"section":"storageclass-v1-storage-k8s-io","subsections":[{"section":"-strong-read-operations-strong--241","subsections":[{"section":"watch-list-245"},{"section":"watch-244"},{"section":"list-243"},{"section":"read-242"}]},{"section":"-strong-write-operations-strong--235","subsections":[{"section":"delete-collection-240"},{"section":"delete-239"},{"section":"replace-238"},{"section":"patch-237"},{"section":"create-236"}]}]},{"section":"persistentvolumeclaim-v1-core","subsections":[{"section":"-strong-status-operations-strong--231","subsections":[{"section":"replace-status-234"},{"section":"read-status-233"},{"section":"patch-status-232"}]},{"section":"-strong-read-operations-strong--224","subsections":[{"section":"watch-list-all-namespaces-230"},{"section":"watch-list-229"},{"section":"watch-228"},{"section":"list-all-namespaces-227"},{"section":"list-226"},{"section":"read-225"}]},{"section":"-strong-write-operations-strong--218","subsections":[{"section":"delete-collection-223"},{"section":"delete-222"},{"section":"replace-221"},{"section":"patch-220"},{"section":"create-219"}]}]},{"section":"secret-v1-core","subsections":[{"section":"-strong-read-operations-strong--211","subsections":[{"section":"watch-list-all-namespaces-217"},{"section":"watch-list-216"},{"section":"watch-215"},{"section":"list-all-namespaces-214"},{"section":"list-213"},{"section":"read-212"}]},{"section":"-strong-write-operations-strong--205","subsections":[{"section":"delete-collection-210"},{"section":"delete-209"},{"section":"replace-208"},{"section":"patch-207"},{"section":"create-206"}]}]},{"section":"configmap-v1-core","subsections":[{"section":"-strong-read-operations-strong--198","subsections":[{"section":"watch-list-all-namespaces-204"},{"section":"watch-list-203"},{"section":"watch-202"},{"section":"list-all-namespaces-201"},{"section":"list-200"},{"section":"read-199"}]},{"section":"-strong-write-operations-strong--192","subsections":[{"section":"delete-collection-197"},{"section":"delete-196"},{"section":"replace-195"},{"section":"patch-194"},{"section":"create-193"}]}]},{"section":"-strong-config-storage-strong-","subsections":[]},{"section":"service-v1-core","subsections":[{"section":"-strong-proxy-operations-strong--181","subsections":[{"section":"replace-connect-proxy-path-191"},{"section":"replace-connect-proxy-190"},{"section":"head-connect-proxy-path-189"},{"section":"head-connect-proxy-188"},{"section":"get-connect-proxy-path-187"},{"section":"get-connect-proxy-186"},{"section":"delete-connect-proxy-path-185"},{"section":"delete-connect-proxy-184"},{"section":"create-connect-proxy-path-183"},{"section":"create-connect-proxy-182"}]},{"section":"-strong-status-operations-strong--177","subsections":[{"section":"replace-status-180"},{"section":"read-status-179"},{"section":"patch-status-178"}]},{"section":"-strong-read-operations-strong--170","subsections":[{"section":"watch-list-all-namespaces-176"},{"section":"watch-list-175"},{"section":"watch-174"},{"section":"list-all-namespaces-173"},{"section":"list-172"},{"section":"read-171"}]},{"section":"-strong-write-operations-strong--165","subsections":[{"section":"delete-169"},{"section":"replace-168"},{"section":"patch-167"},{"section":"create-166"}]}]},{"section":"ingress-v1beta1-extensions","subsections":[{"section":"-strong-status-operations-strong--161","subsections":[{"section":"replace-status-164"},{"section":"read-status-163"},{"section":"patch-status-162"}]},{"section":"-strong-read-operations-strong--154","subsections":[{"section":"watch-list-all-namespaces-160"},{"section":"watch-list-159"},{"section":"watch-158"},{"section":"list-all-namespaces-157"},{"section":"list-156"},{"section":"read-155"}]},{"section":"-strong-write-operations-strong--148","subsections":[{"section":"delete-collection-153"},{"section":"delete-152"},{"section":"replace-151"},{"section":"patch-150"},{"section":"create-149"}]}]},{"section":"endpoints-v1-core","subsections":[{"section":"-strong-read-operations-strong--141","subsections":[{"section":"watch-list-all-namespaces-147"},{"section":"watch-list-146"},{"section":"watch-145"},{"section":"list-all-namespaces-144"},{"section":"list-143"},{"section":"read-142"}]},{"section":"-strong-write-operations-strong--135","subsections":[{"section":"delete-collection-140"},{"section":"delete-139"},{"section":"replace-138"},{"section":"patch-137"},{"section":"create-136"}]}]},{"section":"-strong-discovery-load-balancing-strong-","subsections":[]},{"section":"statefulset-v1-apps","subsections":[{"section":"-strong-misc-operations-strong--131","subsections":[{"section":"patch-scale-134"},{"section":"replace-scale-133"},{"section":"read-scale-132"}]},{"section":"-strong-status-operations-strong--127","subsections":[{"section":"replace-status-130"},{"section":"read-status-129"},{"section":"patch-status-128"}]},{"section":"-strong-read-operations-strong--120","subsections":[{"section":"watch-list-all-namespaces-126"},{"section":"watch-list-125"},{"section":"watch-124"},{"section":"list-all-namespaces-123"},{"section":"list-122"},{"section":"read-121"}]},{"section":"-strong-write-operations-strong--114","subsections":[{"section":"delete-collection-119"},{"section":"delete-118"},{"section":"replace-117"},{"section":"patch-116"},{"section":"create-115"}]}]},{"section":"replicationcontroller-v1-core","subsections":[{"section":"-strong-misc-operations-strong--110","subsections":[{"section":"patch-scale-113"},{"section":"replace-scale-112"},{"section":"read-scale-111"}]},{"section":"-strong-status-operations-strong--106","subsections":[{"section":"replace-status-109"},{"section":"read-status-108"},{"section":"patch-status-107"}]},{"section":"-strong-read-operations-strong--99","subsections":[{"section":"watch-list-all-namespaces-105"},{"section":"watch-list-104"},{"section":"watch-103"},{"section":"list-all-namespaces-102"},{"section":"list-101"},{"section":"read-100"}]},{"section":"-strong-write-operations-strong--93","subsections":[{"section":"delete-collection-98"},{"section":"delete-97"},{"section":"replace-96"},{"section":"patch-95"},{"section":"create-94"}]}]},{"section":"replicaset-v1-apps","subsections":[{"section":"-strong-misc-operations-strong--89","subsections":[{"section":"patch-scale-92"},{"section":"replace-scale-91"},{"section":"read-scale-90"}]},{"section":"-strong-status-operations-strong--85","subsections":[{"section":"replace-status-88"},{"section":"read-status-87"},{"section":"patch-status-86"}]},{"section":"-strong-read-operations-strong--78","subsections":[{"section":"watch-list-all-namespaces-84"},{"section":"watch-list-83"},{"section":"watch-82"},{"section":"list-all-namespaces-81"},{"section":"list-80"},{"section":"read-79"}]},{"section":"-strong-write-operations-strong--72","subsections":[{"section":"delete-collection-77"},{"section":"delete-76"},{"section":"replace-75"},{"section":"patch-74"},{"section":"create-73"}]}]},{"section":"pod-v1-core","subsections":[{"section":"-strong-misc-operations-strong--71","subsections":[{"section":"read-log"}]},{"section":"-strong-proxy-operations-strong-","subsections":[{"section":"replace-connect-proxy-path"},{"section":"replace-connect-proxy"},{"section":"head-connect-proxy-path"},{"section":"head-connect-proxy"},{"section":"get-connect-proxy-path"},{"section":"get-connect-proxy"},{"section":"get-connect-portforward"},{"section":"delete-connect-proxy-path"},{"section":"delete-connect-proxy"},{"section":"create-connect-proxy-path"},{"section":"create-connect-proxy"},{"section":"create-connect-portforward"}]},{"section":"-strong-status-operations-strong--67","subsections":[{"section":"replace-status-70"},{"section":"read-status-69"},{"section":"patch-status-68"}]},{"section":"-strong-read-operations-strong--60","subsections":[{"section":"watch-list-all-namespaces-66"},{"section":"watch-list-65"},{"section":"watch-64"},{"section":"list-all-namespaces-63"},{"section":"list-62"},{"section":"read-61"}]},{"section":"-strong-write-operations-strong--54","subsections":[{"section":"delete-collection-59"},{"section":"delete-58"},{"section":"replace-57"},{"section":"patch-56"},{"section":"create-eviction"},{"section":"create-55"}]}]},{"section":"job-v1-batch","subsections":[{"section":"-strong-status-operations-strong--50","subsections":[{"section":"replace-status-53"},{"section":"read-status-52"},{"section":"patch-status-51"}]},{"section":"-strong-read-operations-strong--43","subsections":[{"section":"watch-list-all-namespaces-49"},{"section":"watch-list-48"},{"section":"watch-47"},{"section":"list-all-namespaces-46"},{"section":"list-45"},{"section":"read-44"}]},{"section":"-strong-write-operations-strong--37","subsections":[{"section":"delete-collection-42"},{"section":"delete-41"},{"section":"replace-40"},{"section":"patch-39"},{"section":"create-38"}]}]},{"section":"deployment-v1-apps","subsections":[{"section":"-strong-misc-operations-strong-","subsections":[{"section":"patch-scale"},{"section":"replace-scale"},{"section":"read-scale"}]},{"section":"-strong-status-operations-strong--33","subsections":[{"section":"replace-status-36"},{"section":"read-status-35"},{"section":"patch-status-34"}]},{"section":"-strong-read-operations-strong--26","subsections":[{"section":"watch-list-all-namespaces-32"},{"section":"watch-list-31"},{"section":"watch-30"},{"section":"list-all-namespaces-29"},{"section":"list-28"},{"section":"read-27"}]},{"section":"-strong-write-operations-strong--20","subsections":[{"section":"delete-collection-25"},{"section":"delete-24"},{"section":"replace-23"},{"section":"patch-22"},{"section":"create-21"}]}]},{"section":"daemonset-v1-apps","subsections":[{"section":"-strong-status-operations-strong--16","subsections":[{"section":"replace-status-19"},{"section":"read-status-18"},{"section":"patch-status-17"}]},{"section":"-strong-read-operations-strong--9","subsections":[{"section":"watch-list-all-namespaces-15"},{"section":"watch-list-14"},{"section":"watch-13"},{"section":"list-all-namespaces-12"},{"section":"list-11"},{"section":"read-10"}]},{"section":"-strong-write-operations-strong--3","subsections":[{"section":"delete-collection-8"},{"section":"delete-7"},{"section":"replace-6"},{"section":"patch-5"},{"section":"create-4"}]}]},{"section":"cronjob-v1beta1-batch","subsections":[{"section":"-strong-status-operations-strong-","subsections":[{"section":"replace-status"},{"section":"read-status"},{"section":"patch-status"}]},{"section":"-strong-read-operations-strong-","subsections":[{"section":"watch-list-all-namespaces"},{"section":"watch-list"},{"section":"watch"},{"section":"list-all-namespaces"},{"section":"list"},{"section":"read-2"}]},{"section":"-strong-write-operations-strong-","subsections":[{"section":"delete-collection"},{"section":"delete-1"},{"section":"replace"},{"section":"patch"},{"section":"create"}]}]},{"section":"container-v1-core","subsections":[]},{"section":"-strong-workloads-strong-","subsections":[]},{"section":"-strong-api-overview-strong-","subsections":[{"section":"resource-operations"},{"section":"resource-objects"},{"section":"resource-categories"}]}],"flatToc":["volumeerror-v1alpha1-storage-k8s-io","volumeattachmentsource-v1alpha1-storage-k8s-io","watch-list-1049","watch-1048","list-1047","read-1046","-strong-read-operations-strong--1045","delete-collection-1044","delete-1043","replace-1042","patch-1041","create-1040","-strong-write-operations-strong--1039","volumeattachment-v1alpha1-storage-k8s-io","userinfo-v1beta1-authentication-k8s-io","create-1038","-strong-write-operations-strong--1037","tokenreview-v1beta1-authentication-k8s-io","supplementalgroupsstrategyoptions-v1beta1-policy","subjectrulesreviewstatus-v1beta1-authorization-k8s-io","create-1036","-strong-write-operations-strong--1035","subjectaccessreview-v1beta1-authorization-k8s-io","subject-v1alpha1-rbac-authorization-k8s-io","subject-v1beta1-rbac-authorization-k8s-io","watch-list-1034","watch-1033","list-1032","read-1031","-strong-read-operations-strong--1030","delete-collection-1029","delete-1028","replace-1027","patch-1026","create-1025","-strong-write-operations-strong--1024","storageclass-v1beta1-storage-k8s-io","statefulsetupdatestrategy-v1beta1-apps","statefulsetupdatestrategy-v1beta2-apps","statefulsetcondition-v1beta1-apps","statefulsetcondition-v1beta2-apps","patch-scale-1023","replace-scale-1022","read-scale-1021","-strong-misc-operations-strong--1020","replace-status-1019","read-status-1018","patch-status-1017","-strong-status-operations-strong--1016","watch-list-all-namespaces-1015","watch-list-1014","watch-1013","list-all-namespaces-1012","list-1011","read-1010","-strong-read-operations-strong--1009","delete-collection-1008","delete-1007","replace-1006","patch-1005","create-1004","-strong-write-operations-strong--1003","statefulset-v1beta1-apps","patch-scale-1002","replace-scale-1001","read-scale-1000","-strong-misc-operations-strong--999","replace-status-998","read-status-997","patch-status-996","-strong-status-operations-strong--995","watch-list-all-namespaces-994","watch-list-993","watch-992","list-all-namespaces-991","list-990","read-989","-strong-read-operations-strong--988","delete-collection-987","delete-986","replace-985","patch-984","create-983","-strong-write-operations-strong--982","statefulset-v1beta2-apps","servicereference-v1beta1-apiregistration-k8s-io","servicereference-v1beta1-admissionregistration-k8s-io","create-981","-strong-write-operations-strong--980","selfsubjectrulesreview-v1beta1-authorization-k8s-io","create-979","-strong-write-operations-strong--978","selfsubjectaccessreview-v1beta1-authorization-k8s-io","scale-v1beta1-extensions","scale-v1beta1-apps","scale-v1beta2-apps","selinuxstrategyoptions-v1beta1-policy","runasuserstrategyoptions-v1beta1-policy","rollingupdatestatefulsetstrategy-v1beta1-apps","rollingupdatestatefulsetstrategy-v1beta2-apps","rollbackconfig-v1beta1-extensions","roleref-v1alpha1-rbac-authorization-k8s-io","roleref-v1beta1-rbac-authorization-k8s-io","watch-list-all-namespaces-977","watch-list-976","watch-975","list-all-namespaces-974","list-973","read-972","-strong-read-operations-strong--971","delete-collection-970","delete-969","replace-968","patch-967","create-966","-strong-write-operations-strong--965","rolebinding-v1alpha1-rbac-authorization-k8s-io","watch-list-all-namespaces-964","watch-list-963","watch-962","list-all-namespaces-961","list-960","read-959","-strong-read-operations-strong--958","delete-collection-957","delete-956","replace-955","patch-954","create-953","-strong-write-operations-strong--952","rolebinding-v1beta1-rbac-authorization-k8s-io","watch-list-all-namespaces-951","watch-list-950","watch-949","list-all-namespaces-948","list-947","read-946","-strong-read-operations-strong--945","delete-collection-944","delete-943","replace-942","patch-941","create-940","-strong-write-operations-strong--939","role-v1alpha1-rbac-authorization-k8s-io","watch-list-all-namespaces-938","watch-list-937","watch-936","list-all-namespaces-935","list-934","read-933","-strong-read-operations-strong--932","delete-collection-931","delete-930","replace-929","patch-928","create-927","-strong-write-operations-strong--926","role-v1beta1-rbac-authorization-k8s-io","resourcerule-v1beta1-authorization-k8s-io","resourceattributes-v1beta1-authorization-k8s-io","replicasetcondition-v1beta1-extensions","replicasetcondition-v1beta2-apps","patch-scale-925","replace-scale-924","read-scale-923","-strong-misc-operations-strong--922","replace-status-921","read-status-920","patch-status-919","-strong-status-operations-strong--918","watch-list-all-namespaces-917","watch-list-916","watch-915","list-all-namespaces-914","list-913","read-912","-strong-read-operations-strong--911","delete-collection-910","delete-909","replace-908","patch-907","create-906","-strong-write-operations-strong--905","replicaset-v1beta1-extensions","patch-scale-904","replace-scale-903","read-scale-902","-strong-misc-operations-strong--901","replace-status-900","read-status-899","patch-status-898","-strong-status-operations-strong--897","watch-list-all-namespaces-896","watch-list-895","watch-894","list-all-namespaces-893","list-892","read-891","-strong-read-operations-strong--890","delete-collection-889","delete-888","replace-887","patch-886","create-885","-strong-write-operations-strong--884","replicaset-v1beta2-apps","watch-list-883","watch-882","list-881","read-880","-strong-read-operations-strong--879","delete-collection-878","delete-877","replace-876","patch-875","create-874","-strong-write-operations-strong--873","priorityclass-v1alpha1-scheduling-k8s-io","policyrule-v1alpha1-rbac-authorization-k8s-io","policyrule-v1beta1-rbac-authorization-k8s-io","watch-list-872","watch-871","list-870","read-869","-strong-read-operations-strong--868","delete-collection-867","delete-866","replace-865","patch-864","create-863","-strong-write-operations-strong--862","podsecuritypolicy-v1beta1-policy","nonresourcerule-v1beta1-authorization-k8s-io","nonresourceattributes-v1beta1-authorization-k8s-io","networkpolicyport-v1beta1-extensions","networkpolicypeer-v1beta1-extensions","networkpolicyingressrule-v1beta1-extensions","networkpolicyegressrule-v1beta1-extensions","watch-list-all-namespaces-861","watch-list-860","watch-859","list-all-namespaces-858","list-857","read-856","-strong-read-operations-strong--855","delete-collection-854","delete-853","replace-852","patch-851","create-850","-strong-write-operations-strong--849","networkpolicy-v1beta1-extensions","create-848","-strong-write-operations-strong--847","localsubjectaccessreview-v1beta1-authorization-k8s-io","jobtemplatespec-v2alpha1-batch","initializer-v1alpha1-admissionregistration-k8s-io","ipblock-v1beta1-extensions","idrange-v1beta1-policy","hostportrange-v1beta1-policy","replace-status-846","read-status-845","patch-status-844","-strong-status-operations-strong--843","watch-list-all-namespaces-842","watch-list-841","watch-840","list-all-namespaces-839","list-838","read-837","-strong-read-operations-strong--836","delete-collection-835","delete-834","replace-833","patch-832","create-831","-strong-write-operations-strong--830","horizontalpodautoscaler-v2beta1-autoscaling","fsgroupstrategyoptions-v1beta1-policy","eventseries-v1beta1-events-k8s-io","watch-list-all-namespaces-829","watch-list-828","watch-827","list-all-namespaces-826","list-825","read-824","-strong-read-operations-strong--823","delete-collection-822","delete-821","replace-820","patch-819","create-818","-strong-write-operations-strong--817","event-v1beta1-events-k8s-io","deploymentcondition-v1beta1-extensions","deploymentcondition-v1beta1-apps","deploymentcondition-v1beta2-apps","rollback-816","patch-scale-815","replace-scale-814","read-scale-813","-strong-misc-operations-strong--812","replace-status-811","read-status-810","patch-status-809","-strong-status-operations-strong--808","watch-list-all-namespaces-807","watch-list-806","watch-805","list-all-namespaces-804","list-803","read-802","-strong-read-operations-strong--801","delete-collection-800","delete-799","replace-798","patch-797","create-796","-strong-write-operations-strong--795","deployment-v1beta1-extensions","rollback","patch-scale-794","replace-scale-793","read-scale-792","-strong-misc-operations-strong--791","replace-status-790","read-status-789","patch-status-788","-strong-status-operations-strong--787","watch-list-all-namespaces-786","watch-list-785","watch-784","list-all-namespaces-783","list-782","read-781","-strong-read-operations-strong--780","delete-collection-779","delete-778","replace-777","patch-776","create-775","-strong-write-operations-strong--774","deployment-v1beta1-apps","patch-scale-773","replace-scale-772","read-scale-771","-strong-misc-operations-strong--770","replace-status-769","read-status-768","patch-status-767","-strong-status-operations-strong--766","watch-list-all-namespaces-765","watch-list-764","watch-763","list-all-namespaces-762","list-761","read-760","-strong-read-operations-strong--759","delete-collection-758","delete-757","replace-756","patch-755","create-754","-strong-write-operations-strong--753","deployment-v1beta2-apps","daemonsetupdatestrategy-v1beta1-extensions","daemonsetupdatestrategy-v1beta2-apps","daemonsetcondition-v1beta1-extensions","daemonsetcondition-v1beta2-apps","replace-status-752","read-status-751","patch-status-750","-strong-status-operations-strong--749","watch-list-all-namespaces-748","watch-list-747","watch-746","list-all-namespaces-745","list-744","read-743","-strong-read-operations-strong--742","delete-collection-741","delete-740","replace-739","patch-738","create-737","-strong-write-operations-strong--736","daemonset-v1beta1-extensions","replace-status-735","read-status-734","patch-status-733","-strong-status-operations-strong--732","watch-list-all-namespaces-731","watch-list-730","watch-729","list-all-namespaces-728","list-727","read-726","-strong-read-operations-strong--725","delete-collection-724","delete-723","replace-722","patch-721","create-720","-strong-write-operations-strong--719","daemonset-v1beta2-apps","crossversionobjectreference-v2beta1-autoscaling","replace-status-718","read-status-717","patch-status-716","-strong-status-operations-strong--715","watch-list-all-namespaces-714","watch-list-713","watch-712","list-all-namespaces-711","list-710","read-709","-strong-read-operations-strong--708","delete-collection-707","delete-706","replace-705","patch-704","create-703","-strong-write-operations-strong--702","cronjob-v2alpha1-batch","watch-list-all-namespaces-701","watch-list-700","watch-699","list-all-namespaces-698","list-697","read-696","-strong-read-operations-strong--695","delete-collection-694","delete-693","replace-692","patch-691","create-690","-strong-write-operations-strong--689","controllerrevision-v1beta1-apps","watch-list-all-namespaces-688","watch-list-687","watch-686","list-all-namespaces-685","list-684","read-683","-strong-read-operations-strong--682","delete-collection-681","delete-680","replace-679","patch-678","create-677","-strong-write-operations-strong--676","controllerrevision-v1beta2-apps","watch-list-675","watch-674","list-673","read-672","-strong-read-operations-strong--671","delete-collection-670","delete-669","replace-668","patch-667","create-666","-strong-write-operations-strong--665","clusterrolebinding-v1alpha1-rbac-authorization-k8s-io","watch-list-664","watch-663","list-662","read-661","-strong-read-operations-strong--660","delete-collection-659","delete-658","replace-657","patch-656","create-655","-strong-write-operations-strong--654","clusterrolebinding-v1beta1-rbac-authorization-k8s-io","watch-list-653","watch-652","list-651","read-650","-strong-read-operations-strong--649","delete-collection-648","delete-647","replace-646","patch-645","create-644","-strong-write-operations-strong--643","clusterrole-v1alpha1-rbac-authorization-k8s-io","watch-list-642","watch-641","list-640","read-639","-strong-read-operations-strong--638","delete-collection-637","delete-636","replace-635","patch-634","create-633","-strong-write-operations-strong--632","clusterrole-v1beta1-rbac-authorization-k8s-io","allowedhostpath-v1beta1-policy","allowedflexvolume-v1beta1-policy","aggregationrule-v1alpha1-rbac-authorization-k8s-io","aggregationrule-v1beta1-rbac-authorization-k8s-io","apiservicecondition-v1beta1-apiregistration-k8s-io","replace-status-631","read-status-630","patch-status-629","-strong-status-operations-strong--628","watch-list-627","watch-626","list-625","read-624","-strong-read-operations-strong--623","delete-collection-622","delete-621","replace-620","patch-619","create-618","-strong-write-operations-strong--617","apiservice-v1beta1-apiregistration-k8s-io","-strong-old-api-versions-strong-","weightedpodaffinityterm-v1-core","webhookclientconfig-v1beta1-admissionregistration","webhook-v1beta1-admissionregistration","watchevent-v1-meta","vspherevirtualdiskvolumesource-v1-core","volumeprojection-v1-core","volumenodeaffinity-v1-core","volumemount-v1-core","volumeerror-v1beta1-storage","volumedevice-v1-core","volumeattachmentsource-v1beta1-storage","userinfo-v1-authentication","topologyselectorterm-v1-core","topologyselectorlabelrequirement-v1-core","toleration-v1-core","time-v1-meta","taint-v1-core","tcpsocketaction-v1-core","sysctl-v1-core","supplementalgroupsstrategyoptions-v1beta1-extensions","subjectrulesreviewstatus-v1-authorization","subject-v1-rbac","storageosvolumesource-v1-core","storageospersistentvolumesource-v1-core","statusdetails-v1-meta","statuscause-v1-meta","status-v1-meta","statefulsetupdatestrategy-v1-apps","statefulsetcondition-v1-apps","sessionaffinityconfig-v1-core","servicereference-v1-apiregistration","serviceport-v1-core","serviceaccounttokenprojection-v1-core","serveraddressbyclientcidr-v1-meta","securitycontext-v1-core","secretvolumesource-v1-core","secretreference-v1-core","secretprojection-v1-core","secretkeyselector-v1-core","secretenvsource-v1-core","scopedresourceselectorrequirement-v1-core","scopeselector-v1-core","scaleiovolumesource-v1-core","scaleiopersistentvolumesource-v1-core","scale-v1-autoscaling","selinuxstrategyoptions-v1beta1-extensions","selinuxoptions-v1-core","runasuserstrategyoptions-v1beta1-extensions","rulewithoperations-v1beta1-admissionregistration","rule-v1alpha1-admissionregistration","rollingupdatestatefulsetstrategy-v1-apps","rollbackconfig-v1beta1-apps","roleref-v1-rbac","resourcerule-v1-authorization","resourcerequirements-v1-core","resourcemetricstatus-v2beta1-autoscaling","resourcemetricsource-v2beta1-autoscaling","resourcefieldselector-v1-core","resourceattributes-v1-authorization","replicationcontrollercondition-v1-core","replicasetcondition-v1-apps","rbdvolumesource-v1-core","rbdpersistentvolumesource-v1-core","quobytevolumesource-v1-core","quantity-resource-core","projectedvolumesource-v1-core","probe-v1-core","preferredschedulingterm-v1-core","preconditions-v1-meta","portworxvolumesource-v1-core","policyrule-v1-rbac","podsmetricstatus-v2beta1-autoscaling","podsmetricsource-v2beta1-autoscaling","podsecuritycontext-v1-core","podreadinessgate-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","persistentvolumeclaimcondition-v1-core","patch-v1-meta","ownerreference-v1-meta","objectreference-v1-core","objectmetricstatus-v2beta1-autoscaling","objectmetricsource-v2beta1-autoscaling","objectmeta-v1-meta","objectfieldselector-v1-core","nonresourcerule-v1-authorization","nonresourceattributes-v1-authorization","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","networkpolicypeer-v1-networking","networkpolicyingressrule-v1-networking","networkpolicyegressrule-v1-networking","nfsvolumesource-v1-core","microtime-v1-meta","metricstatus-v2beta1-autoscaling","metricspec-v2beta1-autoscaling","localvolumesource-v1-core","localobjectreference-v1-core","loadbalancerstatus-v1-core","loadbalanceringress-v1-core","listmeta-v1-meta","limitrangeitem-v1-core","lifecycle-v1-core","labelselectorrequirement-v1-meta","labelselector-v1-meta","keytopath-v1-core","jobtemplatespec-v1beta1-batch","jobcondition-v1-batch","jsonschemapropsorbool-v1beta1-apiextensions","jsonschemapropsorarray-v1beta1-apiextensions","jsonschemaprops-v1beta1-apiextensions","json-v1beta1-apiextensions","initializers-v1-meta","initializer-v1-meta","ingresstls-v1beta1-extensions","ingressrule-v1beta1-extensions","ingressbackend-v1beta1-extensions","iscsivolumesource-v1-core","iscsipersistentvolumesource-v1-core","ipblock-v1-networking","idrange-v1beta1-extensions","hostportrange-v1beta1-extensions","hostpathvolumesource-v1-core","hostalias-v1-core","horizontalpodautoscalercondition-v2beta1-autoscaling","handler-v1-core","httpingressrulevalue-v1beta1-extensions","httpingresspath-v1beta1-extensions","httpheader-v1-core","httpgetaction-v1-core","groupversionfordiscovery-v1-meta","glusterfsvolumesource-v1-core","gitrepovolumesource-v1-core","gcepersistentdiskvolumesource-v1-core","flockervolumesource-v1-core","flexvolumesource-v1-core","flexpersistentvolumesource-v1-core","fsgroupstrategyoptions-v1beta1-extensions","fcvolumesource-v1-core","externalmetricstatus-v2beta1-autoscaling","externalmetricsource-v2beta1-autoscaling","externaldocumentation-v1beta1-apiextensions","execaction-v1-core","eviction-v1beta1-policy","eventsource-v1-core","eventseries-v1-core","envvarsource-v1-core","envvar-v1-core","envfromsource-v1-core","endpointsubset-v1-core","endpointport-v1-core","endpointaddress-v1-core","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-v1beta1-apiextensions","customresourcesubresources-v1beta1-apiextensions","customresourcesubresourcestatus-v1beta1-apiextensions","customresourcesubresourcescale-v1beta1-apiextensions","customresourcedefinitionversion-v1beta1-apiextensions","customresourcedefinitionnames-v1beta1-apiextensions","customresourcedefinitioncondition-v1beta1-apiextensions","customresourcecolumndefinition-v1beta1-apiextensions","crossversionobjectreference-v1-autoscaling","containerstatewaiting-v1-core","containerstateterminated-v1-core","containerstaterunning-v1-core","containerstate-v1-core","containerport-v1-core","containerimage-v1-core","configmapvolumesource-v1-core","configmapprojection-v1-core","configmapnodeconfigsource-v1-core","configmapkeyselector-v1-core","configmapenvsource-v1-core","componentcondition-v1-core","clientipconfig-v1-core","cindervolumesource-v1-core","cinderpersistentvolumesource-v1-core","certificatesigningrequestcondition-v1beta1-certificates","cephfsvolumesource-v1-core","cephfspersistentvolumesource-v1-core","capabilities-v1-core","csipersistentvolumesource-v1-core","azurefilevolumesource-v1-core","azurefilepersistentvolumesource-v1-core","azurediskvolumesource-v1-core","attachedvolume-v1-core","allowedhostpath-v1beta1-extensions","allowedflexvolume-v1beta1-extensions","aggregationrule-v1-rbac","affinity-v1-core","awselasticblockstorevolumesource-v1-core","apiversions-v1-meta","apiservicecondition-v1-apiregistration","apiresource-v1-meta","apigroup-v1-meta","-strong-definitions-strong-","watch-list-all-namespaces-616","watch-list-615","watch-614","list-all-namespaces-613","list-612","read-611","-strong-read-operations-strong--610","delete-collection-609","delete-608","replace-607","patch-606","create-605","-strong-write-operations-strong--604","networkpolicy-v1-networking-k8s-io","create-603","-strong-write-operations-strong--602","tokenreview-v1-authentication-k8s-io","create-601","-strong-write-operations-strong--600","subjectaccessreview-v1-authorization-k8s-io","watch-list-all-namespaces-599","watch-list-598","watch-597","list-all-namespaces-596","list-595","read-594","-strong-read-operations-strong--593","delete-collection-592","delete-591","replace-590","patch-589","create-588","-strong-write-operations-strong--587","serviceaccount-v1-core","create-586","-strong-write-operations-strong--585","selfsubjectrulesreview-v1-authorization-k8s-io","create-584","-strong-write-operations-strong--583","selfsubjectaccessreview-v1-authorization-k8s-io","watch-list-all-namespaces-582","watch-list-581","watch-580","list-all-namespaces-579","list-578","read-577","-strong-read-operations-strong--576","delete-collection-575","delete-574","replace-573","patch-572","create-571","-strong-write-operations-strong--570","rolebinding-v1-rbac-authorization-k8s-io","watch-list-all-namespaces-569","watch-list-568","watch-567","list-all-namespaces-566","list-565","read-564","-strong-read-operations-strong--563","delete-collection-562","delete-561","replace-560","patch-559","create-558","-strong-write-operations-strong--557","role-v1-rbac-authorization-k8s-io","replace-status-556","read-status-555","patch-status-554","-strong-status-operations-strong--553","watch-list-all-namespaces-552","watch-list-551","watch-550","list-all-namespaces-549","list-548","read-547","-strong-read-operations-strong--546","delete-collection-545","delete-544","replace-543","patch-542","create-541","-strong-write-operations-strong--540","resourcequota-v1-core","replace-status-539","read-status-538","patch-status-537","-strong-status-operations-strong--536","watch-list-535","watch-534","list-533","read-532","-strong-read-operations-strong--531","delete-collection-530","delete-529","replace-528","patch-527","create-526","-strong-write-operations-strong--525","persistentvolume-v1-core","replace-connect-proxy-path-524","replace-connect-proxy-523","head-connect-proxy-path-522","head-connect-proxy-521","get-connect-proxy-path-520","get-connect-proxy-519","delete-connect-proxy-path-518","delete-connect-proxy-517","create-connect-proxy-path-516","create-connect-proxy-515","-strong-proxy-operations-strong--514","replace-status-513","read-status-512","patch-status-511","-strong-status-operations-strong--510","watch-list-509","watch-508","list-507","read-506","-strong-read-operations-strong--505","delete-collection-504","delete-503","replace-502","patch-501","create-500","-strong-write-operations-strong--499","node-v1-core","replace-status-498","read-status-497","patch-status-496","-strong-status-operations-strong--495","watch-list-494","watch-493","list-492","read-491","-strong-read-operations-strong--490","delete-489","replace-488","patch-487","create-486","-strong-write-operations-strong--485","namespace-v1-core","create-484","-strong-write-operations-strong--483","localsubjectaccessreview-v1-authorization-k8s-io","list-482","read-481","-strong-read-operations-strong--480","componentstatus-v1-core","watch-list-479","watch-478","list-477","read-476","-strong-read-operations-strong--475","delete-collection-474","delete-473","replace-472","patch-471","create-470","-strong-write-operations-strong--469","clusterrolebinding-v1-rbac-authorization-k8s-io","watch-list-468","watch-467","list-466","read-465","-strong-read-operations-strong--464","delete-collection-463","delete-462","replace-461","patch-460","create-459","-strong-write-operations-strong--458","clusterrole-v1-rbac-authorization-k8s-io","replace-status-457","read-status-456","patch-status-455","-strong-status-operations-strong--454","watch-list-453","watch-452","list-451","read-450","-strong-read-operations-strong--449","delete-collection-448","delete-447","replace-446","patch-445","create-444","-strong-write-operations-strong--443","certificatesigningrequest-v1beta1-certificates-k8s-io","create-442","-strong-write-operations-strong--441","binding-v1-core","replace-status-440","read-status-439","patch-status-438","-strong-status-operations-strong--437","watch-list-436","watch-435","list-434","read-433","-strong-read-operations-strong--432","delete-collection-431","delete-430","replace-429","patch-428","create-427","-strong-write-operations-strong--426","apiservice-v1-apiregistration-k8s-io","-strong-cluster-strong-","watch-list-425","watch-424","list-423","read-422","-strong-read-operations-strong--421","delete-collection-420","delete-419","replace-418","patch-417","create-416","-strong-write-operations-strong--415","podsecuritypolicy-v1beta1-extensions","watch-list-all-namespaces-414","watch-list-413","watch-412","list-all-namespaces-411","list-410","read-409","-strong-read-operations-strong--408","delete-collection-407","delete-406","replace-405","patch-404","create-403","-strong-write-operations-strong--402","podpreset-v1alpha1-settings-k8s-io","watch-list-401","watch-400","list-399","read-398","-strong-read-operations-strong--397","delete-collection-396","delete-395","replace-394","patch-393","create-392","-strong-write-operations-strong--391","priorityclass-v1beta1-scheduling-k8s-io","replace-status-390","read-status-389","patch-status-388","-strong-status-operations-strong--387","watch-list-all-namespaces-386","watch-list-385","watch-384","list-all-namespaces-383","list-382","read-381","-strong-read-operations-strong--380","delete-collection-379","delete-378","replace-377","patch-376","create-375","-strong-write-operations-strong--374","poddisruptionbudget-v1beta1-policy","watch-list-all-namespaces-373","watch-list-372","watch-371","list-all-namespaces-370","list-369","read-368","-strong-read-operations-strong--367","delete-collection-366","delete-365","replace-364","patch-363","create-362","-strong-write-operations-strong--361","podtemplate-v1-core","watch-list-360","watch-359","list-358","read-357","-strong-read-operations-strong--356","delete-collection-355","delete-354","replace-353","patch-352","create-351","-strong-write-operations-strong--350","validatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","watch-list-349","watch-348","list-347","read-346","-strong-read-operations-strong--345","delete-collection-344","delete-343","replace-342","patch-341","create-340","-strong-write-operations-strong--339","mutatingwebhookconfiguration-v1beta1-admissionregistration-k8s-io","watch-list-338","watch-337","list-336","read-335","-strong-read-operations-strong--334","delete-collection-333","delete-332","replace-331","patch-330","create-329","-strong-write-operations-strong--328","initializerconfiguration-v1alpha1-admissionregistration-k8s-io","replace-status-327","read-status-326","patch-status-325","-strong-status-operations-strong--324","watch-list-all-namespaces-323","watch-list-322","watch-321","list-all-namespaces-320","list-319","read-318","-strong-read-operations-strong--317","delete-collection-316","delete-315","replace-314","patch-313","create-312","-strong-write-operations-strong--311","horizontalpodautoscaler-v1-autoscaling","watch-list-all-namespaces-310","watch-list-309","watch-308","list-all-namespaces-307","list-306","read-305","-strong-read-operations-strong--304","delete-collection-303","delete-302","replace-301","patch-300","create-299","-strong-write-operations-strong--298","limitrange-v1-core","watch-list-all-namespaces-297","watch-list-296","watch-295","list-all-namespaces-294","list-293","read-292","-strong-read-operations-strong--291","delete-collection-290","delete-289","replace-288","patch-287","create-286","-strong-write-operations-strong--285","event-v1-core","replace-status-284","read-status-283","patch-status-282","-strong-status-operations-strong--281","watch-list-280","watch-279","list-278","read-277","-strong-read-operations-strong--276","delete-collection-275","delete-274","replace-273","patch-272","create-271","-strong-write-operations-strong--270","customresourcedefinition-v1beta1-apiextensions-k8s-io","watch-list-all-namespaces-269","watch-list-268","watch-267","list-all-namespaces-266","list-265","read-264","-strong-read-operations-strong--263","delete-collection-262","delete-261","replace-260","patch-259","create-258","-strong-write-operations-strong--257","controllerrevision-v1-apps","-strong-metadata-strong-","watch-list-256","watch-255","list-254","read-253","-strong-read-operations-strong--252","delete-collection-251","delete-250","replace-249","patch-248","create-247","-strong-write-operations-strong--246","volumeattachment-v1beta1-storage-k8s-io","volume-v1-core","watch-list-245","watch-244","list-243","read-242","-strong-read-operations-strong--241","delete-collection-240","delete-239","replace-238","patch-237","create-236","-strong-write-operations-strong--235","storageclass-v1-storage-k8s-io","replace-status-234","read-status-233","patch-status-232","-strong-status-operations-strong--231","watch-list-all-namespaces-230","watch-list-229","watch-228","list-all-namespaces-227","list-226","read-225","-strong-read-operations-strong--224","delete-collection-223","delete-222","replace-221","patch-220","create-219","-strong-write-operations-strong--218","persistentvolumeclaim-v1-core","watch-list-all-namespaces-217","watch-list-216","watch-215","list-all-namespaces-214","list-213","read-212","-strong-read-operations-strong--211","delete-collection-210","delete-209","replace-208","patch-207","create-206","-strong-write-operations-strong--205","secret-v1-core","watch-list-all-namespaces-204","watch-list-203","watch-202","list-all-namespaces-201","list-200","read-199","-strong-read-operations-strong--198","delete-collection-197","delete-196","replace-195","patch-194","create-193","-strong-write-operations-strong--192","configmap-v1-core","-strong-config-storage-strong-","replace-connect-proxy-path-191","replace-connect-proxy-190","head-connect-proxy-path-189","head-connect-proxy-188","get-connect-proxy-path-187","get-connect-proxy-186","delete-connect-proxy-path-185","delete-connect-proxy-184","create-connect-proxy-path-183","create-connect-proxy-182","-strong-proxy-operations-strong--181","replace-status-180","read-status-179","patch-status-178","-strong-status-operations-strong--177","watch-list-all-namespaces-176","watch-list-175","watch-174","list-all-namespaces-173","list-172","read-171","-strong-read-operations-strong--170","delete-169","replace-168","patch-167","create-166","-strong-write-operations-strong--165","service-v1-core","replace-status-164","read-status-163","patch-status-162","-strong-status-operations-strong--161","watch-list-all-namespaces-160","watch-list-159","watch-158","list-all-namespaces-157","list-156","read-155","-strong-read-operations-strong--154","delete-collection-153","delete-152","replace-151","patch-150","create-149","-strong-write-operations-strong--148","ingress-v1beta1-extensions","watch-list-all-namespaces-147","watch-list-146","watch-145","list-all-namespaces-144","list-143","read-142","-strong-read-operations-strong--141","delete-collection-140","delete-139","replace-138","patch-137","create-136","-strong-write-operations-strong--135","endpoints-v1-core","-strong-discovery-load-balancing-strong-","patch-scale-134","replace-scale-133","read-scale-132","-strong-misc-operations-strong--131","replace-status-130","read-status-129","patch-status-128","-strong-status-operations-strong--127","watch-list-all-namespaces-126","watch-list-125","watch-124","list-all-namespaces-123","list-122","read-121","-strong-read-operations-strong--120","delete-collection-119","delete-118","replace-117","patch-116","create-115","-strong-write-operations-strong--114","statefulset-v1-apps","patch-scale-113","replace-scale-112","read-scale-111","-strong-misc-operations-strong--110","replace-status-109","read-status-108","patch-status-107","-strong-status-operations-strong--106","watch-list-all-namespaces-105","watch-list-104","watch-103","list-all-namespaces-102","list-101","read-100","-strong-read-operations-strong--99","delete-collection-98","delete-97","replace-96","patch-95","create-94","-strong-write-operations-strong--93","replicationcontroller-v1-core","patch-scale-92","replace-scale-91","read-scale-90","-strong-misc-operations-strong--89","replace-status-88","read-status-87","patch-status-86","-strong-status-operations-strong--85","watch-list-all-namespaces-84","watch-list-83","watch-82","list-all-namespaces-81","list-80","read-79","-strong-read-operations-strong--78","delete-collection-77","delete-76","replace-75","patch-74","create-73","-strong-write-operations-strong--72","replicaset-v1-apps","read-log","-strong-misc-operations-strong--71","replace-connect-proxy-path","replace-connect-proxy","head-connect-proxy-path","head-connect-proxy","get-connect-proxy-path","get-connect-proxy","get-connect-portforward","delete-connect-proxy-path","delete-connect-proxy","create-connect-proxy-path","create-connect-proxy","create-connect-portforward","-strong-proxy-operations-strong-","replace-status-70","read-status-69","patch-status-68","-strong-status-operations-strong--67","watch-list-all-namespaces-66","watch-list-65","watch-64","list-all-namespaces-63","list-62","read-61","-strong-read-operations-strong--60","delete-collection-59","delete-58","replace-57","patch-56","create-eviction","create-55","-strong-write-operations-strong--54","pod-v1-core","replace-status-53","read-status-52","patch-status-51","-strong-status-operations-strong--50","watch-list-all-namespaces-49","watch-list-48","watch-47","list-all-namespaces-46","list-45","read-44","-strong-read-operations-strong--43","delete-collection-42","delete-41","replace-40","patch-39","create-38","-strong-write-operations-strong--37","job-v1-batch","patch-scale","replace-scale","read-scale","-strong-misc-operations-strong-","replace-status-36","read-status-35","patch-status-34","-strong-status-operations-strong--33","watch-list-all-namespaces-32","watch-list-31","watch-30","list-all-namespaces-29","list-28","read-27","-strong-read-operations-strong--26","delete-collection-25","delete-24","replace-23","patch-22","create-21","-strong-write-operations-strong--20","deployment-v1-apps","replace-status-19","read-status-18","patch-status-17","-strong-status-operations-strong--16","watch-list-all-namespaces-15","watch-list-14","watch-13","list-all-namespaces-12","list-11","read-10","-strong-read-operations-strong--9","delete-collection-8","delete-7","replace-6","patch-5","create-4","-strong-write-operations-strong--3","daemonset-v1-apps","replace-status","read-status","patch-status","-strong-status-operations-strong-","watch-list-all-namespaces","watch-list","watch","list-all-namespaces","list","read-2","-strong-read-operations-strong-","delete-collection","delete-1","replace","patch","create","-strong-write-operations-strong-","cronjob-v1beta1-batch","container-v1-core","-strong-workloads-strong-","resource-operations","resource-objects","resource-categories","-strong-api-overview-strong-"]};})(); \ No newline at end of file diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/bootstrap/dist/css/bootstrap.min.css b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/bootstrap/dist/css/bootstrap.min.css new file mode 100755 index 0000000000000..ed3905e0e0c91 --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/bootstrap/dist/css/bootstrap.min.css @@ -0,0 +1,6 @@ +/*! + * Bootstrap v3.3.7 (http://getbootstrap.com) + * Copyright 2011-2016 Twitter, Inc. + * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE) + *//*! normalize.css v3.0.3 | MIT License | github.com/necolas/normalize.css */html{font-family:sans-serif;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}article,aside,details,figcaption,figure,footer,header,hgroup,main,menu,nav,section,summary{display:block}audio,canvas,progress,video{display:inline-block;vertical-align:baseline}audio:not([controls]){display:none;height:0}[hidden],template{display:none}a{background-color:transparent}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}dfn{font-style:italic}h1{margin:.67em 0;font-size:2em}mark{color:#000;background:#ff0}small{font-size:80%}sub,sup{position:relative;font-size:75%;line-height:0;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:1em 40px}hr{height:0;-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box}pre{overflow:auto}code,kbd,pre,samp{font-family:monospace,monospace;font-size:1em}button,input,optgroup,select,textarea{margin:0;font:inherit;color:inherit}button{overflow:visible}button,select{text-transform:none}button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}button::-moz-focus-inner,input::-moz-focus-inner{padding:0;border:0}input{line-height:normal}input[type=checkbox],input[type=radio]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;padding:0}input[type=number]::-webkit-inner-spin-button,input[type=number]::-webkit-outer-spin-button{height:auto}input[type=search]{-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box;-webkit-appearance:textfield}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}fieldset{padding:.35em .625em .75em;margin:0 2px;border:1px solid silver}legend{padding:0;border:0}textarea{overflow:auto}optgroup{font-weight:700}table{border-spacing:0;border-collapse:collapse}td,th{padding:0}/*! Source: https://github.com/h5bp/html5-boilerplate/blob/master/src/css/main.css */@media print{*,:after,:before{color:#000!important;text-shadow:none!important;background:0 0!important;-webkit-box-shadow:none!important;box-shadow:none!important}a,a:visited{text-decoration:underline}a[href]:after{content:" (" attr(href) ")"}abbr[title]:after{content:" (" attr(title) ")"}a[href^="javascript:"]:after,a[href^="#"]:after{content:""}blockquote,pre{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}h2,h3,p{orphans:3;widows:3}h2,h3{page-break-after:avoid}.navbar{display:none}.btn>.caret,.dropup>.btn>.caret{border-top-color:#000!important}.label{border:1px solid #000}.table{border-collapse:collapse!important}.table td,.table th{background-color:#fff!important}.table-bordered td,.table-bordered th{border:1px solid #ddd!important}}@font-face{font-family:'Glyphicons Halflings';src:url(../fonts/glyphicons-halflings-regular.eot);src:url(../fonts/glyphicons-halflings-regular.eot?#iefix) format('embedded-opentype'),url(../fonts/glyphicons-halflings-regular.woff2) format('woff2'),url(../fonts/glyphicons-halflings-regular.woff) format('woff'),url(../fonts/glyphicons-halflings-regular.ttf) format('truetype'),url(../fonts/glyphicons-halflings-regular.svg#glyphicons_halflingsregular) format('svg')}.glyphicon{position:relative;top:1px;display:inline-block;font-family:'Glyphicons Halflings';font-style:normal;font-weight:400;line-height:1;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.glyphicon-asterisk:before{content:"\002a"}.glyphicon-plus:before{content:"\002b"}.glyphicon-eur:before,.glyphicon-euro:before{content:"\20ac"}.glyphicon-minus:before{content:"\2212"}.glyphicon-cloud:before{content:"\2601"}.glyphicon-envelope:before{content:"\2709"}.glyphicon-pencil:before{content:"\270f"}.glyphicon-glass:before{content:"\e001"}.glyphicon-music:before{content:"\e002"}.glyphicon-search:before{content:"\e003"}.glyphicon-heart:before{content:"\e005"}.glyphicon-star:before{content:"\e006"}.glyphicon-star-empty:before{content:"\e007"}.glyphicon-user:before{content:"\e008"}.glyphicon-film:before{content:"\e009"}.glyphicon-th-large:before{content:"\e010"}.glyphicon-th:before{content:"\e011"}.glyphicon-th-list:before{content:"\e012"}.glyphicon-ok:before{content:"\e013"}.glyphicon-remove:before{content:"\e014"}.glyphicon-zoom-in:before{content:"\e015"}.glyphicon-zoom-out:before{content:"\e016"}.glyphicon-off:before{content:"\e017"}.glyphicon-signal:before{content:"\e018"}.glyphicon-cog:before{content:"\e019"}.glyphicon-trash:before{content:"\e020"}.glyphicon-home:before{content:"\e021"}.glyphicon-file:before{content:"\e022"}.glyphicon-time:before{content:"\e023"}.glyphicon-road:before{content:"\e024"}.glyphicon-download-alt:before{content:"\e025"}.glyphicon-download:before{content:"\e026"}.glyphicon-upload:before{content:"\e027"}.glyphicon-inbox:before{content:"\e028"}.glyphicon-play-circle:before{content:"\e029"}.glyphicon-repeat:before{content:"\e030"}.glyphicon-refresh:before{content:"\e031"}.glyphicon-list-alt:before{content:"\e032"}.glyphicon-lock:before{content:"\e033"}.glyphicon-flag:before{content:"\e034"}.glyphicon-headphones:before{content:"\e035"}.glyphicon-volume-off:before{content:"\e036"}.glyphicon-volume-down:before{content:"\e037"}.glyphicon-volume-up:before{content:"\e038"}.glyphicon-qrcode:before{content:"\e039"}.glyphicon-barcode:before{content:"\e040"}.glyphicon-tag:before{content:"\e041"}.glyphicon-tags:before{content:"\e042"}.glyphicon-book:before{content:"\e043"}.glyphicon-bookmark:before{content:"\e044"}.glyphicon-print:before{content:"\e045"}.glyphicon-camera:before{content:"\e046"}.glyphicon-font:before{content:"\e047"}.glyphicon-bold:before{content:"\e048"}.glyphicon-italic:before{content:"\e049"}.glyphicon-text-height:before{content:"\e050"}.glyphicon-text-width:before{content:"\e051"}.glyphicon-align-left:before{content:"\e052"}.glyphicon-align-center:before{content:"\e053"}.glyphicon-align-right:before{content:"\e054"}.glyphicon-align-justify:before{content:"\e055"}.glyphicon-list:before{content:"\e056"}.glyphicon-indent-left:before{content:"\e057"}.glyphicon-indent-right:before{content:"\e058"}.glyphicon-facetime-video:before{content:"\e059"}.glyphicon-picture:before{content:"\e060"}.glyphicon-map-marker:before{content:"\e062"}.glyphicon-adjust:before{content:"\e063"}.glyphicon-tint:before{content:"\e064"}.glyphicon-edit:before{content:"\e065"}.glyphicon-share:before{content:"\e066"}.glyphicon-check:before{content:"\e067"}.glyphicon-move:before{content:"\e068"}.glyphicon-step-backward:before{content:"\e069"}.glyphicon-fast-backward:before{content:"\e070"}.glyphicon-backward:before{content:"\e071"}.glyphicon-play:before{content:"\e072"}.glyphicon-pause:before{content:"\e073"}.glyphicon-stop:before{content:"\e074"}.glyphicon-forward:before{content:"\e075"}.glyphicon-fast-forward:before{content:"\e076"}.glyphicon-step-forward:before{content:"\e077"}.glyphicon-eject:before{content:"\e078"}.glyphicon-chevron-left:before{content:"\e079"}.glyphicon-chevron-right:before{content:"\e080"}.glyphicon-plus-sign:before{content:"\e081"}.glyphicon-minus-sign:before{content:"\e082"}.glyphicon-remove-sign:before{content:"\e083"}.glyphicon-ok-sign:before{content:"\e084"}.glyphicon-question-sign:before{content:"\e085"}.glyphicon-info-sign:before{content:"\e086"}.glyphicon-screenshot:before{content:"\e087"}.glyphicon-remove-circle:before{content:"\e088"}.glyphicon-ok-circle:before{content:"\e089"}.glyphicon-ban-circle:before{content:"\e090"}.glyphicon-arrow-left:before{content:"\e091"}.glyphicon-arrow-right:before{content:"\e092"}.glyphicon-arrow-up:before{content:"\e093"}.glyphicon-arrow-down:before{content:"\e094"}.glyphicon-share-alt:before{content:"\e095"}.glyphicon-resize-full:before{content:"\e096"}.glyphicon-resize-small:before{content:"\e097"}.glyphicon-exclamation-sign:before{content:"\e101"}.glyphicon-gift:before{content:"\e102"}.glyphicon-leaf:before{content:"\e103"}.glyphicon-fire:before{content:"\e104"}.glyphicon-eye-open:before{content:"\e105"}.glyphicon-eye-close:before{content:"\e106"}.glyphicon-warning-sign:before{content:"\e107"}.glyphicon-plane:before{content:"\e108"}.glyphicon-calendar:before{content:"\e109"}.glyphicon-random:before{content:"\e110"}.glyphicon-comment:before{content:"\e111"}.glyphicon-magnet:before{content:"\e112"}.glyphicon-chevron-up:before{content:"\e113"}.glyphicon-chevron-down:before{content:"\e114"}.glyphicon-retweet:before{content:"\e115"}.glyphicon-shopping-cart:before{content:"\e116"}.glyphicon-folder-close:before{content:"\e117"}.glyphicon-folder-open:before{content:"\e118"}.glyphicon-resize-vertical:before{content:"\e119"}.glyphicon-resize-horizontal:before{content:"\e120"}.glyphicon-hdd:before{content:"\e121"}.glyphicon-bullhorn:before{content:"\e122"}.glyphicon-bell:before{content:"\e123"}.glyphicon-certificate:before{content:"\e124"}.glyphicon-thumbs-up:before{content:"\e125"}.glyphicon-thumbs-down:before{content:"\e126"}.glyphicon-hand-right:before{content:"\e127"}.glyphicon-hand-left:before{content:"\e128"}.glyphicon-hand-up:before{content:"\e129"}.glyphicon-hand-down:before{content:"\e130"}.glyphicon-circle-arrow-right:before{content:"\e131"}.glyphicon-circle-arrow-left:before{content:"\e132"}.glyphicon-circle-arrow-up:before{content:"\e133"}.glyphicon-circle-arrow-down:before{content:"\e134"}.glyphicon-globe:before{content:"\e135"}.glyphicon-wrench:before{content:"\e136"}.glyphicon-tasks:before{content:"\e137"}.glyphicon-filter:before{content:"\e138"}.glyphicon-briefcase:before{content:"\e139"}.glyphicon-fullscreen:before{content:"\e140"}.glyphicon-dashboard:before{content:"\e141"}.glyphicon-paperclip:before{content:"\e142"}.glyphicon-heart-empty:before{content:"\e143"}.glyphicon-link:before{content:"\e144"}.glyphicon-phone:before{content:"\e145"}.glyphicon-pushpin:before{content:"\e146"}.glyphicon-usd:before{content:"\e148"}.glyphicon-gbp:before{content:"\e149"}.glyphicon-sort:before{content:"\e150"}.glyphicon-sort-by-alphabet:before{content:"\e151"}.glyphicon-sort-by-alphabet-alt:before{content:"\e152"}.glyphicon-sort-by-order:before{content:"\e153"}.glyphicon-sort-by-order-alt:before{content:"\e154"}.glyphicon-sort-by-attributes:before{content:"\e155"}.glyphicon-sort-by-attributes-alt:before{content:"\e156"}.glyphicon-unchecked:before{content:"\e157"}.glyphicon-expand:before{content:"\e158"}.glyphicon-collapse-down:before{content:"\e159"}.glyphicon-collapse-up:before{content:"\e160"}.glyphicon-log-in:before{content:"\e161"}.glyphicon-flash:before{content:"\e162"}.glyphicon-log-out:before{content:"\e163"}.glyphicon-new-window:before{content:"\e164"}.glyphicon-record:before{content:"\e165"}.glyphicon-save:before{content:"\e166"}.glyphicon-open:before{content:"\e167"}.glyphicon-saved:before{content:"\e168"}.glyphicon-import:before{content:"\e169"}.glyphicon-export:before{content:"\e170"}.glyphicon-send:before{content:"\e171"}.glyphicon-floppy-disk:before{content:"\e172"}.glyphicon-floppy-saved:before{content:"\e173"}.glyphicon-floppy-remove:before{content:"\e174"}.glyphicon-floppy-save:before{content:"\e175"}.glyphicon-floppy-open:before{content:"\e176"}.glyphicon-credit-card:before{content:"\e177"}.glyphicon-transfer:before{content:"\e178"}.glyphicon-cutlery:before{content:"\e179"}.glyphicon-header:before{content:"\e180"}.glyphicon-compressed:before{content:"\e181"}.glyphicon-earphone:before{content:"\e182"}.glyphicon-phone-alt:before{content:"\e183"}.glyphicon-tower:before{content:"\e184"}.glyphicon-stats:before{content:"\e185"}.glyphicon-sd-video:before{content:"\e186"}.glyphicon-hd-video:before{content:"\e187"}.glyphicon-subtitles:before{content:"\e188"}.glyphicon-sound-stereo:before{content:"\e189"}.glyphicon-sound-dolby:before{content:"\e190"}.glyphicon-sound-5-1:before{content:"\e191"}.glyphicon-sound-6-1:before{content:"\e192"}.glyphicon-sound-7-1:before{content:"\e193"}.glyphicon-copyright-mark:before{content:"\e194"}.glyphicon-registration-mark:before{content:"\e195"}.glyphicon-cloud-download:before{content:"\e197"}.glyphicon-cloud-upload:before{content:"\e198"}.glyphicon-tree-conifer:before{content:"\e199"}.glyphicon-tree-deciduous:before{content:"\e200"}.glyphicon-cd:before{content:"\e201"}.glyphicon-save-file:before{content:"\e202"}.glyphicon-open-file:before{content:"\e203"}.glyphicon-level-up:before{content:"\e204"}.glyphicon-copy:before{content:"\e205"}.glyphicon-paste:before{content:"\e206"}.glyphicon-alert:before{content:"\e209"}.glyphicon-equalizer:before{content:"\e210"}.glyphicon-king:before{content:"\e211"}.glyphicon-queen:before{content:"\e212"}.glyphicon-pawn:before{content:"\e213"}.glyphicon-bishop:before{content:"\e214"}.glyphicon-knight:before{content:"\e215"}.glyphicon-baby-formula:before{content:"\e216"}.glyphicon-tent:before{content:"\26fa"}.glyphicon-blackboard:before{content:"\e218"}.glyphicon-bed:before{content:"\e219"}.glyphicon-apple:before{content:"\f8ff"}.glyphicon-erase:before{content:"\e221"}.glyphicon-hourglass:before{content:"\231b"}.glyphicon-lamp:before{content:"\e223"}.glyphicon-duplicate:before{content:"\e224"}.glyphicon-piggy-bank:before{content:"\e225"}.glyphicon-scissors:before{content:"\e226"}.glyphicon-bitcoin:before{content:"\e227"}.glyphicon-btc:before{content:"\e227"}.glyphicon-xbt:before{content:"\e227"}.glyphicon-yen:before{content:"\00a5"}.glyphicon-jpy:before{content:"\00a5"}.glyphicon-ruble:before{content:"\20bd"}.glyphicon-rub:before{content:"\20bd"}.glyphicon-scale:before{content:"\e230"}.glyphicon-ice-lolly:before{content:"\e231"}.glyphicon-ice-lolly-tasted:before{content:"\e232"}.glyphicon-education:before{content:"\e233"}.glyphicon-option-horizontal:before{content:"\e234"}.glyphicon-option-vertical:before{content:"\e235"}.glyphicon-menu-hamburger:before{content:"\e236"}.glyphicon-modal-window:before{content:"\e237"}.glyphicon-oil:before{content:"\e238"}.glyphicon-grain:before{content:"\e239"}.glyphicon-sunglasses:before{content:"\e240"}.glyphicon-text-size:before{content:"\e241"}.glyphicon-text-color:before{content:"\e242"}.glyphicon-text-background:before{content:"\e243"}.glyphicon-object-align-top:before{content:"\e244"}.glyphicon-object-align-bottom:before{content:"\e245"}.glyphicon-object-align-horizontal:before{content:"\e246"}.glyphicon-object-align-left:before{content:"\e247"}.glyphicon-object-align-vertical:before{content:"\e248"}.glyphicon-object-align-right:before{content:"\e249"}.glyphicon-triangle-right:before{content:"\e250"}.glyphicon-triangle-left:before{content:"\e251"}.glyphicon-triangle-bottom:before{content:"\e252"}.glyphicon-triangle-top:before{content:"\e253"}.glyphicon-console:before{content:"\e254"}.glyphicon-superscript:before{content:"\e255"}.glyphicon-subscript:before{content:"\e256"}.glyphicon-menu-left:before{content:"\e257"}.glyphicon-menu-right:before{content:"\e258"}.glyphicon-menu-down:before{content:"\e259"}.glyphicon-menu-up:before{content:"\e260"}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}:after,:before{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:10px;-webkit-tap-highlight-color:rgba(0,0,0,0)}body{font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:14px;line-height:1.42857143;color:#333;background-color:#fff}button,input,select,textarea{font-family:inherit;font-size:inherit;line-height:inherit}a{color:#337ab7;text-decoration:none}a:focus,a:hover{color:#23527c;text-decoration:underline}a:focus{outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}figure{margin:0}img{vertical-align:middle}.carousel-inner>.item>a>img,.carousel-inner>.item>img,.img-responsive,.thumbnail a>img,.thumbnail>img{display:block;max-width:100%;height:auto}.img-rounded{border-radius:6px}.img-thumbnail{display:inline-block;max-width:100%;height:auto;padding:4px;line-height:1.42857143;background-color:#fff;border:1px solid #ddd;border-radius:4px;-webkit-transition:all .2s ease-in-out;-o-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.img-circle{border-radius:50%}hr{margin-top:20px;margin-bottom:20px;border:0;border-top:1px solid #eee}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}[role=button]{cursor:pointer}.h1,.h2,.h3,.h4,.h5,.h6,h1,h2,h3,h4,h5,h6{font-family:inherit;font-weight:500;line-height:1.1;color:inherit}.h1 .small,.h1 small,.h2 .small,.h2 small,.h3 .small,.h3 small,.h4 .small,.h4 small,.h5 .small,.h5 small,.h6 .small,.h6 small,h1 .small,h1 small,h2 .small,h2 small,h3 .small,h3 small,h4 .small,h4 small,h5 .small,h5 small,h6 .small,h6 small{font-weight:400;line-height:1;color:#777}.h1,.h2,.h3,h1,h2,h3{margin-top:20px;margin-bottom:10px}.h1 .small,.h1 small,.h2 .small,.h2 small,.h3 .small,.h3 small,h1 .small,h1 small,h2 .small,h2 small,h3 .small,h3 small{font-size:65%}.h4,.h5,.h6,h4,h5,h6{margin-top:10px;margin-bottom:10px}.h4 .small,.h4 small,.h5 .small,.h5 small,.h6 .small,.h6 small,h4 .small,h4 small,h5 .small,h5 small,h6 .small,h6 small{font-size:75%}.h1,h1{font-size:36px}.h2,h2{font-size:30px}.h3,h3{font-size:24px}.h4,h4{font-size:18px}.h5,h5{font-size:14px}.h6,h6{font-size:12px}p{margin:0 0 10px}.lead{margin-bottom:20px;font-size:16px;font-weight:300;line-height:1.4}@media (min-width:768px){.lead{font-size:21px}}.small,small{font-size:85%}.mark,mark{padding:.2em;background-color:#fcf8e3}.text-left{text-align:left}.text-right{text-align:right}.text-center{text-align:center}.text-justify{text-align:justify}.text-nowrap{white-space:nowrap}.text-lowercase{text-transform:lowercase}.text-uppercase{text-transform:uppercase}.text-capitalize{text-transform:capitalize}.text-muted{color:#777}.text-primary{color:#337ab7}a.text-primary:focus,a.text-primary:hover{color:#286090}.text-success{color:#3c763d}a.text-success:focus,a.text-success:hover{color:#2b542c}.text-info{color:#31708f}a.text-info:focus,a.text-info:hover{color:#245269}.text-warning{color:#8a6d3b}a.text-warning:focus,a.text-warning:hover{color:#66512c}.text-danger{color:#a94442}a.text-danger:focus,a.text-danger:hover{color:#843534}.bg-primary{color:#fff;background-color:#337ab7}a.bg-primary:focus,a.bg-primary:hover{background-color:#286090}.bg-success{background-color:#dff0d8}a.bg-success:focus,a.bg-success:hover{background-color:#c1e2b3}.bg-info{background-color:#d9edf7}a.bg-info:focus,a.bg-info:hover{background-color:#afd9ee}.bg-warning{background-color:#fcf8e3}a.bg-warning:focus,a.bg-warning:hover{background-color:#f7ecb5}.bg-danger{background-color:#f2dede}a.bg-danger:focus,a.bg-danger:hover{background-color:#e4b9b9}.page-header{padding-bottom:9px;margin:40px 0 20px;border-bottom:1px solid #eee}ol,ul{margin-top:0;margin-bottom:10px}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}.list-unstyled{padding-left:0;list-style:none}.list-inline{padding-left:0;margin-left:-5px;list-style:none}.list-inline>li{display:inline-block;padding-right:5px;padding-left:5px}dl{margin-top:0;margin-bottom:20px}dd,dt{line-height:1.42857143}dt{font-weight:700}dd{margin-left:0}@media (min-width:768px){.dl-horizontal dt{float:left;width:160px;overflow:hidden;clear:left;text-align:right;text-overflow:ellipsis;white-space:nowrap}.dl-horizontal dd{margin-left:180px}}abbr[data-original-title],abbr[title]{cursor:help;border-bottom:1px dotted #777}.initialism{font-size:90%;text-transform:uppercase}blockquote{padding:10px 20px;margin:0 0 20px;font-size:17.5px;border-left:5px solid #eee}blockquote ol:last-child,blockquote p:last-child,blockquote ul:last-child{margin-bottom:0}blockquote .small,blockquote footer,blockquote small{display:block;font-size:80%;line-height:1.42857143;color:#777}blockquote .small:before,blockquote footer:before,blockquote small:before{content:'\2014 \00A0'}.blockquote-reverse,blockquote.pull-right{padding-right:15px;padding-left:0;text-align:right;border-right:5px solid #eee;border-left:0}.blockquote-reverse .small:before,.blockquote-reverse footer:before,.blockquote-reverse small:before,blockquote.pull-right .small:before,blockquote.pull-right footer:before,blockquote.pull-right small:before{content:''}.blockquote-reverse .small:after,.blockquote-reverse footer:after,.blockquote-reverse small:after,blockquote.pull-right .small:after,blockquote.pull-right footer:after,blockquote.pull-right small:after{content:'\00A0 \2014'}address{margin-bottom:20px;font-style:normal;line-height:1.42857143}code,kbd,pre,samp{font-family:Menlo,Monaco,Consolas,"Courier New",monospace}code{padding:2px 4px;font-size:90%;color:#c7254e;background-color:#f9f2f4;border-radius:4px}kbd{padding:2px 4px;font-size:90%;color:#fff;background-color:#333;border-radius:3px;-webkit-box-shadow:inset 0 -1px 0 rgba(0,0,0,.25);box-shadow:inset 0 -1px 0 rgba(0,0,0,.25)}kbd kbd{padding:0;font-size:100%;font-weight:700;-webkit-box-shadow:none;box-shadow:none}pre{display:block;padding:9.5px;margin:0 0 10px;font-size:13px;line-height:1.42857143;color:#333;word-break:break-all;word-wrap:break-word;background-color:#f5f5f5;border:1px solid #ccc;border-radius:4px}pre code{padding:0;font-size:inherit;color:inherit;white-space:pre-wrap;background-color:transparent;border-radius:0}.pre-scrollable{max-height:340px;overflow-y:scroll}.container{padding-right:15px;padding-left:15px;margin-right:auto;margin-left:auto}@media (min-width:768px){.container{width:750px}}@media (min-width:992px){.container{width:970px}}@media (min-width:1200px){.container{width:1170px}}.container-fluid{padding-right:15px;padding-left:15px;margin-right:auto;margin-left:auto}.row{margin-right:-15px;margin-left:-15px}.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-xs-1,.col-xs-10,.col-xs-11,.col-xs-12,.col-xs-2,.col-xs-3,.col-xs-4,.col-xs-5,.col-xs-6,.col-xs-7,.col-xs-8,.col-xs-9{position:relative;min-height:1px;padding-right:15px;padding-left:15px}.col-xs-1,.col-xs-10,.col-xs-11,.col-xs-12,.col-xs-2,.col-xs-3,.col-xs-4,.col-xs-5,.col-xs-6,.col-xs-7,.col-xs-8,.col-xs-9{float:left}.col-xs-12{width:100%}.col-xs-11{width:91.66666667%}.col-xs-10{width:83.33333333%}.col-xs-9{width:75%}.col-xs-8{width:66.66666667%}.col-xs-7{width:58.33333333%}.col-xs-6{width:50%}.col-xs-5{width:41.66666667%}.col-xs-4{width:33.33333333%}.col-xs-3{width:25%}.col-xs-2{width:16.66666667%}.col-xs-1{width:8.33333333%}.col-xs-pull-12{right:100%}.col-xs-pull-11{right:91.66666667%}.col-xs-pull-10{right:83.33333333%}.col-xs-pull-9{right:75%}.col-xs-pull-8{right:66.66666667%}.col-xs-pull-7{right:58.33333333%}.col-xs-pull-6{right:50%}.col-xs-pull-5{right:41.66666667%}.col-xs-pull-4{right:33.33333333%}.col-xs-pull-3{right:25%}.col-xs-pull-2{right:16.66666667%}.col-xs-pull-1{right:8.33333333%}.col-xs-pull-0{right:auto}.col-xs-push-12{left:100%}.col-xs-push-11{left:91.66666667%}.col-xs-push-10{left:83.33333333%}.col-xs-push-9{left:75%}.col-xs-push-8{left:66.66666667%}.col-xs-push-7{left:58.33333333%}.col-xs-push-6{left:50%}.col-xs-push-5{left:41.66666667%}.col-xs-push-4{left:33.33333333%}.col-xs-push-3{left:25%}.col-xs-push-2{left:16.66666667%}.col-xs-push-1{left:8.33333333%}.col-xs-push-0{left:auto}.col-xs-offset-12{margin-left:100%}.col-xs-offset-11{margin-left:91.66666667%}.col-xs-offset-10{margin-left:83.33333333%}.col-xs-offset-9{margin-left:75%}.col-xs-offset-8{margin-left:66.66666667%}.col-xs-offset-7{margin-left:58.33333333%}.col-xs-offset-6{margin-left:50%}.col-xs-offset-5{margin-left:41.66666667%}.col-xs-offset-4{margin-left:33.33333333%}.col-xs-offset-3{margin-left:25%}.col-xs-offset-2{margin-left:16.66666667%}.col-xs-offset-1{margin-left:8.33333333%}.col-xs-offset-0{margin-left:0}@media (min-width:768px){.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9{float:left}.col-sm-12{width:100%}.col-sm-11{width:91.66666667%}.col-sm-10{width:83.33333333%}.col-sm-9{width:75%}.col-sm-8{width:66.66666667%}.col-sm-7{width:58.33333333%}.col-sm-6{width:50%}.col-sm-5{width:41.66666667%}.col-sm-4{width:33.33333333%}.col-sm-3{width:25%}.col-sm-2{width:16.66666667%}.col-sm-1{width:8.33333333%}.col-sm-pull-12{right:100%}.col-sm-pull-11{right:91.66666667%}.col-sm-pull-10{right:83.33333333%}.col-sm-pull-9{right:75%}.col-sm-pull-8{right:66.66666667%}.col-sm-pull-7{right:58.33333333%}.col-sm-pull-6{right:50%}.col-sm-pull-5{right:41.66666667%}.col-sm-pull-4{right:33.33333333%}.col-sm-pull-3{right:25%}.col-sm-pull-2{right:16.66666667%}.col-sm-pull-1{right:8.33333333%}.col-sm-pull-0{right:auto}.col-sm-push-12{left:100%}.col-sm-push-11{left:91.66666667%}.col-sm-push-10{left:83.33333333%}.col-sm-push-9{left:75%}.col-sm-push-8{left:66.66666667%}.col-sm-push-7{left:58.33333333%}.col-sm-push-6{left:50%}.col-sm-push-5{left:41.66666667%}.col-sm-push-4{left:33.33333333%}.col-sm-push-3{left:25%}.col-sm-push-2{left:16.66666667%}.col-sm-push-1{left:8.33333333%}.col-sm-push-0{left:auto}.col-sm-offset-12{margin-left:100%}.col-sm-offset-11{margin-left:91.66666667%}.col-sm-offset-10{margin-left:83.33333333%}.col-sm-offset-9{margin-left:75%}.col-sm-offset-8{margin-left:66.66666667%}.col-sm-offset-7{margin-left:58.33333333%}.col-sm-offset-6{margin-left:50%}.col-sm-offset-5{margin-left:41.66666667%}.col-sm-offset-4{margin-left:33.33333333%}.col-sm-offset-3{margin-left:25%}.col-sm-offset-2{margin-left:16.66666667%}.col-sm-offset-1{margin-left:8.33333333%}.col-sm-offset-0{margin-left:0}}@media (min-width:992px){.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9{float:left}.col-md-12{width:100%}.col-md-11{width:91.66666667%}.col-md-10{width:83.33333333%}.col-md-9{width:75%}.col-md-8{width:66.66666667%}.col-md-7{width:58.33333333%}.col-md-6{width:50%}.col-md-5{width:41.66666667%}.col-md-4{width:33.33333333%}.col-md-3{width:25%}.col-md-2{width:16.66666667%}.col-md-1{width:8.33333333%}.col-md-pull-12{right:100%}.col-md-pull-11{right:91.66666667%}.col-md-pull-10{right:83.33333333%}.col-md-pull-9{right:75%}.col-md-pull-8{right:66.66666667%}.col-md-pull-7{right:58.33333333%}.col-md-pull-6{right:50%}.col-md-pull-5{right:41.66666667%}.col-md-pull-4{right:33.33333333%}.col-md-pull-3{right:25%}.col-md-pull-2{right:16.66666667%}.col-md-pull-1{right:8.33333333%}.col-md-pull-0{right:auto}.col-md-push-12{left:100%}.col-md-push-11{left:91.66666667%}.col-md-push-10{left:83.33333333%}.col-md-push-9{left:75%}.col-md-push-8{left:66.66666667%}.col-md-push-7{left:58.33333333%}.col-md-push-6{left:50%}.col-md-push-5{left:41.66666667%}.col-md-push-4{left:33.33333333%}.col-md-push-3{left:25%}.col-md-push-2{left:16.66666667%}.col-md-push-1{left:8.33333333%}.col-md-push-0{left:auto}.col-md-offset-12{margin-left:100%}.col-md-offset-11{margin-left:91.66666667%}.col-md-offset-10{margin-left:83.33333333%}.col-md-offset-9{margin-left:75%}.col-md-offset-8{margin-left:66.66666667%}.col-md-offset-7{margin-left:58.33333333%}.col-md-offset-6{margin-left:50%}.col-md-offset-5{margin-left:41.66666667%}.col-md-offset-4{margin-left:33.33333333%}.col-md-offset-3{margin-left:25%}.col-md-offset-2{margin-left:16.66666667%}.col-md-offset-1{margin-left:8.33333333%}.col-md-offset-0{margin-left:0}}@media (min-width:1200px){.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9{float:left}.col-lg-12{width:100%}.col-lg-11{width:91.66666667%}.col-lg-10{width:83.33333333%}.col-lg-9{width:75%}.col-lg-8{width:66.66666667%}.col-lg-7{width:58.33333333%}.col-lg-6{width:50%}.col-lg-5{width:41.66666667%}.col-lg-4{width:33.33333333%}.col-lg-3{width:25%}.col-lg-2{width:16.66666667%}.col-lg-1{width:8.33333333%}.col-lg-pull-12{right:100%}.col-lg-pull-11{right:91.66666667%}.col-lg-pull-10{right:83.33333333%}.col-lg-pull-9{right:75%}.col-lg-pull-8{right:66.66666667%}.col-lg-pull-7{right:58.33333333%}.col-lg-pull-6{right:50%}.col-lg-pull-5{right:41.66666667%}.col-lg-pull-4{right:33.33333333%}.col-lg-pull-3{right:25%}.col-lg-pull-2{right:16.66666667%}.col-lg-pull-1{right:8.33333333%}.col-lg-pull-0{right:auto}.col-lg-push-12{left:100%}.col-lg-push-11{left:91.66666667%}.col-lg-push-10{left:83.33333333%}.col-lg-push-9{left:75%}.col-lg-push-8{left:66.66666667%}.col-lg-push-7{left:58.33333333%}.col-lg-push-6{left:50%}.col-lg-push-5{left:41.66666667%}.col-lg-push-4{left:33.33333333%}.col-lg-push-3{left:25%}.col-lg-push-2{left:16.66666667%}.col-lg-push-1{left:8.33333333%}.col-lg-push-0{left:auto}.col-lg-offset-12{margin-left:100%}.col-lg-offset-11{margin-left:91.66666667%}.col-lg-offset-10{margin-left:83.33333333%}.col-lg-offset-9{margin-left:75%}.col-lg-offset-8{margin-left:66.66666667%}.col-lg-offset-7{margin-left:58.33333333%}.col-lg-offset-6{margin-left:50%}.col-lg-offset-5{margin-left:41.66666667%}.col-lg-offset-4{margin-left:33.33333333%}.col-lg-offset-3{margin-left:25%}.col-lg-offset-2{margin-left:16.66666667%}.col-lg-offset-1{margin-left:8.33333333%}.col-lg-offset-0{margin-left:0}}table{background-color:transparent}caption{padding-top:8px;padding-bottom:8px;color:#777;text-align:left}th{text-align:left}.table{width:100%;max-width:100%;margin-bottom:20px}.table>tbody>tr>td,.table>tbody>tr>th,.table>tfoot>tr>td,.table>tfoot>tr>th,.table>thead>tr>td,.table>thead>tr>th{padding:8px;line-height:1.42857143;vertical-align:top;border-top:1px solid #ddd}.table>thead>tr>th{vertical-align:bottom;border-bottom:2px solid #ddd}.table>caption+thead>tr:first-child>td,.table>caption+thead>tr:first-child>th,.table>colgroup+thead>tr:first-child>td,.table>colgroup+thead>tr:first-child>th,.table>thead:first-child>tr:first-child>td,.table>thead:first-child>tr:first-child>th{border-top:0}.table>tbody+tbody{border-top:2px solid #ddd}.table .table{background-color:#fff}.table-condensed>tbody>tr>td,.table-condensed>tbody>tr>th,.table-condensed>tfoot>tr>td,.table-condensed>tfoot>tr>th,.table-condensed>thead>tr>td,.table-condensed>thead>tr>th{padding:5px}.table-bordered{border:1px solid #ddd}.table-bordered>tbody>tr>td,.table-bordered>tbody>tr>th,.table-bordered>tfoot>tr>td,.table-bordered>tfoot>tr>th,.table-bordered>thead>tr>td,.table-bordered>thead>tr>th{border:1px solid #ddd}.table-bordered>thead>tr>td,.table-bordered>thead>tr>th{border-bottom-width:2px}.table-striped>tbody>tr:nth-of-type(odd){background-color:#f9f9f9}.table-hover>tbody>tr:hover{background-color:#f5f5f5}table col[class*=col-]{position:static;display:table-column;float:none}table td[class*=col-],table th[class*=col-]{position:static;display:table-cell;float:none}.table>tbody>tr.active>td,.table>tbody>tr.active>th,.table>tbody>tr>td.active,.table>tbody>tr>th.active,.table>tfoot>tr.active>td,.table>tfoot>tr.active>th,.table>tfoot>tr>td.active,.table>tfoot>tr>th.active,.table>thead>tr.active>td,.table>thead>tr.active>th,.table>thead>tr>td.active,.table>thead>tr>th.active{background-color:#f5f5f5}.table-hover>tbody>tr.active:hover>td,.table-hover>tbody>tr.active:hover>th,.table-hover>tbody>tr:hover>.active,.table-hover>tbody>tr>td.active:hover,.table-hover>tbody>tr>th.active:hover{background-color:#e8e8e8}.table>tbody>tr.success>td,.table>tbody>tr.success>th,.table>tbody>tr>td.success,.table>tbody>tr>th.success,.table>tfoot>tr.success>td,.table>tfoot>tr.success>th,.table>tfoot>tr>td.success,.table>tfoot>tr>th.success,.table>thead>tr.success>td,.table>thead>tr.success>th,.table>thead>tr>td.success,.table>thead>tr>th.success{background-color:#dff0d8}.table-hover>tbody>tr.success:hover>td,.table-hover>tbody>tr.success:hover>th,.table-hover>tbody>tr:hover>.success,.table-hover>tbody>tr>td.success:hover,.table-hover>tbody>tr>th.success:hover{background-color:#d0e9c6}.table>tbody>tr.info>td,.table>tbody>tr.info>th,.table>tbody>tr>td.info,.table>tbody>tr>th.info,.table>tfoot>tr.info>td,.table>tfoot>tr.info>th,.table>tfoot>tr>td.info,.table>tfoot>tr>th.info,.table>thead>tr.info>td,.table>thead>tr.info>th,.table>thead>tr>td.info,.table>thead>tr>th.info{background-color:#d9edf7}.table-hover>tbody>tr.info:hover>td,.table-hover>tbody>tr.info:hover>th,.table-hover>tbody>tr:hover>.info,.table-hover>tbody>tr>td.info:hover,.table-hover>tbody>tr>th.info:hover{background-color:#c4e3f3}.table>tbody>tr.warning>td,.table>tbody>tr.warning>th,.table>tbody>tr>td.warning,.table>tbody>tr>th.warning,.table>tfoot>tr.warning>td,.table>tfoot>tr.warning>th,.table>tfoot>tr>td.warning,.table>tfoot>tr>th.warning,.table>thead>tr.warning>td,.table>thead>tr.warning>th,.table>thead>tr>td.warning,.table>thead>tr>th.warning{background-color:#fcf8e3}.table-hover>tbody>tr.warning:hover>td,.table-hover>tbody>tr.warning:hover>th,.table-hover>tbody>tr:hover>.warning,.table-hover>tbody>tr>td.warning:hover,.table-hover>tbody>tr>th.warning:hover{background-color:#faf2cc}.table>tbody>tr.danger>td,.table>tbody>tr.danger>th,.table>tbody>tr>td.danger,.table>tbody>tr>th.danger,.table>tfoot>tr.danger>td,.table>tfoot>tr.danger>th,.table>tfoot>tr>td.danger,.table>tfoot>tr>th.danger,.table>thead>tr.danger>td,.table>thead>tr.danger>th,.table>thead>tr>td.danger,.table>thead>tr>th.danger{background-color:#f2dede}.table-hover>tbody>tr.danger:hover>td,.table-hover>tbody>tr.danger:hover>th,.table-hover>tbody>tr:hover>.danger,.table-hover>tbody>tr>td.danger:hover,.table-hover>tbody>tr>th.danger:hover{background-color:#ebcccc}.table-responsive{min-height:.01%;overflow-x:auto}@media screen and (max-width:767px){.table-responsive{width:100%;margin-bottom:15px;overflow-y:hidden;-ms-overflow-style:-ms-autohiding-scrollbar;border:1px solid #ddd}.table-responsive>.table{margin-bottom:0}.table-responsive>.table>tbody>tr>td,.table-responsive>.table>tbody>tr>th,.table-responsive>.table>tfoot>tr>td,.table-responsive>.table>tfoot>tr>th,.table-responsive>.table>thead>tr>td,.table-responsive>.table>thead>tr>th{white-space:nowrap}.table-responsive>.table-bordered{border:0}.table-responsive>.table-bordered>tbody>tr>td:first-child,.table-responsive>.table-bordered>tbody>tr>th:first-child,.table-responsive>.table-bordered>tfoot>tr>td:first-child,.table-responsive>.table-bordered>tfoot>tr>th:first-child,.table-responsive>.table-bordered>thead>tr>td:first-child,.table-responsive>.table-bordered>thead>tr>th:first-child{border-left:0}.table-responsive>.table-bordered>tbody>tr>td:last-child,.table-responsive>.table-bordered>tbody>tr>th:last-child,.table-responsive>.table-bordered>tfoot>tr>td:last-child,.table-responsive>.table-bordered>tfoot>tr>th:last-child,.table-responsive>.table-bordered>thead>tr>td:last-child,.table-responsive>.table-bordered>thead>tr>th:last-child{border-right:0}.table-responsive>.table-bordered>tbody>tr:last-child>td,.table-responsive>.table-bordered>tbody>tr:last-child>th,.table-responsive>.table-bordered>tfoot>tr:last-child>td,.table-responsive>.table-bordered>tfoot>tr:last-child>th{border-bottom:0}}fieldset{min-width:0;padding:0;margin:0;border:0}legend{display:block;width:100%;padding:0;margin-bottom:20px;font-size:21px;line-height:inherit;color:#333;border:0;border-bottom:1px solid #e5e5e5}label{display:inline-block;max-width:100%;margin-bottom:5px;font-weight:700}input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=checkbox],input[type=radio]{margin:4px 0 0;margin-top:1px\9;line-height:normal}input[type=file]{display:block}input[type=range]{display:block;width:100%}select[multiple],select[size]{height:auto}input[type=file]:focus,input[type=checkbox]:focus,input[type=radio]:focus{outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}output{display:block;padding-top:7px;font-size:14px;line-height:1.42857143;color:#555}.form-control{display:block;width:100%;height:34px;padding:6px 12px;font-size:14px;line-height:1.42857143;color:#555;background-color:#fff;background-image:none;border:1px solid #ccc;border-radius:4px;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075);box-shadow:inset 0 1px 1px rgba(0,0,0,.075);-webkit-transition:border-color ease-in-out .15s,-webkit-box-shadow ease-in-out .15s;-o-transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s;transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s}.form-control:focus{border-color:#66afe9;outline:0;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 8px rgba(102,175,233,.6);box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 8px rgba(102,175,233,.6)}.form-control::-moz-placeholder{color:#999;opacity:1}.form-control:-ms-input-placeholder{color:#999}.form-control::-webkit-input-placeholder{color:#999}.form-control::-ms-expand{background-color:transparent;border:0}.form-control[disabled],.form-control[readonly],fieldset[disabled] .form-control{background-color:#eee;opacity:1}.form-control[disabled],fieldset[disabled] .form-control{cursor:not-allowed}textarea.form-control{height:auto}input[type=search]{-webkit-appearance:none}@media screen and (-webkit-min-device-pixel-ratio:0){input[type=date].form-control,input[type=time].form-control,input[type=datetime-local].form-control,input[type=month].form-control{line-height:34px}.input-group-sm input[type=date],.input-group-sm input[type=time],.input-group-sm input[type=datetime-local],.input-group-sm input[type=month],input[type=date].input-sm,input[type=time].input-sm,input[type=datetime-local].input-sm,input[type=month].input-sm{line-height:30px}.input-group-lg input[type=date],.input-group-lg input[type=time],.input-group-lg input[type=datetime-local],.input-group-lg input[type=month],input[type=date].input-lg,input[type=time].input-lg,input[type=datetime-local].input-lg,input[type=month].input-lg{line-height:46px}}.form-group{margin-bottom:15px}.checkbox,.radio{position:relative;display:block;margin-top:10px;margin-bottom:10px}.checkbox label,.radio label{min-height:20px;padding-left:20px;margin-bottom:0;font-weight:400;cursor:pointer}.checkbox input[type=checkbox],.checkbox-inline input[type=checkbox],.radio input[type=radio],.radio-inline input[type=radio]{position:absolute;margin-top:4px\9;margin-left:-20px}.checkbox+.checkbox,.radio+.radio{margin-top:-5px}.checkbox-inline,.radio-inline{position:relative;display:inline-block;padding-left:20px;margin-bottom:0;font-weight:400;vertical-align:middle;cursor:pointer}.checkbox-inline+.checkbox-inline,.radio-inline+.radio-inline{margin-top:0;margin-left:10px}fieldset[disabled] input[type=checkbox],fieldset[disabled] input[type=radio],input[type=checkbox].disabled,input[type=checkbox][disabled],input[type=radio].disabled,input[type=radio][disabled]{cursor:not-allowed}.checkbox-inline.disabled,.radio-inline.disabled,fieldset[disabled] .checkbox-inline,fieldset[disabled] .radio-inline{cursor:not-allowed}.checkbox.disabled label,.radio.disabled label,fieldset[disabled] .checkbox label,fieldset[disabled] .radio label{cursor:not-allowed}.form-control-static{min-height:34px;padding-top:7px;padding-bottom:7px;margin-bottom:0}.form-control-static.input-lg,.form-control-static.input-sm{padding-right:0;padding-left:0}.input-sm{height:30px;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}select.input-sm{height:30px;line-height:30px}select[multiple].input-sm,textarea.input-sm{height:auto}.form-group-sm .form-control{height:30px;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}.form-group-sm select.form-control{height:30px;line-height:30px}.form-group-sm select[multiple].form-control,.form-group-sm textarea.form-control{height:auto}.form-group-sm .form-control-static{height:30px;min-height:32px;padding:6px 10px;font-size:12px;line-height:1.5}.input-lg{height:46px;padding:10px 16px;font-size:18px;line-height:1.3333333;border-radius:6px}select.input-lg{height:46px;line-height:46px}select[multiple].input-lg,textarea.input-lg{height:auto}.form-group-lg .form-control{height:46px;padding:10px 16px;font-size:18px;line-height:1.3333333;border-radius:6px}.form-group-lg select.form-control{height:46px;line-height:46px}.form-group-lg select[multiple].form-control,.form-group-lg textarea.form-control{height:auto}.form-group-lg .form-control-static{height:46px;min-height:38px;padding:11px 16px;font-size:18px;line-height:1.3333333}.has-feedback{position:relative}.has-feedback .form-control{padding-right:42.5px}.form-control-feedback{position:absolute;top:0;right:0;z-index:2;display:block;width:34px;height:34px;line-height:34px;text-align:center;pointer-events:none}.form-group-lg .form-control+.form-control-feedback,.input-group-lg+.form-control-feedback,.input-lg+.form-control-feedback{width:46px;height:46px;line-height:46px}.form-group-sm .form-control+.form-control-feedback,.input-group-sm+.form-control-feedback,.input-sm+.form-control-feedback{width:30px;height:30px;line-height:30px}.has-success .checkbox,.has-success .checkbox-inline,.has-success .control-label,.has-success .help-block,.has-success .radio,.has-success .radio-inline,.has-success.checkbox label,.has-success.checkbox-inline label,.has-success.radio label,.has-success.radio-inline label{color:#3c763d}.has-success .form-control{border-color:#3c763d;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075);box-shadow:inset 0 1px 1px rgba(0,0,0,.075)}.has-success .form-control:focus{border-color:#2b542c;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #67b168;box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #67b168}.has-success .input-group-addon{color:#3c763d;background-color:#dff0d8;border-color:#3c763d}.has-success .form-control-feedback{color:#3c763d}.has-warning .checkbox,.has-warning .checkbox-inline,.has-warning .control-label,.has-warning .help-block,.has-warning .radio,.has-warning .radio-inline,.has-warning.checkbox label,.has-warning.checkbox-inline label,.has-warning.radio label,.has-warning.radio-inline label{color:#8a6d3b}.has-warning .form-control{border-color:#8a6d3b;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075);box-shadow:inset 0 1px 1px rgba(0,0,0,.075)}.has-warning .form-control:focus{border-color:#66512c;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #c0a16b;box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #c0a16b}.has-warning .input-group-addon{color:#8a6d3b;background-color:#fcf8e3;border-color:#8a6d3b}.has-warning .form-control-feedback{color:#8a6d3b}.has-error .checkbox,.has-error .checkbox-inline,.has-error .control-label,.has-error .help-block,.has-error .radio,.has-error .radio-inline,.has-error.checkbox label,.has-error.checkbox-inline label,.has-error.radio label,.has-error.radio-inline label{color:#a94442}.has-error .form-control{border-color:#a94442;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075);box-shadow:inset 0 1px 1px rgba(0,0,0,.075)}.has-error .form-control:focus{border-color:#843534;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #ce8483;box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #ce8483}.has-error .input-group-addon{color:#a94442;background-color:#f2dede;border-color:#a94442}.has-error .form-control-feedback{color:#a94442}.has-feedback label~.form-control-feedback{top:25px}.has-feedback label.sr-only~.form-control-feedback{top:0}.help-block{display:block;margin-top:5px;margin-bottom:10px;color:#737373}@media (min-width:768px){.form-inline .form-group{display:inline-block;margin-bottom:0;vertical-align:middle}.form-inline .form-control{display:inline-block;width:auto;vertical-align:middle}.form-inline .form-control-static{display:inline-block}.form-inline .input-group{display:inline-table;vertical-align:middle}.form-inline .input-group .form-control,.form-inline .input-group .input-group-addon,.form-inline .input-group .input-group-btn{width:auto}.form-inline .input-group>.form-control{width:100%}.form-inline .control-label{margin-bottom:0;vertical-align:middle}.form-inline .checkbox,.form-inline .radio{display:inline-block;margin-top:0;margin-bottom:0;vertical-align:middle}.form-inline .checkbox label,.form-inline .radio label{padding-left:0}.form-inline .checkbox input[type=checkbox],.form-inline .radio input[type=radio]{position:relative;margin-left:0}.form-inline .has-feedback .form-control-feedback{top:0}}.form-horizontal .checkbox,.form-horizontal .checkbox-inline,.form-horizontal .radio,.form-horizontal .radio-inline{padding-top:7px;margin-top:0;margin-bottom:0}.form-horizontal .checkbox,.form-horizontal .radio{min-height:27px}.form-horizontal .form-group{margin-right:-15px;margin-left:-15px}@media (min-width:768px){.form-horizontal .control-label{padding-top:7px;margin-bottom:0;text-align:right}}.form-horizontal .has-feedback .form-control-feedback{right:15px}@media (min-width:768px){.form-horizontal .form-group-lg .control-label{padding-top:11px;font-size:18px}}@media (min-width:768px){.form-horizontal .form-group-sm .control-label{padding-top:6px;font-size:12px}}.btn{display:inline-block;padding:6px 12px;margin-bottom:0;font-size:14px;font-weight:400;line-height:1.42857143;text-align:center;white-space:nowrap;vertical-align:middle;-ms-touch-action:manipulation;touch-action:manipulation;cursor:pointer;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;background-image:none;border:1px solid transparent;border-radius:4px}.btn.active.focus,.btn.active:focus,.btn.focus,.btn:active.focus,.btn:active:focus,.btn:focus{outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}.btn.focus,.btn:focus,.btn:hover{color:#333;text-decoration:none}.btn.active,.btn:active{background-image:none;outline:0;-webkit-box-shadow:inset 0 3px 5px rgba(0,0,0,.125);box-shadow:inset 0 3px 5px rgba(0,0,0,.125)}.btn.disabled,.btn[disabled],fieldset[disabled] .btn{cursor:not-allowed;filter:alpha(opacity=65);-webkit-box-shadow:none;box-shadow:none;opacity:.65}a.btn.disabled,fieldset[disabled] a.btn{pointer-events:none}.btn-default{color:#333;background-color:#fff;border-color:#ccc}.btn-default.focus,.btn-default:focus{color:#333;background-color:#e6e6e6;border-color:#8c8c8c}.btn-default:hover{color:#333;background-color:#e6e6e6;border-color:#adadad}.btn-default.active,.btn-default:active,.open>.dropdown-toggle.btn-default{color:#333;background-color:#e6e6e6;border-color:#adadad}.btn-default.active.focus,.btn-default.active:focus,.btn-default.active:hover,.btn-default:active.focus,.btn-default:active:focus,.btn-default:active:hover,.open>.dropdown-toggle.btn-default.focus,.open>.dropdown-toggle.btn-default:focus,.open>.dropdown-toggle.btn-default:hover{color:#333;background-color:#d4d4d4;border-color:#8c8c8c}.btn-default.active,.btn-default:active,.open>.dropdown-toggle.btn-default{background-image:none}.btn-default.disabled.focus,.btn-default.disabled:focus,.btn-default.disabled:hover,.btn-default[disabled].focus,.btn-default[disabled]:focus,.btn-default[disabled]:hover,fieldset[disabled] .btn-default.focus,fieldset[disabled] .btn-default:focus,fieldset[disabled] .btn-default:hover{background-color:#fff;border-color:#ccc}.btn-default .badge{color:#fff;background-color:#333}.btn-primary{color:#fff;background-color:#337ab7;border-color:#2e6da4}.btn-primary.focus,.btn-primary:focus{color:#fff;background-color:#286090;border-color:#122b40}.btn-primary:hover{color:#fff;background-color:#286090;border-color:#204d74}.btn-primary.active,.btn-primary:active,.open>.dropdown-toggle.btn-primary{color:#fff;background-color:#286090;border-color:#204d74}.btn-primary.active.focus,.btn-primary.active:focus,.btn-primary.active:hover,.btn-primary:active.focus,.btn-primary:active:focus,.btn-primary:active:hover,.open>.dropdown-toggle.btn-primary.focus,.open>.dropdown-toggle.btn-primary:focus,.open>.dropdown-toggle.btn-primary:hover{color:#fff;background-color:#204d74;border-color:#122b40}.btn-primary.active,.btn-primary:active,.open>.dropdown-toggle.btn-primary{background-image:none}.btn-primary.disabled.focus,.btn-primary.disabled:focus,.btn-primary.disabled:hover,.btn-primary[disabled].focus,.btn-primary[disabled]:focus,.btn-primary[disabled]:hover,fieldset[disabled] .btn-primary.focus,fieldset[disabled] .btn-primary:focus,fieldset[disabled] .btn-primary:hover{background-color:#337ab7;border-color:#2e6da4}.btn-primary .badge{color:#337ab7;background-color:#fff}.btn-success{color:#fff;background-color:#5cb85c;border-color:#4cae4c}.btn-success.focus,.btn-success:focus{color:#fff;background-color:#449d44;border-color:#255625}.btn-success:hover{color:#fff;background-color:#449d44;border-color:#398439}.btn-success.active,.btn-success:active,.open>.dropdown-toggle.btn-success{color:#fff;background-color:#449d44;border-color:#398439}.btn-success.active.focus,.btn-success.active:focus,.btn-success.active:hover,.btn-success:active.focus,.btn-success:active:focus,.btn-success:active:hover,.open>.dropdown-toggle.btn-success.focus,.open>.dropdown-toggle.btn-success:focus,.open>.dropdown-toggle.btn-success:hover{color:#fff;background-color:#398439;border-color:#255625}.btn-success.active,.btn-success:active,.open>.dropdown-toggle.btn-success{background-image:none}.btn-success.disabled.focus,.btn-success.disabled:focus,.btn-success.disabled:hover,.btn-success[disabled].focus,.btn-success[disabled]:focus,.btn-success[disabled]:hover,fieldset[disabled] .btn-success.focus,fieldset[disabled] .btn-success:focus,fieldset[disabled] .btn-success:hover{background-color:#5cb85c;border-color:#4cae4c}.btn-success .badge{color:#5cb85c;background-color:#fff}.btn-info{color:#fff;background-color:#5bc0de;border-color:#46b8da}.btn-info.focus,.btn-info:focus{color:#fff;background-color:#31b0d5;border-color:#1b6d85}.btn-info:hover{color:#fff;background-color:#31b0d5;border-color:#269abc}.btn-info.active,.btn-info:active,.open>.dropdown-toggle.btn-info{color:#fff;background-color:#31b0d5;border-color:#269abc}.btn-info.active.focus,.btn-info.active:focus,.btn-info.active:hover,.btn-info:active.focus,.btn-info:active:focus,.btn-info:active:hover,.open>.dropdown-toggle.btn-info.focus,.open>.dropdown-toggle.btn-info:focus,.open>.dropdown-toggle.btn-info:hover{color:#fff;background-color:#269abc;border-color:#1b6d85}.btn-info.active,.btn-info:active,.open>.dropdown-toggle.btn-info{background-image:none}.btn-info.disabled.focus,.btn-info.disabled:focus,.btn-info.disabled:hover,.btn-info[disabled].focus,.btn-info[disabled]:focus,.btn-info[disabled]:hover,fieldset[disabled] .btn-info.focus,fieldset[disabled] .btn-info:focus,fieldset[disabled] .btn-info:hover{background-color:#5bc0de;border-color:#46b8da}.btn-info .badge{color:#5bc0de;background-color:#fff}.btn-warning{color:#fff;background-color:#f0ad4e;border-color:#eea236}.btn-warning.focus,.btn-warning:focus{color:#fff;background-color:#ec971f;border-color:#985f0d}.btn-warning:hover{color:#fff;background-color:#ec971f;border-color:#d58512}.btn-warning.active,.btn-warning:active,.open>.dropdown-toggle.btn-warning{color:#fff;background-color:#ec971f;border-color:#d58512}.btn-warning.active.focus,.btn-warning.active:focus,.btn-warning.active:hover,.btn-warning:active.focus,.btn-warning:active:focus,.btn-warning:active:hover,.open>.dropdown-toggle.btn-warning.focus,.open>.dropdown-toggle.btn-warning:focus,.open>.dropdown-toggle.btn-warning:hover{color:#fff;background-color:#d58512;border-color:#985f0d}.btn-warning.active,.btn-warning:active,.open>.dropdown-toggle.btn-warning{background-image:none}.btn-warning.disabled.focus,.btn-warning.disabled:focus,.btn-warning.disabled:hover,.btn-warning[disabled].focus,.btn-warning[disabled]:focus,.btn-warning[disabled]:hover,fieldset[disabled] .btn-warning.focus,fieldset[disabled] .btn-warning:focus,fieldset[disabled] .btn-warning:hover{background-color:#f0ad4e;border-color:#eea236}.btn-warning .badge{color:#f0ad4e;background-color:#fff}.btn-danger{color:#fff;background-color:#d9534f;border-color:#d43f3a}.btn-danger.focus,.btn-danger:focus{color:#fff;background-color:#c9302c;border-color:#761c19}.btn-danger:hover{color:#fff;background-color:#c9302c;border-color:#ac2925}.btn-danger.active,.btn-danger:active,.open>.dropdown-toggle.btn-danger{color:#fff;background-color:#c9302c;border-color:#ac2925}.btn-danger.active.focus,.btn-danger.active:focus,.btn-danger.active:hover,.btn-danger:active.focus,.btn-danger:active:focus,.btn-danger:active:hover,.open>.dropdown-toggle.btn-danger.focus,.open>.dropdown-toggle.btn-danger:focus,.open>.dropdown-toggle.btn-danger:hover{color:#fff;background-color:#ac2925;border-color:#761c19}.btn-danger.active,.btn-danger:active,.open>.dropdown-toggle.btn-danger{background-image:none}.btn-danger.disabled.focus,.btn-danger.disabled:focus,.btn-danger.disabled:hover,.btn-danger[disabled].focus,.btn-danger[disabled]:focus,.btn-danger[disabled]:hover,fieldset[disabled] .btn-danger.focus,fieldset[disabled] .btn-danger:focus,fieldset[disabled] .btn-danger:hover{background-color:#d9534f;border-color:#d43f3a}.btn-danger .badge{color:#d9534f;background-color:#fff}.btn-link{font-weight:400;color:#337ab7;border-radius:0}.btn-link,.btn-link.active,.btn-link:active,.btn-link[disabled],fieldset[disabled] .btn-link{background-color:transparent;-webkit-box-shadow:none;box-shadow:none}.btn-link,.btn-link:active,.btn-link:focus,.btn-link:hover{border-color:transparent}.btn-link:focus,.btn-link:hover{color:#23527c;text-decoration:underline;background-color:transparent}.btn-link[disabled]:focus,.btn-link[disabled]:hover,fieldset[disabled] .btn-link:focus,fieldset[disabled] .btn-link:hover{color:#777;text-decoration:none}.btn-group-lg>.btn,.btn-lg{padding:10px 16px;font-size:18px;line-height:1.3333333;border-radius:6px}.btn-group-sm>.btn,.btn-sm{padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}.btn-group-xs>.btn,.btn-xs{padding:1px 5px;font-size:12px;line-height:1.5;border-radius:3px}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:5px}input[type=button].btn-block,input[type=reset].btn-block,input[type=submit].btn-block{width:100%}.fade{opacity:0;-webkit-transition:opacity .15s linear;-o-transition:opacity .15s linear;transition:opacity .15s linear}.fade.in{opacity:1}.collapse{display:none}.collapse.in{display:block}tr.collapse.in{display:table-row}tbody.collapse.in{display:table-row-group}.collapsing{position:relative;height:0;overflow:hidden;-webkit-transition-timing-function:ease;-o-transition-timing-function:ease;transition-timing-function:ease;-webkit-transition-duration:.35s;-o-transition-duration:.35s;transition-duration:.35s;-webkit-transition-property:height,visibility;-o-transition-property:height,visibility;transition-property:height,visibility}.caret{display:inline-block;width:0;height:0;margin-left:2px;vertical-align:middle;border-top:4px dashed;border-top:4px solid\9;border-right:4px solid transparent;border-left:4px solid transparent}.dropdown,.dropup{position:relative}.dropdown-toggle:focus{outline:0}.dropdown-menu{position:absolute;top:100%;left:0;z-index:1000;display:none;float:left;min-width:160px;padding:5px 0;margin:2px 0 0;font-size:14px;text-align:left;list-style:none;background-color:#fff;-webkit-background-clip:padding-box;background-clip:padding-box;border:1px solid #ccc;border:1px solid rgba(0,0,0,.15);border-radius:4px;-webkit-box-shadow:0 6px 12px rgba(0,0,0,.175);box-shadow:0 6px 12px rgba(0,0,0,.175)}.dropdown-menu.pull-right{right:0;left:auto}.dropdown-menu .divider{height:1px;margin:9px 0;overflow:hidden;background-color:#e5e5e5}.dropdown-menu>li>a{display:block;padding:3px 20px;clear:both;font-weight:400;line-height:1.42857143;color:#333;white-space:nowrap}.dropdown-menu>li>a:focus,.dropdown-menu>li>a:hover{color:#262626;text-decoration:none;background-color:#f5f5f5}.dropdown-menu>.active>a,.dropdown-menu>.active>a:focus,.dropdown-menu>.active>a:hover{color:#fff;text-decoration:none;background-color:#337ab7;outline:0}.dropdown-menu>.disabled>a,.dropdown-menu>.disabled>a:focus,.dropdown-menu>.disabled>a:hover{color:#777}.dropdown-menu>.disabled>a:focus,.dropdown-menu>.disabled>a:hover{text-decoration:none;cursor:not-allowed;background-color:transparent;background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled=false)}.open>.dropdown-menu{display:block}.open>a{outline:0}.dropdown-menu-right{right:0;left:auto}.dropdown-menu-left{right:auto;left:0}.dropdown-header{display:block;padding:3px 20px;font-size:12px;line-height:1.42857143;color:#777;white-space:nowrap}.dropdown-backdrop{position:fixed;top:0;right:0;bottom:0;left:0;z-index:990}.pull-right>.dropdown-menu{right:0;left:auto}.dropup .caret,.navbar-fixed-bottom .dropdown .caret{content:"";border-top:0;border-bottom:4px dashed;border-bottom:4px solid\9}.dropup .dropdown-menu,.navbar-fixed-bottom .dropdown .dropdown-menu{top:auto;bottom:100%;margin-bottom:2px}@media (min-width:768px){.navbar-right .dropdown-menu{right:0;left:auto}.navbar-right .dropdown-menu-left{right:auto;left:0}}.btn-group,.btn-group-vertical{position:relative;display:inline-block;vertical-align:middle}.btn-group-vertical>.btn,.btn-group>.btn{position:relative;float:left}.btn-group-vertical>.btn.active,.btn-group-vertical>.btn:active,.btn-group-vertical>.btn:focus,.btn-group-vertical>.btn:hover,.btn-group>.btn.active,.btn-group>.btn:active,.btn-group>.btn:focus,.btn-group>.btn:hover{z-index:2}.btn-group .btn+.btn,.btn-group .btn+.btn-group,.btn-group .btn-group+.btn,.btn-group .btn-group+.btn-group{margin-left:-1px}.btn-toolbar{margin-left:-5px}.btn-toolbar .btn,.btn-toolbar .btn-group,.btn-toolbar .input-group{float:left}.btn-toolbar>.btn,.btn-toolbar>.btn-group,.btn-toolbar>.input-group{margin-left:5px}.btn-group>.btn:not(:first-child):not(:last-child):not(.dropdown-toggle){border-radius:0}.btn-group>.btn:first-child{margin-left:0}.btn-group>.btn:first-child:not(:last-child):not(.dropdown-toggle){border-top-right-radius:0;border-bottom-right-radius:0}.btn-group>.btn:last-child:not(:first-child),.btn-group>.dropdown-toggle:not(:first-child){border-top-left-radius:0;border-bottom-left-radius:0}.btn-group>.btn-group{float:left}.btn-group>.btn-group:not(:first-child):not(:last-child)>.btn{border-radius:0}.btn-group>.btn-group:first-child:not(:last-child)>.btn:last-child,.btn-group>.btn-group:first-child:not(:last-child)>.dropdown-toggle{border-top-right-radius:0;border-bottom-right-radius:0}.btn-group>.btn-group:last-child:not(:first-child)>.btn:first-child{border-top-left-radius:0;border-bottom-left-radius:0}.btn-group .dropdown-toggle:active,.btn-group.open .dropdown-toggle{outline:0}.btn-group>.btn+.dropdown-toggle{padding-right:8px;padding-left:8px}.btn-group>.btn-lg+.dropdown-toggle{padding-right:12px;padding-left:12px}.btn-group.open .dropdown-toggle{-webkit-box-shadow:inset 0 3px 5px rgba(0,0,0,.125);box-shadow:inset 0 3px 5px rgba(0,0,0,.125)}.btn-group.open .dropdown-toggle.btn-link{-webkit-box-shadow:none;box-shadow:none}.btn .caret{margin-left:0}.btn-lg .caret{border-width:5px 5px 0;border-bottom-width:0}.dropup .btn-lg .caret{border-width:0 5px 5px}.btn-group-vertical>.btn,.btn-group-vertical>.btn-group,.btn-group-vertical>.btn-group>.btn{display:block;float:none;width:100%;max-width:100%}.btn-group-vertical>.btn-group>.btn{float:none}.btn-group-vertical>.btn+.btn,.btn-group-vertical>.btn+.btn-group,.btn-group-vertical>.btn-group+.btn,.btn-group-vertical>.btn-group+.btn-group{margin-top:-1px;margin-left:0}.btn-group-vertical>.btn:not(:first-child):not(:last-child){border-radius:0}.btn-group-vertical>.btn:first-child:not(:last-child){border-top-left-radius:4px;border-top-right-radius:4px;border-bottom-right-radius:0;border-bottom-left-radius:0}.btn-group-vertical>.btn:last-child:not(:first-child){border-top-left-radius:0;border-top-right-radius:0;border-bottom-right-radius:4px;border-bottom-left-radius:4px}.btn-group-vertical>.btn-group:not(:first-child):not(:last-child)>.btn{border-radius:0}.btn-group-vertical>.btn-group:first-child:not(:last-child)>.btn:last-child,.btn-group-vertical>.btn-group:first-child:not(:last-child)>.dropdown-toggle{border-bottom-right-radius:0;border-bottom-left-radius:0}.btn-group-vertical>.btn-group:last-child:not(:first-child)>.btn:first-child{border-top-left-radius:0;border-top-right-radius:0}.btn-group-justified{display:table;width:100%;table-layout:fixed;border-collapse:separate}.btn-group-justified>.btn,.btn-group-justified>.btn-group{display:table-cell;float:none;width:1%}.btn-group-justified>.btn-group .btn{width:100%}.btn-group-justified>.btn-group .dropdown-menu{left:auto}[data-toggle=buttons]>.btn input[type=checkbox],[data-toggle=buttons]>.btn input[type=radio],[data-toggle=buttons]>.btn-group>.btn input[type=checkbox],[data-toggle=buttons]>.btn-group>.btn input[type=radio]{position:absolute;clip:rect(0,0,0,0);pointer-events:none}.input-group{position:relative;display:table;border-collapse:separate}.input-group[class*=col-]{float:none;padding-right:0;padding-left:0}.input-group .form-control{position:relative;z-index:2;float:left;width:100%;margin-bottom:0}.input-group .form-control:focus{z-index:3}.input-group-lg>.form-control,.input-group-lg>.input-group-addon,.input-group-lg>.input-group-btn>.btn{height:46px;padding:10px 16px;font-size:18px;line-height:1.3333333;border-radius:6px}select.input-group-lg>.form-control,select.input-group-lg>.input-group-addon,select.input-group-lg>.input-group-btn>.btn{height:46px;line-height:46px}select[multiple].input-group-lg>.form-control,select[multiple].input-group-lg>.input-group-addon,select[multiple].input-group-lg>.input-group-btn>.btn,textarea.input-group-lg>.form-control,textarea.input-group-lg>.input-group-addon,textarea.input-group-lg>.input-group-btn>.btn{height:auto}.input-group-sm>.form-control,.input-group-sm>.input-group-addon,.input-group-sm>.input-group-btn>.btn{height:30px;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}select.input-group-sm>.form-control,select.input-group-sm>.input-group-addon,select.input-group-sm>.input-group-btn>.btn{height:30px;line-height:30px}select[multiple].input-group-sm>.form-control,select[multiple].input-group-sm>.input-group-addon,select[multiple].input-group-sm>.input-group-btn>.btn,textarea.input-group-sm>.form-control,textarea.input-group-sm>.input-group-addon,textarea.input-group-sm>.input-group-btn>.btn{height:auto}.input-group .form-control,.input-group-addon,.input-group-btn{display:table-cell}.input-group .form-control:not(:first-child):not(:last-child),.input-group-addon:not(:first-child):not(:last-child),.input-group-btn:not(:first-child):not(:last-child){border-radius:0}.input-group-addon,.input-group-btn{width:1%;white-space:nowrap;vertical-align:middle}.input-group-addon{padding:6px 12px;font-size:14px;font-weight:400;line-height:1;color:#555;text-align:center;background-color:#eee;border:1px solid #ccc;border-radius:4px}.input-group-addon.input-sm{padding:5px 10px;font-size:12px;border-radius:3px}.input-group-addon.input-lg{padding:10px 16px;font-size:18px;border-radius:6px}.input-group-addon input[type=checkbox],.input-group-addon input[type=radio]{margin-top:0}.input-group .form-control:first-child,.input-group-addon:first-child,.input-group-btn:first-child>.btn,.input-group-btn:first-child>.btn-group>.btn,.input-group-btn:first-child>.dropdown-toggle,.input-group-btn:last-child>.btn-group:not(:last-child)>.btn,.input-group-btn:last-child>.btn:not(:last-child):not(.dropdown-toggle){border-top-right-radius:0;border-bottom-right-radius:0}.input-group-addon:first-child{border-right:0}.input-group .form-control:last-child,.input-group-addon:last-child,.input-group-btn:first-child>.btn-group:not(:first-child)>.btn,.input-group-btn:first-child>.btn:not(:first-child),.input-group-btn:last-child>.btn,.input-group-btn:last-child>.btn-group>.btn,.input-group-btn:last-child>.dropdown-toggle{border-top-left-radius:0;border-bottom-left-radius:0}.input-group-addon:last-child{border-left:0}.input-group-btn{position:relative;font-size:0;white-space:nowrap}.input-group-btn>.btn{position:relative}.input-group-btn>.btn+.btn{margin-left:-1px}.input-group-btn>.btn:active,.input-group-btn>.btn:focus,.input-group-btn>.btn:hover{z-index:2}.input-group-btn:first-child>.btn,.input-group-btn:first-child>.btn-group{margin-right:-1px}.input-group-btn:last-child>.btn,.input-group-btn:last-child>.btn-group{z-index:2;margin-left:-1px}.nav{padding-left:0;margin-bottom:0;list-style:none}.nav>li{position:relative;display:block}.nav>li>a{position:relative;display:block;padding:10px 15px}.nav>li>a:focus,.nav>li>a:hover{text-decoration:none;background-color:#eee}.nav>li.disabled>a{color:#777}.nav>li.disabled>a:focus,.nav>li.disabled>a:hover{color:#777;text-decoration:none;cursor:not-allowed;background-color:transparent}.nav .open>a,.nav .open>a:focus,.nav .open>a:hover{background-color:#eee;border-color:#337ab7}.nav .nav-divider{height:1px;margin:9px 0;overflow:hidden;background-color:#e5e5e5}.nav>li>a>img{max-width:none}.nav-tabs{border-bottom:1px solid #ddd}.nav-tabs>li{float:left;margin-bottom:-1px}.nav-tabs>li>a{margin-right:2px;line-height:1.42857143;border:1px solid transparent;border-radius:4px 4px 0 0}.nav-tabs>li>a:hover{border-color:#eee #eee #ddd}.nav-tabs>li.active>a,.nav-tabs>li.active>a:focus,.nav-tabs>li.active>a:hover{color:#555;cursor:default;background-color:#fff;border:1px solid #ddd;border-bottom-color:transparent}.nav-tabs.nav-justified{width:100%;border-bottom:0}.nav-tabs.nav-justified>li{float:none}.nav-tabs.nav-justified>li>a{margin-bottom:5px;text-align:center}.nav-tabs.nav-justified>.dropdown .dropdown-menu{top:auto;left:auto}@media (min-width:768px){.nav-tabs.nav-justified>li{display:table-cell;width:1%}.nav-tabs.nav-justified>li>a{margin-bottom:0}}.nav-tabs.nav-justified>li>a{margin-right:0;border-radius:4px}.nav-tabs.nav-justified>.active>a,.nav-tabs.nav-justified>.active>a:focus,.nav-tabs.nav-justified>.active>a:hover{border:1px solid #ddd}@media (min-width:768px){.nav-tabs.nav-justified>li>a{border-bottom:1px solid #ddd;border-radius:4px 4px 0 0}.nav-tabs.nav-justified>.active>a,.nav-tabs.nav-justified>.active>a:focus,.nav-tabs.nav-justified>.active>a:hover{border-bottom-color:#fff}}.nav-pills>li{float:left}.nav-pills>li>a{border-radius:4px}.nav-pills>li+li{margin-left:2px}.nav-pills>li.active>a,.nav-pills>li.active>a:focus,.nav-pills>li.active>a:hover{color:#fff;background-color:#337ab7}.nav-stacked>li{float:none}.nav-stacked>li+li{margin-top:2px;margin-left:0}.nav-justified{width:100%}.nav-justified>li{float:none}.nav-justified>li>a{margin-bottom:5px;text-align:center}.nav-justified>.dropdown .dropdown-menu{top:auto;left:auto}@media (min-width:768px){.nav-justified>li{display:table-cell;width:1%}.nav-justified>li>a{margin-bottom:0}}.nav-tabs-justified{border-bottom:0}.nav-tabs-justified>li>a{margin-right:0;border-radius:4px}.nav-tabs-justified>.active>a,.nav-tabs-justified>.active>a:focus,.nav-tabs-justified>.active>a:hover{border:1px solid #ddd}@media (min-width:768px){.nav-tabs-justified>li>a{border-bottom:1px solid #ddd;border-radius:4px 4px 0 0}.nav-tabs-justified>.active>a,.nav-tabs-justified>.active>a:focus,.nav-tabs-justified>.active>a:hover{border-bottom-color:#fff}}.tab-content>.tab-pane{display:none}.tab-content>.active{display:block}.nav-tabs .dropdown-menu{margin-top:-1px;border-top-left-radius:0;border-top-right-radius:0}.navbar{position:relative;min-height:50px;margin-bottom:20px;border:1px solid transparent}@media (min-width:768px){.navbar{border-radius:4px}}@media (min-width:768px){.navbar-header{float:left}}.navbar-collapse{padding-right:15px;padding-left:15px;overflow-x:visible;-webkit-overflow-scrolling:touch;border-top:1px solid transparent;-webkit-box-shadow:inset 0 1px 0 rgba(255,255,255,.1);box-shadow:inset 0 1px 0 rgba(255,255,255,.1)}.navbar-collapse.in{overflow-y:auto}@media (min-width:768px){.navbar-collapse{width:auto;border-top:0;-webkit-box-shadow:none;box-shadow:none}.navbar-collapse.collapse{display:block!important;height:auto!important;padding-bottom:0;overflow:visible!important}.navbar-collapse.in{overflow-y:visible}.navbar-fixed-bottom .navbar-collapse,.navbar-fixed-top .navbar-collapse,.navbar-static-top .navbar-collapse{padding-right:0;padding-left:0}}.navbar-fixed-bottom .navbar-collapse,.navbar-fixed-top .navbar-collapse{max-height:340px}@media (max-device-width:480px) and (orientation:landscape){.navbar-fixed-bottom .navbar-collapse,.navbar-fixed-top .navbar-collapse{max-height:200px}}.container-fluid>.navbar-collapse,.container-fluid>.navbar-header,.container>.navbar-collapse,.container>.navbar-header{margin-right:-15px;margin-left:-15px}@media (min-width:768px){.container-fluid>.navbar-collapse,.container-fluid>.navbar-header,.container>.navbar-collapse,.container>.navbar-header{margin-right:0;margin-left:0}}.navbar-static-top{z-index:1000;border-width:0 0 1px}@media (min-width:768px){.navbar-static-top{border-radius:0}}.navbar-fixed-bottom,.navbar-fixed-top{position:fixed;right:0;left:0;z-index:1030}@media (min-width:768px){.navbar-fixed-bottom,.navbar-fixed-top{border-radius:0}}.navbar-fixed-top{top:0;border-width:0 0 1px}.navbar-fixed-bottom{bottom:0;margin-bottom:0;border-width:1px 0 0}.navbar-brand{float:left;height:50px;padding:15px 15px;font-size:18px;line-height:20px}.navbar-brand:focus,.navbar-brand:hover{text-decoration:none}.navbar-brand>img{display:block}@media (min-width:768px){.navbar>.container .navbar-brand,.navbar>.container-fluid .navbar-brand{margin-left:-15px}}.navbar-toggle{position:relative;float:right;padding:9px 10px;margin-top:8px;margin-right:15px;margin-bottom:8px;background-color:transparent;background-image:none;border:1px solid transparent;border-radius:4px}.navbar-toggle:focus{outline:0}.navbar-toggle .icon-bar{display:block;width:22px;height:2px;border-radius:1px}.navbar-toggle .icon-bar+.icon-bar{margin-top:4px}@media (min-width:768px){.navbar-toggle{display:none}}.navbar-nav{margin:7.5px -15px}.navbar-nav>li>a{padding-top:10px;padding-bottom:10px;line-height:20px}@media (max-width:767px){.navbar-nav .open .dropdown-menu{position:static;float:none;width:auto;margin-top:0;background-color:transparent;border:0;-webkit-box-shadow:none;box-shadow:none}.navbar-nav .open .dropdown-menu .dropdown-header,.navbar-nav .open .dropdown-menu>li>a{padding:5px 15px 5px 25px}.navbar-nav .open .dropdown-menu>li>a{line-height:20px}.navbar-nav .open .dropdown-menu>li>a:focus,.navbar-nav .open .dropdown-menu>li>a:hover{background-image:none}}@media (min-width:768px){.navbar-nav{float:left;margin:0}.navbar-nav>li{float:left}.navbar-nav>li>a{padding-top:15px;padding-bottom:15px}}.navbar-form{padding:10px 15px;margin-top:8px;margin-right:-15px;margin-bottom:8px;margin-left:-15px;border-top:1px solid transparent;border-bottom:1px solid transparent;-webkit-box-shadow:inset 0 1px 0 rgba(255,255,255,.1),0 1px 0 rgba(255,255,255,.1);box-shadow:inset 0 1px 0 rgba(255,255,255,.1),0 1px 0 rgba(255,255,255,.1)}@media (min-width:768px){.navbar-form .form-group{display:inline-block;margin-bottom:0;vertical-align:middle}.navbar-form .form-control{display:inline-block;width:auto;vertical-align:middle}.navbar-form .form-control-static{display:inline-block}.navbar-form .input-group{display:inline-table;vertical-align:middle}.navbar-form .input-group .form-control,.navbar-form .input-group .input-group-addon,.navbar-form .input-group .input-group-btn{width:auto}.navbar-form .input-group>.form-control{width:100%}.navbar-form .control-label{margin-bottom:0;vertical-align:middle}.navbar-form .checkbox,.navbar-form .radio{display:inline-block;margin-top:0;margin-bottom:0;vertical-align:middle}.navbar-form .checkbox label,.navbar-form .radio label{padding-left:0}.navbar-form .checkbox input[type=checkbox],.navbar-form .radio input[type=radio]{position:relative;margin-left:0}.navbar-form .has-feedback .form-control-feedback{top:0}}@media (max-width:767px){.navbar-form .form-group{margin-bottom:5px}.navbar-form .form-group:last-child{margin-bottom:0}}@media (min-width:768px){.navbar-form{width:auto;padding-top:0;padding-bottom:0;margin-right:0;margin-left:0;border:0;-webkit-box-shadow:none;box-shadow:none}}.navbar-nav>li>.dropdown-menu{margin-top:0;border-top-left-radius:0;border-top-right-radius:0}.navbar-fixed-bottom .navbar-nav>li>.dropdown-menu{margin-bottom:0;border-top-left-radius:4px;border-top-right-radius:4px;border-bottom-right-radius:0;border-bottom-left-radius:0}.navbar-btn{margin-top:8px;margin-bottom:8px}.navbar-btn.btn-sm{margin-top:10px;margin-bottom:10px}.navbar-btn.btn-xs{margin-top:14px;margin-bottom:14px}.navbar-text{margin-top:15px;margin-bottom:15px}@media (min-width:768px){.navbar-text{float:left;margin-right:15px;margin-left:15px}}@media (min-width:768px){.navbar-left{float:left!important}.navbar-right{float:right!important;margin-right:-15px}.navbar-right~.navbar-right{margin-right:0}}.navbar-default{background-color:#f8f8f8;border-color:#e7e7e7}.navbar-default .navbar-brand{color:#777}.navbar-default .navbar-brand:focus,.navbar-default .navbar-brand:hover{color:#5e5e5e;background-color:transparent}.navbar-default .navbar-text{color:#777}.navbar-default .navbar-nav>li>a{color:#777}.navbar-default .navbar-nav>li>a:focus,.navbar-default .navbar-nav>li>a:hover{color:#333;background-color:transparent}.navbar-default .navbar-nav>.active>a,.navbar-default .navbar-nav>.active>a:focus,.navbar-default .navbar-nav>.active>a:hover{color:#555;background-color:#e7e7e7}.navbar-default .navbar-nav>.disabled>a,.navbar-default .navbar-nav>.disabled>a:focus,.navbar-default .navbar-nav>.disabled>a:hover{color:#ccc;background-color:transparent}.navbar-default .navbar-toggle{border-color:#ddd}.navbar-default .navbar-toggle:focus,.navbar-default .navbar-toggle:hover{background-color:#ddd}.navbar-default .navbar-toggle .icon-bar{background-color:#888}.navbar-default .navbar-collapse,.navbar-default .navbar-form{border-color:#e7e7e7}.navbar-default .navbar-nav>.open>a,.navbar-default .navbar-nav>.open>a:focus,.navbar-default .navbar-nav>.open>a:hover{color:#555;background-color:#e7e7e7}@media (max-width:767px){.navbar-default .navbar-nav .open .dropdown-menu>li>a{color:#777}.navbar-default .navbar-nav .open .dropdown-menu>li>a:focus,.navbar-default .navbar-nav .open .dropdown-menu>li>a:hover{color:#333;background-color:transparent}.navbar-default .navbar-nav .open .dropdown-menu>.active>a,.navbar-default .navbar-nav .open .dropdown-menu>.active>a:focus,.navbar-default .navbar-nav .open .dropdown-menu>.active>a:hover{color:#555;background-color:#e7e7e7}.navbar-default .navbar-nav .open .dropdown-menu>.disabled>a,.navbar-default .navbar-nav .open .dropdown-menu>.disabled>a:focus,.navbar-default .navbar-nav .open .dropdown-menu>.disabled>a:hover{color:#ccc;background-color:transparent}}.navbar-default .navbar-link{color:#777}.navbar-default .navbar-link:hover{color:#333}.navbar-default .btn-link{color:#777}.navbar-default .btn-link:focus,.navbar-default .btn-link:hover{color:#333}.navbar-default .btn-link[disabled]:focus,.navbar-default .btn-link[disabled]:hover,fieldset[disabled] .navbar-default .btn-link:focus,fieldset[disabled] .navbar-default .btn-link:hover{color:#ccc}.navbar-inverse{background-color:#222;border-color:#080808}.navbar-inverse .navbar-brand{color:#9d9d9d}.navbar-inverse .navbar-brand:focus,.navbar-inverse .navbar-brand:hover{color:#fff;background-color:transparent}.navbar-inverse .navbar-text{color:#9d9d9d}.navbar-inverse .navbar-nav>li>a{color:#9d9d9d}.navbar-inverse .navbar-nav>li>a:focus,.navbar-inverse .navbar-nav>li>a:hover{color:#fff;background-color:transparent}.navbar-inverse .navbar-nav>.active>a,.navbar-inverse .navbar-nav>.active>a:focus,.navbar-inverse .navbar-nav>.active>a:hover{color:#fff;background-color:#080808}.navbar-inverse .navbar-nav>.disabled>a,.navbar-inverse .navbar-nav>.disabled>a:focus,.navbar-inverse .navbar-nav>.disabled>a:hover{color:#444;background-color:transparent}.navbar-inverse .navbar-toggle{border-color:#333}.navbar-inverse .navbar-toggle:focus,.navbar-inverse .navbar-toggle:hover{background-color:#333}.navbar-inverse .navbar-toggle .icon-bar{background-color:#fff}.navbar-inverse .navbar-collapse,.navbar-inverse .navbar-form{border-color:#101010}.navbar-inverse .navbar-nav>.open>a,.navbar-inverse .navbar-nav>.open>a:focus,.navbar-inverse .navbar-nav>.open>a:hover{color:#fff;background-color:#080808}@media (max-width:767px){.navbar-inverse .navbar-nav .open .dropdown-menu>.dropdown-header{border-color:#080808}.navbar-inverse .navbar-nav .open .dropdown-menu .divider{background-color:#080808}.navbar-inverse .navbar-nav .open .dropdown-menu>li>a{color:#9d9d9d}.navbar-inverse .navbar-nav .open .dropdown-menu>li>a:focus,.navbar-inverse .navbar-nav .open .dropdown-menu>li>a:hover{color:#fff;background-color:transparent}.navbar-inverse .navbar-nav .open .dropdown-menu>.active>a,.navbar-inverse .navbar-nav .open .dropdown-menu>.active>a:focus,.navbar-inverse .navbar-nav .open .dropdown-menu>.active>a:hover{color:#fff;background-color:#080808}.navbar-inverse .navbar-nav .open .dropdown-menu>.disabled>a,.navbar-inverse .navbar-nav .open .dropdown-menu>.disabled>a:focus,.navbar-inverse .navbar-nav .open .dropdown-menu>.disabled>a:hover{color:#444;background-color:transparent}}.navbar-inverse .navbar-link{color:#9d9d9d}.navbar-inverse .navbar-link:hover{color:#fff}.navbar-inverse .btn-link{color:#9d9d9d}.navbar-inverse .btn-link:focus,.navbar-inverse .btn-link:hover{color:#fff}.navbar-inverse .btn-link[disabled]:focus,.navbar-inverse .btn-link[disabled]:hover,fieldset[disabled] .navbar-inverse .btn-link:focus,fieldset[disabled] .navbar-inverse .btn-link:hover{color:#444}.breadcrumb{padding:8px 15px;margin-bottom:20px;list-style:none;background-color:#f5f5f5;border-radius:4px}.breadcrumb>li{display:inline-block}.breadcrumb>li+li:before{padding:0 5px;color:#ccc;content:"/\00a0"}.breadcrumb>.active{color:#777}.pagination{display:inline-block;padding-left:0;margin:20px 0;border-radius:4px}.pagination>li{display:inline}.pagination>li>a,.pagination>li>span{position:relative;float:left;padding:6px 12px;margin-left:-1px;line-height:1.42857143;color:#337ab7;text-decoration:none;background-color:#fff;border:1px solid #ddd}.pagination>li:first-child>a,.pagination>li:first-child>span{margin-left:0;border-top-left-radius:4px;border-bottom-left-radius:4px}.pagination>li:last-child>a,.pagination>li:last-child>span{border-top-right-radius:4px;border-bottom-right-radius:4px}.pagination>li>a:focus,.pagination>li>a:hover,.pagination>li>span:focus,.pagination>li>span:hover{z-index:2;color:#23527c;background-color:#eee;border-color:#ddd}.pagination>.active>a,.pagination>.active>a:focus,.pagination>.active>a:hover,.pagination>.active>span,.pagination>.active>span:focus,.pagination>.active>span:hover{z-index:3;color:#fff;cursor:default;background-color:#337ab7;border-color:#337ab7}.pagination>.disabled>a,.pagination>.disabled>a:focus,.pagination>.disabled>a:hover,.pagination>.disabled>span,.pagination>.disabled>span:focus,.pagination>.disabled>span:hover{color:#777;cursor:not-allowed;background-color:#fff;border-color:#ddd}.pagination-lg>li>a,.pagination-lg>li>span{padding:10px 16px;font-size:18px;line-height:1.3333333}.pagination-lg>li:first-child>a,.pagination-lg>li:first-child>span{border-top-left-radius:6px;border-bottom-left-radius:6px}.pagination-lg>li:last-child>a,.pagination-lg>li:last-child>span{border-top-right-radius:6px;border-bottom-right-radius:6px}.pagination-sm>li>a,.pagination-sm>li>span{padding:5px 10px;font-size:12px;line-height:1.5}.pagination-sm>li:first-child>a,.pagination-sm>li:first-child>span{border-top-left-radius:3px;border-bottom-left-radius:3px}.pagination-sm>li:last-child>a,.pagination-sm>li:last-child>span{border-top-right-radius:3px;border-bottom-right-radius:3px}.pager{padding-left:0;margin:20px 0;text-align:center;list-style:none}.pager li{display:inline}.pager li>a,.pager li>span{display:inline-block;padding:5px 14px;background-color:#fff;border:1px solid #ddd;border-radius:15px}.pager li>a:focus,.pager li>a:hover{text-decoration:none;background-color:#eee}.pager .next>a,.pager .next>span{float:right}.pager .previous>a,.pager .previous>span{float:left}.pager .disabled>a,.pager .disabled>a:focus,.pager .disabled>a:hover,.pager .disabled>span{color:#777;cursor:not-allowed;background-color:#fff}.label{display:inline;padding:.2em .6em .3em;font-size:75%;font-weight:700;line-height:1;color:#fff;text-align:center;white-space:nowrap;vertical-align:baseline;border-radius:.25em}a.label:focus,a.label:hover{color:#fff;text-decoration:none;cursor:pointer}.label:empty{display:none}.btn .label{position:relative;top:-1px}.label-default{background-color:#777}.label-default[href]:focus,.label-default[href]:hover{background-color:#5e5e5e}.label-primary{background-color:#337ab7}.label-primary[href]:focus,.label-primary[href]:hover{background-color:#286090}.label-success{background-color:#5cb85c}.label-success[href]:focus,.label-success[href]:hover{background-color:#449d44}.label-info{background-color:#5bc0de}.label-info[href]:focus,.label-info[href]:hover{background-color:#31b0d5}.label-warning{background-color:#f0ad4e}.label-warning[href]:focus,.label-warning[href]:hover{background-color:#ec971f}.label-danger{background-color:#d9534f}.label-danger[href]:focus,.label-danger[href]:hover{background-color:#c9302c}.badge{display:inline-block;min-width:10px;padding:3px 7px;font-size:12px;font-weight:700;line-height:1;color:#fff;text-align:center;white-space:nowrap;vertical-align:middle;background-color:#777;border-radius:10px}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.btn-group-xs>.btn .badge,.btn-xs .badge{top:0;padding:1px 5px}a.badge:focus,a.badge:hover{color:#fff;text-decoration:none;cursor:pointer}.list-group-item.active>.badge,.nav-pills>.active>a>.badge{color:#337ab7;background-color:#fff}.list-group-item>.badge{float:right}.list-group-item>.badge+.badge{margin-right:5px}.nav-pills>li>a>.badge{margin-left:3px}.jumbotron{padding-top:30px;padding-bottom:30px;margin-bottom:30px;color:inherit;background-color:#eee}.jumbotron .h1,.jumbotron h1{color:inherit}.jumbotron p{margin-bottom:15px;font-size:21px;font-weight:200}.jumbotron>hr{border-top-color:#d5d5d5}.container .jumbotron,.container-fluid .jumbotron{padding-right:15px;padding-left:15px;border-radius:6px}.jumbotron .container{max-width:100%}@media screen and (min-width:768px){.jumbotron{padding-top:48px;padding-bottom:48px}.container .jumbotron,.container-fluid .jumbotron{padding-right:60px;padding-left:60px}.jumbotron .h1,.jumbotron h1{font-size:63px}}.thumbnail{display:block;padding:4px;margin-bottom:20px;line-height:1.42857143;background-color:#fff;border:1px solid #ddd;border-radius:4px;-webkit-transition:border .2s ease-in-out;-o-transition:border .2s ease-in-out;transition:border .2s ease-in-out}.thumbnail a>img,.thumbnail>img{margin-right:auto;margin-left:auto}a.thumbnail.active,a.thumbnail:focus,a.thumbnail:hover{border-color:#337ab7}.thumbnail .caption{padding:9px;color:#333}.alert{padding:15px;margin-bottom:20px;border:1px solid transparent;border-radius:4px}.alert h4{margin-top:0;color:inherit}.alert .alert-link{font-weight:700}.alert>p,.alert>ul{margin-bottom:0}.alert>p+p{margin-top:5px}.alert-dismissable,.alert-dismissible{padding-right:35px}.alert-dismissable .close,.alert-dismissible .close{position:relative;top:-2px;right:-21px;color:inherit}.alert-success{color:#3c763d;background-color:#dff0d8;border-color:#d6e9c6}.alert-success hr{border-top-color:#c9e2b3}.alert-success .alert-link{color:#2b542c}.alert-info{color:#31708f;background-color:#d9edf7;border-color:#bce8f1}.alert-info hr{border-top-color:#a6e1ec}.alert-info .alert-link{color:#245269}.alert-warning{color:#8a6d3b;background-color:#fcf8e3;border-color:#faebcc}.alert-warning hr{border-top-color:#f7e1b5}.alert-warning .alert-link{color:#66512c}.alert-danger{color:#a94442;background-color:#f2dede;border-color:#ebccd1}.alert-danger hr{border-top-color:#e4b9c0}.alert-danger .alert-link{color:#843534}@-webkit-keyframes progress-bar-stripes{from{background-position:40px 0}to{background-position:0 0}}@-o-keyframes progress-bar-stripes{from{background-position:40px 0}to{background-position:0 0}}@keyframes progress-bar-stripes{from{background-position:40px 0}to{background-position:0 0}}.progress{height:20px;margin-bottom:20px;overflow:hidden;background-color:#f5f5f5;border-radius:4px;-webkit-box-shadow:inset 0 1px 2px rgba(0,0,0,.1);box-shadow:inset 0 1px 2px rgba(0,0,0,.1)}.progress-bar{float:left;width:0;height:100%;font-size:12px;line-height:20px;color:#fff;text-align:center;background-color:#337ab7;-webkit-box-shadow:inset 0 -1px 0 rgba(0,0,0,.15);box-shadow:inset 0 -1px 0 rgba(0,0,0,.15);-webkit-transition:width .6s ease;-o-transition:width .6s ease;transition:width .6s ease}.progress-bar-striped,.progress-striped .progress-bar{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);-webkit-background-size:40px 40px;background-size:40px 40px}.progress-bar.active,.progress.active .progress-bar{-webkit-animation:progress-bar-stripes 2s linear infinite;-o-animation:progress-bar-stripes 2s linear infinite;animation:progress-bar-stripes 2s linear infinite}.progress-bar-success{background-color:#5cb85c}.progress-striped .progress-bar-success{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent)}.progress-bar-info{background-color:#5bc0de}.progress-striped .progress-bar-info{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent)}.progress-bar-warning{background-color:#f0ad4e}.progress-striped .progress-bar-warning{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent)}.progress-bar-danger{background-color:#d9534f}.progress-striped .progress-bar-danger{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent)}.media{margin-top:15px}.media:first-child{margin-top:0}.media,.media-body{overflow:hidden;zoom:1}.media-body{width:10000px}.media-object{display:block}.media-object.img-thumbnail{max-width:none}.media-right,.media>.pull-right{padding-left:10px}.media-left,.media>.pull-left{padding-right:10px}.media-body,.media-left,.media-right{display:table-cell;vertical-align:top}.media-middle{vertical-align:middle}.media-bottom{vertical-align:bottom}.media-heading{margin-top:0;margin-bottom:5px}.media-list{padding-left:0;list-style:none}.list-group{padding-left:0;margin-bottom:20px}.list-group-item{position:relative;display:block;padding:10px 15px;margin-bottom:-1px;background-color:#fff;border:1px solid #ddd}.list-group-item:first-child{border-top-left-radius:4px;border-top-right-radius:4px}.list-group-item:last-child{margin-bottom:0;border-bottom-right-radius:4px;border-bottom-left-radius:4px}a.list-group-item,button.list-group-item{color:#555}a.list-group-item .list-group-item-heading,button.list-group-item .list-group-item-heading{color:#333}a.list-group-item:focus,a.list-group-item:hover,button.list-group-item:focus,button.list-group-item:hover{color:#555;text-decoration:none;background-color:#f5f5f5}button.list-group-item{width:100%;text-align:left}.list-group-item.disabled,.list-group-item.disabled:focus,.list-group-item.disabled:hover{color:#777;cursor:not-allowed;background-color:#eee}.list-group-item.disabled .list-group-item-heading,.list-group-item.disabled:focus .list-group-item-heading,.list-group-item.disabled:hover .list-group-item-heading{color:inherit}.list-group-item.disabled .list-group-item-text,.list-group-item.disabled:focus .list-group-item-text,.list-group-item.disabled:hover .list-group-item-text{color:#777}.list-group-item.active,.list-group-item.active:focus,.list-group-item.active:hover{z-index:2;color:#fff;background-color:#337ab7;border-color:#337ab7}.list-group-item.active .list-group-item-heading,.list-group-item.active .list-group-item-heading>.small,.list-group-item.active .list-group-item-heading>small,.list-group-item.active:focus .list-group-item-heading,.list-group-item.active:focus .list-group-item-heading>.small,.list-group-item.active:focus .list-group-item-heading>small,.list-group-item.active:hover .list-group-item-heading,.list-group-item.active:hover .list-group-item-heading>.small,.list-group-item.active:hover .list-group-item-heading>small{color:inherit}.list-group-item.active .list-group-item-text,.list-group-item.active:focus .list-group-item-text,.list-group-item.active:hover .list-group-item-text{color:#c7ddef}.list-group-item-success{color:#3c763d;background-color:#dff0d8}a.list-group-item-success,button.list-group-item-success{color:#3c763d}a.list-group-item-success .list-group-item-heading,button.list-group-item-success .list-group-item-heading{color:inherit}a.list-group-item-success:focus,a.list-group-item-success:hover,button.list-group-item-success:focus,button.list-group-item-success:hover{color:#3c763d;background-color:#d0e9c6}a.list-group-item-success.active,a.list-group-item-success.active:focus,a.list-group-item-success.active:hover,button.list-group-item-success.active,button.list-group-item-success.active:focus,button.list-group-item-success.active:hover{color:#fff;background-color:#3c763d;border-color:#3c763d}.list-group-item-info{color:#31708f;background-color:#d9edf7}a.list-group-item-info,button.list-group-item-info{color:#31708f}a.list-group-item-info .list-group-item-heading,button.list-group-item-info .list-group-item-heading{color:inherit}a.list-group-item-info:focus,a.list-group-item-info:hover,button.list-group-item-info:focus,button.list-group-item-info:hover{color:#31708f;background-color:#c4e3f3}a.list-group-item-info.active,a.list-group-item-info.active:focus,a.list-group-item-info.active:hover,button.list-group-item-info.active,button.list-group-item-info.active:focus,button.list-group-item-info.active:hover{color:#fff;background-color:#31708f;border-color:#31708f}.list-group-item-warning{color:#8a6d3b;background-color:#fcf8e3}a.list-group-item-warning,button.list-group-item-warning{color:#8a6d3b}a.list-group-item-warning .list-group-item-heading,button.list-group-item-warning .list-group-item-heading{color:inherit}a.list-group-item-warning:focus,a.list-group-item-warning:hover,button.list-group-item-warning:focus,button.list-group-item-warning:hover{color:#8a6d3b;background-color:#faf2cc}a.list-group-item-warning.active,a.list-group-item-warning.active:focus,a.list-group-item-warning.active:hover,button.list-group-item-warning.active,button.list-group-item-warning.active:focus,button.list-group-item-warning.active:hover{color:#fff;background-color:#8a6d3b;border-color:#8a6d3b}.list-group-item-danger{color:#a94442;background-color:#f2dede}a.list-group-item-danger,button.list-group-item-danger{color:#a94442}a.list-group-item-danger .list-group-item-heading,button.list-group-item-danger .list-group-item-heading{color:inherit}a.list-group-item-danger:focus,a.list-group-item-danger:hover,button.list-group-item-danger:focus,button.list-group-item-danger:hover{color:#a94442;background-color:#ebcccc}a.list-group-item-danger.active,a.list-group-item-danger.active:focus,a.list-group-item-danger.active:hover,button.list-group-item-danger.active,button.list-group-item-danger.active:focus,button.list-group-item-danger.active:hover{color:#fff;background-color:#a94442;border-color:#a94442}.list-group-item-heading{margin-top:0;margin-bottom:5px}.list-group-item-text{margin-bottom:0;line-height:1.3}.panel{margin-bottom:20px;background-color:#fff;border:1px solid transparent;border-radius:4px;-webkit-box-shadow:0 1px 1px rgba(0,0,0,.05);box-shadow:0 1px 1px rgba(0,0,0,.05)}.panel-body{padding:15px}.panel-heading{padding:10px 15px;border-bottom:1px solid transparent;border-top-left-radius:3px;border-top-right-radius:3px}.panel-heading>.dropdown .dropdown-toggle{color:inherit}.panel-title{margin-top:0;margin-bottom:0;font-size:16px;color:inherit}.panel-title>.small,.panel-title>.small>a,.panel-title>a,.panel-title>small,.panel-title>small>a{color:inherit}.panel-footer{padding:10px 15px;background-color:#f5f5f5;border-top:1px solid #ddd;border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel>.list-group,.panel>.panel-collapse>.list-group{margin-bottom:0}.panel>.list-group .list-group-item,.panel>.panel-collapse>.list-group .list-group-item{border-width:1px 0;border-radius:0}.panel>.list-group:first-child .list-group-item:first-child,.panel>.panel-collapse>.list-group:first-child .list-group-item:first-child{border-top:0;border-top-left-radius:3px;border-top-right-radius:3px}.panel>.list-group:last-child .list-group-item:last-child,.panel>.panel-collapse>.list-group:last-child .list-group-item:last-child{border-bottom:0;border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel>.panel-heading+.panel-collapse>.list-group .list-group-item:first-child{border-top-left-radius:0;border-top-right-radius:0}.panel-heading+.list-group .list-group-item:first-child{border-top-width:0}.list-group+.panel-footer{border-top-width:0}.panel>.panel-collapse>.table,.panel>.table,.panel>.table-responsive>.table{margin-bottom:0}.panel>.panel-collapse>.table caption,.panel>.table caption,.panel>.table-responsive>.table caption{padding-right:15px;padding-left:15px}.panel>.table-responsive:first-child>.table:first-child,.panel>.table:first-child{border-top-left-radius:3px;border-top-right-radius:3px}.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child,.panel>.table:first-child>tbody:first-child>tr:first-child,.panel>.table:first-child>thead:first-child>tr:first-child{border-top-left-radius:3px;border-top-right-radius:3px}.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child td:first-child,.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child th:first-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child td:first-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child th:first-child,.panel>.table:first-child>tbody:first-child>tr:first-child td:first-child,.panel>.table:first-child>tbody:first-child>tr:first-child th:first-child,.panel>.table:first-child>thead:first-child>tr:first-child td:first-child,.panel>.table:first-child>thead:first-child>tr:first-child th:first-child{border-top-left-radius:3px}.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child td:last-child,.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child th:last-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child td:last-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child th:last-child,.panel>.table:first-child>tbody:first-child>tr:first-child td:last-child,.panel>.table:first-child>tbody:first-child>tr:first-child th:last-child,.panel>.table:first-child>thead:first-child>tr:first-child td:last-child,.panel>.table:first-child>thead:first-child>tr:first-child th:last-child{border-top-right-radius:3px}.panel>.table-responsive:last-child>.table:last-child,.panel>.table:last-child{border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child,.panel>.table:last-child>tbody:last-child>tr:last-child,.panel>.table:last-child>tfoot:last-child>tr:last-child{border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child td:first-child,.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child th:first-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child td:first-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child th:first-child,.panel>.table:last-child>tbody:last-child>tr:last-child td:first-child,.panel>.table:last-child>tbody:last-child>tr:last-child th:first-child,.panel>.table:last-child>tfoot:last-child>tr:last-child td:first-child,.panel>.table:last-child>tfoot:last-child>tr:last-child th:first-child{border-bottom-left-radius:3px}.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child td:last-child,.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child th:last-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child td:last-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child th:last-child,.panel>.table:last-child>tbody:last-child>tr:last-child td:last-child,.panel>.table:last-child>tbody:last-child>tr:last-child th:last-child,.panel>.table:last-child>tfoot:last-child>tr:last-child td:last-child,.panel>.table:last-child>tfoot:last-child>tr:last-child th:last-child{border-bottom-right-radius:3px}.panel>.panel-body+.table,.panel>.panel-body+.table-responsive,.panel>.table+.panel-body,.panel>.table-responsive+.panel-body{border-top:1px solid #ddd}.panel>.table>tbody:first-child>tr:first-child td,.panel>.table>tbody:first-child>tr:first-child th{border-top:0}.panel>.table-bordered,.panel>.table-responsive>.table-bordered{border:0}.panel>.table-bordered>tbody>tr>td:first-child,.panel>.table-bordered>tbody>tr>th:first-child,.panel>.table-bordered>tfoot>tr>td:first-child,.panel>.table-bordered>tfoot>tr>th:first-child,.panel>.table-bordered>thead>tr>td:first-child,.panel>.table-bordered>thead>tr>th:first-child,.panel>.table-responsive>.table-bordered>tbody>tr>td:first-child,.panel>.table-responsive>.table-bordered>tbody>tr>th:first-child,.panel>.table-responsive>.table-bordered>tfoot>tr>td:first-child,.panel>.table-responsive>.table-bordered>tfoot>tr>th:first-child,.panel>.table-responsive>.table-bordered>thead>tr>td:first-child,.panel>.table-responsive>.table-bordered>thead>tr>th:first-child{border-left:0}.panel>.table-bordered>tbody>tr>td:last-child,.panel>.table-bordered>tbody>tr>th:last-child,.panel>.table-bordered>tfoot>tr>td:last-child,.panel>.table-bordered>tfoot>tr>th:last-child,.panel>.table-bordered>thead>tr>td:last-child,.panel>.table-bordered>thead>tr>th:last-child,.panel>.table-responsive>.table-bordered>tbody>tr>td:last-child,.panel>.table-responsive>.table-bordered>tbody>tr>th:last-child,.panel>.table-responsive>.table-bordered>tfoot>tr>td:last-child,.panel>.table-responsive>.table-bordered>tfoot>tr>th:last-child,.panel>.table-responsive>.table-bordered>thead>tr>td:last-child,.panel>.table-responsive>.table-bordered>thead>tr>th:last-child{border-right:0}.panel>.table-bordered>tbody>tr:first-child>td,.panel>.table-bordered>tbody>tr:first-child>th,.panel>.table-bordered>thead>tr:first-child>td,.panel>.table-bordered>thead>tr:first-child>th,.panel>.table-responsive>.table-bordered>tbody>tr:first-child>td,.panel>.table-responsive>.table-bordered>tbody>tr:first-child>th,.panel>.table-responsive>.table-bordered>thead>tr:first-child>td,.panel>.table-responsive>.table-bordered>thead>tr:first-child>th{border-bottom:0}.panel>.table-bordered>tbody>tr:last-child>td,.panel>.table-bordered>tbody>tr:last-child>th,.panel>.table-bordered>tfoot>tr:last-child>td,.panel>.table-bordered>tfoot>tr:last-child>th,.panel>.table-responsive>.table-bordered>tbody>tr:last-child>td,.panel>.table-responsive>.table-bordered>tbody>tr:last-child>th,.panel>.table-responsive>.table-bordered>tfoot>tr:last-child>td,.panel>.table-responsive>.table-bordered>tfoot>tr:last-child>th{border-bottom:0}.panel>.table-responsive{margin-bottom:0;border:0}.panel-group{margin-bottom:20px}.panel-group .panel{margin-bottom:0;border-radius:4px}.panel-group .panel+.panel{margin-top:5px}.panel-group .panel-heading{border-bottom:0}.panel-group .panel-heading+.panel-collapse>.list-group,.panel-group .panel-heading+.panel-collapse>.panel-body{border-top:1px solid #ddd}.panel-group .panel-footer{border-top:0}.panel-group .panel-footer+.panel-collapse .panel-body{border-bottom:1px solid #ddd}.panel-default{border-color:#ddd}.panel-default>.panel-heading{color:#333;background-color:#f5f5f5;border-color:#ddd}.panel-default>.panel-heading+.panel-collapse>.panel-body{border-top-color:#ddd}.panel-default>.panel-heading .badge{color:#f5f5f5;background-color:#333}.panel-default>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#ddd}.panel-primary{border-color:#337ab7}.panel-primary>.panel-heading{color:#fff;background-color:#337ab7;border-color:#337ab7}.panel-primary>.panel-heading+.panel-collapse>.panel-body{border-top-color:#337ab7}.panel-primary>.panel-heading .badge{color:#337ab7;background-color:#fff}.panel-primary>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#337ab7}.panel-success{border-color:#d6e9c6}.panel-success>.panel-heading{color:#3c763d;background-color:#dff0d8;border-color:#d6e9c6}.panel-success>.panel-heading+.panel-collapse>.panel-body{border-top-color:#d6e9c6}.panel-success>.panel-heading .badge{color:#dff0d8;background-color:#3c763d}.panel-success>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#d6e9c6}.panel-info{border-color:#bce8f1}.panel-info>.panel-heading{color:#31708f;background-color:#d9edf7;border-color:#bce8f1}.panel-info>.panel-heading+.panel-collapse>.panel-body{border-top-color:#bce8f1}.panel-info>.panel-heading .badge{color:#d9edf7;background-color:#31708f}.panel-info>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#bce8f1}.panel-warning{border-color:#faebcc}.panel-warning>.panel-heading{color:#8a6d3b;background-color:#fcf8e3;border-color:#faebcc}.panel-warning>.panel-heading+.panel-collapse>.panel-body{border-top-color:#faebcc}.panel-warning>.panel-heading .badge{color:#fcf8e3;background-color:#8a6d3b}.panel-warning>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#faebcc}.panel-danger{border-color:#ebccd1}.panel-danger>.panel-heading{color:#a94442;background-color:#f2dede;border-color:#ebccd1}.panel-danger>.panel-heading+.panel-collapse>.panel-body{border-top-color:#ebccd1}.panel-danger>.panel-heading .badge{color:#f2dede;background-color:#a94442}.panel-danger>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#ebccd1}.embed-responsive{position:relative;display:block;height:0;padding:0;overflow:hidden}.embed-responsive .embed-responsive-item,.embed-responsive embed,.embed-responsive iframe,.embed-responsive object,.embed-responsive video{position:absolute;top:0;bottom:0;left:0;width:100%;height:100%;border:0}.embed-responsive-16by9{padding-bottom:56.25%}.embed-responsive-4by3{padding-bottom:75%}.well{min-height:20px;padding:19px;margin-bottom:20px;background-color:#f5f5f5;border:1px solid #e3e3e3;border-radius:4px;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.05);box-shadow:inset 0 1px 1px rgba(0,0,0,.05)}.well blockquote{border-color:#ddd;border-color:rgba(0,0,0,.15)}.well-lg{padding:24px;border-radius:6px}.well-sm{padding:9px;border-radius:3px}.close{float:right;font-size:21px;font-weight:700;line-height:1;color:#000;text-shadow:0 1px 0 #fff;filter:alpha(opacity=20);opacity:.2}.close:focus,.close:hover{color:#000;text-decoration:none;cursor:pointer;filter:alpha(opacity=50);opacity:.5}button.close{-webkit-appearance:none;padding:0;cursor:pointer;background:0 0;border:0}.modal-open{overflow:hidden}.modal{position:fixed;top:0;right:0;bottom:0;left:0;z-index:1050;display:none;overflow:hidden;-webkit-overflow-scrolling:touch;outline:0}.modal.fade .modal-dialog{-webkit-transition:-webkit-transform .3s ease-out;-o-transition:-o-transform .3s ease-out;transition:transform .3s ease-out;-webkit-transform:translate(0,-25%);-ms-transform:translate(0,-25%);-o-transform:translate(0,-25%);transform:translate(0,-25%)}.modal.in .modal-dialog{-webkit-transform:translate(0,0);-ms-transform:translate(0,0);-o-transform:translate(0,0);transform:translate(0,0)}.modal-open .modal{overflow-x:hidden;overflow-y:auto}.modal-dialog{position:relative;width:auto;margin:10px}.modal-content{position:relative;background-color:#fff;-webkit-background-clip:padding-box;background-clip:padding-box;border:1px solid #999;border:1px solid rgba(0,0,0,.2);border-radius:6px;outline:0;-webkit-box-shadow:0 3px 9px rgba(0,0,0,.5);box-shadow:0 3px 9px rgba(0,0,0,.5)}.modal-backdrop{position:fixed;top:0;right:0;bottom:0;left:0;z-index:1040;background-color:#000}.modal-backdrop.fade{filter:alpha(opacity=0);opacity:0}.modal-backdrop.in{filter:alpha(opacity=50);opacity:.5}.modal-header{padding:15px;border-bottom:1px solid #e5e5e5}.modal-header .close{margin-top:-2px}.modal-title{margin:0;line-height:1.42857143}.modal-body{position:relative;padding:15px}.modal-footer{padding:15px;text-align:right;border-top:1px solid #e5e5e5}.modal-footer .btn+.btn{margin-bottom:0;margin-left:5px}.modal-footer .btn-group .btn+.btn{margin-left:-1px}.modal-footer .btn-block+.btn-block{margin-left:0}.modal-scrollbar-measure{position:absolute;top:-9999px;width:50px;height:50px;overflow:scroll}@media (min-width:768px){.modal-dialog{width:600px;margin:30px auto}.modal-content{-webkit-box-shadow:0 5px 15px rgba(0,0,0,.5);box-shadow:0 5px 15px rgba(0,0,0,.5)}.modal-sm{width:300px}}@media (min-width:992px){.modal-lg{width:900px}}.tooltip{position:absolute;z-index:1070;display:block;font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:12px;font-style:normal;font-weight:400;line-height:1.42857143;text-align:left;text-align:start;text-decoration:none;text-shadow:none;text-transform:none;letter-spacing:normal;word-break:normal;word-spacing:normal;word-wrap:normal;white-space:normal;filter:alpha(opacity=0);opacity:0;line-break:auto}.tooltip.in{filter:alpha(opacity=90);opacity:.9}.tooltip.top{padding:5px 0;margin-top:-3px}.tooltip.right{padding:0 5px;margin-left:3px}.tooltip.bottom{padding:5px 0;margin-top:3px}.tooltip.left{padding:0 5px;margin-left:-3px}.tooltip-inner{max-width:200px;padding:3px 8px;color:#fff;text-align:center;background-color:#000;border-radius:4px}.tooltip-arrow{position:absolute;width:0;height:0;border-color:transparent;border-style:solid}.tooltip.top .tooltip-arrow{bottom:0;left:50%;margin-left:-5px;border-width:5px 5px 0;border-top-color:#000}.tooltip.top-left .tooltip-arrow{right:5px;bottom:0;margin-bottom:-5px;border-width:5px 5px 0;border-top-color:#000}.tooltip.top-right .tooltip-arrow{bottom:0;left:5px;margin-bottom:-5px;border-width:5px 5px 0;border-top-color:#000}.tooltip.right .tooltip-arrow{top:50%;left:0;margin-top:-5px;border-width:5px 5px 5px 0;border-right-color:#000}.tooltip.left .tooltip-arrow{top:50%;right:0;margin-top:-5px;border-width:5px 0 5px 5px;border-left-color:#000}.tooltip.bottom .tooltip-arrow{top:0;left:50%;margin-left:-5px;border-width:0 5px 5px;border-bottom-color:#000}.tooltip.bottom-left .tooltip-arrow{top:0;right:5px;margin-top:-5px;border-width:0 5px 5px;border-bottom-color:#000}.tooltip.bottom-right .tooltip-arrow{top:0;left:5px;margin-top:-5px;border-width:0 5px 5px;border-bottom-color:#000}.popover{position:absolute;top:0;left:0;z-index:1060;display:none;max-width:276px;padding:1px;font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:14px;font-style:normal;font-weight:400;line-height:1.42857143;text-align:left;text-align:start;text-decoration:none;text-shadow:none;text-transform:none;letter-spacing:normal;word-break:normal;word-spacing:normal;word-wrap:normal;white-space:normal;background-color:#fff;-webkit-background-clip:padding-box;background-clip:padding-box;border:1px solid #ccc;border:1px solid rgba(0,0,0,.2);border-radius:6px;-webkit-box-shadow:0 5px 10px rgba(0,0,0,.2);box-shadow:0 5px 10px rgba(0,0,0,.2);line-break:auto}.popover.top{margin-top:-10px}.popover.right{margin-left:10px}.popover.bottom{margin-top:10px}.popover.left{margin-left:-10px}.popover-title{padding:8px 14px;margin:0;font-size:14px;background-color:#f7f7f7;border-bottom:1px solid #ebebeb;border-radius:5px 5px 0 0}.popover-content{padding:9px 14px}.popover>.arrow,.popover>.arrow:after{position:absolute;display:block;width:0;height:0;border-color:transparent;border-style:solid}.popover>.arrow{border-width:11px}.popover>.arrow:after{content:"";border-width:10px}.popover.top>.arrow{bottom:-11px;left:50%;margin-left:-11px;border-top-color:#999;border-top-color:rgba(0,0,0,.25);border-bottom-width:0}.popover.top>.arrow:after{bottom:1px;margin-left:-10px;content:" ";border-top-color:#fff;border-bottom-width:0}.popover.right>.arrow{top:50%;left:-11px;margin-top:-11px;border-right-color:#999;border-right-color:rgba(0,0,0,.25);border-left-width:0}.popover.right>.arrow:after{bottom:-10px;left:1px;content:" ";border-right-color:#fff;border-left-width:0}.popover.bottom>.arrow{top:-11px;left:50%;margin-left:-11px;border-top-width:0;border-bottom-color:#999;border-bottom-color:rgba(0,0,0,.25)}.popover.bottom>.arrow:after{top:1px;margin-left:-10px;content:" ";border-top-width:0;border-bottom-color:#fff}.popover.left>.arrow{top:50%;right:-11px;margin-top:-11px;border-right-width:0;border-left-color:#999;border-left-color:rgba(0,0,0,.25)}.popover.left>.arrow:after{right:1px;bottom:-10px;content:" ";border-right-width:0;border-left-color:#fff}.carousel{position:relative}.carousel-inner{position:relative;width:100%;overflow:hidden}.carousel-inner>.item{position:relative;display:none;-webkit-transition:.6s ease-in-out left;-o-transition:.6s ease-in-out left;transition:.6s ease-in-out left}.carousel-inner>.item>a>img,.carousel-inner>.item>img{line-height:1}@media all and (transform-3d),(-webkit-transform-3d){.carousel-inner>.item{-webkit-transition:-webkit-transform .6s ease-in-out;-o-transition:-o-transform .6s ease-in-out;transition:transform .6s ease-in-out;-webkit-backface-visibility:hidden;backface-visibility:hidden;-webkit-perspective:1000px;perspective:1000px}.carousel-inner>.item.active.right,.carousel-inner>.item.next{left:0;-webkit-transform:translate3d(100%,0,0);transform:translate3d(100%,0,0)}.carousel-inner>.item.active.left,.carousel-inner>.item.prev{left:0;-webkit-transform:translate3d(-100%,0,0);transform:translate3d(-100%,0,0)}.carousel-inner>.item.active,.carousel-inner>.item.next.left,.carousel-inner>.item.prev.right{left:0;-webkit-transform:translate3d(0,0,0);transform:translate3d(0,0,0)}}.carousel-inner>.active,.carousel-inner>.next,.carousel-inner>.prev{display:block}.carousel-inner>.active{left:0}.carousel-inner>.next,.carousel-inner>.prev{position:absolute;top:0;width:100%}.carousel-inner>.next{left:100%}.carousel-inner>.prev{left:-100%}.carousel-inner>.next.left,.carousel-inner>.prev.right{left:0}.carousel-inner>.active.left{left:-100%}.carousel-inner>.active.right{left:100%}.carousel-control{position:absolute;top:0;bottom:0;left:0;width:15%;font-size:20px;color:#fff;text-align:center;text-shadow:0 1px 2px rgba(0,0,0,.6);background-color:rgba(0,0,0,0);filter:alpha(opacity=50);opacity:.5}.carousel-control.left{background-image:-webkit-linear-gradient(left,rgba(0,0,0,.5) 0,rgba(0,0,0,.0001) 100%);background-image:-o-linear-gradient(left,rgba(0,0,0,.5) 0,rgba(0,0,0,.0001) 100%);background-image:-webkit-gradient(linear,left top,right top,from(rgba(0,0,0,.5)),to(rgba(0,0,0,.0001)));background-image:linear-gradient(to right,rgba(0,0,0,.5) 0,rgba(0,0,0,.0001) 100%);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#80000000', endColorstr='#00000000', GradientType=1);background-repeat:repeat-x}.carousel-control.right{right:0;left:auto;background-image:-webkit-linear-gradient(left,rgba(0,0,0,.0001) 0,rgba(0,0,0,.5) 100%);background-image:-o-linear-gradient(left,rgba(0,0,0,.0001) 0,rgba(0,0,0,.5) 100%);background-image:-webkit-gradient(linear,left top,right top,from(rgba(0,0,0,.0001)),to(rgba(0,0,0,.5)));background-image:linear-gradient(to right,rgba(0,0,0,.0001) 0,rgba(0,0,0,.5) 100%);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#00000000', endColorstr='#80000000', GradientType=1);background-repeat:repeat-x}.carousel-control:focus,.carousel-control:hover{color:#fff;text-decoration:none;filter:alpha(opacity=90);outline:0;opacity:.9}.carousel-control .glyphicon-chevron-left,.carousel-control .glyphicon-chevron-right,.carousel-control .icon-next,.carousel-control .icon-prev{position:absolute;top:50%;z-index:5;display:inline-block;margin-top:-10px}.carousel-control .glyphicon-chevron-left,.carousel-control .icon-prev{left:50%;margin-left:-10px}.carousel-control .glyphicon-chevron-right,.carousel-control .icon-next{right:50%;margin-right:-10px}.carousel-control .icon-next,.carousel-control .icon-prev{width:20px;height:20px;font-family:serif;line-height:1}.carousel-control .icon-prev:before{content:'\2039'}.carousel-control .icon-next:before{content:'\203a'}.carousel-indicators{position:absolute;bottom:10px;left:50%;z-index:15;width:60%;padding-left:0;margin-left:-30%;text-align:center;list-style:none}.carousel-indicators li{display:inline-block;width:10px;height:10px;margin:1px;text-indent:-999px;cursor:pointer;background-color:#000\9;background-color:rgba(0,0,0,0);border:1px solid #fff;border-radius:10px}.carousel-indicators .active{width:12px;height:12px;margin:0;background-color:#fff}.carousel-caption{position:absolute;right:15%;bottom:20px;left:15%;z-index:10;padding-top:20px;padding-bottom:20px;color:#fff;text-align:center;text-shadow:0 1px 2px rgba(0,0,0,.6)}.carousel-caption .btn{text-shadow:none}@media screen and (min-width:768px){.carousel-control .glyphicon-chevron-left,.carousel-control .glyphicon-chevron-right,.carousel-control .icon-next,.carousel-control .icon-prev{width:30px;height:30px;margin-top:-10px;font-size:30px}.carousel-control .glyphicon-chevron-left,.carousel-control .icon-prev{margin-left:-10px}.carousel-control .glyphicon-chevron-right,.carousel-control .icon-next{margin-right:-10px}.carousel-caption{right:20%;left:20%;padding-bottom:30px}.carousel-indicators{bottom:20px}}.btn-group-vertical>.btn-group:after,.btn-group-vertical>.btn-group:before,.btn-toolbar:after,.btn-toolbar:before,.clearfix:after,.clearfix:before,.container-fluid:after,.container-fluid:before,.container:after,.container:before,.dl-horizontal dd:after,.dl-horizontal dd:before,.form-horizontal .form-group:after,.form-horizontal .form-group:before,.modal-footer:after,.modal-footer:before,.modal-header:after,.modal-header:before,.nav:after,.nav:before,.navbar-collapse:after,.navbar-collapse:before,.navbar-header:after,.navbar-header:before,.navbar:after,.navbar:before,.pager:after,.pager:before,.panel-body:after,.panel-body:before,.row:after,.row:before{display:table;content:" "}.btn-group-vertical>.btn-group:after,.btn-toolbar:after,.clearfix:after,.container-fluid:after,.container:after,.dl-horizontal dd:after,.form-horizontal .form-group:after,.modal-footer:after,.modal-header:after,.nav:after,.navbar-collapse:after,.navbar-header:after,.navbar:after,.pager:after,.panel-body:after,.row:after{clear:both}.center-block{display:block;margin-right:auto;margin-left:auto}.pull-right{float:right!important}.pull-left{float:left!important}.hide{display:none!important}.show{display:block!important}.invisible{visibility:hidden}.text-hide{font:0/0 a;color:transparent;text-shadow:none;background-color:transparent;border:0}.hidden{display:none!important}.affix{position:fixed}@-ms-viewport{width:device-width}.visible-lg,.visible-md,.visible-sm,.visible-xs{display:none!important}.visible-lg-block,.visible-lg-inline,.visible-lg-inline-block,.visible-md-block,.visible-md-inline,.visible-md-inline-block,.visible-sm-block,.visible-sm-inline,.visible-sm-inline-block,.visible-xs-block,.visible-xs-inline,.visible-xs-inline-block{display:none!important}@media (max-width:767px){.visible-xs{display:block!important}table.visible-xs{display:table!important}tr.visible-xs{display:table-row!important}td.visible-xs,th.visible-xs{display:table-cell!important}}@media (max-width:767px){.visible-xs-block{display:block!important}}@media (max-width:767px){.visible-xs-inline{display:inline!important}}@media (max-width:767px){.visible-xs-inline-block{display:inline-block!important}}@media (min-width:768px) and (max-width:991px){.visible-sm{display:block!important}table.visible-sm{display:table!important}tr.visible-sm{display:table-row!important}td.visible-sm,th.visible-sm{display:table-cell!important}}@media (min-width:768px) and (max-width:991px){.visible-sm-block{display:block!important}}@media (min-width:768px) and (max-width:991px){.visible-sm-inline{display:inline!important}}@media (min-width:768px) and (max-width:991px){.visible-sm-inline-block{display:inline-block!important}}@media (min-width:992px) and (max-width:1199px){.visible-md{display:block!important}table.visible-md{display:table!important}tr.visible-md{display:table-row!important}td.visible-md,th.visible-md{display:table-cell!important}}@media (min-width:992px) and (max-width:1199px){.visible-md-block{display:block!important}}@media (min-width:992px) and (max-width:1199px){.visible-md-inline{display:inline!important}}@media (min-width:992px) and (max-width:1199px){.visible-md-inline-block{display:inline-block!important}}@media (min-width:1200px){.visible-lg{display:block!important}table.visible-lg{display:table!important}tr.visible-lg{display:table-row!important}td.visible-lg,th.visible-lg{display:table-cell!important}}@media (min-width:1200px){.visible-lg-block{display:block!important}}@media (min-width:1200px){.visible-lg-inline{display:inline!important}}@media (min-width:1200px){.visible-lg-inline-block{display:inline-block!important}}@media (max-width:767px){.hidden-xs{display:none!important}}@media (min-width:768px) and (max-width:991px){.hidden-sm{display:none!important}}@media (min-width:992px) and (max-width:1199px){.hidden-md{display:none!important}}@media (min-width:1200px){.hidden-lg{display:none!important}}.visible-print{display:none!important}@media print{.visible-print{display:block!important}table.visible-print{display:table!important}tr.visible-print{display:table-row!important}td.visible-print,th.visible-print{display:table-cell!important}}.visible-print-block{display:none!important}@media print{.visible-print-block{display:block!important}}.visible-print-inline{display:none!important}@media print{.visible-print-inline{display:inline!important}}.visible-print-inline-block{display:none!important}@media print{.visible-print-inline-block{display:inline-block!important}}@media print{.hidden-print{display:none!important}} +/*# sourceMappingURL=bootstrap.min.css.map */ \ No newline at end of file diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/css/font-awesome.css b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/css/font-awesome.css new file mode 100755 index 0000000000000..ee906a8196d0f --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/css/font-awesome.css @@ -0,0 +1,2337 @@ +/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */ +/* FONT PATH + * -------------------------- */ +@font-face { + font-family: 'FontAwesome'; + src: url('../fonts/fontawesome-webfont.eot?v=4.7.0'); + src: url('../fonts/fontawesome-webfont.eot?#iefix&v=4.7.0') format('embedded-opentype'), url('../fonts/fontawesome-webfont.woff2?v=4.7.0') format('woff2'), url('../fonts/fontawesome-webfont.woff?v=4.7.0') format('woff'), url('../fonts/fontawesome-webfont.ttf?v=4.7.0') format('truetype'), url('../fonts/fontawesome-webfont.svg?v=4.7.0#fontawesomeregular') format('svg'); + font-weight: normal; + font-style: normal; +} +.fa { + display: inline-block; + font: normal normal normal 14px/1 FontAwesome; + font-size: inherit; + text-rendering: auto; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; +} +/* makes the font 33% larger relative to the icon container */ +.fa-lg { + font-size: 1.33333333em; + line-height: 0.75em; + vertical-align: -15%; +} +.fa-2x { + font-size: 2em; +} +.fa-3x { + font-size: 3em; +} +.fa-4x { + font-size: 4em; +} +.fa-5x { + font-size: 5em; +} +.fa-fw { + width: 1.28571429em; + text-align: center; +} +.fa-ul { + padding-left: 0; + margin-left: 2.14285714em; + list-style-type: none; +} +.fa-ul > li { + position: relative; +} +.fa-li { + position: absolute; + left: -2.14285714em; + width: 2.14285714em; + top: 0.14285714em; + text-align: center; +} +.fa-li.fa-lg { + left: -1.85714286em; +} +.fa-border { + padding: .2em .25em .15em; + border: solid 0.08em #eeeeee; + border-radius: .1em; +} +.fa-pull-left { + float: left; +} +.fa-pull-right { + float: right; +} +.fa.fa-pull-left { + margin-right: .3em; +} +.fa.fa-pull-right { + margin-left: .3em; +} +/* Deprecated as of 4.4.0 */ +.pull-right { + float: right; +} +.pull-left { + float: left; +} +.fa.pull-left { + margin-right: .3em; +} +.fa.pull-right { + margin-left: .3em; +} +.fa-spin { + -webkit-animation: fa-spin 2s infinite linear; + animation: fa-spin 2s infinite linear; +} +.fa-pulse { + -webkit-animation: fa-spin 1s infinite steps(8); + animation: fa-spin 1s infinite steps(8); +} +@-webkit-keyframes fa-spin { + 0% { + -webkit-transform: rotate(0deg); + transform: rotate(0deg); + } + 100% { + -webkit-transform: rotate(359deg); + transform: rotate(359deg); + } +} +@keyframes fa-spin { + 0% { + -webkit-transform: rotate(0deg); + transform: rotate(0deg); + } + 100% { + -webkit-transform: rotate(359deg); + transform: rotate(359deg); + } +} +.fa-rotate-90 { + -ms-filter: "progid:DXImageTransform.Microsoft.BasicImage(rotation=1)"; + -webkit-transform: rotate(90deg); + -ms-transform: rotate(90deg); + transform: rotate(90deg); +} +.fa-rotate-180 { + -ms-filter: "progid:DXImageTransform.Microsoft.BasicImage(rotation=2)"; + -webkit-transform: rotate(180deg); + -ms-transform: rotate(180deg); + transform: rotate(180deg); +} +.fa-rotate-270 { + -ms-filter: "progid:DXImageTransform.Microsoft.BasicImage(rotation=3)"; + -webkit-transform: rotate(270deg); + -ms-transform: rotate(270deg); + transform: rotate(270deg); +} +.fa-flip-horizontal { + -ms-filter: "progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)"; + -webkit-transform: scale(-1, 1); + -ms-transform: scale(-1, 1); + transform: scale(-1, 1); +} +.fa-flip-vertical { + -ms-filter: "progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)"; + -webkit-transform: scale(1, -1); + -ms-transform: scale(1, -1); + transform: scale(1, -1); +} +:root .fa-rotate-90, +:root .fa-rotate-180, +:root .fa-rotate-270, +:root .fa-flip-horizontal, +:root .fa-flip-vertical { + filter: none; +} +.fa-stack { + position: relative; + display: inline-block; + width: 2em; + height: 2em; + line-height: 2em; + vertical-align: middle; +} +.fa-stack-1x, +.fa-stack-2x { + position: absolute; + left: 0; + width: 100%; + text-align: center; +} +.fa-stack-1x { + line-height: inherit; +} +.fa-stack-2x { + font-size: 2em; +} +.fa-inverse { + color: #ffffff; +} +/* Font Awesome uses the Unicode Private Use Area (PUA) to ensure screen + readers do not read off random characters that represent icons */ +.fa-glass:before { + content: "\f000"; +} +.fa-music:before { + content: "\f001"; +} +.fa-search:before { + content: "\f002"; +} +.fa-envelope-o:before { + content: "\f003"; +} +.fa-heart:before { + content: "\f004"; +} +.fa-star:before { + content: "\f005"; +} +.fa-star-o:before { + content: "\f006"; +} +.fa-user:before { + content: "\f007"; +} +.fa-film:before { + content: "\f008"; +} +.fa-th-large:before { + content: "\f009"; +} +.fa-th:before { + content: "\f00a"; +} +.fa-th-list:before { + content: "\f00b"; +} +.fa-check:before { + content: "\f00c"; +} +.fa-remove:before, +.fa-close:before, +.fa-times:before { + content: "\f00d"; +} +.fa-search-plus:before { + content: "\f00e"; +} +.fa-search-minus:before { + content: "\f010"; +} +.fa-power-off:before { + content: "\f011"; +} +.fa-signal:before { + content: "\f012"; +} +.fa-gear:before, +.fa-cog:before { + content: "\f013"; +} +.fa-trash-o:before { + content: "\f014"; +} +.fa-home:before { + content: "\f015"; +} +.fa-file-o:before { + content: "\f016"; +} +.fa-clock-o:before { + content: "\f017"; +} +.fa-road:before { + content: "\f018"; +} +.fa-download:before { + content: "\f019"; +} +.fa-arrow-circle-o-down:before { + content: "\f01a"; +} +.fa-arrow-circle-o-up:before { + content: "\f01b"; +} +.fa-inbox:before { + content: "\f01c"; +} +.fa-play-circle-o:before { + content: "\f01d"; +} +.fa-rotate-right:before, +.fa-repeat:before { + content: "\f01e"; +} +.fa-refresh:before { + content: "\f021"; +} +.fa-list-alt:before { + content: "\f022"; +} +.fa-lock:before { + content: "\f023"; +} +.fa-flag:before { + content: "\f024"; +} +.fa-headphones:before { + content: "\f025"; +} +.fa-volume-off:before { + content: "\f026"; +} +.fa-volume-down:before { + content: "\f027"; +} +.fa-volume-up:before { + content: "\f028"; +} +.fa-qrcode:before { + content: "\f029"; +} +.fa-barcode:before { + content: "\f02a"; +} +.fa-tag:before { + content: "\f02b"; +} +.fa-tags:before { + content: "\f02c"; +} +.fa-book:before { + content: "\f02d"; +} +.fa-bookmark:before { + content: "\f02e"; +} +.fa-print:before { + content: "\f02f"; +} +.fa-camera:before { + content: "\f030"; +} +.fa-font:before { + content: "\f031"; +} +.fa-bold:before { + content: "\f032"; +} +.fa-italic:before { + content: "\f033"; +} +.fa-text-height:before { + content: "\f034"; +} +.fa-text-width:before { + content: "\f035"; +} +.fa-align-left:before { + content: "\f036"; +} +.fa-align-center:before { + content: "\f037"; +} +.fa-align-right:before { + content: "\f038"; +} +.fa-align-justify:before { + content: "\f039"; +} +.fa-list:before { + content: "\f03a"; +} +.fa-dedent:before, +.fa-outdent:before { + content: "\f03b"; +} +.fa-indent:before { + content: "\f03c"; +} +.fa-video-camera:before { + content: "\f03d"; +} +.fa-photo:before, +.fa-image:before, +.fa-picture-o:before { + content: "\f03e"; +} +.fa-pencil:before { + content: "\f040"; +} +.fa-map-marker:before { + content: "\f041"; +} +.fa-adjust:before { + content: "\f042"; +} +.fa-tint:before { + content: "\f043"; +} +.fa-edit:before, +.fa-pencil-square-o:before { + content: "\f044"; +} +.fa-share-square-o:before { + content: "\f045"; +} +.fa-check-square-o:before { + content: "\f046"; +} +.fa-arrows:before { + content: "\f047"; +} +.fa-step-backward:before { + content: "\f048"; +} +.fa-fast-backward:before { + content: "\f049"; +} +.fa-backward:before { + content: "\f04a"; +} +.fa-play:before { + content: "\f04b"; +} +.fa-pause:before { + content: "\f04c"; +} +.fa-stop:before { + content: "\f04d"; +} +.fa-forward:before { + content: "\f04e"; +} +.fa-fast-forward:before { + content: "\f050"; +} +.fa-step-forward:before { + content: "\f051"; +} +.fa-eject:before { + content: "\f052"; +} +.fa-chevron-left:before { + content: "\f053"; +} +.fa-chevron-right:before { + content: "\f054"; +} +.fa-plus-circle:before { + content: "\f055"; +} +.fa-minus-circle:before { + content: "\f056"; +} +.fa-times-circle:before { + content: "\f057"; +} +.fa-check-circle:before { + content: "\f058"; +} +.fa-question-circle:before { + content: "\f059"; +} +.fa-info-circle:before { + content: "\f05a"; +} +.fa-crosshairs:before { + content: "\f05b"; +} +.fa-times-circle-o:before { + content: "\f05c"; +} +.fa-check-circle-o:before { + content: "\f05d"; +} +.fa-ban:before { + content: "\f05e"; +} +.fa-arrow-left:before { + content: "\f060"; +} +.fa-arrow-right:before { + content: "\f061"; +} +.fa-arrow-up:before { + content: "\f062"; +} +.fa-arrow-down:before { + content: "\f063"; +} +.fa-mail-forward:before, +.fa-share:before { + content: "\f064"; +} +.fa-expand:before { + content: "\f065"; +} +.fa-compress:before { + content: "\f066"; +} +.fa-plus:before { + content: "\f067"; +} +.fa-minus:before { + content: "\f068"; +} +.fa-asterisk:before { + content: "\f069"; +} +.fa-exclamation-circle:before { + content: "\f06a"; +} +.fa-gift:before { + content: "\f06b"; +} +.fa-leaf:before { + content: "\f06c"; +} +.fa-fire:before { + content: "\f06d"; +} +.fa-eye:before { + content: "\f06e"; +} +.fa-eye-slash:before { + content: "\f070"; +} +.fa-warning:before, +.fa-exclamation-triangle:before { + content: "\f071"; +} +.fa-plane:before { + content: "\f072"; +} +.fa-calendar:before { + content: "\f073"; +} +.fa-random:before { + content: "\f074"; +} +.fa-comment:before { + content: "\f075"; +} +.fa-magnet:before { + content: "\f076"; +} +.fa-chevron-up:before { + content: "\f077"; +} +.fa-chevron-down:before { + content: "\f078"; +} +.fa-retweet:before { + content: "\f079"; +} +.fa-shopping-cart:before { + content: "\f07a"; +} +.fa-folder:before { + content: "\f07b"; +} +.fa-folder-open:before { + content: "\f07c"; +} +.fa-arrows-v:before { + content: "\f07d"; +} +.fa-arrows-h:before { + content: "\f07e"; +} +.fa-bar-chart-o:before, +.fa-bar-chart:before { + content: "\f080"; +} +.fa-twitter-square:before { + content: "\f081"; +} +.fa-facebook-square:before { + content: "\f082"; +} +.fa-camera-retro:before { + content: "\f083"; +} +.fa-key:before { + content: "\f084"; +} +.fa-gears:before, +.fa-cogs:before { + content: "\f085"; +} +.fa-comments:before { + content: "\f086"; +} +.fa-thumbs-o-up:before { + content: "\f087"; +} +.fa-thumbs-o-down:before { + content: "\f088"; +} +.fa-star-half:before { + content: "\f089"; +} +.fa-heart-o:before { + content: "\f08a"; +} +.fa-sign-out:before { + content: "\f08b"; +} +.fa-linkedin-square:before { + content: "\f08c"; +} +.fa-thumb-tack:before { + content: "\f08d"; +} +.fa-external-link:before { + content: "\f08e"; +} +.fa-sign-in:before { + content: "\f090"; +} +.fa-trophy:before { + content: "\f091"; +} +.fa-github-square:before { + content: "\f092"; +} +.fa-upload:before { + content: "\f093"; +} +.fa-lemon-o:before { + content: "\f094"; +} +.fa-phone:before { + content: "\f095"; +} +.fa-square-o:before { + content: "\f096"; +} +.fa-bookmark-o:before { + content: "\f097"; +} +.fa-phone-square:before { + content: "\f098"; +} +.fa-twitter:before { + content: "\f099"; +} +.fa-facebook-f:before, +.fa-facebook:before { + content: "\f09a"; +} +.fa-github:before { + content: "\f09b"; +} +.fa-unlock:before { + content: "\f09c"; +} +.fa-credit-card:before { + content: "\f09d"; +} +.fa-feed:before, +.fa-rss:before { + content: "\f09e"; +} +.fa-hdd-o:before { + content: "\f0a0"; +} +.fa-bullhorn:before { + content: "\f0a1"; +} +.fa-bell:before { + content: "\f0f3"; +} +.fa-certificate:before { + content: "\f0a3"; +} +.fa-hand-o-right:before { + content: "\f0a4"; +} +.fa-hand-o-left:before { + content: "\f0a5"; +} +.fa-hand-o-up:before { + content: "\f0a6"; +} +.fa-hand-o-down:before { + content: "\f0a7"; +} +.fa-arrow-circle-left:before { + content: "\f0a8"; +} +.fa-arrow-circle-right:before { + content: "\f0a9"; +} +.fa-arrow-circle-up:before { + content: "\f0aa"; +} +.fa-arrow-circle-down:before { + content: "\f0ab"; +} +.fa-globe:before { + content: "\f0ac"; +} +.fa-wrench:before { + content: "\f0ad"; +} +.fa-tasks:before { + content: "\f0ae"; +} +.fa-filter:before { + content: "\f0b0"; +} +.fa-briefcase:before { + content: "\f0b1"; +} +.fa-arrows-alt:before { + content: "\f0b2"; +} +.fa-group:before, +.fa-users:before { + content: "\f0c0"; +} +.fa-chain:before, +.fa-link:before { + content: "\f0c1"; +} +.fa-cloud:before { + content: "\f0c2"; +} +.fa-flask:before { + content: "\f0c3"; +} +.fa-cut:before, +.fa-scissors:before { + content: "\f0c4"; +} +.fa-copy:before, +.fa-files-o:before { + content: "\f0c5"; +} +.fa-paperclip:before { + content: "\f0c6"; +} +.fa-save:before, +.fa-floppy-o:before { + content: "\f0c7"; +} +.fa-square:before { + content: "\f0c8"; +} +.fa-navicon:before, +.fa-reorder:before, +.fa-bars:before { + content: "\f0c9"; +} +.fa-list-ul:before { + content: "\f0ca"; +} +.fa-list-ol:before { + content: "\f0cb"; +} +.fa-strikethrough:before { + content: "\f0cc"; +} +.fa-underline:before { + content: "\f0cd"; +} +.fa-table:before { + content: "\f0ce"; +} +.fa-magic:before { + content: "\f0d0"; +} +.fa-truck:before { + content: "\f0d1"; +} +.fa-pinterest:before { + content: "\f0d2"; +} +.fa-pinterest-square:before { + content: "\f0d3"; +} +.fa-google-plus-square:before { + content: "\f0d4"; +} +.fa-google-plus:before { + content: "\f0d5"; +} +.fa-money:before { + content: "\f0d6"; +} +.fa-caret-down:before { + content: "\f0d7"; +} +.fa-caret-up:before { + content: "\f0d8"; +} +.fa-caret-left:before { + content: "\f0d9"; +} +.fa-caret-right:before { + content: "\f0da"; +} +.fa-columns:before { + content: "\f0db"; +} +.fa-unsorted:before, +.fa-sort:before { + content: "\f0dc"; +} +.fa-sort-down:before, +.fa-sort-desc:before { + content: "\f0dd"; +} +.fa-sort-up:before, +.fa-sort-asc:before { + content: "\f0de"; +} +.fa-envelope:before { + content: "\f0e0"; +} +.fa-linkedin:before { + content: "\f0e1"; +} +.fa-rotate-left:before, +.fa-undo:before { + content: "\f0e2"; +} +.fa-legal:before, +.fa-gavel:before { + content: "\f0e3"; +} +.fa-dashboard:before, +.fa-tachometer:before { + content: "\f0e4"; +} +.fa-comment-o:before { + content: "\f0e5"; +} +.fa-comments-o:before { + content: "\f0e6"; +} +.fa-flash:before, +.fa-bolt:before { + content: "\f0e7"; +} +.fa-sitemap:before { + content: "\f0e8"; +} +.fa-umbrella:before { + content: "\f0e9"; +} +.fa-paste:before, +.fa-clipboard:before { + content: "\f0ea"; +} +.fa-lightbulb-o:before { + content: "\f0eb"; +} +.fa-exchange:before { + content: "\f0ec"; +} +.fa-cloud-download:before { + content: "\f0ed"; +} +.fa-cloud-upload:before { + content: "\f0ee"; +} +.fa-user-md:before { + content: "\f0f0"; +} +.fa-stethoscope:before { + content: "\f0f1"; +} +.fa-suitcase:before { + content: "\f0f2"; +} +.fa-bell-o:before { + content: "\f0a2"; +} +.fa-coffee:before { + content: "\f0f4"; +} +.fa-cutlery:before { + content: "\f0f5"; +} +.fa-file-text-o:before { + content: "\f0f6"; +} +.fa-building-o:before { + content: "\f0f7"; +} +.fa-hospital-o:before { + content: "\f0f8"; +} +.fa-ambulance:before { + content: "\f0f9"; +} +.fa-medkit:before { + content: "\f0fa"; +} +.fa-fighter-jet:before { + content: "\f0fb"; +} +.fa-beer:before { + content: "\f0fc"; +} +.fa-h-square:before { + content: "\f0fd"; +} +.fa-plus-square:before { + content: "\f0fe"; +} +.fa-angle-double-left:before { + content: "\f100"; +} +.fa-angle-double-right:before { + content: "\f101"; +} +.fa-angle-double-up:before { + content: "\f102"; +} +.fa-angle-double-down:before { + content: "\f103"; +} +.fa-angle-left:before { + content: "\f104"; +} +.fa-angle-right:before { + content: "\f105"; +} +.fa-angle-up:before { + content: "\f106"; +} +.fa-angle-down:before { + content: "\f107"; +} +.fa-desktop:before { + content: "\f108"; +} +.fa-laptop:before { + content: "\f109"; +} +.fa-tablet:before { + content: "\f10a"; +} +.fa-mobile-phone:before, +.fa-mobile:before { + content: "\f10b"; +} +.fa-circle-o:before { + content: "\f10c"; +} +.fa-quote-left:before { + content: "\f10d"; +} +.fa-quote-right:before { + content: "\f10e"; +} +.fa-spinner:before { + content: "\f110"; +} +.fa-circle:before { + content: "\f111"; +} +.fa-mail-reply:before, +.fa-reply:before { + content: "\f112"; +} +.fa-github-alt:before { + content: "\f113"; +} +.fa-folder-o:before { + content: "\f114"; +} +.fa-folder-open-o:before { + content: "\f115"; +} +.fa-smile-o:before { + content: "\f118"; +} +.fa-frown-o:before { + content: "\f119"; +} +.fa-meh-o:before { + content: "\f11a"; +} +.fa-gamepad:before { + content: "\f11b"; +} +.fa-keyboard-o:before { + content: "\f11c"; +} +.fa-flag-o:before { + content: "\f11d"; +} +.fa-flag-checkered:before { + content: "\f11e"; +} +.fa-terminal:before { + content: "\f120"; +} +.fa-code:before { + content: "\f121"; +} +.fa-mail-reply-all:before, +.fa-reply-all:before { + content: "\f122"; +} +.fa-star-half-empty:before, +.fa-star-half-full:before, +.fa-star-half-o:before { + content: "\f123"; +} +.fa-location-arrow:before { + content: "\f124"; +} +.fa-crop:before { + content: "\f125"; +} +.fa-code-fork:before { + content: "\f126"; +} +.fa-unlink:before, +.fa-chain-broken:before { + content: "\f127"; +} +.fa-question:before { + content: "\f128"; +} +.fa-info:before { + content: "\f129"; +} +.fa-exclamation:before { + content: "\f12a"; +} +.fa-superscript:before { + content: "\f12b"; +} +.fa-subscript:before { + content: "\f12c"; +} +.fa-eraser:before { + content: "\f12d"; +} +.fa-puzzle-piece:before { + content: "\f12e"; +} +.fa-microphone:before { + content: "\f130"; +} +.fa-microphone-slash:before { + content: "\f131"; +} +.fa-shield:before { + content: "\f132"; +} +.fa-calendar-o:before { + content: "\f133"; +} +.fa-fire-extinguisher:before { + content: "\f134"; +} +.fa-rocket:before { + content: "\f135"; +} +.fa-maxcdn:before { + content: "\f136"; +} +.fa-chevron-circle-left:before { + content: "\f137"; +} +.fa-chevron-circle-right:before { + content: "\f138"; +} +.fa-chevron-circle-up:before { + content: "\f139"; +} +.fa-chevron-circle-down:before { + content: "\f13a"; +} +.fa-html5:before { + content: "\f13b"; +} +.fa-css3:before { + content: "\f13c"; +} +.fa-anchor:before { + content: "\f13d"; +} +.fa-unlock-alt:before { + content: "\f13e"; +} +.fa-bullseye:before { + content: "\f140"; +} +.fa-ellipsis-h:before { + content: "\f141"; +} +.fa-ellipsis-v:before { + content: "\f142"; +} +.fa-rss-square:before { + content: "\f143"; +} +.fa-play-circle:before { + content: "\f144"; +} +.fa-ticket:before { + content: "\f145"; +} +.fa-minus-square:before { + content: "\f146"; +} +.fa-minus-square-o:before { + content: "\f147"; +} +.fa-level-up:before { + content: "\f148"; +} +.fa-level-down:before { + content: "\f149"; +} +.fa-check-square:before { + content: "\f14a"; +} +.fa-pencil-square:before { + content: "\f14b"; +} +.fa-external-link-square:before { + content: "\f14c"; +} +.fa-share-square:before { + content: "\f14d"; +} +.fa-compass:before { + content: "\f14e"; +} +.fa-toggle-down:before, +.fa-caret-square-o-down:before { + content: "\f150"; +} +.fa-toggle-up:before, +.fa-caret-square-o-up:before { + content: "\f151"; +} +.fa-toggle-right:before, +.fa-caret-square-o-right:before { + content: "\f152"; +} +.fa-euro:before, +.fa-eur:before { + content: "\f153"; +} +.fa-gbp:before { + content: "\f154"; +} +.fa-dollar:before, +.fa-usd:before { + content: "\f155"; +} +.fa-rupee:before, +.fa-inr:before { + content: "\f156"; +} +.fa-cny:before, +.fa-rmb:before, +.fa-yen:before, +.fa-jpy:before { + content: "\f157"; +} +.fa-ruble:before, +.fa-rouble:before, +.fa-rub:before { + content: "\f158"; +} +.fa-won:before, +.fa-krw:before { + content: "\f159"; +} +.fa-bitcoin:before, +.fa-btc:before { + content: "\f15a"; +} +.fa-file:before { + content: "\f15b"; +} +.fa-file-text:before { + content: "\f15c"; +} +.fa-sort-alpha-asc:before { + content: "\f15d"; +} +.fa-sort-alpha-desc:before { + content: "\f15e"; +} +.fa-sort-amount-asc:before { + content: "\f160"; +} +.fa-sort-amount-desc:before { + content: "\f161"; +} +.fa-sort-numeric-asc:before { + content: "\f162"; +} +.fa-sort-numeric-desc:before { + content: "\f163"; +} +.fa-thumbs-up:before { + content: "\f164"; +} +.fa-thumbs-down:before { + content: "\f165"; +} +.fa-youtube-square:before { + content: "\f166"; +} +.fa-youtube:before { + content: "\f167"; +} +.fa-xing:before { + content: "\f168"; +} +.fa-xing-square:before { + content: "\f169"; +} +.fa-youtube-play:before { + content: "\f16a"; +} +.fa-dropbox:before { + content: "\f16b"; +} +.fa-stack-overflow:before { + content: "\f16c"; +} +.fa-instagram:before { + content: "\f16d"; +} +.fa-flickr:before { + content: "\f16e"; +} +.fa-adn:before { + content: "\f170"; +} +.fa-bitbucket:before { + content: "\f171"; +} +.fa-bitbucket-square:before { + content: "\f172"; +} +.fa-tumblr:before { + content: "\f173"; +} +.fa-tumblr-square:before { + content: "\f174"; +} +.fa-long-arrow-down:before { + content: "\f175"; +} +.fa-long-arrow-up:before { + content: "\f176"; +} +.fa-long-arrow-left:before { + content: "\f177"; +} +.fa-long-arrow-right:before { + content: "\f178"; +} +.fa-apple:before { + content: "\f179"; +} +.fa-windows:before { + content: "\f17a"; +} +.fa-android:before { + content: "\f17b"; +} +.fa-linux:before { + content: "\f17c"; +} +.fa-dribbble:before { + content: "\f17d"; +} +.fa-skype:before { + content: "\f17e"; +} +.fa-foursquare:before { + content: "\f180"; +} +.fa-trello:before { + content: "\f181"; +} +.fa-female:before { + content: "\f182"; +} +.fa-male:before { + content: "\f183"; +} +.fa-gittip:before, +.fa-gratipay:before { + content: "\f184"; +} +.fa-sun-o:before { + content: "\f185"; +} +.fa-moon-o:before { + content: "\f186"; +} +.fa-archive:before { + content: "\f187"; +} +.fa-bug:before { + content: "\f188"; +} +.fa-vk:before { + content: "\f189"; +} +.fa-weibo:before { + content: "\f18a"; +} +.fa-renren:before { + content: "\f18b"; +} +.fa-pagelines:before { + content: "\f18c"; +} +.fa-stack-exchange:before { + content: "\f18d"; +} +.fa-arrow-circle-o-right:before { + content: "\f18e"; +} +.fa-arrow-circle-o-left:before { + content: "\f190"; +} +.fa-toggle-left:before, +.fa-caret-square-o-left:before { + content: "\f191"; +} +.fa-dot-circle-o:before { + content: "\f192"; +} +.fa-wheelchair:before { + content: "\f193"; +} +.fa-vimeo-square:before { + content: "\f194"; +} +.fa-turkish-lira:before, +.fa-try:before { + content: "\f195"; +} +.fa-plus-square-o:before { + content: "\f196"; +} +.fa-space-shuttle:before { + content: "\f197"; +} +.fa-slack:before { + content: "\f198"; +} +.fa-envelope-square:before { + content: "\f199"; +} +.fa-wordpress:before { + content: "\f19a"; +} +.fa-openid:before { + content: "\f19b"; +} +.fa-institution:before, +.fa-bank:before, +.fa-university:before { + content: "\f19c"; +} +.fa-mortar-board:before, +.fa-graduation-cap:before { + content: "\f19d"; +} +.fa-yahoo:before { + content: "\f19e"; +} +.fa-google:before { + content: "\f1a0"; +} +.fa-reddit:before { + content: "\f1a1"; +} +.fa-reddit-square:before { + content: "\f1a2"; +} +.fa-stumbleupon-circle:before { + content: "\f1a3"; +} +.fa-stumbleupon:before { + content: "\f1a4"; +} +.fa-delicious:before { + content: "\f1a5"; +} +.fa-digg:before { + content: "\f1a6"; +} +.fa-pied-piper-pp:before { + content: "\f1a7"; +} +.fa-pied-piper-alt:before { + content: "\f1a8"; +} +.fa-drupal:before { + content: "\f1a9"; +} +.fa-joomla:before { + content: "\f1aa"; +} +.fa-language:before { + content: "\f1ab"; +} +.fa-fax:before { + content: "\f1ac"; +} +.fa-building:before { + content: "\f1ad"; +} +.fa-child:before { + content: "\f1ae"; +} +.fa-paw:before { + content: "\f1b0"; +} +.fa-spoon:before { + content: "\f1b1"; +} +.fa-cube:before { + content: "\f1b2"; +} +.fa-cubes:before { + content: "\f1b3"; +} +.fa-behance:before { + content: "\f1b4"; +} +.fa-behance-square:before { + content: "\f1b5"; +} +.fa-steam:before { + content: "\f1b6"; +} +.fa-steam-square:before { + content: "\f1b7"; +} +.fa-recycle:before { + content: "\f1b8"; +} +.fa-automobile:before, +.fa-car:before { + content: "\f1b9"; +} +.fa-cab:before, +.fa-taxi:before { + content: "\f1ba"; +} +.fa-tree:before { + content: "\f1bb"; +} +.fa-spotify:before { + content: "\f1bc"; +} +.fa-deviantart:before { + content: "\f1bd"; +} +.fa-soundcloud:before { + content: "\f1be"; +} +.fa-database:before { + content: "\f1c0"; +} +.fa-file-pdf-o:before { + content: "\f1c1"; +} +.fa-file-word-o:before { + content: "\f1c2"; +} +.fa-file-excel-o:before { + content: "\f1c3"; +} +.fa-file-powerpoint-o:before { + content: "\f1c4"; +} +.fa-file-photo-o:before, +.fa-file-picture-o:before, +.fa-file-image-o:before { + content: "\f1c5"; +} +.fa-file-zip-o:before, +.fa-file-archive-o:before { + content: "\f1c6"; +} +.fa-file-sound-o:before, +.fa-file-audio-o:before { + content: "\f1c7"; +} +.fa-file-movie-o:before, +.fa-file-video-o:before { + content: "\f1c8"; +} +.fa-file-code-o:before { + content: "\f1c9"; +} +.fa-vine:before { + content: "\f1ca"; +} +.fa-codepen:before { + content: "\f1cb"; +} +.fa-jsfiddle:before { + content: "\f1cc"; +} +.fa-life-bouy:before, +.fa-life-buoy:before, +.fa-life-saver:before, +.fa-support:before, +.fa-life-ring:before { + content: "\f1cd"; +} +.fa-circle-o-notch:before { + content: "\f1ce"; +} +.fa-ra:before, +.fa-resistance:before, +.fa-rebel:before { + content: "\f1d0"; +} +.fa-ge:before, +.fa-empire:before { + content: "\f1d1"; +} +.fa-git-square:before { + content: "\f1d2"; +} +.fa-git:before { + content: "\f1d3"; +} +.fa-y-combinator-square:before, +.fa-yc-square:before, +.fa-hacker-news:before { + content: "\f1d4"; +} +.fa-tencent-weibo:before { + content: "\f1d5"; +} +.fa-qq:before { + content: "\f1d6"; +} +.fa-wechat:before, +.fa-weixin:before { + content: "\f1d7"; +} +.fa-send:before, +.fa-paper-plane:before { + content: "\f1d8"; +} +.fa-send-o:before, +.fa-paper-plane-o:before { + content: "\f1d9"; +} +.fa-history:before { + content: "\f1da"; +} +.fa-circle-thin:before { + content: "\f1db"; +} +.fa-header:before { + content: "\f1dc"; +} +.fa-paragraph:before { + content: "\f1dd"; +} +.fa-sliders:before { + content: "\f1de"; +} +.fa-share-alt:before { + content: "\f1e0"; +} +.fa-share-alt-square:before { + content: "\f1e1"; +} +.fa-bomb:before { + content: "\f1e2"; +} +.fa-soccer-ball-o:before, +.fa-futbol-o:before { + content: "\f1e3"; +} +.fa-tty:before { + content: "\f1e4"; +} +.fa-binoculars:before { + content: "\f1e5"; +} +.fa-plug:before { + content: "\f1e6"; +} +.fa-slideshare:before { + content: "\f1e7"; +} +.fa-twitch:before { + content: "\f1e8"; +} +.fa-yelp:before { + content: "\f1e9"; +} +.fa-newspaper-o:before { + content: "\f1ea"; +} +.fa-wifi:before { + content: "\f1eb"; +} +.fa-calculator:before { + content: "\f1ec"; +} +.fa-paypal:before { + content: "\f1ed"; +} +.fa-google-wallet:before { + content: "\f1ee"; +} +.fa-cc-visa:before { + content: "\f1f0"; +} +.fa-cc-mastercard:before { + content: "\f1f1"; +} +.fa-cc-discover:before { + content: "\f1f2"; +} +.fa-cc-amex:before { + content: "\f1f3"; +} +.fa-cc-paypal:before { + content: "\f1f4"; +} +.fa-cc-stripe:before { + content: "\f1f5"; +} +.fa-bell-slash:before { + content: "\f1f6"; +} +.fa-bell-slash-o:before { + content: "\f1f7"; +} +.fa-trash:before { + content: "\f1f8"; +} +.fa-copyright:before { + content: "\f1f9"; +} +.fa-at:before { + content: "\f1fa"; +} +.fa-eyedropper:before { + content: "\f1fb"; +} +.fa-paint-brush:before { + content: "\f1fc"; +} +.fa-birthday-cake:before { + content: "\f1fd"; +} +.fa-area-chart:before { + content: "\f1fe"; +} +.fa-pie-chart:before { + content: "\f200"; +} +.fa-line-chart:before { + content: "\f201"; +} +.fa-lastfm:before { + content: "\f202"; +} +.fa-lastfm-square:before { + content: "\f203"; +} +.fa-toggle-off:before { + content: "\f204"; +} +.fa-toggle-on:before { + content: "\f205"; +} +.fa-bicycle:before { + content: "\f206"; +} +.fa-bus:before { + content: "\f207"; +} +.fa-ioxhost:before { + content: "\f208"; +} +.fa-angellist:before { + content: "\f209"; +} +.fa-cc:before { + content: "\f20a"; +} +.fa-shekel:before, +.fa-sheqel:before, +.fa-ils:before { + content: "\f20b"; +} +.fa-meanpath:before { + content: "\f20c"; +} +.fa-buysellads:before { + content: "\f20d"; +} +.fa-connectdevelop:before { + content: "\f20e"; +} +.fa-dashcube:before { + content: "\f210"; +} +.fa-forumbee:before { + content: "\f211"; +} +.fa-leanpub:before { + content: "\f212"; +} +.fa-sellsy:before { + content: "\f213"; +} +.fa-shirtsinbulk:before { + content: "\f214"; +} +.fa-simplybuilt:before { + content: "\f215"; +} +.fa-skyatlas:before { + content: "\f216"; +} +.fa-cart-plus:before { + content: "\f217"; +} +.fa-cart-arrow-down:before { + content: "\f218"; +} +.fa-diamond:before { + content: "\f219"; +} +.fa-ship:before { + content: "\f21a"; +} +.fa-user-secret:before { + content: "\f21b"; +} +.fa-motorcycle:before { + content: "\f21c"; +} +.fa-street-view:before { + content: "\f21d"; +} +.fa-heartbeat:before { + content: "\f21e"; +} +.fa-venus:before { + content: "\f221"; +} +.fa-mars:before { + content: "\f222"; +} +.fa-mercury:before { + content: "\f223"; +} +.fa-intersex:before, +.fa-transgender:before { + content: "\f224"; +} +.fa-transgender-alt:before { + content: "\f225"; +} +.fa-venus-double:before { + content: "\f226"; +} +.fa-mars-double:before { + content: "\f227"; +} +.fa-venus-mars:before { + content: "\f228"; +} +.fa-mars-stroke:before { + content: "\f229"; +} +.fa-mars-stroke-v:before { + content: "\f22a"; +} +.fa-mars-stroke-h:before { + content: "\f22b"; +} +.fa-neuter:before { + content: "\f22c"; +} +.fa-genderless:before { + content: "\f22d"; +} +.fa-facebook-official:before { + content: "\f230"; +} +.fa-pinterest-p:before { + content: "\f231"; +} +.fa-whatsapp:before { + content: "\f232"; +} +.fa-server:before { + content: "\f233"; +} +.fa-user-plus:before { + content: "\f234"; +} +.fa-user-times:before { + content: "\f235"; +} +.fa-hotel:before, +.fa-bed:before { + content: "\f236"; +} +.fa-viacoin:before { + content: "\f237"; +} +.fa-train:before { + content: "\f238"; +} +.fa-subway:before { + content: "\f239"; +} +.fa-medium:before { + content: "\f23a"; +} +.fa-yc:before, +.fa-y-combinator:before { + content: "\f23b"; +} +.fa-optin-monster:before { + content: "\f23c"; +} +.fa-opencart:before { + content: "\f23d"; +} +.fa-expeditedssl:before { + content: "\f23e"; +} +.fa-battery-4:before, +.fa-battery:before, +.fa-battery-full:before { + content: "\f240"; +} +.fa-battery-3:before, +.fa-battery-three-quarters:before { + content: "\f241"; +} +.fa-battery-2:before, +.fa-battery-half:before { + content: "\f242"; +} +.fa-battery-1:before, +.fa-battery-quarter:before { + content: "\f243"; +} +.fa-battery-0:before, +.fa-battery-empty:before { + content: "\f244"; +} +.fa-mouse-pointer:before { + content: "\f245"; +} +.fa-i-cursor:before { + content: "\f246"; +} +.fa-object-group:before { + content: "\f247"; +} +.fa-object-ungroup:before { + content: "\f248"; +} +.fa-sticky-note:before { + content: "\f249"; +} +.fa-sticky-note-o:before { + content: "\f24a"; +} +.fa-cc-jcb:before { + content: "\f24b"; +} +.fa-cc-diners-club:before { + content: "\f24c"; +} +.fa-clone:before { + content: "\f24d"; +} +.fa-balance-scale:before { + content: "\f24e"; +} +.fa-hourglass-o:before { + content: "\f250"; +} +.fa-hourglass-1:before, +.fa-hourglass-start:before { + content: "\f251"; +} +.fa-hourglass-2:before, +.fa-hourglass-half:before { + content: "\f252"; +} +.fa-hourglass-3:before, +.fa-hourglass-end:before { + content: "\f253"; +} +.fa-hourglass:before { + content: "\f254"; +} +.fa-hand-grab-o:before, +.fa-hand-rock-o:before { + content: "\f255"; +} +.fa-hand-stop-o:before, +.fa-hand-paper-o:before { + content: "\f256"; +} +.fa-hand-scissors-o:before { + content: "\f257"; +} +.fa-hand-lizard-o:before { + content: "\f258"; +} +.fa-hand-spock-o:before { + content: "\f259"; +} +.fa-hand-pointer-o:before { + content: "\f25a"; +} +.fa-hand-peace-o:before { + content: "\f25b"; +} +.fa-trademark:before { + content: "\f25c"; +} +.fa-registered:before { + content: "\f25d"; +} +.fa-creative-commons:before { + content: "\f25e"; +} +.fa-gg:before { + content: "\f260"; +} +.fa-gg-circle:before { + content: "\f261"; +} +.fa-tripadvisor:before { + content: "\f262"; +} +.fa-odnoklassniki:before { + content: "\f263"; +} +.fa-odnoklassniki-square:before { + content: "\f264"; +} +.fa-get-pocket:before { + content: "\f265"; +} +.fa-wikipedia-w:before { + content: "\f266"; +} +.fa-safari:before { + content: "\f267"; +} +.fa-chrome:before { + content: "\f268"; +} +.fa-firefox:before { + content: "\f269"; +} +.fa-opera:before { + content: "\f26a"; +} +.fa-internet-explorer:before { + content: "\f26b"; +} +.fa-tv:before, +.fa-television:before { + content: "\f26c"; +} +.fa-contao:before { + content: "\f26d"; +} +.fa-500px:before { + content: "\f26e"; +} +.fa-amazon:before { + content: "\f270"; +} +.fa-calendar-plus-o:before { + content: "\f271"; +} +.fa-calendar-minus-o:before { + content: "\f272"; +} +.fa-calendar-times-o:before { + content: "\f273"; +} +.fa-calendar-check-o:before { + content: "\f274"; +} +.fa-industry:before { + content: "\f275"; +} +.fa-map-pin:before { + content: "\f276"; +} +.fa-map-signs:before { + content: "\f277"; +} +.fa-map-o:before { + content: "\f278"; +} +.fa-map:before { + content: "\f279"; +} +.fa-commenting:before { + content: "\f27a"; +} +.fa-commenting-o:before { + content: "\f27b"; +} +.fa-houzz:before { + content: "\f27c"; +} +.fa-vimeo:before { + content: "\f27d"; +} +.fa-black-tie:before { + content: "\f27e"; +} +.fa-fonticons:before { + content: "\f280"; +} +.fa-reddit-alien:before { + content: "\f281"; +} +.fa-edge:before { + content: "\f282"; +} +.fa-credit-card-alt:before { + content: "\f283"; +} +.fa-codiepie:before { + content: "\f284"; +} +.fa-modx:before { + content: "\f285"; +} +.fa-fort-awesome:before { + content: "\f286"; +} +.fa-usb:before { + content: "\f287"; +} +.fa-product-hunt:before { + content: "\f288"; +} +.fa-mixcloud:before { + content: "\f289"; +} +.fa-scribd:before { + content: "\f28a"; +} +.fa-pause-circle:before { + content: "\f28b"; +} +.fa-pause-circle-o:before { + content: "\f28c"; +} +.fa-stop-circle:before { + content: "\f28d"; +} +.fa-stop-circle-o:before { + content: "\f28e"; +} +.fa-shopping-bag:before { + content: "\f290"; +} +.fa-shopping-basket:before { + content: "\f291"; +} +.fa-hashtag:before { + content: "\f292"; +} +.fa-bluetooth:before { + content: "\f293"; +} +.fa-bluetooth-b:before { + content: "\f294"; +} +.fa-percent:before { + content: "\f295"; +} +.fa-gitlab:before { + content: "\f296"; +} +.fa-wpbeginner:before { + content: "\f297"; +} +.fa-wpforms:before { + content: "\f298"; +} +.fa-envira:before { + content: "\f299"; +} +.fa-universal-access:before { + content: "\f29a"; +} +.fa-wheelchair-alt:before { + content: "\f29b"; +} +.fa-question-circle-o:before { + content: "\f29c"; +} +.fa-blind:before { + content: "\f29d"; +} +.fa-audio-description:before { + content: "\f29e"; +} +.fa-volume-control-phone:before { + content: "\f2a0"; +} +.fa-braille:before { + content: "\f2a1"; +} +.fa-assistive-listening-systems:before { + content: "\f2a2"; +} +.fa-asl-interpreting:before, +.fa-american-sign-language-interpreting:before { + content: "\f2a3"; +} +.fa-deafness:before, +.fa-hard-of-hearing:before, +.fa-deaf:before { + content: "\f2a4"; +} +.fa-glide:before { + content: "\f2a5"; +} +.fa-glide-g:before { + content: "\f2a6"; +} +.fa-signing:before, +.fa-sign-language:before { + content: "\f2a7"; +} +.fa-low-vision:before { + content: "\f2a8"; +} +.fa-viadeo:before { + content: "\f2a9"; +} +.fa-viadeo-square:before { + content: "\f2aa"; +} +.fa-snapchat:before { + content: "\f2ab"; +} +.fa-snapchat-ghost:before { + content: "\f2ac"; +} +.fa-snapchat-square:before { + content: "\f2ad"; +} +.fa-pied-piper:before { + content: "\f2ae"; +} +.fa-first-order:before { + content: "\f2b0"; +} +.fa-yoast:before { + content: "\f2b1"; +} +.fa-themeisle:before { + content: "\f2b2"; +} +.fa-google-plus-circle:before, +.fa-google-plus-official:before { + content: "\f2b3"; +} +.fa-fa:before, +.fa-font-awesome:before { + content: "\f2b4"; +} +.fa-handshake-o:before { + content: "\f2b5"; +} +.fa-envelope-open:before { + content: "\f2b6"; +} +.fa-envelope-open-o:before { + content: "\f2b7"; +} +.fa-linode:before { + content: "\f2b8"; +} +.fa-address-book:before { + content: "\f2b9"; +} +.fa-address-book-o:before { + content: "\f2ba"; +} +.fa-vcard:before, +.fa-address-card:before { + content: "\f2bb"; +} +.fa-vcard-o:before, +.fa-address-card-o:before { + content: "\f2bc"; +} +.fa-user-circle:before { + content: "\f2bd"; +} +.fa-user-circle-o:before { + content: "\f2be"; +} +.fa-user-o:before { + content: "\f2c0"; +} +.fa-id-badge:before { + content: "\f2c1"; +} +.fa-drivers-license:before, +.fa-id-card:before { + content: "\f2c2"; +} +.fa-drivers-license-o:before, +.fa-id-card-o:before { + content: "\f2c3"; +} +.fa-quora:before { + content: "\f2c4"; +} +.fa-free-code-camp:before { + content: "\f2c5"; +} +.fa-telegram:before { + content: "\f2c6"; +} +.fa-thermometer-4:before, +.fa-thermometer:before, +.fa-thermometer-full:before { + content: "\f2c7"; +} +.fa-thermometer-3:before, +.fa-thermometer-three-quarters:before { + content: "\f2c8"; +} +.fa-thermometer-2:before, +.fa-thermometer-half:before { + content: "\f2c9"; +} +.fa-thermometer-1:before, +.fa-thermometer-quarter:before { + content: "\f2ca"; +} +.fa-thermometer-0:before, +.fa-thermometer-empty:before { + content: "\f2cb"; +} +.fa-shower:before { + content: "\f2cc"; +} +.fa-bathtub:before, +.fa-s15:before, +.fa-bath:before { + content: "\f2cd"; +} +.fa-podcast:before { + content: "\f2ce"; +} +.fa-window-maximize:before { + content: "\f2d0"; +} +.fa-window-minimize:before { + content: "\f2d1"; +} +.fa-window-restore:before { + content: "\f2d2"; +} +.fa-times-rectangle:before, +.fa-window-close:before { + content: "\f2d3"; +} +.fa-times-rectangle-o:before, +.fa-window-close-o:before { + content: "\f2d4"; +} +.fa-bandcamp:before { + content: "\f2d5"; +} +.fa-grav:before { + content: "\f2d6"; +} +.fa-etsy:before { + content: "\f2d7"; +} +.fa-imdb:before { + content: "\f2d8"; +} +.fa-ravelry:before { + content: "\f2d9"; +} +.fa-eercast:before { + content: "\f2da"; +} +.fa-microchip:before { + content: "\f2db"; +} +.fa-snowflake-o:before { + content: "\f2dc"; +} +.fa-superpowers:before { + content: "\f2dd"; +} +.fa-wpexplorer:before { + content: "\f2de"; +} +.fa-meetup:before { + content: "\f2e0"; +} +.sr-only { + position: absolute; + width: 1px; + height: 1px; + padding: 0; + margin: -1px; + overflow: hidden; + clip: rect(0, 0, 0, 0); + border: 0; +} +.sr-only-focusable:active, +.sr-only-focusable:focus { + position: static; + width: auto; + height: auto; + margin: 0; + overflow: visible; + clip: auto; +} diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/css/font-awesome.css.map b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/css/font-awesome.css.map new file mode 100755 index 0000000000000..60763a8640f1c --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/css/font-awesome.css.map @@ -0,0 +1,7 @@ +{ +"version": 3, +"mappings": ";;;;;;;AAGA,UAUC;EATC,WAAW,EAAE,aAAa;EAC1B,GAAG,EAAE,+CAAgE;EACrE,GAAG,EAAE,ySAAmG;EAKxG,WAAW,EAAE,MAAM;EACnB,UAAU,EAAE,MAAM;ACTpB,GAAmB;EACjB,OAAO,EAAE,YAAY;EACrB,IAAI,EAAE,uCAAwD;EAC9D,SAAS,EAAE,OAAO;EAClB,cAAc,EAAE,IAAI;EACpB,sBAAsB,EAAE,WAAW;EACnC,uBAAuB,EAAE,SAAS;EAClC,SAAS,EAAE,eAAe;;;ACN5B,MAAsB;EACpB,SAAS,EAAE,SAAS;EACpB,WAAW,EAAE,MAAS;EACtB,cAAc,EAAE,IAAI;;AAEtB,MAAsB;EAAE,SAAS,EAAE,GAAG;;AACtC,MAAsB;EAAE,SAAS,EAAE,GAAG;;AACtC,MAAsB;EAAE,SAAS,EAAE,GAAG;;AACtC,MAAsB;EAAE,SAAS,EAAE,GAAG;;ACVtC,MAAsB;EACpB,KAAK,EAAE,SAAW;EAClB,UAAU,EAAE,MAAM;;ACDpB,MAAsB;EACpB,YAAY,EAAE,CAAC;EACf,WAAW,ECKU,SAAS;EDJ9B,eAAe,EAAE,IAAI;EACrB,WAAK;IAAE,QAAQ,EAAE,QAAQ;;AAE3B,MAAsB;EACpB,QAAQ,EAAE,QAAQ;EAClB,IAAI,EAAE,UAAa;EACnB,KAAK,ECFgB,SAAS;EDG9B,GAAG,EAAE,SAAU;EACf,UAAU,EAAE,MAAM;EAClB,YAAuB;IACrB,IAAI,EAAE,UAA0B;;AEbpC,UAA0B;EACxB,OAAO,EAAE,gBAAgB;EACzB,MAAM,EAAE,iBAA4B;EACpC,aAAa,EAAE,IAAI;;AAGrB,WAAY;EAAE,KAAK,EAAE,KAAK;;AAC1B,UAAW;EAAE,KAAK,EAAE,IAAI;;AAGtB,aAAY;EAAE,YAAY,EAAE,IAAI;AAChC,cAAa;EAAE,WAAW,EAAE,IAAI;;ACXlC,QAAwB;EACtB,iBAAiB,EAAE,0BAA0B;EACrC,SAAS,EAAE,0BAA0B;;AAG/C,SAAyB;EACvB,iBAAiB,EAAE,4BAA4B;EACvC,SAAS,EAAE,4BAA4B;;AAGjD,0BASC;EARC,EAAG;IACD,iBAAiB,EAAE,YAAY;IACvB,SAAS,EAAE,YAAY;EAEjC,IAAK;IACH,iBAAiB,EAAE,cAAc;IACzB,SAAS,EAAE,cAAc;AAIrC,kBASC;EARC,EAAG;IACD,iBAAiB,EAAE,YAAY;IACvB,SAAS,EAAE,YAAY;EAEjC,IAAK;IACH,iBAAiB,EAAE,cAAc;IACzB,SAAS,EAAE,cAAc;AC5BrC,aAA8B;ECY5B,MAAM,EAAE,wDAAmE;EAC3E,iBAAiB,EAAE,aAAgB;EAC/B,aAAa,EAAE,aAAgB;EAC3B,SAAS,EAAE,aAAgB;;ADdrC,cAA8B;ECW5B,MAAM,EAAE,wDAAmE;EAC3E,iBAAiB,EAAE,cAAgB;EAC/B,aAAa,EAAE,cAAgB;EAC3B,SAAS,EAAE,cAAgB;;ADbrC,cAA8B;ECU5B,MAAM,EAAE,wDAAmE;EAC3E,iBAAiB,EAAE,cAAgB;EAC/B,aAAa,EAAE,cAAgB;EAC3B,SAAS,EAAE,cAAgB;;ADXrC,mBAAmC;ECejC,MAAM,EAAE,wDAAmE;EAC3E,iBAAiB,EAAE,YAAoB;EACnC,aAAa,EAAE,YAAoB;EAC/B,SAAS,EAAE,YAAoB;;ADjBzC,iBAAmC;ECcjC,MAAM,EAAE,wDAAmE;EAC3E,iBAAiB,EAAE,YAAoB;EACnC,aAAa,EAAE,YAAoB;EAC/B,SAAS,EAAE,YAAoB;;ADZzC;;;;uBAIuC;EACrC,MAAM,EAAE,IAAI;;AEfd,SAAyB;EACvB,QAAQ,EAAE,QAAQ;EAClB,OAAO,EAAE,YAAY;EACrB,KAAK,EAAE,GAAG;EACV,MAAM,EAAE,GAAG;EACX,WAAW,EAAE,GAAG;EAChB,cAAc,EAAE,MAAM;;AAExB,0BAAyD;EACvD,QAAQ,EAAE,QAAQ;EAClB,IAAI,EAAE,CAAC;EACP,KAAK,EAAE,IAAI;EACX,UAAU,EAAE,MAAM;;AAEpB,YAA4B;EAAE,WAAW,EAAE,OAAO;;AAClD,YAA4B;EAAE,SAAS,EAAE,GAAG;;AAC5C,WAA2B;EAAE,KAAK,ELVZ,IAAI;;;;AMN1B,gBAAgC;EAAE,OAAO,ENoQ1B,GAAO;;AMnQtB,gBAAgC;EAAE,OAAO,EN0W1B,GAAO;;AMzWtB,iBAAiC;EAAE,OAAO,ENmb1B,GAAO;;AMlbvB,qBAAqC;EAAE,OAAO,ENmL1B,GAAO;;AMlL3B,gBAAgC;EAAE,OAAO,ENkR1B,GAAO;;AMjRtB,eAA+B;EAAE,OAAO,ENke1B,GAAO;;AMjerB,iBAAiC;EAAE,OAAO,ENse1B,GAAO;;AMrevB,eAA+B;EAAE,OAAO,EN+iB1B,GAAO;;AM9iBrB,eAA+B;EAAE,OAAO,ENyN1B,GAAO;;AMxNrB,mBAAmC;EAAE,OAAO,ENggB1B,GAAO;;AM/fzB,aAA6B;EAAE,OAAO,EN8f1B,GAAO;;AM7fnB,kBAAkC;EAAE,OAAO,EN+f1B,GAAO;;AM9fxB,gBAAgC;EAAE,OAAO,ENoG1B,GAAO;;AMnGtB;;gBAEgC;EAAE,OAAO,ENkgB1B,GAAO;;AMjgBtB,sBAAsC;EAAE,OAAO,ENua1B,GAAO;;AMta5B,uBAAuC;EAAE,OAAO,ENqa1B,GAAO;;AMpa7B,oBAAoC;EAAE,OAAO,EN+X1B,GAAO;;AM9X1B,iBAAiC;EAAE,OAAO,ENsb1B,GAAO;;AMrbvB;cAC8B;EAAE,OAAO,ENwH1B,GAAO;;AMvHpB,kBAAkC;EAAE,OAAO,ENygB1B,GAAO;;AMxgBxB,eAA+B;EAAE,OAAO,ENmQ1B,GAAO;;AMlQrB,iBAAiC;EAAE,OAAO,EN6L1B,GAAO;;AM5LvB,kBAAkC;EAAE,OAAO,EN0G1B,GAAO;;AMzGxB,eAA+B;EAAE,OAAO,EN+Y1B,GAAO;;AM9YrB,mBAAmC;EAAE,OAAO,ENiJ1B,GAAO;;AMhJzB,8BAA8C;EAAE,OAAO,ENI1B,GAAO;;AMHpC,4BAA4C;EAAE,OAAO,ENM1B,GAAO;;AMLlC,gBAAgC;EAAE,OAAO,ENkQ1B,GAAO;;AMjQtB,wBAAwC;EAAE,OAAO,EN4W1B,GAAO;;AM3W9B;iBACiC;EAAE,OAAO,ENmY1B,GAAO;;AMlYvB,kBAAkC;EAAE,OAAO,EN8X1B,GAAO;;AM7XxB,mBAAmC;EAAE,OAAO,ENiS1B,GAAO;;AMhSzB,eAA+B;EAAE,OAAO,ENoS1B,GAAO;;AMnSrB,eAA+B;EAAE,OAAO,ENgM1B,GAAO;;AM/LrB,qBAAqC;EAAE,OAAO,EN+O1B,GAAO;;AM9O3B,qBAAqC;EAAE,OAAO,EN8hB1B,GAAO;;AM7hB3B,sBAAsC;EAAE,OAAO,EN4hB1B,GAAO;;AM3hB5B,oBAAoC;EAAE,OAAO,EN6hB1B,GAAO;;AM5hB1B,iBAAiC;EAAE,OAAO,EN2W1B,GAAO;;AM1WvB,kBAAkC;EAAE,OAAO,ENW1B,GAAO;;AMVxB,cAA8B;EAAE,OAAO,ENod1B,GAAO;;AMndpB,eAA+B;EAAE,OAAO,ENod1B,GAAO;;AMndrB,eAA+B;EAAE,OAAO,EN2B1B,GAAO;;AM1BrB,mBAAmC;EAAE,OAAO,EN2B1B,GAAO;;AM1BzB,gBAAgC;EAAE,OAAO,ENkW1B,GAAO;;AMjWtB,iBAAiC;EAAE,OAAO,ENwC1B,GAAO;;AMvCvB,eAA+B;EAAE,OAAO,EN8L1B,GAAO;;AM7LrB,eAA+B;EAAE,OAAO,ENmB1B,GAAO;;AMlBrB,iBAAiC;EAAE,OAAO,ENoP1B,GAAO;;AMnPvB,sBAAsC;EAAE,OAAO,ENid1B,GAAO;;AMhd5B,qBAAqC;EAAE,OAAO,ENid1B,GAAO;;AMhd3B,qBAAqC;EAAE,OAAO,EN1C1B,GAAO;;AM2C3B,uBAAuC;EAAE,OAAO,EN7C1B,GAAO;;AM8C7B,sBAAsC;EAAE,OAAO,EN3C1B,GAAO;;AM4C5B,wBAAwC;EAAE,OAAO,EN9C1B,GAAO;;AM+C9B,eAA+B;EAAE,OAAO,ENwQ1B,GAAO;;AMvQrB;kBACkC;EAAE,OAAO,ENmT1B,GAAO;;AMlTxB,iBAAiC;EAAE,OAAO,ENmO1B,GAAO;;AMlOvB,uBAAuC;EAAE,OAAO,ENigB1B,GAAO;;AMhgB7B;;oBAEoC;EAAE,OAAO,EN+T1B,GAAO;;AM9T1B,iBAAiC;EAAE,OAAO,ENwT1B,GAAO;;AMvTvB,qBAAqC;EAAE,OAAO,EN+Q1B,GAAO;;AM9Q3B,iBAAiC;EAAE,OAAO,EN5D1B,GAAO;;AM6DvB,eAA+B;EAAE,OAAO,EN8c1B,GAAO;;AM7crB;0BAC0C;EAAE,OAAO,ENqT1B,GAAO;;AMpThC,yBAAyC;EAAE,OAAO,ENuX1B,GAAO;;AMtX/B,yBAAyC;EAAE,OAAO,EN0C1B,GAAO;;AMzC/B,iBAAiC;EAAE,OAAO,ENjC1B,GAAO;;AMkCvB,wBAAwC;EAAE,OAAO,ENma1B,GAAO;;AMla9B,wBAAwC;EAAE,OAAO,EN4H1B,GAAO;;AM3H9B,mBAAmC;EAAE,OAAO,EN7B1B,GAAO;;AM8BzB,eAA+B;EAAE,OAAO,EN0T1B,GAAO;;AMzTrB,gBAAgC;EAAE,OAAO,ENwS1B,GAAO;;AMvStB,eAA+B;EAAE,OAAO,ENia1B,GAAO;;AMharB,kBAAkC;EAAE,OAAO,ENgK1B,GAAO;;AM/JxB,uBAAuC;EAAE,OAAO,ENuH1B,GAAO;;AMtH7B,uBAAuC;EAAE,OAAO,EN4Z1B,GAAO;;AM3Z7B,gBAAgC;EAAE,OAAO,EN4F1B,GAAO;;AM3FtB,uBAAuC;EAAE,OAAO,ENoC1B,GAAO;;AMnC7B,wBAAwC;EAAE,OAAO,ENoC1B,GAAO;;AMnC9B,sBAAsC;EAAE,OAAO,ENsT1B,GAAO;;AMrT5B,uBAAuC;EAAE,OAAO,ENyQ1B,GAAO;;AMxQ7B,uBAAuC;EAAE,OAAO,ENwb1B,GAAO;;AMvb7B,uBAAuC;EAAE,OAAO,ENsB1B,GAAO;;AMrB7B,0BAA0C;EAAE,OAAO,EN2T1B,GAAO;;AM1ThC,sBAAsC;EAAE,OAAO,ENsM1B,GAAO;;AMrM5B,qBAAqC;EAAE,OAAO,EN6D1B,GAAO;;AM5D3B,yBAAyC;EAAE,OAAO,ENob1B,GAAO;;AMnb/B,yBAAyC;EAAE,OAAO,ENkB1B,GAAO;;AMjB/B,cAA8B;EAAE,OAAO,EN/C1B,GAAO;;AMgDpB,qBAAqC;EAAE,OAAO,EN3D1B,GAAO;;AM4D3B,sBAAsC;EAAE,OAAO,EN3D1B,GAAO;;AM4D5B,mBAAmC;EAAE,OAAO,EN3D1B,GAAO;;AM4DzB,qBAAqC;EAAE,OAAO,EN/D1B,GAAO;;AMgE3B;gBACgC;EAAE,OAAO,ENqV1B,GAAO;;AMpVtB,iBAAiC;EAAE,OAAO,ENuF1B,GAAO;;AMtFvB,mBAAmC;EAAE,OAAO,EN4C1B,GAAO;;AM3CzB,eAA+B;EAAE,OAAO,ENmS1B,GAAO;;AMlSrB,gBAAgC;EAAE,OAAO,ENsP1B,GAAO;;AMrPtB,mBAAmC;EAAE,OAAO,EN9D1B,GAAO;;AM+DzB,6BAA6C;EAAE,OAAO,ENgF1B,GAAO;;AM/EnC,eAA+B;EAAE,OAAO,EN+I1B,GAAO;;AM9IrB,eAA+B;EAAE,OAAO,ENoM1B,GAAO;;AMnMrB,eAA+B;EAAE,OAAO,ENmH1B,GAAO;;AMlHrB,cAA8B;EAAE,OAAO,ENiF1B,GAAO;;AMhFpB,oBAAoC;EAAE,OAAO,ENiF1B,GAAO;;AMhF1B;+BAC+C;EAAE,OAAO,EN0E1B,GAAO;;AMzErC,gBAAgC;EAAE,OAAO,ENmR1B,GAAO;;AMlRtB,mBAAmC;EAAE,OAAO,EN/B1B,GAAO;;AMgCzB,iBAAiC;EAAE,OAAO,ENoS1B,GAAO;;AMnSvB,kBAAkC;EAAE,OAAO,ENwB1B,GAAO;;AMvBxB,iBAAiC;EAAE,OAAO,ENqN1B,GAAO;;AMpNvB,qBAAqC;EAAE,OAAO,ENE1B,GAAO;;AMD3B,uBAAuC;EAAE,OAAO,ENF1B,GAAO;;AMG7B,kBAAkC;EAAE,OAAO,EN2S1B,GAAO;;AM1SxB,wBAAwC;EAAE,OAAO,ENyU1B,GAAO;;AMxU9B,iBAAiC;EAAE,OAAO,EN8G1B,GAAO;;AM7GvB,sBAAsC;EAAE,OAAO,EN+G1B,GAAO;;AM9G5B,mBAAmC;EAAE,OAAO,ENnF1B,GAAO;;AMoFzB,mBAAmC;EAAE,OAAO,ENrF1B,GAAO;;AMsFzB;oBACoC;EAAE,OAAO,EN/E1B,GAAO;;AMgF1B,yBAAyC;EAAE,OAAO,ENua1B,GAAO;;AMta/B,0BAA0C;EAAE,OAAO,ENmE1B,GAAO;;AMlEhC,uBAAuC;EAAE,OAAO,EN5C1B,GAAO;;AM6C7B,cAA8B;EAAE,OAAO,ENqK1B,GAAO;;AMpKpB;eAC+B;EAAE,OAAO,ENK1B,GAAO;;AMJrB,mBAAmC;EAAE,OAAO,ENQ1B,GAAO;;AMPzB,sBAAsC;EAAE,OAAO,ENmY1B,GAAO;;AMlY5B,wBAAwC;EAAE,OAAO,ENiY1B,GAAO;;AMhY9B,oBAAoC;EAAE,OAAO,EN2V1B,GAAO;;AM1V1B,kBAAkC;EAAE,OAAO,ENyI1B,GAAO;;AMxIxB,mBAAmC;EAAE,OAAO,ENyT1B,GAAO;;AMxTzB,0BAA0C;EAAE,OAAO,ENiL1B,GAAO;;AMhLhC,qBAAqC;EAAE,OAAO,EN0X1B,GAAO;;AMzX3B,wBAAwC;EAAE,OAAO,EN8C1B,GAAO;;AM7C9B,kBAAkC;EAAE,OAAO,ENoT1B,GAAO;;AMnTxB,iBAAiC;EAAE,OAAO,EN8Y1B,GAAO;;AM7YvB,wBAAwC;EAAE,OAAO,EN6G1B,GAAO;;AM5G9B,iBAAiC;EAAE,OAAO,EN8Z1B,GAAO;;AM7ZvB,kBAAkC;EAAE,OAAO,EN+J1B,GAAO;;AM9JxB,gBAAgC;EAAE,OAAO,ENsO1B,GAAO;;AMrOtB,mBAAmC;EAAE,OAAO,EN2U1B,GAAO;;AM1UzB,qBAAqC;EAAE,OAAO,EN/E1B,GAAO;;AMgF3B,uBAAuC;EAAE,OAAO,ENoO1B,GAAO;;AMnO7B,kBAAkC;EAAE,OAAO,EN8Y1B,GAAO;;AM7YxB;mBACmC;EAAE,OAAO,ENuC1B,GAAO;;AMtCzB,iBAAiC;EAAE,OAAO,ENiG1B,GAAO;;AMhGvB,iBAAiC;EAAE,OAAO,ENiZ1B,GAAO;;AMhZvB,sBAAsC;EAAE,OAAO,ENR1B,GAAO;;AMS5B,cAA8B;EAAE,OAAO,EN4Q1B,GAAO;;AM3QpB,gBAAgC;EAAE,OAAO,ENgH1B,GAAO;;AM/GtB,mBAAmC;EAAE,OAAO,ENnF1B,GAAO;;AMoFzB,eAA+B;EAAE,OAAO,ENzG1B,GAAO;;AM0GrB,sBAAsC;EAAE,OAAO,ENzD1B,GAAO;;AM0D5B,uBAAuC;EAAE,OAAO,EN0G1B,GAAO;;AMzG7B,sBAAsC;EAAE,OAAO,ENwG1B,GAAO;;AMvG5B,oBAAoC;EAAE,OAAO,ENyG1B,GAAO;;AMxG1B,sBAAsC;EAAE,OAAO,ENqG1B,GAAO;;AMpG5B,4BAA4C;EAAE,OAAO,EN5I1B,GAAO;;AM6IlC,6BAA6C;EAAE,OAAO,ENxI1B,GAAO;;AMyInC,0BAA0C;EAAE,OAAO,ENxI1B,GAAO;;AMyIhC,4BAA4C;EAAE,OAAO,ENhJ1B,GAAO;;AMiJlC,gBAAgC;EAAE,OAAO,ENsF1B,GAAO;;AMrFtB,iBAAiC;EAAE,OAAO,ENia1B,GAAO;;AMhavB,gBAAgC;EAAE,OAAO,ENiV1B,GAAO;;AMhVtB,iBAAiC;EAAE,OAAO,ENgD1B,GAAO;;AM/CvB,oBAAoC;EAAE,OAAO,ENvG1B,GAAO;;AMwG1B,qBAAqC;EAAE,OAAO,ENzI1B,GAAO;;AM0I3B;gBACgC;EAAE,OAAO,ENqY1B,GAAO;;AMpYtB;eAC+B;EAAE,OAAO,ENuI1B,GAAO;;AMtIrB,gBAAgC;EAAE,OAAO,ENpD1B,GAAO;;AMqDtB,gBAAgC;EAAE,OAAO,EN+C1B,GAAO;;AM9CtB;mBACmC;EAAE,OAAO,ENwP1B,GAAO;;AMvPzB;kBACkC;EAAE,OAAO,ENkC1B,GAAO;;AMjCxB,oBAAoC;EAAE,OAAO,ENsL1B,GAAO;;AMrL1B;mBACmC;EAAE,OAAO,EN0C1B,GAAO;;AMzCzB,iBAAiC;EAAE,OAAO,ENiS1B,GAAO;;AMhSvB;;eAE+B;EAAE,OAAO,EN9I1B,GAAO;;AM+IrB,kBAAkC;EAAE,OAAO,ENgI1B,GAAO;;AM/HxB,kBAAkC;EAAE,OAAO,EN8H1B,GAAO;;AM7HxB,wBAAwC;EAAE,OAAO,EN4S1B,GAAO;;AM3S9B,oBAAoC;EAAE,OAAO,ENoW1B,GAAO;;AMnW1B,gBAAgC;EAAE,OAAO,ENmT1B,GAAO;;AMlTtB,gBAAgC;EAAE,OAAO,ENkI1B,GAAO;;AMjItB,gBAAgC;EAAE,OAAO,ENuV1B,GAAO;;AMtVtB,oBAAoC;EAAE,OAAO,ENwL1B,GAAO;;AMvL1B,2BAA2C;EAAE,OAAO,ENyL1B,GAAO;;AMxLjC,6BAA6C;EAAE,OAAO,ENyD1B,GAAO;;AMxDnC,sBAAsC;EAAE,OAAO,ENuD1B,GAAO;;AMtD5B,gBAAgC;EAAE,OAAO,ENsJ1B,GAAO;;AMrJtB,qBAAqC;EAAE,OAAO,ENtH1B,GAAO;;AMuH3B,mBAAmC;EAAE,OAAO,ENhH1B,GAAO;;AMiHzB,qBAAqC;EAAE,OAAO,ENvH1B,GAAO;;AMwH3B,sBAAsC;EAAE,OAAO,ENvH1B,GAAO;;AMwH5B,kBAAkC;EAAE,OAAO,ENvE1B,GAAO;;AMwExB;eAC+B;EAAE,OAAO,EN2P1B,GAAO;;AM1PrB;oBACoC;EAAE,OAAO,EN+P1B,GAAO;;AM9P1B;mBACmC;EAAE,OAAO,EN4P1B,GAAO;;AM3PzB,mBAAmC;EAAE,OAAO,ENxC1B,GAAO;;AMyCzB,mBAAmC;EAAE,OAAO,ENkG1B,GAAO;;AMjGzB;eAC+B;EAAE,OAAO,EN8U1B,GAAO;;AM7UrB;gBACgC;EAAE,OAAO,ENqB1B,GAAO;;AMpBtB;qBACqC;EAAE,OAAO,EN2R1B,GAAO;;AM1R3B,oBAAoC;EAAE,OAAO,ENpF1B,GAAO;;AMqF1B,qBAAqC;EAAE,OAAO,ENnF1B,GAAO;;AMoF3B;eAC+B;EAAE,OAAO,ENjK1B,GAAO;;AMkKrB,kBAAkC;EAAE,OAAO,ENkO1B,GAAO;;AMjOxB,mBAAmC;EAAE,OAAO,ENkU1B,GAAO;;AMjUzB;oBACoC;EAAE,OAAO,EN1G1B,GAAO;;AM2G1B,sBAAsC;EAAE,OAAO,ENgF1B,GAAO;;AM/E5B,mBAAmC;EAAE,OAAO,ENnD1B,GAAO;;AMoDzB,yBAAyC;EAAE,OAAO,ENzG1B,GAAO;;AM0G/B,uBAAuC;EAAE,OAAO,ENzG1B,GAAO;;AM0G7B,kBAAkC;EAAE,OAAO,ENsU1B,GAAO;;AMrUxB,sBAAsC;EAAE,OAAO,EN+P1B,GAAO;;AM9P5B,mBAAmC;EAAE,OAAO,ENsQ1B,GAAO;;AMrQzB,iBAAiC;EAAE,OAAO,ENvL1B,GAAO;;AMwLvB,iBAAiC;EAAE,OAAO,ENzG1B,GAAO;;AM0GvB,kBAAkC;EAAE,OAAO,ENtF1B,GAAO;;AMuFxB,sBAAsC;EAAE,OAAO,EN3B1B,GAAO;;AM4B5B,qBAAqC;EAAE,OAAO,ENxK1B,GAAO;;AMyK3B,qBAAqC;EAAE,OAAO,ENkC1B,GAAO;;AMjC3B,oBAAoC;EAAE,OAAO,EN3O1B,GAAO;;AM4O1B,iBAAiC;EAAE,OAAO,ENiG1B,GAAO;;AMhGvB,sBAAsC;EAAE,OAAO,EN/C1B,GAAO;;AMgD5B,eAA+B;EAAE,OAAO,ENpM1B,GAAO;;AMqMrB,mBAAmC;EAAE,OAAO,ENe1B,GAAO;;AMdzB,sBAAsC;EAAE,OAAO,ENgJ1B,GAAO;;AM/I5B,4BAA4C;EAAE,OAAO,EN5O1B,GAAO;;AM6OlC,6BAA6C;EAAE,OAAO,EN5O1B,GAAO;;AM6OnC,0BAA0C;EAAE,OAAO,EN5O1B,GAAO;;AM6OhC,4BAA4C;EAAE,OAAO,ENhP1B,GAAO;;AMiPlC,qBAAqC;EAAE,OAAO,EN5O1B,GAAO;;AM6O3B,sBAAsC;EAAE,OAAO,EN5O1B,GAAO;;AM6O5B,mBAAmC;EAAE,OAAO,EN5O1B,GAAO;;AM6OzB,qBAAqC;EAAE,OAAO,ENhP1B,GAAO;;AMiP3B,kBAAkC;EAAE,OAAO,ENlG1B,GAAO;;AMmGxB,iBAAiC;EAAE,OAAO,ENuC1B,GAAO;;AMtCvB,iBAAiC;EAAE,OAAO,ENoP1B,GAAO;;AMnPvB;iBACiC;EAAE,OAAO,ENyF1B,GAAO;;AMxFvB,mBAAmC;EAAE,OAAO,EN9I1B,GAAO;;AM+IzB,qBAAqC;EAAE,OAAO,EN0I1B,GAAO;;AMzI3B,sBAAsC;EAAE,OAAO,EN0I1B,GAAO;;AMzI5B,kBAAkC;EAAE,OAAO,ENgN1B,GAAO;;AM/MxB,iBAAiC;EAAE,OAAO,ENnJ1B,GAAO;;AMoJvB;gBACgC;EAAE,OAAO,ENkJ1B,GAAO;;AMjJtB,qBAAqC;EAAE,OAAO,ENnB1B,GAAO;;AMoB3B,mBAAmC;EAAE,OAAO,ENxC1B,GAAO;;AMyCzB,wBAAwC;EAAE,OAAO,ENvC1B,GAAO;;AMwC9B,kBAAkC;EAAE,OAAO,EN0L1B,GAAO;;AMzLxB,kBAAkC;EAAE,OAAO,ENpC1B,GAAO;;AMqCxB,gBAAgC;EAAE,OAAO,ENoE1B,GAAO;;AMnEtB,kBAAkC;EAAE,OAAO,ENpC1B,GAAO;;AMqCxB,qBAAqC;EAAE,OAAO,ENkB1B,GAAO;;AMjB3B,iBAAiC;EAAE,OAAO,ENrD1B,GAAO;;AMsDvB,yBAAyC;EAAE,OAAO,ENvD1B,GAAO;;AMwD/B,mBAAmC;EAAE,OAAO,ENuO1B,GAAO;;AMtOzB,eAA+B;EAAE,OAAO,ENtJ1B,GAAO;;AMuJrB;oBACoC;EAAE,OAAO,ENqI1B,GAAO;;AMpI1B;;sBAEsC;EAAE,OAAO,ENuM1B,GAAO;;AMtM5B,yBAAyC;EAAE,OAAO,ENkC1B,GAAO;;AMjC/B,eAA+B;EAAE,OAAO,EN5I1B,GAAO;;AM6IrB,oBAAoC;EAAE,OAAO,EN7J1B,GAAO;;AM8J1B;uBACuC;EAAE,OAAO,EN1L1B,GAAO;;AM2L7B,mBAAmC;EAAE,OAAO,EN4G1B,GAAO;;AM3GzB,eAA+B;EAAE,OAAO,ENT1B,GAAO;;AMUrB,sBAAsC;EAAE,OAAO,ENhH1B,GAAO;;AMiH5B,sBAAsC;EAAE,OAAO,EN8M1B,GAAO;;AM7M5B,oBAAoC;EAAE,OAAO,ENyM1B,GAAO;;AMxM1B,iBAAiC;EAAE,OAAO,ENvH1B,GAAO;;AMwHvB,uBAAuC;EAAE,OAAO,ENmG1B,GAAO;;AMlG7B,qBAAqC;EAAE,OAAO,EN8C1B,GAAO;;AM7C3B,2BAA2C;EAAE,OAAO,EN8C1B,GAAO;;AM7CjC,iBAAiC;EAAE,OAAO,ENgJ1B,GAAO;;AM/IvB,qBAAqC;EAAE,OAAO,EN5N1B,GAAO;;AM6N3B,4BAA4C;EAAE,OAAO,ENjF1B,GAAO;;AMkFlC,iBAAiC;EAAE,OAAO,ENoH1B,GAAO;;AMnHvB,iBAAiC;EAAE,OAAO,ENkC1B,GAAO;;AMjCvB,8BAA8C;EAAE,OAAO,ENlM1B,GAAO;;AMmMpC,+BAA+C;EAAE,OAAO,ENlM1B,GAAO;;AMmMrC,4BAA4C;EAAE,OAAO,ENlM1B,GAAO;;AMmMlC,8BAA8C;EAAE,OAAO,ENtM1B,GAAO;;AMuMpC,gBAAgC;EAAE,OAAO,EN/B1B,GAAO;;AMgCtB,eAA+B;EAAE,OAAO,ENjK1B,GAAO;;AMkKrB,iBAAiC;EAAE,OAAO,EN9S1B,GAAO;;AM+SvB,qBAAqC;EAAE,OAAO,ENmP1B,GAAO;;AMlP3B,mBAAmC;EAAE,OAAO,EN9O1B,GAAO;;AM+OzB,qBAAqC;EAAE,OAAO,EN/I1B,GAAO;;AMgJ3B,qBAAqC;EAAE,OAAO,EN/I1B,GAAO;;AMgJ3B,qBAAqC;EAAE,OAAO,EN4G1B,GAAO;;AM3G3B,sBAAsC;EAAE,OAAO,ENsE1B,GAAO;;AMrE5B,iBAAiC;EAAE,OAAO,EN2M1B,GAAO;;AM1MvB,uBAAuC;EAAE,OAAO,EN6B1B,GAAO;;AM5B7B,yBAAyC;EAAE,OAAO,EN6B1B,GAAO;;AM5B/B,mBAAmC;EAAE,OAAO,ENhB1B,GAAO;;AMiBzB,qBAAqC;EAAE,OAAO,ENlB1B,GAAO;;AMmB3B,uBAAuC;EAAE,OAAO,ENvN1B,GAAO;;AMwN7B,wBAAwC;EAAE,OAAO,ENiD1B,GAAO;;AMhD9B,+BAA+C;EAAE,OAAO,EN3I1B,GAAO;;AM4IrC,uBAAuC;EAAE,OAAO,ENkH1B,GAAO;;AMjH7B,kBAAkC;EAAE,OAAO,EN1L1B,GAAO;;AM2LxB;8BAC8C;EAAE,OAAO,ENjP1B,GAAO;;AMkPpC;4BAC4C;EAAE,OAAO,ENhP1B,GAAO;;AMiPlC;+BAC+C;EAAE,OAAO,ENnP1B,GAAO;;AMoPrC;cAC8B;EAAE,OAAO,EN7J1B,GAAO;;AM8JpB,cAA8B;EAAE,OAAO,EN/F1B,GAAO;;AMgGpB;cAC8B;EAAE,OAAO,EN4N1B,GAAO;;AM3NpB;cAC8B;EAAE,OAAO,ENvD1B,GAAO;;AMwDpB;;;cAG8B;EAAE,OAAO,ENrD1B,GAAO;;AMsDpB;;cAE8B;EAAE,OAAO,EN8E1B,GAAO;;AM7EpB;cAC8B;EAAE,OAAO,ENtD1B,GAAO;;AMuDpB;cAC8B;EAAE,OAAO,ENzR1B,GAAO;;AM0RpB,eAA+B;EAAE,OAAO,ENzJ1B,GAAO;;AM0JrB,oBAAoC;EAAE,OAAO,EN7I1B,GAAO;;AM8I1B,yBAAyC;EAAE,OAAO,EN2G1B,GAAO;;AM1G/B,0BAA0C;EAAE,OAAO,EN2G1B,GAAO;;AM1GhC,0BAA0C;EAAE,OAAO,EN2G1B,GAAO;;AM1GhC,2BAA2C;EAAE,OAAO,EN2G1B,GAAO;;AM1GjC,2BAA2C;EAAE,OAAO,EN8G1B,GAAO;;AM7GjC,4BAA4C;EAAE,OAAO,EN8G1B,GAAO;;AM7GlC,oBAAoC;EAAE,OAAO,ENgK1B,GAAO;;AM/J1B,sBAAsC;EAAE,OAAO,EN4J1B,GAAO;;AM3J5B,yBAAyC;EAAE,OAAO,ENwO1B,GAAO;;AMvO/B,kBAAkC;EAAE,OAAO,ENqO1B,GAAO;;AMpOxB,eAA+B;EAAE,OAAO,EN+N1B,GAAO;;AM9NrB,sBAAsC;EAAE,OAAO,EN+N1B,GAAO;;AM9N5B,uBAAuC;EAAE,OAAO,ENmO1B,GAAO;;AMlO7B,kBAAkC;EAAE,OAAO,ENxM1B,GAAO;;AMyMxB,yBAAyC;EAAE,OAAO,EN+G1B,GAAO;;AM9G/B,oBAAoC;EAAE,OAAO,ENnF1B,GAAO;;AMoF1B,iBAAiC;EAAE,OAAO,EN/I1B,GAAO;;AMgJvB,cAA8B;EAAE,OAAO,ENhX1B,GAAO;;AMiXpB,oBAAoC;EAAE,OAAO,ENxT1B,GAAO;;AMyT1B,2BAA2C;EAAE,OAAO,ENxT1B,GAAO;;AMyTjC,iBAAiC;EAAE,OAAO,ENyK1B,GAAO;;AMxKvB,wBAAwC;EAAE,OAAO,ENyK1B,GAAO;;AMxK9B,0BAA0C;EAAE,OAAO,ENtD1B,GAAO;;AMuDhC,wBAAwC;EAAE,OAAO,ENpD1B,GAAO;;AMqD9B,0BAA0C;EAAE,OAAO,ENvD1B,GAAO;;AMwDhC,2BAA2C;EAAE,OAAO,ENvD1B,GAAO;;AMwDjC,gBAAgC;EAAE,OAAO,ENxW1B,GAAO;;AMyWtB,kBAAkC;EAAE,OAAO,EN0M1B,GAAO;;AMzMxB,kBAAkC;EAAE,OAAO,ENpX1B,GAAO;;AMqXxB,gBAAgC;EAAE,OAAO,ENpE1B,GAAO;;AMqEtB,mBAAmC;EAAE,OAAO,EN1N1B,GAAO;;AM2NzB,gBAAgC;EAAE,OAAO,ENqE1B,GAAO;;AMpEtB,qBAAqC;EAAE,OAAO,ENtJ1B,GAAO;;AMuJ3B,iBAAiC;EAAE,OAAO,ENuJ1B,GAAO;;AMtJvB,iBAAiC;EAAE,OAAO,EN/L1B,GAAO;;AMgMvB,eAA+B;EAAE,OAAO,EN1D1B,GAAO;;AM2DrB;mBACmC;EAAE,OAAO,ENnI1B,GAAO;;AMoIzB,gBAAgC;EAAE,OAAO,EN2G1B,GAAO;;AM1GtB,iBAAiC;EAAE,OAAO,ENxC1B,GAAO;;AMyCvB,kBAAkC;EAAE,OAAO,ENrX1B,GAAO;;AMsXxB,cAA8B;EAAE,OAAO,ENpU1B,GAAO;;AMqUpB,aAA6B;EAAE,OAAO,ENgL1B,GAAO;;AM/KnB,gBAAgC;EAAE,OAAO,ENqL1B,GAAO;;AMpLtB,iBAAiC;EAAE,OAAO,ENa1B,GAAO;;AMZvB,oBAAoC;EAAE,OAAO,ENrC1B,GAAO;;AMsC1B,yBAAyC;EAAE,OAAO,EN8E1B,GAAO;;AM7E/B,+BAA+C;EAAE,OAAO,ENtX1B,GAAO;;AMuXrC,8BAA8C;EAAE,OAAO,ENxX1B,GAAO;;AMyXpC;8BAC8C;EAAE,OAAO,EN3T1B,GAAO;;AM4TpC,uBAAuC;EAAE,OAAO,ENjP1B,GAAO;;AMkP7B,qBAAqC;EAAE,OAAO,EN+K1B,GAAO;;AM9K3B,uBAAuC;EAAE,OAAO,ENmK1B,GAAO;;AMlK7B;cAC8B;EAAE,OAAO,ENoI1B,GAAO;;AMnIpB,wBAAwC;EAAE,OAAO,ENjB1B,GAAO;;AMkB9B,wBAAwC;EAAE,OAAO,EN6D1B,GAAO;;AM5D9B,gBAAgC;EAAE,OAAO,EN2C1B,GAAO;;AM1CtB,0BAA0C;EAAE,OAAO,EN7O1B,GAAO;;AM8OhC,oBAAoC;EAAE,OAAO,EN2K1B,GAAO;;AM1K1B,iBAAiC;EAAE,OAAO,ENvD1B,GAAO;;AMwDvB;;qBAEqC;EAAE,OAAO,ENsI1B,GAAO;;AMrI3B;yBACyC;EAAE,OAAO,ENjK1B,GAAO;;AMkK/B,gBAAgC;EAAE,OAAO,ENwK1B,GAAO;;AMvKtB,iBAAiC;EAAE,OAAO,ENvK1B,GAAO;;AMwKvB,iBAAiC;EAAE,OAAO,ENhB1B,GAAO;;AMiBvB,wBAAwC;EAAE,OAAO,ENhB1B,GAAO;;AMiB9B,6BAA6C;EAAE,OAAO,ENsE1B,GAAO;;AMrEnC,sBAAsC;EAAE,OAAO,ENoE1B,GAAO;;AMnE5B,oBAAoC;EAAE,OAAO,EN7Q1B,GAAO;;AM8Q1B,eAA+B;EAAE,OAAO,EN1Q1B,GAAO;;AM2QrB,qBAAqC;EAAE,OAAO,ENjD1B,GAAO;;AMkD3B,yBAAyC;EAAE,OAAO,ENjD1B,GAAO;;AMkD/B,iBAAiC;EAAE,OAAO,ENvQ1B,GAAO;;AMwQvB,iBAAiC;EAAE,OAAO,EN9I1B,GAAO;;AM+IvB,mBAAmC;EAAE,OAAO,ENzI1B,GAAO;;AM0IzB,cAA8B;EAAE,OAAO,EN9O1B,GAAO;;AM+OpB,mBAAmC;EAAE,OAAO,EN3W1B,GAAO;;AM4WzB,gBAAgC;EAAE,OAAO,EN9T1B,GAAO;;AM+TtB,cAA8B;EAAE,OAAO,ENnE1B,GAAO;;AMoEpB,gBAAgC;EAAE,OAAO,ENoC1B,GAAO;;AMnCtB,eAA+B;EAAE,OAAO,ENjS1B,GAAO;;AMkSrB,gBAAgC;EAAE,OAAO,ENjS1B,GAAO;;AMkStB,kBAAkC;EAAE,OAAO,ENtY1B,GAAO;;AMuYxB,yBAAyC;EAAE,OAAO,ENtY1B,GAAO;;AMuY/B,gBAAgC;EAAE,OAAO,EN2C1B,GAAO;;AM1CtB,uBAAuC;EAAE,OAAO,EN2C1B,GAAO;;AM1C7B,kBAAkC;EAAE,OAAO,ENvC1B,GAAO;;AMwCxB;cAC8B;EAAE,OAAO,EN3W1B,GAAO;;AM4WpB;eAC+B;EAAE,OAAO,EN2D1B,GAAO;;AM1DrB,eAA+B;EAAE,OAAO,ENuF1B,GAAO;;AMtFrB,kBAAkC;EAAE,OAAO,ENwB1B,GAAO;;AMvBxB,qBAAqC;EAAE,OAAO,ENpS1B,GAAO;;AMqS3B,qBAAqC;EAAE,OAAO,ENkB1B,GAAO;;AMjB3B,mBAAmC;EAAE,OAAO,EN1S1B,GAAO;;AM2SzB,qBAAqC;EAAE,OAAO,ENxP1B,GAAO;;AMyP3B,sBAAsC;EAAE,OAAO,ENjP1B,GAAO;;AMkP5B,uBAAuC;EAAE,OAAO,EN9P1B,GAAO;;AM+P7B,4BAA4C;EAAE,OAAO,ENxP1B,GAAO;;AMyPlC;;uBAEuC;EAAE,OAAO,ENjQ1B,GAAO;;AMkQ7B;yBACyC;EAAE,OAAO,ENvQ1B,GAAO;;AMwQ/B;uBACuC;EAAE,OAAO,ENxQ1B,GAAO;;AMyQ7B;uBACuC;EAAE,OAAO,EN7P1B,GAAO;;AM8P7B,sBAAsC;EAAE,OAAO,EN1Q1B,GAAO;;AM2Q5B,eAA+B;EAAE,OAAO,ENsG1B,GAAO;;AMrGrB,kBAAkC;EAAE,OAAO,ENlV1B,GAAO;;AMmVxB,mBAAmC;EAAE,OAAO,ENnL1B,GAAO;;AMoLzB;;;;oBAIoC;EAAE,OAAO,ENxK1B,GAAO;;AMyK1B,yBAAyC;EAAE,OAAO,ENpW1B,GAAO;;AMqW/B;gBACgC;EAAE,OAAO,EN1E1B,GAAO;;AM2EtB;iBACiC;EAAE,OAAO,ENpT1B,GAAO;;AMqTvB,qBAAqC;EAAE,OAAO,EN1O1B,GAAO;;AM2O3B,cAA8B;EAAE,OAAO,EN5O1B,GAAO;;AM6OpB,sBAAsC;EAAE,OAAO,EN7N1B,GAAO;;AM8N5B,wBAAwC;EAAE,OAAO,ENwB1B,GAAO;;AMvB9B,aAA6B;EAAE,OAAO,ENzF1B,GAAO;;AM0FnB;iBACiC;EAAE,OAAO,EN2F1B,GAAO;;AM1FvB;sBACsC;EAAE,OAAO,EN9H1B,GAAO;;AM+H5B;wBACwC;EAAE,OAAO,EN/H1B,GAAO;;AMgI9B,kBAAkC;EAAE,OAAO,EN3N1B,GAAO;;AM4NxB;sBACsC;EAAE,OAAO,ENrX1B,GAAO;;AMsX5B,iBAAiC;EAAE,OAAO,ENnO1B,GAAO;;AMoOvB,oBAAoC;EAAE,OAAO,ENlI1B,GAAO;;AMmI1B,kBAAkC;EAAE,OAAO,EN1C1B,GAAO;;AM2CxB,oBAAoC;EAAE,OAAO,EN7D1B,GAAO;;AM8D1B,2BAA2C;EAAE,OAAO,EN7D1B,GAAO;;AM8DjC,eAA+B;EAAE,OAAO,ENpb1B,GAAO;;AMqbrB;mBACmC;EAAE,OAAO,ENzQ1B,GAAO;;AM0QzB,cAA8B;EAAE,OAAO,ENsC1B,GAAO;;AMrCpB,qBAAqC;EAAE,OAAO,EN/b1B,GAAO;;AMgc3B,eAA+B;EAAE,OAAO,ENrH1B,GAAO;;AMsHrB,qBAAqC;EAAE,OAAO,ENlD1B,GAAO;;AMmD3B,iBAAiC;EAAE,OAAO,ENsC1B,GAAO;;AMrCvB,eAA+B;EAAE,OAAO,ENiF1B,GAAO;;AMhFrB,sBAAsC;EAAE,OAAO,ENvJ1B,GAAO;;AMwJ5B,eAA+B;EAAE,OAAO,ENuE1B,GAAO;;AMtErB,qBAAqC;EAAE,OAAO,ENjb1B,GAAO;;AMkb3B,iBAAiC;EAAE,OAAO,EN9I1B,GAAO;;AM+IvB,wBAAwC;EAAE,OAAO,ENhQ1B,GAAO;;AMiQ9B,kBAAkC;EAAE,OAAO,EN9Z1B,GAAO;;AM+ZxB,wBAAwC;EAAE,OAAO,ENla1B,GAAO;;AMma9B,sBAAsC;EAAE,OAAO,ENpa1B,GAAO;;AMqa5B,kBAAkC;EAAE,OAAO,ENta1B,GAAO;;AMuaxB,oBAAoC;EAAE,OAAO,ENpa1B,GAAO;;AMqa1B,oBAAoC;EAAE,OAAO,ENpa1B,GAAO;;AMqa1B,qBAAqC;EAAE,OAAO,ENld1B,GAAO;;AMmd3B,uBAAuC;EAAE,OAAO,ENld1B,GAAO;;AMmd7B,gBAAgC;EAAE,OAAO,ENY1B,GAAO;;AMXtB,oBAAoC;EAAE,OAAO,EN3X1B,GAAO;;AM4X1B,aAA6B;EAAE,OAAO,ENre1B,GAAO;;AMsenB,qBAAqC;EAAE,OAAO,ENjV1B,GAAO;;AMkV3B,sBAAsC;EAAE,OAAO,ENpK1B,GAAO;;AMqK5B,wBAAwC;EAAE,OAAO,ENrd1B,GAAO;;AMsd9B,qBAAqC;EAAE,OAAO,EN3f1B,GAAO;;AM4f3B,oBAAoC;EAAE,OAAO,ENvJ1B,GAAO;;AMwJ1B,qBAAqC;EAAE,OAAO,EN5N1B,GAAO;;AM6N3B,iBAAiC;EAAE,OAAO,EN1O1B,GAAO;;AM2OvB,wBAAwC;EAAE,OAAO,EN1O1B,GAAO;;AM2O9B,qBAAqC;EAAE,OAAO,ENN1B,GAAO;;AMO3B,oBAAoC;EAAE,OAAO,ENN1B,GAAO;;AMO1B,kBAAkC;EAAE,OAAO,EN/d1B,GAAO;;AMgexB,cAA8B;EAAE,OAAO,EN7c1B,GAAO;;AM8cpB,kBAAkC;EAAE,OAAO,EN1P1B,GAAO;;AM2PxB,oBAAoC;EAAE,OAAO,ENhhB1B,GAAO;;AMihB1B,aAA6B;EAAE,OAAO,EN7b1B,GAAO;;AM8bnB;;cAE8B;EAAE,OAAO,ENxQ1B,GAAO;;AMyQpB,mBAAmC;EAAE,OAAO,EN7M1B,GAAO;;AM8MzB,qBAAqC;EAAE,OAAO,ENpd1B,GAAO;;AMqd3B,yBAAyC;EAAE,OAAO,ENnZ1B,GAAO;;AMoZ/B,mBAAmC;EAAE,OAAO,ENxY1B,GAAO;;AMyYzB,mBAAmC;EAAE,OAAO,EN1T1B,GAAO;;AM2TzB,kBAAkC;EAAE,OAAO,ENxP1B,GAAO;;AMyPxB,iBAAiC;EAAE,OAAO,ENrH1B,GAAO;;AMsHvB,uBAAuC;EAAE,OAAO,ENzG1B,GAAO;;AM0G7B,sBAAsC;EAAE,OAAO,ENrG1B,GAAO;;AMsG5B,mBAAmC;EAAE,OAAO,ENpG1B,GAAO;;AMqGzB,oBAAoC;EAAE,OAAO,EN5c1B,GAAO;;AM6c1B,0BAA0C;EAAE,OAAO,EN9c1B,GAAO;;AM+chC,kBAAkC;EAAE,OAAO,EN3Y1B,GAAO;;AM4YxB,eAA+B;EAAE,OAAO,ENhH1B,GAAO;;AMiHrB,sBAAsC;EAAE,OAAO,ENI1B,GAAO;;AMH5B,qBAAqC;EAAE,OAAO,EN5M1B,GAAO;;AM6M3B,sBAAsC;EAAE,OAAO,ENpE1B,GAAO;;AMqE5B,oBAAoC;EAAE,OAAO,ENhS1B,GAAO;;AMiS1B,gBAAgC;EAAE,OAAO,ENG1B,GAAO;;AMFtB,eAA+B;EAAE,OAAO,ENtO1B,GAAO;;AMuOrB,kBAAkC;EAAE,OAAO,EN7N1B,GAAO;;AM8NxB,sBAAsC;EAAE,OAAO,ENhC1B,GAAO;;AMiC5B,0BAA0C;EAAE,OAAO,ENhC1B,GAAO;;AMiChC,uBAAuC;EAAE,OAAO,END1B,GAAO;;AME7B,sBAAsC;EAAE,OAAO,EN1O1B,GAAO;;AM2O5B,qBAAqC;EAAE,OAAO,ENF1B,GAAO;;AMG3B,sBAAsC;EAAE,OAAO,EN3O1B,GAAO;;AM4O5B,wBAAwC;EAAE,OAAO,EN1O1B,GAAO;;AM2O9B,wBAAwC;EAAE,OAAO,EN5O1B,GAAO;;AM6O9B,iBAAiC;EAAE,OAAO,ENvN1B,GAAO;;AMwNvB,4BAA4C;EAAE,OAAO,EN9X1B,GAAO;;AM+XlC,sBAAsC;EAAE,OAAO,ENhM1B,GAAO;;AMiM5B,mBAAmC;EAAE,OAAO,ENI1B,GAAO;;AMHzB,iBAAiC;EAAE,OAAO,EN7I1B,GAAO;;AM8IvB,oBAAoC;EAAE,OAAO,ENjB1B,GAAO;;AMkB1B,qBAAqC;EAAE,OAAO,ENhB1B,GAAO;;AMiB3B;cAC8B;EAAE,OAAO,ENphB1B,GAAO;;AMqhBpB,kBAAkC;EAAE,OAAO,ENd1B,GAAO;;AMexB,gBAAgC;EAAE,OAAO,ENnD1B,GAAO;;AMoDtB,iBAAiC;EAAE,OAAO,ENvF1B,GAAO;;AMwFvB,iBAAiC;EAAE,OAAO,ENrP1B,GAAO", +"sources": ["../scss/_path.scss","../scss/_core.scss","../scss/_larger.scss","../scss/_fixed-width.scss","../scss/_list.scss","../scss/_variables.scss","../scss/_bordered-pulled.scss","../scss/_animated.scss","../scss/_rotated-flipped.scss","../scss/_mixins.scss","../scss/_stacked.scss","../scss/_icons.scss"], +"names": [], +"file": "font-awesome.css" +} diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/css/font-awesome.min.css b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/css/font-awesome.min.css new file mode 100755 index 0000000000000..540440ce89f2a --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/css/font-awesome.min.css @@ -0,0 +1,4 @@ +/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:'FontAwesome';src:url('../fonts/fontawesome-webfont.eot?v=4.7.0');src:url('../fonts/fontawesome-webfont.eot?#iefix&v=4.7.0') format('embedded-opentype'),url('../fonts/fontawesome-webfont.woff2?v=4.7.0') format('woff2'),url('../fonts/fontawesome-webfont.woff?v=4.7.0') format('woff'),url('../fonts/fontawesome-webfont.ttf?v=4.7.0') format('truetype'),url('../fonts/fontawesome-webfont.svg?v=4.7.0#fontawesomeregular') format('svg');font-weight:normal;font-style:normal}.fa{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571429em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14285714em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14285714em;width:2.14285714em;top:.14285714em;text-align:center}.fa-li.fa-lg{left:-1.85714286em}.fa-border{padding:.2em .25em .15em;border:solid .08em #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa.fa-pull-left{margin-right:.3em}.fa.fa-pull-right{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left{margin-right:.3em}.fa.pull-right{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s infinite linear;animation:fa-spin 2s infinite linear}.fa-pulse{-webkit-animation:fa-spin 1s infinite steps(8);animation:fa-spin 1s infinite steps(8)}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scale(-1, 1);-ms-transform:scale(-1, 1);transform:scale(-1, 1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scale(1, -1);-ms-transform:scale(1, -1);transform:scale(1, -1)}:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270,:root .fa-flip-horizontal,:root .fa-flip-vertical{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:"\f000"}.fa-music:before{content:"\f001"}.fa-search:before{content:"\f002"}.fa-envelope-o:before{content:"\f003"}.fa-heart:before{content:"\f004"}.fa-star:before{content:"\f005"}.fa-star-o:before{content:"\f006"}.fa-user:before{content:"\f007"}.fa-film:before{content:"\f008"}.fa-th-large:before{content:"\f009"}.fa-th:before{content:"\f00a"}.fa-th-list:before{content:"\f00b"}.fa-check:before{content:"\f00c"}.fa-remove:before,.fa-close:before,.fa-times:before{content:"\f00d"}.fa-search-plus:before{content:"\f00e"}.fa-search-minus:before{content:"\f010"}.fa-power-off:before{content:"\f011"}.fa-signal:before{content:"\f012"}.fa-gear:before,.fa-cog:before{content:"\f013"}.fa-trash-o:before{content:"\f014"}.fa-home:before{content:"\f015"}.fa-file-o:before{content:"\f016"}.fa-clock-o:before{content:"\f017"}.fa-road:before{content:"\f018"}.fa-download:before{content:"\f019"}.fa-arrow-circle-o-down:before{content:"\f01a"}.fa-arrow-circle-o-up:before{content:"\f01b"}.fa-inbox:before{content:"\f01c"}.fa-play-circle-o:before{content:"\f01d"}.fa-rotate-right:before,.fa-repeat:before{content:"\f01e"}.fa-refresh:before{content:"\f021"}.fa-list-alt:before{content:"\f022"}.fa-lock:before{content:"\f023"}.fa-flag:before{content:"\f024"}.fa-headphones:before{content:"\f025"}.fa-volume-off:before{content:"\f026"}.fa-volume-down:before{content:"\f027"}.fa-volume-up:before{content:"\f028"}.fa-qrcode:before{content:"\f029"}.fa-barcode:before{content:"\f02a"}.fa-tag:before{content:"\f02b"}.fa-tags:before{content:"\f02c"}.fa-book:before{content:"\f02d"}.fa-bookmark:before{content:"\f02e"}.fa-print:before{content:"\f02f"}.fa-camera:before{content:"\f030"}.fa-font:before{content:"\f031"}.fa-bold:before{content:"\f032"}.fa-italic:before{content:"\f033"}.fa-text-height:before{content:"\f034"}.fa-text-width:before{content:"\f035"}.fa-align-left:before{content:"\f036"}.fa-align-center:before{content:"\f037"}.fa-align-right:before{content:"\f038"}.fa-align-justify:before{content:"\f039"}.fa-list:before{content:"\f03a"}.fa-dedent:before,.fa-outdent:before{content:"\f03b"}.fa-indent:before{content:"\f03c"}.fa-video-camera:before{content:"\f03d"}.fa-photo:before,.fa-image:before,.fa-picture-o:before{content:"\f03e"}.fa-pencil:before{content:"\f040"}.fa-map-marker:before{content:"\f041"}.fa-adjust:before{content:"\f042"}.fa-tint:before{content:"\f043"}.fa-edit:before,.fa-pencil-square-o:before{content:"\f044"}.fa-share-square-o:before{content:"\f045"}.fa-check-square-o:before{content:"\f046"}.fa-arrows:before{content:"\f047"}.fa-step-backward:before{content:"\f048"}.fa-fast-backward:before{content:"\f049"}.fa-backward:before{content:"\f04a"}.fa-play:before{content:"\f04b"}.fa-pause:before{content:"\f04c"}.fa-stop:before{content:"\f04d"}.fa-forward:before{content:"\f04e"}.fa-fast-forward:before{content:"\f050"}.fa-step-forward:before{content:"\f051"}.fa-eject:before{content:"\f052"}.fa-chevron-left:before{content:"\f053"}.fa-chevron-right:before{content:"\f054"}.fa-plus-circle:before{content:"\f055"}.fa-minus-circle:before{content:"\f056"}.fa-times-circle:before{content:"\f057"}.fa-check-circle:before{content:"\f058"}.fa-question-circle:before{content:"\f059"}.fa-info-circle:before{content:"\f05a"}.fa-crosshairs:before{content:"\f05b"}.fa-times-circle-o:before{content:"\f05c"}.fa-check-circle-o:before{content:"\f05d"}.fa-ban:before{content:"\f05e"}.fa-arrow-left:before{content:"\f060"}.fa-arrow-right:before{content:"\f061"}.fa-arrow-up:before{content:"\f062"}.fa-arrow-down:before{content:"\f063"}.fa-mail-forward:before,.fa-share:before{content:"\f064"}.fa-expand:before{content:"\f065"}.fa-compress:before{content:"\f066"}.fa-plus:before{content:"\f067"}.fa-minus:before{content:"\f068"}.fa-asterisk:before{content:"\f069"}.fa-exclamation-circle:before{content:"\f06a"}.fa-gift:before{content:"\f06b"}.fa-leaf:before{content:"\f06c"}.fa-fire:before{content:"\f06d"}.fa-eye:before{content:"\f06e"}.fa-eye-slash:before{content:"\f070"}.fa-warning:before,.fa-exclamation-triangle:before{content:"\f071"}.fa-plane:before{content:"\f072"}.fa-calendar:before{content:"\f073"}.fa-random:before{content:"\f074"}.fa-comment:before{content:"\f075"}.fa-magnet:before{content:"\f076"}.fa-chevron-up:before{content:"\f077"}.fa-chevron-down:before{content:"\f078"}.fa-retweet:before{content:"\f079"}.fa-shopping-cart:before{content:"\f07a"}.fa-folder:before{content:"\f07b"}.fa-folder-open:before{content:"\f07c"}.fa-arrows-v:before{content:"\f07d"}.fa-arrows-h:before{content:"\f07e"}.fa-bar-chart-o:before,.fa-bar-chart:before{content:"\f080"}.fa-twitter-square:before{content:"\f081"}.fa-facebook-square:before{content:"\f082"}.fa-camera-retro:before{content:"\f083"}.fa-key:before{content:"\f084"}.fa-gears:before,.fa-cogs:before{content:"\f085"}.fa-comments:before{content:"\f086"}.fa-thumbs-o-up:before{content:"\f087"}.fa-thumbs-o-down:before{content:"\f088"}.fa-star-half:before{content:"\f089"}.fa-heart-o:before{content:"\f08a"}.fa-sign-out:before{content:"\f08b"}.fa-linkedin-square:before{content:"\f08c"}.fa-thumb-tack:before{content:"\f08d"}.fa-external-link:before{content:"\f08e"}.fa-sign-in:before{content:"\f090"}.fa-trophy:before{content:"\f091"}.fa-github-square:before{content:"\f092"}.fa-upload:before{content:"\f093"}.fa-lemon-o:before{content:"\f094"}.fa-phone:before{content:"\f095"}.fa-square-o:before{content:"\f096"}.fa-bookmark-o:before{content:"\f097"}.fa-phone-square:before{content:"\f098"}.fa-twitter:before{content:"\f099"}.fa-facebook-f:before,.fa-facebook:before{content:"\f09a"}.fa-github:before{content:"\f09b"}.fa-unlock:before{content:"\f09c"}.fa-credit-card:before{content:"\f09d"}.fa-feed:before,.fa-rss:before{content:"\f09e"}.fa-hdd-o:before{content:"\f0a0"}.fa-bullhorn:before{content:"\f0a1"}.fa-bell:before{content:"\f0f3"}.fa-certificate:before{content:"\f0a3"}.fa-hand-o-right:before{content:"\f0a4"}.fa-hand-o-left:before{content:"\f0a5"}.fa-hand-o-up:before{content:"\f0a6"}.fa-hand-o-down:before{content:"\f0a7"}.fa-arrow-circle-left:before{content:"\f0a8"}.fa-arrow-circle-right:before{content:"\f0a9"}.fa-arrow-circle-up:before{content:"\f0aa"}.fa-arrow-circle-down:before{content:"\f0ab"}.fa-globe:before{content:"\f0ac"}.fa-wrench:before{content:"\f0ad"}.fa-tasks:before{content:"\f0ae"}.fa-filter:before{content:"\f0b0"}.fa-briefcase:before{content:"\f0b1"}.fa-arrows-alt:before{content:"\f0b2"}.fa-group:before,.fa-users:before{content:"\f0c0"}.fa-chain:before,.fa-link:before{content:"\f0c1"}.fa-cloud:before{content:"\f0c2"}.fa-flask:before{content:"\f0c3"}.fa-cut:before,.fa-scissors:before{content:"\f0c4"}.fa-copy:before,.fa-files-o:before{content:"\f0c5"}.fa-paperclip:before{content:"\f0c6"}.fa-save:before,.fa-floppy-o:before{content:"\f0c7"}.fa-square:before{content:"\f0c8"}.fa-navicon:before,.fa-reorder:before,.fa-bars:before{content:"\f0c9"}.fa-list-ul:before{content:"\f0ca"}.fa-list-ol:before{content:"\f0cb"}.fa-strikethrough:before{content:"\f0cc"}.fa-underline:before{content:"\f0cd"}.fa-table:before{content:"\f0ce"}.fa-magic:before{content:"\f0d0"}.fa-truck:before{content:"\f0d1"}.fa-pinterest:before{content:"\f0d2"}.fa-pinterest-square:before{content:"\f0d3"}.fa-google-plus-square:before{content:"\f0d4"}.fa-google-plus:before{content:"\f0d5"}.fa-money:before{content:"\f0d6"}.fa-caret-down:before{content:"\f0d7"}.fa-caret-up:before{content:"\f0d8"}.fa-caret-left:before{content:"\f0d9"}.fa-caret-right:before{content:"\f0da"}.fa-columns:before{content:"\f0db"}.fa-unsorted:before,.fa-sort:before{content:"\f0dc"}.fa-sort-down:before,.fa-sort-desc:before{content:"\f0dd"}.fa-sort-up:before,.fa-sort-asc:before{content:"\f0de"}.fa-envelope:before{content:"\f0e0"}.fa-linkedin:before{content:"\f0e1"}.fa-rotate-left:before,.fa-undo:before{content:"\f0e2"}.fa-legal:before,.fa-gavel:before{content:"\f0e3"}.fa-dashboard:before,.fa-tachometer:before{content:"\f0e4"}.fa-comment-o:before{content:"\f0e5"}.fa-comments-o:before{content:"\f0e6"}.fa-flash:before,.fa-bolt:before{content:"\f0e7"}.fa-sitemap:before{content:"\f0e8"}.fa-umbrella:before{content:"\f0e9"}.fa-paste:before,.fa-clipboard:before{content:"\f0ea"}.fa-lightbulb-o:before{content:"\f0eb"}.fa-exchange:before{content:"\f0ec"}.fa-cloud-download:before{content:"\f0ed"}.fa-cloud-upload:before{content:"\f0ee"}.fa-user-md:before{content:"\f0f0"}.fa-stethoscope:before{content:"\f0f1"}.fa-suitcase:before{content:"\f0f2"}.fa-bell-o:before{content:"\f0a2"}.fa-coffee:before{content:"\f0f4"}.fa-cutlery:before{content:"\f0f5"}.fa-file-text-o:before{content:"\f0f6"}.fa-building-o:before{content:"\f0f7"}.fa-hospital-o:before{content:"\f0f8"}.fa-ambulance:before{content:"\f0f9"}.fa-medkit:before{content:"\f0fa"}.fa-fighter-jet:before{content:"\f0fb"}.fa-beer:before{content:"\f0fc"}.fa-h-square:before{content:"\f0fd"}.fa-plus-square:before{content:"\f0fe"}.fa-angle-double-left:before{content:"\f100"}.fa-angle-double-right:before{content:"\f101"}.fa-angle-double-up:before{content:"\f102"}.fa-angle-double-down:before{content:"\f103"}.fa-angle-left:before{content:"\f104"}.fa-angle-right:before{content:"\f105"}.fa-angle-up:before{content:"\f106"}.fa-angle-down:before{content:"\f107"}.fa-desktop:before{content:"\f108"}.fa-laptop:before{content:"\f109"}.fa-tablet:before{content:"\f10a"}.fa-mobile-phone:before,.fa-mobile:before{content:"\f10b"}.fa-circle-o:before{content:"\f10c"}.fa-quote-left:before{content:"\f10d"}.fa-quote-right:before{content:"\f10e"}.fa-spinner:before{content:"\f110"}.fa-circle:before{content:"\f111"}.fa-mail-reply:before,.fa-reply:before{content:"\f112"}.fa-github-alt:before{content:"\f113"}.fa-folder-o:before{content:"\f114"}.fa-folder-open-o:before{content:"\f115"}.fa-smile-o:before{content:"\f118"}.fa-frown-o:before{content:"\f119"}.fa-meh-o:before{content:"\f11a"}.fa-gamepad:before{content:"\f11b"}.fa-keyboard-o:before{content:"\f11c"}.fa-flag-o:before{content:"\f11d"}.fa-flag-checkered:before{content:"\f11e"}.fa-terminal:before{content:"\f120"}.fa-code:before{content:"\f121"}.fa-mail-reply-all:before,.fa-reply-all:before{content:"\f122"}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:"\f123"}.fa-location-arrow:before{content:"\f124"}.fa-crop:before{content:"\f125"}.fa-code-fork:before{content:"\f126"}.fa-unlink:before,.fa-chain-broken:before{content:"\f127"}.fa-question:before{content:"\f128"}.fa-info:before{content:"\f129"}.fa-exclamation:before{content:"\f12a"}.fa-superscript:before{content:"\f12b"}.fa-subscript:before{content:"\f12c"}.fa-eraser:before{content:"\f12d"}.fa-puzzle-piece:before{content:"\f12e"}.fa-microphone:before{content:"\f130"}.fa-microphone-slash:before{content:"\f131"}.fa-shield:before{content:"\f132"}.fa-calendar-o:before{content:"\f133"}.fa-fire-extinguisher:before{content:"\f134"}.fa-rocket:before{content:"\f135"}.fa-maxcdn:before{content:"\f136"}.fa-chevron-circle-left:before{content:"\f137"}.fa-chevron-circle-right:before{content:"\f138"}.fa-chevron-circle-up:before{content:"\f139"}.fa-chevron-circle-down:before{content:"\f13a"}.fa-html5:before{content:"\f13b"}.fa-css3:before{content:"\f13c"}.fa-anchor:before{content:"\f13d"}.fa-unlock-alt:before{content:"\f13e"}.fa-bullseye:before{content:"\f140"}.fa-ellipsis-h:before{content:"\f141"}.fa-ellipsis-v:before{content:"\f142"}.fa-rss-square:before{content:"\f143"}.fa-play-circle:before{content:"\f144"}.fa-ticket:before{content:"\f145"}.fa-minus-square:before{content:"\f146"}.fa-minus-square-o:before{content:"\f147"}.fa-level-up:before{content:"\f148"}.fa-level-down:before{content:"\f149"}.fa-check-square:before{content:"\f14a"}.fa-pencil-square:before{content:"\f14b"}.fa-external-link-square:before{content:"\f14c"}.fa-share-square:before{content:"\f14d"}.fa-compass:before{content:"\f14e"}.fa-toggle-down:before,.fa-caret-square-o-down:before{content:"\f150"}.fa-toggle-up:before,.fa-caret-square-o-up:before{content:"\f151"}.fa-toggle-right:before,.fa-caret-square-o-right:before{content:"\f152"}.fa-euro:before,.fa-eur:before{content:"\f153"}.fa-gbp:before{content:"\f154"}.fa-dollar:before,.fa-usd:before{content:"\f155"}.fa-rupee:before,.fa-inr:before{content:"\f156"}.fa-cny:before,.fa-rmb:before,.fa-yen:before,.fa-jpy:before{content:"\f157"}.fa-ruble:before,.fa-rouble:before,.fa-rub:before{content:"\f158"}.fa-won:before,.fa-krw:before{content:"\f159"}.fa-bitcoin:before,.fa-btc:before{content:"\f15a"}.fa-file:before{content:"\f15b"}.fa-file-text:before{content:"\f15c"}.fa-sort-alpha-asc:before{content:"\f15d"}.fa-sort-alpha-desc:before{content:"\f15e"}.fa-sort-amount-asc:before{content:"\f160"}.fa-sort-amount-desc:before{content:"\f161"}.fa-sort-numeric-asc:before{content:"\f162"}.fa-sort-numeric-desc:before{content:"\f163"}.fa-thumbs-up:before{content:"\f164"}.fa-thumbs-down:before{content:"\f165"}.fa-youtube-square:before{content:"\f166"}.fa-youtube:before{content:"\f167"}.fa-xing:before{content:"\f168"}.fa-xing-square:before{content:"\f169"}.fa-youtube-play:before{content:"\f16a"}.fa-dropbox:before{content:"\f16b"}.fa-stack-overflow:before{content:"\f16c"}.fa-instagram:before{content:"\f16d"}.fa-flickr:before{content:"\f16e"}.fa-adn:before{content:"\f170"}.fa-bitbucket:before{content:"\f171"}.fa-bitbucket-square:before{content:"\f172"}.fa-tumblr:before{content:"\f173"}.fa-tumblr-square:before{content:"\f174"}.fa-long-arrow-down:before{content:"\f175"}.fa-long-arrow-up:before{content:"\f176"}.fa-long-arrow-left:before{content:"\f177"}.fa-long-arrow-right:before{content:"\f178"}.fa-apple:before{content:"\f179"}.fa-windows:before{content:"\f17a"}.fa-android:before{content:"\f17b"}.fa-linux:before{content:"\f17c"}.fa-dribbble:before{content:"\f17d"}.fa-skype:before{content:"\f17e"}.fa-foursquare:before{content:"\f180"}.fa-trello:before{content:"\f181"}.fa-female:before{content:"\f182"}.fa-male:before{content:"\f183"}.fa-gittip:before,.fa-gratipay:before{content:"\f184"}.fa-sun-o:before{content:"\f185"}.fa-moon-o:before{content:"\f186"}.fa-archive:before{content:"\f187"}.fa-bug:before{content:"\f188"}.fa-vk:before{content:"\f189"}.fa-weibo:before{content:"\f18a"}.fa-renren:before{content:"\f18b"}.fa-pagelines:before{content:"\f18c"}.fa-stack-exchange:before{content:"\f18d"}.fa-arrow-circle-o-right:before{content:"\f18e"}.fa-arrow-circle-o-left:before{content:"\f190"}.fa-toggle-left:before,.fa-caret-square-o-left:before{content:"\f191"}.fa-dot-circle-o:before{content:"\f192"}.fa-wheelchair:before{content:"\f193"}.fa-vimeo-square:before{content:"\f194"}.fa-turkish-lira:before,.fa-try:before{content:"\f195"}.fa-plus-square-o:before{content:"\f196"}.fa-space-shuttle:before{content:"\f197"}.fa-slack:before{content:"\f198"}.fa-envelope-square:before{content:"\f199"}.fa-wordpress:before{content:"\f19a"}.fa-openid:before{content:"\f19b"}.fa-institution:before,.fa-bank:before,.fa-university:before{content:"\f19c"}.fa-mortar-board:before,.fa-graduation-cap:before{content:"\f19d"}.fa-yahoo:before{content:"\f19e"}.fa-google:before{content:"\f1a0"}.fa-reddit:before{content:"\f1a1"}.fa-reddit-square:before{content:"\f1a2"}.fa-stumbleupon-circle:before{content:"\f1a3"}.fa-stumbleupon:before{content:"\f1a4"}.fa-delicious:before{content:"\f1a5"}.fa-digg:before{content:"\f1a6"}.fa-pied-piper-pp:before{content:"\f1a7"}.fa-pied-piper-alt:before{content:"\f1a8"}.fa-drupal:before{content:"\f1a9"}.fa-joomla:before{content:"\f1aa"}.fa-language:before{content:"\f1ab"}.fa-fax:before{content:"\f1ac"}.fa-building:before{content:"\f1ad"}.fa-child:before{content:"\f1ae"}.fa-paw:before{content:"\f1b0"}.fa-spoon:before{content:"\f1b1"}.fa-cube:before{content:"\f1b2"}.fa-cubes:before{content:"\f1b3"}.fa-behance:before{content:"\f1b4"}.fa-behance-square:before{content:"\f1b5"}.fa-steam:before{content:"\f1b6"}.fa-steam-square:before{content:"\f1b7"}.fa-recycle:before{content:"\f1b8"}.fa-automobile:before,.fa-car:before{content:"\f1b9"}.fa-cab:before,.fa-taxi:before{content:"\f1ba"}.fa-tree:before{content:"\f1bb"}.fa-spotify:before{content:"\f1bc"}.fa-deviantart:before{content:"\f1bd"}.fa-soundcloud:before{content:"\f1be"}.fa-database:before{content:"\f1c0"}.fa-file-pdf-o:before{content:"\f1c1"}.fa-file-word-o:before{content:"\f1c2"}.fa-file-excel-o:before{content:"\f1c3"}.fa-file-powerpoint-o:before{content:"\f1c4"}.fa-file-photo-o:before,.fa-file-picture-o:before,.fa-file-image-o:before{content:"\f1c5"}.fa-file-zip-o:before,.fa-file-archive-o:before{content:"\f1c6"}.fa-file-sound-o:before,.fa-file-audio-o:before{content:"\f1c7"}.fa-file-movie-o:before,.fa-file-video-o:before{content:"\f1c8"}.fa-file-code-o:before{content:"\f1c9"}.fa-vine:before{content:"\f1ca"}.fa-codepen:before{content:"\f1cb"}.fa-jsfiddle:before{content:"\f1cc"}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-saver:before,.fa-support:before,.fa-life-ring:before{content:"\f1cd"}.fa-circle-o-notch:before{content:"\f1ce"}.fa-ra:before,.fa-resistance:before,.fa-rebel:before{content:"\f1d0"}.fa-ge:before,.fa-empire:before{content:"\f1d1"}.fa-git-square:before{content:"\f1d2"}.fa-git:before{content:"\f1d3"}.fa-y-combinator-square:before,.fa-yc-square:before,.fa-hacker-news:before{content:"\f1d4"}.fa-tencent-weibo:before{content:"\f1d5"}.fa-qq:before{content:"\f1d6"}.fa-wechat:before,.fa-weixin:before{content:"\f1d7"}.fa-send:before,.fa-paper-plane:before{content:"\f1d8"}.fa-send-o:before,.fa-paper-plane-o:before{content:"\f1d9"}.fa-history:before{content:"\f1da"}.fa-circle-thin:before{content:"\f1db"}.fa-header:before{content:"\f1dc"}.fa-paragraph:before{content:"\f1dd"}.fa-sliders:before{content:"\f1de"}.fa-share-alt:before{content:"\f1e0"}.fa-share-alt-square:before{content:"\f1e1"}.fa-bomb:before{content:"\f1e2"}.fa-soccer-ball-o:before,.fa-futbol-o:before{content:"\f1e3"}.fa-tty:before{content:"\f1e4"}.fa-binoculars:before{content:"\f1e5"}.fa-plug:before{content:"\f1e6"}.fa-slideshare:before{content:"\f1e7"}.fa-twitch:before{content:"\f1e8"}.fa-yelp:before{content:"\f1e9"}.fa-newspaper-o:before{content:"\f1ea"}.fa-wifi:before{content:"\f1eb"}.fa-calculator:before{content:"\f1ec"}.fa-paypal:before{content:"\f1ed"}.fa-google-wallet:before{content:"\f1ee"}.fa-cc-visa:before{content:"\f1f0"}.fa-cc-mastercard:before{content:"\f1f1"}.fa-cc-discover:before{content:"\f1f2"}.fa-cc-amex:before{content:"\f1f3"}.fa-cc-paypal:before{content:"\f1f4"}.fa-cc-stripe:before{content:"\f1f5"}.fa-bell-slash:before{content:"\f1f6"}.fa-bell-slash-o:before{content:"\f1f7"}.fa-trash:before{content:"\f1f8"}.fa-copyright:before{content:"\f1f9"}.fa-at:before{content:"\f1fa"}.fa-eyedropper:before{content:"\f1fb"}.fa-paint-brush:before{content:"\f1fc"}.fa-birthday-cake:before{content:"\f1fd"}.fa-area-chart:before{content:"\f1fe"}.fa-pie-chart:before{content:"\f200"}.fa-line-chart:before{content:"\f201"}.fa-lastfm:before{content:"\f202"}.fa-lastfm-square:before{content:"\f203"}.fa-toggle-off:before{content:"\f204"}.fa-toggle-on:before{content:"\f205"}.fa-bicycle:before{content:"\f206"}.fa-bus:before{content:"\f207"}.fa-ioxhost:before{content:"\f208"}.fa-angellist:before{content:"\f209"}.fa-cc:before{content:"\f20a"}.fa-shekel:before,.fa-sheqel:before,.fa-ils:before{content:"\f20b"}.fa-meanpath:before{content:"\f20c"}.fa-buysellads:before{content:"\f20d"}.fa-connectdevelop:before{content:"\f20e"}.fa-dashcube:before{content:"\f210"}.fa-forumbee:before{content:"\f211"}.fa-leanpub:before{content:"\f212"}.fa-sellsy:before{content:"\f213"}.fa-shirtsinbulk:before{content:"\f214"}.fa-simplybuilt:before{content:"\f215"}.fa-skyatlas:before{content:"\f216"}.fa-cart-plus:before{content:"\f217"}.fa-cart-arrow-down:before{content:"\f218"}.fa-diamond:before{content:"\f219"}.fa-ship:before{content:"\f21a"}.fa-user-secret:before{content:"\f21b"}.fa-motorcycle:before{content:"\f21c"}.fa-street-view:before{content:"\f21d"}.fa-heartbeat:before{content:"\f21e"}.fa-venus:before{content:"\f221"}.fa-mars:before{content:"\f222"}.fa-mercury:before{content:"\f223"}.fa-intersex:before,.fa-transgender:before{content:"\f224"}.fa-transgender-alt:before{content:"\f225"}.fa-venus-double:before{content:"\f226"}.fa-mars-double:before{content:"\f227"}.fa-venus-mars:before{content:"\f228"}.fa-mars-stroke:before{content:"\f229"}.fa-mars-stroke-v:before{content:"\f22a"}.fa-mars-stroke-h:before{content:"\f22b"}.fa-neuter:before{content:"\f22c"}.fa-genderless:before{content:"\f22d"}.fa-facebook-official:before{content:"\f230"}.fa-pinterest-p:before{content:"\f231"}.fa-whatsapp:before{content:"\f232"}.fa-server:before{content:"\f233"}.fa-user-plus:before{content:"\f234"}.fa-user-times:before{content:"\f235"}.fa-hotel:before,.fa-bed:before{content:"\f236"}.fa-viacoin:before{content:"\f237"}.fa-train:before{content:"\f238"}.fa-subway:before{content:"\f239"}.fa-medium:before{content:"\f23a"}.fa-yc:before,.fa-y-combinator:before{content:"\f23b"}.fa-optin-monster:before{content:"\f23c"}.fa-opencart:before{content:"\f23d"}.fa-expeditedssl:before{content:"\f23e"}.fa-battery-4:before,.fa-battery:before,.fa-battery-full:before{content:"\f240"}.fa-battery-3:before,.fa-battery-three-quarters:before{content:"\f241"}.fa-battery-2:before,.fa-battery-half:before{content:"\f242"}.fa-battery-1:before,.fa-battery-quarter:before{content:"\f243"}.fa-battery-0:before,.fa-battery-empty:before{content:"\f244"}.fa-mouse-pointer:before{content:"\f245"}.fa-i-cursor:before{content:"\f246"}.fa-object-group:before{content:"\f247"}.fa-object-ungroup:before{content:"\f248"}.fa-sticky-note:before{content:"\f249"}.fa-sticky-note-o:before{content:"\f24a"}.fa-cc-jcb:before{content:"\f24b"}.fa-cc-diners-club:before{content:"\f24c"}.fa-clone:before{content:"\f24d"}.fa-balance-scale:before{content:"\f24e"}.fa-hourglass-o:before{content:"\f250"}.fa-hourglass-1:before,.fa-hourglass-start:before{content:"\f251"}.fa-hourglass-2:before,.fa-hourglass-half:before{content:"\f252"}.fa-hourglass-3:before,.fa-hourglass-end:before{content:"\f253"}.fa-hourglass:before{content:"\f254"}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:"\f255"}.fa-hand-stop-o:before,.fa-hand-paper-o:before{content:"\f256"}.fa-hand-scissors-o:before{content:"\f257"}.fa-hand-lizard-o:before{content:"\f258"}.fa-hand-spock-o:before{content:"\f259"}.fa-hand-pointer-o:before{content:"\f25a"}.fa-hand-peace-o:before{content:"\f25b"}.fa-trademark:before{content:"\f25c"}.fa-registered:before{content:"\f25d"}.fa-creative-commons:before{content:"\f25e"}.fa-gg:before{content:"\f260"}.fa-gg-circle:before{content:"\f261"}.fa-tripadvisor:before{content:"\f262"}.fa-odnoklassniki:before{content:"\f263"}.fa-odnoklassniki-square:before{content:"\f264"}.fa-get-pocket:before{content:"\f265"}.fa-wikipedia-w:before{content:"\f266"}.fa-safari:before{content:"\f267"}.fa-chrome:before{content:"\f268"}.fa-firefox:before{content:"\f269"}.fa-opera:before{content:"\f26a"}.fa-internet-explorer:before{content:"\f26b"}.fa-tv:before,.fa-television:before{content:"\f26c"}.fa-contao:before{content:"\f26d"}.fa-500px:before{content:"\f26e"}.fa-amazon:before{content:"\f270"}.fa-calendar-plus-o:before{content:"\f271"}.fa-calendar-minus-o:before{content:"\f272"}.fa-calendar-times-o:before{content:"\f273"}.fa-calendar-check-o:before{content:"\f274"}.fa-industry:before{content:"\f275"}.fa-map-pin:before{content:"\f276"}.fa-map-signs:before{content:"\f277"}.fa-map-o:before{content:"\f278"}.fa-map:before{content:"\f279"}.fa-commenting:before{content:"\f27a"}.fa-commenting-o:before{content:"\f27b"}.fa-houzz:before{content:"\f27c"}.fa-vimeo:before{content:"\f27d"}.fa-black-tie:before{content:"\f27e"}.fa-fonticons:before{content:"\f280"}.fa-reddit-alien:before{content:"\f281"}.fa-edge:before{content:"\f282"}.fa-credit-card-alt:before{content:"\f283"}.fa-codiepie:before{content:"\f284"}.fa-modx:before{content:"\f285"}.fa-fort-awesome:before{content:"\f286"}.fa-usb:before{content:"\f287"}.fa-product-hunt:before{content:"\f288"}.fa-mixcloud:before{content:"\f289"}.fa-scribd:before{content:"\f28a"}.fa-pause-circle:before{content:"\f28b"}.fa-pause-circle-o:before{content:"\f28c"}.fa-stop-circle:before{content:"\f28d"}.fa-stop-circle-o:before{content:"\f28e"}.fa-shopping-bag:before{content:"\f290"}.fa-shopping-basket:before{content:"\f291"}.fa-hashtag:before{content:"\f292"}.fa-bluetooth:before{content:"\f293"}.fa-bluetooth-b:before{content:"\f294"}.fa-percent:before{content:"\f295"}.fa-gitlab:before{content:"\f296"}.fa-wpbeginner:before{content:"\f297"}.fa-wpforms:before{content:"\f298"}.fa-envira:before{content:"\f299"}.fa-universal-access:before{content:"\f29a"}.fa-wheelchair-alt:before{content:"\f29b"}.fa-question-circle-o:before{content:"\f29c"}.fa-blind:before{content:"\f29d"}.fa-audio-description:before{content:"\f29e"}.fa-volume-control-phone:before{content:"\f2a0"}.fa-braille:before{content:"\f2a1"}.fa-assistive-listening-systems:before{content:"\f2a2"}.fa-asl-interpreting:before,.fa-american-sign-language-interpreting:before{content:"\f2a3"}.fa-deafness:before,.fa-hard-of-hearing:before,.fa-deaf:before{content:"\f2a4"}.fa-glide:before{content:"\f2a5"}.fa-glide-g:before{content:"\f2a6"}.fa-signing:before,.fa-sign-language:before{content:"\f2a7"}.fa-low-vision:before{content:"\f2a8"}.fa-viadeo:before{content:"\f2a9"}.fa-viadeo-square:before{content:"\f2aa"}.fa-snapchat:before{content:"\f2ab"}.fa-snapchat-ghost:before{content:"\f2ac"}.fa-snapchat-square:before{content:"\f2ad"}.fa-pied-piper:before{content:"\f2ae"}.fa-first-order:before{content:"\f2b0"}.fa-yoast:before{content:"\f2b1"}.fa-themeisle:before{content:"\f2b2"}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:"\f2b3"}.fa-fa:before,.fa-font-awesome:before{content:"\f2b4"}.fa-handshake-o:before{content:"\f2b5"}.fa-envelope-open:before{content:"\f2b6"}.fa-envelope-open-o:before{content:"\f2b7"}.fa-linode:before{content:"\f2b8"}.fa-address-book:before{content:"\f2b9"}.fa-address-book-o:before{content:"\f2ba"}.fa-vcard:before,.fa-address-card:before{content:"\f2bb"}.fa-vcard-o:before,.fa-address-card-o:before{content:"\f2bc"}.fa-user-circle:before{content:"\f2bd"}.fa-user-circle-o:before{content:"\f2be"}.fa-user-o:before{content:"\f2c0"}.fa-id-badge:before{content:"\f2c1"}.fa-drivers-license:before,.fa-id-card:before{content:"\f2c2"}.fa-drivers-license-o:before,.fa-id-card-o:before{content:"\f2c3"}.fa-quora:before{content:"\f2c4"}.fa-free-code-camp:before{content:"\f2c5"}.fa-telegram:before{content:"\f2c6"}.fa-thermometer-4:before,.fa-thermometer:before,.fa-thermometer-full:before{content:"\f2c7"}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:"\f2c8"}.fa-thermometer-2:before,.fa-thermometer-half:before{content:"\f2c9"}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:"\f2ca"}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:"\f2cb"}.fa-shower:before{content:"\f2cc"}.fa-bathtub:before,.fa-s15:before,.fa-bath:before{content:"\f2cd"}.fa-podcast:before{content:"\f2ce"}.fa-window-maximize:before{content:"\f2d0"}.fa-window-minimize:before{content:"\f2d1"}.fa-window-restore:before{content:"\f2d2"}.fa-times-rectangle:before,.fa-window-close:before{content:"\f2d3"}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:"\f2d4"}.fa-bandcamp:before{content:"\f2d5"}.fa-grav:before{content:"\f2d6"}.fa-etsy:before{content:"\f2d7"}.fa-imdb:before{content:"\f2d8"}.fa-ravelry:before{content:"\f2d9"}.fa-eercast:before{content:"\f2da"}.fa-microchip:before{content:"\f2db"}.fa-snowflake-o:before{content:"\f2dc"}.fa-superpowers:before{content:"\f2dd"}.fa-wpexplorer:before{content:"\f2de"}.fa-meetup:before{content:"\f2e0"}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto} diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/FontAwesome.otf b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/FontAwesome.otf new file mode 100755 index 0000000000000..401ec0f36e4f7 Binary files /dev/null and b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/FontAwesome.otf differ diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.eot b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.eot new file mode 100755 index 0000000000000..e9f60ca953f93 Binary files /dev/null and b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.eot differ diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.svg b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.svg new file mode 100755 index 0000000000000..855c845e538b6 --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.ttf b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.ttf new file mode 100755 index 0000000000000..35acda2fa1196 Binary files /dev/null and b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.ttf differ diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.woff b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.woff new file mode 100755 index 0000000000000..400014a4b06ee Binary files /dev/null and b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.woff differ diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.woff2 b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.woff2 new file mode 100755 index 0000000000000..4d13fc60404b9 Binary files /dev/null and b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/font-awesome/fonts/fontawesome-webfont.woff2 differ diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/highlight.js/styles/default.css b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/highlight.js/styles/default.css new file mode 100755 index 0000000000000..f1bfade31e5dc --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/highlight.js/styles/default.css @@ -0,0 +1,99 @@ +/* + +Original highlight.js style (c) Ivan Sagalaev + +*/ + +.hljs { + display: block; + overflow-x: auto; + padding: 0.5em; + background: #F0F0F0; +} + + +/* Base color: saturation 0; */ + +.hljs, +.hljs-subst { + color: #444; +} + +.hljs-comment { + color: #888888; +} + +.hljs-keyword, +.hljs-attribute, +.hljs-selector-tag, +.hljs-meta-keyword, +.hljs-doctag, +.hljs-name { + font-weight: bold; +} + + +/* User color: hue: 0 */ + +.hljs-type, +.hljs-string, +.hljs-number, +.hljs-selector-id, +.hljs-selector-class, +.hljs-quote, +.hljs-template-tag, +.hljs-deletion { + color: #880000; +} + +.hljs-title, +.hljs-section { + color: #880000; + font-weight: bold; +} + +.hljs-regexp, +.hljs-symbol, +.hljs-variable, +.hljs-template-variable, +.hljs-link, +.hljs-selector-attr, +.hljs-selector-pseudo { + color: #BC6060; +} + + +/* Language color: hue: 90; */ + +.hljs-literal { + color: #78A960; +} + +.hljs-built_in, +.hljs-bullet, +.hljs-code, +.hljs-addition { + color: #397300; +} + + +/* Meta color: hue: 200 */ + +.hljs-meta { + color: #1f7199; +} + +.hljs-meta-string { + color: #4d99bf; +} + + +/* Misc effects */ + +.hljs-emphasis { + font-style: italic; +} + +.hljs-strong { + font-weight: bold; +} diff --git a/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/jquery.scrollto/jquery.scrollTo.min.js b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/jquery.scrollto/jquery.scrollTo.min.js new file mode 100755 index 0000000000000..65a020d92ad28 --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.11/node_modules/jquery.scrollto/jquery.scrollTo.min.js @@ -0,0 +1,7 @@ +/** + * Copyright (c) 2007-2015 Ariel Flesler - afleslergmailcom | http://flesler.blogspot.com + * Licensed under MIT + * @author Ariel Flesler + * @version 2.1.2 + */ +;(function(f){"use strict";"function"===typeof define&&define.amd?define(["jquery"],f):"undefined"!==typeof module&&module.exports?module.exports=f(require("jquery")):f(jQuery)})(function($){"use strict";function n(a){return!a.nodeName||-1!==$.inArray(a.nodeName.toLowerCase(),["iframe","#document","html","body"])}function h(a){return $.isFunction(a)||$.isPlainObject(a)?a:{top:a,left:a}}var p=$.scrollTo=function(a,d,b){return $(window).scrollTo(a,d,b)};p.defaults={axis:"xy",duration:0,limit:!0};$.fn.scrollTo=function(a,d,b){"object"=== typeof d&&(b=d,d=0);"function"===typeof b&&(b={onAfter:b});"max"===a&&(a=9E9);b=$.extend({},p.defaults,b);d=d||b.duration;var u=b.queue&&1=f[g]?0:Math.min(f[g],n));!a&&1=0&&c0&&b-1 in a)}var x=function(a){var b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u="sizzle"+1*new Date,v=a.document,w=0,x=0,y=ha(),z=ha(),A=ha(),B=function(a,b){return a===b&&(l=!0),0},C={}.hasOwnProperty,D=[],E=D.pop,F=D.push,G=D.push,H=D.slice,I=function(a,b){for(var c=0,d=a.length;c+~]|"+K+")"+K+"*"),S=new RegExp("="+K+"*([^\\]'\"]*?)"+K+"*\\]","g"),T=new RegExp(N),U=new RegExp("^"+L+"$"),V={ID:new RegExp("^#("+L+")"),CLASS:new RegExp("^\\.("+L+")"),TAG:new RegExp("^("+L+"|[*])"),ATTR:new RegExp("^"+M),PSEUDO:new RegExp("^"+N),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+K+"*(even|odd|(([+-]|)(\\d*)n|)"+K+"*(?:([+-]|)"+K+"*(\\d+)|))"+K+"*\\)|)","i"),bool:new RegExp("^(?:"+J+")$","i"),needsContext:new RegExp("^"+K+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+K+"*((?:-\\d)?\\d*)"+K+"*\\)|)(?=[^-]|$)","i")},W=/^(?:input|select|textarea|button)$/i,X=/^h\d$/i,Y=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,$=/[+~]/,_=new RegExp("\\\\([\\da-f]{1,6}"+K+"?|("+K+")|.)","ig"),aa=function(a,b,c){var d="0x"+b-65536;return d!==d||c?b:d<0?String.fromCharCode(d+65536):String.fromCharCode(d>>10|55296,1023&d|56320)},ba=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ca=function(a,b){return b?"\0"===a?"\ufffd":a.slice(0,-1)+"\\"+a.charCodeAt(a.length-1).toString(16)+" ":"\\"+a},da=function(){m()},ea=ta(function(a){return a.disabled===!0&&("form"in a||"label"in a)},{dir:"parentNode",next:"legend"});try{G.apply(D=H.call(v.childNodes),v.childNodes),D[v.childNodes.length].nodeType}catch(fa){G={apply:D.length?function(a,b){F.apply(a,H.call(b))}:function(a,b){var c=a.length,d=0;while(a[c++]=b[d++]);a.length=c-1}}}function ga(a,b,d,e){var f,h,j,k,l,o,r,s=b&&b.ownerDocument,w=b?b.nodeType:9;if(d=d||[],"string"!=typeof a||!a||1!==w&&9!==w&&11!==w)return d;if(!e&&((b?b.ownerDocument||b:v)!==n&&m(b),b=b||n,p)){if(11!==w&&(l=Z.exec(a)))if(f=l[1]){if(9===w){if(!(j=b.getElementById(f)))return d;if(j.id===f)return d.push(j),d}else if(s&&(j=s.getElementById(f))&&t(b,j)&&j.id===f)return d.push(j),d}else{if(l[2])return G.apply(d,b.getElementsByTagName(a)),d;if((f=l[3])&&c.getElementsByClassName&&b.getElementsByClassName)return G.apply(d,b.getElementsByClassName(f)),d}if(c.qsa&&!A[a+" "]&&(!q||!q.test(a))){if(1!==w)s=b,r=a;else if("object"!==b.nodeName.toLowerCase()){(k=b.getAttribute("id"))?k=k.replace(ba,ca):b.setAttribute("id",k=u),o=g(a),h=o.length;while(h--)o[h]="#"+k+" "+sa(o[h]);r=o.join(","),s=$.test(a)&&qa(b.parentNode)||b}if(r)try{return G.apply(d,s.querySelectorAll(r)),d}catch(x){}finally{k===u&&b.removeAttribute("id")}}}return i(a.replace(P,"$1"),b,d,e)}function ha(){var a=[];function b(c,e){return a.push(c+" ")>d.cacheLength&&delete b[a.shift()],b[c+" "]=e}return b}function ia(a){return a[u]=!0,a}function ja(a){var b=n.createElement("fieldset");try{return!!a(b)}catch(c){return!1}finally{b.parentNode&&b.parentNode.removeChild(b),b=null}}function ka(a,b){var c=a.split("|"),e=c.length;while(e--)d.attrHandle[c[e]]=b}function la(a,b){var c=b&&a,d=c&&1===a.nodeType&&1===b.nodeType&&a.sourceIndex-b.sourceIndex;if(d)return d;if(c)while(c=c.nextSibling)if(c===b)return-1;return a?1:-1}function ma(a){return function(b){var c=b.nodeName.toLowerCase();return"input"===c&&b.type===a}}function na(a){return function(b){var c=b.nodeName.toLowerCase();return("input"===c||"button"===c)&&b.type===a}}function oa(a){return function(b){return"form"in b?b.parentNode&&b.disabled===!1?"label"in b?"label"in b.parentNode?b.parentNode.disabled===a:b.disabled===a:b.isDisabled===a||b.isDisabled!==!a&&ea(b)===a:b.disabled===a:"label"in b&&b.disabled===a}}function pa(a){return ia(function(b){return b=+b,ia(function(c,d){var e,f=a([],c.length,b),g=f.length;while(g--)c[e=f[g]]&&(c[e]=!(d[e]=c[e]))})})}function qa(a){return a&&"undefined"!=typeof a.getElementsByTagName&&a}c=ga.support={},f=ga.isXML=function(a){var b=a&&(a.ownerDocument||a).documentElement;return!!b&&"HTML"!==b.nodeName},m=ga.setDocument=function(a){var b,e,g=a?a.ownerDocument||a:v;return g!==n&&9===g.nodeType&&g.documentElement?(n=g,o=n.documentElement,p=!f(n),v!==n&&(e=n.defaultView)&&e.top!==e&&(e.addEventListener?e.addEventListener("unload",da,!1):e.attachEvent&&e.attachEvent("onunload",da)),c.attributes=ja(function(a){return a.className="i",!a.getAttribute("className")}),c.getElementsByTagName=ja(function(a){return a.appendChild(n.createComment("")),!a.getElementsByTagName("*").length}),c.getElementsByClassName=Y.test(n.getElementsByClassName),c.getById=ja(function(a){return o.appendChild(a).id=u,!n.getElementsByName||!n.getElementsByName(u).length}),c.getById?(d.filter.ID=function(a){var b=a.replace(_,aa);return function(a){return a.getAttribute("id")===b}},d.find.ID=function(a,b){if("undefined"!=typeof b.getElementById&&p){var c=b.getElementById(a);return c?[c]:[]}}):(d.filter.ID=function(a){var b=a.replace(_,aa);return function(a){var c="undefined"!=typeof a.getAttributeNode&&a.getAttributeNode("id");return c&&c.value===b}},d.find.ID=function(a,b){if("undefined"!=typeof b.getElementById&&p){var c,d,e,f=b.getElementById(a);if(f){if(c=f.getAttributeNode("id"),c&&c.value===a)return[f];e=b.getElementsByName(a),d=0;while(f=e[d++])if(c=f.getAttributeNode("id"),c&&c.value===a)return[f]}return[]}}),d.find.TAG=c.getElementsByTagName?function(a,b){return"undefined"!=typeof b.getElementsByTagName?b.getElementsByTagName(a):c.qsa?b.querySelectorAll(a):void 0}:function(a,b){var c,d=[],e=0,f=b.getElementsByTagName(a);if("*"===a){while(c=f[e++])1===c.nodeType&&d.push(c);return d}return f},d.find.CLASS=c.getElementsByClassName&&function(a,b){if("undefined"!=typeof b.getElementsByClassName&&p)return b.getElementsByClassName(a)},r=[],q=[],(c.qsa=Y.test(n.querySelectorAll))&&(ja(function(a){o.appendChild(a).innerHTML="",a.querySelectorAll("[msallowcapture^='']").length&&q.push("[*^$]="+K+"*(?:''|\"\")"),a.querySelectorAll("[selected]").length||q.push("\\["+K+"*(?:value|"+J+")"),a.querySelectorAll("[id~="+u+"-]").length||q.push("~="),a.querySelectorAll(":checked").length||q.push(":checked"),a.querySelectorAll("a#"+u+"+*").length||q.push(".#.+[+~]")}),ja(function(a){a.innerHTML="";var b=n.createElement("input");b.setAttribute("type","hidden"),a.appendChild(b).setAttribute("name","D"),a.querySelectorAll("[name=d]").length&&q.push("name"+K+"*[*^$|!~]?="),2!==a.querySelectorAll(":enabled").length&&q.push(":enabled",":disabled"),o.appendChild(a).disabled=!0,2!==a.querySelectorAll(":disabled").length&&q.push(":enabled",":disabled"),a.querySelectorAll("*,:x"),q.push(",.*:")})),(c.matchesSelector=Y.test(s=o.matches||o.webkitMatchesSelector||o.mozMatchesSelector||o.oMatchesSelector||o.msMatchesSelector))&&ja(function(a){c.disconnectedMatch=s.call(a,"*"),s.call(a,"[s!='']:x"),r.push("!=",N)}),q=q.length&&new RegExp(q.join("|")),r=r.length&&new RegExp(r.join("|")),b=Y.test(o.compareDocumentPosition),t=b||Y.test(o.contains)?function(a,b){var c=9===a.nodeType?a.documentElement:a,d=b&&b.parentNode;return a===d||!(!d||1!==d.nodeType||!(c.contains?c.contains(d):a.compareDocumentPosition&&16&a.compareDocumentPosition(d)))}:function(a,b){if(b)while(b=b.parentNode)if(b===a)return!0;return!1},B=b?function(a,b){if(a===b)return l=!0,0;var d=!a.compareDocumentPosition-!b.compareDocumentPosition;return d?d:(d=(a.ownerDocument||a)===(b.ownerDocument||b)?a.compareDocumentPosition(b):1,1&d||!c.sortDetached&&b.compareDocumentPosition(a)===d?a===n||a.ownerDocument===v&&t(v,a)?-1:b===n||b.ownerDocument===v&&t(v,b)?1:k?I(k,a)-I(k,b):0:4&d?-1:1)}:function(a,b){if(a===b)return l=!0,0;var c,d=0,e=a.parentNode,f=b.parentNode,g=[a],h=[b];if(!e||!f)return a===n?-1:b===n?1:e?-1:f?1:k?I(k,a)-I(k,b):0;if(e===f)return la(a,b);c=a;while(c=c.parentNode)g.unshift(c);c=b;while(c=c.parentNode)h.unshift(c);while(g[d]===h[d])d++;return d?la(g[d],h[d]):g[d]===v?-1:h[d]===v?1:0},n):n},ga.matches=function(a,b){return ga(a,null,null,b)},ga.matchesSelector=function(a,b){if((a.ownerDocument||a)!==n&&m(a),b=b.replace(S,"='$1']"),c.matchesSelector&&p&&!A[b+" "]&&(!r||!r.test(b))&&(!q||!q.test(b)))try{var d=s.call(a,b);if(d||c.disconnectedMatch||a.document&&11!==a.document.nodeType)return d}catch(e){}return ga(b,n,null,[a]).length>0},ga.contains=function(a,b){return(a.ownerDocument||a)!==n&&m(a),t(a,b)},ga.attr=function(a,b){(a.ownerDocument||a)!==n&&m(a);var e=d.attrHandle[b.toLowerCase()],f=e&&C.call(d.attrHandle,b.toLowerCase())?e(a,b,!p):void 0;return void 0!==f?f:c.attributes||!p?a.getAttribute(b):(f=a.getAttributeNode(b))&&f.specified?f.value:null},ga.escape=function(a){return(a+"").replace(ba,ca)},ga.error=function(a){throw new Error("Syntax error, unrecognized expression: "+a)},ga.uniqueSort=function(a){var b,d=[],e=0,f=0;if(l=!c.detectDuplicates,k=!c.sortStable&&a.slice(0),a.sort(B),l){while(b=a[f++])b===a[f]&&(e=d.push(f));while(e--)a.splice(d[e],1)}return k=null,a},e=ga.getText=function(a){var b,c="",d=0,f=a.nodeType;if(f){if(1===f||9===f||11===f){if("string"==typeof a.textContent)return a.textContent;for(a=a.firstChild;a;a=a.nextSibling)c+=e(a)}else if(3===f||4===f)return a.nodeValue}else while(b=a[d++])c+=e(b);return c},d=ga.selectors={cacheLength:50,createPseudo:ia,match:V,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(a){return a[1]=a[1].replace(_,aa),a[3]=(a[3]||a[4]||a[5]||"").replace(_,aa),"~="===a[2]&&(a[3]=" "+a[3]+" "),a.slice(0,4)},CHILD:function(a){return a[1]=a[1].toLowerCase(),"nth"===a[1].slice(0,3)?(a[3]||ga.error(a[0]),a[4]=+(a[4]?a[5]+(a[6]||1):2*("even"===a[3]||"odd"===a[3])),a[5]=+(a[7]+a[8]||"odd"===a[3])):a[3]&&ga.error(a[0]),a},PSEUDO:function(a){var b,c=!a[6]&&a[2];return V.CHILD.test(a[0])?null:(a[3]?a[2]=a[4]||a[5]||"":c&&T.test(c)&&(b=g(c,!0))&&(b=c.indexOf(")",c.length-b)-c.length)&&(a[0]=a[0].slice(0,b),a[2]=c.slice(0,b)),a.slice(0,3))}},filter:{TAG:function(a){var b=a.replace(_,aa).toLowerCase();return"*"===a?function(){return!0}:function(a){return a.nodeName&&a.nodeName.toLowerCase()===b}},CLASS:function(a){var b=y[a+" "];return b||(b=new RegExp("(^|"+K+")"+a+"("+K+"|$)"))&&y(a,function(a){return b.test("string"==typeof a.className&&a.className||"undefined"!=typeof a.getAttribute&&a.getAttribute("class")||"")})},ATTR:function(a,b,c){return function(d){var e=ga.attr(d,a);return null==e?"!="===b:!b||(e+="","="===b?e===c:"!="===b?e!==c:"^="===b?c&&0===e.indexOf(c):"*="===b?c&&e.indexOf(c)>-1:"$="===b?c&&e.slice(-c.length)===c:"~="===b?(" "+e.replace(O," ")+" ").indexOf(c)>-1:"|="===b&&(e===c||e.slice(0,c.length+1)===c+"-"))}},CHILD:function(a,b,c,d,e){var f="nth"!==a.slice(0,3),g="last"!==a.slice(-4),h="of-type"===b;return 1===d&&0===e?function(a){return!!a.parentNode}:function(b,c,i){var j,k,l,m,n,o,p=f!==g?"nextSibling":"previousSibling",q=b.parentNode,r=h&&b.nodeName.toLowerCase(),s=!i&&!h,t=!1;if(q){if(f){while(p){m=b;while(m=m[p])if(h?m.nodeName.toLowerCase()===r:1===m.nodeType)return!1;o=p="only"===a&&!o&&"nextSibling"}return!0}if(o=[g?q.firstChild:q.lastChild],g&&s){m=q,l=m[u]||(m[u]={}),k=l[m.uniqueID]||(l[m.uniqueID]={}),j=k[a]||[],n=j[0]===w&&j[1],t=n&&j[2],m=n&&q.childNodes[n];while(m=++n&&m&&m[p]||(t=n=0)||o.pop())if(1===m.nodeType&&++t&&m===b){k[a]=[w,n,t];break}}else if(s&&(m=b,l=m[u]||(m[u]={}),k=l[m.uniqueID]||(l[m.uniqueID]={}),j=k[a]||[],n=j[0]===w&&j[1],t=n),t===!1)while(m=++n&&m&&m[p]||(t=n=0)||o.pop())if((h?m.nodeName.toLowerCase()===r:1===m.nodeType)&&++t&&(s&&(l=m[u]||(m[u]={}),k=l[m.uniqueID]||(l[m.uniqueID]={}),k[a]=[w,t]),m===b))break;return t-=e,t===d||t%d===0&&t/d>=0}}},PSEUDO:function(a,b){var c,e=d.pseudos[a]||d.setFilters[a.toLowerCase()]||ga.error("unsupported pseudo: "+a);return e[u]?e(b):e.length>1?(c=[a,a,"",b],d.setFilters.hasOwnProperty(a.toLowerCase())?ia(function(a,c){var d,f=e(a,b),g=f.length;while(g--)d=I(a,f[g]),a[d]=!(c[d]=f[g])}):function(a){return e(a,0,c)}):e}},pseudos:{not:ia(function(a){var b=[],c=[],d=h(a.replace(P,"$1"));return d[u]?ia(function(a,b,c,e){var f,g=d(a,null,e,[]),h=a.length;while(h--)(f=g[h])&&(a[h]=!(b[h]=f))}):function(a,e,f){return b[0]=a,d(b,null,f,c),b[0]=null,!c.pop()}}),has:ia(function(a){return function(b){return ga(a,b).length>0}}),contains:ia(function(a){return a=a.replace(_,aa),function(b){return(b.textContent||b.innerText||e(b)).indexOf(a)>-1}}),lang:ia(function(a){return U.test(a||"")||ga.error("unsupported lang: "+a),a=a.replace(_,aa).toLowerCase(),function(b){var c;do if(c=p?b.lang:b.getAttribute("xml:lang")||b.getAttribute("lang"))return c=c.toLowerCase(),c===a||0===c.indexOf(a+"-");while((b=b.parentNode)&&1===b.nodeType);return!1}}),target:function(b){var c=a.location&&a.location.hash;return c&&c.slice(1)===b.id},root:function(a){return a===o},focus:function(a){return a===n.activeElement&&(!n.hasFocus||n.hasFocus())&&!!(a.type||a.href||~a.tabIndex)},enabled:oa(!1),disabled:oa(!0),checked:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&!!a.checked||"option"===b&&!!a.selected},selected:function(a){return a.parentNode&&a.parentNode.selectedIndex,a.selected===!0},empty:function(a){for(a=a.firstChild;a;a=a.nextSibling)if(a.nodeType<6)return!1;return!0},parent:function(a){return!d.pseudos.empty(a)},header:function(a){return X.test(a.nodeName)},input:function(a){return W.test(a.nodeName)},button:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&"button"===a.type||"button"===b},text:function(a){var b;return"input"===a.nodeName.toLowerCase()&&"text"===a.type&&(null==(b=a.getAttribute("type"))||"text"===b.toLowerCase())},first:pa(function(){return[0]}),last:pa(function(a,b){return[b-1]}),eq:pa(function(a,b,c){return[c<0?c+b:c]}),even:pa(function(a,b){for(var c=0;c=0;)a.push(d);return a}),gt:pa(function(a,b,c){for(var d=c<0?c+b:c;++d1?function(b,c,d){var e=a.length;while(e--)if(!a[e](b,c,d))return!1;return!0}:a[0]}function va(a,b,c){for(var d=0,e=b.length;d-1&&(f[j]=!(g[j]=l))}}else r=wa(r===g?r.splice(o,r.length):r),e?e(null,g,r,i):G.apply(g,r)})}function ya(a){for(var b,c,e,f=a.length,g=d.relative[a[0].type],h=g||d.relative[" "],i=g?1:0,k=ta(function(a){return a===b},h,!0),l=ta(function(a){return I(b,a)>-1},h,!0),m=[function(a,c,d){var e=!g&&(d||c!==j)||((b=c).nodeType?k(a,c,d):l(a,c,d));return b=null,e}];i1&&ua(m),i>1&&sa(a.slice(0,i-1).concat({value:" "===a[i-2].type?"*":""})).replace(P,"$1"),c,i0,e=a.length>0,f=function(f,g,h,i,k){var l,o,q,r=0,s="0",t=f&&[],u=[],v=j,x=f||e&&d.find.TAG("*",k),y=w+=null==v?1:Math.random()||.1,z=x.length;for(k&&(j=g===n||g||k);s!==z&&null!=(l=x[s]);s++){if(e&&l){o=0,g||l.ownerDocument===n||(m(l),h=!p);while(q=a[o++])if(q(l,g||n,h)){i.push(l);break}k&&(w=y)}c&&((l=!q&&l)&&r--,f&&t.push(l))}if(r+=s,c&&s!==r){o=0;while(q=b[o++])q(t,u,g,h);if(f){if(r>0)while(s--)t[s]||u[s]||(u[s]=E.call(i));u=wa(u)}G.apply(i,u),k&&!f&&u.length>0&&r+b.length>1&&ga.uniqueSort(i)}return k&&(w=y,j=v),t};return c?ia(f):f}return h=ga.compile=function(a,b){var c,d=[],e=[],f=A[a+" "];if(!f){b||(b=g(a)),c=b.length;while(c--)f=ya(b[c]),f[u]?d.push(f):e.push(f);f=A(a,za(e,d)),f.selector=a}return f},i=ga.select=function(a,b,c,e){var f,i,j,k,l,m="function"==typeof a&&a,n=!e&&g(a=m.selector||a);if(c=c||[],1===n.length){if(i=n[0]=n[0].slice(0),i.length>2&&"ID"===(j=i[0]).type&&9===b.nodeType&&p&&d.relative[i[1].type]){if(b=(d.find.ID(j.matches[0].replace(_,aa),b)||[])[0],!b)return c;m&&(b=b.parentNode),a=a.slice(i.shift().value.length)}f=V.needsContext.test(a)?0:i.length;while(f--){if(j=i[f],d.relative[k=j.type])break;if((l=d.find[k])&&(e=l(j.matches[0].replace(_,aa),$.test(i[0].type)&&qa(b.parentNode)||b))){if(i.splice(f,1),a=e.length&&sa(i),!a)return G.apply(c,e),c;break}}}return(m||h(a,n))(e,b,!p,c,!b||$.test(a)&&qa(b.parentNode)||b),c},c.sortStable=u.split("").sort(B).join("")===u,c.detectDuplicates=!!l,m(),c.sortDetached=ja(function(a){return 1&a.compareDocumentPosition(n.createElement("fieldset"))}),ja(function(a){return a.innerHTML="","#"===a.firstChild.getAttribute("href")})||ka("type|href|height|width",function(a,b,c){if(!c)return a.getAttribute(b,"type"===b.toLowerCase()?1:2)}),c.attributes&&ja(function(a){return a.innerHTML="",a.firstChild.setAttribute("value",""),""===a.firstChild.getAttribute("value")})||ka("value",function(a,b,c){if(!c&&"input"===a.nodeName.toLowerCase())return a.defaultValue}),ja(function(a){return null==a.getAttribute("disabled")})||ka(J,function(a,b,c){var d;if(!c)return a[b]===!0?b.toLowerCase():(d=a.getAttributeNode(b))&&d.specified?d.value:null}),ga}(a);r.find=x,r.expr=x.selectors,r.expr[":"]=r.expr.pseudos,r.uniqueSort=r.unique=x.uniqueSort,r.text=x.getText,r.isXMLDoc=x.isXML,r.contains=x.contains,r.escapeSelector=x.escape;var y=function(a,b,c){var d=[],e=void 0!==c;while((a=a[b])&&9!==a.nodeType)if(1===a.nodeType){if(e&&r(a).is(c))break;d.push(a)}return d},z=function(a,b){for(var c=[];a;a=a.nextSibling)1===a.nodeType&&a!==b&&c.push(a);return c},A=r.expr.match.needsContext;function B(a,b){return a.nodeName&&a.nodeName.toLowerCase()===b.toLowerCase()}var C=/^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i,D=/^.[^:#\[\.,]*$/;function E(a,b,c){return r.isFunction(b)?r.grep(a,function(a,d){return!!b.call(a,d,a)!==c}):b.nodeType?r.grep(a,function(a){return a===b!==c}):"string"!=typeof b?r.grep(a,function(a){return i.call(b,a)>-1!==c}):D.test(b)?r.filter(b,a,c):(b=r.filter(b,a),r.grep(a,function(a){return i.call(b,a)>-1!==c&&1===a.nodeType}))}r.filter=function(a,b,c){var d=b[0];return c&&(a=":not("+a+")"),1===b.length&&1===d.nodeType?r.find.matchesSelector(d,a)?[d]:[]:r.find.matches(a,r.grep(b,function(a){return 1===a.nodeType}))},r.fn.extend({find:function(a){var b,c,d=this.length,e=this;if("string"!=typeof a)return this.pushStack(r(a).filter(function(){for(b=0;b1?r.uniqueSort(c):c},filter:function(a){return this.pushStack(E(this,a||[],!1))},not:function(a){return this.pushStack(E(this,a||[],!0))},is:function(a){return!!E(this,"string"==typeof a&&A.test(a)?r(a):a||[],!1).length}});var F,G=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/,H=r.fn.init=function(a,b,c){var e,f;if(!a)return this;if(c=c||F,"string"==typeof a){if(e="<"===a[0]&&">"===a[a.length-1]&&a.length>=3?[null,a,null]:G.exec(a),!e||!e[1]&&b)return!b||b.jquery?(b||c).find(a):this.constructor(b).find(a);if(e[1]){if(b=b instanceof r?b[0]:b,r.merge(this,r.parseHTML(e[1],b&&b.nodeType?b.ownerDocument||b:d,!0)),C.test(e[1])&&r.isPlainObject(b))for(e in b)r.isFunction(this[e])?this[e](b[e]):this.attr(e,b[e]);return this}return f=d.getElementById(e[2]),f&&(this[0]=f,this.length=1),this}return a.nodeType?(this[0]=a,this.length=1,this):r.isFunction(a)?void 0!==c.ready?c.ready(a):a(r):r.makeArray(a,this)};H.prototype=r.fn,F=r(d);var I=/^(?:parents|prev(?:Until|All))/,J={children:!0,contents:!0,next:!0,prev:!0};r.fn.extend({has:function(a){var b=r(a,this),c=b.length;return this.filter(function(){for(var a=0;a-1:1===c.nodeType&&r.find.matchesSelector(c,a))){f.push(c);break}return this.pushStack(f.length>1?r.uniqueSort(f):f)},index:function(a){return a?"string"==typeof a?i.call(r(a),this[0]):i.call(this,a.jquery?a[0]:a):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(a,b){return this.pushStack(r.uniqueSort(r.merge(this.get(),r(a,b))))},addBack:function(a){return this.add(null==a?this.prevObject:this.prevObject.filter(a))}});function K(a,b){while((a=a[b])&&1!==a.nodeType);return a}r.each({parent:function(a){var b=a.parentNode;return b&&11!==b.nodeType?b:null},parents:function(a){return y(a,"parentNode")},parentsUntil:function(a,b,c){return y(a,"parentNode",c)},next:function(a){return K(a,"nextSibling")},prev:function(a){return K(a,"previousSibling")},nextAll:function(a){return y(a,"nextSibling")},prevAll:function(a){return y(a,"previousSibling")},nextUntil:function(a,b,c){return y(a,"nextSibling",c)},prevUntil:function(a,b,c){return y(a,"previousSibling",c)},siblings:function(a){return z((a.parentNode||{}).firstChild,a)},children:function(a){return z(a.firstChild)},contents:function(a){return B(a,"iframe")?a.contentDocument:(B(a,"template")&&(a=a.content||a),r.merge([],a.childNodes))}},function(a,b){r.fn[a]=function(c,d){var e=r.map(this,b,c);return"Until"!==a.slice(-5)&&(d=c),d&&"string"==typeof d&&(e=r.filter(d,e)),this.length>1&&(J[a]||r.uniqueSort(e),I.test(a)&&e.reverse()),this.pushStack(e)}});var L=/[^\x20\t\r\n\f]+/g;function M(a){var b={};return r.each(a.match(L)||[],function(a,c){b[c]=!0}),b}r.Callbacks=function(a){a="string"==typeof a?M(a):r.extend({},a);var b,c,d,e,f=[],g=[],h=-1,i=function(){for(e=e||a.once,d=b=!0;g.length;h=-1){c=g.shift();while(++h-1)f.splice(c,1),c<=h&&h--}),this},has:function(a){return a?r.inArray(a,f)>-1:f.length>0},empty:function(){return f&&(f=[]),this},disable:function(){return e=g=[],f=c="",this},disabled:function(){return!f},lock:function(){return e=g=[],c||b||(f=c=""),this},locked:function(){return!!e},fireWith:function(a,c){return e||(c=c||[],c=[a,c.slice?c.slice():c],g.push(c),b||i()),this},fire:function(){return j.fireWith(this,arguments),this},fired:function(){return!!d}};return j};function N(a){return a}function O(a){throw a}function P(a,b,c,d){var e;try{a&&r.isFunction(e=a.promise)?e.call(a).done(b).fail(c):a&&r.isFunction(e=a.then)?e.call(a,b,c):b.apply(void 0,[a].slice(d))}catch(a){c.apply(void 0,[a])}}r.extend({Deferred:function(b){var c=[["notify","progress",r.Callbacks("memory"),r.Callbacks("memory"),2],["resolve","done",r.Callbacks("once memory"),r.Callbacks("once memory"),0,"resolved"],["reject","fail",r.Callbacks("once memory"),r.Callbacks("once memory"),1,"rejected"]],d="pending",e={state:function(){return d},always:function(){return f.done(arguments).fail(arguments),this},"catch":function(a){return e.then(null,a)},pipe:function(){var a=arguments;return r.Deferred(function(b){r.each(c,function(c,d){var e=r.isFunction(a[d[4]])&&a[d[4]];f[d[1]](function(){var a=e&&e.apply(this,arguments);a&&r.isFunction(a.promise)?a.promise().progress(b.notify).done(b.resolve).fail(b.reject):b[d[0]+"With"](this,e?[a]:arguments)})}),a=null}).promise()},then:function(b,d,e){var f=0;function g(b,c,d,e){return function(){var h=this,i=arguments,j=function(){var a,j;if(!(b=f&&(d!==O&&(h=void 0,i=[a]),c.rejectWith(h,i))}};b?k():(r.Deferred.getStackHook&&(k.stackTrace=r.Deferred.getStackHook()),a.setTimeout(k))}}return r.Deferred(function(a){c[0][3].add(g(0,a,r.isFunction(e)?e:N,a.notifyWith)),c[1][3].add(g(0,a,r.isFunction(b)?b:N)),c[2][3].add(g(0,a,r.isFunction(d)?d:O))}).promise()},promise:function(a){return null!=a?r.extend(a,e):e}},f={};return r.each(c,function(a,b){var g=b[2],h=b[5];e[b[1]]=g.add,h&&g.add(function(){d=h},c[3-a][2].disable,c[0][2].lock),g.add(b[3].fire),f[b[0]]=function(){return f[b[0]+"With"](this===f?void 0:this,arguments),this},f[b[0]+"With"]=g.fireWith}),e.promise(f),b&&b.call(f,f),f},when:function(a){var b=arguments.length,c=b,d=Array(c),e=f.call(arguments),g=r.Deferred(),h=function(a){return function(c){d[a]=this,e[a]=arguments.length>1?f.call(arguments):c,--b||g.resolveWith(d,e)}};if(b<=1&&(P(a,g.done(h(c)).resolve,g.reject,!b),"pending"===g.state()||r.isFunction(e[c]&&e[c].then)))return g.then();while(c--)P(e[c],h(c),g.reject);return g.promise()}});var Q=/^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/;r.Deferred.exceptionHook=function(b,c){a.console&&a.console.warn&&b&&Q.test(b.name)&&a.console.warn("jQuery.Deferred exception: "+b.message,b.stack,c)},r.readyException=function(b){a.setTimeout(function(){throw b})};var R=r.Deferred();r.fn.ready=function(a){return R.then(a)["catch"](function(a){r.readyException(a)}),this},r.extend({isReady:!1,readyWait:1,ready:function(a){(a===!0?--r.readyWait:r.isReady)||(r.isReady=!0,a!==!0&&--r.readyWait>0||R.resolveWith(d,[r]))}}),r.ready.then=R.then;function S(){d.removeEventListener("DOMContentLoaded",S), +a.removeEventListener("load",S),r.ready()}"complete"===d.readyState||"loading"!==d.readyState&&!d.documentElement.doScroll?a.setTimeout(r.ready):(d.addEventListener("DOMContentLoaded",S),a.addEventListener("load",S));var T=function(a,b,c,d,e,f,g){var h=0,i=a.length,j=null==c;if("object"===r.type(c)){e=!0;for(h in c)T(a,b,h,c[h],!0,f,g)}else if(void 0!==d&&(e=!0,r.isFunction(d)||(g=!0),j&&(g?(b.call(a,d),b=null):(j=b,b=function(a,b,c){return j.call(r(a),c)})),b))for(;h1,null,!0)},removeData:function(a){return this.each(function(){X.remove(this,a)})}}),r.extend({queue:function(a,b,c){var d;if(a)return b=(b||"fx")+"queue",d=W.get(a,b),c&&(!d||Array.isArray(c)?d=W.access(a,b,r.makeArray(c)):d.push(c)),d||[]},dequeue:function(a,b){b=b||"fx";var c=r.queue(a,b),d=c.length,e=c.shift(),f=r._queueHooks(a,b),g=function(){r.dequeue(a,b)};"inprogress"===e&&(e=c.shift(),d--),e&&("fx"===b&&c.unshift("inprogress"),delete f.stop,e.call(a,g,f)),!d&&f&&f.empty.fire()},_queueHooks:function(a,b){var c=b+"queueHooks";return W.get(a,c)||W.access(a,c,{empty:r.Callbacks("once memory").add(function(){W.remove(a,[b+"queue",c])})})}}),r.fn.extend({queue:function(a,b){var c=2;return"string"!=typeof a&&(b=a,a="fx",c--),arguments.length\x20\t\r\n\f]+)/i,la=/^$|\/(?:java|ecma)script/i,ma={option:[1,""],thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};ma.optgroup=ma.option,ma.tbody=ma.tfoot=ma.colgroup=ma.caption=ma.thead,ma.th=ma.td;function na(a,b){var c;return c="undefined"!=typeof a.getElementsByTagName?a.getElementsByTagName(b||"*"):"undefined"!=typeof a.querySelectorAll?a.querySelectorAll(b||"*"):[],void 0===b||b&&B(a,b)?r.merge([a],c):c}function oa(a,b){for(var c=0,d=a.length;c-1)e&&e.push(f);else if(j=r.contains(f.ownerDocument,f),g=na(l.appendChild(f),"script"),j&&oa(g),c){k=0;while(f=g[k++])la.test(f.type||"")&&c.push(f)}return l}!function(){var a=d.createDocumentFragment(),b=a.appendChild(d.createElement("div")),c=d.createElement("input");c.setAttribute("type","radio"),c.setAttribute("checked","checked"),c.setAttribute("name","t"),b.appendChild(c),o.checkClone=b.cloneNode(!0).cloneNode(!0).lastChild.checked,b.innerHTML="",o.noCloneChecked=!!b.cloneNode(!0).lastChild.defaultValue}();var ra=d.documentElement,sa=/^key/,ta=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,ua=/^([^.]*)(?:\.(.+)|)/;function va(){return!0}function wa(){return!1}function xa(){try{return d.activeElement}catch(a){}}function ya(a,b,c,d,e,f){var g,h;if("object"==typeof b){"string"!=typeof c&&(d=d||c,c=void 0);for(h in b)ya(a,h,c,d,b[h],f);return a}if(null==d&&null==e?(e=c,d=c=void 0):null==e&&("string"==typeof c?(e=d,d=void 0):(e=d,d=c,c=void 0)),e===!1)e=wa;else if(!e)return a;return 1===f&&(g=e,e=function(a){return r().off(a),g.apply(this,arguments)},e.guid=g.guid||(g.guid=r.guid++)),a.each(function(){r.event.add(this,b,e,d,c)})}r.event={global:{},add:function(a,b,c,d,e){var f,g,h,i,j,k,l,m,n,o,p,q=W.get(a);if(q){c.handler&&(f=c,c=f.handler,e=f.selector),e&&r.find.matchesSelector(ra,e),c.guid||(c.guid=r.guid++),(i=q.events)||(i=q.events={}),(g=q.handle)||(g=q.handle=function(b){return"undefined"!=typeof r&&r.event.triggered!==b.type?r.event.dispatch.apply(a,arguments):void 0}),b=(b||"").match(L)||[""],j=b.length;while(j--)h=ua.exec(b[j])||[],n=p=h[1],o=(h[2]||"").split(".").sort(),n&&(l=r.event.special[n]||{},n=(e?l.delegateType:l.bindType)||n,l=r.event.special[n]||{},k=r.extend({type:n,origType:p,data:d,handler:c,guid:c.guid,selector:e,needsContext:e&&r.expr.match.needsContext.test(e),namespace:o.join(".")},f),(m=i[n])||(m=i[n]=[],m.delegateCount=0,l.setup&&l.setup.call(a,d,o,g)!==!1||a.addEventListener&&a.addEventListener(n,g)),l.add&&(l.add.call(a,k),k.handler.guid||(k.handler.guid=c.guid)),e?m.splice(m.delegateCount++,0,k):m.push(k),r.event.global[n]=!0)}},remove:function(a,b,c,d,e){var f,g,h,i,j,k,l,m,n,o,p,q=W.hasData(a)&&W.get(a);if(q&&(i=q.events)){b=(b||"").match(L)||[""],j=b.length;while(j--)if(h=ua.exec(b[j])||[],n=p=h[1],o=(h[2]||"").split(".").sort(),n){l=r.event.special[n]||{},n=(d?l.delegateType:l.bindType)||n,m=i[n]||[],h=h[2]&&new RegExp("(^|\\.)"+o.join("\\.(?:.*\\.|)")+"(\\.|$)"),g=f=m.length;while(f--)k=m[f],!e&&p!==k.origType||c&&c.guid!==k.guid||h&&!h.test(k.namespace)||d&&d!==k.selector&&("**"!==d||!k.selector)||(m.splice(f,1),k.selector&&m.delegateCount--,l.remove&&l.remove.call(a,k));g&&!m.length&&(l.teardown&&l.teardown.call(a,o,q.handle)!==!1||r.removeEvent(a,n,q.handle),delete i[n])}else for(n in i)r.event.remove(a,n+b[j],c,d,!0);r.isEmptyObject(i)&&W.remove(a,"handle events")}},dispatch:function(a){var b=r.event.fix(a),c,d,e,f,g,h,i=new Array(arguments.length),j=(W.get(this,"events")||{})[b.type]||[],k=r.event.special[b.type]||{};for(i[0]=b,c=1;c=1))for(;j!==this;j=j.parentNode||this)if(1===j.nodeType&&("click"!==a.type||j.disabled!==!0)){for(f=[],g={},c=0;c-1:r.find(e,this,null,[j]).length),g[e]&&f.push(d);f.length&&h.push({elem:j,handlers:f})}return j=this,i\x20\t\r\n\f]*)[^>]*)\/>/gi,Aa=/\s*$/g;function Ea(a,b){return B(a,"table")&&B(11!==b.nodeType?b:b.firstChild,"tr")?r(">tbody",a)[0]||a:a}function Fa(a){return a.type=(null!==a.getAttribute("type"))+"/"+a.type,a}function Ga(a){var b=Ca.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function Ha(a,b){var c,d,e,f,g,h,i,j;if(1===b.nodeType){if(W.hasData(a)&&(f=W.access(a),g=W.set(b,f),j=f.events)){delete g.handle,g.events={};for(e in j)for(c=0,d=j[e].length;c1&&"string"==typeof q&&!o.checkClone&&Ba.test(q))return a.each(function(e){var f=a.eq(e);s&&(b[0]=q.call(this,e,f.html())),Ja(f,b,c,d)});if(m&&(e=qa(b,a[0].ownerDocument,!1,a,d),f=e.firstChild,1===e.childNodes.length&&(e=f),f||d)){for(h=r.map(na(e,"script"),Fa),i=h.length;l")},clone:function(a,b,c){var d,e,f,g,h=a.cloneNode(!0),i=r.contains(a.ownerDocument,a);if(!(o.noCloneChecked||1!==a.nodeType&&11!==a.nodeType||r.isXMLDoc(a)))for(g=na(h),f=na(a),d=0,e=f.length;d0&&oa(g,!i&&na(a,"script")),h},cleanData:function(a){for(var b,c,d,e=r.event.special,f=0;void 0!==(c=a[f]);f++)if(U(c)){if(b=c[W.expando]){if(b.events)for(d in b.events)e[d]?r.event.remove(c,d):r.removeEvent(c,d,b.handle);c[W.expando]=void 0}c[X.expando]&&(c[X.expando]=void 0)}}}),r.fn.extend({detach:function(a){return Ka(this,a,!0)},remove:function(a){return Ka(this,a)},text:function(a){return T(this,function(a){return void 0===a?r.text(this):this.empty().each(function(){1!==this.nodeType&&11!==this.nodeType&&9!==this.nodeType||(this.textContent=a)})},null,a,arguments.length)},append:function(){return Ja(this,arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=Ea(this,a);b.appendChild(a)}})},prepend:function(){return Ja(this,arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=Ea(this,a);b.insertBefore(a,b.firstChild)}})},before:function(){return Ja(this,arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this)})},after:function(){return Ja(this,arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this.nextSibling)})},empty:function(){for(var a,b=0;null!=(a=this[b]);b++)1===a.nodeType&&(r.cleanData(na(a,!1)),a.textContent="");return this},clone:function(a,b){return a=null!=a&&a,b=null==b?a:b,this.map(function(){return r.clone(this,a,b)})},html:function(a){return T(this,function(a){var b=this[0]||{},c=0,d=this.length;if(void 0===a&&1===b.nodeType)return b.innerHTML;if("string"==typeof a&&!Aa.test(a)&&!ma[(ka.exec(a)||["",""])[1].toLowerCase()]){a=r.htmlPrefilter(a);try{for(;c1)}});function _a(a,b,c,d,e){return new _a.prototype.init(a,b,c,d,e)}r.Tween=_a,_a.prototype={constructor:_a,init:function(a,b,c,d,e,f){this.elem=a,this.prop=c,this.easing=e||r.easing._default,this.options=b,this.start=this.now=this.cur(),this.end=d,this.unit=f||(r.cssNumber[c]?"":"px")},cur:function(){var a=_a.propHooks[this.prop];return a&&a.get?a.get(this):_a.propHooks._default.get(this)},run:function(a){var b,c=_a.propHooks[this.prop];return this.options.duration?this.pos=b=r.easing[this.easing](a,this.options.duration*a,0,1,this.options.duration):this.pos=b=a,this.now=(this.end-this.start)*b+this.start,this.options.step&&this.options.step.call(this.elem,this.now,this),c&&c.set?c.set(this):_a.propHooks._default.set(this),this}},_a.prototype.init.prototype=_a.prototype,_a.propHooks={_default:{get:function(a){var b;return 1!==a.elem.nodeType||null!=a.elem[a.prop]&&null==a.elem.style[a.prop]?a.elem[a.prop]:(b=r.css(a.elem,a.prop,""),b&&"auto"!==b?b:0)},set:function(a){r.fx.step[a.prop]?r.fx.step[a.prop](a):1!==a.elem.nodeType||null==a.elem.style[r.cssProps[a.prop]]&&!r.cssHooks[a.prop]?a.elem[a.prop]=a.now:r.style(a.elem,a.prop,a.now+a.unit)}}},_a.propHooks.scrollTop=_a.propHooks.scrollLeft={set:function(a){a.elem.nodeType&&a.elem.parentNode&&(a.elem[a.prop]=a.now)}},r.easing={linear:function(a){return a},swing:function(a){return.5-Math.cos(a*Math.PI)/2},_default:"swing"},r.fx=_a.prototype.init,r.fx.step={};var ab,bb,cb=/^(?:toggle|show|hide)$/,db=/queueHooks$/;function eb(){bb&&(d.hidden===!1&&a.requestAnimationFrame?a.requestAnimationFrame(eb):a.setTimeout(eb,r.fx.interval),r.fx.tick())}function fb(){return a.setTimeout(function(){ab=void 0}),ab=r.now()}function gb(a,b){var c,d=0,e={height:a};for(b=b?1:0;d<4;d+=2-b)c=ca[d],e["margin"+c]=e["padding"+c]=a;return b&&(e.opacity=e.width=a),e}function hb(a,b,c){for(var d,e=(kb.tweeners[b]||[]).concat(kb.tweeners["*"]),f=0,g=e.length;f1)},removeAttr:function(a){return this.each(function(){r.removeAttr(this,a)})}}),r.extend({attr:function(a,b,c){var d,e,f=a.nodeType;if(3!==f&&8!==f&&2!==f)return"undefined"==typeof a.getAttribute?r.prop(a,b,c):(1===f&&r.isXMLDoc(a)||(e=r.attrHooks[b.toLowerCase()]||(r.expr.match.bool.test(b)?lb:void 0)),void 0!==c?null===c?void r.removeAttr(a,b):e&&"set"in e&&void 0!==(d=e.set(a,c,b))?d:(a.setAttribute(b,c+""),c):e&&"get"in e&&null!==(d=e.get(a,b))?d:(d=r.find.attr(a,b), +null==d?void 0:d))},attrHooks:{type:{set:function(a,b){if(!o.radioValue&&"radio"===b&&B(a,"input")){var c=a.value;return a.setAttribute("type",b),c&&(a.value=c),b}}}},removeAttr:function(a,b){var c,d=0,e=b&&b.match(L);if(e&&1===a.nodeType)while(c=e[d++])a.removeAttribute(c)}}),lb={set:function(a,b,c){return b===!1?r.removeAttr(a,c):a.setAttribute(c,c),c}},r.each(r.expr.match.bool.source.match(/\w+/g),function(a,b){var c=mb[b]||r.find.attr;mb[b]=function(a,b,d){var e,f,g=b.toLowerCase();return d||(f=mb[g],mb[g]=e,e=null!=c(a,b,d)?g:null,mb[g]=f),e}});var nb=/^(?:input|select|textarea|button)$/i,ob=/^(?:a|area)$/i;r.fn.extend({prop:function(a,b){return T(this,r.prop,a,b,arguments.length>1)},removeProp:function(a){return this.each(function(){delete this[r.propFix[a]||a]})}}),r.extend({prop:function(a,b,c){var d,e,f=a.nodeType;if(3!==f&&8!==f&&2!==f)return 1===f&&r.isXMLDoc(a)||(b=r.propFix[b]||b,e=r.propHooks[b]),void 0!==c?e&&"set"in e&&void 0!==(d=e.set(a,c,b))?d:a[b]=c:e&&"get"in e&&null!==(d=e.get(a,b))?d:a[b]},propHooks:{tabIndex:{get:function(a){var b=r.find.attr(a,"tabindex");return b?parseInt(b,10):nb.test(a.nodeName)||ob.test(a.nodeName)&&a.href?0:-1}}},propFix:{"for":"htmlFor","class":"className"}}),o.optSelected||(r.propHooks.selected={get:function(a){var b=a.parentNode;return b&&b.parentNode&&b.parentNode.selectedIndex,null},set:function(a){var b=a.parentNode;b&&(b.selectedIndex,b.parentNode&&b.parentNode.selectedIndex)}}),r.each(["tabIndex","readOnly","maxLength","cellSpacing","cellPadding","rowSpan","colSpan","useMap","frameBorder","contentEditable"],function(){r.propFix[this.toLowerCase()]=this});function pb(a){var b=a.match(L)||[];return b.join(" ")}function qb(a){return a.getAttribute&&a.getAttribute("class")||""}r.fn.extend({addClass:function(a){var b,c,d,e,f,g,h,i=0;if(r.isFunction(a))return this.each(function(b){r(this).addClass(a.call(this,b,qb(this)))});if("string"==typeof a&&a){b=a.match(L)||[];while(c=this[i++])if(e=qb(c),d=1===c.nodeType&&" "+pb(e)+" "){g=0;while(f=b[g++])d.indexOf(" "+f+" ")<0&&(d+=f+" ");h=pb(d),e!==h&&c.setAttribute("class",h)}}return this},removeClass:function(a){var b,c,d,e,f,g,h,i=0;if(r.isFunction(a))return this.each(function(b){r(this).removeClass(a.call(this,b,qb(this)))});if(!arguments.length)return this.attr("class","");if("string"==typeof a&&a){b=a.match(L)||[];while(c=this[i++])if(e=qb(c),d=1===c.nodeType&&" "+pb(e)+" "){g=0;while(f=b[g++])while(d.indexOf(" "+f+" ")>-1)d=d.replace(" "+f+" "," ");h=pb(d),e!==h&&c.setAttribute("class",h)}}return this},toggleClass:function(a,b){var c=typeof a;return"boolean"==typeof b&&"string"===c?b?this.addClass(a):this.removeClass(a):r.isFunction(a)?this.each(function(c){r(this).toggleClass(a.call(this,c,qb(this),b),b)}):this.each(function(){var b,d,e,f;if("string"===c){d=0,e=r(this),f=a.match(L)||[];while(b=f[d++])e.hasClass(b)?e.removeClass(b):e.addClass(b)}else void 0!==a&&"boolean"!==c||(b=qb(this),b&&W.set(this,"__className__",b),this.setAttribute&&this.setAttribute("class",b||a===!1?"":W.get(this,"__className__")||""))})},hasClass:function(a){var b,c,d=0;b=" "+a+" ";while(c=this[d++])if(1===c.nodeType&&(" "+pb(qb(c))+" ").indexOf(b)>-1)return!0;return!1}});var rb=/\r/g;r.fn.extend({val:function(a){var b,c,d,e=this[0];{if(arguments.length)return d=r.isFunction(a),this.each(function(c){var e;1===this.nodeType&&(e=d?a.call(this,c,r(this).val()):a,null==e?e="":"number"==typeof e?e+="":Array.isArray(e)&&(e=r.map(e,function(a){return null==a?"":a+""})),b=r.valHooks[this.type]||r.valHooks[this.nodeName.toLowerCase()],b&&"set"in b&&void 0!==b.set(this,e,"value")||(this.value=e))});if(e)return b=r.valHooks[e.type]||r.valHooks[e.nodeName.toLowerCase()],b&&"get"in b&&void 0!==(c=b.get(e,"value"))?c:(c=e.value,"string"==typeof c?c.replace(rb,""):null==c?"":c)}}}),r.extend({valHooks:{option:{get:function(a){var b=r.find.attr(a,"value");return null!=b?b:pb(r.text(a))}},select:{get:function(a){var b,c,d,e=a.options,f=a.selectedIndex,g="select-one"===a.type,h=g?null:[],i=g?f+1:e.length;for(d=f<0?i:g?f:0;d-1)&&(c=!0);return c||(a.selectedIndex=-1),f}}}}),r.each(["radio","checkbox"],function(){r.valHooks[this]={set:function(a,b){if(Array.isArray(b))return a.checked=r.inArray(r(a).val(),b)>-1}},o.checkOn||(r.valHooks[this].get=function(a){return null===a.getAttribute("value")?"on":a.value})});var sb=/^(?:focusinfocus|focusoutblur)$/;r.extend(r.event,{trigger:function(b,c,e,f){var g,h,i,j,k,m,n,o=[e||d],p=l.call(b,"type")?b.type:b,q=l.call(b,"namespace")?b.namespace.split("."):[];if(h=i=e=e||d,3!==e.nodeType&&8!==e.nodeType&&!sb.test(p+r.event.triggered)&&(p.indexOf(".")>-1&&(q=p.split("."),p=q.shift(),q.sort()),k=p.indexOf(":")<0&&"on"+p,b=b[r.expando]?b:new r.Event(p,"object"==typeof b&&b),b.isTrigger=f?2:3,b.namespace=q.join("."),b.rnamespace=b.namespace?new RegExp("(^|\\.)"+q.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,b.result=void 0,b.target||(b.target=e),c=null==c?[b]:r.makeArray(c,[b]),n=r.event.special[p]||{},f||!n.trigger||n.trigger.apply(e,c)!==!1)){if(!f&&!n.noBubble&&!r.isWindow(e)){for(j=n.delegateType||p,sb.test(j+p)||(h=h.parentNode);h;h=h.parentNode)o.push(h),i=h;i===(e.ownerDocument||d)&&o.push(i.defaultView||i.parentWindow||a)}g=0;while((h=o[g++])&&!b.isPropagationStopped())b.type=g>1?j:n.bindType||p,m=(W.get(h,"events")||{})[b.type]&&W.get(h,"handle"),m&&m.apply(h,c),m=k&&h[k],m&&m.apply&&U(h)&&(b.result=m.apply(h,c),b.result===!1&&b.preventDefault());return b.type=p,f||b.isDefaultPrevented()||n._default&&n._default.apply(o.pop(),c)!==!1||!U(e)||k&&r.isFunction(e[p])&&!r.isWindow(e)&&(i=e[k],i&&(e[k]=null),r.event.triggered=p,e[p](),r.event.triggered=void 0,i&&(e[k]=i)),b.result}},simulate:function(a,b,c){var d=r.extend(new r.Event,c,{type:a,isSimulated:!0});r.event.trigger(d,null,b)}}),r.fn.extend({trigger:function(a,b){return this.each(function(){r.event.trigger(a,b,this)})},triggerHandler:function(a,b){var c=this[0];if(c)return r.event.trigger(a,b,c,!0)}}),r.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(a,b){r.fn[b]=function(a,c){return arguments.length>0?this.on(b,null,a,c):this.trigger(b)}}),r.fn.extend({hover:function(a,b){return this.mouseenter(a).mouseleave(b||a)}}),o.focusin="onfocusin"in a,o.focusin||r.each({focus:"focusin",blur:"focusout"},function(a,b){var c=function(a){r.event.simulate(b,a.target,r.event.fix(a))};r.event.special[b]={setup:function(){var d=this.ownerDocument||this,e=W.access(d,b);e||d.addEventListener(a,c,!0),W.access(d,b,(e||0)+1)},teardown:function(){var d=this.ownerDocument||this,e=W.access(d,b)-1;e?W.access(d,b,e):(d.removeEventListener(a,c,!0),W.remove(d,b))}}});var tb=a.location,ub=r.now(),vb=/\?/;r.parseXML=function(b){var c;if(!b||"string"!=typeof b)return null;try{c=(new a.DOMParser).parseFromString(b,"text/xml")}catch(d){c=void 0}return c&&!c.getElementsByTagName("parsererror").length||r.error("Invalid XML: "+b),c};var wb=/\[\]$/,xb=/\r?\n/g,yb=/^(?:submit|button|image|reset|file)$/i,zb=/^(?:input|select|textarea|keygen)/i;function Ab(a,b,c,d){var e;if(Array.isArray(b))r.each(b,function(b,e){c||wb.test(a)?d(a,e):Ab(a+"["+("object"==typeof e&&null!=e?b:"")+"]",e,c,d)});else if(c||"object"!==r.type(b))d(a,b);else for(e in b)Ab(a+"["+e+"]",b[e],c,d)}r.param=function(a,b){var c,d=[],e=function(a,b){var c=r.isFunction(b)?b():b;d[d.length]=encodeURIComponent(a)+"="+encodeURIComponent(null==c?"":c)};if(Array.isArray(a)||a.jquery&&!r.isPlainObject(a))r.each(a,function(){e(this.name,this.value)});else for(c in a)Ab(c,a[c],b,e);return d.join("&")},r.fn.extend({serialize:function(){return r.param(this.serializeArray())},serializeArray:function(){return this.map(function(){var a=r.prop(this,"elements");return a?r.makeArray(a):this}).filter(function(){var a=this.type;return this.name&&!r(this).is(":disabled")&&zb.test(this.nodeName)&&!yb.test(a)&&(this.checked||!ja.test(a))}).map(function(a,b){var c=r(this).val();return null==c?null:Array.isArray(c)?r.map(c,function(a){return{name:b.name,value:a.replace(xb,"\r\n")}}):{name:b.name,value:c.replace(xb,"\r\n")}}).get()}});var Bb=/%20/g,Cb=/#.*$/,Db=/([?&])_=[^&]*/,Eb=/^(.*?):[ \t]*([^\r\n]*)$/gm,Fb=/^(?:about|app|app-storage|.+-extension|file|res|widget):$/,Gb=/^(?:GET|HEAD)$/,Hb=/^\/\//,Ib={},Jb={},Kb="*/".concat("*"),Lb=d.createElement("a");Lb.href=tb.href;function Mb(a){return function(b,c){"string"!=typeof b&&(c=b,b="*");var d,e=0,f=b.toLowerCase().match(L)||[];if(r.isFunction(c))while(d=f[e++])"+"===d[0]?(d=d.slice(1)||"*",(a[d]=a[d]||[]).unshift(c)):(a[d]=a[d]||[]).push(c)}}function Nb(a,b,c,d){var e={},f=a===Jb;function g(h){var i;return e[h]=!0,r.each(a[h]||[],function(a,h){var j=h(b,c,d);return"string"!=typeof j||f||e[j]?f?!(i=j):void 0:(b.dataTypes.unshift(j),g(j),!1)}),i}return g(b.dataTypes[0])||!e["*"]&&g("*")}function Ob(a,b){var c,d,e=r.ajaxSettings.flatOptions||{};for(c in b)void 0!==b[c]&&((e[c]?a:d||(d={}))[c]=b[c]);return d&&r.extend(!0,a,d),a}function Pb(a,b,c){var d,e,f,g,h=a.contents,i=a.dataTypes;while("*"===i[0])i.shift(),void 0===d&&(d=a.mimeType||b.getResponseHeader("Content-Type"));if(d)for(e in h)if(h[e]&&h[e].test(d)){i.unshift(e);break}if(i[0]in c)f=i[0];else{for(e in c){if(!i[0]||a.converters[e+" "+i[0]]){f=e;break}g||(g=e)}f=f||g}if(f)return f!==i[0]&&i.unshift(f),c[f]}function Qb(a,b,c,d){var e,f,g,h,i,j={},k=a.dataTypes.slice();if(k[1])for(g in a.converters)j[g.toLowerCase()]=a.converters[g];f=k.shift();while(f)if(a.responseFields[f]&&(c[a.responseFields[f]]=b),!i&&d&&a.dataFilter&&(b=a.dataFilter(b,a.dataType)),i=f,f=k.shift())if("*"===f)f=i;else if("*"!==i&&i!==f){if(g=j[i+" "+f]||j["* "+f],!g)for(e in j)if(h=e.split(" "),h[1]===f&&(g=j[i+" "+h[0]]||j["* "+h[0]])){g===!0?g=j[e]:j[e]!==!0&&(f=h[0],k.unshift(h[1]));break}if(g!==!0)if(g&&a["throws"])b=g(b);else try{b=g(b)}catch(l){return{state:"parsererror",error:g?l:"No conversion from "+i+" to "+f}}}return{state:"success",data:b}}r.extend({active:0,lastModified:{},etag:{},ajaxSettings:{url:tb.href,type:"GET",isLocal:Fb.test(tb.protocol),global:!0,processData:!0,async:!0,contentType:"application/x-www-form-urlencoded; charset=UTF-8",accepts:{"*":Kb,text:"text/plain",html:"text/html",xml:"application/xml, text/xml",json:"application/json, text/javascript"},contents:{xml:/\bxml\b/,html:/\bhtml/,json:/\bjson\b/},responseFields:{xml:"responseXML",text:"responseText",json:"responseJSON"},converters:{"* text":String,"text html":!0,"text json":JSON.parse,"text xml":r.parseXML},flatOptions:{url:!0,context:!0}},ajaxSetup:function(a,b){return b?Ob(Ob(a,r.ajaxSettings),b):Ob(r.ajaxSettings,a)},ajaxPrefilter:Mb(Ib),ajaxTransport:Mb(Jb),ajax:function(b,c){"object"==typeof b&&(c=b,b=void 0),c=c||{};var e,f,g,h,i,j,k,l,m,n,o=r.ajaxSetup({},c),p=o.context||o,q=o.context&&(p.nodeType||p.jquery)?r(p):r.event,s=r.Deferred(),t=r.Callbacks("once memory"),u=o.statusCode||{},v={},w={},x="canceled",y={readyState:0,getResponseHeader:function(a){var b;if(k){if(!h){h={};while(b=Eb.exec(g))h[b[1].toLowerCase()]=b[2]}b=h[a.toLowerCase()]}return null==b?null:b},getAllResponseHeaders:function(){return k?g:null},setRequestHeader:function(a,b){return null==k&&(a=w[a.toLowerCase()]=w[a.toLowerCase()]||a,v[a]=b),this},overrideMimeType:function(a){return null==k&&(o.mimeType=a),this},statusCode:function(a){var b;if(a)if(k)y.always(a[y.status]);else for(b in a)u[b]=[u[b],a[b]];return this},abort:function(a){var b=a||x;return e&&e.abort(b),A(0,b),this}};if(s.promise(y),o.url=((b||o.url||tb.href)+"").replace(Hb,tb.protocol+"//"),o.type=c.method||c.type||o.method||o.type,o.dataTypes=(o.dataType||"*").toLowerCase().match(L)||[""],null==o.crossDomain){j=d.createElement("a");try{j.href=o.url,j.href=j.href,o.crossDomain=Lb.protocol+"//"+Lb.host!=j.protocol+"//"+j.host}catch(z){o.crossDomain=!0}}if(o.data&&o.processData&&"string"!=typeof o.data&&(o.data=r.param(o.data,o.traditional)),Nb(Ib,o,c,y),k)return y;l=r.event&&o.global,l&&0===r.active++&&r.event.trigger("ajaxStart"),o.type=o.type.toUpperCase(),o.hasContent=!Gb.test(o.type),f=o.url.replace(Cb,""),o.hasContent?o.data&&o.processData&&0===(o.contentType||"").indexOf("application/x-www-form-urlencoded")&&(o.data=o.data.replace(Bb,"+")):(n=o.url.slice(f.length),o.data&&(f+=(vb.test(f)?"&":"?")+o.data,delete o.data),o.cache===!1&&(f=f.replace(Db,"$1"),n=(vb.test(f)?"&":"?")+"_="+ub++ +n),o.url=f+n),o.ifModified&&(r.lastModified[f]&&y.setRequestHeader("If-Modified-Since",r.lastModified[f]),r.etag[f]&&y.setRequestHeader("If-None-Match",r.etag[f])),(o.data&&o.hasContent&&o.contentType!==!1||c.contentType)&&y.setRequestHeader("Content-Type",o.contentType),y.setRequestHeader("Accept",o.dataTypes[0]&&o.accepts[o.dataTypes[0]]?o.accepts[o.dataTypes[0]]+("*"!==o.dataTypes[0]?", "+Kb+"; q=0.01":""):o.accepts["*"]);for(m in o.headers)y.setRequestHeader(m,o.headers[m]);if(o.beforeSend&&(o.beforeSend.call(p,y,o)===!1||k))return y.abort();if(x="abort",t.add(o.complete),y.done(o.success),y.fail(o.error),e=Nb(Jb,o,c,y)){if(y.readyState=1,l&&q.trigger("ajaxSend",[y,o]),k)return y;o.async&&o.timeout>0&&(i=a.setTimeout(function(){y.abort("timeout")},o.timeout));try{k=!1,e.send(v,A)}catch(z){if(k)throw z;A(-1,z)}}else A(-1,"No Transport");function A(b,c,d,h){var j,m,n,v,w,x=c;k||(k=!0,i&&a.clearTimeout(i),e=void 0,g=h||"",y.readyState=b>0?4:0,j=b>=200&&b<300||304===b,d&&(v=Pb(o,y,d)),v=Qb(o,v,y,j),j?(o.ifModified&&(w=y.getResponseHeader("Last-Modified"),w&&(r.lastModified[f]=w),w=y.getResponseHeader("etag"),w&&(r.etag[f]=w)),204===b||"HEAD"===o.type?x="nocontent":304===b?x="notmodified":(x=v.state,m=v.data,n=v.error,j=!n)):(n=x,!b&&x||(x="error",b<0&&(b=0))),y.status=b,y.statusText=(c||x)+"",j?s.resolveWith(p,[m,x,y]):s.rejectWith(p,[y,x,n]),y.statusCode(u),u=void 0,l&&q.trigger(j?"ajaxSuccess":"ajaxError",[y,o,j?m:n]),t.fireWith(p,[y,x]),l&&(q.trigger("ajaxComplete",[y,o]),--r.active||r.event.trigger("ajaxStop")))}return y},getJSON:function(a,b,c){return r.get(a,b,c,"json")},getScript:function(a,b){return r.get(a,void 0,b,"script")}}),r.each(["get","post"],function(a,b){r[b]=function(a,c,d,e){return r.isFunction(c)&&(e=e||d,d=c,c=void 0),r.ajax(r.extend({url:a,type:b,dataType:e,data:c,success:d},r.isPlainObject(a)&&a))}}),r._evalUrl=function(a){return r.ajax({url:a,type:"GET",dataType:"script",cache:!0,async:!1,global:!1,"throws":!0})},r.fn.extend({wrapAll:function(a){var b;return this[0]&&(r.isFunction(a)&&(a=a.call(this[0])),b=r(a,this[0].ownerDocument).eq(0).clone(!0),this[0].parentNode&&b.insertBefore(this[0]),b.map(function(){var a=this;while(a.firstElementChild)a=a.firstElementChild;return a}).append(this)),this},wrapInner:function(a){return r.isFunction(a)?this.each(function(b){r(this).wrapInner(a.call(this,b))}):this.each(function(){var b=r(this),c=b.contents();c.length?c.wrapAll(a):b.append(a)})},wrap:function(a){var b=r.isFunction(a);return this.each(function(c){r(this).wrapAll(b?a.call(this,c):a)})},unwrap:function(a){return this.parent(a).not("body").each(function(){r(this).replaceWith(this.childNodes)}),this}}),r.expr.pseudos.hidden=function(a){return!r.expr.pseudos.visible(a)},r.expr.pseudos.visible=function(a){return!!(a.offsetWidth||a.offsetHeight||a.getClientRects().length)},r.ajaxSettings.xhr=function(){try{return new a.XMLHttpRequest}catch(b){}};var Rb={0:200,1223:204},Sb=r.ajaxSettings.xhr();o.cors=!!Sb&&"withCredentials"in Sb,o.ajax=Sb=!!Sb,r.ajaxTransport(function(b){var c,d;if(o.cors||Sb&&!b.crossDomain)return{send:function(e,f){var g,h=b.xhr();if(h.open(b.type,b.url,b.async,b.username,b.password),b.xhrFields)for(g in b.xhrFields)h[g]=b.xhrFields[g];b.mimeType&&h.overrideMimeType&&h.overrideMimeType(b.mimeType),b.crossDomain||e["X-Requested-With"]||(e["X-Requested-With"]="XMLHttpRequest");for(g in e)h.setRequestHeader(g,e[g]);c=function(a){return function(){c&&(c=d=h.onload=h.onerror=h.onabort=h.onreadystatechange=null,"abort"===a?h.abort():"error"===a?"number"!=typeof h.status?f(0,"error"):f(h.status,h.statusText):f(Rb[h.status]||h.status,h.statusText,"text"!==(h.responseType||"text")||"string"!=typeof h.responseText?{binary:h.response}:{text:h.responseText},h.getAllResponseHeaders()))}},h.onload=c(),d=h.onerror=c("error"),void 0!==h.onabort?h.onabort=d:h.onreadystatechange=function(){4===h.readyState&&a.setTimeout(function(){c&&d()})},c=c("abort");try{h.send(b.hasContent&&b.data||null)}catch(i){if(c)throw i}},abort:function(){c&&c()}}}),r.ajaxPrefilter(function(a){a.crossDomain&&(a.contents.script=!1)}),r.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/\b(?:java|ecma)script\b/},converters:{"text script":function(a){return r.globalEval(a),a}}}),r.ajaxPrefilter("script",function(a){void 0===a.cache&&(a.cache=!1),a.crossDomain&&(a.type="GET")}),r.ajaxTransport("script",function(a){if(a.crossDomain){var b,c;return{send:function(e,f){b=r("