diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b702f514d1..7c0810171f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,8 +1,12 @@ >^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ > Please delete this note before submitting the pull request. -> For 1.12 Features: set Milestone to 1.12 and Base Branch to release-1.12 -> Help editing and submitting pull requests: https://deploy-preview-9510--kubernetes-io-master-staging.netlify.com/docs/contribute/start/#submit-a-pull-request. -> Help choosing which branch to use, see +> +> For 1.13 Features: set Milestone to 1.13 and Base Branch to dev-1.13 +> +> Help editing and submitting pull requests: +> https://kubernetes.io/docs/contribute/start/#improve-existing-content. +> +> Help choosing which branch to use: > https://kubernetes.io/docs/contribute/start#choose-which-git-branch-to-use. >^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ > diff --git a/.gitignore b/.gitignore index 773d707e9c..e78fa72d9a 100644 --- a/.gitignore +++ b/.gitignore @@ -32,3 +32,8 @@ public/ # User-specific editorconfig files .editorconfig + +# Netlify Functions build output +package-lock.json +functions/ +node_modules/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 13c07eb905..d5f2c4ce05 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,8 @@ These are just guidelines, not rules. Use your best judgment, and feel free to p ### Code of Conduct -Kubernetes follows the [Cloud Native Computing Foundation (CNCF) Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to Sarah Novotny [sarahnovotny@google.com](mailto:sarahnovotny@google.com) and/or Dan Kohn [dan@linuxfoundation.org](mailto:dan@linuxfoundation.org). +Kubernetes follows the [Cloud Native Computing Foundation (CNCF) Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to the +[Kubernetes Code of Conduct Committee](https://github.com/kubernetes/community/tree/master/committee-code-of-conduct) . ### Documentation and Site Decisions diff --git a/Dockerfile b/Dockerfile index 3dade4f6c4..0e3f6d1099 100644 --- a/Dockerfile +++ b/Dockerfile @@ -20,10 +20,11 @@ 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_extended_${HUGO_VERSION}_linux-64bit.tar.gz | tar -xz && \ + #curl -L https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-64bit.tar.gz | tar -xz && \ + 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 && \ + #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 diff --git a/Makefile b/Makefile index 747dfd091f..366671f09f 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,9 @@ DOCKER = docker -HUGO_VERSION = 0.47.1 +HUGO_VERSION = 0.49 DOCKER_IMAGE = kubernetes-hugo DOCKER_RUN = $(DOCKER) run --rm --interactive --tty --volume $(PWD):/src +NODE_BIN = node_modules/.bin +NETLIFY_FUNC = $(NODE_BIN)/netlify-lambda .PHONY: all build sass build-preview help serve @@ -16,6 +18,9 @@ build: ## Build site with production settings and put deliverables in ./public build-preview: ## Build site with drafts and future posts enabled hugo -D -F +functions-build: + $(NETLIFY_FUNC) build functions-src + check-headers-file: scripts/check-headers-file.sh @@ -24,6 +29,12 @@ production-build: build check-headers-file ## Build the production site and ensu non-production-build: ## Build the non-production site, which adds noindex headers to prevent indexing hugo --enableGitInfo +sass-build: + scripts/sass.sh build + +sass-develop: + scripts/sass.sh develop + serve: ## Boot the development server. hugo server --ignoreCache --disableFastRender diff --git a/OWNERS b/OWNERS index f98d699709..da9dee9771 100644 --- a/OWNERS +++ b/OWNERS @@ -1,23 +1,10 @@ # Reviewers can /lgtm /approve but not sufficient for auto-merge without an # approver reviewers: -- Rajakavitha1 -- stewart-yu -- xiangpengzhao -- zhangxiaoyu-zidif +- sig-docs-en-reviews # Approvers have all the ability of reviewers but their /approve makes # auto-merge happen if a /lgtm exists, or vice versa, or they can do both # No need for approvers to also be listed as reviewers approvers: -- bradamant3 -- bradtopol -- chenopis -- kbarnard10 -- mistyhacks -- ryanmcginnis -- steveperry-53 -- tengqm -- tfogo -- zacharysarah -- zparnold +- sig-docs-en-owners diff --git a/OWNERS_ALIASES b/OWNERS_ALIASES index 598aeb4767..c27bb0210c 100644 --- a/OWNERS_ALIASES +++ b/OWNERS_ALIASES @@ -97,21 +97,71 @@ aliases: - apelisse - grodrigues3 - spxtr - sig-docs: #Team: documentation; GH: sig-docs-pr-reviews + sig-docs: #Team: documentation; GH: sig-docs-maintainers - bradamant3 - bradtopol - chenopis + - jaredbhatti - kbarnard10 - mistyhacks - - rajakavitha1 - ryanmcginnis - steveperry-53 - - stewart-yu - tengqm + - tfogo - xiangpengzhao - zacharysarah - zhangxiaoyu-zidif - zparnold + sig-docs-en-owners: #Team: Documentation; GH: sig-docs-en-owners + - bradamant3 + - bradtopol + - chenopis + - jaredbhatti + - kbarnard10 + - mistyhacks + - ryanmcginnis + - steveperry-53 + - stewart-yu + - tengqm + - tfogo + - zacharysarah + - zparnold + sig-docs-en-reviews: #Team: Documentation; GH: sig-docs-pr-reviews + - jimangel + - rajakavitha1 + - stewart-yu + - xiangpengzhao + - zhangxiaoyu + sig-docs-ja-owners: #Team: Japanese docs localization; GH: sig-docs-ja-owners + - cstoku + - nasa9084 + - tnir + sig-docs-ja-reviews: #Team: Japanese docs PR reviews; GH:sig-docs-ja-reviews + - cstoku + - makocchi-git + - MasayaAoyama + - nasa9084 + - tnir + sig-docs-ko-owners: #Team Korean docs localization; GH: sig-docs-ko-owners + - ClaudiaJKang + - gochist + sig-docs-ko-reviews: #Team Korean docs reviews; GH: sig-docs-ko-reviews + - ClaudiaJKang + - gochist + - ianychoi + sig-docs-zh-owners: #Team Chinese docs localization; GH: sig-docs-zh-owners + - dchen1107 + - haibinxie + - hanjiayao + - lichuqiang + - tengqm + - xiangpengzhao + - zhangxiaoyu-zidif + sig-docs-zh-reviews: #Team Chinese docs reviews; GH: sig-docs-zh-reviews + - idealhack + - tengqm + - xiangpengzhao + - zhangxiaoyu-zidif sig-federation: #Team: Federation; e.g. Federated Clusters - csbell sig-gcp: #Google Cloud Platform; GH: sig-gcp-pr-reviews diff --git a/README.md b/README.md index 20de961d16..b92d82f7aa 100644 --- a/README.md +++ b/README.md @@ -15,11 +15,29 @@ For more information about contributing to the Kubernetes documentation, see: * [Using Page Templates](http://kubernetes.io/docs/contribute/style/page-templates/) * [Documentation Style Guide](http://kubernetes.io/docs/contribute/style/style-guide/) +## Running the site locally using Docker + +The recommended way to run the Kubernetes website locally is to run a specialized [Docker](https://docker.com) image that includes the [Hugo](https://gohugo.io) static site generator. + +> If you'd prefer to run the website locally without Docker, see [Running the site locally using Hugo](#running-the-site-locally-using-hugo) below. + +If you have Docker [up and running](https://www.docker.com/get-started), build the `kubernetes-hugo` Docker image locally: + +```bash +make docker-image +``` + +Once the image has been built, you can run the site locally: + +```bash +make docker-serve +``` + +Open up your browser to http://localhost:1313 to view the site. As you make changes to the source files, Hugo updates the site and forces a browser refresh. + ## Running the site locally using Hugo -The Kubernetes documentation is built using the [Hugo](https://gohugo.io) static site generator. See the [official Hugo documentation](https://gohugo.io/getting-started/installing/) for Hugo installation instructions. - -> Building and running the site requires the Hugo version specified by the `HUGO_VERSION` environment variable in the [`netlify.toml`](netlify.toml#L9) file. +See the [official Hugo documentation](https://gohugo.io/getting-started/installing/) for Hugo installation instructions. Make sure to install the Hugo version specified by the `HUGO_VERSION` environment variable in the [`netlify.toml`](netlify.toml#L9) file. To run the site locally when you have Hugo installed: @@ -27,23 +45,7 @@ To run the site locally when you have Hugo installed: make serve ``` -This will start the local Hugo server on port 1313. Open up your browser to http://localhost:1313 to view the site. As you make changes to the source files, Hugo updates immediately and forces a browser refresh. - -## Building the site using Docker - -You can build the Kubernetes docs using [Docker](https://docker.com). To get started, make sure that you have Docker running and build the image locally: - -```bash -make docker-image -``` - -Once the `kubernetes-hugo` image has been built locally, you can run the site locally: - -```bash -make docker-serve -``` - -Open up your browser to http://localhost:1313 to view the site. +This will start the local Hugo server on port 1313. Open up your browser to http://localhost:1313 to view the site. As you make changes to the source files, Hugo updates the site and forces a browser refresh. ## Thank you! diff --git a/SECURITY_CONTACTS b/SECURITY_CONTACTS index 38072a560a..22a9f7a2ba 100644 --- a/SECURITY_CONTACTS +++ b/SECURITY_CONTACTS @@ -11,5 +11,5 @@ # INSTRUCTIONS AT https://kubernetes.io/security/ chenopis -jaredbhatti +bradamant3 zacharysarah diff --git a/config.toml b/config.toml index db1c633a1d..92f1eee421 100644 --- a/config.toml +++ b/config.toml @@ -7,7 +7,7 @@ enableRobotsTXT = true disableKinds = ["taxonomy", "taxonomyTerm"] -ignoreFiles = [ "^OWNERS$", "README.md", "^node_modules$", "content/en/docs/doc-contributor-tools" ] +ignoreFiles = [ "^OWNERS$", "README[-]+[a-z]*\\.md", "^node_modules$", "content/en/docs/doc-contributor-tools" ] contentDir = "content/en" @@ -22,7 +22,7 @@ pygmentsStyle = "emacs" # Enable Git variables like commit, lastmod enableGitInfo = true -# This is currently used for testing. +# Norwegian ("no") is sometimes but not currently used for testing. disableLanguages = ["no"] [blackfriday] @@ -131,23 +131,29 @@ description = "Production-Grade Container Orchestration" languageName ="English" # Weight used for sorting. weight = 1 -[languages.cn] + +[languages.zh] title = "Kubernetes" description = "Production-Grade Container Orchestration" -languageName = "Chinese" +languageName = "中文 Chinese" weight = 2 -contentDir = "content/cn" +contentDir = "content/zh" + +[languages.ko] +title = "Kubernetes" +description = "Production-Grade Container Orchestration" +languageName = "한국어 Korean" +weight = 3 +contentDir = "content/ko" + [languages.no] title = "Kubernetes" description = "Production-Grade Container Orchestration" languageName ="Norsk" -weight = 3 +weight = 4 contentDir = "content/no" + +[languages.no.params] +time_format_blog = "02.01.2006" # A list of language codes to look for untranslated content, ordered from left to right. language_alternatives = ["en"] -[languages.ko] -title = "Kubernetes" -description = "Production-Grade Container Orchestration" -languageName = "Korean" -weight = 4 -contentDir = "content/ko" diff --git a/content/cn/includes/default-storage-class-prereqs.md b/content/cn/includes/default-storage-class-prereqs.md deleted file mode 100644 index ef4823318d..0000000000 --- a/content/cn/includes/default-storage-class-prereqs.md +++ /dev/null @@ -1,6 +0,0 @@ -You need to either have a dynamic PersistentVolume provisioner with a default -[StorageClass](/docs/concepts/storage/storage-classes/), -or [statically provision PersistentVolumes](/docs/user-guide/persistent-volumes/#provisioning) -yourself to satisfy the [PersistentVolumeClaims](/docs/user-guide/persistent-volumes/#persistentvolumeclaims) -used here. - diff --git a/content/cn/includes/federated-task-tutorial-prereqs.md b/content/cn/includes/federated-task-tutorial-prereqs.md deleted file mode 100644 index c5ec939c07..0000000000 --- a/content/cn/includes/federated-task-tutorial-prereqs.md +++ /dev/null @@ -1,8 +0,0 @@ -This guide assumes that you have a running Kubernetes Cluster -Federation installation. If not, then head over to the -[federation admin guide](/docs/tutorials/federation/set-up-cluster-federation-kubefed/) to learn how to -bring up a cluster federation (or have your cluster administrator do -this for you). -Other tutorials, such as Kelsey Hightower's -[Federated Kubernetes Tutorial](https://github.com/kelseyhightower/kubernetes-cluster-federation), -might also help you create a Federated Kubernetes cluster. \ No newline at end of file diff --git a/content/cn/includes/federation-content-moved.md b/content/cn/includes/federation-content-moved.md deleted file mode 100644 index 87a10e7199..0000000000 --- a/content/cn/includes/federation-content-moved.md +++ /dev/null @@ -1,2 +0,0 @@ -The topics in the [Federation API](/docs/federation/api-reference/) section of the Kubernetes docs -are being moved to the [Reference](/docs/reference/) section. The content in this topic has moved to: diff --git a/content/cn/includes/federation-current-state.md b/content/cn/includes/federation-current-state.md deleted file mode 100644 index 56e4decdf3..0000000000 --- a/content/cn/includes/federation-current-state.md +++ /dev/null @@ -1,7 +0,0 @@ -**Note:** `Federation V1`, the current Kubernetes federation API which reuses the Kubernetes API -resources 'as is', is currently considered alpha for many of its features, and there is no clear -path to evolve the API to GA. However, there is a `Federation V2` effort in progress to implement -a dedicated federation API apart from the Kubernetes API. The details can be found at -[sig-multicluster community page](https://github.com/kubernetes/community/tree/master/sig-multicluster). -{: .note} - diff --git a/content/cn/includes/index.md b/content/cn/includes/index.md deleted file mode 100644 index ca03031f1e..0000000000 --- a/content/cn/includes/index.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -headless: true ---- diff --git a/content/cn/includes/user-guide-content-moved.md b/content/cn/includes/user-guide-content-moved.md deleted file mode 100644 index 8b93e29f12..0000000000 --- a/content/cn/includes/user-guide-content-moved.md +++ /dev/null @@ -1,3 +0,0 @@ -The topics in the [User Guide](/docs/user-guide/) section of the Kubernetes docs -are being moved to the [Tasks](/docs/tasks/), [Tutorials](/docs/tutorials/), and -[Concepts](/docs/concepts) sections. The content in this topic has moved to: diff --git a/content/cn/includes/user-guide-migration-notice.md b/content/cn/includes/user-guide-migration-notice.md deleted file mode 100644 index 366a05907c..0000000000 --- a/content/cn/includes/user-guide-migration-notice.md +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - -
-

NOTICE

-

As of March 14, 2017, the Kubernetes SIG-Docs-Maintainers group have begun migration of the User Guide content as announced previously to the SIG Docs community through the kubernetes-sig-docs group and kubernetes.slack.com #sig-docs channel.

-

The user guides within this section are being refactored into topics within Tutorials, Tasks, and Concepts. Anything that has been moved will have a notice placed in its previous location as well as a link to its new location. The reorganization implements a new table of contents and should improve the documentation's findability and readability for a wider range of audiences.

-

For any questions, please contact: kubernetes-sig-docs@googlegroups.com

-
diff --git a/content/en/OWNERS b/content/en/OWNERS new file mode 100644 index 0000000000..52f02277d4 --- /dev/null +++ b/content/en/OWNERS @@ -0,0 +1,11 @@ +# This is the directory for English source content. +# Teams and members are visible at https://github.com/orgs/kubernetes/teams. + +reviewers: +- sig-docs-en-reviews + +approvers: +- sig-docs-en-owners + +labels: +- language/en diff --git a/content/en/blog/_posts/2016-05-00-Hypernetes-Security-And-Multi-Tenancy-In-Kubernetes.md b/content/en/blog/_posts/2016-05-00-Hypernetes-Security-And-Multi-Tenancy-In-Kubernetes.md index f7f2615505..36846fe663 100644 --- a/content/en/blog/_posts/2016-05-00-Hypernetes-Security-And-Multi-Tenancy-In-Kubernetes.md +++ b/content/en/blog/_posts/2016-05-00-Hypernetes-Security-And-Multi-Tenancy-In-Kubernetes.md @@ -22,7 +22,7 @@ We can consider containers as two parts (as Kubernetes does). The first part is The interesting part of HyperContainer is not only that it is secure enough for multi-tenant environments (such as a public cloud), but also how well it fits into the Kubernetes philosophy. -One of the most important concepts in Kubernetes is Pods. The design of Pods is a lesson learned ([Borg paper section 8.1](http://static.googleusercontent.com/media/research.google.com/zh-CN//pubs/archive/43438.pdf)) from real world workloads, where in many cases people want an atomic scheduling unit composed of multiple containers (please check this [example](https://github.com/kubernetes/kubernetes/tree/master/examples/javaweb-tomcat-sidecar) for further information). In the context of Linux containers, a Pod wraps and encapsulates several containers into a logical group. But in HyperContainer, the hypervisor serves as a natural boundary, and Pods are introduced as first-class objects: +One of the most important concepts in Kubernetes is Pods. The design of Pods is a lesson learned ([Borg paper section 8.1](http://static.googleusercontent.com/media/research.google.com/zh-CN//pubs/archive/43438.pdf)) from real world workloads, where in many cases people want an atomic scheduling unit composed of multiple containers (please check this [example](https://github.com/kubernetes/examples/tree/master/staging/javaweb-tomcat-sidecar) for further information). In the context of Linux containers, a Pod wraps and encapsulates several containers into a logical group. But in HyperContainer, the hypervisor serves as a natural boundary, and Pods are introduced as first-class objects: diff --git a/content/en/blog/_posts/2017-01-00-Running-Mongodb-On-Kubernetes-With-Statefulsets.md b/content/en/blog/_posts/2017-01-00-Running-Mongodb-On-Kubernetes-With-Statefulsets.md index c1f895f1a2..8c609bfc88 100644 --- a/content/en/blog/_posts/2017-01-00-Running-Mongodb-On-Kubernetes-With-Statefulsets.md +++ b/content/en/blog/_posts/2017-01-00-Running-Mongodb-On-Kubernetes-With-Statefulsets.md @@ -13,7 +13,7 @@ Of course, this is not true at all. At Google, everything runs in a container, i If you’ve followed my previous posts, you know how to create a [MEAN Stack app with Docker](http://blog.sandeepdinesh.com/2015/07/running-mean-web-application-in-docker.html), then [migrate it to Kubernetes](https://medium.com/google-cloud/running-a-mean-stack-on-google-cloud-platform-with-kubernetes-149ca81c2b5d) to provide easier management and reliability, and [create a MongoDB replica set](https://medium.com/google-cloud/mongodb-replica-sets-with-kubernetes-d96606bd9474) to provide redundancy and high availability. -While the replica set in my previous blog post worked, there were some annoying steps that you needed to follow. You had to manually create a disk, a ReplicationController, and a service for each replica. Scaling the set up and down meant managing all of these resources manually, which is an opportunity for error, and would put your stateful application at risk In the previous example, we created a Makefile to ease the management of of these resources, but it would have been great if Kubernetes could just take care of all of this for us. +While the replica set in my previous blog post worked, there were some annoying steps that you needed to follow. You had to manually create a disk, a ReplicationController, and a service for each replica. Scaling the set up and down meant managing all of these resources manually, which is an opportunity for error, and would put your stateful application at risk In the previous example, we created a Makefile to ease the management of these resources, but it would have been great if Kubernetes could just take care of all of this for us. With StatefulSets, these headaches finally go away. You can create and manage your MongoDB replica set natively in Kubernetes, without the need for scripts and Makefiles. Let’s take a look how. diff --git a/content/en/blog/_posts/2017-02-00-Postgresql-Clusters-Kubernetes-Statefulsets.md b/content/en/blog/_posts/2017-02-00-Postgresql-Clusters-Kubernetes-Statefulsets.md index 70b2359b8d..b8747f50f3 100644 --- a/content/en/blog/_posts/2017-02-00-Postgresql-Clusters-Kubernetes-Statefulsets.md +++ b/content/en/blog/_posts/2017-02-00-Postgresql-Clusters-Kubernetes-Statefulsets.md @@ -205,7 +205,7 @@ This environment variable is a hint to the container initialization logic as to -The tests below assume that the psql client has been installed on the test system. If if not, the psql client has been previously installed, it can be installed as follows: +The tests below assume that the psql client has been installed on the test system. If not, the psql client has been previously installed, it can be installed as follows: diff --git a/content/en/blog/_posts/2018-07-16-kubernetes-1.11-release-interview.md b/content/en/blog/_posts/2018-07-16-kubernetes-1.11-release-interview.md index ad3531eb18..5bfd60c125 100644 --- a/content/en/blog/_posts/2018-07-16-kubernetes-1.11-release-interview.md +++ b/content/en/blog/_posts/2018-07-16-kubernetes-1.11-release-interview.md @@ -122,7 +122,7 @@ TIM PEPPER: A test escape, another way to think of it as you shipped a bug becau TIM PEPPER: It's common for us to focus on "I've created this feature and I'm testing the positive cases". And this also comes to thinking about things like secure by default and having a really robust system. A harder piece of engineering often is to think about the failure cases and really actively manage those well. -JOSH BERKUS: I had a conversation with a contributor recently where it became apparent that that contributor had never worked on a support team, because their conception of a badly behaved user was, like, a hacker, right? An attacker who comes from outside. +JOSH BERKUS: I had a conversation with a contributor recently where it became apparent that contributor had never worked on a support team, because their conception of a badly behaved user was, like, a hacker, right? An attacker who comes from outside. And I'm like, no, no, no. You're stable of badly behaved users is your own staff. You know, they will do bad things, not necessarily intending to do bad things, but because they're trying to take a shortcut. And that is actually your primary concern in terms of preventing breaking the system. @@ -158,7 +158,7 @@ But then you start also getting interactions. Maybe a bug was introduced, and ot And maybe because I'm following Josh into this role from a bug triage position and in his mentions earlier of just the communications and tracking involved with that versus triage, I do have a bit of a concern that at times, email and Slack are relatively quiet. Some of the SIG meeting notes are a bit sparse or YouTube videos slow to upload. So the general artifacts around choice making I think is an area where we need a little more rigor. So I'm hoping to see some of that. -And that can be just as subtle as commenting on issues like, hey, this commit doesn't say what it's doing. And for that reason on the release team, we can't assess its risk versus value. So could you give a little more information here? Things like that that give more information both to the release team and the development community as well, because this is open source. And to collaborate, you really do need to communicate in depth. +And that can be just as subtle as commenting on issues like, hey, this commit doesn't say what it's doing. And for that reason on the release team, we can't assess its risk versus value. So could you give a little more information here? Things like that give more information both to the release team and the development community as well, because this is open source. And to collaborate, you really do need to communicate in depth. CRAIG BOX: Speaking of cultural changes, professional baker to Kubernetes' release lead sounds like quite a journey. @@ -234,7 +234,7 @@ JOSH BERKUS: And so that made a big difference. And the second thing that was pr JOSH BERKUS: We had a lot of problems with flaky tests. We have a lot of old tests that are not all that well maintained, and they're testing very complicated things like upgrading a cluster that has 40 nodes. And as a result, these tests have high failure rates that have very little to do with any change in the code. -And so one of the things that happened, and the reason we had a one-day delay in the release is, you know, we're a week out from release, and just by random luck of the draw, a bunch of these tests all at once got a run of failures. And it turned out that that run of failures didn't actually mean anything, having anything to do with Kubernetes. But there was no way for us to tell that without a lot of research, and we were not going to have enough time for that research without delaying the release. +And so one of the things that happened, and the reason we had a one-day delay in the release is, you know, we're a week out from release, and just by random luck of the draw, a bunch of these tests all at once got a run of failures. And it turned out that run of failures didn't actually mean anything, having anything to do with Kubernetes. But there was no way for us to tell that without a lot of research, and we were not going to have enough time for that research without delaying the release. So one of the things we're looking to address in the 1.12 cycle is to actually move some of those flaky tests out. Either fix them or move them out of the release blocking category. @@ -258,7 +258,7 @@ And then the second thing, like I said, is that we didn't have sort of major, un You know, number one was having the scalability tests start failing for unrelated reasons for a long period, which then masked the fact that they were actually failing for real reasons when we actually got them working again. And as a result, ending up debugging a major and super complicated scalability issue within days of what was supposed to be the original release date. So that was monkey wrench number one for the 1.10 cycle. -Monkey wrench number two for the 1.10 cycle was we got a security hole that needed to be patched. And so again, a week out from what was supposed to be the original release date, we were releasing a security update, and that security update required patching the release branch. And it turns out that that patch against the release branch broke a bunch of incoming features. And we didn't get anything of that magnitude in the 1.11 release, and I'm thankful for that. +Monkey wrench number two for the 1.10 cycle was we got a security hole that needed to be patched. And so again, a week out from what was supposed to be the original release date, we were releasing a security update, and that security update required patching the release branch. And it turns out that patch against the release branch broke a bunch of incoming features. And we didn't get anything of that magnitude in the 1.11 release, and I'm thankful for that. TIM PEPPER: Also, I would maybe argue in a way that a portion of that wasn't just luck. The extent to which this community has a good team, not just the release team but beyond, some of this goes to active work that folks all across the project, but especially in the contributor experience SIG are doing to cultivate a positive and inclusive culture here. And you really see that. When problems crop up, you're seeing people jump on and really try to constructively tackle them. And it's really fun to be a part of that. diff --git a/content/en/blog/_posts/2018-07-27-kubevirt-crds-for-virtualization.md b/content/en/blog/_posts/2018-07-27-kubevirt-crds-for-virtualization.md index 96eb8f5af5..b6ea48288c 100644 --- a/content/en/blog/_posts/2018-07-27-kubevirt-crds-for-virtualization.md +++ b/content/en/blog/_posts/2018-07-27-kubevirt-crds-for-virtualization.md @@ -99,7 +99,7 @@ A [CRD finalizer](https://kubernetes.io/docs/tasks/access-kubernetes-API/extend- The Kubernetes core APIs have the ability to support multiple versions for a single object type and perform conversions between those versions. This gives the Kubernetes core APIs a path for advancing the `v1alpha1` version of an object to a `v1beta1` version and so forth. -Prior to Kubernetes 1.11, CRDs did not not have support for multiple versions. This meant when we wanted to progress a CRD from `kubevirt.io/v1alpha1` to `kubevirt.io/v1beta1`, the only path available to was to backup our CRD objects, delete the registered CRD from Kubernetes, register a new CRD with the updated version, convert the backed up CRD objects to the new version, and finally post the migrated CRD objects back to the cluster. +Prior to Kubernetes 1.11, CRDs did not have support for multiple versions. This meant when we wanted to progress a CRD from `kubevirt.io/v1alpha1` to `kubevirt.io/v1beta1`, the only path available to was to backup our CRD objects, delete the registered CRD from Kubernetes, register a new CRD with the updated version, convert the backed up CRD objects to the new version, and finally post the migrated CRD objects back to the cluster. That strategy was not exactly a viable option for us. diff --git a/content/en/blog/_posts/2018-09-18-2018-linkerd-2.0.md b/content/en/blog/_posts/2018-09-18-2018-linkerd-2.0.md index b3b9e09b59..d985cec573 100644 --- a/content/en/blog/_posts/2018-09-18-2018-linkerd-2.0.md +++ b/content/en/blog/_posts/2018-09-18-2018-linkerd-2.0.md @@ -119,7 +119,7 @@ Let’s scroll a little further down the page, we’ll see a live list of all tr
-There are two calls that are not at 100%: the first is vote-bot’s call the “/api/vote” endpoint. The second is the “VotePoop” call from the web service to the voting service. Very interesting! Since /api/vote is an incoming call, and “/VotePoop” is an outgoing call, this is a good clue that that the failure of the vote service’s VotePoop endpoint is what’s causing the problem! +There are two calls that are not at 100%: the first is vote-bot’s call the “/api/vote” endpoint. The second is the “VotePoop” call from the web service to the voting service. Very interesting! Since /api/vote is an incoming call, and “/VotePoop” is an outgoing call, this is a good clue that the failure of the vote service’s VotePoop endpoint is what’s causing the problem! Finally, if we click on the “tap” icon for that row in the far right column, we’ll be taken to live list of requests that match this endpoint. This allows us to confirm that the requests are failing (they all have [gRPC status code 2](https://godoc.org/google.golang.org/grpc/codes#Code), indicating an error). diff --git a/content/en/blog/_posts/2018-09-27-kubernetes-1.12-release-announcement.md b/content/en/blog/_posts/2018-09-27-kubernetes-1.12-release-announcement.md new file mode 100644 index 0000000000..d1e9508bf9 --- /dev/null +++ b/content/en/blog/_posts/2018-09-27-kubernetes-1.12-release-announcement.md @@ -0,0 +1,115 @@ +--- +layout: blog +title: 'Kubernetes 1.12: Kubelet TLS Bootstrap and Azure Virtual Machine Scale Sets (VMSS) Move to General Availability' +date: 2018-09-27 +--- + +**Author**: The 1.12 [Release Team](https://github.com/kubernetes/sig-release/blob/master/releases/release-1.12/release_team.md) + +We’re pleased to announce the delivery of Kubernetes 1.12, our third release of 2018! + +Today’s release continues to focus on internal improvements and graduating features to stable in Kubernetes. This newest version graduates key features such as security and Azure. Notable additions in this release include two highly-anticipated features graduating to general availability: Kubelet TLS Bootstrap and Support for Azure Virtual Machine Scale Sets (VMSS). + +These new features mean increased security, availability, resiliency, and ease of use to get production applications to market faster. The release also signifies the increasing maturation and sophistication of Kubernetes on the developer side. + +Let’s dive into the key features of this release: + +## Introducing General Availability of Kubelet TLS Bootstrap + +We’re excited to announce General Availability (GA) of [Kubelet TLS Bootstrap](https://github.com/kubernetes/features/issues/43). In Kubernetes 1.4, we introduced an API for requesting certificates from a cluster-level Certificate Authority (CA). The original intent of this API is to enable provisioning of TLS client certificates for kubelets. This feature allows for a kubelet to bootstrap itself into a TLS-secured cluster. Most importantly, it automates the provision and distribution of signed certificates. + +Before, when a kubelet ran for the first time, it had to be given client credentials in an out-of-band process during cluster startup. The burden was on the operator to provision these credentials. Because this task was so onerous to manually execute and complex to automate, many operators deployed clusters with a single credential and single identity for all kubelets. These setups prevented deployment of node lockdown features like the Node authorizer and the NodeRestriction admission controller. + +To alleviate this, [SIG Auth](https://github.com/kubernetes/community/tree/master/sig-auth) introduced a way for kubelet to generate a private key and a CSR for submission to a cluster-level certificate signing process. The v1 (GA) designation indicates production hardening and readiness, and comes with the guarantee of long-term backwards compatibility. + +Alongside this, [Kubelet server certificate bootstrap and rotation](https://github.com/kubernetes/features/issues/267) is moving to beta. Currently, when a kubelet first starts, it generates a self-signed certificate/key pair that is used for accepting incoming TLS connections. This feature introduces a process for generating a key locally and then issuing a Certificate Signing Request to the cluster API server to get an associated certificate signed by the cluster’s root certificate authority. Also, as certificates approach expiration, the same mechanism will be used to request an updated certificate. + +## Support for Azure Virtual Machine Scale Sets (VMSS) and Cluster-Autoscaler is Now Stable + +Azure Virtual Machine Scale Sets (VMSS) allow you to create and manage a homogenous VM pool that can automatically increase or decrease based on demand or a set schedule. This enables you to easily manage, scale, and load balance multiple VMs to provide high availability and application resiliency, ideal for large-scale applications that can run as Kubernetes workloads. + +With this new stable feature, Kubernetes supports the [scaling of containerized applications with Azure VMSS](https://github.com/kubernetes/features/issues/514), including the ability to [integrate it with cluster-autoscaler](https://github.com/kubernetes/features/issues/513) to automatically adjust the size of the Kubernetes clusters based on the same conditions. + +## Additional Notable Feature Updates + +[`RuntimeClass`](https://github.com/kubernetes/features/issues/585) is a new cluster-scoped resource that surfaces container runtime properties to the control plane being released as an alpha feature. + +[Snapshot / restore functionality for Kubernetes and CSI](https://github.com/kubernetes/features/issues/177) is being introduced as an alpha feature. This provides standardized APIs design (CRDs) and adds PV snapshot/restore support for CSI volume drivers. + +[Topology aware dynamic provisioning](https://github.com/kubernetes/features/issues/561) is now in beta, meaning storage resources can now understand where they live. This also includes beta support to [AWS EBS](https://github.com/kubernetes/features/issues/567) and [GCE PD](https://github.com/kubernetes/features/issues/558). + +[Configurable pod process namespace sharing](https://github.com/kubernetes/features/issues/495) is moving to beta, meaning users can configure containers within a pod to share a common PID namespace by setting an option in the PodSpec. + +[Taint node by condition](https://github.com/kubernetes/features/issues/382) is now in beta, meaning users have the ability to represent node conditions that block scheduling by using taints. + +[Arbitrary / Custom Metrics](https://github.com/kubernetes/features/issues/117) in the Horizontal Pod Autoscaler is moving to a second beta to test some additional feature enhancements. This reworked Horizontal Pod Autoscaler functionality includes support for custom metrics and status conditions. + +Improvements that will allow the [Horizontal Pod Autoscaler to reach proper size faster](https://github.com/kubernetes/features/issues/591) are moving to beta. + +[Vertical Scaling of Pods](https://github.com/kubernetes/features/issues/21) is now in beta, which makes it possible to vary the resource limits on a pod over its lifetime. In particular, this is valuable for pets (i.e., pods that are very costly to destroy and re-create). + +[Encryption at rest via KMS](https://github.com/kubernetes/features/issues/460) is now in beta. This adds multiple encryption providers, including Google Cloud KMS, Azure Key Vault, AWS KMS, and Hashicorp Vault, that will encrypt data as it is stored to etcd. + +## Availability + +Kubernetes 1.12 is available for [download on GitHub](https://github.com/kubernetes/kubernetes/releases/tag/v1.12.0). To get started with Kubernetes, check out these [interactive tutorials](https://kubernetes.io/docs/tutorials/). You can also install 1.12 using [Kubeadm](https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/). + +## 5 Day Features Blog Series + +If you’re interested in exploring these features more in depth, check back next week for our 5 Days of Kubernetes series where we’ll highlight detailed walkthroughs of the following features: + +* Day 1 - Kubelet TLS Bootstrap +* Day 2 - Support for Azure Virtual Machine Scale Sets (VMSS) and Cluster-Autoscaler +* Day 3 - Snapshots Functionality +* Day 4 - RuntimeClass +* Day 5 - Topology Resources + +## 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.12/release_team.md) led by Tim Pepper, Orchestration & Containers Lead, at VMware Open Source Technology Center. The 36 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 22,000 individual contributors to date and an active community of more than 45,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, 259 different companies and over 1,400 individuals contribute to Kubernetes each month. [Check out DevStats](https://k8s.devstats.cncf.io/d/11/companies-contributing-in-repository-groups?orgId=1&var-period=m&var-repogroup_name=All) 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: + +* **Ygrene**, a PACE (Property Assessed Clean Energy) financing company, is using cloud native to [bring security and scalability to the finance industry](https://kubernetes.io/case-studies/ygrene/), cutting deployment times down to five minutes with Kubernetes. +* **Sling TV**, a live TV streaming service, uses Kubernetes to [enable their hybrid cloud strategy](https://kubernetes.io/case-studies/slingtv/) and deliver a high-quality service for their customers. +* **ING**, a Dutch multinational banking and financial services corporation, moved to Kubernetes with the intent to eventually be able to go from [idea to production within 48 hours](https://kubernetes.io/case-studies/ing/). +* **Pinterest**, a web and mobile application company that is running on 1,000 microservices and hundreds of thousands of data jobs, moved to Kubernetes to [build on-demand scaling and simply the deployment process](https://kubernetes.io/case-studies/pinterest/). +* **Pearson**, a global education company serving 75 million learners, is using Kubernetes to [transform the way that educational content is delivered online](https://kubernetes.io/case-studies/pearson/) and has saved 15-20% in developer productivity. + +Is Kubernetes helping your team? [Share your story](https://docs.google.com/a/google.com/forms/d/e/1FAIpQLScuI7Ye3VQHQTwBASrgkjQDSS5TP0g3AXfFhwSM9YpHgxRKFA/viewform) with the community. + +## Ecosystem Updates + +* CNCF recently released the findings of their [bi-annual CNCF survey](https://www.cncf.io/blog/2018/08/29/cncf-survey-use-of-cloud-native-technologies-in-production-has-grown-over-200-percent/), finding that the use of cloud native technologies in production has grown over 200% within the last six months. +* CNCF 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/). +* CNCF 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://events.linuxfoundation.cn/events/kubecon-cloudnativecon-china-2018/) from November 13-15, 2018 and [Seattle](https://events.linuxfoundation.org/events/kubecon-cloudnativecon-north-america-2018/) from December 10-13, 2018. This conference will feature technical sessions, case studies, developer deep dives, salons and more! [Register today](https://www.cncf.io/community/kubecon-cloudnativecon-events/)! + +## Webinar + +Join members of the Kubernetes 1.12 release team on November 6th at 10am PDT to learn about the major features in this release. Register [here](https://zoom.us/webinar/register/WN_DYMejau3TMaTbk91oC3YkA). + +## 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-10-01-health-checking-grpc.md b/content/en/blog/_posts/2018-10-01-health-checking-grpc.md new file mode 100644 index 0000000000..b1f3cd6ed0 --- /dev/null +++ b/content/en/blog/_posts/2018-10-01-health-checking-grpc.md @@ -0,0 +1,97 @@ +--- +layout: blog +title: 'Health checking gRPC servers on Kubernetes' +date: 2018-10-01 +--- + +**Author**: [Ahmet Alp Balkan](https://twitter.com/ahmetb) (Google) + +[gRPC](https://grpc.io) is on its way to becoming the lingua franca for +communication between cloud-native microservices. If you are deploying gRPC +applications to Kubernetes today, you may be wondering about the best way to +configure health checks. In this article, we will talk about +[grpc-health-probe](https://github.com/grpc-ecosystem/grpc-health-probe/), a +Kubernetes-native way to health check gRPC apps. + +If you're unfamiliar, Kubernetes [health +checks](/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/) +(liveness and readiness probes) is what's keeping your applications available +while you're sleeping. They detect unresponsive pods, mark them unhealthy, and +cause these pods to be restarted or rescheduled. + +Kubernetes [does not +support](https://github.com/kubernetes/kubernetes/issues/21493) gRPC health +checks natively. This leaves the gRPC developers with the following three +approaches when they deploy to Kubernetes: + +[![options for health checking grpc on kubernetes today](/images/blog/2019-09-30-health-checking-grpc/options.png)](/images/blog/2019-09-30-health-checking-grpc/options.png) + + +1. **httpGet probe:** Cannot be natively used with gRPC. You need to refactor + your app to serve both gRPC and HTTP/1.1 protocols (on different port + numbers). +2. **tcpSocket probe:** Opening a socket to gRPC server is not meaningful, + since it cannot read the response body. +3. **exec probe:** This invokes a program in a container's ecosystem + periodically. In the case of gRPC, this means you implement a health RPC + yourself, then write and ship a client tool with your container. + +Can we do better? Absolutely. + +## Introducing “grpc-health-probe” + +To standardize the "exec probe" approach mentioned above, we need: + +- a **standard** health check "protocol" that can be implemented in any gRPC + server easily. +- a **standard** health check "tool" that can query the health protocol easily. + +Thankfully, gRPC has a [standard health checking +protocol](https://github.com/grpc/grpc/blob/v1.15.0/doc/health-checking.md). It +can be used easily from any language. Generated code and the utilities for +setting the health status are shipped in nearly all language implementations of +gRPC. + +If you +[implement](https://github.com/grpc/grpc/blob/v1.15.0/src/proto/grpc/health/v1/health.proto) +this health check protocol in your gRPC apps, you can then use a standard/common +tool to invoke this `Check()` method to determine server status. + +The next thing you need is the "standard tool", and it's the +[**grpc-health-probe**](https://github.com/grpc-ecosystem/grpc-health-probe/). + + + + + +With this tool, you can use the same health check configuration in all your gRPC +applications. This approach requires you to: + +1. Find the gRPC "health" module in your favorite language and start using it + (example [Go library](https://godoc.org/github.com/grpc/grpc-go/health)). +2. Ship the + [grpc_health_probe](https://github.com/grpc-ecosystem/grpc-health-probe/) + binary in your container. +3. [Configure](https://github.com/grpc-ecosystem/grpc-health-probe/tree/1329d682b4232c102600b5e7886df8ffdcaf9e26#example-grpc-health-checking-on-kubernetes) + Kubernetes "exec" probe to invoke the "grpc_health_probe" tool in the + container. + +In this case, executing "grpc_health_probe" will call your gRPC server over +`localhost`, since they are in the same pod. + +## What's next + +**grpc-health-probe** project is still in its early days and it needs your +feedback. It supports a variety of features like communicating with TLS servers +and configurable connection/RPC timeouts. + +If you are running a gRPC server on Kubernetes today, try using the gRPC Health +Protocol and try the grpc-health-probe in your deployments, and [give +feedback](https://github.com/grpc-ecosystem/grpc-health-probe/). + +## Further reading + +- Protocol: [GRPC Health Checking Protocol](https://github.com/grpc/grpc/blob/v1.15.0/doc/health-checking.md) ([health.proto](https://github.com/grpc/grpc/blob/v1.15.0/src/proto/grpc/health/v1/health.proto)) +- Documentation: [Kubernetes liveness and readiness probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/) +- Article: [Advanced Kubernetes Health Check Patterns](https://ahmet.im/blog/advanced-kubernetes-health-checks/) diff --git a/content/en/blog/_posts/2018-10-02-network-bootable-farm-with-ltsp.md b/content/en/blog/_posts/2018-10-02-network-bootable-farm-with-ltsp.md new file mode 100644 index 0000000000..0a45f18b02 --- /dev/null +++ b/content/en/blog/_posts/2018-10-02-network-bootable-farm-with-ltsp.md @@ -0,0 +1,496 @@ +--- +layout: blog +title: 'Building a Network Bootable Server Farm for Kubernetes with LTSP' +date: 2018-10-02 +--- + +**Author**: Andrei Kvapil (WEDOS) + +![k8s+ltsp](/images/blog/2018-10-01-network-bootable-farm-with-ltsp/k8s+ltsp.svg) + + +In this post, I'm going to introduce you to a cool technology for Kubernetes, LTSP. It is useful for large baremetal Kubernetes deployments. + +You don't need to think about installing an OS and binaries on each node anymore. Why? You can do that automatically through Dockerfile! + +You can buy and put 100 new servers into a production environment and get them working immediately - it's really amazing! + +Intrigued? Let me walk you through how it works. + +# Summary + +First, we need to understand how exactly it works. + +In short, for all nodes we have prepared the image with the OS, Docker, Kubelet and everything else that you need there. This image with the kernel is building automatically by CI using Dockerfile. End nodes are booting the kernel and OS from this image via the network. + +Nodes are using overlays as the root filesystem and after reboot any changes will be lost (like in Docker containers). You have a config-file where you can describe mounts and some initial commands which should be executed during node boot (Example: set root user ssh-key and kubeadm join commands) + +## Image Preparation Process + +We will use LTSP project because it's gives us everything we need to organize the network booting environment. Basically, LTSP is a pack of shell-scripts which makes our life much easier. + +LTSP provides a initramfs module, a few helper-scripts, and the configuration system which prepare the system during the early state of boot, before the main init process call. + +**This is what the image preparation procedure looks like:** + +- You're deploying the basesystem in the chroot environment. +- Make any needed changes there, install software. +- Run the `ltsp-build-image` command + +After that, you will get the squashed image from the chroot with all the software inside. Each node will download this image during the boot and use it as the rootfs. For the update node, you can just reboot it. The new squashed image will be downloaded and mounted into the rootfs. + +## Server Components + +**The server part of LTSP includes two components in our case:** + +- **TFTP-server** - TFTP is the initial protocol, it is used the download the kernel, initramfs and main config - lts.conf. +- **NBD-server** - NBD protocol is used to distribute the squashed rootfs image to the clients. It is the fastest way, but if you want, it can be replaced by the NFS or AoE protocol. + +You should also have: + +- **DHCP-server** - it will distribute the IP-settings and a few specific options to the clients to make it possible for them to boot from our LTSP-server. + +## Node Booting Process + +**This is how the node is booting up** + +- The first time, the node will ask DHCP for IP-settings and `next-server`, `filename` options. +- Next, the node will apply settings and download bootloader (pxelinux or grub) +- Bootloader will download and read config with the kernel and initramfs image. +- Then bootloader will download the kernel and initramfs and execute it with specific cmdline options. +- During the boot, initramfs modules will handle options from cmdline and do some actions like connect NBD-device, prepare overlay rootfs, etc. +- Afterwards it will call the ltsp-init system instead of the normal init. +- ltsp-init scripts will prepare the system on the earlier stage, before the main init will be called. Basically it applies the setting from lts.conf (main config): write fstab and rc.local entries etc. +- Call the main init (systemd) which is booting the configured system as usual, mounts shares from fstab, start targets and services, executes commands from rc.local file. +- In the end you have a fully configured and booted system ready for further operations. + +# Preparing the Server + +As I said before, I'm preparing the LTSP-server with the squashed image automatically using Dockerfile. This method is quite good because you have all steps described in your git repository. +You have versioning, branches, CI and everything that you used to use for preparing your usual Docker projects. + +Otherwise, you can deploy the LTSP server manually by executing all steps by hand. This is a good practice for learning and understanding the basic principles. + +Just repeat all the steps listed here by hand, just to try to install LTSP without Dockerfile. + +## Used Patches List + +LTSP still has some issues which authors don’t want to apply, yet. However LTSP is easy customizable so I prepared a few patches for myself and will share them here. + +I’ll create a fork if the community will warmly accept my solution. + + * [feature-grub.diff](https://github.com/kvaps/ltsp/compare/feature-grub.diff) + LTSP does not support EFI by default, so I've prepared a patch which adds GRUB2 with EFI support. + * [feature_preinit.diff](https://github.com/kvaps/ltsp/compare/feature_preinit.diff) + This patch adds a PREINIT option to lts.conf, which allows you to run custom commands before the main init call. It may be useful to modify the systemd units and configure the network. It's remarkable that all environment variables from the boot environment are saved and you can use them in your scripts. + * [feature_initramfs_params_from_lts_conf.diff](https://github.com/kvaps/ltsp/compare/feature_initramfs_params_from_lts_conf.diff) + Solves a problem with NBD_TO_RAM option, after this patch you can specify it on lts.conf inside chroot. (not in tftp directory) + * [nbd-server-wrapper.sh](https://gist.githubusercontent.com/kvaps/1a6a7d8b73bf7444f0f99b22379c9e4e/raw/eb0d60c638ef72b7e28438b7f4d2beda89c41f75/nbd-server-wrapper.sh) + This is not a patch but a special wrapper script which allows you to run NBD-server in the foreground. It is useful if you want to run it inside a Docker container. + +## Dockerfile Stages + +We will use [stage building](https://docs.docker.com/develop/develop-images/multistage-build/) in our Dockerfile to leave only the needed parts in our Docker image. The unused parts will be removed from the final image. + +``` +ltsp-base +(install basic LTSP server software) + | + |---basesystem + | (prepare chroot with main software and kernel) + | | + | |---builder + | | (build additional software from sources, if needed) + | | + | '---ltsp-image + | (install additional software, docker, kubelet and build squashed image) + | + '---final-stage + (copy squashed image, kernel and initramfs into first stage) +``` + +### Stage 1: ltsp-base + +Let's start writing our Dockerfile. This is the first part: + +```Dockerfile +FROM ubuntu:16.04 as ltsp-base + +ADD nbd-server-wrapper.sh /bin/ +ADD /patches/feature-grub.diff /patches/feature-grub.diff +RUN apt-get -y update \ + && apt-get -y install \ + ltsp-server \ + tftpd-hpa \ + nbd-server \ + grub-common \ + grub-pc-bin \ + grub-efi-amd64-bin \ + curl \ + patch \ + && sed -i 's|in_target mount|in_target_nofail mount|' \ + /usr/share/debootstrap/functions \ + # Add EFI support and Grub bootloader (#1745251) + && patch -p2 -d /usr/sbin < /patches/feature-grub.diff \ + && rm -rf /var/lib/apt/lists \ + && apt-get clean +``` + +At this stage our Docker image has already been installed: + +* NBD-server +* TFTP-server +* LTSP-scripts with grub bootloader support (for EFI) + +### Stage 2: basesystem + +In this stage we will prepare a chroot environment with basesystem, and install basic software with the kernel. + +We will use the classic **debootstrap** instead of **ltsp-build-client** to prepare the base image, because **ltsp-build-client** will install GUI and few other things which we don't need for the server deployment. + +```Dockerfile +FROM ltsp-base as basesystem + +ARG DEBIAN_FRONTEND=noninteractive + +# Prepare base system +RUN debootstrap --arch amd64 xenial /opt/ltsp/amd64 + +# Install updates +RUN echo "\ + deb http://archive.ubuntu.com/ubuntu xenial main restricted universe multiverse\n\ + deb http://archive.ubuntu.com/ubuntu xenial-updates main restricted universe multiverse\n\ + deb http://archive.ubuntu.com/ubuntu xenial-security main restricted universe multiverse" \ + > /opt/ltsp/amd64/etc/apt/sources.list \ + && ltsp-chroot apt-get -y update \ + && ltsp-chroot apt-get -y upgrade + +# Installing LTSP-packages +RUN ltsp-chroot apt-get -y install ltsp-client-core + +# Apply initramfs patches +# 1: Read params from /etc/lts.conf during the boot (#1680490) +# 2: Add support for PREINIT variables in lts.conf +ADD /patches /patches +RUN patch -p4 -d /opt/ltsp/amd64/usr/share < /patches/feature_initramfs_params_from_lts_conf.diff \ + && patch -p3 -d /opt/ltsp/amd64/usr/share < /patches/feature_preinit.diff + +# Write new local client config for boot NBD image to ram: +RUN echo "[Default]\nLTSP_NBD_TO_RAM = true" \ + > /opt/ltsp/amd64/etc/lts.conf + +# Install packages +RUN echo 'APT::Install-Recommends "0";\nAPT::Install-Suggests "0";' \ + >> /opt/ltsp/amd64/etc/apt/apt.conf.d/01norecommend \ + && ltsp-chroot apt-get -y install \ + software-properties-common \ + apt-transport-https \ + ca-certificates \ + ssh \ + bridge-utils \ + pv \ + jq \ + vlan \ + bash-completion \ + screen \ + vim \ + mc \ + lm-sensors \ + htop \ + jnettop \ + rsync \ + curl \ + wget \ + tcpdump \ + arping \ + apparmor-utils \ + nfs-common \ + telnet \ + sysstat \ + ipvsadm \ + ipset \ + make + +# Install kernel +RUN ltsp-chroot apt-get -y install linux-generic-hwe-16.04 +``` + +Note that you may encounter problems with some packages, such as `lvm2`. +They have not fully optimized for installing in an unprivileged chroot. +Their postinstall scripts try to call some privileged commands which can fail with errors and block the package installation. + +Solution: + +* Some of them can be installed before the kernel without any problems (like `lvm2`) +* But for some of them you will need to use [this workaround](https://askubuntu.com/a/482936/327437) to install without the postinstall script. + +### Stage 3: builder + +Now we can build all the necessary software and kernel modules. It's really cool that you can do that automatically in this stage. +You can skip this stage if you have nothing to do here. + +Here is example for install latest MLNX_EN driver: + +```Dockerfile +FROM basesystem as builder + +# Set cpuinfo (for building from sources) +RUN cp /proc/cpuinfo /opt/ltsp/amd64/proc/cpuinfo + +# Compile Mellanox driver +RUN ltsp-chroot sh -cx \ + ' VERSION=4.3-1.0.1.0-ubuntu16.04-x86_64 \ + && curl -L http://www.mellanox.com/downloads/ofed/MLNX_EN-${VERSION%%-ubuntu*}/mlnx-en-${VERSION}.tgz \ + | tar xzf - \ + && export \ + DRIVER_DIR="$(ls -1 | grep "MLNX_OFED_LINUX-\|mlnx-en-")" \ + KERNEL="$(ls -1t /lib/modules/ | head -n1)" \ + && cd "$DRIVER_DIR" \ + && ./*install --kernel "$KERNEL" --without-dkms --add-kernel-support \ + && cd - \ + && rm -rf "$DRIVER_DIR" /tmp/mlnx-en* /tmp/ofed*' + +# Save kernel modules +RUN ltsp-chroot sh -c \ + ' export KERNEL="$(ls -1t /usr/src/ | grep -m1 "^linux-headers" | sed "s/^linux-headers-//g")" \ + && tar cpzf /modules.tar.gz /lib/modules/${KERNEL}/updates' + +``` + +### Stage 4: ltsp-image + +In this stage we will install what we built in the previous step: + +```Dockerfile +FROM basesystem as ltsp-image + +# Retrieve kernel modules +COPY --from=builder /opt/ltsp/amd64/modules.tar.gz /opt/ltsp/amd64/modules.tar.gz + +# Install kernel modules +RUN ltsp-chroot sh -c \ + ' export KERNEL="$(ls -1t /usr/src/ | grep -m1 "^linux-headers" | sed "s/^linux-headers-//g")" \ + && tar xpzf /modules.tar.gz \ + && depmod -a "${KERNEL}" \ + && rm -f /modules.tar.gz' +``` + +Then do some additional changes to finalize our ltsp-image: + +```Dockerfile +# Install docker +RUN ltsp-chroot sh -c \ + ' curl -fsSL https://download.docker.com/linux/ubuntu/gpg | apt-key add - \ + && echo "deb https://download.docker.com/linux/ubuntu xenial stable" \ + > /etc/apt/sources.list.d/docker.list \ + && apt-get -y update \ + && apt-get -y install \ + docker-ce=$(apt-cache madison docker-ce | grep 18.06 | head -1 | awk "{print $ 3}")' + +# Configure docker options +RUN DOCKER_OPTS="$(echo \ + --storage-driver=overlay2 \ + --iptables=false \ + --ip-masq=false \ + --log-driver=json-file \ + --log-opt=max-size=10m \ + --log-opt=max-file=5 \ + )" \ + && sed "/^ExecStart=/ s|$| $DOCKER_OPTS|g" \ + /opt/ltsp/amd64/lib/systemd/system/docker.service \ + > /opt/ltsp/amd64/etc/systemd/system/docker.service + +# Install kubeadm, kubelet and kubectl +RUN ltsp-chroot sh -c \ + ' curl -s https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key add - \ + && echo "deb http://apt.kubernetes.io/ kubernetes-xenial main" \ + > /etc/apt/sources.list.d/kubernetes.list \ + && apt-get -y update \ + && apt-get -y install kubelet kubeadm kubectl cri-tools' + +# Disable automatic updates +RUN rm -f /opt/ltsp/amd64/etc/apt/apt.conf.d/20auto-upgrades + +# Disable apparmor profiles +RUN ltsp-chroot find /etc/apparmor.d \ + -maxdepth 1 \ + -type f \ + -name "sbin.*" \ + -o -name "usr.*" \ + -exec ln -sf "{}" /etc/apparmor.d/disable/ \; + +# Write kernel cmdline options +RUN KERNEL_OPTIONS="$(echo \ + init=/sbin/init-ltsp \ + forcepae \ + console=tty1 \ + console=ttyS0,9600n8 \ + nvme_core.default_ps_max_latency_us=0 \ + )" \ + && sed -i "/^CMDLINE_LINUX_DEFAULT=/ s|=.*|=\"${KERNEL_OPTIONS}\"|" \ + "/opt/ltsp/amd64/etc/ltsp/update-kernels.conf" +``` + +Then we will make the squashed image from our chroot: + +```Dockerfile +# Cleanup caches +RUN rm -rf /opt/ltsp/amd64/var/lib/apt/lists \ + && ltsp-chroot apt-get clean + +# Build squashed image +RUN ltsp-update-image +``` + +### Stage 5: Final Stage +In the final stage we will save only our squashed image and kernels with initramfs. + +```Dockerfile +FROM ltsp-base +COPY --from=ltsp-image /opt/ltsp/images /opt/ltsp/images +COPY --from=ltsp-image /etc/nbd-server/conf.d /etc/nbd-server/conf.d +COPY --from=ltsp-image /var/lib/tftpboot /var/lib/tftpboot +``` + +Ok, now we have docker image which includes: + + - TFTP-server + - NBD-server + - configured bootloader + - kernel with initramfs + - squashed rootfs image + +# Usage + +OK, now when our docker-image with LTSP-server, kernel, initramfs and squashed rootfs fully prepared we can run the deployment with it. + +We can do that as usual, but one more thing is networking. +Unfortunately, we can't use the standard Kubernetes service abstraction for our deployment, because during the boot, our nodes are not part of Kubernetes cluster and they requires ExternalIP, but Kubernetes always enables NAT for ExternalIPs, and there is no way to disable this behavior. + +For now I have two ways for avoid this: use `hostNetwork: true` or use [pipework](https://github.com/dreamcat4/docker-images/blob/master/pipework/3.%20Examples.md#kubernetes). The second option will also provide you redundancy because, in case of failure, the IP will be moved with the Pod to another node. Unfortunately, pipework is not native and a less secure method. +If you have some better option for that please let me know. + +Here is example for deployment with hostNetwork: + +```yaml +apiVersion: extensions/v1beta1 +kind: Deployment +metadata: + name: ltsp-server + labels: + app: ltsp-server +spec: + selector: + matchLabels: + name: ltsp-server + replicas: 1 + template: + metadata: + labels: + name: ltsp-server + spec: + hostNetwork: true + containers: + - name: tftpd + image: registry.example.org/example/ltsp:latest + command: [ "/usr/sbin/in.tftpd", "-L", "-u", "tftp", "-a", ":69", "-s", "/var/lib/tftpboot" ] + lifecycle: + postStart: + exec: + command: ["/bin/sh", "-c", "cd /var/lib/tftpboot/ltsp/amd64; ln -sf config/lts.conf ." ] + volumeMounts: + - name: config + mountPath: "/var/lib/tftpboot/ltsp/amd64/config" + + - name: nbd-server + image: registry.example.org/example/ltsp:latest + command: [ "/bin/nbd-server-wrapper.sh" ] + + volumes: + - name: config + configMap: + name: ltsp-config +``` + +As you can see it also requires configmap with **lts.conf** file. +Here is example part from mine: + +``` +apiVersion: v1 +kind: ConfigMap +metadata: + name: ltsp-config +data: + lts.conf: | + [default] + KEEP_SYSTEM_SERVICES = "ssh ureadahead dbus-org.freedesktop.login1 systemd-logind polkitd cgmanager ufw rpcbind nfs-kernel-server" + + PREINIT_00_TIME = "ln -sf /usr/share/zoneinfo/Europe/Prague /etc/localtime" + PREINIT_01_FIX_HOSTNAME = "sed -i '/^127.0.0.2/d' /etc/hosts" + PREINIT_02_DOCKER_OPTIONS = "sed -i 's|^ExecStart=.*|ExecStart=/usr/bin/dockerd -H fd:// --storage-driver overlay2 --iptables=false --ip-masq=false --log-driver=json-file --log-opt=max-size=10m --log-opt=max-file=5|' /etc/systemd/system/docker.service" + + FSTAB_01_SSH = "/dev/data/ssh /etc/ssh ext4 nofail,noatime,nodiratime 0 0" + FSTAB_02_JOURNALD = "/dev/data/journal /var/log/journal ext4 nofail,noatime,nodiratime 0 0" + FSTAB_03_DOCKER = "/dev/data/docker /var/lib/docker ext4 nofail,noatime,nodiratime 0 0" + + # Each command will stop script execution when fail + RCFILE_01_SSH_SERVER = "cp /rofs/etc/ssh/*_config /etc/ssh; ssh-keygen -A" + RCFILE_02_SSH_CLIENT = "mkdir -p /root/.ssh/; echo 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDBSLYRaORL2znr1V4a3rjDn3HDHn2CsvUNK1nv8+CctoICtJOPXl6zQycI9KXNhANfJpc6iQG1ZPZUR74IiNhNIKvOpnNRPyLZ5opm01MVIDIZgi9g0DUks1g5gLV5LKzED8xYKMBmAfXMxh/nsP9KEvxGvTJB3OD+/bBxpliTl5xY3Eu41+VmZqVOz3Yl98+X8cZTgqx2dmsHUk7VKN9OZuCjIZL9MtJCZyOSRbjuo4HFEssotR1mvANyz+BUXkjqv2pEa0I2vGQPk1VDul5TpzGaN3nOfu83URZLJgCrX+8whS1fzMepUYrbEuIWq95esjn0gR6G4J7qlxyguAb9 admin@kubernetes' >> /root/.ssh/authorized_keys" + RCFILE_03_KERNEL_DEBUG = "sysctl -w kernel.unknown_nmi_panic=1 kernel.softlockup_panic=1; modprobe netconsole netconsole=@/vmbr0,@10.9.0.15/" + RCFILE_04_SYSCTL = "sysctl -w fs.file-max=20000000 fs.nr_open=20000000 net.ipv4.neigh.default.gc_thresh1=80000 net.ipv4.neigh.default.gc_thresh2=90000 net.ipv4.neigh.default.gc_thresh3=100000" + RCFILE_05_FORWARD = "echo 1 > /proc/sys/net/ipv4/ip_forward" + RCFILE_06_MODULES = "modprobe br_netfilter" + RCFILE_07_JOIN_K8S = "kubeadm join --token 2a4576.504356e45fa3d365 10.9.0.20:6443 --discovery-token-ca-cert-hash sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" +``` + +* **KEEP_SYSTEM_SERVICES** - during the boot, LTSP automatically removes some services, this variable is needed to prevent this behavior. +* **PREINIT_*** - commands listed here will be executed before systemd runs (this function was added by the [feature_preinit.diff](#used-patches-list) patch) +* **FSTAB_*** - entries written here will be added to the `/etc/fstab` file. +As you can see, I use the `nofail` option, that means that if a partition doesn't exist, it will continue to boot without error. +If you have fully diskless nodes you can remove the FSTAB settings or configure the remote filesystem there. +* **RCFILE_*** - those commands will be written to `rc.local` file, which will be called by systemd during the boot. +Here I load the kernel modules and add some sysctl tunes, then call the `kubeadm join` command, which adds my node to the Kubernetes cluster. + +You can get more details on all the variables used from [lts.conf manpage](http://manpages.ubuntu.com/manpages/xenial/man5/lts.conf.5.html). + +Now you can configure your DHCP. Basically you should set the `next-server` and `filename` options. + +I use ISC-DHCP server, and here is an example `dhcpd.conf`: + +``` +shared-network ltsp-netowrk { + subnet 10.9.0.0 netmask 255.255.0.0 { + authoritative; + default-lease-time -1; + max-lease-time -1; + + option domain-name "example.org"; + option domain-name-servers 10.9.0.1; + option routers 10.9.0.1; + next-server ltsp-1; # write LTSP-server hostname here + + if option architecture = 00:07 { + filename "/ltsp/amd64/grub/x86_64-efi/core.efi"; + } else { + filename "/ltsp/amd64/grub/i386-pc/core.0"; + } + + range 10.9.200.0 10.9.250.254; + } +``` + +You can start from this, but what about me, I have multiple LTSP-servers and I configure leases statically for each node via the Ansible playbook. + +Try to run your first node. If everything was right, you will have a running system there. +The node also will be added to your Kubernetes cluster. + +Now you can try to make your own changes. + +If you need something more, note that LTSP can be easily changed to meet your needs. +Feel free to look into the source code and you can find many answers there. + +**UPD:** Many people asking me: Why not simple use CoreOS and Ignition? + +I can answer. The main feature here is image preparation process not configuration. +In case with LTSP you have classic Ubuntu system, and everything that can be installed on Ubuntu it can also be written here in the Dockerfile. +In case CoreOS you have no so many freedom and you can’t easily add custom kernel modules and packages at the build stage of the boot image. diff --git a/content/en/blog/_posts/2018-10-03-kubedirector.md b/content/en/blog/_posts/2018-10-03-kubedirector.md new file mode 100644 index 0000000000..105440ae04 --- /dev/null +++ b/content/en/blog/_posts/2018-10-03-kubedirector.md @@ -0,0 +1,191 @@ +--- +layout: blog +title: 'KubeDirector: The easy way to run complex stateful applications on Kubernetes' +date: 2018-10-03 +--- + +**Author**: Thomas Phelan (BlueData) + +KubeDirector is an open source project designed to make it easy to run complex stateful scale-out application clusters on Kubernetes. KubeDirector is built using the custom resource definition (CRD) framework and leverages the native Kubernetes API extensions and design philosophy. This enables transparent integration with Kubernetes user/resource management as well as existing clients and tools. + +We recently [introduced the KubeDirector project](https://medium.com/@thomas_phelan/operation-stateful-introducing-bluek8s-and-kubernetes-director-aa204952f619/), as part of a broader open source Kubernetes initiative we call BlueK8s. I’m happy to announce that the pre-alpha +code for [KubeDirector](https://github.com/bluek8s/kubedirector/) is now available. And in this blog post, I’ll show how it works. + +KubeDirector provides the following capabilities: + +* The ability to run non-cloud native stateful applications on Kubernetes without modifying the code. In other words, it’s not necessary to decompose these existing applications to fit a microservices design pattern. +* Native support for preserving application-specific configuration and state. +* An application-agnostic deployment pattern, minimizing the time to onboard new stateful applications to Kubernetes. + +KubeDirector enables data scientists familiar with data-intensive distributed applications such as Hadoop, Spark, Cassandra, TensorFlow, Caffe2, etc. to run these applications on Kubernetes -- with a minimal learning curve and no need to write GO code. The applications controlled by KubeDirector are defined by some basic metadata and an associated package of configuration artifacts. The application metadata is referred to as a KubeDirectorApp resource. + +To understand the components of KubeDirector, clone the repository on [GitHub](https://github.com/bluek8s/kubedirector/) using a command similar to: + +``` +git clone http://@github.com/bluek8s/kubedirector. +``` + +The KubeDirectorApp definition for the Spark 2.2.1 application is located +in the file `kubedirector/deploy/example_catalog/cr-app-spark221e2.json`. + ``` + ~> cat kubedirector/deploy/example_catalog/cr-app-spark221e2.json + { + "apiVersion": "kubedirector.bluedata.io/v1alpha1", + "kind": "KubeDirectorApp", + "metadata": { + "name" : "spark221e2" + }, + "spec" : { + "systemctlMounts": true, + "config": { + "node_services": [ + { + "service_ids": [ + "ssh", + "spark", + "spark_master", + "spark_worker" + ], +… +``` + +The configuration of an application cluster is referred to as a KubeDirectorCluster resource. The +KubeDirectorCluster definition for a sample Spark 2.2.1 cluster is located in the file +`kubedirector/deploy/example_clusters/cr-cluster-spark221.e1.yaml`. +``` +~> cat kubedirector/deploy/example_clusters/cr-cluster-spark221.e1.yaml +apiVersion: "kubedirector.bluedata.io/v1alpha1" +kind: "KubeDirectorCluster" +metadata: + name: "spark221e2" +spec: + app: spark221e2 + roles: + - name: controller + replicas: 1 + resources: + requests: + memory: "4Gi" + cpu: "2" + limits: + memory: "4Gi" + cpu: "2" + - name: worker + replicas: 2 + resources: + requests: + memory: "4Gi" + cpu: "2" + limits: + memory: "4Gi" + cpu: "2" + - name: jupyter +… +``` +## Running Spark on Kubernetes with KubeDirector + +With KubeDirector, it’s easy to run Spark clusters on Kubernetes. + +First, verify that Kubernetes (version 1.9 or later) is running, using the command `kubectl version` +``` +~> kubectl version +Client Version: version.Info{Major:"1", Minor:"11", GitVersion:"v1.11.3", GitCommit:"a4529464e4629c21224b3d52edfe0ea91b072862", GitTreeState:"clean", BuildDate:"2018-09-09T18:02:47Z", GoVersion:"go1.10.3", Compiler:"gc", Platform:"linux/amd64"} +Server Version: version.Info{Major:"1", Minor:"11", GitVersion:"v1.11.3", GitCommit:"a4529464e4629c21224b3d52edfe0ea91b072862", GitTreeState:"clean", BuildDate:"2018-09-09T17:53:03Z", GoVersion:"go1.10.3", Compiler:"gc", Platform:"linux/amd64"} +``` +Deploy the KubeDirector service and the example KubeDirectorApp resource definitions with the commands: +``` +cd kubedirector +make deploy +``` +These will start the KubeDirector pod: +``` +~> kubectl get pods +NAME READY STATUS RESTARTS AGE +kubedirector-58cf59869-qd9hb 1/1 Running 0 1m +``` +List the installed KubeDirector applications with `kubectl get KubeDirectorApp` +``` +~> kubectl get KubeDirectorApp +NAME AGE +cassandra311 30m +spark211up 30m +spark221e2 30m +``` + +Now you can launch a Spark 2.2.1 cluster using the example KubeDirectorCluster file and the +`kubectl create -f deploy/example_clusters/cr-cluster-spark211up.yaml` command. +Verify that the Spark cluster has been started: +``` +~> kubectl get pods +NAME READY STATUS RESTARTS AGE +kubedirector-58cf59869-djdwl 1/1 Running 0 19m +spark221e2-controller-zbg4d-0 1/1 Running 0 23m +spark221e2-jupyter-2km7q-0 1/1 Running 0 23m +spark221e2-worker-4gzbz-0 1/1 Running 0 23m +spark221e2-worker-4gzbz-1 1/1 Running 0 23m +``` +The running services now include the Spark services: +``` +~> kubectl get service +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +kubedirector ClusterIP 10.98.234.194 60000/TCP 1d +kubernetes ClusterIP 10.96.0.1 443/TCP 1d +svc-spark221e2-5tg48 ClusterIP None 8888/TCP 21s +svc-spark221e2-controller-tq8d6-0 NodePort 10.104.181.123 22:30534/TCP,8080:31533/TCP,7077:32506/TCP,8081:32099/TCP 20s +svc-spark221e2-jupyter-6989v-0 NodePort 10.105.227.249 22:30632/TCP,8888:30355/TCP 20s +svc-spark221e2-worker-d9892-0 NodePort 10.107.131.165 22:30358/TCP,8081:32144/TCP 20s +svc-spark221e2-worker-d9892-1 NodePort 10.110.88.221 22:30294/TCP,8081:31436/TCP 20s +``` + +Pointing the browser at port 31533 connects to the Spark Master UI: + +![kubedirector](/images/blog/2018-10-03-kubedirector/kubedirector.png) + +That’s all there is to it! +In fact, in the example above we also deployed a Jupyter notebook along with the Spark cluster. + +To start another application (e.g. Cassandra), just specify another KubeDirectorApp file: +``` +kubectl create -f deploy/example_clusters/cr-cluster-cassandra311.yaml +``` +See the running Cassandra cluster: +``` +~> kubectl get pods +NAME READY STATUS RESTARTS AGE +cassandra311-seed-v24r6-0 1/1 Running 0 1m +cassandra311-seed-v24r6-1 1/1 Running 0 1m +cassandra311-worker-rqrhl-0 1/1 Running 0 1m +cassandra311-worker-rqrhl-1 1/1 Running 0 1m +kubedirector-58cf59869-djdwl 1/1 Running 0 1d +spark221e2-controller-tq8d6-0 1/1 Running 0 22m +spark221e2-jupyter-6989v-0 1/1 Running 0 22m +spark221e2-worker-d9892-0 1/1 Running 0 22m +spark221e2-worker-d9892-1 1/1 Running 0 22m +``` +Now you have a Spark cluster (with a Jupyter notebook) and a Cassandra cluster running on Kubernetes. +Use `kubectl get service` to see the set of services. +``` +~> kubectl get service +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +kubedirector ClusterIP 10.98.234.194 60000/TCP 1d +kubernetes ClusterIP 10.96.0.1 443/TCP 1d +svc-cassandra311-seed-v24r6-0 NodePort 10.96.94.204 22:31131/TCP,9042:30739/TCP 3m +svc-cassandra311-seed-v24r6-1 NodePort 10.106.144.52 22:30373/TCP,9042:32662/TCP 3m +svc-cassandra311-vhh29 ClusterIP None 8888/TCP 3m +svc-cassandra311-worker-rqrhl-0 NodePort 10.109.61.194 22:31832/TCP,9042:31962/TCP 3m +svc-cassandra311-worker-rqrhl-1 NodePort 10.97.147.131 22:31454/TCP,9042:31170/TCP 3m +svc-spark221e2-5tg48 ClusterIP None 8888/TCP 24m +svc-spark221e2-controller-tq8d6-0 NodePort 10.104.181.123 22:30534/TCP,8080:31533/TCP,7077:32506/TCP,8081:32099/TCP 24m +svc-spark221e2-jupyter-6989v-0 NodePort 10.105.227.249 22:30632/TCP,8888:30355/TCP 24m +svc-spark221e2-worker-d9892-0 NodePort 10.107.131.165 22:30358/TCP,8081:32144/TCP 24m +svc-spark221e2-worker-d9892-1 NodePort 10.110.88.221 22:30294/TCP,8081:31436/TCP 24m +``` + +## Get Involved + +KubeDirector is a fully open source, Apache v2 licensed, project – the first of multiple open source projects within a broader initiative we call BlueK8s. +The pre-alpha code for KubeDirector has just been released and we would love for you to join the growing community of developers, contributors, and adopters. +Follow [@BlueK8s](https://twitter.com/BlueK8s/) on Twitter and get involved through these channels: + +* KubeDirector [chat room on Slack](https://join.slack.com/t/bluek8s/shared_invite/enQtNDUwMzkwODY5OTM4LTRhYmRmZmE4YzY3OGUzMjA1NDg0MDVhNDQ2MGNkYjRhM2RlMDNjMTI1NDQyMjAzZGVlMDFkNThkNGFjZGZjMGY/) +* KubeDirector [GitHub repo](https://github.com/bluek8s/kubedirector/) diff --git a/content/en/blog/_posts/2018-10-04-non-code-contributors-guide.md b/content/en/blog/_posts/2018-10-04-non-code-contributors-guide.md new file mode 100644 index 0000000000..092975df3e --- /dev/null +++ b/content/en/blog/_posts/2018-10-04-non-code-contributors-guide.md @@ -0,0 +1,43 @@ +--- +layout: blog +title: 'Introducing the Non-Code Contributor’s Guide' +date: 2018-10-04 +--- + +**Author**: [Noah Abrahams](https://twitter.com/noah_abrahams) (InfoSiftr), [Jonas Rosland](https://twitter.com/jonasrosland) (VMware), [Ihor Dvoretskyi](https://twitter.com/idvoretskyi) (CNCF) + +It was May 2018 in Copenhagen, and the Kubernetes community was enjoying the contributor summit at KubeCon/CloudNativeCon, complete with the first run of the New Contributor Workshop. As a time of tremendous collaboration between contributors, the topics covered ranged from signing the CLA to deep technical conversations. Along with the vast exchange of information and ideas, however, came continued scrutiny of the topics at hand to ensure that the community was being as inclusive and accommodating as possible. Over that spring week, some of the pieces under the microscope included the many themes being covered, and how they were being presented, but also the overarching characteristics of the people contributing and the skill sets involved. From the discussions and analysis that followed grew the idea that the community was not benefiting as much as it could from the many people who wanted to contribute, but whose strengths were in areas other than writing code. + +**This all led to an effort called the [Non-Code Contributor’s Guide](https://github.com/kubernetes/community/blob/master/contributors/guide/non-code-contributions.md).** + +Now, it’s important to note that Kubernetes is rare, if not unique, in the open source world, in that it was defined very early on as both a project and a community. While the project itself is focused on the codebase, it is the community of people driving it forward that makes the project successful. The community works together with an explicit set of [community values](https://github.com/kubernetes/steering/blob/master/values.md), guiding the day-to-day behavior of contributors whether on GitHub, Slack, Discourse, or sitting together over tea or coffee. + +By having a community that values people first, and explicitly values a diversity of people, the Kubernetes project is building a product to serve people with diverse needs. The different backgrounds of the contributors bring different approaches to the problem solving, with different methods of collaboration, and all those different viewpoints ultimately create a better project. + +The Non-Code Contributor’s Guide aims to make it easy for anyone to contribute to the Kubernetes project in a way that makes sense for them. This can be in many forms, technical and non-technical, based on the person's knowledge of the project and their available time. Most individuals are not developers, and most of the world’s developers are not paid to fully work on open source projects. Based on this we have started an ever-growing list of possible ways to contribute to the Kubernetes project in a Non-Code way! + +## Get Involved + +Some of the ways that you can contribute to the Kubernetes community without writing a single line of code include: + +- Community education, answering questions on [Discuss](https://discuss.kubernetes.io/), [StackOverflow](https://stackoverflow.com/questions/tagged/kubernetes), and [Slack](http://slack.k8s.io/) +- Outward facing community work such as [hosting meetups](https://www.meetup.com/pro/cncf/) and events +- Writing [project documentation](https://github.com/kubernetes/community/tree/master/sig-docs) +- Writing operational manuals, helping users understand how to run Kubernetes +- Helping deliver Kubernetes, as a part of the [release team](https://github.com/kubernetes/sig-release/blob/master/release-team/README.md) +- Project, program, and [product management](https://github.com/kubernetes/community/blob/master/sig-pm/README.md) +- And many more! + +The guide to get started with Kubernetes project contribution is [documented on Github](https://github.com/kubernetes/community/tree/master/contributors/guide), and as the Non-Code Contributors Guide is a part of that Kubernetes Contributors Guide, it can be found [here](https://github.com/kubernetes/community/blob/master/contributors/guide/non-code-contributions.md). As stated earlier, this list is not exhaustive and will continue to be a work in progress. + +To date, the typical Non-Code contributions fall into the following categories: + +- Roles that are based on skill sets other than “software developer” +- Non-Code contributions in primarily code-based roles +- “Post-Code” roles, that are not code-based, but require knowledge of either the code base or management of the code base + +If you, dear reader, have any additional ideas for a Non-Code way to contribute, whether or not it fits in an existing category, the team will always appreciate if you could help us expand the list. + +If a contribution of the Non-Code nature appeals to you, please read the Non-Code Contributions document, and then check the [Contributor Role Board](https://discuss.kubernetes.io/c/contributors/role-board) to see if there are any open positions where your expertise could be best used! If there are no listed open positions that match your skill set, drop on by the [#sig-contribex](https://kubernetes.slack.com/messages/sig-contribex) channel on Slack, and we’ll point you in the right direction. + +We hope to see you contributing to the Kubernetes community soon! diff --git a/content/en/blog/_posts/2018-10-08-support-for-azure-vmss.md b/content/en/blog/_posts/2018-10-08-support-for-azure-vmss.md new file mode 100644 index 0000000000..79875cc21d --- /dev/null +++ b/content/en/blog/_posts/2018-10-08-support-for-azure-vmss.md @@ -0,0 +1,338 @@ +--- +layout: blog +title: 'Support for Azure VMSS, Cluster-Autoscaler and User Assigned Identity' +date: 2018-10-08 +--- + +**Author**: [Krishnakumar R (KK)](https://twitter.com/kkwriting) (Microsoft), [Pengfei Ni](https://twitter.com/feisky) (Microsoft) + +## Introduction + +With Kubernetes v1.12, Azure virtual machine scale sets (VMSS) and cluster-autoscaler have reached their General Availability (GA) and User Assigned Identity is available as a preview feature. + +_Azure VMSS allow you to create and manage identical, load balanced VMs that automatically increase or decrease based on demand or a set schedule. This enables you to easily manage and scale multiple VMs to provide high availability and application resiliency, ideal for large-scale applications like container workloads [[1]](https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/overview)._ + +Cluster autoscaler allows you to adjust the size of the Kubernetes clusters based on the load conditions automatically. + +Another exciting feature which v1.12 brings to the table is the ability to use User Assigned Identities with Kubernetes clusters [[12]](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview). + +In this article, we will do a brief overview of VMSS, cluster autoscaler and user assigned identity features on Azure. + +## VMSS + +Azure’s Virtual Machine Scale sets (VMSS) feature offers users an ability to automatically create VMs from a single central configuration, provide load balancing via L4 and L7 load balancing, provide a path to use availability zones for high availability, provides large-scale VM instances et. al. + +VMSS consists of a group of virtual machines, which are identical and can be managed and configured at a group level. More details of this feature in Azure itself can be found at the following link [[1]](https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/overview). + +With Kubernetes v1.12 customers can create k8s cluster out of VMSS instances and utilize VMSS features. + +## Cluster components on Azure + +Generally, standalone Kubernetes cluster in Azure consists of the following parts + +* Compute - the VM itself and its properties. +* Networking - this includes the IPs and load balancers. +* Storage - the disks which are associated with the VMs. + +## Compute + +Compute in cloud k8s cluster consists of the VMs. These VMs are created by provisioning tools such as acs-engine or AKS (in case of managed service). Eventually, they run various system daemons such as kubelet, kube-api server etc. either as a process (in some versions) or as a docker container. + +![](/images/blog/2018-10-08-support-for-azure-vmss/sample-azure-cluster.png) + +## Networking + +In Azure Kubernetes cluster various networking components are brought together to provide features required for users. Typically they consist of the network interfaces, network security groups, public IP resource, VNET (virtual networks), load balancers etc. + +## Storage + +Kubernetes clusters are built on top of disks created in Azure. In a typical configuration, we have managed disks which are used to hold the regular OS images and a separate disk is used for etcd. + +## Cloud provider components + +![](/images/blog/2018-10-08-support-for-azure-vmss/cloud-provider-components.png) + +Kubernetes cloud provider interface provides interactions with clouds for managing cloud-specific resources, e.g. public IPs and routes. A good overview of these components is given in [[2]](https://kubernetes.io/docs/concepts/architecture/cloud-controller/). In case of Azure Kubernetes cluster, the Kubernetes interactions go through the Azure cloud provider layer and contact the various services running in the cloud. + +The cloud provider implementation of K8s can be largely divided into the following component interfaces which we need to implement: + +1. Load Balancer +1. Instances +1. Zones +1. Routes + +In addition to the above interfaces, the storage services from the cloud provider is linked via the volume plugin layer. + +## Azure cloud provider implementation and VMSS + +In the Azure cloud provider, for every type of cluster we implement, there is a VMType option which we specify. In case of VMSS, the VM type is “vmss”. The provisioning software (acs-engine, in future AKS etc.) would setup these values in /etc/kubernetes/azure.json file. Based on this type, various implementations would get instantiated [[3]](https://github.com/kubernetes/kubernetes/blob/master/pkg/cloudprovider/providers/azure/azure_vmss.go) + +The load balancer interface provides access to the underlying cloud provider load balancer service. The information about the load balancers and the control operations on them are required for Kubernetes to handle the services which gets hosted on the Kubernetes cluster. For VMSS support the changes ensure that the VMSS instances are part of the load balancer pool as required. + +The instances interfaces help the cloud controller to get various details about a node from the cloud provider layer. For example, the details of a node like the IP address, the instance id etc, is obtained by the controller by means of the instances interfaces which the cloud provider layer registers with it. In case of VMSS support, we talk to VMSS service to gather information regarding the instances. + +The zones interfaces help the cloud controller to get zone information for each node. Scheduler could spread pods to different availability zones with such information. It is also required for supporting topology aware dynamic provisioning features, e.g. AzureDisk. Each VMSS instances will be labeled with its current zone and region. + +The routes interfaces help the cloud controller to setup advanced routes for Pod network. For example, a route with prefix node’s podCIDR and next hop node’s internal IP will be set for each node. In case of VMSS support, the next hops are VMSS virtual machines’ internal IP address. + +The Azure volume plugin interfaces have been modified for VMSS to work properly. For example, the attach/detach to the AzureDisk have been modified to perform these operations at VMSS instance level. + +## Setting up a VMSS cluster on Azure + +The following link [[4]](https://github.com/Azure/acs-engine/blob/master/docs/kubernetes/deploy.md) provides an example of acs-engine to create a Kubernetes cluster. + +``` +acs-engine deploy --subscription-id \ + --dns-prefix --location \ + --api-model examples/kubernetes.json +``` + +API model file provides various configurations which acs-engine uses to create a cluster. The API model here [[5]](https://github.com/Azure/acs-engine/blob/master/examples/kubernetes-vmss/kubernetes.json) gives a good starting configuration to setup the VMSS cluster. + +Once a VMSS cluster is created, here are some of the steps you can run to understand more about the cluster setup. Here is the output of kubectl get nodes from a cluster created using the above command: + +``` +$ kubectl get nodes +NAME STATUS ROLES AGE VERSION +k8s-agentpool1-92998111-vmss000000 Ready agent 1h v1.12.0-rc.2 +k8s-agentpool1-92998111-vmss000001 Ready agent 1h v1.12.0-rc.2 +k8s-master-92998111-0 Ready master 1h v1.12.0-rc.2 +``` + +This cluster consists of two worker nodes and one master. Now how do we check which node is which in Azure parlance? In VMSS listing, we can see a single VMSS: + +``` +$ az vmss list -o table -g k8sblogkk1 +Name ResourceGroup Location Zones Capacity Overprovision UpgradePolicy +---------------------------- --------------- ---------- ------- ---------- --------------- --------------- +k8s-agentpool1-92998111-vmss k8sblogkk1 westus2 2 False Manual +``` + +The nodes which we see as agents (in the kubectl get nodes command) are part of this vmss. We can use the following command to list the instances which are part of the VM scale set: + +``` +$ az vmss list-instances -g k8sblogkk1 -n k8s-agentpool1-92998111-vmss -o table + InstanceId LatestModelApplied Location Name ProvisioningState ResourceGroup VmId +------------ -------------------- ---------- ------------------------------ ------------------- --------------- ------------------------------------ + 0 True westus2 k8s-agentpool1-92998111-vmss_0 Succeeded K8SBLOGKK1 21c57d6c-9c8f-4a62-970f-63ed0fcba53f + 1 True westus2 k8s-agentpool1-92998111-vmss_1 Succeeded K8SBLOGKK1 840743b9-0076-4a2e-920e-5ba9da296665 +``` + +The node name does not match the name in the vm scale set, but if we run the following command to list the providerID we can find the matching node which resembles the instance name: + +``` +$ kubectl describe nodes k8s-agentpool1-92998111-vmss000000| grep ProviderID +ProviderID: azure:///subscriptions//resourceGroups/k8sblogkk1/providers/Microsoft.Compute/virtualMachineScaleSets/k8s-agentpool1-92998111-vmss/virtualMachines/0 +``` + +## Current Status and Future + +Currently the following is supported: + +1. VMSS master nodes and worker nodes +1. VMSS on worker nodes and Availability set on master nodes combination. +1. Per vm disk attach +1. Azure Disk & Azure File support +1. Availability zones (Alpha) + +In future there will be support for the following: + +1. AKS with VMSS support +1. Per VM instance public IP + +## Cluster Autoscaler + +A Kubernetes cluster consists of nodes. These nodes can be virtual machines, bare metal servers or could be even virtual node (virtual kubelet). To avoid getting lost in permutations and combinations of Kubernetes ecosystem ;-), let's consider that the cluster we are discussing consists of virtual machines, which are hosted in a cloud (eg: Azure, Google or AWS). What this effectively means is that you have access to virtual machines which run Kubernetes agents and a master node which runs k8s services like API server. A detailed version of k8s architecture can be found here [[11]](https://kubernetes.io/docs/concepts/architecture/). + +The number of nodes which are required on a cluster depends on the workload on the cluster. When the load goes up there is a need to increase the nodes and when it subsides, there is a need to reduce the nodes and clean up the resources which are no longer in use. One way this can be taken care of is to manually scale up the nodes which are part of the Kubernetes cluster and manually scale down when the demand reduces. But shouldn’t this be done automatically ? Answer to this question is the Cluster Autoscaler (CA). + +The cluster autoscaler itself runs as a pod within the kubernetes cluster. The following figure illustrates the high level view of the setup with respect to the k8s cluster: + +![](/images/blog/2018-10-08-support-for-azure-vmss/cluster-autoscaler.png) + +Since Cluster Autoscaler is a pod within the k8s cluster, it can use the in-cluster config and the Kubernetes go client [[10]](https://github.com/kubernetes/client-go) to contact the API server. + +## Internals + +The API server is the central service which manages the state of the k8s cluster utilizing a backing store (an etcd database), runs on the management node or runs within the cloud (in case of managed service such as AKS). For any component within the Kubernetes cluster to figure out the state of the cluster, like for example the nodes registered in the cluster, contacting the API server is the way to go. + +In order to simplify our discussion let’s divide the CA functionality into 3 parts as given below: + +![](/images/blog/2018-10-08-support-for-azure-vmss/ca-functionality.png) + +The main portion of the CA is a control loop which keeps running at every scan interval. This loop is responsible for updating the autoscaler metrics and health probes. Before this loop is entered auto scaler performs various operations such as claiming the leader state after performing a Kubernetes leader election. The main loop initializes static autoscaler component. This component initializes the underlying cloud provider based on the parameters passed onto the CA. + +Various operations performed by the CA to manage the state of the cluster is passed onto the cloud provider component. Some examples like - increase target size, decrease target size etc, results in the cloud provider component talking to the cloud services internally and performing operations such as adding a node or deleting a node. These operations are performed on group of nodes in the cluster. The static autoscaler also keeps tab on the state of the system by querying the API server - operations such as list pods and list nodes are used to get hold of such information. + +The decision to make a scale up is based on pods which remain unscheduled and a variety of checks and balances. The nodes which are free to be scaled down are deleted from the cluster and deleted from the cloud itself. The cluster autoscaler applies checks and balances before scaling up and scaling down - for example the nodes which have been recently added are given special consideration. During the deletion the nodes are drained to ensure that no disruption happens to the running pods. + +## Setting up CA on Azure: + +Cluster Autoscaler is available as an add-on with acs-engine. The following link [[15]](https://github.com/Azure/acs-engine/tree/master/examples/addons/cluster-autoscaler) has an example configuration file used to deploy autoscaler with acs-engine. The following link [[8]](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/cloudprovider/azure/README.md) provides details on manual step by step way to do the same. + +In acs-engine case we use the the regular command line to deploy: + +``` +acs-engine deploy --subscription-id \ + --dns-prefix --location \ + --api-model examples/kubernetes.json +``` + +The main difference are the following lines in the config file at [[15]](https://github.com/Azure/acs-engine/tree/master/examples/addons/cluster-autoscaler) makes sure that CA is deployed as an addon: + +``` +"addons": [ + { + "name": "cluster-autoscaler", + "enabled": true, + "config": { + "minNodes": "1", + "maxNodes": "5" + } + } + ] +``` + +The config section in the json above can be used to provide the configuration to the cluster autoscaler pod, eg: min and max nodes as above. + +Once the setup completes we can see that the cluster-autoscaler pod is deployed in the system namespace: + +``` +$kubectl get pods -n kube-system | grep autoscaler +cluster-autoscaler-7bdc74d54c-qvbjs 1/1 Running 1 6m +``` + +Here is the output from the CA configmap and events from a sample cluster: + +``` +$kubectl -n kube-system describe configmap cluster-autoscaler-status +Name: cluster-autoscaler-status +Namespace: kube-system +Labels: +Annotations: cluster-autoscaler.kubernetes.io/last-updated=2018-10-02 01:21:17.850010508 +0000 UTC + +Data +==== +status: +---- +Cluster-autoscaler status at 2018-10-02 01:21:17.850010508 +0000 UTC: +Cluster-wide: + Health: Healthy (ready=3 unready=0 notStarted=0 longNotStarted=0 registered=3 longUnregistered=0) + LastProbeTime: 2018-10-02 01:21:17.772229859 +0000 UTC m=+3161.412682204 + LastTransitionTime: 2018-10-02 00:28:49.944222739 +0000 UTC m=+13.584675084 + ScaleUp: NoActivity (ready=3 registered=3) + LastProbeTime: 2018-10-02 01:21:17.772229859 +0000 UTC m=+3161.412682204 + LastTransitionTime: 2018-10-02 00:28:49.944222739 +0000 UTC m=+13.584675084 + ScaleDown: NoCandidates (candidates=0) + LastProbeTime: 2018-10-02 01:21:17.772229859 +0000 UTC m=+3161.412682204 + LastTransitionTime: 2018-10-02 00:39:50.493307405 +0000 UTC m=+674.133759650 + +NodeGroups: + Name: k8s-agentpool1-92998111-vmss + Health: Healthy (ready=2 unready=0 notStarted=0 longNotStarted=0 registered=2 longUnregistered=0 cloudProviderTarget=2 (minSize=1, maxSize=5)) + LastProbeTime: 2018-10-02 01:21:17.772229859 +0000 UTC m=+3161.412682204 + LastTransitionTime: 2018-10-02 00:28:49.944222739 +0000 UTC m=+13.584675084 + ScaleUp: NoActivity (ready=2 cloudProviderTarget=2) + LastProbeTime: 2018-10-02 01:21:17.772229859 +0000 UTC m=+3161.412682204 + LastTransitionTime: 2018-10-02 00:28:49.944222739 +0000 UTC m=+13.584675084 + ScaleDown: NoCandidates (candidates=0) + LastProbeTime: 2018-10-02 01:21:17.772229859 +0000 UTC m=+3161.412682204 + LastTransitionTime: 2018-10-02 00:39:50.493307405 +0000 UTC m=+674.133759650 + + +Events: + Type Reason Age From Message + ---- ------ ---- ---- ------- + Normal ScaleDownEmpty 42m cluster-autoscaler Scale-down: removing empty node k8s-agentpool1-92998111-vmss000002 +``` + +As can be seen the events, the cluster autoscaler scaled down and deleted a node as there was no load on this cluster. The rest of the configmap in this case indicates that there are no further actions which the autoscaler is taking at this moment. + +## Current status and future: + +Cluster Autoscaler currently supports four VM types: standard (VMAS), VMSS, ACS and AKS. In the future, Cluster Autoscaler will be integrated within AKS product, so that users can enable it by one-click. + +## User Assigned Identity + +Inorder for the Kubernetes cluster components to securely talk to the cloud services, it needs to authenticate with the cloud provider. In Azure Kubernetes clusters, up until now this was done using two ways - Service Principals or Managed Identities. In case of service principal the credentials are stored within the cluster and there are password rotation and other challenges which user needs to incur to accommodate this model. Managed service identities takes out this burden from the user and manages the service instances directly [[12]](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview). + +There are two kinds of managed identities possible - one is system assigned and another is user assigned. In case of system assigned identity each vm in the Kubernetes cluster is assigned a managed identity during creation. This identity is used by various Kubernetes components needing access to Azure resources. Examples to these operations are getting/updating load balancer configuration, getting/updating vm information etc. With the system assigned managed identity, user has no control over the identity which is assigned to the underlying vm. The system automatically assigns it and this reduces the flexibility for the user. + +With v1.12 we bring user assigned managed identity support for Kubernetes. With this support user does not have to manage any passwords but at the same time has the flexibility to manage the identity which is used by the cluster. For example if the user needs to allow access to a cluster for a specific storage account or a Azure key vault, the user assigned identity can be created in advance and key vault access provided. + +## Internals + +To understand the internals, we will focus on a cluster created using acs-engine. This can be configured in other ways, but the basic interactions are of the same pattern. + +The acs-engine sets up the cluster with the required configuration. The /etc/kubernetes/azure.json file provides a way for the cluster components (eg: kube-apiserver) to gather configuration on how to access the cloud resources. In a user managed identity cluster there is a value filled with the key as `UserAssignedIdentityID`. This value is filled with the client id of the user assigned identity created by acs-engine or provided by the user, however the case may be. The code which does the authentication for Kubernetes on azure can be found here [[14]](https://github.com/kubernetes/kubernetes/blob/master/pkg/cloudprovider/providers/azure/auth/azure_auth.go). This code uses Azure adal packages to get authenticated to access various resources in the cloud. In case of user assigned identity the following API call is made to get new token: + +``` +adal.NewServicePrincipalTokenFromMSIWithUserAssignedID(msiEndpoint, +env.ServiceManagementEndpoint, +config.UserAssignedIdentityID) +``` + +This calls hits either the instance metadata service or the vm extension [[12]](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview) to gather the token which is then used to access various resources. + +## Setting up a cluster with user assigned identity + +With the upstream support for user assigned identity in v1.12, it is now supported in the acs-engine to create a cluster with the user assigned identity. The json config files present here [[13]](https://github.com/Azure/acs-engine/tree/master/examples/kubernetes-msi-userassigned) can be used to create a cluster with user assigned identity. The same step used to create a vmss cluster can be used to create a cluster which has user assigned identity assigned. + +``` +acs-engine deploy --subscription-id \ + --dns-prefix --location \ + --api-model examples/kubernetes-msi-userassigned/kube-vmss.json +``` + +The main config values here are the following: + +``` +"useManagedIdentity": true +"userAssignedID": "acsenginetestid" +``` + +The first one `useManagedIdentity` indicates to acs-engine that we are going to use the managed identity extension. This sets up the necessary packages and extensions required for the managed identities to work. The next one `userAssignedID` provides the information on the user identity which is to be used with the cluster. + +## Current status and future + +Currently we support the user assigned identity creation with the cluster using deploy of the acs-engine. In future this will become part of AKS. + +## Get involved + +For azure specific discussions - please checkout the Azure SIG page at [[6]](https://github.com/kubernetes/community/tree/master/sig-azure) and come and join the [#sig-azure](https://kubernetes.slack.com/messages/sig-azure) slack channel for more. + +For CA, please checkout the Autoscaler project here [[7]](http://www.github.com/kubernetes/autoscaler) and join the [#sig-autoscaling](https://kubernetes.slack.com/messages/sig-autoscaling) Slack for more discussions. + +For the acs-engine (the unmanaged variety) on Azure docs can be found here: [[9]](https://github.com/Azure/acs-engine). More details about the managed service from Azure Kubernetes Service (AKS) here [[5]](https://docs.microsoft.com/en-us/azure/aks/). + +## References + +1) https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/overview + +2) https://kubernetes.io/docs/concepts/architecture/cloud-controller/ + +3) https://github.com/kubernetes/kubernetes/blob/master/pkg/cloudprovider/providers/azure/azure_vmss.go + +4) https://github.com/Azure/acs-engine/blob/master/docs/kubernetes/deploy.md + +5) https://docs.microsoft.com/en-us/azure/aks/ + +6) https://github.com/kubernetes/community/tree/master/sig-azure + +7) https://github.com/kubernetes/autoscaler + +8) https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/cloudprovider/azure/README.md + +9) https://github.com/Azure/acs-engine + +10) https://github.com/kubernetes/client-go + +11) https://kubernetes.io/docs/concepts/architecture/ + +12) https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview + +13) https://github.com/Azure/acs-engine/tree/master/examples/kubernetes-msi-userassigned + +14) https://github.com/kubernetes/kubernetes/blob/master/pkg/cloudprovider/providers/azure/auth/azure_auth.go + +15) https://github.com/Azure/acs-engine/tree/master/examples/addons/cluster-autoscaler diff --git a/content/en/blog/_posts/2018-10-09-volume-snapshot-alpha.md b/content/en/blog/_posts/2018-10-09-volume-snapshot-alpha.md new file mode 100644 index 0000000000..e8d4181ae0 --- /dev/null +++ b/content/en/blog/_posts/2018-10-09-volume-snapshot-alpha.md @@ -0,0 +1,292 @@ +--- +layout: blog +title: 'Introducing Volume Snapshot Alpha for Kubernetes' +date: 2018-10-09 +--- + +**Author**: Jing Xu (Google) Xing Yang (Huawei), Saad Ali (Google) + +Kubernetes v1.12 introduces alpha support for volume snapshotting. This feature allows creating/deleting volume snapshots, and the ability to create new volumes from a snapshot natively using the Kubernetes API. + +## What is a Snapshot? + +Many storage systems (like Google Cloud Persistent Disks, Amazon Elastic Block Storage, and many on-premise storage systems) provide the ability to create a "snapshot" of a persistent volume. A snapshot represents a point-in-time copy of a volume. A snapshot can be used either to provision a new volume (pre-populated with the snapshot data) or to restore the existing volume to a previous state (represented by the snapshot). + +## Why add Snapshots to Kubernetes? + +The Kubernetes volume plugin system already provides a powerful abstraction that automates the provisioning, attaching, and mounting of block and file storage. + +Underpinning all these features is the Kubernetes goal of workload portability: Kubernetes aims to create an abstraction layer between distributed systems applications and underlying clusters so that applications can be agnostic to the specifics of the cluster they run on and application deployment requires no “cluster specific” knowledge. + +The [Kubernetes Storage SIG](https://github.com/kubernetes/community/tree/master/sig-storage) identified snapshot operations as critical functionality for many stateful workloads. For example, a database administrator may want to snapshot a database volume before starting a database operation. + +By providing a standard way to trigger snapshot operations in the Kubernetes API, Kubernetes users can now handle use cases like this without having to go around the Kubernetes API (and manually executing storage system specific operations). + +Instead, Kubernetes users are now empowered to incorporate snapshot operations in a cluster agnostic way into their tooling and policy with the comfort of knowing that it will work against arbitrary Kubernetes clusters regardless of the underlying storage. + +Additionally these Kubernetes snapshot primitives act as basic building blocks that unlock the ability to develop advanced, enterprise grade, storage administration features for Kubernetes: such as data protection, data replication, and data migration. + +## Which volume plugins support Kubernetes Snapshots? + +Kubernetes supports three types of volume plugins: in-tree, Flex, and CSI. See [Kubernetes Volume Plugin FAQ](https://github.com/kubernetes/community/blob/master/sig-storage/volume-plugin-faq.md) for details. + +Snapshots are only supported for CSI drivers (not for in-tree or Flex). To use the Kubernetes snapshots feature, ensure that a CSI Driver that implements snapshots is deployed on your cluster. + +As of the publishing of this blog, the following CSI drivers support snapshots: + +* [GCE Persistent Disk CSI Driver](https://github.com/kubernetes-sigs/gcp-compute-persistent-disk-csi-driver) +* [OpenSDS CSI Driver](https://github.com/opensds/nbp/tree/master/csi/server) +* [Ceph RBD CSI Driver](https://github.com/ceph/ceph-csi/tree/master/pkg/rbd) +* [Portworx CSI Driver](https://github.com/libopenstorage/openstorage/tree/master/csi) + +Snapshot support for other [drivers](https://kubernetes-csi.github.io/docs/Drivers.html) is pending, and should be available soon. Read the “[Container Storage Interface (CSI) for Kubernetes Goes Beta](https://kubernetes.io/blog/2018/04/10/container-storage-interface-beta/)” blog post to learn more about CSI and how to deploy CSI drivers. + +## Kubernetes Snapshots API + +Similar to the API for managing Kubernetes Persistent Volumes, Kubernetes Volume Snapshots introduce three new API objects for managing snapshots: + +* `VolumeSnapshot` + * Created by a Kubernetes user to request creation of a snapshot for a specified volume. It contains information about the snapshot operation such as the timestamp when the snapshot was taken and whether the snapshot is ready to use. + * Similar to the `PersistentVolumeClaim` object, the creation and deletion of this object represents a user desire to create or delete a cluster resource (a snapshot). +* `VolumeSnapshotContent` + * Created by the CSI volume driver once a snapshot has been successfully created. It contains information about the snapshot including snapshot ID. + * Similar to the `PersistentVolume` object, this object represents a provisioned resource on the cluster (a snapshot). + * Like `PersistentVolumeClaim` and `PersistentVolume` objects, once a snapshot is created, the `VolumeSnapshotContent` object binds to the VolumeSnapshot for which it was created (with a one-to-one mapping). +* `VolumeSnapshotClass` + * Created by cluster administrators to describe how snapshots should be created. including the driver information, the secrets to access the snapshot, etc. + +It is important to note that unlike the core Kubernetes Persistent Volume objects, these Snapshot objects are defined as [CustomResourceDefinitions (CRDs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions). The Kubernetes project is moving away from having resource types pre-defined in the API server, and is moving towards a model where the API server is independent of the API objects. This allows the API server to be reused for projects other than Kubernetes, and consumers (like Kubernetes) can simply install the resource types they require as CRDs. + +[CSI Drivers](https://kubernetes-csi.github.io/docs/Drivers.html) that support snapshots will automatically install the required CRDs. Kubernetes end users only need to verify that a CSI driver that supports snapshots is deployed on their Kubernetes cluster. + +In addition to these new objects, a new, DataSource field has been added to the `PersistentVolumeClaim` object: + +``` +type PersistentVolumeClaimSpec struct { + AccessModes []PersistentVolumeAccessMode + Selector *metav1.LabelSelector + Resources ResourceRequirements + VolumeName string + StorageClassName *string + VolumeMode *PersistentVolumeMode + DataSource *TypedLocalObjectReference +} +``` + +This new alpha field enables a new volume to be created and automatically pre-populated with data from an existing snapshot. + +## Kubernetes Snapshots Requirements + +Before using Kubernetes Volume Snapshotting, you must: + +* Ensure a CSI driver implementing snapshots is deployed and running on your Kubernetes cluster. +* Enable the Kubernetes Volume Snapshotting feature via new Kubernetes feature gate (disabled by default for alpha): + * Set the following flag on the API server binary: `--feature-gates=VolumeSnapshotDataSource=true` + +Before creating a snapshot, you also need to specify CSI driver information for snapshots by creating a `VolumeSnapshotClass` object and setting the `snapshotter` field to point to your CSI driver. In the example of `VolumeSnapshotClass` below, the CSI driver is `com.example.csi-driver`. You need at least one `VolumeSnapshotClass` object per snapshot provisioner. You can also set a default `VolumeSnapshotClass` for each individual CSI driver by putting an annotation `snapshot.storage.kubernetes.io/is-default-class: "true"` in the class definition. + +``` +apiVersion: snapshot.storage.k8s.io/v1alpha1 +kind: VolumeSnapshotClass +metadata: + name: default-snapclass + annotations: + snapshot.storage.kubernetes.io/is-default-class: "true" +snapshotter: com.example.csi-driver + + +apiVersion: snapshot.storage.k8s.io/v1alpha1 +kind: VolumeSnapshotClass +metadata: + name: csi-snapclass +snapshotter: com.example.csi-driver +parameters: + fakeSnapshotOption: foo + csiSnapshotterSecretName: csi-secret + csiSnapshotterSecretNamespace: csi-namespace +``` + +You must set any required opaque parameters based on the documentation for your CSI driver. As the example above shows, the parameter `fakeSnapshotOption: foo` and any referenced secret(s) will be passed to CSI driver during snapshot creation and deletion. The [default CSI external-snapshotter](https://github.com/kubernetes-csi/external-snapshotter) reserves the parameter keys `csiSnapshotterSecretName` and `csiSnapshotterSecretNamespace`. If specified, it fetches the secret and passes it to the CSI driver when creating and deleting a snapshot. + +And finally, before creating a snapshot, you must provision a volume using your CSI driver and populate it with some data that you want to snapshot (see the [CSI blog post](https://kubernetes.io/blog/2018/04/10/container-storage-interface-beta/) on how to create and use CSI volumes). + +## Creating a new Snapshot with Kubernetes + +Once a `VolumeSnapshotClass` object is defined and you have a volume you want to snapshot, you may create a new snapshot by creating a `VolumeSnapshot` object. + +The source of the snapshot specifies the volume to create a snapshot from. It has two parameters: + +* `kind` - must be `PersistentVolumeClaim` +* `name` - the PVC API object name + +The namespace of the volume to snapshot is assumed to be the same as the namespace of the `VolumeSnapshot` object. + +``` +apiVersion: snapshot.storage.k8s.io/v1alpha1 +kind: VolumeSnapshot +metadata: + name: new-snapshot-demo + namespace: demo-namespace +spec: + snapshotClassName: csi-snapclass + source: + name: mypvc + kind: PersistentVolumeClaim +``` + +In the `VolumeSnapshot` spec, user can specify the `VolumeSnapshotClass` which has the information about which CSI driver should be used for creating the snapshot . When the `VolumeSnapshot` object is created, the parameter `fakeSnapshotOption: foo` and any referenced secret(s) from the `VolumeSnapshotClass` are passed to the CSI plugin `com.example.csi-driver` via a `CreateSnapshot` call. + +In response, the CSI driver triggers a snapshot of the volume and then automatically creates a `VolumeSnapshotContent` object to represent the new snapshot, and binds the new `VolumeSnapshotContent` object to the `VolumeSnapshot`, making it ready to use. If the CSI driver fails to create the snapshot and returns error, the snapshot controller reports the error in the status of `VolumeSnapshot` object and does not retry (this is different from other controllers in Kubernetes, and is to prevent snapshots from being taken at an unexpected time). + +If a snapshot class is not specified, the external snapshotter will try to find and set a default snapshot class for the snapshot. The `CSI driver` specified by `snapshotter` in the default snapshot class must match the `CSI driver` specified by the `provisioner` in the storage class of the PVC. + +Please note that the alpha release of Kubernetes Snapshot does not provide any consistency guarantees. You have to prepare your application (pause application, freeze filesystem etc.) before taking the snapshot for data consistency. + +You can verify that the `VolumeSnapshot` object is created and bound with `VolumeSnapshotContent` by running `kubectl describe volumesnapshot`: + +* `Ready` should be set to true under `Status` to indicate this volume snapshot is ready for use. +* `Creation Time` field indicates when the snapshot is actually created (cut). +* `Restore Size` field indicates the minimum volume size when restoring a volume from the snapshot. +* `Snapshot Content Name` field in the `spec` points to the `VolumeSnapshotContent` object created for this snapshot. + +## Importing an existing snapshot with Kubernetes + +You can always import an existing snapshot to Kubernetes by manually creating a `VolumeSnapshotContent` object to represent the existing snapshot. Because `VolumeSnapshotContent` is a non-namespace API object, only a system admin may have the permission to create it. Once a `VolumeSnapshotContent` object is created, the user can create a `VolumeSnapshot` object pointing to the `VolumeSnapshotContent` object. The external-snapshotter controller will mark snapshot as ready after verifying the snapshot exists and the binding between `VolumeSnapshot` and `VolumeSnapshotContent` objects is correct. Once bound, the snapshot is ready to use in Kubernetes. + +A `VolumeSnapshotContent` object should be created with the following fields to represent a pre-provisioned snapshot: + +* `csiVolumeSnapshotSource` - Snapshot identifying information. + * `snapshotHandle` - name/identifier of the snapshot. This field is required. + * `driver` - CSI driver used to handle this volume. This field is required. It must match the snapshotter name in the snapshot controller. + * `creationTime` and `restoreSize` - these fields are not required for pre-provisioned volumes. The external-snapshotter controller will automatically update them after creation. +* `volumeSnapshotRef` - Pointer to the `VolumeSnapshot` object this object should bind to. + * `name` and `namespace` - It specifies the name and namespace of the `VolumeSnapshot` object which the content is bound to. + * `UID` - these fields are not required for pre-provisioned volumes.The external-snapshotter controller will update the field automatically after binding. If user specifies UID field, he/she must make sure that it matches with the binding snapshot’s UID. If the specified UID does not match the binding snapshot’s UID, the content is considered an orphan object and the controller will delete it and its associated snapshot. +* `snapshotClassName` - This field is optional. The external-snapshotter controller will update the field automatically after binding. + +``` +apiVersion: snapshot.storage.k8s.io/v1alpha1 +kind: VolumeSnapshotContent +metadata: + name: static-snapshot-content +spec: + csiVolumeSnapshotSource: + driver: com.example.csi-driver + snapshotHandle: snapshotcontent-example-id + volumeSnapshotRef: + kind: VolumeSnapshot + name: static-snapshot-demo + namespace: demo-namespace +``` + +A `VolumeSnapshot` object should be created to allow a user to use the snapshot: + +* `snapshotClassName` - name of the volume snapshot class. This field is optional. If set, the snapshotter field in the snapshot class must match the snapshotter name of the snapshot controller. If not set, the snapshot controller will try to find a default snapshot class. +* `snapshotContentName` - name of the volume snapshot content. This field is required for pre-provisioned volumes. + +``` +apiVersion: snapshot.storage.k8s.io/v1alpha1 +kind: VolumeSnapshot +metadata: + name: static-snapshot-demo + namespace: demo-namespace +spec: + snapshotClassName: csi-snapclass + snapshotContentName: static-snapshot-content +``` + +Once these objects are created, the snapshot controller will bind them together, and set the field Ready (under `Status`) to True to indicate the snapshot is ready to use. + +## Provision a new volume from a snapshot with Kubernetes + +To provision a new volume pre-populated with data from a snapshot object, use the new dataSource field in the `PersistentVolumeClaim`. It has three parameters: + +* name - name of the `VolumeSnapshot` object representing the snapshot to use as source +* kind - must be `VolumeSnapshot` +* apiGroup - must be `snapshot.storage.k8s.io` + +The namespace of the source `VolumeSnapshot` object is assumed to be the same as the namespace of the `PersistentVolumeClaim` object. + +``` +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: pvc-restore + Namespace: demo-namespace +spec: + storageClassName: csi-storageclass + dataSource: + name: new-snapshot-demo + kind: VolumeSnapshot + apiGroup: snapshot.storage.k8s.io + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 1Gi +``` + +When the `PersistentVolumeClaim` object is created, it will trigger provisioning of a new volume that is pre-populated with data from the specified snapshot. + +## As a storage vendor, how do I add support for snapshots to my CSI driver? + +To implement the snapshot feature, a CSI driver MUST add support for additional controller capabilities `CREATE_DELETE_SNAPSHOT` and `LIST_SNAPSHOTS`, and implement additional controller RPCs: `CreateSnapshot`, `DeleteSnapshot`, and `ListSnapshots`. For details, see [the CSI spec](https://github.com/container-storage-interface/spec/blob/master/spec.md). + +Although Kubernetes is as [minimally prescriptive](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/storage/container-storage-interface.md#third-party-csi-volume-drivers) on the packaging and deployment of a CSI Volume Driver as possible, it provides a [suggested mechanism](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/storage/container-storage-interface.md#recommended-mechanism-for-deploying-csi-drivers-on-kubernetes) for deploying an arbitrary containerized CSI driver on Kubernetes to simplify deployment of containerized CSI compatible volume drivers. + +As part of this recommended deployment process, the Kubernetes team provides a number of sidecar (helper) containers, including a new [external-snapshotter](https://github.com/kubernetes-csi/external-snapshotter) sidecar container. + +The external-snapshotter watches the Kubernetes API server for `VolumeSnapshot` and `VolumeSnapshotContent` objects and triggers CreateSnapshot and DeleteSnapshot operations against a CSI endpoint. The CSI [external-provisioner](https://github.com/kubernetes-csi/external-provisioner) sidecar container has also been updated to support restoring volume from snapshot using the new `dataSource` PVC field. + +In order to support snapshot feature, it is recommended that storage vendors deploy the external-snapshotter sidecar containers in addition to the external provisioner the external attacher, along with their CSI driver in a statefulset as shown in the following diagram. + +![](/images/blog/2018-10-09-volume-snapshot-alpha/snapshot.png) + +In this [example deployment yaml](https://github.com/kubernetes-csi/external-snapshotter/blob/e011fe31df548813d2eb6dacb278c0ca58533b34/deploy/kubernetes/setup-csi-snapshotter.yaml) file, two sidecar containers, the external provisioner and the external snapshotter, and CSI drivers are deployed together with the hostpath CSI plugin in the statefulset pod. Hostpath CSI plugin is a sample plugin, not for production. + +## What are the limitations of alpha? + +The alpha implementation of snapshots for Kubernetes has the following limitations: + +* Does not support reverting an existing volume to an earlier state represented by a snapshot (alpha only supports provisioning a new volume from a snapshot). +* Does not support “in-place restore” of an existing PersistentVolumeClaim from a snapshot: i.e. provisioning a new volume from a snapshot, but updating an existing PersistentVolumeClaim to point to the new volume and effectively making the PVC appear to revert to an earlier state (alpha only supports using a new volume provisioned from a snapshot via a new PV/PVC). +* No snapshot consistency guarantees beyond any guarantees provided by storage system (e.g. crash consistency). + +## What’s next? +Depending on feedback and adoption, the Kubernetes team plans to push the CSI Snapshot implementation to beta in either 1.13 or 1.14. + +## How can I learn more? + +Check out additional documentation on the snapshot feature here: http://k8s.io/docs/concepts/storage/volume-snapshots and https://kubernetes-csi.github.io/docs/ + +## How do I get involved? + +This project, like all of Kubernetes, is the result of hard work by many contributors from diverse backgrounds working together. + +In addition to the contributors who have been working on the Snapshot feature: + +* Xing Yang ([xing-yang](https://github.com/xing-yang)) +* Jing Xu ([jingxu97](https://github.com/jingxu97)) +* Huamin Chen ([rootfs](https://github.com/rootfs)) +* Tomas Smetana ([tsmetana](https://github.com/tsmetana)) +* Shiwei Xu ([wackxu](https://github.com/wackxu)) + +We offer a huge thank you to all the contributors in Kubernetes Storage SIG and CSI community who helped review the design and implementation of the project, including but not limited to the following: + +* Saad Ali ([saadali](https://github.com/saadali)) +* Tim Hockin ([thockin](https://github.com/thockin)) +* Jan Šafránek ([jsafrane](https://github.com/jsafrane)) +* Luis Pabon ([lpabon](https://github.com/lpabon)) +* Jordan Liggitt ([liggitt](https://github.com/liggitt)) +* David Zhu ([davidz627](https://github.com/davidz627)) +* Garth Bushell ([garthy](https://github.com/garthy)) +* Ardalan Kangarlou ([kangarlou](https://github.com/kangarlou)) +* Seungcheol Ko ([sngchlko](https://github.com/sngchlko)) +* Michelle Au ([msau42](https://github.com/msau42)) +* Humble Devassy Chirammal ([humblec](https://github.com/humblec)) +* Vladimir Vivien ([vladimirvivien](https://github.com/vladimirvivien)) +* John Griffith ([j-griffith](https://github.com/j-griffith)) +* Bradley Childs ([childsb](https://github.com/childsb)) +* Ben Swartzlander ([bswartz](https://github.com/bswartz)) + +If you’re interested in getting involved with the design and development of CSI or any part of the Kubernetes Storage system, join the [Kubernetes Storage Special Interest Group](https://github.com/kubernetes/community/tree/master/sig-storage) (SIG). We’re rapidly growing and always welcome new contributors. diff --git a/content/en/blog/_posts/2018-10-10-runtimeclass.md b/content/en/blog/_posts/2018-10-10-runtimeclass.md new file mode 100644 index 0000000000..9899884299 --- /dev/null +++ b/content/en/blog/_posts/2018-10-10-runtimeclass.md @@ -0,0 +1,47 @@ +--- +layout: blog +title: 'Kubernetes v1.12: Introducing RuntimeClass' +date: 2018-10-10 +--- + +**Author**: Tim Allclair (Google) + +Kubernetes originally launched with support for Docker containers running native applications on a Linux host. Starting with [rkt](https://kubernetes.io/blog/2016/07/rktnetes-brings-rkt-container-engine-to-kubernetes/) in Kubernetes 1.3 more runtimes were coming, which lead to the development of the [Container Runtime Interface](https://kubernetes.io/blog/2016/12/container-runtime-interface-cri-in-kubernetes/) (CRI). Since then, the set of alternative runtimes has only expanded: projects like [Kata Containers](https://katacontainers.io/) and [gVisor](https://github.com/google/gvisor) were announced for stronger workload isolation, and Kubernetes' Windows support has been [steadily progressing](https://kubernetes.io/blog/2018/01/kubernetes-v19-beta-windows-support/). + +With runtimes targeting so many different use cases, a clear need for mixed runtimes in a cluster arose. But all these different ways of running containers have brought a new set of problems to deal with: + +- How do users know which runtimes are available, and select the runtime for their workloads? +- How do we ensure pods are scheduled to the nodes that support the desired runtime? +- Which runtimes support which features, and how can we surface incompatibilities to the user? +- How do we account for the varying resource overheads of the runtimes? + +**RuntimeClass** aims to solve these issues. + +## RuntimeClass in Kubernetes 1.12 + +RuntimeClass was recently introduced as an alpha feature in Kubernetes 1.12. The initial implementation focuses on providing a runtime selection API, and paves the way to address the other open problems. + +The RuntimeClass resource represents a container runtime supported in a Kubernetes cluster. The cluster provisioner sets up, configures, and defines the concrete runtimes backing the RuntimeClass. In its current form, a RuntimeClassSpec holds a single field, the **RuntimeHandler**. The RuntimeHandler is interpreted by the CRI implementation running on a node, and mapped to the actual runtime configuration. Meanwhile the PodSpec has been expanded with a new field, **RuntimeClassName**, which names the RuntimeClass that should be used to run the pod. + +Why is RuntimeClass a pod level concept? The Kubernetes resource model expects certain resources to be shareable between containers in the pod. If the pod is made up of different containers with potentially different resource models, supporting the necessary level of resource sharing becomes very challenging. For example, it is extremely difficult to support a loopback (localhost) interface across a VM boundary, but this is a common model for communication between two containers in a pod. + +## What's next? + +The RuntimeClass resource is an important foundation for surfacing runtime properties to the control plane. For example, to implement scheduler support for clusters with heterogeneous nodes supporting different runtimes, we might add [NodeAffinity](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity) terms to the RuntimeClass definition. Another area to address is managing the variable resource requirements to run pods of different runtimes. The [Pod Overhead proposal](https://docs.google.com/document/d/1EJKT4gyl58-kzt2bnwkv08MIUZ6lkDpXcxkHqCvvAp4/preview) was an early take on this that aligns nicely with the RuntimeClass design, and may be pursued further. + +Many other RuntimeClass extensions have also been proposed, and will be revisited as the feature continues to develop and mature. A few more extensions that are being considered include: + + - Surfacing optional features supported by runtimes, and better visibility into errors caused by incompatible features. +- Automatic runtime or feature discovery, to support scheduling decisions without manual configuration. +- Standardized or conformant RuntimeClass names that define a set of properties that should be supported across clusters with RuntimeClasses of the same name. +- Dynamic registration of additional runtimes, so users can install new runtimes on existing clusters with no downtime. +- "Fitting" a RuntimeClass to a pod's requirements. For instance, specifying runtime properties and letting the system match an appropriate RuntimeClass, rather than explicitly assigning a RuntimeClass by name. + +RuntimeClass will be under active development at least through 2019, and we’re excited to see the feature take shape, starting with the RuntimeClass alpha in Kubernetes 1.12. + +## Learn More + +- Take it for a spin! As an alpha feature, there are some additional setup steps to use RuntimeClass. Refer to the [RuntimeClass documentation](https://kubernetes.io/docs/concepts/containers/runtime-class/#runtime-class) for how to get it running. +- Check out the [RuntimeClass Kubernetes Enhancement Proposal](https://github.com/kubernetes/community/blob/master/keps/sig-node/0014-runtime-class.md) for more nitty-gritty design details. +- The [Sandbox Isolation Level Decision](https://docs.google.com/document/d/1fe7lQUjYKR0cijRmSbH_y0_l3CYPkwtQa5ViywuNo8Q/preview) documents the thought process that initially went into making RuntimeClass a pod-level choice. +- Join the discussions and help shape the future of RuntimeClass with the [SIG-Node community](https://github.com/kubernetes/community/tree/master/sig-node) diff --git a/content/en/blog/_posts/2018-10-11-topology-aware-volume-provisioning.md b/content/en/blog/_posts/2018-10-11-topology-aware-volume-provisioning.md new file mode 100644 index 0000000000..6daecd1c5f --- /dev/null +++ b/content/en/blog/_posts/2018-10-11-topology-aware-volume-provisioning.md @@ -0,0 +1,158 @@ +--- +layout: blog +title: 'Topology-Aware Volume Provisioning in Kubernetes' +date: 2018-10-11 +--- + +**Author**: Michelle Au (Google) + +The multi-zone cluster experience with persistent volumes is improving in Kubernetes 1.12 with the topology-aware dynamic provisioning beta feature. This feature allows Kubernetes to make intelligent decisions when dynamically provisioning volumes by getting scheduler input on the best place to provision a volume for a pod. In multi-zone clusters, this means that volumes will get provisioned in an appropriate zone that can run your pod, allowing you to easily deploy and scale your stateful workloads across failure domains to provide high availability and fault tolerance. + +## Previous challenges + +Before this feature, running stateful workloads with zonal persistent disks (such as AWS ElasticBlockStore, Azure Disk, GCE PersistentDisk) in multi-zone clusters had many challenges. Dynamic provisioning was handled independently from pod scheduling, which meant that as soon as you created a PersistentVolumeClaim (PVC), a volume would get provisioned. This meant that the provisioner had no knowledge of what pods were using the volume, and any pod constraints it had that could impact scheduling. + +This resulted in unschedulable pods because volumes were provisioned in zones that: + +* did not have enough CPU or memory resources to run the pod +* conflicted with node selectors, pod affinity or anti-affinity policies +* could not run the pod due to taints + +Another common issue was that a non-StatefulSet pod using multiple persistent volumes could have each volume provisioned in a different zone, again resulting in an unschedulable pod. + +Suboptimal workarounds included overprovisioning of nodes, or manual creation of volumes in the correct zones, making it difficult to dynamically deploy and scale stateful workloads. + +The topology-aware dynamic provisioning feature addresses all of the above issues. + +## Supported Volume Types + +In 1.12, the following drivers support topology-aware dynamic provisioning: + +* AWS EBS +* Azure Disk +* GCE PD (including Regional PD) +* CSI (alpha) - currently only the GCE PD CSI driver has implemented topology support + +## Design Principles + +While the initial set of supported plugins are all zonal-based, we designed this feature to adhere to the Kubernetes principle of portability across environments. Topology specification is generalized and uses a similar label-based specification like in Pod nodeSelectors and nodeAffinity. This mechanism allows you to define your own topology boundaries, such as racks in on-premise clusters, without requiring modifications to the scheduler to understand these custom topologies. + +In addition, the topology information is abstracted away from the pod specification, so a pod does not need knowledge of the underlying storage system’s topology characteristics. This means that you can use the same pod specification across multiple clusters, environments, and storage systems. + +## Getting Started + +To enable this feature, all you need to do is to create a StorageClass with `volumeBindingMode` set to `WaitForFirstConsumer`: + +``` +kind: StorageClass +apiVersion: storage.k8s.io/v1 +metadata: + name: topology-aware-standard +provisioner: kubernetes.io/gce-pd +volumeBindingMode: WaitForFirstConsumer +parameters: + type: pd-standard +``` + +This new setting instructs the volume provisioner to not create a volume immediately, and instead, wait for a pod using an associated PVC to run through scheduling. Note that previous StorageClass `zone` and `zones` parameters do not need to be specified anymore, as pod policies now drive the decision of which zone to provision a volume in. + +Next, create a pod and PVC with this StorageClass. This sequence is the same as before, but with a different StorageClass specified in the PVC. The following is a hypothetical example, demonstrating the capabilities of the new feature by specifying many pod constraints and scheduling policies: + +* multiple PVCs in a pod +* nodeAffinity across a subset of zones +* pod anti-affinity on zones + +``` +apiVersion: apps/v1 +kind: StatefulSet +metadata: + name: web +spec: + serviceName: "nginx" + replicas: 2 + selector: + matchLabels: + app: nginx + template: + metadata: + labels: + app: nginx + spec: + affinity: + nodeAffinity: + requiredDuringSchedulingIgnoredDuringExecution: + nodeSelectorTerms: + - matchExpressions: + - key: failure-domain.beta.kubernetes.io/zone + operator: In + values: + - us-central1-a + - us-central1-f + podAntiAffinity: + requiredDuringSchedulingIgnoredDuringExecution: + - labelSelector: + matchExpressions: + - key: app + operator: In + values: + - nginx + topologyKey: failure-domain.beta.kubernetes.io/zone + containers: + - name: nginx + image: gcr.io/google_containers/nginx-slim:0.8 + ports: + - containerPort: 80 + name: web + volumeMounts: + - name: www + mountPath: /usr/share/nginx/html + - name: logs + mountPath: /logs + volumeClaimTemplates: + - metadata: + name: www + spec: + accessModes: [ "ReadWriteOnce" ] + storageClassName: topology-aware-standard + resources: + requests: + storage: 10Gi + - metadata: + name: logs + spec: + accessModes: [ "ReadWriteOnce" ] + storageClassName: topology-aware-standard + resources: + requests: + storage: 1Gi +``` + +Afterwards, you can see that the volumes were provisioned in zones according to the policies set by the pod: + +``` +$ kubectl get pv -o=jsonpath='{range .items[*]}{.spec.claimRef.name}{"\t"}{.metadata.labels.failure\-domain\.beta\.kubernetes\.io/zone}{"\n"}{end}' +www-web-0 us-central1-f +logs-web-0 us-central1-f +www-web-1 us-central1-a +logs-web-1 us-central1-a +``` + +## How can I learn more? + +Official documentation on the topology-aware dynamic provisioning feature is available here: +https://kubernetes.io/docs/concepts/storage/storage-classes/#volume-binding-mode + +Documentation for CSI drivers is available at https://kubernetes-csi.github.io/docs/ + +## What’s next? + +We are actively working on improving this feature to support: + +* more volume types, including dynamic provisioning for local volumes +* dynamic volume attachable count and capacity limits per node + +## How do I get involved? + +If you have feedback for this feature or are interested in getting involved with the design and development, join the [Kubernetes Storage Special-Interest-Group](https://github.com/kubernetes/community/tree/master/sig-storage) (SIG). We’re rapidly growing and always welcome new contributors. + +Special thanks to all the contributors that helped bring this feature to beta, including Cheng Xing ([verult](https://github.com/verult)), Chuqiang Li ([lichuqiang](https://github.com/lichuqiang)), David Zhu ([davidz627](https://github.com/davidz627)), Deep Debroy ([ddebroy](https://github.com/ddebroy)), Jan Šafránek ([jsafrane](https://github.com/jsafrane)), Jordan Liggitt ([liggitt](https://github.com/liggitt)), Michelle Au ([msau42](https://github.com/msau42)), Pengfei Ni ([feiskyer](https://github.com/feiskyer)), Saad Ali ([saad-ali](https://github.com/saad-ali)), Tim Hockin ([thockin](https://github.com/thockin)), and Yecheng Fu ([cofyc](https://github.com/cofyc)). diff --git a/content/en/blog/_posts/2018-10-15-steering-election-results.md b/content/en/blog/_posts/2018-10-15-steering-election-results.md new file mode 100644 index 0000000000..e6b7677981 --- /dev/null +++ b/content/en/blog/_posts/2018-10-15-steering-election-results.md @@ -0,0 +1,33 @@ +--- +layout: blog +title: '2018 Steering Committee Election Results' +date: 2018-10-15 +--- + +**Authors**: Jorge Castro (Heptio), Ihor Dvoretskyi (CNCF), Paris Pittman (Google) + +## Results +The [Kubernetes Steering Committee Election](https://kubernetes.io/blog/2018/09/06/2018-steering-committee-election-cycle-kicks-off/) is now complete and the following candidates came ahead to secure two year terms that start immediately: + +* Aaron Crickenberger, Google, [@spiffxp](https://github.com/spiffxp) +* Davanum Srinivas, Huawei, [@dims](https://github.com/dims) +* Tim St. Clair, Heptio, [@timothysc](https://github.com/timothysc) + +## Big Thanks! + +* Steering Committee Member Emeritus [Quinton Hoole](https://github.com/quinton-hoole) for his service to the community over the past year. We look forward to +* The candidates that came forward to run for election. May we always have a strong set of people who want to push community forward like yours in every election. +* All 307 voters who cast a ballot. +* And last but not least...Cornell University for hosting [CIVS](https://civs.cs.cornell.edu/)! + +## Get Involved with the Steering Committee +You can follow along to Steering Committee [backlog items](https://git.k8s.io/steering/backlog.md) and weigh in by filing an issue or creating a PR against their [repo](https://github.com/kubernetes/steering). They meet bi-weekly on [Wednesdays at 8pm UTC](https://github.com/kubernetes/steering) and regularly attend Meet Our Contributors. + +Steering Committee Meetings: + +* [YouTube Playlist](https://www.youtube.com/playlist?list=PL69nYSiGNLP1yP1B_nd9-drjoxp0Q14qM) + +Meet Our Contributors Steering AMA’s: + +* [Oct 3 2018](https://youtu.be/x6Jm8p0K-IQ) +* [Sept 5 2018](https://youtu.be/UbxWV12Or58) diff --git a/content/en/blog/_posts/2018-10-16-kubernetes-2018-north-american-contributor-summit.md b/content/en/blog/_posts/2018-10-16-kubernetes-2018-north-american-contributor-summit.md new file mode 100644 index 0000000000..095e47a73d --- /dev/null +++ b/content/en/blog/_posts/2018-10-16-kubernetes-2018-north-american-contributor-summit.md @@ -0,0 +1,63 @@ +--- +layout: "Blog" +title: "Kubernetes 2018 North American Contributor Summit" +date: 2018-10-16 +--- + +**Authors:** +[Bob Killen][bob] (University of Michigan) +[Sahdev Zala][sahdev] (IBM), +[Ihor Dvoretskyi][ihor] (CNCF) + + +The 2018 North American Kubernetes Contributor Summit to be hosted right before +[KubeCon + CloudNativeCon][kubecon] Seattle is shaping up to be the largest yet. +It is an event that brings together new and current contributors alike to +connect and share face-to-face; and serves as an opportunity for existing +contributors to help shape the future of community development. For new +community members, it offers a welcoming space to learn, explore and put the +contributor workflow to practice. + +Unlike previous Contributor Summits, the event now spans two-days with a more +relaxed ‘hallway’ track and general Contributor get-together to be hosted from +5-8pm on Sunday December 9th at the [Garage Lounge and Gaming Hall][garage], just +a short walk away from the Convention Center. There, contributors can enjoy +billiards, bowling, trivia and more; accompanied by a variety of food and drink. + +Things pick up the following day, Monday the 10th with three separate tracks: + +### New Contributor Workshop: +A half day workshop aimed at getting new and first time contributors onboarded +and comfortable with working within the Kubernetes Community. Staying for the +duration is required; this is not a workshop you can drop into. + +### Current Contributor Track: +Reserved for those that are actively engaged with the development of the +project; the Current Contributor Track includes Talks, Workshops, Birds of a +Feather, Unconferences, Steering Committee Sessions, and more! Keep an eye on +the [schedule in GitHub][schedule] as content is frequently being updated. + +### Docs Sprint: +SIG-Docs will have a curated list of issues and challenges to be tackled closer +to the event date. + +## To Register: +To register for the Contributor Summit, see the [Registration section of the +Event Details in GitHub][register]. Please note that registrations are being +reviewed. If you select the “Current Contributor Track” and are not an active +contributor, you will be asked to attend the New Contributor Workshop, or asked +to be put on a waitlist. With thousands of contributors and only 300 spots, we +need to make sure the right folks are in the room. + +If you have any questions or concerns, please don’t hesitate to reach out to +the Contributor Summit Events Team at community@kubernetes.io. + +Look forward to seeing everyone there! + +[bob]: https://twitter.com/mrbobbytables +[sahdev]: https://twitter.com/sp_zala +[ihor]: https://twitter.com/idvoretskyi +[kubecon]: https://events.linuxfoundation.org/events/kubecon-cloudnativecon-north-america-2018/ +[garage]: https://www.garagebilliards.com/ +[schedule]: https://git.k8s.io/community/events/2018/12-contributor-summit#agenda +[register]: https://git.k8s.io/community/events/2018/12-contributor-summit#registration diff --git a/content/en/case-studies/ancestry/index.html b/content/en/case-studies/ancestry/index.html index 8bd998392a..a992a284ac 100644 --- a/content/en/case-studies/ancestry/index.html +++ b/content/en/case-studies/ancestry/index.html @@ -7,7 +7,7 @@ css: /css/style_ancestry.css ---
-

CASE STUDY:
Digging Into the Past With New Technology

+

CASE STUDY:
Digging Into the Past With New Technology

diff --git a/content/en/case-studies/capital-one/index.html b/content/en/case-studies/capital-one/index.html index ade270278d..773db4869e 100644 --- a/content/en/case-studies/capital-one/index.html +++ b/content/en/case-studies/capital-one/index.html @@ -89,7 +89,7 @@ css: /css/style_case_studies.css
- 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."

+ 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/peardeck/index.html b/content/en/case-studies/peardeck/index.html index 615c17376b..688754a620 100644 --- a/content/en/case-studies/peardeck/index.html +++ b/content/en/case-studies/peardeck/index.html @@ -21,7 +21,7 @@ css: /css/style_peardeck.css

Challenge

- The three-year-old startup provides a web app for teachers to interact with their students in the classroom. The JavaScript app was built on Google’s web app development platform Firebase, using Heroku. As the user base steadily grew, so did the development team. "We outgrew Heroku when we started wanting to have multiple services, and the deploying story got pretty horrendous. We were frustrated that we couldn’t have the developers quickly stage a version," says CEO Riley Eynon-Lynch. "Tracing and monitoring became basically impossible." On top of that, many of Pear Deck’s customers are behind government firewalls and connect through Firebase, not Pear Deck’s servers, making troubleshooting even more difficult. + The three-year-old startup provides a web app for teachers to interact with their students in the classroom. The JavaScript app was built on Google’s web app development platform Firebase, using Heroku. As the user base steadily grew, so did the development team. "We outgrew Heroku when we started wanting to have multiple services, and the deploying story got pretty horrendous. We were frustrated that we couldn’t have the developers quickly stage a version," says CEO Riley Eynon-Lynch. "Tracing and monitoring became basically impossible." On top of that, many of Pear Deck’s customers are behind government firewalls and connect through Firebase, not Pear Deck’s servers, making troubleshooting even more difficult.
diff --git a/content/en/case-studies/wink/index.html b/content/en/case-studies/wink/index.html index 124f1511f8..3f47f8c779 100644 --- a/content/en/case-studies/wink/index.html +++ b/content/en/case-studies/wink/index.html @@ -41,7 +41,7 @@ css: /css/style_wink.css
- "It’s not proprietary, it’s totally open, it’s really portable. You can run all the workloads across different cloud providers. You can easily run a hybrid AWS or even bring in your own data center. That’s the benefit of having everything unified on one open source Kubernetes-Docker-CoreOS Container Linux stack. There are massive security benefits if you only have one Linux distro/machine image to validate. The benefits are enormous because you save money, and you save time.”

- KIT KLEIN, HEAD OF ENGINEERING, WINK + "It’s not proprietary, it’s totally open, it’s really portable. You can run all the workloads across different cloud providers. You can easily run a hybrid AWS or even bring in your own data center. That’s the benefit of having everything unified on one open source Kubernetes-Docker-CoreOS Container Linux stack. There are massive security benefits if you only have one Linux distro/machine image to validate. The benefits are enormous because you save money, and you save time.”

- KIT KLEIN, HEAD OF ENGINEERING, WINK
diff --git a/content/en/community/_index.html b/content/en/community/_index.html index 807faa6565..88cf6b07d5 100644 --- a/content/en/community/_index.html +++ b/content/en/community/_index.html @@ -44,8 +44,8 @@ cid: community 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. + mechanism, reach out to the Kubernetes Code of Conduct Committee + conduct@kubernetes.io. Your anonymity will be protected.

diff --git a/content/en/community/code-of-conduct.md b/content/en/community/code-of-conduct.md index 3defdd4b72..ec85a0cf75 100644 --- a/content/en/community/code-of-conduct.md +++ b/content/en/community/code-of-conduct.md @@ -16,9 +16,9 @@ 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. +Slack, or in another communication mechanism, reach out to +the [Kubernetes Code of Conduct Committee](https://github.com/kubernetes/community/tree/master/committee-code-of-conduct) . +Your anonymity will be protected.
{{< include "/static/cncf-code-of-conduct.md" >}} diff --git a/content/en/community/static/cncf-code-of-conduct.md b/content/en/community/static/cncf-code-of-conduct.md index e332919bca..3ee025ba34 100644 --- a/content/en/community/static/cncf-code-of-conduct.md +++ b/content/en/community/static/cncf-code-of-conduct.md @@ -34,7 +34,8 @@ 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 . +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting +the [Kubernetes Code of Conduct Committee](https://github.com/kubernetes/community/tree/master/committee-code-of-conduct) . This Code of Conduct is adapted from the Contributor Covenant (http://contributor-covenant.org), version 1.2.0, available at diff --git a/content/en/docs/community/_index.md b/content/en/docs/community/_index.md deleted file mode 100644 index c5031a0a48..0000000000 --- a/content/en/docs/community/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "Community" -weight: 80 -menu: - main: - title: "Community" - weight: 30 - post: > -

If you need help, you can connect with other Kubernetes users and the Kubernetes authors, attend community events, and watch video presentations from around the web.

---- - -This section of the Kubernetes documentation surfaces key topics imported from the [kubernetes/community](https://github.com/kubernetes/community) repo. It is the starting point for becoming a contributor -- improving docs, improving code, giving talks etc. diff --git a/content/en/docs/community/devel.md b/content/en/docs/community/devel.md deleted file mode 100644 index cdf8ee6385..0000000000 --- a/content/en/docs/community/devel.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: Kubernetes Developer Guide ---- - -The developer guide is for anyone wanting to either write code which directly accesses the -Kubernetes API, or to contribute directly to the Kubernetes project. -It assumes some familiarity with concepts in the [User Guide](http://kubernetes.io/docs/user-guide/) and the [Cluster Admin -Guide](http://kubernetes.io/docs/admin/). - - -## The process of developing and contributing code to the Kubernetes project - -* **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-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. - -* **Getting Recent Builds** ([getting-builds.md](https://github.com/kubernetes/community/tree/master/contributors/devel/getting-builds.md)): How to get recent builds including the latest builds that pass CI. - -* **Automated Tools** ([automation.md](https://github.com/kubernetes/community/tree/master/contributors/devel/automation.md)): Descriptions of the automation that is running on our github repository. - - -## Setting up your dev environment, coding, and debugging - -* **Development Guide** ([development.md](https://github.com/kubernetes/community/tree/master/contributors/devel/development.md)): Setting up your development environment. - -* **Testing** ([testing.md](https://github.com/kubernetes/community/tree/master/contributors/devel/testing.md)): How to run unit, integration, and end-to-end tests in your development sandbox. - -* **Hunting flaky tests** ([flaky-tests.md](https://github.com/kubernetes/community/tree/master/contributors/devel/flaky-tests.md)): We have a goal of 99.9% flake free tests. - Here's how to run your tests many times. - -* **Logging Conventions** ([logging.md](https://github.com/kubernetes/community/tree/master/contributors/devel/logging.md)): Glog levels. - -* **Profiling Kubernetes** ([profiling.md](https://github.com/kubernetes/community/tree/master/contributors/devel/profiling.md)): How to plug in go pprof profiler to Kubernetes. - -* **Instrumenting Kubernetes with a new metric** - ([instrumentation.md](https://github.com/kubernetes/community/tree/master/contributors/devel/instrumentation.md)): How to add a new metrics to the - Kubernetes code base. - -* **Coding Conventions** ([coding-conventions.md](https://github.com/kubernetes/community/tree/master/contributors/devel/../guide/coding-conventions.md)): - Coding style advice for contributors. - -* **Document Conventions** ([how-to-doc.md](https://github.com/kubernetes/community/tree/master/contributors/devel/how-to-doc.md)) - Document style advice for contributors. - -* **Running a cluster locally** ([running-locally.md](https://github.com/kubernetes/community/tree/master/contributors/devel/running-locally.md)): - A fast and lightweight local cluster deployment for development. - -## Developing against the Kubernetes API - -* The [REST API documentation](http://kubernetes.io/docs/reference/) explains the REST - API exposed by apiserver. - -* **Annotations** ([Annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/)): are for attaching arbitrary non-identifying metadata to objects. - Programs that automate Kubernetes objects may use annotations to store small amounts of their state. - -* **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](/docs/reference/using-api/client-libraries/)): - A list of existing client libraries, both supported and user-contributed. - - -## Writing plugins - -* **Authentication** ([Authentication](http://kubernetes.io/docs/reference/access-authn-authz/authentication/)): - The current and planned states of authentication tokens. - -* **Authorization Plugins** ([Authorization](http://kubernetes.io/docs/reference/access-authn-authz/authorization/)): - Authorization applies to all HTTP requests on the main apiserver port. - This doc explains the available authorization implementations. - -* **Admission Control Plugins** ([admission_control](https://github.com/kubernetes/community/tree/master/contributors/design-proposals/api-machinery/admission_control.md)) - - -## Building releases - -See the [kubernetes/release](https://github.com/kubernetes/release) repository for details on creating releases and related tools and helper scripts. diff --git a/content/en/docs/community/guide.md b/content/en/docs/community/guide.md deleted file mode 100644 index be6bba58ae..0000000000 --- a/content/en/docs/community/guide.md +++ /dev/null @@ -1,248 +0,0 @@ ---- -title: Kubernetes Contributor Guide -owner: sig-contributor-experience -notitle: true ---- - -# Kubernetes Contributor Guide - -## Disclaimer - -Hello! This is the starting point for our brand new contributor guide, currently underway as per [issue#6102](https://github.com/kubernetes/website/issues/6102) and is in need of help. -Please be patient, or fix a section below that needs improvement, and submit a pull request! Feel free to browse the [open issues](https://github.com/kubernetes/community/issues?q=is%3Aissue+is%3Aopen+label%3Aarea%2Fcontributor-guide) and file new ones, all feedback welcome! - - -# Welcome - -Welcome to Kubernetes! This document is the single source of truth for how to contribute to the code base. Please leave comments / suggestions if you find something is missing or incorrect. - -- [Before you get started](#before-you-get-started) - - [Sign the CLA](#sign-the-cla) - - [Code of Conduct](#code-of-conduct) - - [Setting up your development - environment](#setting-up-your-development-environment) - - [Community Expectations and Roles](#community-expectations-and-roles) - - [Thanks](#thanks) -- [Your First Contribution](#your-first-contribution) - - [Find something to work on](#find-something-to-work-on) - - [Find a good first topic](#find-a-good-first-topic) - - [Learn about SIGs](#learn-about-sigs) - - [File an Issue](#file-an-issue) -- [Contributing](#contributing) - - [Communication](#communication) - - [GitHub workflow](#github-workflow) - - [Open a Pull Request](#open-a-pull-request) - - [Code Review](#code-review) - - [Testing](#testing) - - [Security](#security) - - [Documentation](#documentation) - - [Issues Management or Triage](#issues-management-or-triage) -- [Community](#community) - - [Communication](#communication-1) - - [Events](#events) - - [Meetups](#meetups) - - [Mentorship](#mentorship) - -# Before you get started - -## Sign the CLA - -Before you can contribute, you will need to sign the [Contributor License Agreement](https://github.com/kubernetes/community/tree/master/CLA.md). - -## Code of Conduct - -Please make sure to read and observe our [Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). - -## Setting up your development environment - -If you haven’t set up your environment, please find resources [here](https://github.com/kubernetes/community/tree/master/contributors/devel). - -## Community Expectations and Roles - -Kubernetes is a community project. Consequently, it is wholly dependent on its community to provide a productive, friendly and collaborative environment. - -- Read and review the [Community Expectations](https://github.com/kubernetes/community/tree/master/contributors/guide/community-expectations.md) for an understand of code and review expectations. -- See [Community Membership](https://github.com/kubernetes/community/tree/master/community-membership.md) for a list the various responsibilities of contributor roles. You are encouraged to move up this contributor ladder as you gain experience. - -# Your First Contribution - -Have you ever wanted to contribute to the coolest cloud technology? We will help you understand the organization of the Kubernetes project and direct you to the best places to get started. You'll be able to pick up issues, write code to fix them, and get your work reviewed and merged. - -Please be aware that due to the large number of issues our triage team deals with, we cannot offer technical support in GitHub issues. If you have questions about the development process, feel free to jump into our [Slack Channel](http://slack.k8s.io/) or join our [mailing list](https://groups.google.com/forum/#!forum/kubernetes-dev). You can also ask questions on [ServerFault](https://serverfault.com/questions/tagged/kubernetes) or [Stack Overflow](https://stackoverflow.com/questions/tagged/kubernetes). The Kubernetes team scans Stack Overflow on a regular basis and will try to ensure your questions don't go unanswered. - -## Find something to work on - -Help is always welcome! For example, documentation (like the text you are reading now) can always use improvement. There's always code that can be clarified and variables or functions that can be renamed or commented. There's always a need for more test coverage. -You get the idea - if you ever see something you think should be fixed, you should own it. Here is how you get started. - -### Find a good first topic - -There are multiple repositories within the Kubernetes community and a full list of repositories can be found [here](https://github.com/kubernetes/). -Each repository in the Kubernetes organization has beginner-friendly issues that provide a good first issue. For example, [kubernetes/kubernetes](https://git.k8s.io/kubernetes) has [help wanted issues](https://go.k8s.io/help-wanted) that should not need deep knowledge of the system. -Another good strategy is to find a documentation improvement, such as a missing/broken link, which will give you exposure to the code submission/review process without the added complication of technical depth. Please see [Contributing](#contributing) below for the workflow. - -### Learn about SIGs - -#### Sig structure - -You may have noticed that some repositories in the Kubernetes Organization are owned by Special Interest Groups, or SIGs. We organize the Kubernetes community into SIGs in order to improve our workflow and more easily manage what is a very large community project. The developers within each SIG have autonomy and ownership over that SIG's part of Kubernetes. - -Some SIGs also have their own `CONTRIBUTING.md` files, which may contain extra information or guidelines in addition to these general ones. These are located in the SIG-specific community directories. For example: the contributor's guide for SIG CLI is located in the *kubernetes/community* repo, as [`/sig-cli/CONTRIBUTING.md`](https://github.com/kubernetes/community/tree/master/sig-cli/CONTRIBUTING.md). - -Like everything else in Kubernetes, a SIG is an open, community, effort. Anybody is welcome to jump into a SIG and begin fixing issues, critiquing design proposals and reviewing code. SIGs have regular [video meetings](https://kubernetes.io/community/) which everyone is welcome to. Each SIG has a kubernetes slack channel that you can join as well. - -There is an entire SIG ([sig-contributor-experience](https://github.com/kubernetes/community/tree/master/sig-contributor-experience/README.md)) devoted to improving your experience as a contributor. -Contributing to Kubernetes should be easy. If you find a rough edge, let us know! Better yet, help us fix it by joining the SIG; just -show up to one of the [bi-weekly meetings](https://docs.google.com/document/d/1qf-02B7EOrItQgwXFxgqZ5qjW0mtfu5qkYIF1Hl4ZLI/edit). - -#### Find a SIG that is related to your contribution - -Finding the appropriate SIG for your contribution and adding a SIG label will help you ask questions in the correct place and give your contribution higher visibility and a faster community response. - -For Pull Requests, the automatically assigned reviewer will add a SIG label if you haven't done so. See [Open A Pull Request](#open-a-pull-request) below. - -For Issues, we are still working on a more automated workflow. Since SIGs do not directly map onto Kubernetes subrepositories, it may be difficult to find which SIG your contribution belongs in. Here is the [list of SIGs](https://github.com/kubernetes/community/tree/master/sig-list.md). Determine which is most likely related to your contribution. - -*Example:* if you are filing a cni issue, you should choose the [Network SIG](http://git.k8s.io/community/sig-network). Add the SIG label in a comment like so: -``` -/sig network -``` - -Follow the link in the SIG name column to reach each SIGs README. Most SIGs will have a set of GitHub Teams with tags that can be mentioned in a comment on issues and pull requests for higher visibility. If you are not sure about the correct SIG for an issue, you can try SIG-contributor-experience [here](https://github.com/kubernetes/community/tree/master/sig-contributor-experience#github-teams), or [ask in Slack](http://slack.k8s.io/). - -### File an Issue - -Not ready to contribute code, but see something that needs work? While the community encourages everyone to contribute code, it is also appreciated when someone reports an issue (aka problem). Issues should be filed under the appropriate Kubernetes subrepository. -Check the [issue triage guide](https://github.com/kubernetes/community/tree/master/contributors/guide/./issue-triage.md) for more information. - -*Example:* a documentation issue should be opened to [kubernetes/website](https://github.com/kubernetes/website/issues). - -Make sure to adhere to the prompted submission guidelines while opening an issue. - -# Contributing - -Kubernetes is open source, but many of the people working on it do so as their day job. In order to avoid forcing people to be "at work" effectively 24/7, we want to establish some semi-formal protocols around development. Hopefully, these rules make things go more smoothly. If you find that this is not the case, please complain loudly. - -As a potential contributor, your changes and ideas are welcome at any hour of the day or night, weekdays, weekends, and holidays. Please do not ever hesitate to ask a question or send a pull request. - -Our community guiding principles on how to create great code as a big group are found [here](https://github.com/kubernetes/community/tree/master/contributors/devel/collab.md). - -Beginner focused information can be found below in [Open a Pull Request](#open-a-pull-request) and [Code Review](#code-review). - -For quick reference on contributor resources, we have a handy [contributor cheatsheet](https://github.com/kubernetes/community/tree/master/contributors/guide/./contributor-cheatsheet.md) - -### Communication - -It is best to contact your [SIG](#learn-about-sigs) for issues related to the SIG's topic. Your SIG will be able to help you much more quickly than a general question would. - -For general questions and troubleshooting, use the [kubernetes standard lines of communication](https://github.com/kubernetes/community/tree/master/communication.md) and work through the [kubernetes troubleshooting guide](https://kubernetes.io/docs/tasks/debug-application-cluster/troubleshooting/). - -## GitHub workflow - -To check out code to work on, please refer to [this guide](https://github.com/kubernetes/community/tree/master/contributors/guide/./github-workflow.md). - -## Open a Pull Request - -Pull requests are often called simply "PR". Kubernetes generally follows the standard [github pull request](https://help.github.com/articles/about-pull-requests/) process, but there is a layer of additional kubernetes specific (and sometimes SIG specific) differences: - -- [Kubernetes-specific github workflow](https://github.com/kubernetes/community/tree/master/contributors/guide/pull-requests.md#the-testing-and-merge-workflow). - -The first difference you'll see is that a bot will begin applying structured labels to your PR. - -The bot may also make some helpful suggestions for commands to run in your PR to facilitate review. These `/command` options can be entered in comments to trigger auto-labeling and notifications. The command reference is [here](https://go.k8s.io/bot-commands). - -Common new contributor PR issues are: - -* not having correctly signed the CLA ahead of your first PR (see [Sign the CLA](#sign-the-cla) section) -* finding the right SIG or reviewer(s) for the PR (see [Code Review](#code-review) section) and following any SIG specific contributing guidelines -* dealing with test cases which fail on your PR, unrelated to the changes you introduce (see [Test Flakes](http://velodrome.k8s.io/dashboard/db/bigquery-metrics?orgId=1)) -* Not following [scalability good practices](https://github.com/kubernetes/community/tree/master/contributors/guide/scalability-good-practices.md) - -## Code Review - -For a brief description of the importance of code review, please read [On Code Review](https://github.com/kubernetes/community/tree/master/contributors/guide/community-expectations.md#code-review). There are two aspects of code review: giving and receiving. - -To make it easier for your PR to receive reviews, consider the reviewers will need you to: - -* follow the project [coding conventions](https://github.com/kubernetes/community/tree/master/contributors/guide/coding-conventions.md) -* write [good commit messages](https://chris.beams.io/posts/git-commit/) -* break large changes into a logical series of smaller patches which individually make easily understandable changes, and in aggregate solve a broader issue -* label PRs with appropriate SIGs and reviewers: to do this read the messages the bot sends you to guide you through the PR process - -Reviewers, the people giving the review, are highly encouraged to revisit the [Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md) and must go above and beyond to promote a collaborative, respectful Kubernetes community. When reviewing PRs from others [The Gentle Art of Patch Review](http://sage.thesharps.us/2014/09/01/the-gentle-art-of-patch-review/) suggests an iterative series of focuses which is designed to lead new contributors to positive collaboration without inundating them initially with nuances: - -* Is the idea behind the contribution sound? -* Is the contribution architected correctly? -* Is the contribution polished? - -## Testing - -Testing is the responsibility of all contributors and is in part owned by all sigs, but is also coordinated by [sig-testing](https://github.com/kubernetes/community/tree/master/sig-testing). - -The main testing overview document is [here](https://github.com/kubernetes/community/tree/master/contributors/devel/testing.md). - -There are three types of test in kubernetes. The location of the test code varies with type, as does the specifics of the environment needed to successfully run the test: - -* Unit: These confirm that a particular function behaves as intended. Golang includes a native ability for unit testing via the [testing](https://golang.org/pkg/testing/) package. Unit test source code can be found adjacent to the corresponding source code within a given package. For example: functions defined in [kubernetes/cmd/kubeadm/app/util/version.go](https://git.k8s.io/kubernetes/cmd/kubeadm/app/util/version.go) will have unit tests in [kubernetes/cmd/kubeadm/app/util/version_test.go](https://git.k8s.io/kubernetes/cmd/kubeadm/app/util/version_test.go). These are easily run locally by any developer on any OS. -* Integration: These tests cover interactions of package components or interactions between kubernetes components and some other non-kubernetes system resource (eg: etcd). An example would be testing whether a piece of code can correctly store data to or retrieve data from etcd. Integration tests are stored in [kubernetes/test/integration/](https://git.k8s.io/kubernetes/test/integration). Running these can require the developer set up additional functionality on their development system. -* End-to-end ("e2e"): These are broad tests of overall kubernetes system behavior and coherence. These are more complicated as they require a functional kubernetes cluster built from the sources to be tested. A separate document [here](https://github.com/kubernetes/community/tree/master/contributors/devel/e2e-tests.md) details e2e testing and test cases themselves can be found in [kubernetes/test/e2e/](https://git.k8s.io/kubernetes/test/e2e). - -Continuous integration will run these tests either as pre-submits on PRs, post-submits against master/release branches, or both. The results appear on [testgrid](https://testgrid.k8s.io). - -sig-testing is responsible for that official infrastructure and CI. The associated automation is tracked in the [test-infra repo](https://git.k8s.io/test-infra). If you're looking to run e2e tests on your own infrastructure, [kubetest](https://git.k8s.io/test-infra/kubetest) is the mechanism. - -## Security - - -* Please help write this section. - -## Documentation - -- [Contributing to Documentation](https://kubernetes.io/editdocs/) - -## Issues Management or Triage - -Have you ever noticed the total number of [open issues](https://issues.k8s.io)? This number at any given time is typically high. Helping to manage or triage these open issues can be a great contribution to the Kubernetes project. This is also a great opportunity to learn about the various areas of the project. Refer to the [Kubernetes Issue Triage Guidelines](https://github.com/kubernetes/community/tree/master/contributors/devel/issues.md) for more information. - -# Community - -If you haven't noticed by now, we have a large, lively, and friendly open-source community. We depend on new people becoming members and regular code contributors, so we would like you to come join us. To find out more about our community structure, different levels of membership and code contributors, please [explore here](https://github.com/kubernetes/community/tree/master/community-membership.md). - -## Communication - -- [General Information](https://github.com/kubernetes/community/tree/master/communication) - -## Events - -Kubernetes is the main focus of CloudNativeCon/KubeCon, held twice per year in EMEA and in North America. Information about these and other community events is available on the CNCF [events](https://www.cncf.io/events/) pages. - -### Meetups - -We follow the general [Cloud Native Computing Foundation guidelines](https://github.com/cncf/meetups) for Meetups. You may also contact Paris Pittman via direct message on Kubernetes Slack (@paris) or by email (parispittman@google.com) - -## Mentorship - -Please learn about our mentoring initiatives [here](http://git.k8s.io/community/mentoring/README.md). - -# Advanced Topics - -This section includes things that need to be documented, but typical contributors do not need to interact with regularly. - -- [OWNERS files](https://github.com/kubernetes/community/tree/master/contributors/guide/owners.md) - The Kubernetes organizations are managed with OWNERS files, which outline which parts of the code are owned by what groups. -EMEA and in North America. Information about these and other community events is available on the CNCF [events](https://www.cncf.io/events/) pages. - -### Meetups - -_Improvements needed_ -* include link to meetups -* information on CNCF support for founding a Meetup - -### KubeCon - -_Improvements needed_ -* write friendly blurb about KubeCon, and include links - -## Mentorship - -_Improvements needed_ -* Link and mini description for Kubernetes Pilots should go here. diff --git a/content/en/docs/community/keps.md b/content/en/docs/community/keps.md deleted file mode 100644 index 2c277645d3..0000000000 --- a/content/en/docs/community/keps.md +++ /dev/null @@ -1,419 +0,0 @@ ---- -title: Kubernetes Enhancement Proposal Process ---- ---- -kep-number: 1 -title: Kubernetes Enhancement Proposal Process -authors: - - "@calebamiles" - - "@jbeda" -owning-sig: sig-architecture -participating-sigs: - - kubernetes-wide -reviewers: - - name: "@timothysc" -approvers: - - name: "@bgrant0607" -editor: - name: "@jbeda" -creation-date: 2017-08-22 -status: implementable ---- - -# Kubernetes Enhancement Proposal Process - -## Table of Contents - -* [Kubernetes Enhancement Proposal Process](#kubernetes-enhancement-proposal-process) - * [Metadata](#metadata) - * [Table of Contents](#table-of-contents) - * [Summary](#summary) - * [Motivation](#motivation) - * [Reference-level explanation](#reference-level-explanation) - * [What type of work should be tracked by a KEP](#what-type-of-work-should-be-tracked-by-a-kep) - * [KEP Template](#kep-template) - * [KEP Metadata](#kep-metadata) - * [KEP Workflow](#kep-workflow) - * [Git and GitHub Implementation](#git-and-github-implementation) - * [KEP Editor Role](#kep-editor-role) - * [Important Metrics](#important-metrics) - * [Prior Art](#prior-art) - * [Graduation Criteria](#graduation-criteria) - * [Drawbacks](#drawbacks) - * [Alternatives](#alternatives) - * [Unresolved Questions](#unresolved-questions) - * [Mentors](#mentors) - -## Summary - -A standardized development process for Kubernetes is proposed in order to - -- provide a common structure for proposing changes to Kubernetes -- ensure that the motivation for a change is clear -- allow for the enumeration stability milestones and stability graduation - criteria -- persist project information in a Version Control System (VCS) for future - Kubernauts -- support the creation of _high value user facing_ information such as: - - an overall project development roadmap - - motivation for impactful user facing changes -- reserve GitHub issues for tracking work in flight rather than creating "umbrella" - issues -- ensure community participants are successfully able to drive changes to - completion across one or more releases while stakeholders are adequately - represented throughout the process - -This process is supported by a unit of work called a Kubernetes Enhancement Proposal or KEP. -A KEP attempts to combine aspects of a - -- feature, and effort tracking document -- a product requirements document -- design document - -into one file which is created incrementally in collaboration with one or more -Special Interest Groups (SIGs). - -## Motivation - -For cross project SIGs such as SIG PM and SIG Release an abstraction beyond a -single GitHub Issue or Pull request seems to be required in order to understand -and communicate upcoming changes to Kubernetes. In a blog post describing the -[road to Go 2][], Russ Cox explains - -> that it is difficult but essential to describe the significance of a problem -> in a way that someone working in a different environment can understand - -as a project it is vital to be able to track the chain of custody for a proposed -enhancement from conception through implementation. - -Without a standardized mechanism for describing important enhancements our -talented technical writers and product managers struggle to weave a coherent -narrative explaining why a particular release is important. Additionally for -critical infrastructure such as Kubernetes adopters need a forward looking road -map in order to plan their adoption strategy. - -The purpose of the KEP process is to reduce the amount of "tribal knowledge" in -our community. By moving decisions from a smattering of mailing lists, video -calls and hallway conversations into a well tracked artifact this process aims -to enhance communication and discoverability. - -A KEP is broken into sections which can be merged into source control -incrementally in order to support an iterative development process. An important -goal of the KEP process is ensuring that the process for submitting the content -contained in [design proposals][] is both clear and efficient. The KEP process -is intended to create high quality uniform design and implementation documents -for SIGs to deliberate. - -[road to Go 2]: https://blog.golang.org/toward-go2 -[design proposals]: /contributors/design-proposals - - -## Reference-level explanation - -### What type of work should be tracked by a KEP - -The definition of what constitutes an "enhancement" is a foundational concern -for the Kubernetes project. Roughly any Kubernetes user or operator facing -enhancement should follow the KEP process: if an enhancement would be described -in either written or verbal communication to anyone besides the KEP author or -developer then consider creating a KEP. - -Similarly, any technical effort (refactoring, major architectural change) that -will impact a large section of the development community should also be -communicated widely. The KEP process is suited for this even if it will have -zero impact on the typical user or operator. - -As the local bodies of governance, SIGs should have broad latitude in describing -what constitutes an enhancement which should be tracked through the KEP process. -SIGs may find that helpful to enumerate what _does not_ require a KEP rather -than what does. SIGs also have the freedom to customize the KEP template -according to their SIG specific concerns. For example the KEP template used to -track API changes will likely have different subsections than the template for -proposing governance changes. However, as changes start impacting other SIGs or -the larger developer community outside of a SIG, the KEP process should be used -to coordinate and communicate. - -Enhancements that have major impacts on multiple SIGs should use the KEP process. -A single SIG will own the KEP but it is expected that the set of approvers will span the impacted SIGs. -The KEP process is the way that SIGs can negotiate and communicate changes that cross boundaries. - -KEPs will also be used to drive large changes that will cut across all parts of the project. -These KEPs will be owned by SIG-architecture and should be seen as a way to communicate the most fundamental aspects of what Kubernetes is. - -### KEP Template - -The template for a KEP is precisely defined [here](https://github.com/kubernetes/community/tree/master/keps/0000-kep-template.md) - -### KEP Metadata - -There is a place in each KEP for a YAML document that has standard metadata. -This will be used to support tooling around filtering and display. It is also -critical to clearly communicate the status of a KEP. - -Metadata items: -* **kep-number** Required - * Each proposal has a number. This is to make all references to proposals as - clear as possible. This is especially important as we create a network - cross references between proposals. - * Before having the `Approved` status, the number for the KEP will be in the - form of `draft-YYYYMMDD`. The `YYYYMMDD` is replaced with the current date - when first creating the KEP. The goal is to enable fast parallel merges of - pre-acceptance KEPs. - * On acceptance a sequential dense number will be assigned. This will be done - by the editor and will be done in such a way as to minimize the chances of - conflicts. The final number for a KEP will have no prefix. -* **title** Required - * The title of the KEP in plain language. The title will also be used in the - KEP filename. See the template for instructions and details. -* **status** Required - * The current state of the KEP. - * Must be one of `provisional`, `implementable`, `implemented`, `deferred`, `rejected`, `withdrawn`, or `replaced`. -* **authors** Required - * A list of authors for the KEP. - This is simply the github ID. - In the future we may enhance this to include other types of identification. -* **owning-sig** Required - * The SIG that is most closely associated with this KEP. If there is code or - other artifacts that will result from this KEP, then it is expected that - this SIG will take responsibility for the bulk of those artifacts. - * Sigs are listed as `sig-abc-def` where the name matches up with the - directory in the `kubernetes/community` repo. -* **participating-sigs** Optional - * A list of SIGs that are involved or impacted by this KEP. - * A special value of `kubernetes-wide` will indicate that this KEP has impact - across the entire project. -* **reviewers** Required - * Reviewer(s) chosen after triage according to proposal process - * If not yet chosen replace with `TBD` - * Same name/contact scheme as `authors` - * Reviewers should be a distinct set from authors. -* **approvers** Required - * Approver(s) chosen after triage according to proposal process - * Approver(s) are drawn from the impacted SIGs. - It is up to the individual SIGs to determine how they pick approvers for KEPs impacting them. - The approvers are speaking for the SIG in the process of approving this KEP. - The SIGs in question can modify this list as necessary. - * The approvers are the individuals that make the call to move this KEP to the `approved` state. - * Approvers should be a distinct set from authors. - * If not yet chosen replace with `TBD` - * Same name/contact scheme as `authors` -* **editor** Required - * Someone to keep things moving forward. - * If not yet chosen replace with `TBD` - * Same name/contact scheme as `authors` -* **creation-date** Required - * The date that the KEP was first submitted in a PR. - * In the form `yyyy-mm-dd` - * While this info will also be in source control, it is helpful to have the set of KEP files stand on their own. -* **last-updated** Optional - * The date that the KEP was last changed significantly. - * In the form `yyyy-mm-dd` -* **see-also** Optional - * A list of other KEPs that are relevant to this KEP. - * In the form `KEP-123` -* **replaces** Optional - * A list of KEPs that this KEP replaces. Those KEPs should list this KEP in - their `superseded-by`. - * In the form `KEP-123` -* **superseded-by** - * A list of KEPs that supersede this KEP. Use of this should be paired with - this KEP moving into the `Replaced` status. - * In the form `KEP-123` - - -### KEP Workflow - -A KEP has the following states - -- `provisional`: The KEP has been proposed and is actively being defined. - This is the starting state while the KEP is being fleshed out and actively defined and discussed. - The owning SIG has accepted that this is work that needs to be done. -- `implementable`: The approvers have approved this KEP for implementation. -- `implemented`: The KEP has been implemented and is no longer actively changed. -- `deferred`: The KEP is proposed but not actively being worked on. -- `rejected`: The approvers and authors have decided that this KEP is not moving forward. - The KEP is kept around as a historical document. -- `withdrawn`: The KEP has been withdrawn by the authors. -- `replaced`: The KEP has been replaced by a new KEP. - The `superseded-by` metadata value should point to the new KEP. - -### Git and GitHub Implementation - -KEPs are checked into the community repo under the `/kep` directory. -In the future, as needed we can add SIG specific subdirectories. -KEPs in SIG specific subdirectories have limited impact outside of the SIG and can leverage SIG specific OWNERS files. - -New KEPs can be checked in with a file name in the form of `draft-YYYYMMDD-my-title.md`. -As significant work is done on the KEP the authors can assign a KEP number. -This is done by taking the next number in the NEXT_KEP_NUMBER file, incrementing that number, and renaming the KEP. -No other changes should be put in that PR so that it can be approved quickly and minimize merge conflicts. -The KEP number can also be done as part of the initial submission if the PR is likely to be uncontested and merged quickly. - -### KEP Editor Role - -Taking a cue from the [Python PEP process][], we define the role of a KEP editor. -The job of an KEP editor is likely very similar to the [PEP editor responsibilities][] and will hopefully provide another opportunity for people who do not write code daily to contribute to Kubernetes. - -In keeping with the PEP editors which - -> Read the PEP to check if it is ready: sound and complete. The ideas must make -> technical sense, even if they don't seem likely to be accepted. -> The title should accurately describe the content. -> Edit the PEP for language (spelling, grammar, sentence structure, etc.), markup -> (for reST PEPs), code style (examples should match PEP 8 & 7). - -KEP editors should generally not pass judgement on a KEP beyond editorial corrections. -KEP editors can also help inform authors about the process and otherwise help things move smoothly. - -[Python PEP process]: https://www.python.org/dev/peps/pep-0001/ -[PEP editor responsibilities]: https://www.python.org/dev/peps/pep-0001/#pep-editor-responsibilities-workflow - -### Important Metrics - -It is proposed that the primary metrics which would signal the success or -failure of the KEP process are - -- how many "enhancements" are tracked with a KEP -- distribution of time a KEP spends in each state -- KEP rejection rate -- PRs referencing a KEP merged per week -- number of issued open which reference a KEP -- number of contributors who authored a KEP -- number of contributors who authored a KEP for the first time -- number of orphaned KEPs -- number of retired KEPs -- number of superseded KEPs - -### Prior Art - -The KEP process as proposed was essentially stolen from the [Rust RFC process][] which -itself seems to be very similar to the [Python PEP process][] - -[Rust RFC process]: https://github.com/rust-lang/rfcs - -## Drawbacks - -Any additional process has the potential to engender resentment within the -community. There is also a risk that the KEP process as designed will not -sufficiently address the scaling challenges we face today. PR review bandwidth is -already at a premium and we may find that the KEP process introduces an unreasonable -bottleneck on our development velocity. - -It certainly can be argued that the lack of a dedicated issue/defect tracker -beyond GitHub issues contributes to our challenges in managing a project as large -as Kubernetes, however, given that other large organizations, including GitHub -itself, make effective use of GitHub issues perhaps the argument is overblown. - -The centrality of Git and GitHub within the KEP process also may place too high -a barrier to potential contributors, however, given that both Git and GitHub are -required to contribute code changes to Kubernetes today perhaps it would be reasonable -to invest in providing support to those unfamiliar with this tooling. - -Expanding the proposal template beyond the single sentence description currently -required in the [features issue template][] may be a heavy burden for non native -English speakers and here the role of the KEP editor combined with kindness and -empathy will be crucial to making the process successful. - -[features issue template]: https://git.k8s.io/features/ISSUE_TEMPLATE.md - -## Alternatives - -This KEP process is related to -- the generation of a [architectural roadmap][] -- the fact that the [what constitutes a feature][] is still undefined -- [issue management][] -- the difference between an [accepted design and a proposal][] -- [the organization of design proposals][] - -this proposal attempts to place these concerns within a general framework. - -[architectural roadmap]: https://github.com/kubernetes/community/issues/952 -[what constitutes a feature]: https://github.com/kubernetes/community/issues/531 -[issue management]: https://github.com/kubernetes/community/issues/580 -[accepted design and a proposal]: https://github.com/kubernetes/community/issues/914 -[the organization of design proposals]: https://github.com/kubernetes/community/issues/918 - -### Github issues vs. KEPs - -The use of GitHub issues when proposing changes does not provide SIGs good -facilities for signaling approval or rejection of a proposed change to Kubernetes -since anyone can open a GitHub issue at any time. Additionally managing a proposed -change across multiple releases is somewhat cumbersome as labels and milestones -need to be updated for every release that a change spans. These long lived GitHub -issues lead to an ever increasing number of issues open against -`kubernetes/features` which itself has become a management problem. - -In addition to the challenge of managing issues over time, searching for text -within an issue can be challenging. The flat hierarchy of issues can also make -navigation and categorization tricky. While not all community members might -not be comfortable using Git directly, it is imperative that as a community we -work to educate people on a standard set of tools so they can take their -experience to other projects they may decide to work on in the future. While -git is a fantastic version control system (VCS), it is not a project management -tool nor a cogent way of managing an architectural catalog or backlog; this -proposal is limited to motivating the creation of a standardized definition of -work in order to facilitate project management. This primitive for describing -a unit of work may also allow contributors to create their own personalized -view of the state of the project while relying on Git and GitHub for consistency -and durable storage. - -## Unresolved Questions - -- How reviewers and approvers are assigned to a KEP -- Example schedule, deadline, and time frame for each stage of a KEP -- Communication/notification mechanisms -- Review meetings and escalation procedure - roadmap][] -- the fact that the [what constitutes a feature][] is still undefined -- [issue management][] -- the difference between an [accepted design and a proposal][] -- [the organization of design proposals][] - -this proposal attempts to place these concerns within a general framework. - -[architectural roadmap]: https://github.com/kubernetes/community/issues/952 -[what constitutes a feature]: https://github.com/kubernetes/community/issues/531 -[issue management]: https://github.com/kubernetes/community/issues/580 -[accepted design and a proposal]: https://github.com/kubernetes/community/issues/914 -[the organization of design proposals]: https://github.com/kubernetes/community/issues/918 - -### Github issues vs. KEPs - -The use of GitHub issues when proposing changes does not provide SIGs good -facilities for signaling approval or rejection of a proposed change to Kubernetes -since anyone can open a GitHub issue at any time. Additionally managing a proposed -change across multiple releases is somewhat cumbersome as labels and milestones -need to be updated for every release that a change spans. These long lived GitHub -issues lead to an ever increasing number of issues open against -`kubernetes/features` which itself has become a management problem. - -In addition to the challenge of managing issues over time, searching for text -within an issue can be challenging. The flat hierarchy of issues can also make -navigation and categorization tricky. While not all community members might -not be comfortable using Git directly, it is imperative that as a community we -work to educate people on a standard set of tools so they can take their -experience to other projects they may decide to work on in the future. While -git is a fantastic version control system (VCS), it is not a project management -tool nor a cogent way of managing an architectural catalog or backlog; this -proposal is limited to motivating the creation of a standardized definition of -work in order to facilitate project management. This primitive for describing -a unit of work may also allow contributors to create their own personalized -view of the state of the project while relying on Git and GitHub for consistency -and durable storage. - -## Unresolved Questions - -- How reviewers and approvers are assigned to a KEP -- Approval decision process for a KEP -- Example schedule, deadline, and time frame for each stage of a KEP -- Communication/notification mechanisms -- Review meetings and escalation procedure -- Decision on where development should occur - -## Mentors - -- caleb miles - - github: [calebamiles](https://github.com/calebamiles/) - - slack: [calebamiles](https://coreos.slack.com/team/caleb.miles) - - email: [caleb.miles@coreos.com](mailto:caleb.miles@coreos.com) - - pronoun: "he" diff --git a/content/en/docs/community/mentoring.md b/content/en/docs/community/mentoring.md deleted file mode 100644 index a156146db4..0000000000 --- a/content/en/docs/community/mentoring.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Kubernetes Mentoring Initiatives -notitle: true ---- - -# Kubernetes Mentoring Initiatives - -This folder will be used for all mentoring initiatives for Kubernetes. - ---- -## Kubernetes Pilots - -We understand that everyone has different learning styles and we want to support as many of those as possible. Mentoring is vital to the growth of an individual and organization of every kind. For Kubernetes, the larger the project becomes, it's necessary to keep a continuous pipeline of quality contributors. - -*What's a Pilot?* -A pilot is a Kubernetes mentor helping new and current members navigate the seas of our repos. - -## Current mentoring activities: -All are currently in an incubation phase. Please reach out to Paris Pittman (parispittman@google.com or Paris on Kubernetes slack channel) for more information on how to get involved. - -Mentors On Demand -* [Meet Our Contributors](https://github.com/kubernetes/community/tree/master/mentoring/meet-our-contributors.md) - -Long Term Contributor Ladder Growth -* [Group Mentoring Cohorts](https://github.com/kubernetes/community/tree/master/mentoring/group-mentoring.md) - -Students -* [Outreachy](https://github.com/kubernetes/community/tree/master/sig-cli/outreachy.md) -* [Google Summer of Code](https://github.com/kubernetes/community/tree/master/mentoring/google-summer-of-code.md) - -#### Inspiration and Thanks -This is not an out of the box program but was largely inspired by the following: -* [Ada Developer Academy](https://adadevelopersacademy.org/) -* [Apache Mentoring Programme](https://community.apache.org/mentoringprogramme.html) -* [exercism.io](https://github.com/OperationCode/exercism-io-mentoring) -* [Google Summer of Code](https://developers.google.com/open-source/gsoc/) -* [Outreachy](https://www.outreachy.org/) -* [OpenStack Mentoring](https://wiki.openstack.org/wiki/Mentoring) - -Thanks to: -* the many contributors who reviewed and participated in brainstorming, -* founding mentees for their willingness to try this out, -* founding Pilots (@chrislovecnm, @luxas, @kow3ns) - -We welcome PRs, suggestions, and help! - try this out, -* founding Pilots (@chrislovecnm, @luxas, @kow3ns) - -We welcome PRs, suggestions, and help! diff --git a/content/en/docs/concepts/cluster-administration/manage-deployment.md b/content/en/docs/concepts/cluster-administration/manage-deployment.md index eb01056679..c50f54ce23 100644 --- a/content/en/docs/concepts/cluster-administration/manage-deployment.md +++ b/content/en/docs/concepts/cluster-administration/manage-deployment.md @@ -63,7 +63,7 @@ Resource creation isn't the only operation that `kubectl` can perform in bulk. I ```shell $ kubectl delete -f https://k8s.io/examples/application/nginx-app.yaml -deployment "my-nginx" deleted +deployment.apps "my-nginx" deleted service "my-nginx-svc" deleted ``` @@ -117,9 +117,9 @@ Instead, specify the `--recursive` or `-R` flag with the `--filename,-f` flag as ```shell $ kubectl create -f project/k8s/development --recursive -configmap "my-config" created -deployment "my-deployment" created -persistentvolumeclaim "my-pvc" created +configmap/my-config created +deployment.apps/my-deployment created +persistentvolumeclaim/my-pvc created ``` The `--recursive` flag works with any operation that accepts the `--filename,-f` flag such as: `kubectl {create,get,delete,describe,rollout} etc.` @@ -128,11 +128,11 @@ The `--recursive` flag also works when multiple `-f` arguments are provided: ```shell $ kubectl create -f project/k8s/namespaces -f project/k8s/development --recursive -namespace "development" created -namespace "staging" created -configmap "my-config" created -deployment "my-deployment" created -persistentvolumeclaim "my-pvc" created +namespace/development created +namespace/staging created +configmap/my-config created +deployment.apps/my-deployment created +persistentvolumeclaim/my-pvc created ``` If you're interested in learning more about `kubectl`, go ahead and read [kubectl Overview](/docs/reference/kubectl/overview/). diff --git a/content/en/docs/concepts/cluster-administration/networking.md b/content/en/docs/concepts/cluster-administration/networking.md index 7ee3861759..924b72fd76 100644 --- a/content/en/docs/concepts/cluster-administration/networking.md +++ b/content/en/docs/concepts/cluster-administration/networking.md @@ -201,6 +201,10 @@ sysctl net.ipv4.ip_forward=1 The result of all this is that all `Pods` can reach each other and can egress traffic to the internet. +### Jaguar + +[Jaguar](https://gitlab.com/sdnlab/jaguar) is an open source solution for Kubernetes's network based on OpenDaylight. Jaguar provides overlay network using vxlan and Jaguar CNIPlugin provides one IP address per pod. + ### Knitter [Knitter](https://github.com/ZTE/Knitter/) is a network solution which supports multiple networking in Kubernetes. It provides the ability of tenant management and network management. Knitter includes a set of end-to-end NFV container networking solutions besides multiple network planes, such as keeping IP address for applications, IP address migration, etc. @@ -273,6 +277,11 @@ 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. +### Jaguar + +[Jaguar](https://gitlab.com/sdnlab/jaguar) is an open source solution for Kubernetes's network based on OpenDaylight. +Jaguar provides overlay network using vxlan and Jaguar CNIPlugin provides one IP address per pod. + {{% /capture %}} {{% capture whatsnext %}} 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 6478279d19..86c2faa1fe 100644 --- a/content/en/docs/concepts/configuration/manage-compute-resources-container.md +++ b/content/en/docs/concepts/configuration/manage-compute-resources-container.md @@ -366,7 +366,9 @@ spec: ### How Pods with ephemeral-storage requests are scheduled When you create a Pod, the Kubernetes scheduler selects a node for the Pod to -run on. Each node has a maximum amount of local ephemeral storage it can provide for Pods. (For more information, see ["Node Allocatable"](/docs/tasks/administer-cluster/reserve-compute-resources/#node-allocatable) The scheduler ensures that the sum of the resource requests of the scheduled Containers is less than the capacity of the node. +run on. Each node has a maximum amount of local ephemeral storage it can provide for Pods. For more information, see ["Node Allocatable"](/docs/tasks/administer-cluster/reserve-compute-resources/#node-allocatable). + +The scheduler ensures that the sum of the resource requests of the scheduled Containers is less than the capacity of the node. ### How Pods with ephemeral-storage limits run diff --git a/content/en/docs/concepts/configuration/pod-priority-preemption.md b/content/en/docs/concepts/configuration/pod-priority-preemption.md index f94f42f84d..6349a0b56a 100644 --- a/content/en/docs/concepts/configuration/pod-priority-preemption.md +++ b/content/en/docs/concepts/configuration/pod-priority-preemption.md @@ -202,7 +202,7 @@ spec: In Kubernetes 1.9 and later, when Pod priority is enabled, scheduler orders pending Pods by their priority and a pending Pod is placed ahead of other pending Pods with lower priority in the scheduling queue. As a result, the -higher priority Pod may by scheduled sooner that Pods with lower priority if its +higher priority Pod may be scheduled sooner than Pods with lower priority if its scheduling requirements are met. If such Pod cannot be scheduled, scheduler will continue and tries to schedule other lower priority Pods. diff --git a/content/en/docs/concepts/containers/runtime-class.md b/content/en/docs/concepts/containers/runtime-class.md index eef2a4f006..dfb75ab724 100644 --- a/content/en/docs/concepts/containers/runtime-class.md +++ b/content/en/docs/concepts/containers/runtime-class.md @@ -1,3 +1,4 @@ +<<<<<<< HEAD --- reviewers: - tallclair @@ -120,3 +121,128 @@ If no `runtimeClassName` is specified, the default RuntimeHandler will be used, to the behavior when the RuntimeClass feature is disabled. {{% /capture %}} +||||||| merged common ancestors +======= +--- +reviewers: +- tallclair +- dchen1107 +title: Runtime Class +content_template: templates/concept +weight: 20 +--- + +{{% capture overview %}} + +{{< feature-state for_k8s_version="v1.12" state="alpha" >}} + +This page describes the RuntimeClass resource and runtime selection mechanism. + +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + +## Runtime Class + +RuntimeClass is an alpha feature for selecting the container runtime configuration to use to run a +pod's containers. + +### Set Up + +As an early alpha feature, there are some additional setup steps that must be taken in order to use +the RuntimeClass feature: + +1. Enable the RuntimeClass feature gate (on apiservers & kubelets, requires version 1.12+) +2. Install the RuntimeClass CRD +3. Configure the CRI implementation on nodes (runtime dependent) +4. Create the corresponding RuntimeClass resources + +#### 1. Enable the RuntimeClass feature gate + +See [Feature Gates](/docs/reference/command-line-tools-reference/feature-gates/) for an explanation +of enabling feature gates. The `RuntimeClass` feature gate must be enabled on apiservers _and_ +kubelets. + +#### 2. Install the RuntimeClass CRD + +The RuntimeClass [CustomResourceDefinition][] (CRD) can be found in the addons directory of the +Kubernetes git repo: [kubernetes/cluster/addons/runtimeclass/runtimeclass_crd.yaml][runtimeclass_crd] + +Install the CRD with `kubectl apply -f runtimeclass_crd.yaml`. + +[CustomResourceDefinition]: /docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/ +[runtimeclass_crd]: https://github.com/kubernetes/kubernetes/tree/master/cluster/addons/runtimeclass/runtimeclass_crd.yaml + + +#### 3. Configure the CRI implementation on nodes + +The configurations to select between with RuntimeClass are CRI implementation dependent. See the +corresponding documentation for your CRI implementation for how to configure. As this is an alpha +feature, not all CRIs support multiple RuntimeClasses yet. + +{{< note >}} +**Note:** RuntimeClass currently assumes a homogeneous node configuration across the cluster +(which means that all nodes are configured the same way with respect to container runtimes). Any heterogeneity (varying configurations) must be +managed independently of RuntimeClass through scheduling features (see [Assigning Pods to +Nodes](/docs/concepts/configuration/assign-pod-node/)). +{{< /note >}} + +The configurations have a corresponding `RuntimeHandler` name, referenced by the RuntimeClass. The +RuntimeHandler must be a valid DNS 1123 subdomain (alpha-numeric + `-` and `.` characters). + +#### 4. Create the corresponding RuntimeClass resources + +The configurations setup in step 3 should each have an associated `RuntimeHandler` name, which +identifies the configuration. For each RuntimeHandler (and optionally the empty `""` handler), +create a corresponding RuntimeClass object. + +The RuntimeClass resource currently only has 2 significant fields: the RuntimeClass name +(`metadata.name`) and the RuntimeHandler (`spec.runtimeHandler`). The object definition looks like this: + +```yaml +apiVersion: node.k8s.io/v1alpha1 # RuntimeClass is defined in the node.k8s.io API group +kind: RuntimeClass +metadata: + name: myclass # The name the RuntimeClass will be referenced by + # RuntimeClass is a non-namespaced resource +spec: + runtimeHandler: myconfiguration # The name of the corresponding CRI configuration +``` + + +{{< note >}} + +**Note:** It is recommended that RuntimeClass write operations (create/update/patch/delete) be +restricted to the cluster administrator. This is typically the default. See [Authorization +Overview](https://kubernetes.io/docs/reference/access-authn-authz/authorization/) for more details. + +{{< /note >}} + +### Usage + +Once RuntimeClasses are configured for the cluster, using them is very simple. Specify a +`runtimeClassName` in the Pod spec. For example: + +```yaml +apiVersion: v1 +kind: Pod +metadata: + name: mypod +spec: + runtimeClassName: myclass + # ... +``` + +This will instruct the Kubelet to use the named RuntimeClass to run this pod. If the named +RuntimeClass does not exist, or the CRI cannot run the corresponding handler, the pod will enter the +`Failed` terminal [phase](/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase). Look for a +corresponding [event](/docs/tasks/debug-application-cluster/debug-application-introspection/) for an +error message. + +If no `runtimeClassName` is specified, the default RuntimeHandler will be used, which is equivalent +to the behavior when the RuntimeClass feature is disabled. + +{{% /capture %}} +>>>>>>> master 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 22886908c7..e2f521a806 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 @@ -84,8 +84,8 @@ For example: #### Support traffic shaping -The CNI networking plugin also supports pod ingress and egress traffic shaping. You can use the officical [bandwidth](https://github.com/containernetworking/plugins/tree/master/plugins/meta/bandwidth) -plugin offered by the CNI plugin team or use your own plugin with bandwidth contol functionality. +The CNI networking plugin also supports pod ingress and egress traffic shaping. You can use the official [bandwidth](https://github.com/containernetworking/plugins/tree/master/plugins/meta/bandwidth) +plugin offered by the CNI plugin team or use your own plugin with bandwidth control functionality. If you want to enable traffic shaping support, you must add a `bandwidth` plugin to your CNI configuration file (default `/etc/cni/net.d`). diff --git a/content/en/docs/concepts/extend-kubernetes/extend-cluster.md b/content/en/docs/concepts/extend-kubernetes/extend-cluster.md index 9172616e2e..8b04771a07 100644 --- a/content/en/docs/concepts/extend-kubernetes/extend-cluster.md +++ b/content/en/docs/concepts/extend-kubernetes/extend-cluster.md @@ -132,7 +132,7 @@ Adding an API does not directly let you affect the behavior of existing APIs (e. ### API Access Extensions -When a request reaches the Kubernetes API Server, it is first Authenticated, then Authorized, then subject to various types of Admission Control. See [Controlling Access to the Kubernetes API](/docs/reference/access-authn-authz/controlling-access/)] for more on this flow. +When a request reaches the Kubernetes API Server, it is first Authenticated, then Authorized, then subject to various types of Admission Control. See [Controlling Access to the Kubernetes API](/docs/reference/access-authn-authz/controlling-access/) for more on this flow. Each of these steps offers extension points. @@ -207,7 +207,7 @@ the nodes chosen for a pod. * [Device Plugins](/docs/concepts/cluster-administration/device-plugins/) * Learn about [kubectl plugins](/docs/tasks/extend-kubectl/kubectl-plugins/) * See examples of Automation - * [List of Operators](https://github.com/coreos/awesome-kubernetes-extensions) + * [List of Operators](https://github.com/operator-framework/awesome-operators) {{% /capture %}} diff --git a/content/en/docs/concepts/policy/pod-security-policy.md b/content/en/docs/concepts/policy/pod-security-policy.md index 8570ea99a3..93d959144a 100644 --- a/content/en/docs/concepts/policy/pod-security-policy.md +++ b/content/en/docs/concepts/policy/pod-security-policy.md @@ -481,7 +481,7 @@ spec: ### Users and groups -**RunAsUser** - Controls the what user ID containers run as. +**RunAsUser** - Controls which user ID the containers are run with. - *MustRunAs* - Requires at least one `range` to be specified. Uses the minimum value of the first range as the default. Validates against all ranges. @@ -491,7 +491,7 @@ image. No default provided. Setting `allowPrivilegeEscalation=false` is strongly recommended with this strategy. - *RunAsAny* - No default provided. Allows any `runAsUser` to be specified. -**RunAsGroup** - Controls the what primary group ID containers run as. +**RunAsGroup** - Controls which primary group ID the containers are run with. - *MustRunAs* - Requires at least one `range` to be specified. Uses the minimum value of the first range as the default. Validates against all ranges. @@ -613,4 +613,4 @@ default cannot be changed. Controlled via annotations on the PodSecurityPolicy. Refer to the [Sysctl documentation]( /docs/concepts/cluster-administration/sysctl-cluster/#podsecuritypolicy-annotations). -{{% /capture %}} +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/concepts/policy/resource-quotas.md b/content/en/docs/concepts/policy/resource-quotas.md index 55c9a68800..5fbc36c45e 100644 --- a/content/en/docs/concepts/policy/resource-quotas.md +++ b/content/en/docs/concepts/policy/resource-quotas.md @@ -568,7 +568,7 @@ For example: values: ["cluster-services"] ``` -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. +See [LimitedResources](https://github.com/kubernetes/kubernetes/pull/36765) and [Quota support for priority class design doc](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/scheduling/pod-priority-resourcequota.md) for more information. ## Example @@ -580,4 +580,4 @@ See a [detailed example for how to use resource quota](/docs/tasks/administer-cl See [ResourceQuota design doc](https://git.k8s.io/community/contributors/design-proposals/resource-management/admission_control_resource_quota.md) for more information. -{{% /capture %}} +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/concepts/services-networking/connect-applications-service.md b/content/en/docs/concepts/services-networking/connect-applications-service.md index 0f22a568c6..730ec739c5 100644 --- a/content/en/docs/concepts/services-networking/connect-applications-service.md +++ b/content/en/docs/concepts/services-networking/connect-applications-service.md @@ -65,7 +65,7 @@ You can create a Service for your 2 nginx replicas with `kubectl expose`: ```shell $ kubectl expose deployment/my-nginx -service "my-nginx" exposed +service/my-nginx exposed ``` This is equivalent to `kubectl create -f` the following yaml: @@ -213,7 +213,7 @@ You can acquire all these from the [nginx https example](https://github.com/kube ```shell $ make keys secret KEY=/tmp/nginx.key CERT=/tmp/nginx.crt SECRET=/tmp/secret.json $ kubectl create -f /tmp/secret.json -secret "nginxsecret" created +secret/nginxsecret created $ kubectl get secrets NAME TYPE DATA AGE default-token-il9rc kubernetes.io/service-account-token 1 1d diff --git a/content/en/docs/concepts/services-networking/ingress.md b/content/en/docs/concepts/services-networking/ingress.md index ab53f30934..b61141909c 100644 --- a/content/en/docs/concepts/services-networking/ingress.md +++ b/content/en/docs/concepts/services-networking/ingress.md @@ -48,7 +48,7 @@ It can be configured to give services externally-reachable URLs, load balance tr Before you start using the Ingress resource, there are a few things you should understand. The Ingress is a beta resource, not available in any Kubernetes release prior to 1.1. You need an Ingress controller to satisfy an Ingress, simply creating the resource will have no effect. -GCE/Google Kubernetes Engine deploys an ingress controller on the master. You can deploy any number of custom ingress controllers in a pod. You must annotate each ingress with the appropriate class, as indicated [here](https://git.k8s.io/ingress#running-multiple-ingress-controllers) and [here](https://git.k8s.io/ingress-gce/BETA_LIMITATIONS.md#disabling-glbc). +GCE/Google Kubernetes Engine deploys an ingress controller on the master. You can deploy any number of custom ingress controllers in a pod. You must annotate each ingress with the appropriate class, as indicated [here](https://git.k8s.io/ingress-nginx/docs/user-guide/multiple-ingress.md#multiple-ingress-controllers) and [here](https://git.k8s.io/ingress-gce/examples/PREREQUISITES.md#ingress-class). Make sure you review the [beta limitations](https://github.com/kubernetes/ingress-gce/blob/master/BETA_LIMITATIONS.md#glbc-beta-limitations) of this controller. In environments other than GCE/Google Kubernetes Engine, you need to [deploy a controller](https://git.k8s.io/ingress-nginx/README.md) as a pod. diff --git a/content/en/docs/concepts/services-networking/service.md b/content/en/docs/concepts/services-networking/service.md index ce529a53bf..9423fc26f9 100644 --- a/content/en/docs/concepts/services-networking/service.md +++ b/content/en/docs/concepts/services-networking/service.md @@ -173,8 +173,6 @@ By default, the choice of backend is round robin. ![Services overview diagram for userspace proxy](/images/docs/services-userspace-overview.svg) -Note that in the above diagram, `clusterIP` is shown as `ServiceIP`. - ### Proxy-mode: iptables In this mode, kube-proxy watches the Kubernetes master for the addition and @@ -192,8 +190,6 @@ having working [readiness probes](/docs/tasks/configure-pod-container/configure- ![Services overview diagram for iptables proxy](/images/docs/services-iptables-overview.svg) -Note that in the above diagram, `clusterIP` is shown as `ServiceIP`. - ### Proxy-mode: ipvs {{< feature-state for_k8s_version="v1.9" state="beta" >}} diff --git a/content/en/docs/concepts/workloads/controllers/deployment.md b/content/en/docs/concepts/workloads/controllers/deployment.md index eefe7895ef..8bc7f2f73b 100644 --- a/content/en/docs/concepts/workloads/controllers/deployment.md +++ b/content/en/docs/concepts/workloads/controllers/deployment.md @@ -66,9 +66,9 @@ In this example: * The Pods are labeled `app: nginx`using the `labels` field. * The Pod template's specification, or `.template.spec` field, indicates that the Pods run one container, `nginx`, which runs the `nginx` - [Docker Hub](https://hub.docker.com/) image at version 1.7.9. + [Docker Hub](https://hub.docker.com/) image at version 1.15.4. * Create one container and name it `nginx` using the `name` field. - * Run the `nginx` image at version `1.7.9`. + * Run the `nginx` image at version `1.15.4`. * Open port `80` so that the container can send and accept traffic. To create this Deployment, run the following command: @@ -78,9 +78,7 @@ kubectl create -f https://k8s.io/examples/controllers/nginx-deployment.yaml ``` {{< note >}} -**Note:** You can append `--record` to this command to record the current command in the annotations of -the created or updated resource. This is useful for future review, such as investigating which -commands were executed in each Deployment revision. +**Note:** You may specify the `--record` flag to write the command executed in the resource annotation `kubernetes.io/change-cause`. It is useful for future instrospection, for example to see the commands executed in each Deployment revision. {{< /note >}} Next, run `kubectl get deployments`. The output is similar to the following: @@ -173,15 +171,15 @@ Suppose that you now want to update the nginx Pods to use the `nginx:1.9.1` imag instead of the `nginx:1.7.9` image. ```shell -$ kubectl set image deployment/nginx-deployment nginx=nginx:1.9.1 -deployment.extensions/nginx-deployment image updated +$ kubectl set image deployment/nginx-deployment nginx=nginx:1.9.1 --record +deployment.apps/nginx-deployment image updated ``` Alternatively, you can `edit` the Deployment and change `.spec.template.spec.containers[0].image` from `nginx:1.7.9` to `nginx:1.9.1`: ```shell $ kubectl edit deployment/nginx-deployment -deployment.extensions/nginx-deployment edited +deployment.apps/nginx-deployment edited ``` To see the rollout status, run: @@ -189,7 +187,7 @@ To see the rollout status, run: ```shell $ kubectl rollout status deployment/nginx-deployment Waiting for rollout to finish: 2 out of 3 new replicas have been updated... -deployment.extensions/nginx-deployment successfully rolled out +deployment.apps/nginx-deployment successfully rolled out ``` After the rollout succeeds, you may want to `get` the Deployment: @@ -340,7 +338,7 @@ Suppose that you made a typo while updating the Deployment, by putting the image ```shell $ kubectl set image deployment/nginx-deployment nginx=nginx:1.91 -deployment.extensions/nginx-deployment image updated +deployment.apps/nginx-deployment image updated ``` The rollout will be stuck. @@ -420,13 +418,15 @@ First, check the revisions of this deployment: $ kubectl rollout history deployment/nginx-deployment deployments "nginx-deployment" REVISION CHANGE-CAUSE -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 +1 kubectl create --filename=https://k8s.io/examples/controllers/nginx-deployment.yaml --record=true +2 kubectl set image deployment/nginx-deployment nginx=nginx:1.9.1 --record=true +3 kubectl set image deployment/nginx-deployment nginx=nginx:1.91 --record=true ``` +`CHANGE-CAUSE` is copied from the Deployment annotation `kubernetes.io/change-cause` to its revisions upon creation. You could specify the`CHANGE-CAUSE` message by: -Because you recorded the command while creating this Deployment using `--record`, you can easily see -the changes you made in each revision. +* Annotating the Deployment with `kubectl annotate deploy nginx-deployment kubernetes.io/change-cause="image updated to 1.9.1"` +* Append the `--record` flag to save the `kubectl` command that is making changes to the resource. +* Manually editing the manifest of the resource. To further see the details of each revision, run: @@ -435,7 +435,7 @@ $ kubectl rollout history deployment/nginx-deployment --revision=2 deployments "nginx-deployment" revision 2 Labels: app=nginx pod-template-hash=1159050644 - Annotations: kubernetes.io/change-cause=kubectl set image deployment/nginx-deployment nginx=nginx:1.9.1 + Annotations: kubernetes.io/change-cause=kubectl set image deployment/nginx-deployment nginx=nginx:1.9.1 --record=true Containers: nginx: Image: nginx:1.9.1 @@ -453,14 +453,14 @@ Now you've decided to undo the current rollout and rollback to the previous revi ```shell $ kubectl rollout undo deployment/nginx-deployment -deployment.extensions/nginx-deployment +deployment.apps/nginx-deployment ``` Alternatively, you can rollback to a specific revision by specify that in `--to-revision`: ```shell $ kubectl rollout undo deployment/nginx-deployment --to-revision=2 -deployment.extensions/nginx-deployment +deployment.apps/nginx-deployment ``` For more details about rollout related commands, read [`kubectl rollout`](/docs/reference/generated/kubectl/kubectl-commands#rollout). @@ -469,36 +469,52 @@ The Deployment is now rolled back to a previous stable revision. As you can see, for rolling back to revision 2 is generated from Deployment controller. ```shell -$ kubectl get deployment +$ kubectl get deployment nginx-deployment NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE nginx-deployment 3 3 3 3 30m -$ kubectl describe deployment -Name: nginx-deployment -Namespace: default -CreationTimestamp: Tue, 15 Mar 2016 14:48:04 -0700 -Labels: app=nginx -Selector: app=nginx -Replicas: 3 updated | 3 total | 3 available | 0 unavailable -StrategyType: RollingUpdate -MinReadySeconds: 0 -RollingUpdateStrategy: 1 max unavailable, 1 max surge -OldReplicaSets: -NewReplicaSet: nginx-deployment-1564180365 (3/3 replicas created) +$ kubectl describe deployment nginx-deployment +Name: nginx-deployment +Namespace: default +CreationTimestamp: Sun, 02 Sep 2018 18:17:55 -0500 +Labels: app=nginx +Annotations: deployment.kubernetes.io/revision=4 + kubernetes.io/change-cause=kubectl set image deployment/nginx-deployment nginx=nginx:1.9.1 --record=true +Selector: app=nginx +Replicas: 3 desired | 3 updated | 3 total | 3 available | 0 unavailable +StrategyType: RollingUpdate +MinReadySeconds: 0 +RollingUpdateStrategy: 25% max unavailable, 25% max surge +Pod Template: + Labels: app=nginx + Containers: + nginx: + Image: nginx:1.9.1 + Port: 80/TCP + Host Port: 0/TCP + Environment: + Mounts: + Volumes: +Conditions: + Type Status Reason + ---- ------ ------ + Available True MinimumReplicasAvailable + Progressing True NewReplicaSetAvailable +OldReplicaSets: +NewReplicaSet: nginx-deployment-c4747d96c (3/3 replicas created) Events: - FirstSeen LastSeen Count From SubobjectPath Type Reason Message - --------- -------- ----- ---- ------------- -------- ------ ------- - 30m 30m 1 {deployment-controller } Normal ScalingReplicaSet Scaled up replica set nginx-deployment-2035384211 to 3 - 29m 29m 1 {deployment-controller } Normal ScalingReplicaSet Scaled up replica set nginx-deployment-1564180365 to 1 - 29m 29m 1 {deployment-controller } Normal ScalingReplicaSet Scaled down replica set nginx-deployment-2035384211 to 2 - 29m 29m 1 {deployment-controller } Normal ScalingReplicaSet Scaled up replica set nginx-deployment-1564180365 to 2 - 29m 29m 1 {deployment-controller } Normal ScalingReplicaSet Scaled down replica set nginx-deployment-2035384211 to 0 - 29m 29m 1 {deployment-controller } Normal ScalingReplicaSet Scaled up replica set nginx-deployment-3066724191 to 2 - 29m 29m 1 {deployment-controller } Normal ScalingReplicaSet Scaled up replica set nginx-deployment-3066724191 to 1 - 29m 29m 1 {deployment-controller } Normal ScalingReplicaSet Scaled down replica set nginx-deployment-1564180365 to 2 - 2m 2m 1 {deployment-controller } Normal ScalingReplicaSet Scaled down replica set nginx-deployment-3066724191 to 0 - 2m 2m 1 {deployment-controller } Normal DeploymentRollback Rolled back deployment "nginx-deployment" to revision 2 - 29m 2m 2 {deployment-controller } Normal ScalingReplicaSet Scaled up replica set nginx-deployment-1564180365 to 3 + Type Reason Age From Message + ---- ------ ---- ---- ------- + Normal ScalingReplicaSet 12m deployment-controller Scaled up replica set nginx-deployment-75675f5897 to 3 + Normal ScalingReplicaSet 11m deployment-controller Scaled up replica set nginx-deployment-c4747d96c to 1 + Normal ScalingReplicaSet 11m deployment-controller Scaled down replica set nginx-deployment-75675f5897 to 2 + Normal ScalingReplicaSet 11m deployment-controller Scaled up replica set nginx-deployment-c4747d96c to 2 + Normal ScalingReplicaSet 11m deployment-controller Scaled down replica set nginx-deployment-75675f5897 to 1 + Normal ScalingReplicaSet 11m deployment-controller Scaled up replica set nginx-deployment-c4747d96c to 3 + Normal ScalingReplicaSet 11m deployment-controller Scaled down replica set nginx-deployment-75675f5897 to 0 + Normal ScalingReplicaSet 11m deployment-controller Scaled up replica set nginx-deployment-595696685f to 1 + Normal DeploymentRollback 15s deployment-controller Rolled back deployment "nginx-deployment" to revision 2 + Normal ScalingReplicaSet 15s deployment-controller Scaled down replica set nginx-deployment-595696685f to 0 ``` ## Scaling a Deployment @@ -516,7 +532,7 @@ Pods you want to run based on the CPU utilization of your existing Pods. ```shell $ kubectl autoscale deployment nginx-deployment --min=10 --max=15 --cpu-percent=80 -deployment.extensions/nginx-deployment scaled +deployment.apps/nginx-deployment scaled ``` ### Proportional scaling @@ -538,7 +554,7 @@ You update to a new image which happens to be unresolvable from inside the clust ```shell $ kubectl set image deploy/nginx-deployment nginx=nginx:sometag -deployment.extensions/nginx-deployment image updated +deployment.apps/nginx-deployment image updated ``` The image update starts a new rollout with ReplicaSet nginx-deployment-1989198191, but it's blocked due to the @@ -592,14 +608,14 @@ Pause by running the following command: ```shell $ kubectl rollout pause deployment/nginx-deployment -deployment.extensions/nginx-deployment paused +deployment.apps/nginx-deployment paused ``` Then update the image of the Deployment: ```shell $ kubectl set image deploy/nginx-deployment nginx=nginx:1.9.1 -deployment.extensions/nginx-deployment image updated +deployment.apps/nginx-deployment image updated ``` Notice that no new rollout started: @@ -619,7 +635,7 @@ You can make as many updates as you wish, for example, update the resources that ```shell $ kubectl set resources deployment nginx-deployment -c=nginx --limits=cpu=200m,memory=512Mi -deployment.extensions/nginx-deployment resource requirements updated +deployment.apps/nginx-deployment resource requirements updated ``` The initial state of the Deployment prior to pausing it will continue its function, but new updates to @@ -629,7 +645,7 @@ Eventually, resume the Deployment and observe a new ReplicaSet coming up with al ```shell $ kubectl rollout resume deploy/nginx-deployment -deployment.extensions/nginx-deployment resumed +deployment.apps/nginx-deployment resumed $ kubectl get rs -w NAME DESIRED CURRENT READY AGE nginx-2142116321 2 2 2 2m @@ -688,7 +704,7 @@ successfully, `kubectl rollout status` returns a zero exit code. ```shell $ kubectl rollout status deploy/nginx-deployment Waiting for rollout to finish: 2 of 3 updated replicas are available... -deployment.extensions/nginx-deployment successfully rolled out +deployment.apps/nginx-deployment successfully rolled out $ echo $? 0 ``` @@ -715,7 +731,7 @@ lack of progress for a Deployment after 10 minutes: ```shell $ kubectl patch deployment/nginx-deployment -p '{"spec":{"progressDeadlineSeconds":600}}' -deployment.extensions/nginx-deployment patched +deployment.apps/nginx-deployment patched ``` Once the deadline has been exceeded, the Deployment controller adds a DeploymentCondition with the following attributes to the Deployment's `.status.conditions`: diff --git a/content/en/docs/concepts/workloads/controllers/garbage-collection.md b/content/en/docs/concepts/workloads/controllers/garbage-collection.md index 66ac4a5c58..a2b8517afa 100644 --- a/content/en/docs/concepts/workloads/controllers/garbage-collection.md +++ b/content/en/docs/concepts/workloads/controllers/garbage-collection.md @@ -81,7 +81,7 @@ the following things are true: Once the "deletion in progress" state is set, the garbage collector deletes the object's dependents. Once the garbage collector has deleted all -"blocking" dependents (objects with `ownerReference.blockOwnerDeletion=true`), it delete +"blocking" dependents (objects with `ownerReference.blockOwnerDeletion=true`), it deletes the owner object. Note that in the "foregroundDeletion", only dependents with 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 9e6ec9f9c9..d66543b763 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 @@ -134,8 +134,8 @@ There are three main types of jobs: - 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`. 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. + - 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. - each pod is independently capable of determining whether or not all its peers are done, thus the entire Job is done. - when _any_ pod terminates with success, no new pods are created. - once at least one pod has terminated with success and all pods are terminated, then the job is completed with success. @@ -207,10 +207,7 @@ back-off count is reset if no new failed Pods appear before the Job's next status check. {{< note >}} -**Note:** Due to a known issue [#54870](https://github.com/kubernetes/kubernetes/issues/54870), -when the `.spec.template.spec.restartPolicy` field is set to "`OnFailure`", the -back-off limit may be ineffective. As a short-term workaround, set the restart -policy for the embedded template to "`Never`". +**Note:** Issue [#54870](https://github.com/kubernetes/kubernetes/issues/54870) still exists for versions of Kubernetes prior to version 1.12 {{< /note >}} ## Job Termination and Cleanup @@ -281,7 +278,6 @@ apiVersion: batch/v1 kind: Job metadata: name: pi-with-ttl -spec: spec: ttlSecondsAfterFinished: 100 template: @@ -458,4 +454,4 @@ object, but complete control over what pods are created and how work is assigned 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 %}} +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/concepts/workloads/controllers/statefulset.md b/content/en/docs/concepts/workloads/controllers/statefulset.md index 3655625bc8..480988cb09 100644 --- a/content/en/docs/concepts/workloads/controllers/statefulset.md +++ b/content/en/docs/concepts/workloads/controllers/statefulset.md @@ -32,7 +32,6 @@ following. * Stable, unique network identifiers. * Stable, persistent storage. * Ordered, graceful deployment and scaling. -* Ordered, graceful deletion and termination. * Ordered, automated rolling updates. In the above, stable is synonymous with persistence across Pod (re)scheduling. @@ -48,6 +47,7 @@ provides a set of stateless replicas. Controllers such as * The storage for a given Pod must either be provisioned by a [PersistentVolume Provisioner](https://github.com/kubernetes/examples/tree/{{< param "githubbranch" >}}/staging/persistent-volume-provisioning/README.md) based on the requested `storage class`, or pre-provisioned by an admin. * Deleting and/or scaling a StatefulSet down will *not* delete the volumes associated with the StatefulSet. This is done to ensure data safety, which is generally more valuable than an automatic purge of all related StatefulSet resources. * StatefulSets currently require a [Headless Service](/docs/concepts/services-networking/service/#headless-services) to be responsible for the network identity of the Pods. You are responsible for creating this Service. +* StatefulSets do not provide any guarantees on the termination of pods when a StatefulSet is deleted. To achieve ordered and graceful termination of the pods in the StatefulSet, it is possible to scale the StatefulSet down to 0 prior to deletion. ## Components The example below demonstrates the components of a StatefulSet. diff --git a/content/en/docs/concepts/workloads/pods/pod.md b/content/en/docs/concepts/workloads/pods/pod.md index 147eb1f833..7b000b4768 100644 --- a/content/en/docs/concepts/workloads/pods/pod.md +++ b/content/en/docs/concepts/workloads/pods/pod.md @@ -24,7 +24,8 @@ for how to run the containers. A pod's contents are always co-located and co-scheduled, and run in a shared context. A pod models an application-specific "logical host" - it contains one or more application containers which are relatively tightly coupled — in a pre-container -world, they would have executed on the same physical or virtual machine. +world, being executed on the same physical or virtual machine would mean being +executed on the same logical host. While Kubernetes supports more container runtimes than just Docker, Docker is the most commonly known runtime, and it helps to describe pods in Docker terms. diff --git a/content/en/docs/contribute/_index.md b/content/en/docs/contribute/_index.md index e97e78c2c9..688a2c6160 100644 --- a/content/en/docs/contribute/_index.md +++ b/content/en/docs/contribute/_index.md @@ -13,7 +13,11 @@ we're happy to have your help! Anyone can contribute, whether you're new to the project or you've been around a long time, and whether you self-identify as a developer, an end user, or someone who just can't stand seeing typos. -Looking for the [style guide](/docs/contribute/style/style-guide/)? +For more ways to get involved in the Kubernetes community or to learn about us, +also visit the [Kubernetes community site](/community/). + +Looking for the [style guide](/docs/contribute/style/style-guide/) or the +[Kubernetes Community site](/community/)? {{% /capture %}} {{% capture body %}} diff --git a/content/en/docs/contribute/intermediate.md b/content/en/docs/contribute/intermediate.md index a986fd105d..499e699d56 100644 --- a/content/en/docs/contribute/intermediate.md +++ b/content/en/docs/contribute/intermediate.md @@ -490,7 +490,7 @@ Slack channel or the If you aren't ready to create a pull request but you want to see what your changes look like, you can use the `hugo` command to stage the changes locally. -1. Install Hugo version `0.40.3` or later. +1. Install Hugo version {{< hugoVersion >}} or later. 2. In a terminal, go to the root directory of your clone of the Kubernetes docs, and enter this command: diff --git a/content/en/docs/contribute/localization.md b/content/en/docs/contribute/localization.md index 2f8c870d0d..90d3c51ccf 100644 --- a/content/en/docs/contribute/localization.md +++ b/content/en/docs/contribute/localization.md @@ -4,17 +4,19 @@ content_template: templates/concept approvers: - chenopis - zacharysarah +- zparnold --- {{% capture overview %}} -The Kubernetes documentation is currently available in [multiple languages](#supported-languages) and we encourage you to add new localizations ([l10n](https://blog.mozilla.org/l10n/2011/12/14/i18n-vs-l10n-whats-the-diff/))! +Documentation for Kubernetes is available in multiple languages: -Currently available languages: +- English +- Chinese +- Japanese +- Korean -{{< language-repos-list >}} - -In order for localizations to be accepted, however, they must fulfill some requirements related to workflow (*how* to localize) and output (*what* to localize). +We encourage you to add new [localizations](https://blog.mozilla.org/l10n/2011/12/14/i18n-vs-l10n-whats-the-diff/)! {{% /capture %}} @@ -22,42 +24,51 @@ In order for localizations to be accepted, however, they must fulfill some requi {{% capture body %}} -## Workflow - -The Kubernetes documentation for all languages is built from the [kubernetes/website](https://github.com/kubernetes/website) repository on GitHub. Most day-to-work work on translations, however, happens in separate translation repositories. Changes to those repositories are then [periodically](#upstream-contributions) synced to the main kubernetes/website repository via [pull request](../create-pull-request). - -Work on the Chinese translation, for example, happens in the [kubernetes/kubernetes-docs-zh](https://github.com/kubernetes/kubernetes-docs-zh) repository. - -{{< note >}} -**Note**: For an example localization-related [pull request](../create-pull-request), see [this pull request](https://github.com/kubernetes/website/pull/8636) to the [Kubernetes website repo](https://github.com/kubernetes/website) adding Korean localization to the Kubernetes docs. -{{< /note >}} - -## Source Files - -Localizations must use English files from the most recent major release as sources. To find the most recent release's documentation source files: - -1. Navigate to the Kubernetes website repository at https://github.com/kubernetes/website. -2. Select the `release-1.X` branch for the most recent version, which is currently **{{< latest-version >}}**, making the most recent release branch [`{{< release-branch >}}`](https://github.com/kubernetes/website/tree/{{< release-branch >}}). - ## Getting started -In order to add a new localization of the Kubernetes documentation, you'll need to make a few modifications to the site's [configuration](#configuration) and [directory structure](#new-directory), and then you can get to work [translating documents](#translating-documents)! +Localizations must meet some requirements for workflow (*how* to localize) and output (*what* to localize). -To get started, clone the website repo and `cd` into it: +To add a new localization of the Kubernetes documentation, you'll need to update the website by modifying the [site configuration](#modify-the-site-configuration) and [directory structure](#add-a-new-localization-directory). Then you can start [translating documents](#translating-documents)! + +Let Kubernetes SIG Docs know you're interested in creating a localization! Join the [SIG Docs Slack channel](https://kubernetes.slack.com/messages/C1J0BPD2M/). We're happy to help you get started and answer any questions you have. + +All localization teams must be self-sustaining with their own resources. We're happy to host your work, but we can't translate it for you. + +### Fork and clone the repo + +First, [create your own fork](https://help.github.com/articles/fork-a-repo/) of the [kubernetes/website](https://github.com/kubernetes/website). + +Then, clone the website repo and `cd` into it: ```shell git clone https://github.com/kubernetes/website cd website -git checkout {{< release-branch >}} ``` -## Configuration +{{< note >}} +Contributors to `k/website` must [create a fork](https://kubernetes.io/docs/contribute/start/#improve-existing-content) from which to open pull requests. For localizations, we ask additionally that: -We'll walk you through the configuration process using the German language (language code `de`) as an example. +1. Team approvers open development branches directly from https://github.com/kubernetes/website. +2. Localization contributors work from forks, with branches based on the current development branch. -There's currently no translation for German, but you're welcome to create one using the instructions here. +This is because localization projects are collaborative efforts on long-running branches, similar to the development branches for the Kubernetes release cycle. For information about localization pull requests, see ["branching strategy"](#branching-strategy). +{{< /note >}} -The Kubernetes website's configuration is in the [`config.toml`](https://github.com/kubernetes/website/tree/master/config.toml) file. You need to add a configuration block for the new language to that file, under the existing `[languages]` block. The German block, for example, looks like this: +### Find your two-letter language code + +Consult the [ISO 639-1 standard](https://www.loc.gov/standards/iso639-2/php/code_list.php) for your localization's two-letter country code. For example, the two-letter code for German is `de`. + +{{< note >}} +These instructions use the [ISO 639-1](https://www.loc.gov/standards/iso639-2/php/code_list.php) language code for German (`de`) as an example. + +There's currently no Kubernetes localization for German, but you're welcome to create one! +{{< /note >}} + +### Modify the site configuration + +The Kubernetes website uses Hugo as its web framework. The website's Hugo configuration resides in the [`config.toml`](https://github.com/kubernetes/website/tree/master/config.toml) file. To support a new localization, you'll need to modify `config.toml`. + +Add a configuration block for the new language to `config.toml`, under the existing `[languages]` block. The German block, for example, looks like: ```toml [languages.de] @@ -68,74 +79,128 @@ contentDir = "content/de" weight = 3 ``` -When assigning a `weight` parameter, see which of the current languages has the highest weight and add 1 to that value. +When assigning a `weight` parameter for your block, find the language block with the highest weight and add 1 to that value. -Now add a language-specific subdirectory to the [`content`](https://github.com/kubernetes/website/tree/master/content) folder. The two-letter code for German is `de`, so add a `content/de` directory: +For more information about Hugo's multilingual support, see "[Multilingual Mode](https://gohugo.io/content-management/multilingual/)". + +### Add a new localization directory + +Add a language-specific subdirectory to the [`content`](https://github.com/kubernetes/website/tree/master/content) folder in the repository. For example, the two-letter code for German is `de`: ```shell mkdir content/de ``` +### Add a localized README + +To guide other localization contributors, add a new [`README-**.md`](https://help.github.com/articles/about-readmes/) to the top level of k/website, where `**` is the two-letter language code. For example, a German README file would be `README-de.md`. + +Provide guidance to localization contributors in the localized `README-**.md` file. Include the same information contained in `README.md` as well as: + +- A point of contact for the localization project +- Any information specific to the localization + +After you create the localized README, add a link to the file from the main English file, [`README.md`] and include contact information in English. You can provide a GitHub ID, email address, [Slack channel](https://slack.com/), or other method of contact. + ## Translating documents -We understand that localizing *all* of the Kubernetes documentation would be an enormous task. We're okay with localizations smarting small and expanding over time. +Localizing *all* of the Kubernetes documentation is an enormous task. It's okay to start small and expand over time. -As an initial requirement, all localizations must include the following documentation at a minimum: +At a minimum, all localizations must include: Description | URLs -----|----- Home | [All heading and subheading URLs](https://kubernetes.io/docs/home/) Setup | [All heading and subheading URLs](https://kubernetes.io/docs/setup/) Tutorials | [Kubernetes Basics](https://kubernetes.io/docs/tutorials/kubernetes-basics/), [Hello Minikube](https://kubernetes.io/docs/tutorials/stateless-application/hello-minikube/) +Site strings | [All site strings in a new localized TOML file](https://github.com/kubernetes/website/tree/master/i18n) -Translated documents should have the same URL endpoint as the English docs (substituting the subdirectory of the `content` folder). To translate the [Kubernetes Basics](https://kubernetes.io/docs/tutorials/kubernetes-basics/) doc into German, for example, create the proper subfolder under the `content/de` folder and copy the English doc: +Translated documents must reside in their own `content/**/` subdirectory, but otherwise follow the same URL path as the English source. For example, to prepare the [Kubernetes Basics](https://kubernetes.io/docs/tutorials/kubernetes-basics/) tutorial for translation into German, create a subfolder under the `content/de/` folder and copy the English source: ```shell mkdir -p content/de/docs/tutorials cp content/en/docs/tutorials/kubernetes-basics.md content/de/docs/tutorials/kubernetes-basics.md ``` +For an example of a localization-related [pull request](../create-pull-request), [this pull request](https://github.com/kubernetes/website/pull/10471) to the [Kubernetes website repo](https://github.com/kubernetes/website) added Korean localization to the Kubernetes docs. + +### Source Files + +Localizations must use English files from the most recent release as their source. The most recent version is **{{< latest-version >}}**. + +To find source files for the most recent release: + +1. Navigate to the Kubernetes website repository at https://github.com/kubernetes/website. +2. Select the `release-1.X` branch for the most recent version. + +The latest version is **{{< latest-version >}}**, so the most recent release branch is [`{{< release-branch >}}`](https://github.com/kubernetes/website/tree/{{< release-branch >}}). + +### Site strings in i18n/ + +Localizations must include the contents of [`i18n/en.toml`](https://github.com/kubernetes/website/blob/master/i18n/en.toml) in a new language-specific file. Using German as an example: `i18n/de.toml`. + +Add a new localization file to `i18n/`. For example, with German (`de`): + +```shell +cp i18n/en.toml i18n/de.toml +``` + +Then translate the value of each string: + +```TOML +[docs_label_i_am] +other = "ICH BIN..." +``` + +Localizing site strings lets you customize site-wide text and features: for example, the legal copyright text in the footer on each page. + ## Project logistics -### Contact with project chairs +### Contact the SIG Docs chairs -When starting a new localization effort, you should get in touch with one of the chairs of the Kubernetes [SIG Docs](https://github.com/kubernetes/community/tree/master/sig-docs) organization. The current chairs are listed [here](https://github.com/kubernetes/community/tree/master/sig-docs#chairs). - -### Project information - -Teams working on localization efforts must provide a single point of contact, including the name and contact information of a person who can respond to or redirect questions or concerns, listed in the translation repository's main [`README`](https://help.github.com/articles/about-readmes/). You can provide an email address, email list, [Slack channel](https://slack.com/), or some other method of contact. +Contact one of the chairs of the Kubernetes [SIG Docs](https://github.com/kubernetes/community/tree/master/sig-docs#chairs) chairs when you start a new localization. ### Maintainers -Each localization repository must select its own maintainers. Maintainers can be from a single organization or multiple organizations. +Each localization repository must provide its own maintainers. Maintainers can be from a single organization or multiple organizations. Whenever possible, localization pull requests should be approved by a reviewer from a different organization than the translator. -In addition, all l10n work must be self-sustaining with the team's own resources. +A localization must provide a minimum of two maintainers. (It's not possible to review and approve one's own work.) -Wherever possible, every localized page must be approved by a reviewer from a different company than the translator. +### Branching strategy -### GitHub project +Because localization projects are highly collaborative efforts, we encourage teams to work from a shared development branch. -Each Kubernetes localization repository must track its overall progress with a [GitHub project](https://help.github.com/articles/creating-a-project-board/). +To collaborate on a development branch: -Projects must include at least these columns: +1. A team member opens a development branch, usually by opening a new pull request against a source branch on https://github.com/kubernetes/website. -- To Do -- In Progress -- Done + We recommend the following branch naming scheme: -{{< note >}} -**Note**: For an example GitHub project, see the [Chinese localization project](https://github.com/kubernetes/kubernetes-docs-zh/projects/1). -{{< /note >}} + `dev--.` -### Repository structure + For example, an approver on a German localization team opens the development branch `dev-1.12-de.1` directly against the k/website repository, based on the source branch for Kubernetes v1.12. -Each l10n repository must have branches for the different Kubernetes documentation release versions, matching the branches in the main [kubernetes/website](https://github.com/kubernetes/website) documentation repository. For example, the kubernetes/website `release-1.10` branch (https://github.com/kubernetes/website/tree/release-1.10) has a corresponding branch in the kubernetes/kubernetes-docs-zh repository (https://github.com/kubernetes/kubernetes-docs-zh/tree/release-1.10). These version branches keep track of the differences in the documentation between Kubernetes versions. +2. Individual contributors open feature branches based on the development branch. + + For example, a German contributor opens a pull request with changes to `kubernetes:dev-1.12-de.1` from `username:local-branch-name`. + +3. Approvers review and merge feature branches into the development branch. + +4. Periodically, an approver merges the development branch to its source branch. + +Repeat steps 1-4 as needed until the localization is complete. For example, subsequent German development branches would be: `dev-1.12-de.2`, `dev-1.12-de.3`, etc. + +Teams must merge localized content into the same release branch from which the content was sourced. For example, a development branch sourced from {{< release-branch >}} must be based on {{< release-branch >}}. + +An approver must maintain a development branch by keeping it current with its source branch and resolving merge conflicts. The longer a development branch stays open, the more maintenance it typically requires. Consider periodically merging development branches and opening new ones, rather than maintaining one extremely long-running development branch. + +While only approvers can merge pull requests, anyone can open a pull request for a new development branch. No special permissions are required. + +For more information about working from forks or directly from the repository, see ["fork and clone the repo"](#fork-and-clone-the-repo). ### Upstream contributions -Upstream contributions are welcome and encouraged! - -For the sake of efficiency, limit upstream contributions to a single pull request per week, containing a single [squashed commit](https://github.com/todotxt/todo.txt-android/wiki/Squash-All-Commits-Related-to-a-Single-Issue-into-a-Single-Commit). +SIG Docs welcomes upstream contributions and corrections to the English source! Open a [pull request](https://kubernetes.io/docs/contribute/start/#improve-existing-content) (from a fork) with any updates. {{% /capture %}} @@ -143,7 +208,7 @@ For the sake of efficiency, limit upstream contributions to a single pull reques Once a l10n meets requirements for workflow and minimum output, SIG docs will: -- Work with the localization team to implement language selection on the website. -- Publicize availability through [Cloud Native Computing Foundation](https://www.cncf.io/) (CNCF) channels. +- Enable language selection on the website +- Publicize the localization's availability through [Cloud Native Computing Foundation](https://www.cncf.io/) (CNCF) channels, including the [Kubernetes blog](https://kubernetes.io/blog/). {{% /capture %}} diff --git a/content/en/docs/contribute/start.md b/content/en/docs/contribute/start.md index 1233becf81..02e0ce0bc0 100644 --- a/content/en/docs/contribute/start.md +++ b/content/en/docs/contribute/start.md @@ -114,7 +114,7 @@ in mind: For instance, "Fix the security docs" is not an actionable issue, but "Add details to the 'Restricting network access' topic" might be. - If the issue relates to another issue or pull request, you can refer to it - either by its full URL or by the the issue or pull request number prefixed + either by its full URL or by the issue or pull request number prefixed with a `#` character. For instance, `Introduced by #987654`. - Be respectful and avoid venting. For instance, "The docs about X suck" is not helpful or actionable feedback. The @@ -179,7 +179,7 @@ to base your work on. Use these guidelines to make the decision: - Use `master` for fixing problems in content that is already published, or making improvements to content that already exists. -- Use a release branch (such as `release-1.12`) to document upcoming features + - Use a release branch (such as `dev-{{< release-branch >}}` for the {{< release-branch >}} release) to document upcoming features or changes for an upcoming release that is not yet published. - Use a feature branch that has been agreed upon by SIG Docs to collaborate on big improvements or changes to the existing documentation, including content diff --git a/content/en/docs/contribute/style/style-guide.md b/content/en/docs/contribute/style/style-guide.md index f577ca2a6c..516b57a208 100644 --- a/content/en/docs/contribute/style/style-guide.md +++ b/content/en/docs/contribute/style/style-guide.md @@ -56,11 +56,11 @@ leads to an awkward construction. Use angle brackets for placeholders. Tell the reader what a placeholder represents. -1. Display information about a pod: +1. Display information about a Pod: kubectl describe pod - where `` is the name of one of your pods. + where `` is the name of one of your Pods. ### Use bold for user interface elements @@ -138,7 +138,7 @@ For field values of type string or integer, use normal style without quotation m ### Separate commands from output -Verify that the pod is running on your chosen node: +Verify that the Pod is running on your chosen node: kubectl get pods --output=wide @@ -149,7 +149,7 @@ The output is similar to this: ### Versioning Kubernetes examples -Code examples and configuration examples that include version information should be consistent with the accompanying text. +Code examples and configuration examples that include version information should be consistent with the accompanying text. If the information is version specific, the Kubernetes version needs to be defined in the `prerequisites` section of the [Task template](/docs/contribute/style/page-templates/#task-template) or the [Tutorial template] (/docs/contribute/style/page-templates/#tutorial-template). Once the page is saved, the `prerequisites` section is shown as **Before you begin**. @@ -194,7 +194,7 @@ Hugo [Shortcodes](https://gohugo.io/content-management/shortcodes) help create d 1. Surround the text with an opening and closing shortcode. 2. Use the following syntax to apply a style: - + ``` {{}} **Note:** The prefix you use is the same text you use in the tag. @@ -213,7 +213,7 @@ The output is: Use {{}} to highlight a tip or a piece of information that may be helpful to know. For example: - + ``` {{}} **Note:** You can _still_ use Markdown inside these callouts. @@ -387,7 +387,7 @@ whether they're part of the "we" you're describing. DoDon't Version 1.4 includes ...In version 1.4, we have added ... Kubernetes provides a new feature for ...We provide a new feature ... - This page teaches you how to use pods.In this page, we are going to learn about pods. + This page teaches you how to use Pods.In this page, we are going to learn about Pods. ### Avoid jargon and idioms diff --git a/content/en/docs/getting-started-guides/ubuntu/backups.md b/content/en/docs/getting-started-guides/ubuntu/backups.md index f06a8edde3..226072ceb3 100644 --- a/content/en/docs/getting-started-guides/ubuntu/backups.md +++ b/content/en/docs/getting-started-guides/ubuntu/backups.md @@ -41,7 +41,7 @@ juju deploy etcd new-etcd The above code snippet will deploy a single unit of etcd, as 'new-etcd' ``` -juju run-action etcd/0 restore target=/mnt/etcd-backups +juju run-action new-etcd/0 restore target=/mnt/etcd-backups ``` Once the restore action has completed, evaluate the cluster health. If the unit diff --git a/content/en/docs/getting-started-guides/ubuntu/local.md b/content/en/docs/getting-started-guides/ubuntu/local.md index 61127fb4c9..b8aaaf9d5d 100644 --- a/content/en/docs/getting-started-guides/ubuntu/local.md +++ b/content/en/docs/getting-started-guides/ubuntu/local.md @@ -18,7 +18,8 @@ sudo snap install conjure-up --classic sudo usermod -a -G lxd $(whoami) ``` -Note: If conjure-up asks you to "Setup an ipv6 subnet" with LXD, answer NO. ipv6 with Juju/LXD is currently unsupported. +Note: If conjure-up asks you to "Setup an IPv6 subnet" with LXD, answer NO. IPv6 with Juju/LXD is currently unsupported. +If you already have a bridge configured, e.g. `lxdbr0`, [disable IPv6 on the bridge](https://docs.conjure-up.io/stable/en/troubleshoot#common-problems), otherwise you won't be able to choose it. {{% /capture %}} {{% capture steps %}} diff --git a/content/en/docs/reference/_index.md b/content/en/docs/reference/_index.md index 654ab4356c..56dfb08920 100644 --- a/content/en/docs/reference/_index.md +++ b/content/en/docs/reference/_index.md @@ -20,6 +20,7 @@ This section of the Kubernetes documentation contains references. * [Kubernetes API Overview](/docs/reference/using-api/api-overview/) - Overview of the API for Kubernetes. * Kubernetes API Versions + * [1.12](/docs/reference/generated/kubernetes-api/v1.12/) * [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/) @@ -39,7 +40,7 @@ client libraries: * [kubectl](/docs/user-guide/kubectl-overview) - Main CLI tool for running commands and managing Kubernetes clusters. * [JSONPath](/docs/user-guide/jsonpath/) - Syntax guide for using [JSONPath expressions](http://goessner.net/articles/JsonPath/) with kubectl. -* [kubeadm](/docs/admin/kubeadm/) - CLI tool to easily provision a secure Kubernetes cluster. +* [kubeadm](/docs/admin/kubeadm/) - CLI tool to easily provision a secure Kubernetes cluster. * [kubefed](/docs/admin/kubefed/) - CLI tool to help you administrate your federated clusters. ## Config Reference diff --git a/content/en/docs/reference/access-authn-authz/abac.md b/content/en/docs/reference/access-authn-authz/abac.md index 0e3e6cf17f..67ab051408 100644 --- a/content/en/docs/reference/access-authn-authz/abac.md +++ b/content/en/docs/reference/access-authn-authz/abac.md @@ -16,12 +16,12 @@ Attribute-based access control (ABAC) defines an access control paradigm whereby {{% capture body %}} ## Policy File Format -For mode `ABAC`, also specify `--authorization-policy-file=SOME_FILENAME`. +To enable `ABAC` mode, specify `--authorization-policy-file=SOME_FILENAME` and `--authorization-mode=ABAC` on startup. The file format is [one JSON object per line](http://jsonlines.org/). There should be no enclosing list or map, just one map per line. -Each line is a "policy object". A policy object is a map with the following +Each line is a "policy object", where each such object is a map with the following properties: - Versioning properties: @@ -104,12 +104,12 @@ up the verbosity: ```json {"apiVersion": "abac.authorization.kubernetes.io/v1beta1", "kind": "Policy", "spec": {"user": "alice", "namespace": "*", "resource": "*", "apiGroup": "*"}} ``` - 2. Kubelet can read any pods: + 2. The Kubelet can read any pods: ```json {"apiVersion": "abac.authorization.kubernetes.io/v1beta1", "kind": "Policy", "spec": {"user": "kubelet", "namespace": "*", "resource": "pods", "readonly": true}} ``` - 3. Kubelet can read and write events: + 3. The Kubelet can read and write events: ```json {"apiVersion": "abac.authorization.kubernetes.io/v1beta1", "kind": "Policy", "spec": {"user": "kubelet", "namespace": "*", "resource": "events"}} @@ -130,22 +130,20 @@ up the verbosity: ## A quick note on service accounts -A service account automatically generates a user. The user's name is generated -according to the naming convention: +Every service account has a corresponding ABAC username, and that service account's user name is generated according to the naming convention: ```shell system:serviceaccount:: ``` -Creating a new namespace also causes a new service account to be created, of -this form: + +Creating a new namespace leads to the creation of a new service account in the following format: ```shell system:serviceaccount::default ``` -For example, if you wanted to grant the default service account in the -kube-system full privilege to the API, you would add this line to your policy -file: +For example, if you wanted to grant the default service account (in the `kube-system` namespace) full +privilege to the API using ABAC, you would add this line to your policy file: ```json {"apiVersion":"abac.authorization.kubernetes.io/v1beta1","kind":"Policy","spec":{"user":"system:serviceaccount:kube-system:default","namespace":"*","resource":"*","apiGroup":"*"}} 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 1dabb38254..9eee5a89e8 100644 --- a/content/en/docs/reference/access-authn-authz/admission-controllers.md +++ b/content/en/docs/reference/access-authn-authz/admission-controllers.md @@ -62,7 +62,7 @@ For example, the following command line enables the `NamespaceLifecycle` and the admission control plugins: ```shell -kube-apiserver --enable-admission-plugins=NamespaceLifecyle,LimitRanger ... +kube-apiserver --enable-admission-plugins=NamespaceLifecycle,LimitRanger ... ``` {{< note >}} diff --git a/content/en/docs/reference/access-authn-authz/authentication.md b/content/en/docs/reference/access-authn-authz/authentication.md index bfd4e2c273..9159b7c68d 100644 --- a/content/en/docs/reference/access-authn-authz/authentication.md +++ b/content/en/docs/reference/access-authn-authz/authentication.md @@ -408,6 +408,10 @@ file format. Within the file, `clusters` refers to the remote service and `users` refers to the API server webhook. An example would be: ```yaml +# Kubernetes API version +apiVersion: v1 +# kind of the API object +kind: Config # clusters refers to the remote service. clusters: - name: name-of-remote-authn-service diff --git a/content/en/docs/reference/access-authn-authz/webhook.md b/content/en/docs/reference/access-authn-authz/webhook.md index 3989baa724..e4945b1685 100644 --- a/content/en/docs/reference/access-authn-authz/webhook.md +++ b/content/en/docs/reference/access-authn-authz/webhook.md @@ -29,6 +29,10 @@ file format. Within the file "users" refers to the API Server webhook and A configuration example which uses HTTPS client auth: ```yaml +# Kubernetes API version +apiVersion: v1 +# kind of the API object +kind: Config # clusters refers to the remote service. clusters: - name: name-of-remote-authz-service diff --git a/content/en/docs/reference/command-line-tools-reference/federation-apiserver.md b/content/en/docs/reference/command-line-tools-reference/federation-apiserver.md index 09a672d78e..bb9ddab27d 100644 --- a/content/en/docs/reference/command-line-tools-reference/federation-apiserver.md +++ b/content/en/docs/reference/command-line-tools-reference/federation-apiserver.md @@ -1,3 +1,8 @@ +--- +title: federation-apiserver +notitle: true +--- + ## federation-apiserver @@ -145,4 +150,4 @@ VolumeScheduling=true|false (ALPHA - default=false) --watch-cache-sizes strings 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-size ``` -###### Auto generated by spf13/cobra on 24-Sep-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 \ No newline at end of file diff --git a/content/en/docs/reference/command-line-tools-reference/federation-controller-manager.md b/content/en/docs/reference/command-line-tools-reference/federation-controller-manager.md index a6527d97f6..21ae9c02ca 100644 --- a/content/en/docs/reference/command-line-tools-reference/federation-controller-manager.md +++ b/content/en/docs/reference/command-line-tools-reference/federation-controller-manager.md @@ -1,3 +1,8 @@ +--- +title: federation-controller-manager +notitle: true +--- + ## federation-controller-manager @@ -51,4 +56,4 @@ federation-controller-manager [flags] --zone-name string Zone name, like example.com. ``` -###### Auto generated by spf13/cobra on 24-Sep-2018 +###### Auto generated by spf13/cobra on 24-Sep-2018 \ No newline at end of file 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 8102198ef8..de1111982f 100644 --- a/content/en/docs/reference/command-line-tools-reference/kubelet.md +++ b/content/en/docs/reference/command-line-tools-reference/kubelet.md @@ -132,7 +132,7 @@ kubelet [flags] --bootstrap-checkpoint-path string - Path to to the directory where the checkpoints are stored + Path to the directory where the checkpoints are stored diff --git a/content/en/docs/reference/federation/extensions/v1beta1/definitions.html b/content/en/docs/reference/federation/extensions/v1beta1/definitions.html index f3bafaf149..85ce8eefde 100755 --- a/content/en/docs/reference/federation/extensions/v1beta1/definitions.html +++ b/content/en/docs/reference/federation/extensions/v1beta1/definitions.html @@ -1451,7 +1451,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

v1beta1.HTTPIngressRuleValue

-

HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> → backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last / and before the first ? or #.

+

HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> → backend 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 #.

diff --git a/content/en/docs/reference/federation/v1/definitions.html b/content/en/docs/reference/federation/v1/definitions.html index 05b55bda6f..9cfb9cf1d3 100755 --- a/content/en/docs/reference/federation/v1/definitions.html +++ b/content/en/docs/reference/federation/v1/definitions.html @@ -2350,7 +2350,7 @@ When an object is created, the system will populate this list with the current s - + diff --git a/content/en/docs/reference/glossary/container-env-variables.md b/content/en/docs/reference/glossary/container-env-variables.md index 1fe95d0973..b0eda8ab80 100755 --- a/content/en/docs/reference/glossary/container-env-variables.md +++ b/content/en/docs/reference/glossary/container-env-variables.md @@ -4,15 +4,14 @@ id: container-env-variables date: 2018-04-12 full_link: /docs/concepts/containers/container-environment-variables.md short_description: > - Container environment variables are name/value pairs that provide useful information into containers running in a Pod. + Container environment variables are name=value pairs that provide useful information into containers running in a Pod. aka: tags: - fundamental --- - Container environment variables are name/value pairs that provide useful information into containers running in a Pod. + Container environment variables are name=value pairs that provide useful information into containers running in a Pod. - - -Container environment variables provide information that is required by the running containerized applications along with information about important resources to the [Containers] {{< glossary_tooltip text="Containers" term_id="container" >}}. For example, file system, information about the container itself and other cluster resources such as service endpoints, etc. + +Container environment variables provide information that is required by the running containerized applications along with information about important resources to the {{< glossary_tooltip text="Containers" term_id="container" >}}. For example, file system details, information about the container itself, and other cluster resources such as service endpoints. \ No newline at end of file diff --git a/content/en/docs/reference/glossary/quantity.md b/content/en/docs/reference/glossary/quantity.md index c0c0edd52b..4bc243e0b9 100644 --- a/content/en/docs/reference/glossary/quantity.md +++ b/content/en/docs/reference/glossary/quantity.md @@ -1,3 +1,4 @@ +<<<<<<< HEAD --- title: Quantity id: quantity @@ -28,3 +29,37 @@ intentionally lowercase), `M` (mega), `G` (giga), `T` (terra), `P` (peta), The accepted binary (power-of-2) units are `Ki` (kibi), `Mi` (mebi), `Gi` (gibi), `Ti` (tebi), `Pi` (pebi), `Ei` (exbi). +||||||| merged common ancestors +======= +--- +title: Quantity +id: quantity +date: 2018-08-07 +full_link: +short_description: > + A whole-number representation of small or large numbers using SI suffixes. + +aka: +tags: +- core-object +--- + A whole-number representation of small or large numbers using SI suffixes. + + + +Quantities are representations of small or large numbers using a compact, +whole-number notation with SI suffixes. Fractional numbers are represented +using milli units, while large numbers can be represented using kilo, +mega, or giga units. + +For instance, the number `1.5` is represented as `1500m`, while the number `1000` +can be represented as `1k`, and `1000000` as `1M`. You can also specify +binary-notation suffixes; the number 2048 can be written as `2Ki`. + +The accepted decimal (power-of-10) units are `m` (milli), `k` (kilo, +intentionally lowercase), `M` (mega), `G` (giga), `T` (terra), `P` (peta), +`E` (exa). + +The accepted binary (power-of-2) units are `Ki` (kibi), `Mi` (mebi), `Gi` (gibi), +`Ti` (tebi), `Pi` (pebi), `Ei` (exbi). +>>>>>>> master diff --git a/content/en/docs/reference/issues-security/security.md b/content/en/docs/reference/issues-security/security.md index 9613a6bc7c..a2795d3b93 100644 --- a/content/en/docs/reference/issues-security/security.md +++ b/content/en/docs/reference/issues-security/security.md @@ -23,7 +23,7 @@ Join the [kubernetes-announce](https://groups.google.com/forum/#!forum/kubernete We’re extremely grateful for security researchers and users that report vulnerabilities to the Kubernetes Open Source Community. All reports are thoroughly investigated by a set of community volunteers. -To make a report, please email the private [kubernetes-security@googlegroups.com](mailto:kubernetes-security@googlegroups.com) list with the security details and the details expected for [all Kubernetes bug reports](https://git.k8s.io/kubernetes/.github/ISSUE_TEMPLATE.md). +To make a report, please email the private [security@kubernetes.io](mailto:security@kubernetes.io) list with the security details and the details expected for [all Kubernetes bug reports](https://git.k8s.io/kubernetes/.github/ISSUE_TEMPLATE.md). You may encrypt your email to this list using the GPG keys of the [Product Security Team members](https://git.k8s.io/sig-release/security-release-process-documentation/security-release-process.md#product-security-team-pst). Encryption using GPG is NOT required to make a disclosure. diff --git a/content/en/docs/reference/kubectl/cheatsheet.md b/content/en/docs/reference/kubectl/cheatsheet.md index 33300cc84c..8ded895e73 100644 --- a/content/en/docs/reference/kubectl/cheatsheet.md +++ b/content/en/docs/reference/kubectl/cheatsheet.md @@ -321,4 +321,6 @@ Verbosity | Description * Also [kubectl Usage Conventions](/docs/reference/kubectl/conventions/) to understand how to use it in reusable scripts. +* See more community [kubectl cheatsheets](https://github.com/dennyzhang/cheatsheet-kubernetes-A4). + {{% /capture %}} diff --git a/content/en/docs/reference/kubectl/kubectl.md b/content/en/docs/reference/kubectl/kubectl.md index c32a7cad88..4ebd4bb171 100755 --- a/content/en/docs/reference/kubectl/kubectl.md +++ b/content/en/docs/reference/kubectl/kubectl.md @@ -9,7 +9,7 @@ kubectl controls the Kubernetes cluster manager ### Synopsis -kubectl controls the Kubernetes cluster manager. +kubectl controls the Kubernetes cluster manager. Find more information at: https://kubernetes.io/docs/reference/kubectl/overview/ @@ -249,45 +249,44 @@ kubectl [flags] ### SEE ALSO -* [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 -* [kubectl auth](kubectl_auth.md) - Inspect authorization -* [kubectl autoscale](kubectl_autoscale.md) - Auto-scale a Deployment, ReplicaSet, or ReplicationController -* [kubectl certificate](kubectl_certificate.md) - Modify certificate resources. -* [kubectl cluster-info](kubectl_cluster-info.md) - Display cluster info -* [kubectl completion](kubectl_completion.md) - Output shell completion code for the specified shell (bash or zsh) -* [kubectl config](kubectl_config.md) - Modify kubeconfig files -* [kubectl convert](kubectl_convert.md) - Convert config files between different API versions -* [kubectl cordon](kubectl_cordon.md) - Mark node as unschedulable -* [kubectl cp](kubectl_cp.md) - Copy files and directories to and from containers. -* [kubectl create](kubectl_create.md) - Create a resource from a file or from stdin. -* [kubectl delete](kubectl_delete.md) - Delete resources by filenames, stdin, resources and names, or by resources and label selector -* [kubectl describe](kubectl_describe.md) - Show details of a specific resource or group of resources -* [kubectl drain](kubectl_drain.md) - Drain node in preparation for maintenance -* [kubectl edit](kubectl_edit.md) - Edit a resource on the server -* [kubectl exec](kubectl_exec.md) - Execute a command in a container -* [kubectl explain](kubectl_explain.md) - Documentation of resources -* [kubectl expose](kubectl_expose.md) - Take a replication controller, service, deployment or pod and expose it as a new Kubernetes Service -* [kubectl get](kubectl_get.md) - Display one or many resources -* [kubectl label](kubectl_label.md) - Update the labels on a resource -* [kubectl logs](kubectl_logs.md) - Print the logs for a container in a pod -* [kubectl options](kubectl_options.md) - Print the list of flags inherited by all commands -* [kubectl patch](kubectl_patch.md) - Update field(s) of a resource using strategic merge patch -* [kubectl plugin](kubectl_plugin.md) - Provides utilities for interacting with plugins. -* [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 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 -* [kubectl set](kubectl_set.md) - Set specific features on objects -* [kubectl taint](kubectl_taint.md) - Update the taints on one or more nodes -* [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 a specific condition on one or many resources. - +* [kubectl alpha](/docs/reference/generated/kubectl/kubectl-commands#alpha) - Commands for features in alpha +* [kubectl annotate](/docs/reference/generated/kubectl/kubectl-commands#annotate) - Update the annotations on a resource +* [kubectl api-resources](/docs/reference/generated/kubectl/kubectl-commands#api-resources) - Print the supported API resources on the server +* [kubectl api-versions](/docs/reference/generated/kubectl/kubectl-commands#api-versions) - Print the supported API versions on the server, in the form of "group/version" +* [kubectl apply](/docs/reference/generated/kubectl/kubectl-commands#apply) - Apply a configuration to a resource by filename or stdin +* [kubectl attach](/docs/reference/generated/kubectl/kubectl-commands#attach) - Attach to a running container +* [kubectl auth](/docs/reference/generated/kubectl/kubectl-commands#auth) - Inspect authorization +* [kubectl autoscale](/docs/reference/generated/kubectl/kubectl-commands#autoscale) - Auto-scale a Deployment, ReplicaSet, or ReplicationController +* [kubectl certificate](/docs/reference/generated/kubectl/kubectl-commands#certificate) - Modify certificate resources. +* [kubectl cluster-info](/docs/reference/generated/kubectl/kubectl-commands#cluster-info) - Display cluster info +* [kubectl completion](/docs/reference/generated/kubectl/kubectl-commands#completion) - Output shell completion code for the specified shell (bash or zsh) +* [kubectl config](/docs/reference/generated/kubectl/kubectl-commands#config) - Modify kubeconfig files +* [kubectl convert](/docs/reference/generated/kubectl/kubectl-commands#convert) - Convert config files between different API versions +* [kubectl cordon](/docs/reference/generated/kubectl/kubectl-commands#cordon) - Mark node as unschedulable +* [kubectl cp](/docs/reference/generated/kubectl/kubectl-commands#cp) - Copy files and directories to and from containers. +* [kubectl create](/docs/reference/generated/kubectl/kubectl-commands#create) - Create a resource from a file or from stdin. +* [kubectl delete](/docs/reference/generated/kubectl/kubectl-commands#delete) - Delete resources by filenames, stdin, resources and names, or by resources and label selector +* [kubectl describe](/docs/reference/generated/kubectl/kubectl-commands#describe) - Show details of a specific resource or group of resources +* [kubectl drain](/docs/reference/generated/kubectl/kubectl-commands#drain) - Drain node in preparation for maintenance +* [kubectl edit](/docs/reference/generated/kubectl/kubectl-commands#edit) - Edit a resource on the server +* [kubectl exec](/docs/reference/generated/kubectl/kubectl-commands#exec) - Execute a command in a container +* [kubectl explain](/docs/reference/generated/kubectl/kubectl-commands#explain) - Documentation of resources +* [kubectl expose](/docs/reference/generated/kubectl/kubectl-commands#expose) - Take a replication controller, service, deployment or pod and expose it as a new Kubernetes Service +* [kubectl get](/docs/reference/generated/kubectl/kubectl-commands#get) - Display one or many resources +* [kubectl label](/docs/reference/generated/kubectl/kubectl-commands#label) - Update the labels on a resource +* [kubectl logs](/docs/reference/generated/kubectl/kubectl-commands#logs) - Print the logs for a container in a pod +* [kubectl options](/docs/reference/generated/kubectl/kubectl-commands#options) - Print the list of flags inherited by all commands +* [kubectl patch](/docs/reference/generated/kubectl/kubectl-commands#patch) - Update field(s) of a resource using strategic merge patch +* [kubectl plugin](/docs/reference/generated/kubectl/kubectl-commands#plugin) - Provides utilities for interacting with plugins. +* [kubectl port-forward](/docs/reference/generated/kubectl/kubectl-commands#port-forward) - Forward one or more local ports to a pod +* [kubectl proxy](/docs/reference/generated/kubectl/kubectl-commands#proxy) - Run a proxy to the Kubernetes API server +* [kubectl replace](/docs/reference/generated/kubectl/kubectl-commands#replace) - Replace a resource by filename or stdin +* [kubectl rollout](/docs/reference/generated/kubectl/kubectl-commands#rollout) - Manage the rollout of a resource +* [kubectl run](/docs/reference/generated/kubectl/kubectl-commands#run) - Run a particular image on the cluster +* [kubectl scale](/docs/reference/generated/kubectl/kubectl-commands#scale) - Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job +* [kubectl set](/docs/reference/generated/kubectl/kubectl-commands#set) - Set specific features on objects +* [kubectl taint](/docs/reference/generated/kubectl/kubectl-commands#taint) - Update the taints on one or more nodes +* [kubectl top](/docs/reference/generated/kubectl/kubectl-commands#top) - Display Resource (CPU/Memory/Storage) usage. +* [kubectl uncordon](/docs/reference/generated/kubectl/kubectl-commands#uncordon) - Mark node as schedulable +* [kubectl version](/docs/reference/generated/kubectl/kubectl-commands#version) - Print the client and server version information +* [kubectl wait](/docs/reference/generated/kubectl/kubectl-commands#wait) - Experimental: Wait for a specific condition on one or many resources. diff --git a/content/en/docs/reference/kubernetes-api/index.md b/content/en/docs/reference/kubernetes-api/index.md index 8c2c6fab83..bb5a42fee9 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.11 +title: v1.12 --- -[Kubernetes API v1.11](/docs/reference/generated/kubernetes-api/v1.11/) +[Kubernetes API v1.12](/docs/reference/generated/kubernetes-api/v1.12/) 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 4643946ce5..cc288daa97 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 @@ -16,7 +16,7 @@ provide a file - a subset of the standard kubeconfig file. This file can be a local file or downloaded via an HTTPS URL. The forms are kubeadm join --discovery-token abcdef.1234567890abcdef 1.2.3.4:6443, kubeadm join --discovery-file path/to/file.conf, or kubeadm join ---discovery-file https://url/file.conf. Only one form can be used. If +--discovery-file `https://url/file.conf`. Only one form can be used. If the discovery information is loaded from a URL, HTTPS must be used. Also, in that case the host installed CA bundle is used to verify the connection. 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 67fcee964a..09cc412595 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/implementation-details.md +++ b/content/en/docs/reference/setup-tools/kubeadm/implementation-details.md @@ -86,7 +86,7 @@ In any case the user can skip specific preflight checks (or eventually all prefl - [error] if not Kernel 3.10+ or 4+ with specific KernelSpec - [error] if required cgroups subsystem aren't in set up - if using docker: - - [warning/error] if Docker service does not exists, if it is disabled, if it is not active. + - [warning/error] if Docker service does not exist, if it is disabled, if it is not active. - [error] if Docker endpoint does not exist or does not work - [warning] if docker version >17.03 - If using other cri engine: 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 9562bb7829..4a26f55110 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md +++ b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md @@ -106,8 +106,8 @@ It is **recommended** that you migrate your old `v1alpha2` configuration to `v1a the [kubeadm config migrate](/docs/reference/setup-tools/kubeadm/kubeadm-config/) command, because `v1alpha2` will be removed in Kubernetes 1.13. -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) +For more details on each field in the `v1alpha3` configuration you can navigate to our +[API reference pages.] (https://godoc.org/k8s.io/kubernetes/cmd/kubeadm/app/apis/kubeadm/v1alpha3) ### Adding kube-proxy parameters {#kube-proxy} @@ -226,7 +226,7 @@ Other CRI-based runtimes include: - [frakti](https://github.com/kubernetes/frakti) - [rkt](https://github.com/kubernetes-incubator/rktlet) -Refer to the [CRI installation instructions](/docs/setup/cri.md) for more information. +Refer to the [CRI installation instructions](/docs/setup/cri) for more information. After you have successfully installed `kubeadm` and `kubelet`, execute these two additional steps: @@ -411,4 +411,4 @@ provisioned). For details, see the [kubeadm join](/docs/reference/setup-tools/ku * [kubeadm join](/docs/reference/setup-tools/kubeadm/kubeadm-join/) to bootstrap a Kubernetes worker node and join it to the cluster * [kubeadm upgrade](/docs/reference/setup-tools/kubeadm/kubeadm-upgrade/) to upgrade a Kubernetes cluster to a newer version * [kubeadm reset](/docs/reference/setup-tools/kubeadm/kubeadm-reset/) to revert any changes made to this host by `kubeadm init` or `kubeadm join` -{{% /capture %}} +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-upgrade.md b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-upgrade.md index 3fb5856448..e97ae9b2e0 100644 --- a/content/en/docs/reference/setup-tools/kubeadm/kubeadm-upgrade.md +++ b/content/en/docs/reference/setup-tools/kubeadm/kubeadm-upgrade.md @@ -19,14 +19,10 @@ cluster if necessary. Every upgrade process might be a bit different, so we've documented each minor upgrade process individually. For more version-specific upgrade guidance, see the following resources: - * [1.7.x to 1.7.y upgrades](/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-8/) - * [1.7 to 1.8 upgrades](/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-8/) - * [1.8.x to 1.8.y upgrades](/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-8/) - * [1.8.x to 1.9.x upgrades](/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-9/) - * [1.9.x to 1.9.y upgrades](/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-9/) - * [1.9.x to 1.9.y HA cluster upgrades](/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-ha/) * [1.10 to 1.11 upgrades](/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-11/) * [1.11 to 1.12 upgrades](/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-12/) + +_For older versions, please refer to older documentation sets on the Kubernetes website._ In Kubernetes v1.11.0 and later, you can use `kubeadm upgrade diff` to see the changes that would be applied to static pod manifests. @@ -50,4 +46,4 @@ applied to static pod manifests. {{% capture whatsnext %}} * [kubeadm config](/docs/reference/setup-tools/kubeadm/kubeadm-config/) if you initialized your cluster using kubeadm v1.7.x or lower, to configure your cluster for `kubeadm upgrade` -{{% /capture %}} +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/reference/using-api/api-concepts.md b/content/en/docs/reference/using-api/api-concepts.md index 623e2b9937..1ac0712f47 100644 --- a/content/en/docs/reference/using-api/api-concepts.md +++ b/content/en/docs/reference/using-api/api-concepts.md @@ -164,7 +164,7 @@ For example: 1. List all of the pods on a cluster in the Table format. GET /api/v1/pods - Accept: application/json;as=Table;v=meta.k8s.io;g=v1beta1 + Accept: application/json;as=Table;g=meta.k8s.io;v=v1beta1 --- 200 OK Content-Type: application/json @@ -205,7 +205,7 @@ For API resource types that do not have a custom Table definition on the server, Table responses are available beginning in version 1.10 of the kube-apiserver. As such, not all API resource types will support a Table response, specifically when using a client against older clusters. Clients that must work against all resource types, or can potentially deal with older clusters, should specify multiple content types in their `Accept` header to support fallback to non-Tabular JSON: ``` -Accept: application/json;as=Table;v=meta.k8s.io;g=v1beta1, application/json +Accept: application/json;as=Table;g=meta.k8s.io;v=v1beta1, application/json ``` diff --git a/content/en/docs/setup/_index.md b/content/en/docs/setup/_index.md index 128ead127f..a47d59bf3e 100644 --- a/content/en/docs/setup/_index.md +++ b/content/en/docs/setup/_index.md @@ -75,7 +75,7 @@ You should pick a on-prem turnkey cloud solution if you: * Want to deploy clusters on your private cloud network * Have a dedicated SRE team -* Have the the resources to host and monitor your clusters +* Have the resources to host and monitor your clusters Pick an [on-prem turnkey cloud solution](/docs/setup/pick-right-solution/#on-premises-turnkey-cloud-solutions). diff --git a/content/en/docs/setup/independent/create-cluster-kubeadm.md b/content/en/docs/setup/independent/create-cluster-kubeadm.md index cd23475401..e37bea2a1c 100644 --- a/content/en/docs/setup/independent/create-cluster-kubeadm.md +++ b/content/en/docs/setup/independent/create-cluster-kubeadm.md @@ -30,7 +30,7 @@ scope. You can install _kubeadm_ very easily on operating systems that support installing deb or rpm packages. The responsible SIG for kubeadm, [SIG Cluster Lifecycle](https://github.com/kubernetes/community/tree/master/sig-cluster-lifecycle), provides these packages pre-built for you, -but you may also on other OSes. +but you may also build them from source for other OSes. ### kubeadm Maturity @@ -317,14 +317,10 @@ Set `/proc/sys/net/bridge/bridge-nf-call-iptables` to `1` by running `sysctl net to pass bridged IPv4 traffic to iptables' chains. This is a requirement for some CNI plugins to work, for more information please see [here](https://kubernetes.io/docs/concepts/cluster-administration/network-plugins/#network-plugin-requirements). -```shell -kubectl apply -f https://raw.githubusercontent.com/coreos/flannel/v0.10.0/Documentation/kube-flannel.yml -``` -Note that `flannel` works on `amd64`, `arm`, `arm64` and `ppc64le`, but until `flannel v0.11.0` is released -you need to use the following manifest that supports all the architectures: +Note that `flannel` works on `amd64`, `arm`, `arm64` and `ppc64le`. ```shell -kubectl apply -f https://raw.githubusercontent.com/coreos/flannel/c5d10c8/Documentation/kube-flannel.yml +kubectl apply -f https://raw.githubusercontent.com/coreos/flannel/bc79dd1505b0c8681ece4de4c0d86c5cd2643275/Documentation/kube-flannel.yml ``` For more information about `flannel`, see [the CoreOS flannel repository on GitHub diff --git a/content/en/docs/setup/independent/high-availability.md b/content/en/docs/setup/independent/high-availability.md index fdf3df5def..226409b48f 100644 --- a/content/en/docs/setup/independent/high-availability.md +++ b/content/en/docs/setup/independent/high-availability.md @@ -306,6 +306,7 @@ done ```sh kubeadm alpha phase kubeconfig all --config kubeadm-config.yaml kubeadm alpha phase controlplane all --config kubeadm-config.yaml + kubeadm alpha phase kubelet config annotate-cri --config kubeadm-config.yaml kubeadm alpha phase mark-master --config kubeadm-config.yaml ``` @@ -393,6 +394,7 @@ done ```sh kubeadm alpha phase kubeconfig all --config kubeadm-config.yaml kubeadm alpha phase controlplane all --config kubeadm-config.yaml + kubeadm alpha phase kubelet config annotate-cri --config kubeadm-config.yaml kubeadm alpha phase mark-master --config kubeadm-config.yaml ``` diff --git a/content/en/docs/setup/independent/install-kubeadm.md b/content/en/docs/setup/independent/install-kubeadm.md index df670972c5..e79a1635a7 100644 --- a/content/en/docs/setup/independent/install-kubeadm.md +++ b/content/en/docs/setup/independent/install-kubeadm.md @@ -23,11 +23,11 @@ see the [Using kubeadm to Create a Cluster](/docs/setup/independent/create-clust - HypriotOS v1.0.1+ - Container Linux (tested with 1800.6.0) * 2 GB or more of RAM per machine (any less will leave little room for your apps) -* 2 CPUs or more +* 2 CPUs or more * Full network connectivity between all machines in the cluster (public or private network is fine) * Unique hostname, MAC address, and product_uuid for every node. See [here](#verify-the-mac-address-and-product-uuid-are-unique-for-every-node) for more details. * Certain ports are open on your machines. See [here](#check-required-ports) for more details. -* Swap disabled. You **MUST** disable swap in order for the kubelet to work properly. +* Swap disabled. You **MUST** disable swap in order for the kubelet to work properly. {{% /capture %}} @@ -87,12 +87,12 @@ The container runtime used by default is Docker, which is enabled through the bu Other CRI-based runtimes include: -- [cri-containerd](https://github.com/containerd/cri-containerd) +- [containerd](https://github.com/containerd/cri) (CRI plugin built into containerd) - [cri-o](https://github.com/kubernetes-incubator/cri-o) - [frakti](https://github.com/kubernetes/frakti) - [rkt](https://github.com/kubernetes-incubator/rktlet) -Refer to the [CRI installation instructions](/docs/setup/cri.md) for more information. +Refer to the [CRI installation instructions](/docs/setup/cri) for more information. ## Installing kubeadm, kubelet and kubectl @@ -105,10 +105,10 @@ You will install these packages on all of your machines: * `kubectl`: the command line util to talk to your cluster. -kubeadm **will not** install or manage `kubelet` or `kubectl` for you, so you will -need to ensure they match the version of the Kubernetes control panel you want +kubeadm **will not** install or manage `kubelet` or `kubectl` for you, so you will +need to ensure they match the version of the Kubernetes control panel you want kubeadm to install for you. If you do not, there is a risk of a version skew occurring that -can lead to unexpected, buggy behaviour. However, _one_ minor version skew between the +can lead to unexpected, buggy behaviour. However, _one_ minor version skew between the kubelet and the control plane is supported, but the kubelet version may never exceed the API server version. For example, kubelets running 1.7.0 should be fully compatible with a 1.8.0 API server, but not vice versa. @@ -119,7 +119,7 @@ This is because kubeadm and Kubernetes require [special attention to upgrade](/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-11/). {{}} -For more information on version skews, please read our +For more information on version skews, please read our [version skew policy](/docs/setup/independent/create-cluster-kubeadm/#version-skew-policy). {{< tabs name="k8s_install" >}} @@ -128,7 +128,7 @@ For more information on version skews, please read our apt-get update && apt-get install -y apt-transport-https curl curl -s https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key add - cat </etc/apt/sources.list.d/kubernetes.list -deb http://apt.kubernetes.io/ kubernetes-xenial main +deb https://apt.kubernetes.io/ kubernetes-xenial main EOF apt-get update apt-get install -y kubelet kubeadm kubectl @@ -147,18 +147,24 @@ repo_gpgcheck=1 gpgkey=https://packages.cloud.google.com/yum/doc/yum-key.gpg https://packages.cloud.google.com/yum/doc/rpm-package-key.gpg exclude=kube* EOF + +# Set SELinux in permissive mode (effectively disabling it) setenforce 0 +sed -i 's/^SELINUX=enforcing$/SELINUX=permissive/' /etc/selinux/config + yum install -y kubelet kubeadm kubectl --disableexcludes=kubernetes + systemctl enable kubelet && systemctl start kubelet ``` **Note:** - - Disabling SELinux by running `setenforce 0` is required to allow containers to access the host filesystem, which is required by pod networks for example. + - Setting SELinux in permissive mode by running `setenforce 0` and `sed ...` effectively disables it. + This is required to allow containers to access the host filesystem, which is needed by pod networks for example. You have to do this until SELinux support is improved in the kubelet. - Some users on RHEL/CentOS 7 have reported issues with traffic being routed incorrectly due to iptables being bypassed. You should ensure `net.bridge.bridge-nf-call-iptables` is set to 1 in your `sysctl` config, e.g. - + ```bash cat < /etc/sysctl.d/k8s.conf net.bridge.bridge-nf-call-ip6tables = 1 @@ -244,8 +250,4 @@ If you are running into difficulties with kubeadm, please consult our [troublesh * [Using kubeadm to Create a Cluster](/docs/setup/independent/create-cluster-kubeadm/) -{{% /capture %}} - - - - +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/setup/minikube.md b/content/en/docs/setup/minikube.md index 9ae0b34c24..09ecfc62cc 100644 --- a/content/en/docs/setup/minikube.md +++ b/content/en/docs/setup/minikube.md @@ -64,11 +64,34 @@ NAME READY STATUS RESTARTS AGE hello-minikube-3383150820-vctvh 1/1 Running 0 13s # We can see that the pod is now Running and we will now be able to curl it: $ curl $(minikube service hello-minikube --url) -CLIENT VALUES: -client_address=192.168.99.1 -command=GET -real path=/ -... + + +Hostname: hello-minikube-7c77b68cff-8wdzq + +Pod Information: + -no pod information available- + +Server values: + server_version=nginx: 1.13.3 - lua: 10008 + +Request Information: + client_address=172.17.0.1 + method=GET + real path=/ + query= + request_version=1.1 + request_scheme=http + request_uri=http://192.168.99.100:8080/ + +Request Headers: + accept=*/* + host=192.168.99.100:30674 + user-agent=curl/7.47.0 + +Request Body: + -no body in request- + + $ kubectl delete services hello-minikube service "hello-minikube" deleted $ kubectl delete deployment hello-minikube @@ -195,13 +218,6 @@ To switch back to this context later, run this command: `kubectl config use-cont #### Specifying the Kubernetes version -Minikube supports running multiple different versions of Kubernetes. You can -access a list of all available versions via - -``` -minikube get-k8s-versions -``` - You can specify the specific version of Kubernetes for Minikube to use by adding the `--kubernetes-version` string to the `minikube start` command. For example, to run version `v1.7.3`, you would run the following: @@ -223,12 +239,12 @@ configuration struct and `value` is the value to set. Valid keys can be found by examining the documentation for the Kubernetes `componentconfigs` for each component. Here is the documentation for each supported configuration: -* [kubelet](https://godoc.org/k8s.io/kubernetes/pkg/kubelet/apis/kubeletconfig#KubeletConfiguration) +* [kubelet](https://godoc.org/k8s.io/kubernetes/pkg/kubelet/apis/config#KubeletConfiguration) * [apiserver](https://godoc.org/k8s.io/kubernetes/cmd/kube-apiserver/app/options#ServerRunOptions) -* [proxy](https://godoc.org/k8s.io/kubernetes/pkg/proxy/apis/kubeproxyconfig#KubeProxyConfiguration) -* [controller-manager](https://godoc.org/k8s.io/kubernetes/pkg/apis/componentconfig#KubeControllerManagerConfiguration) +* [proxy](https://godoc.org/k8s.io/kubernetes/pkg/proxy/apis/config#KubeProxyConfiguration) +* [controller-manager](https://godoc.org/k8s.io/kubernetes/pkg/controller/apis/config#KubeControllerManagerConfiguration) * [etcd](https://godoc.org/github.com/coreos/etcd/etcdserver#ServerConfig) -* [scheduler](https://godoc.org/k8s.io/kubernetes/pkg/apis/componentconfig#KubeSchedulerConfiguration) +* [scheduler](https://godoc.org/k8s.io/kubernetes/pkg/scheduler/apis/config#KubeSchedulerConfiguration) #### Examples diff --git a/content/en/docs/setup/multiple-zones.md b/content/en/docs/setup/multiple-zones.md index d98604c25e..e050489730 100644 --- a/content/en/docs/setup/multiple-zones.md +++ b/content/en/docs/setup/multiple-zones.md @@ -126,10 +126,10 @@ and `failure-domain.beta.kubernetes.io/zone` for the zone: NAME STATUS ROLES AGE VERSION LABELS -kubernetes-master Ready,SchedulingDisabled 6m v1.11.1 beta.kubernetes.io/instance-type=n1-standard-1,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-a,kubernetes.io/hostname=kubernetes-master -kubernetes-minion-87j9 Ready 6m v1.11.1 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-a,kubernetes.io/hostname=kubernetes-minion-87j9 -kubernetes-minion-9vlv Ready 6m v1.11.1 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-a,kubernetes.io/hostname=kubernetes-minion-9vlv -kubernetes-minion-a12q Ready 6m v1.11.1 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-a,kubernetes.io/hostname=kubernetes-minion-a12q +kubernetes-master Ready,SchedulingDisabled 6m v1.12.0 beta.kubernetes.io/instance-type=n1-standard-1,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-a,kubernetes.io/hostname=kubernetes-master +kubernetes-minion-87j9 Ready 6m v1.12.0 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-a,kubernetes.io/hostname=kubernetes-minion-87j9 +kubernetes-minion-9vlv Ready 6m v1.12.0 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-a,kubernetes.io/hostname=kubernetes-minion-9vlv +kubernetes-minion-a12q Ready 6m v1.12.0 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-a,kubernetes.io/hostname=kubernetes-minion-a12q ``` ### Add more nodes in a second zone @@ -161,13 +161,13 @@ in us-central1-b: > kubectl get nodes --show-labels NAME STATUS ROLES AGE VERSION LABELS -kubernetes-master Ready,SchedulingDisabled 16m v1.11.1 beta.kubernetes.io/instance-type=n1-standard-1,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-a,kubernetes.io/hostname=kubernetes-master -kubernetes-minion-281d Ready 2m v1.11.1 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-b,kubernetes.io/hostname=kubernetes-minion-281d -kubernetes-minion-87j9 Ready 16m v1.11.1 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-a,kubernetes.io/hostname=kubernetes-minion-87j9 -kubernetes-minion-9vlv Ready 16m v1.11.1 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-a,kubernetes.io/hostname=kubernetes-minion-9vlv -kubernetes-minion-a12q Ready 17m v1.11.1 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-a,kubernetes.io/hostname=kubernetes-minion-a12q -kubernetes-minion-pp2f Ready 2m v1.11.1 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-b,kubernetes.io/hostname=kubernetes-minion-pp2f -kubernetes-minion-wf8i Ready 2m v1.11.1 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-b,kubernetes.io/hostname=kubernetes-minion-wf8i +kubernetes-master Ready,SchedulingDisabled 16m v1.12.0 beta.kubernetes.io/instance-type=n1-standard-1,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-a,kubernetes.io/hostname=kubernetes-master +kubernetes-minion-281d Ready 2m v1.12.0 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-b,kubernetes.io/hostname=kubernetes-minion-281d +kubernetes-minion-87j9 Ready 16m v1.12.0 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-a,kubernetes.io/hostname=kubernetes-minion-87j9 +kubernetes-minion-9vlv Ready 16m v1.12.0 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-a,kubernetes.io/hostname=kubernetes-minion-9vlv +kubernetes-minion-a12q Ready 17m v1.12.0 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-a,kubernetes.io/hostname=kubernetes-minion-a12q +kubernetes-minion-pp2f Ready 2m v1.12.0 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-b,kubernetes.io/hostname=kubernetes-minion-pp2f +kubernetes-minion-wf8i Ready 2m v1.12.0 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-b,kubernetes.io/hostname=kubernetes-minion-wf8i ``` ### Volume affinity @@ -288,9 +288,9 @@ Node: kubernetes-minion-olsh/10.240.0.11 > kubectl get node kubernetes-minion-9vlv kubernetes-minion-281d kubernetes-minion-olsh --show-labels NAME STATUS ROLES AGE VERSION LABELS -kubernetes-minion-9vlv Ready 34m v1.11.1 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-a,kubernetes.io/hostname=kubernetes-minion-9vlv -kubernetes-minion-281d Ready 20m v1.11.1 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-b,kubernetes.io/hostname=kubernetes-minion-281d -kubernetes-minion-olsh Ready 3m v1.11.1 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-f,kubernetes.io/hostname=kubernetes-minion-olsh +kubernetes-minion-9vlv Ready 34m v1.12.0 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-a,kubernetes.io/hostname=kubernetes-minion-9vlv +kubernetes-minion-281d Ready 20m v1.12.0 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-b,kubernetes.io/hostname=kubernetes-minion-281d +kubernetes-minion-olsh Ready 3m v1.12.0 beta.kubernetes.io/instance-type=n1-standard-2,failure-domain.beta.kubernetes.io/region=us-central1,failure-domain.beta.kubernetes.io/zone=us-central1-f,kubernetes.io/hostname=kubernetes-minion-olsh ``` diff --git a/content/en/docs/setup/on-premises-metal/krib.md b/content/en/docs/setup/on-premises-metal/krib.md new file mode 100644 index 0000000000..10dcbe99bf --- /dev/null +++ b/content/en/docs/setup/on-premises-metal/krib.md @@ -0,0 +1,95 @@ +--- +title: Installing Kubernetes with Digital Rebar Provision (DRP) via KRIB +krib-version: 2.4 +author: Rob Hirschfeld (zehicle) +--- + +## Overview + +This guide helps to install a Kubernetes cluster hosted on bare metal with [Digital Rebar Provision](https://github.com/digitalrebar/provision) using only its Content packages and *kubeadm*. + +Digital Rebar Provision (DRP) is an integrated Golang DHCP, bare metal provisioning (PXE/iPXE) and workflow automation platform. While [DRP can be used to invoke](https://provision.readthedocs.io/en/tip/doc/integrations/ansible.html) [kubespray](../kubespray), it also offers a self-contained Kubernetes installation known as [KRIB (Kubernetes Rebar Integrated Bootstrap)](https://github.com/digitalrebar/provision-content/tree/master/krib). + +{{< note >}} +**Note:** KRIB is not a _stand-alone_ installer: Digital Rebar templates drive a standard *[kubeadm](/docs/admin/kubeadm/)* configuration that manages the Kubernetes installation with the [Digital Rebar cluster pattern](https://provision.readthedocs.io/en/tip/doc/arch/cluster.html#rs-cluster-pattern) to elect leaders _without external supervision_. +{{< /note >}} + + +KRIB features: + +* zero-touch, self-configuring cluster without pre-configuration or inventory +* very fast, no-ssh required automation +* bare metal, on-premises focused platform +* highly available cluster options (including splitting etcd from the controllers) +* dynamic generation of a TLS infrastructure +* composable attributes and automatic detection of hardware by profile +* options for persistent, immutable and image-based deployments +* support for Ubuntu 18.04, CentOS/RHEL 7 and others + +## Creating a cluster + +Review [Digital Rebar documentation](https://https://provision.readthedocs.io/en/tip/README.html) for details about installing the platform. + +The Digital Rebar Provision Golang binary should be installed on a Linux-like system with 16 GB of RAM or larger (Packet.net Tiny and Rasberry Pi are also acceptable). + +### (1/5) Discover servers + +Following the [Digital Rebar installation](https://provision.readthedocs.io/en/tip/doc/quickstart.html), allow one or more servers to boot through the _Sledgehammer_ discovery process to register with the API. This will automatically install the Digital Rebar runner and to allow for next steps. + +### (2/5) Install KRIB Content and Certificate Plugin + +Upload the KRIB Content bundle (or build from [source](https://github.com/digitalrebar/provision-content/tree/master/krib)) and the Cert Plugin for your DRP platform (e.g.: [amd64 Linux v2.4.0](https://s3-us-west-2.amazonaws.com/rebar-catalog/certs/v2.4.0-0-02301d35f9f664d6c81d904c92a9c81d3fd41d2c/amd64/linux/certs)). Both are freely available via the [RackN UX](https://portal.rackn.io). + +### (3/5) Start your cluster deployment + +{{< note >}} +**Note:** KRIB documentation is dynamically generated from the source and will be more up to date than this guide. +{{< /note >}} + +Following the [KRIB documentation](https://provision.readthedocs.io/en/tip/doc/content-packages/krib.html), create a Profile for your cluster and assign your target servers into the cluster Profile. The Profile must set `krib\cluster-name` and `etcd\cluster-name` Params to be the name of the Profile. Cluster configuration choices can be made by adding additional Params to the Profile; however, safe defaults are provided for all Params. + +Once all target servers are assigned to the cluster Profile, start a KRIB installation Workflow by assigning one of the included Workflows to all cluster servers. For example, selecting `krib-live-cluster` will perform an immutable deployment into the Sledgehammer discovery operating system. You may use one of the pre-created read-only Workflows or choose to build your own custom variation. + +For basic installs, no further action is required. Advanced users may choose to assign the controllers, etcd servers or other configuration values in the relevant Params. + +### (4/5) Monitor your cluster deployment + +Digital Rebar Provision provides detailed logging and live updates during the installation process. Workflow events are available via a websocket connection or monitoring the Jobs list. + +During the installation, KRIB writes cluster configuration data back into the cluster Profile. + +### (5/5) Access your cluster + +The cluster is available for access via *kubectl* once the `krib/cluster-admin-conf` Param has been set. This Param contains the `kubeconfig` information necessary to access the cluster. + +For example, if you named the cluster Profile `krib` then the following commands would allow you to connect to the installed cluster from your local terminal. + + :: + + drpcli profiles get krib params krib/cluster-admin-conf > admin.conf + export KUBECONFIG=admin.conf + kubectl get nodes + + +The installation continues after the `krib/cluster-admin-conf` is set to install the Kubernetes UI and Helm. You may interact with the cluster as soon as the `admin.conf` file is available. + +## Cluster operations + +KRIB provides additional Workflows to manage your cluster. Please see the [KRIB documentation](https://provision.readthedocs.io/en/tip/doc/content-packages/krib.html) for an updated list of advanced cluster operations. + +### Scale your cluster + +You can add servers into your cluster by adding the cluster Profile to the server and running the appropriate Workflow. + +### Cleanup your cluster (for developers) + +You can reset your cluster and wipe out all configuration and TLS certificates using the the `krib-reset-cluster` Workflow on any of the servers in the cluster. + +{{< caution >}} +**Caution:** When running the reset Workflow, be sure not to accidentally target your production cluster! +{{< /caution >}} + +## Feedback + +* Slack Channel: [#community](https://rackn.slack.com/messages/community/) +* [GitHub Issues](https://github.com/digital/provision/issues) diff --git a/content/en/docs/setup/pick-right-solution.md b/content/en/docs/setup/pick-right-solution.md index e0cef0f713..882563a57c 100644 --- a/content/en/docs/setup/pick-right-solution.md +++ b/content/en/docs/setup/pick-right-solution.md @@ -34,6 +34,8 @@ a Kubernetes cluster from scratch. * [Minikube](/docs/setup/minikube/) is the recommended method for creating a local, single-node Kubernetes cluster for development and testing. Setup is completely automated and doesn't require a cloud provider account. +* [microk8s](https://microk8s.io/) provides a single command installation of the latest Kubernetes release on a local machine for development and testing. Setup is quick, fast (~30 sec) and supports many plugins including Istio with a single command. + * [IBM Cloud Private-CE (Community Edition)](https://github.com/IBM/deploy-ibm-cloud-private) can use VirtualBox on your machine to deploy Kubernetes to one or more VMs for development and test scenarios. Scales to full multi-node cluster. * [IBM Cloud Private-CE (Community Edition) on Linux Containers](https://github.com/HSBawa/icp-ce-on-linux-containers) is a Terraform/Packer/BASH based Infrastructure as Code (IaC) scripts to create a seven node (1 Boot, 1 Master, 1 Management, 1 Proxy and 3 Workers) LXD cluster on Linux Host. @@ -95,6 +97,7 @@ few commands. These solutions are actively developed and have active community s * [Madcore.Ai](https://madcore.ai/) * [Oracle Container Engine for K8s](https://docs.us-phoenix-1.oraclecloud.com/Content/ContEng/Concepts/contengprerequisites.htm) * [Pivotal Container Service](https://pivotal.io/platform/pivotal-container-service) +* [Giant Swarm](https://giantswarm.io) * [Rancher 2.0](https://rancher.com/docs/rancher/v2.x/en/) * [Stackpoint.io](/docs/setup/turnkey/stackpoint/) * [Tectonic by CoreOS](https://coreos.com/tectonic) @@ -105,11 +108,13 @@ few commands. * [Agile Stacks](https://www.agilestacks.com/products/kubernetes) * [APPUiO](https://appuio.ch) +* [GKE On-Prem | Google Cloud](https://cloud.google.com/gke-on-prem/) * [IBM Cloud Private](https://www.ibm.com/cloud-computing/products/ibm-cloud-private/) * [Kontena Pharos](https://kontena.io/pharos/) * [Kubermatic](https://www.loodse.com) * [Kublr](https://kublr.com/) * [Pivotal Container Service](https://pivotal.io/platform/pivotal-container-service) +* [Giant Swarm](https://giantswarm.io) * [Rancher 2.0](https://rancher.com/docs/rancher/v2.x/en/) * [SUSE CaaS Platform](https://www.suse.com/products/caas-platform) * [SUSE Cloud Application Platform](https://www.suse.com/products/cloud-application-platform/) @@ -157,6 +162,7 @@ These solutions are combinations of cloud providers and operating systems not co ### Bare Metal * [CoreOS](/docs/setup/custom-cloud/coreos/) +* [Digital Rebar](/docs/setup/on-premises-metal/krib/) * [Fedora (Single Node)](/docs/getting-started-guides/fedora/fedora_manual_config/) * [Fedora (Multi Node)](/docs/getting-started-guides/fedora/flannel_multi_node_cluster/) * [Kubernetes on Ubuntu](/docs/getting-started-guides/ubuntu/) @@ -218,6 +224,7 @@ any | [Gardener Cluster-Operator](https://kubernetes.io/blog/20 Alibaba Cloud Container Service For Kubernetes | ROS | CentOS | flannel/Terway | [docs](https://www.aliyun.com/product/containerservice) | Commercial Agile Stacks | Terraform | CoreOS | multi-support | [docs](https://www.agilestacks.com/products/kubernetes) | Commercial IBM Cloud Kubernetes Service | | Ubuntu | calico | [docs](https://console.bluemix.net/docs/containers/container_index.html) | Commercial +Digital Rebar | kubeadm | any | metal | [docs](/docs/setup/on-premises-metal/krib/) | Community ([@digitalrebar](https://github.com/digitalrebar)) {{< note >}} diff --git a/content/en/docs/setup/scratch.md b/content/en/docs/setup/scratch.md index cbf1808e8e..8645a487ab 100644 --- a/content/en/docs/setup/scratch.md +++ b/content/en/docs/setup/scratch.md @@ -198,7 +198,7 @@ We recommend that you use the etcd version which is provided in the Kubernetes b were tested extensively with this version of etcd and not with any other version. The recommended version number can also be found as the value of `TAG` in `kubernetes/cluster/images/etcd/Makefile`. -For the miniumum recommended version of etcd, refer to +For the minimum recommended version of etcd, refer to [Configuring and Updating etcd](/docs/tasks/administer-cluster/configure-upgrade-etcd/) The remainder of the document assumes that the image identifiers have been chosen and stored in corresponding env vars. Examples (replace with latest tags and appropriate registry): diff --git a/content/en/docs/tasks/access-application-cluster/configure-access-multiple-clusters.md b/content/en/docs/tasks/access-application-cluster/configure-access-multiple-clusters.md index cdebb3015c..236e91bc8d 100644 --- a/content/en/docs/tasks/access-application-cluster/configure-access-multiple-clusters.md +++ b/content/en/docs/tasks/access-application-cluster/configure-access-multiple-clusters.md @@ -22,14 +22,6 @@ It does not mean that there is a file named `kubeconfig`. {{% capture prerequisites %}} -You need to have the [`kubectl`](/docs/tasks/tools/install-kubectl/) command-line tool installed. - -{{% /capture %}} - -{{< toc >}} - -{{% capture prerequisites %}} - {{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} {{% /capture %}} diff --git a/content/en/docs/tasks/access-kubernetes-api/setup-extension-api-server.md b/content/en/docs/tasks/access-kubernetes-api/setup-extension-api-server.md index f1fdc298d6..71c6059eec 100644 --- a/content/en/docs/tasks/access-kubernetes-api/setup-extension-api-server.md +++ b/content/en/docs/tasks/access-kubernetes-api/setup-extension-api-server.md @@ -16,15 +16,10 @@ Setting up an extension API server to work the aggregation layer allows the Kube {{% capture prerequisites %}} -* You need to have a Kubernetes cluster running. -* You must [configure the aggregation layer](/docs/tasks/access-kubernetes-api/configure-aggregation-layer/) and enable the apiserver flags. - -{{% /capture %}} - -{{% capture prerequisites %}} - {{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} +* You must [configure the aggregation layer](/docs/tasks/access-kubernetes-api/configure-aggregation-layer/) and enable the apiserver flags. + {{% /capture %}} {{% capture steps %}} diff --git a/content/en/docs/tasks/administer-cluster/cluster-management.md b/content/en/docs/tasks/administer-cluster/cluster-management.md index 8059db0f31..2871b52d03 100644 --- a/content/en/docs/tasks/administer-cluster/cluster-management.md +++ b/content/en/docs/tasks/administer-cluster/cluster-management.md @@ -73,6 +73,7 @@ Different providers, and tools, will manage upgrades differently. It is recomme * [kops](https://github.com/kubernetes/kops) * [kubespray](https://github.com/kubernetes-incubator/kubespray) * [CoreOS Tectonic](https://coreos.com/tectonic/docs/latest/admin/upgrade.html) +* [Digital Rebar](https://provision.readthedocs.io/en/tip/doc/content-packages/krib.html) * ... ## Resizing a cluster @@ -214,4 +215,4 @@ You can use `kubectl convert` command to convert config files between different kubectl convert -f pod.yaml --output-version v1 ``` -For more options, please refer to the usage of [kubectl convert](/docs/user-guide/kubectl/{{page.version}}/#convert) command. +For more options, please refer to the usage of [kubectl convert](/docs/reference/generated/kubectl/kubectl-commands#convert) command. diff --git a/content/en/docs/tasks/administer-cluster/coredns.md b/content/en/docs/tasks/administer-cluster/coredns.md index 1779246362..e0d6c30e3b 100644 --- a/content/en/docs/tasks/administer-cluster/coredns.md +++ b/content/en/docs/tasks/administer-cluster/coredns.md @@ -7,7 +7,7 @@ content_template: templates/task --- {{% capture overview %}} -This page describes the CoreDNS upgrade process and how to install kube-dns instead of CoreDNS. +This page describes the CoreDNS upgrade process and how to install CoreDNS instead of kube-dns. {{% /capture %}} {{% capture prerequisites %}} @@ -29,15 +29,6 @@ deployment, or by using tools like kubeadm that will deploy and upgrade the clus For manual deployment or replacement of kube-dns, see the documentation at the [CoreDNS GitHub project.](https://github.com/coredns/deployment/tree/master/kubernetes) -## Installing CoreDNS with kubeadm - -In Kubernetes 1.11, CoreDNS has graduated to General Availability (GA) -and is installed by default. To install kube-dns instead, set the `CoreDNS` feature gate -value to `false`: -``` -kubeadm init --feature-gates=CoreDNS=false -``` - ## Upgrading an existing cluster with kubeadm In Kubernetes version 1.10 and later, you can also move to CoreDNS when you use `kubeadm` to upgrade @@ -58,6 +49,20 @@ customizations after the new ConfigMap is up and running. If you are running CoreDNS in Kubernetes version 1.11 and later, during upgrade, your existing Corefile will be retained. +## Installing kube-dns instead of CoreDNS with kubeadm + +{{< note >}} +**Note:** In Kubernetes 1.11, CoreDNS has graduated to General Availability (GA) +and is installed by default. +{{< /note >}} + +To install kube-dns instead, set the `CoreDNS` feature gate +value to `false`: + +``` +kubeadm init --feature-gates=CoreDNS=false +``` + {{% /capture %}} {{% capture whatsnext %}} diff --git a/content/en/docs/tasks/administer-cluster/declare-network-policy.md b/content/en/docs/tasks/administer-cluster/declare-network-policy.md index 60f2a276fe..db27d97ce5 100644 --- a/content/en/docs/tasks/administer-cluster/declare-network-policy.md +++ b/content/en/docs/tasks/administer-cluster/declare-network-policy.md @@ -9,22 +9,19 @@ content_template: templates/task This document helps you get started using the Kubernetes [NetworkPolicy API](/docs/concepts/services-networking/network-policies/) to declare network policies that govern how pods communicate with each other. {{% /capture %}} -{{% capture prerequisites %}} -You'll need to have a Kubernetes cluster in place, with network policy support. There are a number of network providers that support NetworkPolicy, including: - -* [Calico](/docs/tasks/configure-pod-container/calico-network-policy/) -* [Cilium](/docs/tasks/administer-cluster/cilium-network-policy/) -* [Kube-router](/docs/tasks/administer-cluster/kube-router-network-policy/) -* [Romana](/docs/tasks/configure-pod-container/romana-network-policy/) -* [Weave Net](/docs/tasks/administer-cluster/weave-network-policy/) - -**Note**: The above list is sorted alphabetically by product name, not by recommendation or preference. This example is valid for a Kubernetes cluster using any of these providers. -{{% /capture %}} - {{% capture prerequisites %}} {{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} +Make sure you've configured a network provider with network policy support. There are a number of network providers that support NetworkPolicy, including: + +* [Calico](/docs/tasks/administer-cluster/network-policy-provider/calico-network-policy/) +* [Cilium](/docs/tasks/administer-cluster/network-policy-provider/cilium-network-policy/) +* [Kube-router](/docs/tasks/administer-cluster/network-policy-provider/kube-router-network-policy/) +* [Romana](/docs/tasks/administer-cluster/network-policy-provider/romana-network-policy/) +* [Weave Net](/docs/tasks/administer-cluster/network-policy-provider/weave-network-policy/) + +**Note**: The above list is sorted alphabetically by product name, not by recommendation or preference. This example is valid for a Kubernetes cluster using any of these providers. {{% /capture %}} {{% capture steps %}} diff --git a/content/en/docs/tasks/administer-cluster/dns-custom-nameservers.md b/content/en/docs/tasks/administer-cluster/dns-custom-nameservers.md index 7067097b0b..07fc8f10c4 100644 --- a/content/en/docs/tasks/administer-cluster/dns-custom-nameservers.md +++ b/content/en/docs/tasks/administer-cluster/dns-custom-nameservers.md @@ -71,7 +71,8 @@ kind: ConfigMap metadata: name: coredns namespace: kube-system -Corefile: | +data: + Corefile: | .:53 { errors health @@ -94,7 +95,7 @@ The Corefile configuration includes the following [plugins](https://coredns.io/p * [health](https://coredns.io/plugins/health/): Health of CoreDNS is reported to http://localhost:8080/health. * [kubernetes](https://coredns.io/plugins/kubernetes/): CoreDNS will reply to DNS queries based on IP of the services and pods of Kubernetes. You can find more details [here](https://coredns.io/plugins/kubernetes/). -> The `pods insecure` option is provided for backward compatibility with kube-dns. You can use the `pod verified` option, which returns an A record only if there exists a pod in same namespace with matching IP. The `pods disabled` option can be used if you don't use pod records. +> The `pods insecure` option is provided for backward compatibility with kube-dns. You can use the `pods verified` option, which returns an A record only if there exists a pod in same namespace with matching IP. The `pods disabled` option can be used if you don't use pod records. > `Upstream` is used for resolving services that point to external hosts (External Services). @@ -139,7 +140,8 @@ kind: ConfigMap metadata: name: coredns namespace: kube-system -Corefile: | +data: + Corefile: | .:53 { errors health @@ -386,4 +388,4 @@ To migrate from kube-dns to CoreDNS, [a detailed blog](https://coredns.io/2018/0 A cluster administrator can also migrate using [the deploy script](https://github.com/coredns/deployment/blob/master/kubernetes/deploy.sh), which will also help you translate the kube-dns configmap to the equivalent CoreDNS one. ## What's next -- [Debugging DNS Resolution](/docs/tasks/administer-cluster/dns-debugging-resolution/). +- [Debugging DNS Resolution](/docs/tasks/administer-cluster/dns-debugging-resolution/). \ No newline at end of file diff --git a/content/en/docs/tasks/administer-cluster/dns-horizontal-autoscaling.md b/content/en/docs/tasks/administer-cluster/dns-horizontal-autoscaling.md index c28f4c1001..eaded41813 100644 --- a/content/en/docs/tasks/administer-cluster/dns-horizontal-autoscaling.md +++ b/content/en/docs/tasks/administer-cluster/dns-horizontal-autoscaling.md @@ -18,12 +18,6 @@ Kubernetes cluster. {{% /capture %}} -{{% capture prerequisites %}} - -{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} - -{{% /capture %}} - {{% capture steps %}} ## Determining whether DNS horizontal autoscaling is already enabled diff --git a/content/en/docs/tasks/administer-cluster/encrypt-data.md b/content/en/docs/tasks/administer-cluster/encrypt-data.md index 75f5e19e28..b7b5eec380 100644 --- a/content/en/docs/tasks/administer-cluster/encrypt-data.md +++ b/content/en/docs/tasks/administer-cluster/encrypt-data.md @@ -17,16 +17,6 @@ This page shows how to enable and configure encryption of secret data at rest. * etcd v3 or later is required -* Encryption at rest is alpha in 1.7.0 which means it may change without notice. Users may be required to decrypt their data prior to upgrading to 1.8.0. - -{{% /capture %}} - -{{< toc >}} - -{{% capture prerequisites %}} - -{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} - {{% /capture %}} {{% capture steps %}} diff --git a/content/en/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-ha.md b/content/en/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-ha.md index 064dae86d3..fb7f476f0c 100644 --- a/content/en/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-ha.md +++ b/content/en/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-ha.md @@ -150,6 +150,12 @@ Add an annotation for the cri-socket to the current node, for example to use doc kubectl annotate node kubeadm.alpha.kubernetes.io/cri-socket=/var/run/dockershim.sock ``` +Apply the modified kubeadm-config on the node: + +```shell +kubectl apply -f kubeadm-config-cm.yaml --force +``` + Start the upgrade: ```shell @@ -237,4 +243,4 @@ If the upgrade fails, see whether one of the following scenarios applies: - If `kubeadm upgrade apply` on one of the secondary masters failed, the cluster is upgraded and working, but the secondary masters are in an undefined state. You need to investigate further and join the secondaries manually. -{{% /capture %}} +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/tasks/administer-cluster/manage-resources/memory-constraint-namespace.md b/content/en/docs/tasks/administer-cluster/manage-resources/memory-constraint-namespace.md index 80480ee00f..aca790e87a 100644 --- a/content/en/docs/tasks/administer-cluster/manage-resources/memory-constraint-namespace.md +++ b/content/en/docs/tasks/administer-cluster/manage-resources/memory-constraint-namespace.md @@ -146,7 +146,7 @@ pods "constraints-mem-demo-2" is forbidden: maximum memory usage per Container i ## Attempt to create a Pod that does not meet the minimum memory request Here's the configuration file for a Pod that has one Container. The Container specifies a -memory request of 200 MiB and a memory limit of 800 MiB. +memory request of 100 MiB and a memory limit of 800 MiB. {{< codenew file="admin/resource/memory-constraints-pod-3.yaml" >}} diff --git a/content/en/docs/tasks/administer-cluster/sysctl-cluster.md b/content/en/docs/tasks/administer-cluster/sysctl-cluster.md index 3b3d53628e..46dc23cdf1 100644 --- a/content/en/docs/tasks/administer-cluster/sysctl-cluster.md +++ b/content/en/docs/tasks/administer-cluster/sysctl-cluster.md @@ -6,7 +6,7 @@ content_template: templates/task --- {{% capture overview %}} -{{< feature-state for_k8s_version="v1.11" state="beta" >}} +{{< feature-state for_k8s_version="v1.12" state="beta" >}} This document describes how to configure and use kernel parameters within a Kubernetes cluster using the sysctl interface. 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 c303b78570..d1b0a42128 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 @@ -29,9 +29,9 @@ Kubernetes cluster. ```shell NAME STATUS ROLES AGE VERSION - worker0 Ready 1d v1.11.1 - worker1 Ready 1d v1.11.1 - worker2 Ready 1d v1.11.1 + worker0 Ready 1d v1.12.0 + worker1 Ready 1d v1.12.0 + worker2 Ready 1d v1.12.0 ``` 1. Chose one of your nodes, and add a label to it: @@ -51,9 +51,9 @@ Kubernetes cluster. ```shell NAME STATUS ROLES AGE VERSION LABELS - worker0 Ready 1d v1.11.1 ...,disktype=ssd,kubernetes.io/hostname=worker0 - worker1 Ready 1d v1.11.1 ...,kubernetes.io/hostname=worker1 - worker2 Ready 1d v1.11.1 ...,kubernetes.io/hostname=worker2 + worker0 Ready 1d v1.12.0 ...,disktype=ssd,kubernetes.io/hostname=worker0 + worker1 Ready 1d v1.12.0 ...,kubernetes.io/hostname=worker1 + worker2 Ready 1d v1.12.0 ...,kubernetes.io/hostname=worker2 ``` In the preceding output, you can see that the `worker0` node has a diff --git a/content/en/docs/tasks/debug-application-cluster/crictl.md b/content/en/docs/tasks/debug-application-cluster/crictl.md index 413cf6a24c..71ccab81aa 100644 --- a/content/en/docs/tasks/debug-application-cluster/crictl.md +++ b/content/en/docs/tasks/debug-application-cluster/crictl.md @@ -65,7 +65,7 @@ debug: true ## Example crictl commands -The following examples show some `crictl` commands and and example output. +The following examples show some `crictl` commands and example output. {{< warning >}} **Warning:** If you use `crictl` to create pod sandboxes or containers on a running 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 ca5b4c8e39..955164e24a 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 @@ -258,10 +258,10 @@ Sometimes when debugging it can be useful to look at the status of a node -- for ```shell $ kubectl get nodes NAME STATUS ROLES AGE VERSION -kubernetes-node-861h NotReady 1h v1.11.1 -kubernetes-node-bols Ready 1h v1.11.1 -kubernetes-node-st6x Ready 1h v1.11.1 -kubernetes-node-unaj Ready 1h v1.11.1 +kubernetes-node-861h NotReady 1h v1.12.0 +kubernetes-node-bols Ready 1h v1.12.0 +kubernetes-node-st6x Ready 1h v1.12.0 +kubernetes-node-unaj Ready 1h v1.12.0 ``` ```shell 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 b070ac4980..609adc498c 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 @@ -18,8 +18,6 @@ where bottlenecks can be removed to improve overall performance. {{% /capture %}} -{{< toc >}} - {{% capture body %}} In Kubernetes, application monitoring does not depend on a single monitoring @@ -89,12 +87,20 @@ This video shows how to configure and run a Google Cloud Monitoring backed Heaps {{< 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." >}} -### Dynatrace Kubernetes monitoring +## CronJob monitoring -With [Dynatrace Kubernetes monitoring](https://www.dynatrace.com/technologies/kubernetes-monitoring/), you can monitor application and cluster health in highly-dynamic Kubernetes environments. +### Kubernetes Job Monitor -Dynatrace automatically discovers all containers running on Kubernetes and presents you with a real-time view of all the connections between your containerized processes, hosts, and cloud instances. Dynatrace includes root cause analysis and the ability to replay problems to see how they evolved over time. +With the [Kubernetes Job Monitor](https://github.com/pietervogelaar/kubernetes-job-monitor) dashboard a Cluster Administrator can see which jobs are running and view the status of completed jobs. -{{< figure src="/images/docs/dynatrace.png" alt="Dynatrace Kubernetes monitoring dashboard example" title="Dynatrace Kubernetes monitoring dashboard example" caption="This dashboard shows a Node overview." >}} +### New Relic Kubernetes monitoring integration + +[New Relic Kubernetes](https://docs.newrelic.com/docs/integrations/host-integrations/host-integrations-list/kubernetes-monitoring-integration) integration provides increased visibility into the performance of your Kubernetes environment. New Relic's Kubernetes integration instruments the container orchestration layer by reporting metrics from Kubernetes objects. The integration gives you insight into your Kubernetes nodes, namespaces, deployments, replica sets, pods, and containers. + +Marquee capabilities: +View your data in pre-built dashboards for immediate insight into your Kubernetes environment. +Create your own custom queries and charts in Insights from automatically reported data. +Create alert conditions on Kubernetes data. +Learn more on this [page](https://docs.newrelic.com/docs/integrations/host-integrations/host-integrations-list/kubernetes-monitoring-integration). {{% /capture %}} diff --git a/content/en/docs/tasks/extend-kubectl/kubectl-plugins.md b/content/en/docs/tasks/extend-kubectl/kubectl-plugins.md index 48945ae9d3..bf30124a82 100644 --- a/content/en/docs/tasks/extend-kubectl/kubectl-plugins.md +++ b/content/en/docs/tasks/extend-kubectl/kubectl-plugins.md @@ -191,7 +191,7 @@ I am a plugin with a dash in my name #### Name conflicts and overshadowing -It can be possible to have multiple plugins with the same filename in different locations throughout your PATH. +It is possible to have multiple plugins with the same filename in different locations throughout your PATH. For example, given a PATH with the following value: `PATH=/usr/local/bin/plugins:/usr/local/bin/moreplugins`, a copy of plugin `kubectl-foo` could exist in `/usr/local/bin/plugins` and `/usr/local/bin/moreplugins`, such that the output of the `kubectl plugin list` command is: @@ -276,4 +276,3 @@ See the [Sample CLI Plugin](https://github.com/kubernetes/sample-cli-plugin) for {{% /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 7cf1703d97..89263d8661 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 @@ -113,7 +113,7 @@ Upon creation, the command `echo Warm greetings to The Most Honorable Kubernetes {{% capture whatsnext %}} -* Learn more about [environment variables](/docs/tasks/configure-pod-container/environment-variable-expose-pod-information/). +* Learn more about [environment variables](/docs/tasks/inject-data-application/environment-variable-expose-pod-information/). * Learn about [using secrets as environment variables](/docs/user-guide/secrets/#using-secrets-as-environment-variables). * See [EnvVarSource](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#envvarsource-v1-core). 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 86c0b23ccf..b3a3cca0f7 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 @@ -25,7 +25,7 @@ Pod fields and Container fields. There are two ways to expose Pod and Container fields to a running Container: -* [Environment variables](/docs/tasks/configure-pod-container/environment-variable-expose-pod-information/) +* [Environment variables](/docs/tasks/inject-data-application/environment-variable-expose-pod-information/) * DownwardAPIVolumeFiles Together, these two ways of exposing Pod and Container fields are called the 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 index f961bbf34c..4834e7ee91 100644 --- a/content/en/docs/tasks/job/automated-tasks-with-cron-jobs.md +++ b/content/en/docs/tasks/job/automated-tasks-with-cron-jobs.md @@ -130,6 +130,16 @@ A cron job config also needs a [`.spec` section](https://git.k8s.io/community/co The `.spec.schedule` is a required field of the `.spec`. It takes a [Cron](https://en.wikipedia.org/wiki/Cron) format string, such as `0 * * * *` or `@hourly`, as schedule time of its jobs to be created and executed. +The format also includes extended `vixie cron` step values. As explained in the [FreeBSD manual](https://www.freebsd.org/cgi/man.cgi?crontab%285%29): + +> Step values can be used in conjunction with ranges. Following a range +> with ``/'' specifies skips of the number's value through the +> range. For example, ``0-23/2'' can be used in the hours field to specify +> command execution every other hour (the alternative in the V7 standard is +> ``0,2,4,6,8,10,12,14,16,18,20,22''). Steps are also permitted after an +> asterisk, so if you want to say ``every two hours'', just use ``*/2''. + + **Note:** The question mark (`?`) in the schedule has the same meaning as an asterisk `*`, that is, it stands for any of available value for a given field. ### Job Template @@ -146,7 +156,15 @@ After the deadline, the cron job does not start the job. Jobs that do not meet their deadline in this way count as failed jobs. If this field is not specified, the jobs have no deadline. -It is important to note that if the `.spec.startingDeadlineSeconds` field is set (not nil), the CronJob controller counts how many missed jobs occurred from the value of `.spec.startingDeadlineSeconds` until now. For example, if it is set to `200`, it counts how many missed schedules occurred in the last 200 seconds. If there were more than 100 missed schedules, the cronjob would not be scheduled. +The CronJob controller counts how many missed schedules happen for a cron job. If there are more than 100 missed +schedules, the cron job is no longer scheduled. When `.spec.startingDeadlineSeconds` is not set, the CronJob +controller counts missed schedules from `status.lastScheduleTime` until now. For example, one cron job is +supposed to run every minute, the `status.lastScheduleTime` of the cronjob is 5:00am, but now it's 7:00am. +That means 120 schedules were missed, so the cron job is no longer scheduled. If the `.spec.startingDeadlineSeconds` +field is set (not null), the CronJob controller counts how many missed jobs occurred from the value of +`.spec.startingDeadlineSeconds` until now. For example, if it is set to `200`, it counts how many missed +schedules occurred in the last 200 seconds. In that case, if there were more than 100 missed schedules in the +last 200 seconds, the cron job is no longer scheduled. ### Concurrency Policy 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 a8a256c482..d2cd15cdcd 100644 --- a/content/en/docs/tasks/manage-daemon/update-daemon-set.md +++ b/content/en/docs/tasks/manage-daemon/update-daemon-set.md @@ -25,12 +25,12 @@ This page shows how to perform a rolling update on a DaemonSet. DaemonSet has two update strategy types: -* OnDelete: This is the default update strategy for backward-compatibility. With - `OnDelete` update strategy, after you update a DaemonSet template, new +* OnDelete: With `OnDelete` update strategy, after you update a DaemonSet template, new DaemonSet pods will *only* be created when you manually delete old DaemonSet pods. This is the same behavior of DaemonSet in Kubernetes version 1.5 or before. -* RollingUpdate: With `RollingUpdate` update strategy, after you update a +* RollingUpdate: This is the default update strategy. + 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. diff --git a/content/en/docs/tasks/manage-gpus/scheduling-gpus.md b/content/en/docs/tasks/manage-gpus/scheduling-gpus.md index fc2b82745e..a191b4ec92 100644 --- a/content/en/docs/tasks/manage-gpus/scheduling-gpus.md +++ b/content/en/docs/tasks/manage-gpus/scheduling-gpus.md @@ -7,10 +7,13 @@ title: Schedule GPUs {{% capture overview %}} -Kubernetes includes **experimental** support for managing NVIDIA GPUs spread +Kubernetes includes **experimental** support for managing AMD and 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. +multiple backwards incompatible iterations. The support for AMD GPUs was added in +v1.9 via [device plugin](#deploying-amd-gpu-device-plugin). + +This page describes how users can consume GPUs across different Kubernetes versions +and the current limitations. {{% /capture %}} @@ -28,14 +31,15 @@ feature gate has to be explicitly set to true across the system: `--feature-gates="DevicePlugins=true"`. This is no longer required starting from 1.10. -Then you have to install NVIDIA drivers on the nodes and run an NVIDIA GPU device -plugin ([see below](#deploying-nvidia-gpu-device-plugin)). +Then you have to install GPU drivers from the corresponding vendor on the nodes +and run the corresponding device plugin from the GPU vendor +([AMD](#deploying-amd-gpu-device-plugin), [NVIDIA](#deploying-nvidia-gpu-device-plugin)). -When the above conditions are true, Kubernetes will expose `nvidia.com/gpu` as -a schedulable resource. +When the above conditions are true, Kubernetes will expose `nvidia.com/gpu` or +`amd.com/gpu` as a schedulable resource. You can consume these GPUs from your containers by requesting -`nvidia.com/gpu` just like you request `cpu` or `memory`. +`.com/gpu` just like you request `cpu` or `memory`. However, there are some limitations in how you specify the resource requirements when using GPUs: @@ -67,6 +71,24 @@ spec: nvidia.com/gpu: 1 # requesting 1 GPU ``` +### Deploying AMD GPU device plugin + +The [official AMD GPU device plugin](https://github.com/RadeonOpenCompute/k8s-device-plugin) +has the following requirements: + +- Kubernetes nodes have to be pre-installed with AMD GPU Linux driver. + +To deploy the AMD device plugin once your cluster is running and the above +requirements are satisfied: +``` +# For Kubernetes v1.9 +kubectl create -f https://raw.githubusercontent.com/RadeonOpenCompute/k8s-device-plugin/r1.9/k8s-ds-amdgpu-dp.yaml + +# For Kubernetes v1.10 +kubectl create -f https://raw.githubusercontent.com/RadeonOpenCompute/k8s-device-plugin/r1.10/k8s-ds-amdgpu-dp.yaml +``` +Report issues with this device plugin to [RadeonOpenCompute/k8s-device-plugin](https://github.com/RadeonOpenCompute/k8s-device-plugin). + ### Deploying NVIDIA GPU device plugin There are currently two device plugin implementations for NVIDIA GPUs: 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 ca1ec171bd..ccb4285b8f 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 @@ -440,7 +440,7 @@ the quantity `10500m` would be written as `10.5` in decimal notation. The metri will return whole numbers without a suffix when possible, and will generally return quantities in milli-units otherwise. This means you might see your metric value fluctuate between `1` and `1500m`, or `1` and `1.5` when written in decimal notation. See the -[glossary entry on quantities](/docs/reference/glossary/quantity.md) for more information. +[glossary entry on quantities](/docs/reference/glossary?core-object=true#term-quantity) for more information. ## Appendix: Other possible scenarios @@ -458,4 +458,4 @@ $ kubectl create -f https://k8s.io/examples/application/hpa/php-apache.yaml horizontalpodautoscaler.autoscaling/php-apache created ``` -{{% /capture %}} +{{% /capture %}} \ No newline at end of file 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 078d2c537f..45782730be 100644 --- a/content/en/docs/tasks/run-application/horizontal-pod-autoscale.md +++ b/content/en/docs/tasks/run-application/horizontal-pod-autoscale.md @@ -64,7 +64,7 @@ or the custom metrics API (for all other metrics). except that it works with raw values, not utilization values. * For object metrics and external metrics, a single metric is fetched, which describes - the object in question. This metric is compared compared to the target + the object in question. This metric is compared to the target value, to produce a ratio as above. In the `autoscaling/v2beta2` API version, this value can optionally be divided by the number of pods before the comparison is made. @@ -99,7 +99,7 @@ desiredReplicas = ceil[currentReplicas * ( currentMetricValue / desiredMetricVal For example, if the current metric value is `200m`, and the desired value is `100m`, the number of replicas will be doubled, since `200.0 / 100.0 == -2.0` If the the current value is instead `50m`, we'll halve the number of +2.0` If the current value is instead `50m`, we'll halve the number of replicas, since `50.0 / 100.0 == 0.5`. We'll skip scaling if the ratio is sufficiently close to 1.0 (within a globally-configurable tolerance, from the `--horizontal-pod-autoscaler-tolerance` flag, which defaults to 0.1). @@ -122,7 +122,7 @@ became ready, that pod is set aside as well. Due to technical constraints, the HorizontalPodAutoscaler controller cannot exactly determine the first time a pod becomes ready when -determinining whether to set aside certain CPU metrics. Instead, it +determining whether to set aside certain CPU metrics. Instead, it considers a Pod "not yet ready" if it's unready and transitioned to unready within a short, configurable window of time since it started. This value is configured with the `--horizontal-pod-autoscaler-initial-readiness-delay` flag, and its default is 30 @@ -139,9 +139,9 @@ conservatively, assuming those pods were consuming 100% of the desired value in case of a scale down, and 0% in case of a scale up. This dampens the magnitude of any potential scale. -Futhermore, if any not-yet-ready pods were present, and we would have +Furthermore, if any not-yet-ready pods were present, and we would have scaled up without factoring in missing metrics or not-yet-ready pods, we -conservatively assume the non-yet-ready pods are consuming 0% of the +conservatively assume the not-yet-ready pods are consuming 0% of the desired metric, further dampening the magnitude of a scale up. After factoring in the not-yet-ready pods and missing metrics, we @@ -161,9 +161,9 @@ into a desired replica count (e.g. due to an error fetching the metrics from the metrics APIs), scaling is skipped. Finally, just before HPA scales the target, the scale reccomendation is recorded. The -controller considers all reccomendations within a configurable window choosing the +controller considers all recommendations within a configurable window choosing the highest recommendation from within that window. This value can be configured using the `--horizontal-pod-autoscaler-downscale-stabilization-window` flag, which defaults to 5 minutes. -This means that scaledowns will occur gradually, smothing out the impact of rapidly +This means that scaledowns will occur gradually, smoothing out the impact of rapidly fluctuating metric values. ## API Object @@ -278,4 +278,4 @@ APIs, cluster administrators must ensure that: * 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 %}} +{{% /capture %}} \ No newline at end of file diff --git a/content/en/docs/tasks/tls/certificate-rotation.md b/content/en/docs/tasks/tls/certificate-rotation.md index 3e2f4e553b..8581f60c56 100644 --- a/content/en/docs/tasks/tls/certificate-rotation.md +++ b/content/en/docs/tasks/tls/certificate-rotation.md @@ -27,7 +27,7 @@ default, these certificates are issued with one year expiration so that they do not need to be renewed too frequently. Kubernetes 1.8 contains [kubelet certificate -rotation](/docs/tasks/administer-cluster/certificate-rotation/), a beta feature +rotation](/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping/), a beta feature that will automatically generate a new key and request a new certificate from the Kubernetes API as the current certificate approaches expiration. Once the new certificate is available, it will be used for authenticating connections to diff --git a/content/en/docs/tasks/tools/install-kubectl.md b/content/en/docs/tasks/tools/install-kubectl.md index 434faf3b86..4f94e6335b 100644 --- a/content/en/docs/tasks/tools/install-kubectl.md +++ b/content/en/docs/tasks/tools/install-kubectl.md @@ -28,7 +28,6 @@ Here are a few methods to install kubectl. {{< tab name="Ubuntu, Debian or HypriotOS" codelang="bash" >}} sudo apt-get update && sudo apt-get install -y apt-transport-https curl -s https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key add - -sudo touch /etc/apt/sources.list.d/kubernetes.list echo "deb http://apt.kubernetes.io/ kubernetes-xenial main" | sudo tee -a /etc/apt/sources.list.d/kubernetes.list sudo apt-get update sudo apt-get install -y kubectl diff --git a/content/en/docs/tutorials/hello-minikube.md b/content/en/docs/tutorials/hello-minikube.md index 70ce0584e8..f9f8867413 100644 --- a/content/en/docs/tutorials/hello-minikube.md +++ b/content/en/docs/tutorials/hello-minikube.md @@ -37,13 +37,13 @@ Minikube provides a simple way of running Kubernetes on your local machine for f {{< note >}} **Note:** If you see the following Homebrew error when you run `brew update` after you update your computer to macOS 10.13: - ``` + ```shell Error: /usr/local is not writable. You should change the ownership and permissions of /usr/local back to your user account: sudo chown -R $(whoami) /usr/local ``` You can resolve the issue by reinstalling Homebrew: - ``` + ```shell /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" ``` {{< /note >}} @@ -160,15 +160,22 @@ 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 to the image and starts the Node.js server. -Because this tutorial uses Minikube, instead of pushing your Docker image to a -registry, you can simply build the image using the same Docker host as -the Minikube VM, so that the images are automatically present. To do so, make -sure you are using the Minikube Docker daemon: +By default, Docker will create images and store them in your local machine's Docker registry. +In this tutorial, we will not use your local machine's Docker registry; we will use the +Docker registry of the Docker daemon running _inside_ Minikube's vm instance. To point the +'docker' command to your Minikube's Docker daemon, type (unix shells): ```shell eval $(minikube docker-env) ``` +or in powershell: +```shell +minikube docker-env | Invoke-Expression +``` + + + {{< 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)`. @@ -180,6 +187,22 @@ Build your Docker image, using the Minikube Docker daemon (mind the trailing dot docker build -t hello-node:v1 . ``` +check that the image is in Minikube's Docker registry: + +```shell +minikube ssh docker images +``` + +Output: + +```shell +REPOSITORY TAG IMAGE ID CREATED SIZE +hello-node v1 f82485ca953c 3 minutes ago 655MB +... +node 6.9.2 faaadb4aaf9b 20 months ago 655MB +``` + + Now the Minikube VM can run the image you built. ## Create a Deployment diff --git a/content/en/docs/tutorials/kubernetes-basics/deploy-app/deploy-intro.html b/content/en/docs/tutorials/kubernetes-basics/deploy-app/deploy-intro.html index b037d637a4..c0108fa9c0 100644 --- a/content/en/docs/tutorials/kubernetes-basics/deploy-app/deploy-intro.html +++ b/content/en/docs/tutorials/kubernetes-basics/deploy-app/deploy-intro.html @@ -91,7 +91,9 @@ weight: 10
-

For our first Deployment, we'll use a Node.js application packaged in a Docker container. The source code and the Dockerfile are available in the GitHub repository for the Kubernetes Basics.

+

For our first Deployment, we'll use a Node.js application packaged in a Docker container. + To create the Node.js application and deploy the Docker container, follow the instructions from the + Hello Minikube tutorial.

Now that you know what Deployments are, let's go to the online tutorial and deploy our first app!

diff --git a/content/en/docs/tutorials/kubernetes-basics/update/update-intro.html b/content/en/docs/tutorials/kubernetes-basics/update/update-intro.html index 075de3f887..9db375508f 100644 --- a/content/en/docs/tutorials/kubernetes-basics/update/update-intro.html +++ b/content/en/docs/tutorials/kubernetes-basics/update/update-intro.html @@ -10,6 +10,7 @@ weight: 10 +
diff --git a/content/en/docs/tutorials/online-training/overview.md b/content/en/docs/tutorials/online-training/overview.md index 1f1c0a9753..e82722fbd2 100644 --- a/content/en/docs/tutorials/online-training/overview.md +++ b/content/en/docs/tutorials/online-training/overview.md @@ -21,6 +21,10 @@ Here are some of the sites that offer online training for Kubernetes: * [Learn Kubernetes using Interactive Hands-on Scenarios (Katacoda)](https://www.katacoda.com/courses/kubernetes/) +* [Certified Kubernetes Administrator Preparation Course (LinuxAcademy.com)](https://linuxacademy.com/linux/training/course/name/certified-kubernetes-administrator-preparation-course) + +* [Kubernetes the Hard Way (LinuxAcademy.com)](https://linuxacademy.com/linux/training/course/name/kubernetes-the-hard-way) + {{% /capture %}} diff --git a/content/en/docs/tutorials/services/source-ip.md b/content/en/docs/tutorials/services/source-ip.md index e41e16ed51..536f17c509 100644 --- a/content/en/docs/tutorials/services/source-ip.md +++ b/content/en/docs/tutorials/services/source-ip.md @@ -61,9 +61,9 @@ a `proxyMode` endpoint: ```console $ kubectl get nodes NAME STATUS ROLES AGE VERSION -kubernetes-minion-group-6jst Ready 2h v1.11.1 -kubernetes-minion-group-cx31 Ready 2h v1.11.1 -kubernetes-minion-group-jj1t Ready 2h v1.11.1 +kubernetes-minion-group-6jst Ready 2h v1.12.0 +kubernetes-minion-group-cx31 Ready 2h v1.12.0 +kubernetes-minion-group-jj1t Ready 2h v1.12.0 kubernetes-minion-group-6jst $ curl localhost:10249/proxyMode iptables diff --git a/content/en/docs/tutorials/stateful-application/cassandra.md b/content/en/docs/tutorials/stateful-application/cassandra.md index 9c3436f6e1..f1cd0c0d46 100644 --- a/content/en/docs/tutorials/stateful-application/cassandra.md +++ b/content/en/docs/tutorials/stateful-application/cassandra.md @@ -54,7 +54,7 @@ To complete this tutorial, you should already have a basic familiarity with [Pod ### Additional Minikube Setup Instructions {{< caution >}} -**Caution:** [Minikube](/docs/getting-started-guides/minikube/) defaults to 1024MB of memory and 1 CPU. Running Minikube with the default resource configuration results in insufficient resource errors during this tutorial. To avoid these errors, start Minikube with the folllowing settings: +**Caution:** [Minikube](/docs/getting-started-guides/minikube/) defaults to 1024MB of memory and 1 CPU. Running Minikube with the default resource configuration results in insufficient resource errors during this tutorial. To avoid these errors, start Minikube with the following settings: ```shell minikube start --memory 5120 --cpus=4 diff --git a/content/en/docs/user-journeys/users/application-developer/foundational.md b/content/en/docs/user-journeys/users/application-developer/foundational.md index e9a84a849e..d5e72dd3b6 100644 --- a/content/en/docs/user-journeys/users/application-developer/foundational.md +++ b/content/en/docs/user-journeys/users/application-developer/foundational.md @@ -53,6 +53,33 @@ Minikube can be installed locally, and runs a simple, single-node Kubernetes clu You can get basic information about your cluster with the commands `kubectl cluster-info` and `kubectl get nodes`. However, to get a good idea of what's really going on, you need to deploy an application to your cluster. This is covered in the next section. +#### microk8s + +On Linux, *microk8s* is a good alternative to Minikube for a local +install of Kubernetes: + +* Runs on the native OS, so there is no overhead from running a virtual machine. +* Always provides the latest stable version of Kubernetes, using built-in auto-upgrade functionality. +* Installs in less than a minute. + +* {{< link text="Install microk8s" url="https://microk8s.io/" >}}. + +After you install microk8s, you can use its tab-completion +functionality. All microk8s commands start with `microk8s.`. Type +`microk8s.` (with the period) and then use the tab key to see a list +of available commands. + +It also includes commands to enable Kubernetes subsystems. For example: + +* the Kubernetes Dashboard +* the DNS service +* GPU passthrough (for NVIDIA) +* Ingress +* Istio +* Metrics server +* Registry +* Storage + ## Deploy an application #### Basic workloads diff --git a/content/en/examples/audit/audit-policy.yaml b/content/en/examples/audit/audit-policy.yaml index b5d66b3a18..25b8fd0070 100644 --- a/content/en/examples/audit/audit-policy.yaml +++ b/content/en/examples/audit/audit-policy.yaml @@ -1,4 +1,4 @@ -apiVersion: audit.k8s.io/v1beta1 # This is required. +apiVersion: audit.k8s.io/v1 # This is required. kind: Policy # Don't generate audit events for all requests in RequestReceived stage. omitStages: @@ -65,4 +65,4 @@ rules: # Long-running requests like watches that fall under this rule will not # generate an audit event in RequestReceived. omitStages: - - "RequestReceived" \ No newline at end of file + - "RequestReceived" diff --git a/content/en/examples/controllers/nginx-deployment.yaml b/content/en/examples/controllers/nginx-deployment.yaml index f7f95deebb..5dd80da371 100644 --- a/content/en/examples/controllers/nginx-deployment.yaml +++ b/content/en/examples/controllers/nginx-deployment.yaml @@ -16,6 +16,6 @@ spec: spec: containers: - name: nginx - image: nginx:1.7.9 + image: nginx:1.15.4 ports: - containerPort: 80 diff --git a/content/en/examples/debug/event-exporter.yaml b/content/en/examples/debug/event-exporter.yaml index 759b2ce9c1..64a585b9a5 100644 --- a/content/en/examples/debug/event-exporter.yaml +++ b/content/en/examples/debug/event-exporter.yaml @@ -24,7 +24,7 @@ subjects: apiVersion: apps/v1 kind: Deployment metadata: - name: event-exporter-v0.1.0 + name: event-exporter-v0.2.3 namespace: default labels: app: event-exporter @@ -41,7 +41,7 @@ spec: serviceAccountName: event-exporter-sa containers: - name: event-exporter - image: k8s.gcr.io/event-exporter:v0.1.0 + image: k8s.gcr.io/event-exporter:v0.2.3 command: - '/event-exporter' terminationGracePeriodSeconds: 30 diff --git a/content/en/examples/minikube/Dockerfile b/content/en/examples/minikube/Dockerfile index 34b1f40f52..1fe745295a 100644 --- a/content/en/examples/minikube/Dockerfile +++ b/content/en/examples/minikube/Dockerfile @@ -1,4 +1,4 @@ -FROM node:6.9.2 +FROM node:6.14.2 EXPOSE 8080 COPY server.js . CMD node server.js diff --git a/content/en/includes/partner-script.js b/content/en/includes/partner-script.js index aeb75e73c7..25c13ef3c5 100644 --- a/content/en/includes/partner-script.js +++ b/content/en/includes/partner-script.js @@ -292,7 +292,7 @@ name: 'Emerging Technology Advisors', logo: 'eta', link: 'https://www.emergingtechnologyadvisors.com/services/kubernetes.html', - blurb: 'ETA helps companies architect, implement, and manage scalable applications using Kubernetes on on public or private cloud.' + blurb: 'ETA helps companies architect, implement, and manage scalable applications using Kubernetes on public or private cloud.' }, { type: 0, diff --git a/content/ja/OWNERS b/content/ja/OWNERS new file mode 100644 index 0000000000..91ea772f74 --- /dev/null +++ b/content/ja/OWNERS @@ -0,0 +1,11 @@ +# This is the localization project for Japanese. +# Teams and members are visible at https://github.com/orgs/kubernetes/teams. + +reviewers: +- sig-docs-ja-reviews + +approvers: +- sig-docs-ja-owners + +labels: +- language/ja diff --git a/content/ko/OWNERS b/content/ko/OWNERS new file mode 100644 index 0000000000..45a4bc5870 --- /dev/null +++ b/content/ko/OWNERS @@ -0,0 +1,11 @@ +# This is the localization project for Korean. +# Teams and members are visible at https://github.com/orgs/kubernetes/teams. + +reviewers: +- sig-docs-ko-reviews + +approvers: +- sig-docs-ko-owners + +labels: +- language/ko diff --git a/content/ko/docs/setup/_index.md b/content/ko/docs/setup/_index.md index ab50a95e6e..d804d24f69 100644 --- a/content/ko/docs/setup/_index.md +++ b/content/ko/docs/setup/_index.md @@ -1,3 +1,4 @@ +<<<<<<< HEAD --- no_issue: true title: 설치 @@ -89,3 +90,97 @@ Pick a [custom solution](/docs/setup/pick-right-solution/#custom-solutions). Go to [Picking the Right Solution](/docs/setup/pick-right-solution/) for a complete list of solutions. {{% /capture %}} +||||||| merged common ancestors +======= +--- +no_issue: true +title: 설치 +main_menu: true +weight: 30 +content_template: templates/concept +--- + +{{% capture overview %}} + +Use this page to find the type of solution that best fits your needs. + +Deciding where to run Kubernetes depends on what resources you have available +and how much flexibility you need. You can run Kubernetes almost anywhere, +from your laptop to VMs on a cloud provider to a rack of bare metal servers. +You can also set up a fully-managed cluster by running a single command or craft +your own customized cluster on your bare metal servers. + +{{% /capture %}} + +{{% capture body %}} + +## Local-machine Solutions + +A local-machine solution is an easy way to get started with Kubernetes. You +can create and test Kubernetes clusters without worrying about consuming cloud +resources and quotas. + +You should pick a local solution if you want to: + +* Try or start learning about Kubernetes +* Develop and test clusters locally + +Pick a [local-machine solution](/docs/setup/pick-right-solution/#local-machine-solutions). + +## Hosted Solutions + +Hosted solutions are a convenient way to create and maintain Kubernetes clusters. They +manage and operate your clusters so you don’t have to. + +You should pick a hosted solution if you: + +* Want a fully-managed solution +* Want to focus on developing your apps or services +* Don’t have dedicated site reliability engineering (SRE) team but want high availability +* Don't have resources to host and monitor your clusters + +Pick a [hosted solution](/docs/setup/pick-right-solution/#hosted-solutions). + +## Turnkey – Cloud Solutions + + +These solutions allow you to create Kubernetes clusters with only a few commands and +are actively developed and have active community support. They can also be hosted on +a range of Cloud IaaS providers, but they offer more freedom and flexibility in +exchange for effort. + +You should pick a turnkey cloud solution if you: + +* Want more control over your clusters than the hosted solutions allow +* Want to take on more operations ownership + +Pick a [turnkey cloud solution](/docs/setup/pick-right-solution/#turnkey-cloud-solutions) + +## Turnkey – On-Premises Solutions + +These solutions allow you to create Kubernetes clusters on your internal, secure, +cloud network with only a few commands. + +You should pick a on-prem turnkey cloud solution if you: + +* Want to deploy clusters on your private cloud network +* Have a dedicated SRE team +* Have the resources to host and monitor your clusters + +Pick an [on-prem turnkey cloud solution](/docs/setup/pick-right-solution/#on-premises-turnkey-cloud-solutions). + +## Custom Solutions + +Custom solutions give you the most freedom over your clusters but require the +most expertise. These solutions range from bare-metal to cloud providers on +different operating systems. + +Pick a [custom solution](/docs/setup/pick-right-solution/#custom-solutions). + +{{% /capture %}} + +{{% capture whatsnext %}} +Go to [Picking the Right Solution](/docs/setup/pick-right-solution/) for a complete +list of solutions. +{{% /capture %}} +>>>>>>> master diff --git a/content/ko/docs/tutorials/kubernetes-basics/_index.html b/content/ko/docs/tutorials/kubernetes-basics/_index.html index da2487b5d1..c9607d4dbd 100644 --- a/content/ko/docs/tutorials/kubernetes-basics/_index.html +++ b/content/ko/docs/tutorials/kubernetes-basics/_index.html @@ -1,3 +1,4 @@ +<<<<<<< HEAD --- title: 쿠버네티스 기초 학습 linkTitle: 쿠버네티스 기초 학습 @@ -112,3 +113,120 @@ weight: 5 +||||||| merged common ancestors +======= +--- +title: 쿠버네티스 기초 학습 +linkTitle: 쿠버네티스 기초 학습 +weight: 5 +--- + + + + + + + +
+ +
+ +
+
+

쿠버네티스 기초

+

이 튜토리얼에서는 쿠버네티스 클러스터 오케스트레이션 시스템의 기초를 익힐 수 있는 가이드를 제공한다. 각각의 모듈에는 쿠버네티스의 주요 기능과 개념에 대한 배경 지식이 담겨 있으며 대화형 온라인 튜토리얼도 포함되어 있다. 대화형 튜토리얼에서 간단한 클러스터와 그 클러스터 상의 컨테이너화된 애플리케이션을 직접 관리해볼 수 있다.

+

대화형 튜토리얼을 사용해서 다음의 내용을 배울 수 있다.

+
    +
  • 컨테이너화된 애플리케이션을 클러스터에 배포하기
  • +
  • 디플로이먼트를 스케일링하기
  • +
  • 컨테이너화된 애플리케이션을 새로운 소프트웨어 버전으로 업데이트하기
  • +
  • 컨테이너화된 애플리케이션을 디버그하기
  • +
+

이 튜토리얼에서는 Katacoda를 사용해서 독자의 웹브라우저에서 Minikube가 동작하는 가상 터미널을 구동시킨다. Minikube는 로컬에 설치할 수 있는 작은 규모의 쿠버네티스로써 어디에서든 작동된다. 어떤 소프트웨어도 설치할 필요가 없고, 아무 것도 설정할 필요가 없다. 왜냐하면 대화형 튜토리얼이 웹브라우저 자체에서 바로 동작하기 때문이다.

+
+
+ +
+ +
+
+

쿠버네티스가 어떤 도움이 될까?

+

오늘날의 웹서비스에 대해서, 사용자는 애플리케이션이 24/7 가용하기를 바라고, 개발자는 하루에도 몇 번이고 새로운 버전의 애플리케이션을 배포하기를 바란다. 컨테이너화를 통해 소프트웨어를 패키지하면 애플리케이션을 다운타임 없이 쉽고 빠르게 릴리스 및 업데이트할 수 있게 되어서 이런 목표를 달성하는데 도움이 된다. 쿠버네티스는 이렇게 컨테이너화된 애플리케이션을 원하는 곳 어디에든 또 언제든 구동시킬 수 있다는 확신을 갖는데 도움을 주며, 그 애플리케이션이 작동하는데 필요한 자원과 도구를 찾는 것을 도와준다. 쿠버네티스는 구글의 컨테이너 오케스트레이션 부문의 축적된 경험으로 설계되고 커뮤니티로부터 도출된 최고의 아이디어가 결합된 운영 수준의 오픈 소스 플랫폼이다.

+
+
+ +
+

쿠버네티스 기초 모듈

+ +
+ + + +
+ +
+ + + +>>>>>>> master diff --git a/content/ko/docs/tutorials/kubernetes-basics/create-cluster/cluster-interactive.html b/content/ko/docs/tutorials/kubernetes-basics/create-cluster/cluster-interactive.html index 90b0abecaa..cd4c4c354d 100644 --- a/content/ko/docs/tutorials/kubernetes-basics/create-cluster/cluster-interactive.html +++ b/content/ko/docs/tutorials/kubernetes-basics/create-cluster/cluster-interactive.html @@ -1,3 +1,4 @@ +<<<<<<< HEAD --- title: 대화형 튜토리얼 - 클러스터 생성하기 weight: 20 @@ -39,3 +40,47 @@ weight: 20 +||||||| merged common ancestors +======= +--- +title: 대화형 튜토리얼 - 클러스터 생성하기 +weight: 20 +--- + + + + + + + + + + + +
+ +
+ +
+
+ 터미널로 상호 작용하기 위해서, 데스크탑/태블릿 버전을 사용해주세요 +
+
+
+ + +
+ +
+ + + +>>>>>>> master diff --git a/content/ko/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro.html b/content/ko/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro.html index ff101a1531..3714392a0f 100644 --- a/content/ko/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro.html +++ b/content/ko/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro.html @@ -1,3 +1,4 @@ +<<<<<<< HEAD --- title: Minikube를 사용해서 클러스터 생성하기 weight: 10 @@ -130,3 +131,138 @@ weight: 10 +||||||| merged common ancestors +======= +--- +title: Minikube를 사용해서 클러스터 생성하기 +weight: 10 +--- + + + + + + + + + +
+ +
+ +
+ +
+

목표

+
    +
  • 쿠버네티스 클러스터가 무엇인지 배운다.
  • +
  • Minikube가 무엇인지 배운다.
  • +
  • 온라인 터미널을 사용해서 쿠버네티스 클러스터를 시작한다.
  • +
+
+ +
+

쿠버네티스 클러스터

+

+ 쿠버네티스는 서로 연결되어서 단일 유닛처럼 동작하는 고가용성의 컴퓨터 클러스터를 상호조정한다. + 쿠버네티스의 추상화된 개념을 통해 개별 머신에 얽매이지 않고 컨테이너화된 애플리케이션을 클러스터에 + 배포할 수 있다. 이렇게 새로운 배포 모델을 활용하려면, 애플리케이션을 개별 호스트에 결합되지 않는 + 방식으로 패키지할 필요가 있다. 즉, 컨테이너화 해야 한다. 컨테이너화된 애플리케이션은 호스트에 + 매우 깊이 통합된 패키지로써 특정 머신에 직접 설치되는 예전의 배포 모델보다 유연하고 가용성이 높다. + 쿠버네티스는 애플리케이션 컨테이너를 클러스터에 분산시키고 스케줄링하는 일을 보다 효율적으로 + 자동화한다. 쿠버네티스는 오픈소스 + 플랫폼이고 운영 수준의 안정성을 가졌다. +

+

쿠버네티스 클러스터는 두 가지 형태의 자원으로 구성된다. +

    +
  • 마스터는 클러스터를 상호조정한다
  • +
  • 노드는 애플리케이션을 구동하는 작업자다
  • +
+

+
+ +
+
+

요약:

+
    +
  • 쿠버네티스 클러스터
  • +
  • Minikube
  • +
+
+
+

+ 쿠버네티스는 컴퓨터 클러스터에 걸쳐서 애플리케이션 컨테이너의 위치(스케줄링)와 실행을 + 오케스트레이션하는 운영 수준의 오픈소스 플랫폼이다. +

+
+
+
+
+ +
+
+

클러스터 다이어그램

+
+
+ +
+
+

+
+
+
+ +
+
+

마스터는 클러스터 관리를 담당한다. 마스터는 애플리케이션을 스케줄링하거나, 애플리케이션의 + 항상성을 유지하거나, 애플리케이션을 스케일링하고, 새로운 변경사항을 순서대로 반영하는 일과 같은 + 클러스터 내 모든 활동을 조율한다.

+

노드는 쿠버네티스 클러스터 내 워커 머신으로써 동작하는 VM 또는 물리적인 컴퓨터다. + 각 노드는 노드를 관리하고 쿠버네티스 마스터와 통신하는 Kubelet이라는 에이전트를 갖는다. 노드는 + 컨테이너 운영을 담당하는 Docker 또는 + rkt과 같은 툴도 갖는다. 운영 트래픽을 처리하는 쿠버네티스 + 클러스터는 최소 세 대의 노드를 가져야한다.

+ +
+
+
+

마스터는 클러스터를 관리하고 노드는 구동되는 애플리케이션을 수용하는데 사용된다.

+
+
+
+ +
+
+

애플리케이션을 쿠버네티스에 배포한다는 것은, 마스터에 애플리케이션 컨테이너를 구동하라고 지시하는 + 것이다. 마스터는 컨테이너를 클러스터의 어느 노드에 구동시킬지를 스케줄한다. 노드는 마스터가 + 제공하는 쿠버네티스 API를 통해서 마스터와 통신한다. 최종 사용자도 쿠버네티스 API를 직접 + 사용해서 클러스터와 상호작용할 수 있다.

+ +

쿠버네티스 클러스터는 물리 및 가상 머신 모두에 설치될 수 있다. 쿠버네티스 개발을 시작하려면 + Minikube를 사용할 수 있다. Minikube는 로컬 + 머신에 VM을 만들고 하나의 노드로 구성된 간단한 클러스터를 배포하는 가벼운 쿠버네티스 구현체다. + Minikube는 리눅스, 맥, 그리고 윈도우 시스템에서 구동이 가능하다. Minikube CLI는 클러스터에 대해 + 시작, 중지, 상태 조회 및 삭제 등의 기본적인 부트스트래핑 기능을 제공한다. 하지만, 본 튜토리얼에서는 + Minikube가 미리 설치된 채로 제공되는 온라인 터미널을 사용할 것이다.

+ +

이제 쿠버네티스가 무엇인지 알아봤으니, 온라인 튜토리얼로 이동해서 우리의 첫 번째 클러스터를 + 시작해보자!

+ +
+
+
+ + + +
+ +
+ + + +>>>>>>> master diff --git a/content/ko/docs/tutorials/kubernetes-basics/deploy-app/deploy-interactive.html b/content/ko/docs/tutorials/kubernetes-basics/deploy-app/deploy-interactive.html index ce3b72a2d4..ca33d8e0bb 100644 --- a/content/ko/docs/tutorials/kubernetes-basics/deploy-app/deploy-interactive.html +++ b/content/ko/docs/tutorials/kubernetes-basics/deploy-app/deploy-interactive.html @@ -1,3 +1,4 @@ +<<<<<<< HEAD --- title: 대화형 튜토리얼 - 앱 배포하기 weight: 20 @@ -43,3 +44,51 @@ weight: 20 +||||||| merged common ancestors +======= +--- +title: 대화형 튜토리얼 - 앱 배포하기 +weight: 20 +--- + + + + + + + + + + + +
+ +
+ +
+
+
+ 터미널로 상호 작용하기 위해서, 데스크탑/태블릿 버전을 사용해주세요 +
+ +
+
+ +
+ + +
+ +
+ + + +>>>>>>> master diff --git a/content/ko/docs/tutorials/kubernetes-basics/deploy-app/deploy-intro.html b/content/ko/docs/tutorials/kubernetes-basics/deploy-app/deploy-intro.html index 7b524bea4d..425f2e4f54 100644 --- a/content/ko/docs/tutorials/kubernetes-basics/deploy-app/deploy-intro.html +++ b/content/ko/docs/tutorials/kubernetes-basics/deploy-app/deploy-intro.html @@ -1,3 +1,4 @@ +<<<<<<< HEAD --- title: kubectl을 사용해서 디플로이먼트 생성하기 weight: 10 @@ -127,3 +128,135 @@ weight: 10 +||||||| merged common ancestors +======= +--- +title: kubectl을 사용해서 디플로이먼트 생성하기 +weight: 10 +--- + + + + + + + + + +
+ +
+ +
+ +
+

목표

+
    +
  • 애플리케이션 디플로이먼트(Deployment)에 대해 배운다.
  • +
  • kubectl로 첫 애플리케이션을 쿠버네티스에 배포한다.
  • +
+
+ +
+

쿠버네티스 디플로이먼트

+

+ 일단 쿠버네티스 클러스터를 구동시키면, 그 위에 컨테이너화된 애플리케이션을 배포할 수 있다. + 그러기 위해서, 쿠버네티스 디플로이먼트 설정을 만들어야 한다. 디플로이먼트는 쿠버네티스가 + 애플리케이션의 인스턴스를 어떻게 생성하고 업데이트해야 하는지를 지시한다. 디플로이먼트가 만들어지면, + 쿠버네티스 마스터가 해당 애플리케이션 인스턴스를 클러스터의 개별 노드에 스케줄한다. +

+ +

애플리케이션 인스턴스가 생성되면, 쿠버네티스 디플로이먼트 컨트롤러는 지속적으로 이들 인스턴스를 + 모니터링한다. 인스턴스를 구동 중인 노드가 다운되거나 삭제되면, 디플로이먼트 컨트롤러가 인스턴스를 + 교체시켜준다. 이렇게 머신의 장애나 정비에 대응할 수 있는 자동 복구(self-healing) 메커니즘을 + 제공한다.

+ +

오케스트레이션 기능이 없던 환경에서는, 설치 스크립트가 애플리케이션을 시작하는데 종종 사용되곤 + 했지만, 머신의 장애가 발생한 경우 복구를 해주지는 않았다. 쿠버네티스 디플로이먼트는 애플리케이션 + 인스턴스를 생성해주고 여러 노드에 걸쳐서 지속적으로 인스턴스가 구동되도록 하는 두 가지를 모두 + 하기 때문에 애플리케이션 관리를 위한 접근법에서 근본적인 차이를 가져다준다.

+ +
+ +
+
+

요약:

+
    +
  • 디플로이먼트
  • +
  • Kubectl
  • +
+
+
+

+ 디플로이먼트는 애플리케이션 인스턴스를 생성하고 업데이트하는 역할을 담당한다. +

+
+
+
+
+ +
+
+

쿠버네티스에 첫 번째 애플리케이션 배포하기

+
+
+ +
+
+

+
+
+
+ +
+
+ +

Kubectl이라는 쿠버네티스 CLI를 통해 디플로이먼트를 생성하고 관리할 수 있다. + Kubectl은 클러스터와 상호 작용하기 위해 쿠버네티스 API를 사용한다. 이 모듈에서는, 쿠버네티스 + 클러스터 상에 애플리케이션을 구동시키는 디플로이먼트를 생성하기 위해 필요한 가장 일반적인 Kubectl + 명령어를 배우게 된다.

+ +

디플로이먼트를 생성할 때, 애플리케이션에 대한 컨테이너 이미지와 구동시키고자 하는 복제 수를 지정해야 + 한다. 디플로이먼트를 업데이트해서 이런 정보를 나중에 변경할 수 있다. 모듈 + 56의 부트캠프에서 어떻게 + 스케일하고 업데이트하는지에 대해 다룬다.

+ + +
+
+
+

애플리케이션이 쿠버네티스 상에 배포되려면 지원되는 컨테이너 형식 중 하나로 패키지 되어야한다. +

+
+
+
+ +
+
+ +

우리의 첫 번째 디플로이먼트로, Docker 컨테이너로 패키지된 Node.js + 애플리케이션을 사용해보자. 소스 코드와 Dockerfile은 GitHub + 저장소에서 찾을 수 있다.

+ +

이제 디플로이먼트를 이해했으니, 온라인 튜토리얼을 통해 우리의 첫 번째 애플리케이션을 배포해보자!

+ +
+
+
+ + + +
+ +
+ + + +>>>>>>> master diff --git a/content/ko/docs/tutorials/kubernetes-basics/explore/explore-interactive.html b/content/ko/docs/tutorials/kubernetes-basics/explore/explore-interactive.html index 9b90944a82..4e6f8cabcc 100644 --- a/content/ko/docs/tutorials/kubernetes-basics/explore/explore-interactive.html +++ b/content/ko/docs/tutorials/kubernetes-basics/explore/explore-interactive.html @@ -1,3 +1,4 @@ +<<<<<<< HEAD --- title: 대화형 튜토리얼 - 앱 조사하기 weight: 20 @@ -43,3 +44,51 @@ weight: 20 +||||||| merged common ancestors +======= +--- +title: 대화형 튜토리얼 - 앱 조사하기 +weight: 20 +--- + + + + + + + + + + + +
+ +
+ +
+
+ +
+ 터미널과 상호작용하기 위해, 데스크탑/태블릿 버전을 이용한다. +
+ +
+
+
+ + +
+ +
+ + + +>>>>>>> master diff --git a/content/ko/docs/tutorials/kubernetes-basics/explore/explore-intro.html b/content/ko/docs/tutorials/kubernetes-basics/explore/explore-intro.html index 0865caad9f..0c7433d61a 100644 --- a/content/ko/docs/tutorials/kubernetes-basics/explore/explore-intro.html +++ b/content/ko/docs/tutorials/kubernetes-basics/explore/explore-intro.html @@ -1,3 +1,4 @@ +<<<<<<< HEAD --- title: 파드와 노드 보기 weight: 10 @@ -141,3 +142,149 @@ weight: 10 +||||||| merged common ancestors +======= +--- +title: 파드와 노드 보기 +weight: 10 +--- + + + + + + + + + + +
+ +
+ +
+ +
+

목표

+
    +
  • 쿠버네티스 파드에 대해 배운다.
  • +
  • 쿠버네티스 노드에 대해 배운다.
  • +
  • 배포된 애플리케이션의 문제를 해결한다.
  • +
+
+ +
+

쿠버네티스 파드

+

모듈 2에서 배포를 생성했을 때, 쿠버네티스는 여러분의 애플리케이션 인스턴스에 파드를 생성했다. 파드는 하나 또는 그 이상의 애플리케이션 컨테이너 (도커 또는 rkt와 같은)들의 그룹을 나타내는 쿠버네티스의 추상적 개념으로 일부는 컨테이너에 대한 자원을 공유한다. 그 자원은 다음을 포함한다:

+
    +
  • 볼륨과 같은, 공유 스토리지
  • +
  • 클러스터 IP 주소와 같은, 네트워킹
  • +
  • 컨테이너 이미지 버전 또는 사용할 특정 포트와 같이, 각 컨테이너가 동작하는 방식에 대한 정보
  • +
+

파드는 특유한 "로컬호스트" 애플리케이션 모형을 만들어. 상대적으로 밀접하게 결합되어진 상이한 애플리케이션 컨테이너들을 수용할 수 있다. 가령, 파드는 Node.js 앱과 더불어 Node.js 웹서버에 의해 발행되는 데이터를 공급하는 상이한 컨테이너를 함께 수용할 수 있다. 파드 내 컨테이너는 IP 주소, 그리고 포트 스페이스를 공유하고 항상 함께 위치하고 함께 스케쥴링 되고 동일 노드 상의 컨텍스트를 공유하면서 동작한다.

+ +

파드는 쿠버네티스 플랫폼 상에서 최소 단위가 된다. 우리가 쿠버네티스에서 배포를 생성할 때, 그 배포는 컨테이너 내부에서 컨테이너와 함께 파드를 생성한다. 각 파드는 스케쥴 되어진 노드에게 묶여지게 된다. 그리고 (재구동 정책에 따라) 소멸되거나 삭제되기 전까지 그 노드에 유지된다. 노드에 실패가 발생할 경우, 클러스터 내에 가용한 다른 노드들을 대상으로 스케쥴되어진다.

+ +
+
+
+

요약:

+
    +
  • 파드
  • +
  • 노드
  • +
  • Kubectl 주요 명령어
  • +
+
+
+

+ 파드는 하나 또는 그 이상의 애플리케이션 컨테이너 (도커 또는 rkt와 같은)들의 그룹이고 공유 스토리지 (볼륨), IP 주소 그리고 그것을 동작시키는 방식에 대한 정보를 포함하고 있다. +

+
+
+
+
+ +
+
+

파드 개요

+
+
+ +
+
+

+
+
+
+ +
+
+

노드

+

파드는 언제나 노드 상에서 동작한다. 노드는 쿠버네티스에서 워커 머신을 말하며 클러스터에 따라 가상 또는 물리 머신일 수 있다. 각 노드는 마스터에 의해 관리된다. 하나의 노드는 여러 개의 파드를 가질 수 있고, 쿠버네티스 마스터는 클러스터 내 노드를 통해서 파드에 대한 스케쥴링을 자동으로 처리한다.

+ +

모든 쿠버네티스 노드는 최소한 다음과 같이 동작한다.

+
    +
  • Kubelet은, 쿠버네티스 마스터와 노드 간 통신을 책임지는 프로세스이며, 하나의 머신 상에서 동작하는 파드와 컨테이너를 관리한다.
  • +
  • (도커, rkt)와 같은 컨테이너 런타임은 레지스트리에서 컨테이너 이미지를 가져와 묶여 있는 것을 풀고 애플리케이션을 동작시키는 책임을 맡는다.
  • +
+ +
+
+
+

만약 컨테이너들이 밀접하고 결합되어 있고 디스크와 같은 자원을 공유해야 한다면 오직 하나의 단일 파드에 함께 스케쥴되어져야 한다.

+
+
+
+ +
+ +
+
+

노드 개요

+
+
+ +
+
+

+
+
+
+ +
+
+

kubectl로 문제해결하기

+

모듈 2에서, 여러분은 Kubectl 커맨드-라인 인터페이스를 사용하였다. 여러분은 배포된 애플리케이션과 그 환경에 대한 정보를 얻기 위해 모듈 3에서도 계속 그것을 사용하게 될 것이다. 가장 보편적인 운용업무는 다음 kubectl 명령어를 이용해 처리될 수 있다:

+
    +
  • kubectl get - 자원을 나열한다
  • +
  • kubectl describe - 자원에 대해 상세한 정보를 보여준다.
  • +
  • kubectl logs - 파드 내 컨테이너의 로그들을 출력한다
  • +
  • kubectl exec - 파드 내 컨테이너에 대한 명령을 실행한다.
  • +
+ +

언제 애플리케이션이 배포되었으며, 현재 상태가 어떠한지, 그것의 구성은 어떠한지 등을 보기 위해 이러한 명령을 이용할 수 있다.

+ +

이제 클러스터 컴포넌트와 커맨드 라인에 대해 알아 보았으니, 애플리케이션을 조사해 보자.

+ +
+
+
+

노드는 쿠버네티스에 있어서 워커 머신이며 클러스터에 따라 VM 또는 물리 머신이 될 수 있다. 여러개의 파드는 하나의 노드 위에서 동작할 수 있다.

+
+
+
+
+ + + +
+ +
+ + + +>>>>>>> master diff --git a/content/ko/docs/tutorials/kubernetes-basics/expose/expose-interactive.html b/content/ko/docs/tutorials/kubernetes-basics/expose/expose-interactive.html index 6d7a569862..69596107a3 100644 --- a/content/ko/docs/tutorials/kubernetes-basics/expose/expose-interactive.html +++ b/content/ko/docs/tutorials/kubernetes-basics/expose/expose-interactive.html @@ -1,3 +1,4 @@ +<<<<<<< HEAD --- title: 대화형 튜토리얼 - 앱 노출하기 weight: 20 @@ -36,3 +37,44 @@ weight: 20 +||||||| merged common ancestors +======= +--- +title: 대화형 튜토리얼 - 앱 노출하기 +weight: 20 +--- + + + + + + + + + + + +
+ +
+ +
+
+ 터미널과 상호작용하기 위해, 데스크탑/태블릿 버전을 이용한다. +
+
+
+
+ + +
+ +
+ + + +>>>>>>> master diff --git a/content/ko/docs/tutorials/kubernetes-basics/expose/expose-intro.html b/content/ko/docs/tutorials/kubernetes-basics/expose/expose-intro.html index 6ffa2c6126..27a7a5fa07 100644 --- a/content/ko/docs/tutorials/kubernetes-basics/expose/expose-intro.html +++ b/content/ko/docs/tutorials/kubernetes-basics/expose/expose-intro.html @@ -1,3 +1,4 @@ +<<<<<<< HEAD --- title: 앱 노출을 위해 서비스 이용하기 weight: 10 @@ -112,3 +113,120 @@ weight: 10 +||||||| merged common ancestors +======= +--- +title: 앱 노출을 위해 서비스 이용하기 +weight: 10 +--- + + + + + + + + + +
+ +
+ +
+
+

목표

+
    +
  • 쿠버네티스의 서비스에 대해 배운다.
  • +
  • 레이블과 레이블셀랙터 오브젝트가 어떻게 서비스와 연관되는지 이해한다.
  • +
  • 서비스를 이용하여 쿠버네티스 클러스터 외부로 애플리케이션을 노출한다.
  • +
+
+ +
+

쿠버네티스 서비스들에 대한 개요

+ +

쿠버네티스 파드들 은 언젠가는 죽게된다. 실제 파드들은 생명주기를 갖는다. 워커 노드가 죽으면, 노드 상에서 동작하는 파드들 또한 종료된다. 레플리케이션 컨트롤러는 여러분의 애플리케이션이 지속적으로 동작할 수 있도록 새로운 파드들의 생성을 통해 동적으로 클러스터를 미리 지정해 둔 상태로 되돌려 줄 수도 있다. 또 다른 예시로서, 3개의 복제본을 갖는 이미지 처리용 백엔드를 고려해 보자. 그 복제본들은 대체 가능한 상태이다. 그래서 프론트엔드 시스템은 하나의 파드가 소멸되어 재생성이 되더라도, 백엔드 복제본들에 의한 영향을 받아서는 안된다. 즉, 동일 노드 상의 파드들이라 할지라도, 쿠버네티스 클러스터 내 각 파드는 유일한 IP 주소를 가지며, 여러분의 애플리케이션들이 지속적으로 기능할 수 있도록 파드들 속에서 발생하는 변화에 대해 자동으로 조정해 줄 방법이 있어야 한다.

+ +

쿠버네티스에서 서비스는 하나의 논리적인 파드 셋과 그 파드들에 접근할 수 있는 정책을 정의하는 추상적 개념이다. 서비스는 종속적인 파드들 사이를 느슨하게 결합되도록 해준다. 서비스는 모든 쿠버네티스 오브젝트들과 같이 YAML (보다 선호하는) 또는 JSON을 이용하여 정의된다. 서비스가 대상으로 하는 파드 셋은 보통 LabelSelector에 의해 결정된다 (여러분이 왜 스펙에 selector가 포함되지 않은 서비스를 필요로 하게 될 수도 있는지에 대해 아래에서 확인해 보자).

+ +

비록 각 파드들이 고유의 IP를 갖고 있기는 하지만, 그 IP들은 서비스의 도움없이 클러스터 외부로 노출되어질 수 없다. 서비스들은 여러분의 애플리케이션들에게 트래픽이 실릴 수 있도록 허용해준다. 서비스들은 ServiceSpec에서 type을 지정함으로써 다양한 방식들로 노출시킬 수 있다:

+
    +
  • ClusterIP (기본값) - 클러스터 내에서 내부 IP 에 대해 서비스를 노출해준다. 이 방식은 오직 클러스터 내에서만 서비스가 접근될 수 있도록 해준다.
  • +
  • NodePort - NAT가 이용되는 클러스터 내에서 각각 선택된 노드들의 동일한 포트에 서비스를 노출시켜준다. <NodeIP>:<NodePort>를 이용하여 클러스터 외부로부터 서비스가 접근할 수 있도록 해준다. CluserIP의 상위 집합이다.
  • +
  • LoadBalancer - (지원 가능한 경우) 기존 클라우드에서 외부용 로드밸런서를 생성하고 서비스에 고정된 공인 IP를 할당해준다. NodePort의 상위 집합이다.
  • +
  • ExternalName - 이름으로 CNAME 레코드를 반환함으로써 임의의 이름(스펙에서 externalName으로 명시)을 이용하여 서비스를 노출시켜준다. 프록시는 사용되지 않는다. 이 방식은 kube-dns 버전 1.7 이상에서 지원 가능하다.
  • +
+

다른 서비스 타입들에 대한 추가 정보는 소스 IP 이용하기 튜토리얼에서 확인 가능하다. 또한 서비스들로 애플리케이션에 접속하기도 참고해 보자.

+

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

+
+
+
+

요약

+
    +
  • 파드들을 외부 트래픽에 노출하기
  • +
  • 여러 파드에 걸쳐서 트래픽 로드밸런싱 하기
  • +
  • 레이블 사용하기
  • +
+
+
+

쿠버네티스 서비스는 논리적 파드 셋을 정의하고 외부 트래픽 노출, 로드밸런싱 그리고 그 파드들에 대한 서비스 디스커버리를 가능하게 해주는 추상 계층이다.

+
+
+
+
+ +
+
+

서비스와 레이블

+
+
+ +
+
+

+
+
+ +
+
+

서비스는 파드 셋에 걸쳐서 트래픽을 라우트한다. 여러분의 애플리케이션에 영향을 주지 않으면서 쿠버네티스에서 파드들이 죽게도 하고, 복제가 되게도 해주는 추상적 개념이다. 종속적인 파드들 사이에서의 디스커버리와 라우팅은 (하나의 애플리케이션에서 프로트엔드와 백엔드 컴포넌트와 같은) 쿠버네티스 서비스들에 의해 처리된다.

+

서비스는 쿠버네티스의 객체들에 대해 논리 연산을 허용해주는 기본 그룹핑 단위인, 레이블과 셀렉터를 이용하여 파드 셋과 매치시킨다. 레이블은 오브젝트들에 붙여진 키/밸류 쌍으로 다양한 방식으로 이용 가능하다:

+
    +
  • 개발, 테스트, 그리고 상용환경에 대한 객체들의 지정
  • +
  • 임베디드된 버전 태그들
  • +
  • 태그들을 이용하는 객체들에 대한 분류
  • +
+ +
+
+
+

여러분은 kubectl 명령에
--expose 옵션을 사용함으로써 디플로이먼트 생성과 동일 시점에 서비스를 생성할 수 있다.

+
+
+
+ +
+ +
+
+

+
+
+
+
+
+

레이블은 오브젝트의 생성 시점 또는 이후 시점에 붙여질 수 있다. 언제든지 수정이 가능하다. 이제 서비스를 이용하여 우리의 애플리케이션을 노출도 시켜보고 레이블도 적용해 보자.

+
+
+
+ +
+
+ + + +>>>>>>> master diff --git a/content/ko/docs/tutorials/kubernetes-basics/scale/scale-interactive.html b/content/ko/docs/tutorials/kubernetes-basics/scale/scale-interactive.html index 41dc8ce052..17daa33869 100644 --- a/content/ko/docs/tutorials/kubernetes-basics/scale/scale-interactive.html +++ b/content/ko/docs/tutorials/kubernetes-basics/scale/scale-interactive.html @@ -1,3 +1,4 @@ +<<<<<<< HEAD --- title: 대화형 튜토리얼 - 앱 스케일링하기 weight: 20 @@ -42,3 +43,50 @@ weight: 20 +||||||| merged common ancestors +======= +--- +title: 대화형 튜토리얼 - 앱 스케일링하기 +weight: 20 +--- + + + + + + + + + + + +
+ +
+ +
+
+ 터미널로 상호 작용하기 위해서, 데스크탑/태블릿 버전을 사용해주세요 +
+
+
+
+ + +
+ + + +
+ + + +>>>>>>> master diff --git a/content/ko/docs/tutorials/kubernetes-basics/scale/scale-intro.html b/content/ko/docs/tutorials/kubernetes-basics/scale/scale-intro.html index a3f7da1d4d..b1da2f797f 100644 --- a/content/ko/docs/tutorials/kubernetes-basics/scale/scale-intro.html +++ b/content/ko/docs/tutorials/kubernetes-basics/scale/scale-intro.html @@ -1,3 +1,4 @@ +<<<<<<< HEAD --- title: 복수의 앱 인스턴스를 구동하기 weight: 10 @@ -134,3 +135,142 @@ weight: 10 +||||||| merged common ancestors +======= +--- +title: 복수의 앱 인스턴스를 구동하기 +weight: 10 +--- + + + + + + + + + +
+ +
+ +
+ +
+

목표

+
    +
  • kubectl을 사용해서 애플리케이션을 스케일한다.
  • +
+
+ +
+

애플리케이션을 스케일하기

+ +

지난 모듈에서 디플로이먼트, + 를 만들고 서비스를 + 통해서 디플로이먼트를 외부에 노출시켜 봤다. 해당 디플로이먼트는 애플리케이션을 구동하기 위해 단 + 하나의 파드(Pod)만을 생성했었다. 트래픽이 증가하면, 사용자 요청에 맞추어 애플리케이션의 규모를 + 조정할 필요가 있다.

+ +

디플로이먼트의 복제 수를 변경하면 스케일링이 수행된다

+ +
+
+
+

요약:

+
    +
  • 디플로이먼트 스케일링하기
  • +
+
+
+

kubectl run 명령에 --replicas 파라미터를 사용해서 처음부터 복수의 인스턴스로 구동되는 + 디플로이먼트를 만들 수도 있다

+
+
+
+
+ +
+
+

스케일링 개요

+
+
+ +
+
+
+ +
+
+ +
+ +
+
+ +

디플로이먼트를 스케일 아웃하면 신규 파드가 생성되어서 가용한 자원이 있는 노드에 스케줄된다. + 스케일링 기능은 새로 의도한 상태(desired state)까지 파드의 수를 늘린다. 쿠버네티스는 + 파드의 오토스케일링 + 도 지원하지만 본 튜토리얼에서는 다루지 않는다. 0까지 스케일링하는 것도 가능하다. 이 경우 해당 + 디플로이먼트의 모든 파드가 종료된다.

+ +

애플리케이션의 인스턴스를 복수로 구동하게 되면 트래픽을 해당 인스턴스 모두에 분산시킬 방법이 + 필요해진다. 서비스는 노출된 디플로이먼트의 모든 파드에 네트워크 트래픽을 분산시켜줄 통합된 + 로드밸런서를 갖는다. 서비스는 엔드포인트를 이용해서 구동중인 파드를 지속적으로 모니터링함으로써 + 가용한 파드에만 트래픽이 전달되도록 해준다.

+ +
+
+
+

디플로이먼트의 복제 수를 변경하면 스케일링이 수행된다.

+
+
+
+ +
+ +
+
+

일단 복수의 애플리케이션의 인스턴스가 구동 중이면, 다운타임 없이 롤링 업데이트를 할 수 있다. + 다음 모듈에서 이 내용을 다루도록 하겠다. 이제 온라인 터미널로 가서 애플리케이션을 스케일해보자.

+
+
+
+ + + +
+ +
+ + + +>>>>>>> master diff --git a/content/ko/docs/tutorials/kubernetes-basics/update/update-interactive.html b/content/ko/docs/tutorials/kubernetes-basics/update/update-interactive.html index 83ba8f581f..5c014d29e1 100644 --- a/content/ko/docs/tutorials/kubernetes-basics/update/update-interactive.html +++ b/content/ko/docs/tutorials/kubernetes-basics/update/update-interactive.html @@ -1,3 +1,4 @@ +<<<<<<< HEAD --- title: 대화형 튜토리얼 - 앱 업데이트 하기 weight: 20 @@ -35,3 +36,43 @@ weight: 20 +||||||| merged common ancestors +======= +--- +title: 대화형 튜토리얼 - 앱 업데이트 하기 +weight: 20 +--- + + + + + + + + + + + +
+ +
+ +
+
+ 터미널과 상호작용하기 위해, 데스크탑/태블릿 버전을 이용한다. +
+
+
+
+ +
+ +
+ + + +>>>>>>> master diff --git a/content/ko/docs/tutorials/kubernetes-basics/update/update-intro.html b/content/ko/docs/tutorials/kubernetes-basics/update/update-intro.html index ea011672a0..d2e3b99430 100644 --- a/content/ko/docs/tutorials/kubernetes-basics/update/update-intro.html +++ b/content/ko/docs/tutorials/kubernetes-basics/update/update-intro.html @@ -1,3 +1,4 @@ +<<<<<<< HEAD --- title: 롤링 업데이트 수행하기 weight: 10 @@ -139,3 +140,147 @@ weight: 10 +||||||| merged common ancestors +======= +--- +title: 롤링 업데이트 수행하기 +weight: 10 +--- + + + + + + + + + +
+ +
+ +
+ +
+

목표

+
    +
  • kubectl을 이용하여 롤링 업데이트 수행하기
  • +
+
+ +
+

애플리케이션 업데이트하기

+ +

사용자들은 애플리케이션이 항상 가용한 상태일 것이라 여기고 개발자들은 하루에 여러번씩 새로운 버전을 + 배포하도록 요구 받고있다. 쿠버네티스에서는 이것을 롤링 업데이트를 통해 이루고 있다. 롤링 업데이트는 파드 인스턴스를 점진적으로 새로운 것으로 업데이트하여 디플로이먼트 업데이트가 서비스 중단 없이 이루어질 수 있도록 해준다. + 새로운 파드는 가용한 자원을 보유한 노드로 스케줄될 것이다.

+ +

이전 모듈에서 여러 개의 인스턴스를 동작시키도록 애플리케이션을 스케일했다. 이것은 애플리케이션의 가용성에 영향을 미치지 않으면서 + 업데이트를 수행하는 것에 대한 요구이다. 기본적으로, 업데이트가 이루어지는 동안 이용 불가한 파드의 최대 개수와 생성 가능한 새로운 파드의 최대 개수는 하나다. + 두 옵션은 (파드에 대한) 개수 또는 백분율로 구성될 수 있다. + 쿠버네티스에서, 업데이트는 버전으로 관리되고 어떠한 디플로이먼트 업데이트라도 이전의 (안정적인) 버전으로 원복이 가능하다.

+ +
+
+
+

요약:

+
    +
  • 앱 업데이트하기
  • +
+
+
+

롤링 업데이트는 파드 인스턴스를 점진적으로 새로운 것으로 업데이트하여 디플로이먼트 업데이트가 서비스 중단 없이 이루어질 수 있도록 해준다.

+
+
+
+
+ +
+
+

롤링 업데이트 개요

+
+
+
+
+
+ +
+
+
+ +
+
+ +

애플리케이션 스케일링과 유사하게, 디플로이먼트가 외부로 노출되면, 서비스는 업데이트가 이루어지는 동안 오직 가용한 파드에게만 트래픽을 로드밸런스 할 것이다. 가용한 파드란 애플리케이션의 사용자들에게 가용한 상태의 인스턴스를 말한다.

+ +

롤링 업데이트는 다음 동작들을 허용해준다:

+
    +
  • 하나의 환경에서 또 다른 환경으로의 애플리케이션 프로모션 (컨테이너 이미지 업데이트를 통해)
  • +
  • 이전 버전으로의 롤백
  • +
  • 서비스 중단 없는 애플리케이션의 지속적인 통합과 지속적인 전달
  • + +
+ +
+
+
+

디플로이먼트가 외부로 노출되면, 서비스는 업데이트가 이루어지는 동안 오직 가용한 파드에게만 트래픽을 로드밸런스 할 것이다.

+
+
+
+ +
+ +
+
+

다음 대화형 튜토리얼에서, 새로운 버전으로 애플리케이션을 업데이트하고, 롤백 또한 수행해 볼 것이다.

+
+
+
+ + + +
+ +
+ + + +>>>>>>> master diff --git a/content/no/blog/_index.md b/content/no/blog/_index.md new file mode 100644 index 0000000000..c475a33fd9 --- /dev/null +++ b/content/no/blog/_index.md @@ -0,0 +1,4 @@ +--- +title: Kubernetes Blogg +linkTitle: Blogg +--- diff --git a/content/no/blog/_posts/2018-09-06-2018-steering-committee-election-cycle-kicks-off.md b/content/no/blog/_posts/2018-09-06-2018-steering-committee-election-cycle-kicks-off.md new file mode 100644 index 0000000000..46f450a0a5 --- /dev/null +++ b/content/no/blog/_posts/2018-09-06-2018-steering-committee-election-cycle-kicks-off.md @@ -0,0 +1,6 @@ +--- +title: '2018 Norsk oversettelse' +date: 2018-09-06 +--- + +Norsk oversettelse. diff --git a/content/no/case-studies/_index.md b/content/no/case-studies/_index.md index b6380168c4..ffe4845a34 100644 --- a/content/no/case-studies/_index.md +++ b/content/no/case-studies/_index.md @@ -1,4 +1,8 @@ --- title: Eksempler på Kubernetes-bruk +linkTitle: Kubernetes-brukere +class: gridPage +cid: caseStudies + --- \ No newline at end of file diff --git a/content/no/case-studies/adform/index.html b/content/no/case-studies/adform/index.html new file mode 100644 index 0000000000..7bef6dea4f --- /dev/null +++ b/content/no/case-studies/adform/index.html @@ -0,0 +1,115 @@ +--- +title: Adform bruker-historie +linkTitle: Adform +case_study_styles: true +cid: caseStudies +css: /css/style_case_studies.css +featured: true +weight: 47 +quote: Her er en norsk oversettelse. +--- + +
+

CASE STUDY:
Improving Performance and Morale with Cloud Native + +

+ +
+ +
+ Company  AdForm     Location  Copenhagen, Denmark     Industry  Adtech +
+ +
+
+
+
+

Challenge

+ Adform’s mission is to provide a secure and transparent full stack of advertising technology to enable digital ads across devices. The company has a large infrastructure: OpenStack-based private clouds running on 1,100 physical servers in 7 data centers around the world, 3 of which were opened in the past year. With the company’s growth, the infrastructure team felt that "our private cloud was not really flexible enough," says IT System Engineer Edgaras Apšega. "The biggest pain point is that our developers need to maintain their virtual machines, so rolling out technology and new software takes time. We were really struggling with our releases, and we didn’t have self-healing infrastructure." + + +
+ +

Solution

+ The team, which had already been using Prometheus for monitoring, embraced Kubernetes and cloud native practices in 2017. "To start our Kubernetes journey, we had to adapt all our software, so we had to choose newer frameworks," says Apšega. "We also adopted the microservices way, so observability is much better because you can inspect the bug or the services separately." + + +
+ +
+ +

Impact

+ "Kubernetes helps our business a lot because our features are coming to market faster," says Apšega. The release process went from several hours to several minutes. Autoscaling has been at least 6 times faster than the semi-manual VM bootstrapping and application deployment required before. The team estimates that the company has experienced cost savings of 4-5x due to less hardware and fewer man hours needed to set up the hardware and virtual machines, metrics, and logging. Utilization of the hardware resources has been reduced as well, with containers notching 2-3 times more efficiency over virtual machines. "The deployments are very easy because developers just push the code and it automatically appears on Kubernetes," says Apšega. Prometheus has also had a positive impact: "It provides high availability for metrics and alerting. We monitor everything starting from hardware to applications. Having all the metrics in Grafana dashboards provides great insight on your systems." + + +
+ +
+
+
+
+"Kubernetes enabled the self-healing and immutable infrastructure. We can do faster releases, so our developers are really happy. They can ship our features faster than before, and that makes our clients happier."

— Edgaras Apšega, IT Systems Engineer, Adform
+ +
+
+ + +
+
+

Adform made headlines last year when it detected the HyphBot ad fraud network that was costing some businesses hundreds of thousands of dollars a day.

With its mission to provide a secure and transparent full stack of advertising technology to enable an open internet, Adform published a white paper revealing what it did—and others could too—to limit customers’ exposure to the scam.

+In that same spirit, Adform is sharing its cloud native journey. "When you see that everyone shares their best practices, it inspires you to contribute back to the project," says IT Systems Engineer Edgaras Apšega.

+The company has a large infrastructure: OpenStack-based private clouds running on 1,100 physical servers in their own seven data centers around the world, three of which were opened in the past year. With the company’s growth, the infrastructure team felt that "our private cloud was not really flexible enough," says Apšega. "The biggest pain point is that our developers need to maintain their virtual machines, so rolling out technology and new software really takes time. We were really struggling with our releases, and we didn’t have self-healing infrastructure." + + +
+
+
+
+ "The fact that Cloud Native Computing Foundation incubated Kubernetes was a really big point for us because it was vendor neutral. And we can see that a community really gathers around it. Everyone shares their experiences, their knowledge, and the fact that it’s open source, you can contribute."

— Edgaras Apšega, IT Systems Engineer, Adform
+
+
+
+
+ +The team, which had already been using Prometheus for monitoring, embraced Kubernetes, microservices, and cloud native practices. "The fact that Cloud Native Computing Foundation incubated Kubernetes was a really big point for us because it was vendor neutral," says Apšega. "And we can see that a community really gathers around it."

+A proof of concept project was started, with a Kubernetes cluster running on bare metal in the data center. When developers saw how quickly containers could be spun up compared to the virtual machine process, "they wanted to ship their containers in production right away, and we were still doing proof of concept," says IT Systems Engineer Andrius Cibulskis. +Of course, a lot of work still had to be done. "First of all, we had to learn Kubernetes, see all of the moving parts, how they glue together," says Apšega. "Second of all, the whole CI/CD part had to be redone, and our DevOps team had to invest more man hours to implement it. And third is that developers had to rewrite the code, and they’re still doing it." +

+The first production cluster was launched in the spring of 2018, and is now up to 20 physical machines dedicated for pods throughout three data centers, with plans for separate clusters in the other four data centers. The user-facing Adform application platform, data distribution platform, and back ends are now all running on Kubernetes. "Many APIs for critical applications are being developed for Kubernetes," says Apšega. "Teams are rewriting their applications to .NET core, because it supports containers, and preparing to move to Kubernetes. And new applications, by default, go in containers." + + +
+
+
+
+"Releases are really nice for them, because they just push their code to Git and that’s it. They don’t have to worry about their virtual machines anymore."

— Andrius Cibulskis, IT Systems Engineer, Adform
+
+
+ +
+
+This big push has been driven by the real impact that these new practices have had. "Kubernetes helps our business a lot because our features are coming to market faster," says Apšega. "The deployments are very easy because developers just push the code and it automatically appears on Kubernetes." The release process went from several hours to several minutes. Autoscaling is at least six times faster than the semi-manual VM bootstrapping and application deployment required before.

+The team estimates that the company has experienced cost savings of 4-5x due to less hardware and fewer man hours needed to set up the hardware and virtual machines, metrics, and logging. Utilization of the hardware resources has been reduced as well, with containers notching two to three times more efficiency over virtual machines.

+Prometheus has also had a positive impact: "It provides high availability for metrics and alerting," says Apšega. "We monitor everything starting from hardware to applications. Having all the metrics in Grafana dashboards provides great insight on our systems." + + + +
+ +
+
+ "I think that our company just started our cloud native journey. It seems like a huge road ahead, but we’re really happy that we joined it."

— Edgaras Apšega, IT Systems Engineer, Adform
+
+
+ +
+All of these benefits have trickled down to individual team members, whose working lives have been changed for the better. "They used to have to get up at night to re-start some services, and now Kubernetes handles all of that," says Apšega. Adds Cibulskis: "Releases are really nice for them, because they just push their code to Git and that’s it. They don’t have to worry about their virtual machines anymore." Even the security teams have been impacted. "Security teams are always not happy," says Apšega, "and now they’re happy because they can easily inspect the containers." +The company plans to remain in the data centers for now, "mostly because we want to keep all the data, to not share it in any way," says Cibulskis, "and it’s cheaper at our scale." But, Apšega says, the possibility of using a hybrid cloud for computing is intriguing: "One of the projects we’re interested in is the Virtual Kubelet that lets you spin up the working nodes on different clouds to do some computing." +

+Apšega, Cibulskis and their colleagues are keeping tabs on how the cloud native ecosystem develops, and are excited to contribute where they can. "I think that our company just started our cloud native journey," says Apšega. "It seems like a huge road ahead, but we’re really happy that we joined it." + + + +
+ +
diff --git a/content/no/docs/_index.md b/content/no/docs/_index.md new file mode 100644 index 0000000000..df6139e123 --- /dev/null +++ b/content/no/docs/_index.md @@ -0,0 +1,3 @@ +--- +title: Dokumentasjon +--- diff --git a/content/no/docs/contribute/_index.md b/content/no/docs/contribute/_index.md new file mode 100755 index 0000000000..684274748f --- /dev/null +++ b/content/no/docs/contribute/_index.md @@ -0,0 +1,29 @@ +--- +title: "Hjelp til med Kubernetes-dokumentasjonen" +weight: 80 +--- + +## Quamquam conversa + +Tooltip: {{< glossary_tooltip text="Pod" term_id="pod" >}}. Tooltip 2 (translated): {{< glossary_tooltip term_id="container" >}}. + +Capere mirabile gaudet vetitorum proturbat sponte amplexus videamus +*exsultantemque* maenala partibus radice seris [submersum at +vitta](http://flamine.org/nostrae) transcurrere nitidum lumina septem. +Recentibus superas discedens duobus fessusque Stygias ubera et terrarumque +monstri conprensus amantis Martius orbes. Ad secreta Medusae diurnis movit +aspicite, patruo, nunc referre, abit prior ab, Est! Et esse **et** flexi +periuria, venturis mihi finis nunc premis, citharae. + +> Exit relinquant testataque habet varios et Mermeros longaque incidit vestes +> unda quae daulida. Temeraria fugant patriorum plures, stabat, in illam; +> vilisque labori virosque; ad, nomine, vires. Hiatu occulte vindice, bracchia +> ille sustulit adspicit data? Tibi recto flammas sine non, partes esset, +> tendens omnes. + +## Ante dos Caucason stetit eadem errabat ipsa + +Quid videbatur nimium sonus, in tibi, contingere viriles erit! Se vitat oculi +viginti, posse, pectus veteres. Citharae *carmina* subdidit, corruit pulcherrime +mortalia turaque nostri aequora tempora credas repugnat loqui! Parnasi seu ument +ea fulgore, teres **ut adamanta longis** dant spatium est *ille* prosilit iacto? diff --git a/content/no/docs/home/_index.md b/content/no/docs/home/_index.md new file mode 100644 index 0000000000..72bbaff103 --- /dev/null +++ b/content/no/docs/home/_index.md @@ -0,0 +1,19 @@ +--- +title: Kubernetes-dokumentasjon +layout: docsportal_home +noedit: true +cid: userJourneys +css: /css/style_user_journeys.css +display_browse_numbers: true +linkTitle: "Dokumentasjon" +main_menu: true +weight: 5 +menu: + main: + title: "Dokumentasjon" + weight: 20 + post: > +

Lær å bruke Kubernetes gjenom eksempler of referansedokumentasjon. Du kan også hjelpe!

+--- + + diff --git a/content/no/docs/reference/_index.md b/content/no/docs/reference/_index.md new file mode 100644 index 0000000000..d73e13d1ec --- /dev/null +++ b/content/no/docs/reference/_index.md @@ -0,0 +1,14 @@ +--- +title: Referanse +weight: 70 +main_menu: true +--- + +## Referanse 1 + + +## Referanse 2 + +## Referanse 3 + +## Referanse 4 \ No newline at end of file diff --git a/content/no/docs/reference/glossary/container.md b/content/no/docs/reference/glossary/container.md new file mode 100755 index 0000000000..15514157d4 --- /dev/null +++ b/content/no/docs/reference/glossary/container.md @@ -0,0 +1,19 @@ +--- +title: "Kontainer" +id: container +date: 2018-04-12 +full_link: /docs/concepts/overview/what-is-kubernetes/#why-containers +short_description: > + En lett-vekts kontainer med alle avhengigheter. + +aka: +tags: +- fundamental +- workload +--- + En lett-vekts kontainer med alle avhengigheter. + + + +Mer tekst her. + diff --git a/content/no/docs/reference/glossary/index.md b/content/no/docs/reference/glossary/index.md new file mode 100644 index 0000000000..d1c3f6b80a --- /dev/null +++ b/content/no/docs/reference/glossary/index.md @@ -0,0 +1,4 @@ +--- +title: "Ordliste" +layout: glossary +--- diff --git a/content/no/docs/setup/_index.md b/content/no/docs/setup/_index.md new file mode 100644 index 0000000000..d0f8474b05 --- /dev/null +++ b/content/no/docs/setup/_index.md @@ -0,0 +1,8 @@ +--- +no_issue: true +weight: 30 +title: Oppsett +main_menu: true +--- + +Dette er en midlertidig norsk oversettelse. \ No newline at end of file diff --git a/content/no/docs/setup/pick-right-solution.md b/content/no/docs/setup/pick-right-solution.md new file mode 100644 index 0000000000..7d314ad9cc --- /dev/null +++ b/content/no/docs/setup/pick-right-solution.md @@ -0,0 +1,6 @@ +--- +title: Å velge den rette løsningen +weight: 10 +--- + +Dette er en midlertidig norsk oversettelse. diff --git a/content/no/docs/tutorials/kubernetes-basics/_index.md b/content/no/docs/tutorials/kubernetes-basics/_index.md new file mode 100644 index 0000000000..3b29499f74 --- /dev/null +++ b/content/no/docs/tutorials/kubernetes-basics/_index.md @@ -0,0 +1,5 @@ +--- +title: Grunnleggende Kubernetes +linkTitle: Prøv Kubernetes +weight: 10 +--- diff --git a/content/zh/OWNERS b/content/zh/OWNERS new file mode 100644 index 0000000000..7eec09c28c --- /dev/null +++ b/content/zh/OWNERS @@ -0,0 +1,11 @@ +# This is the localization project for Chinese. +# Teams and members are visible at https://github.com/orgs/kubernetes/teams. + +reviewers: +- sig-docs-zh-reviews + +approvers: +- sig-docs-zh-owners + +labels: +- language/zh diff --git a/content/cn/_index.html b/content/zh/_index.html similarity index 100% rename from content/cn/_index.html rename to content/zh/_index.html diff --git a/content/zh/blog/_posts/2016-04-00-Kubernetes-Network-Policy-APIs.md b/content/zh/blog/_posts/2016-04-00-Kubernetes-Network-Policy-APIs.md new file mode 100644 index 0000000000..072ec679f3 --- /dev/null +++ b/content/zh/blog/_posts/2016-04-00-Kubernetes-Network-Policy-APIs.md @@ -0,0 +1,182 @@ + + +--- +title: "SIG-Networking: Kubernetes Network Policy APIs Coming in 1.3 " +date: 2016-04-18 +slug: kubernetes-network-policy-apis +url: /blog/2016/04/Kubernetes-Network-Policy-APIs +--- + + + +编者按:这一周,我们的封面主题是 [Kubernetes 特别兴趣小组](https://github.com/kubernetes/kubernetes/wiki/Special-Interest-Groups-(SIGs));今天的文章由网络兴趣小组撰写,来谈谈 1.3 版本中即将出现的网络策略 API - 针对安全,隔离和多租户的策略。 + + + +自去年下半年起,[Kubernetes 网络特别兴趣小组](https://kubernetes.slack.com/messages/sig-network/)经常定期开会,讨论如何将网络策略带入到 Kubernetes 之中,现在,我们也将慢慢看到这些工作的成果。 + + + +很多用户经常会碰到的一个问题是, Kubernetes 的开放访问网络策略并不能很好地满足那些需要对 pod 或服务( service )访问进行更为精确控制的场景。今天,这个场景可以是在多层应用中,只允许临近层的访问。然而,随着组合微服务构建原生应用程序潮流的发展,如何控制流量在不同服务之间的流动会别的越发的重要。 + + + +在大多数的(公共的或私有的) IaaS 环境中,这种网络控制通常是将 VM 和“安全组”结合,其中安全组中成员的通信都是通过一个网络策略或者访问控制表( Access Control List, ACL )来定义,以及借助于网络包过滤器来实现。 + + + +“网络特别兴趣小组”刚开始的工作是确定 [特定的使用场景](https://docs.google.com/document/d/1blfqiH4L_fpn33ZrnQ11v7LcYP0lmpiJ_RaapAPBbNU/edit?pref=2&pli=1#) ,这些用例需要基本的网络隔离来提升安全性。 +让这些API恰如其分地满足简单、共通的用例尤其重要,因为它们将为那些服务于 Kubernetes 内多租户,更为复杂的网络策略奠定基础。 + + + +根据这些应用场景,我们考虑了集中不同的方法,然后定义了一个最简[策略规范](https://docs.google.com/document/d/1qAm-_oSap-f1d6a-xRTj6xaH1sYQBfK36VyjB5XOZug/edit)。 +基本的想法是,如果是根据命名空间的不同来进行隔离,那么就会根据所被允许的流量类型的不同,来选择特定的 pods 。 + + + +快速支持这个实验性 API 的办法是往 API 服务器上加入一个 `ThirdPartyResource` 扩展,这在 Kubernetes 1.2 就能办到。 + + + +如果你还不是很熟悉这其中的细节, Kubernetes API 是可以通过定义 `ThirdPartyResources` 扩展在特定的 URL 上创建一个新的 API 端点。 + +#### third-party-res-def.yaml + +``` +kind: ThirdPartyResource +apiVersion: extensions/v1beta1 +metadata: + - name: network-policy.net.alpha.kubernetes.io +description: "Network policy specification" +versions: + - name: v1alpha1 +``` + +``` +$kubectl create -f third-party-res-def.yaml +``` + + +这条命令会创建一个 API 端点(每个命名空间各一个): + +``` +/net.alpha.kubernetes.io/v1alpha1/namespace/default/networkpolicys/ +``` + + + + +第三方网络控制器可以监听这些端点,根据资源的创建,修改或者删除作出必要的响应。 +_注意:在接下来的 Kubernetes 1.3 发布中, Network Policy API 会以 beta API 的形式出现,这也就不需要像上面那样,创建一个 `ThirdPartyResource` API 端点了。_ + + + +网络隔离默认是关闭的,因而,所有的 pods 之间可以自由地通信。 +然而,很重要的一点是,一旦开通了网络隔离,所有命名空间下的所有 pods 之间的通信都会被阻断,换句话说,开通隔离会改变 pods 的行为。 + + + +网络隔离可以通过定义命名空间, `net.alpha.kubernetes.io` 里的 `network-isolation` 注释来开通关闭: + +``` +net.alpha.kubernetes.io/network-isolation: [on | off] +``` + + + +一旦开通了网络隔离,**一定需要使用** 显示的网络策略来允许 pod 间的通信。 + + + +一个策略规范可以被用到一个命名空间中,来定义策略的细节(如下所示): + +``` +POST /apis/net.alpha.kubernetes.io/v1alpha1/namespaces/tenant-a/networkpolicys/ +{ + "kind": "NetworkPolicy", + "metadata": { + "name": "pol1" + }, + "spec": { + "allowIncoming": { + "from": [ + { + "pods": { + "segment": "frontend" + } + } + ], + "toPorts": [ + { + "port": 80, + "protocol": "TCP" + } + ] + }, + "podSelector": { + "segment": "backend" + } + } +} +``` + + + +在这个例子中,**tenant-a** 空间将会使用 **pol1** 策略。 +具体而言,带有 **segment** 标签为 **backend** 的 pods 会允许 **segment** 标签为 **frontend** 的 pods 访问其端口 80 。 + + + + + +今天,[Romana](http://romana.io/), [OpenShift](https://www.openshift.com/), [OpenContrail](http://www.opencontrail.org/) 以及 [Calico](http://projectcalico.org/) 都已经支持在命名空间和pods中使用网络策略。 +而 Cisco 和 VMware 也在努力实现支持之中。 +Romana 和 Calico 已经在最近的 KubeCon 中展示了如何在 Kubernetes 1.2 下使用这些功能。 +你可以在这里看到他们的演讲: +[Romana](https://www.youtube.com/watch?v=f-dLKtK6qCs) ([幻灯片](http://www.slideshare.net/RomanaProject/kubecon-london-2016-ronana-cloud-native-sdn)), +[Calico](https://www.youtube.com/watch?v=p1zfh4N4SX0) ([幻灯片](http://www.slideshare.net/kubecon/kubecon-eu-2016-secure-cloudnative-networking-with-project-calico)). + + + +**这是如何工作的** + + + +每套解决方案都有自己不同的具体实现。尽管今天,他们都借助于每种主机上( on-host )的实现机制,但未来的实现可以通过将策略使用在 hypervisor 上,亦或是直接使用到网络本身上来达到同样的目的。 + + + +外部策略控制软件(不同实现各有不同)可以监听 pods 创建以及新加载策略的 API 端点。 +当产生一个需要策略配置的事件之后,监听器会确认这个请求,相应的,控制器会配置接口,使用该策略。 +下面的图例展示了 API 监视器和策略控制器是如何通过主机代理在本地应用网络策略的。 +这些 pods 的网络接口是使用过主机上的 CNI 插件来进行配置的(并未在图中注明)。 + + ![controller.jpg](https://lh5.googleusercontent.com/zMEpLMYmask-B-rYWnbMyGb0M7YusPQFPS6EfpNOSLbkf-cM49V7rTDBpA6k9-Zdh2soMul39rz9rHFJfL-jnEn_mHbpg0E1WlM-wjU-qvQu9KDTQqQ9uBmdaeWynDDNhcT3UjX5) + + + + +如果你一直受网络隔离或安全考虑的困扰,而犹豫要不要使用 Kubernetes 来开发应用程序,这些新的网络策略将会极大地解决你这方面的需求。并不需要等到 Kubernetes 1.3 ,现在就可以通过 `ThirdPartyResource` 的方式来使用这个实现性 API 。 + + + + +如果你对 Kubernetes 和网络感兴趣,可以通过下面的方式参与、加入其中: + +- 我们的[网络 slack channel](https://kubernetes.slack.com/messages/sig-network/) +- 我们的[Kubernetes 特别网络兴趣小组](https://groups.google.com/forum/#!forum/kubernetes-sig-network) 邮件列表 + + + +网络“特别兴趣小组”每两周下午三点(太平洋时间)开会,地址是[SIG-Networking hangout](https://zoom.us/j/5806599998). + +_--Chris Marino, Co-Founder, Pani Networks_ diff --git a/content/zh/blog/_posts/2016-04-00-Kubernetes-On-Aws_15.md b/content/zh/blog/_posts/2016-04-00-Kubernetes-On-Aws_15.md new file mode 100644 index 0000000000..c5de9e6a12 --- /dev/null +++ b/content/zh/blog/_posts/2016-04-00-Kubernetes-On-Aws_15.md @@ -0,0 +1,129 @@ + + +--- +title: " 如何在AWS上部署安全,可审计,可复现的k8s集群 " +date: 2016-04-15 +slug: kubernetes-on-aws_15 +url: /blog/2016/04/Kubernetes-On-Aws_15 +--- + + + +_今天的客座文章是由Colin Hom撰写,[CoreOS](https://coreos.com/)的基础架构工程师。CoreOS致力于推广谷歌的基础架构模式(Google’s Infrastructure for Everyone Else, #GIFEE),让全世界的容器都能在CoreOS Linux, Tectonic 和 Quay上安全运行。_ + +_加入到我们的[柏林CoreOS盛宴](https://coreos.com/fest/),这是一个开源分布式系统主题的会议,在这里可以了解到更多关于CoreOS和Kubernetes的信息。_ + + + +在CoreOS, 我们一直都是在生产环境中大规模部署Kubernetes。今天我们非常兴奋地想分享一款工具,它能让你的Kubernetes生产环境大规模部署更加的轻松。Kube-aws这个工具可以用来在AWS上部署可审计,可复现的k8s集群,而CoreOS本身就在生产环境中使用它。 + + + +也许今天,你更多的可能是用手工的方式来拼接Kubernetes组件。但有了这个工具之后,Kubernetes可以流水化地打包、交付,节省时间,减少了相互间的依赖,更加快捷地实现生产环境的部署。 + + + +借助于一个简单的模板系统,来生成集群配置,这么做是因为一套声明式的配置模板可以版本控制,审计以及重复部署。而且,由于整个创建过程只用到了[AWS CloudFormation](https://aws.amazon.com/cloudformation/) 和 cloud-init,你也就不需要额外用到其它的配置管理工具。开箱即用! + + + +如果要跳过演讲,直接了解这个项目,可以看看[kube-aws的最新发布](https://github.com/coreos/coreos-kubernetes/releases),支持Kubernetes 1.2.x。如果要部署集群,可以参考[文档]](https://coreos.com/kubernetes/docs/latest/kubernetes-on-aws.html). + + +**为什么是kube-aws?安全,可审计,可复现** + + +Kube-aws设计初衷有三个目标。 + + + +**安全** : TLS 资源在嵌入到CloudFormation JSON之前,通过[AWS 秘钥管理服务](https://aws.amazon.com/kms/)加密。通过单独管理KMS密钥的[IAM 策略](http://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html),可以将CloudFormation栈的访问与TLS秘钥的访问分离开。 + + + +**可审计** : kube-aws是围绕集群资产的概念来创建。这些配置和账户资产是对集群的完全描述。由于KMS被用来加密TLS资产,因而可以无所顾忌地将未加密的CloudFormation栈 JSON签入到版本控制服务中。 + + + +**可重复** : _--export_ 选项将参数化的集群定义打包成一整个JSON文件,对应一个CloudFormation栈。这个文件可以版本控制,然后,如果需要的话,通过现有的部署工具直接提交给CloudFormation API。 + + +**如何开始用kube-aws** + + +在此基础之上,kube-aws也实现了一些功能,使得在AWS上部署Kubernetes集群更加容易,灵活。下面是一些例子。 + + +**Route53集成** : Kube-aws 可以管理你的集群DNS记录,作为配置过程的一部分。 + +cluster.yaml +``` +externalDNSName: my-cluster.kubernetes.coreos.com + +createRecordSet: true + +hostedZone: kubernetes.coreos.com + +recordSetTTL: 300 +``` + + +**现有VPC支持** : 将集群部署到现有的VPC上。 + +cluster.yaml +``` +vpcId: vpc-xxxxx + +routeTableId: rtb-xxxxx +``` + + +**验证** : kube-aws 支持验证 cloud-init 和 CloudFormation定义,以及集群栈会集成用到的外部资源。例如,下面就是一个cloud-config,外带一个拼写错误的参数: + +userdata/cloud-config-worker +``` +#cloud-config + +coreos: + + flannel: + interrface: $private\_ipv4 + etcd\_endpoints: {{ .ETCDEndpoints }} +``` + +$ kube-aws validate + + \> Validating UserData... + Error: cloud-config validation errors: + UserDataWorker: line 4: warning: unrecognized key "interrface" + + +考虑如何起步?看看[kube-aws 文档](https://coreos.com/kubernetes/docs/latest/kubernetes-on-aws.html)! + + +**未来的工作** + + +一如既往,kube-aws的目标是让生产环境部署更加的简单。尽管我们现在在AWS下使用kube-aws进行生产环境部署,但是这个项目还是pre-1.0,所以还有很多的地方,kube-aws需要考虑、扩展。 + + +**容错** : CoreOS坚信 Kubernetes on AWS是强健的平台,适于容错、自恢复部署。在接下来的几个星期,kube-aws将会迎接新的考验:混世猴子([Chaos Monkey](https://github.com/Netflix/SimianArmy/wiki/Chaos-Monkey))测试 - 控制平面以及全部! + + +**零停机更新** : 更新CoreOS节点和Kubernetes组件不需要停机,也不需要考虑实例更新策略(instance replacement strategy)的影响。 + + +有一个[github issue](https://github.com/coreos/coreos-kubernetes/issues/340)来追踪这些工作进展。我们期待你的参与,提交issue,或是直接贡献。 + + +_想要更多地了解Kubernetes,来[柏林CoreOS盛宴](https://coreos.com/fest/)看看,- 五月 9-10, 2016_ + + +_– Colin Hom, 基础架构工程师, CoreOS_ diff --git a/content/zh/blog/_posts/2018-03-00-Principles-Of-Container-App-Design.md b/content/zh/blog/_posts/2018-03-00-Principles-Of-Container-App-Design.md new file mode 100644 index 0000000000..4797bb7986 --- /dev/null +++ b/content/zh/blog/_posts/2018-03-00-Principles-Of-Container-App-Design.md @@ -0,0 +1,81 @@ +--- +title: "Principles of Container-based Application Design" +date: 2018-03-15 +slug: principles-of-container-app-design +url: /blog/2018/03/Principles-Of-Container-App-Design +--- + + + +现如今,几乎所有的的应用程序都可以在容器中运行。但创建云原生应用,通过诸如 Kubernetes 的云原生平台更有效地自动化运行、管理容器化的应用却需要额外的工作。 +云原生应用需要考虑故障;即使是在底层架构发生故障时也需要可靠地运行。 +为了提供这样的功能,像 Kubernetes 这样的云原生平台需要向运行的应用程序强加一些契约和约束。 +这些契约确保应用可以在符合某些约束的条件下运行,从而使得平台可以自动化应用管理。 + + + +我已经为容器化应用如何之为云原生应用概括出了[七项原则][1]。 + +| ----- | +| ![][2] | +| Container Design Principles | + + + + +这里所述的七项原则涉及到构建时和运行时,两类关注点。 + + +#### 构建时 + + + +* **单一关注点:** 每个容器只解决一个关注点,并且完成的很好。 +* **自包含:** 一个容器只依赖Linux内核。额外的库要求可以在构建容器时加入。 +* **镜像不变性:** 容器化的应用意味着不变性,一旦构建完成,不需要根据环境的不同而重新构建。 + + +#### 运行时 + + + +* **高可观测性:** 每个容器必须实现所有必要的 API 来帮助平台以最好的方式来观测、管理应用。 +* **生命周期一致性:** 一个容器必须要能从平台中获取事件信息,并作出相应的反应。 +* **进程易处理性:** 容器化应用的寿命一定要尽可能的短暂,这样,可以随时被另一个容器所替换。 +* **运行时限制:** 每个容器都必须要声明自己的资源需求,并将资源使用限制在所需要的范围之内。 + + + +编译时原则保证了容器拥有合适的粒度,一致性以及结构。运行时原则明确了容器化必须要实现那些功能才能成为云原生函数。遵循这些原则可以帮助你的应用适应 Kubernetes 上的自动化。 + + + +白皮书可以免费下载: + + + +想要了解更多关于如何面向 Kubernetes 设计云原生应用,可以看看我的 [Kubernetes 模式][3] 一书。 + + + +— [Bilgin Ibryam][4], 首席架构师, Red Hat + +Twitter: 
 +Blog: [http://www.ofbizian.com][5] +Linkedin: + + + +Bilgin Ibryam (@bibryam) 是 Red Hat 的一名首席架构师, ASF 的开源贡献者,博主,作者以及演讲者。 +他是 Camel 设计模式、 Kubernetes 模式的作者。在他的日常生活中,他非常享受指导、培训以及帮助各个团队更加成功地使用分布式系统、微服务、容器,以及云原生应用。 + +[1]: https://www.redhat.com/en/resources/cloud-native-container-design-whitepaper +[2]: https://lh5.googleusercontent.com/1XqojkVC0CET1yKCJqZ3-0VWxJ3W8Q74zPLlqnn6eHSJsjHOiBTB7EGUX5o_BOKumgfkxVdgBeLyoyMfMIXwVm9p2QXkq_RRy2mDJG1qEExJDculYL5PciYcWfPAKxF2-DGIdiLw +[3]: http://leanpub.com/k8spatterns/ +[4]: http://twitter.com/bibryam +[5]: http://www.ofbizian.com/ diff --git a/content/zh/blog/_posts/2018-06-28-Airflow-Kubernetes-Operator.md b/content/zh/blog/_posts/2018-06-28-Airflow-Kubernetes-Operator.md new file mode 100644 index 0000000000..6ff8dc79c8 --- /dev/null +++ b/content/zh/blog/_posts/2018-06-28-Airflow-Kubernetes-Operator.md @@ -0,0 +1,676 @@ +--- + +layout: blog + +title: 'Airflow on Kubernetes (Part 1): A Different Kind of Operator' + +date: 2018-06-28 + +title: 'Airflow在Kubernetes中的使用(第一部分):一种不同的操作器' + +cn-approvers: + +- congfairy + +--- + + + + + + +作者: Daniel Imberman (Bloomberg LP) + + + + + + + +## 介绍 + + + +作为Bloomberg [继续致力于开发Kubernetes生态系统]的一部分(https://www.techatbloomberg.com/blog/bloomberg-awarded-first-cncf-end-user-award-contributions-kubernetes/),我们很高兴能够宣布Kubernetes Airflow Operator的发布; [Apache Airflow](https://airflow.apache.org/)的机制,一种流行的工作流程编排框架,使用Kubernetes API可以在本机启动任意的Kubernetes Pod。 + + + + + + + +## 什么是Airflow? + + + +Apache Airflow是DevOps“Configuration As Code”理念的一种实现。 Airflow允许用户使用简单的Python对象DAG(有向无环图)启动多步骤流水线。 您可以在易于阅读的UI中定义依赖关系,以编程方式构建复杂的工作流,并监视调度的作业。 + + + + + + + + + + + + + +## 为什么在Kubernetes上使用Airflow? + + + +自成立以来,Airflow的最大优势在于其灵活性。 Airflow提供广泛的服务集成,包括Spark和HBase,以及各种云提供商的服务。 Airflow还通过其插件框架提供轻松的可扩展性。但是,该项目的一个限制是Airflow用户仅限于执行时Airflow站点上存在的框架和客户端。单个组织可以拥有各种Airflow工作流程,范围从数据科学流到应用程序部署。用例中的这种差异会在依赖关系管理中产生问题,因为两个团队可能会在其工作流程使用截然不同的库。 + + + +为了解决这个问题,我们使Kubernetes允许用户启动任意Kubernetes pod和配置。 Airflow用户现在可以在其运行时环境,资源和机密上拥有全部权限,基本上将Airflow转变为“您想要的任何工作”工作流程协调器。 + + + + + + + +## Kubernetes运营商 + + + +在进一步讨论之前,我们应该澄清Airflow中的[Operator](https://airflow.apache.org/concepts.html#operators)是一个任务定义。 当用户创建DAG时,他们将使用像“SparkSubmitOperator”或“PythonOperator”这样的operator分别提交/监视Spark作业或Python函数。 Airflow附带了Apache Spark,BigQuery,Hive和EMR等框架的内置运算符。 它还提供了一个插件入口点,允许DevOps工程师开发自己的连接器。 + + + +Airflow用户一直在寻找更易于管理部署和ETL流的方法。 在增加监控的同时,任何解耦流程的机会都可以减少未来的停机等问题。 以下是Airflow Kubernetes Operator提供的好处: + + + + + + + +* 提高部署灵活性: + +Airflow的插件API一直为希望在其DAG中测试新功能的工程师提供了重要的福利。 不利的一面是,每当开发人员想要创建一个新的operator时,他们就必须开发一个全新的插件。 现在,任何可以在Docker容器中运行的任务都可以通过完全相同的运算符访问,而无需维护额外的Airflow代码。 + + + + + + + +* 配置和依赖的灵活性: + +对于在静态Airflow工作程序中运行的operator,依赖关系管理可能变得非常困难。 如果开发人员想要运行一个需要[SciPy](https://www.scipy.org) 的任务和另一个需要[NumPy](http://www.numpy.org) 的任务,开发人员必须维护所有Airflow节点中的依赖关系或将任务卸载到其他计算机(如果外部计算机以未跟踪的方式更改,则可能导致错误)。 自定义Docker镜像允许用户确保任务环境,配置和依赖关系完全是幂等的。 + + + + + + + +* 使用kubernetes Secret以增加安全性: + +处理敏感数据是任何开发工程师的核心职责。 Airflow用户总有机会在严格条款的基础上隔离任何API密钥,数据库密码和登录凭据。 使用Kubernetes运算符,用户可以利用Kubernetes Vault技术存储所有敏感数据。 这意味着Airflow工作人员将永远无法访问此信息,并且可以容易地请求仅使用他们需要的密码信息构建pod。 + + + + + + + +#架构 + + + + + + + +Kubernetes Operator使用[Kubernetes Python客户端](https://github.com/kubernetes-client/Python)生成由APIServer处理的请求(1)。 然后,Kubernetes将使用您定义的需求启动您的pod(2)。映像文件中将加载环境变量,Secret和依赖项,执行单个命令。 一旦启动作业,operator只需要监视跟踪日志的状况(3)。 用户可以选择将日志本地收集到调度程序或当前位于其Kubernetes集群中的任何分布式日志记录服务。 + + + + + + + +#使用Kubernetes Operator + + + +##一个基本的例子 + + + +以下DAG可能是我们可以编写的最简单的示例,以显示Kubernetes Operator的工作原理。 这个DAG在Kubernetes上创建了两个pod:一个带有Python的Linux发行版和一个没有它的基本Ubuntu发行版。 Python pod将正确运行Python请求,而没有Python的那个将向用户报告失败。 如果Operator正常工作,则应该完成“passing-task”pod,而“falling-task”pod则向Airflow网络服务器返回失败。 + + + + + +```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) + +``` + + + +##但这与我的工作流程有什么关系? + + + +虽然这个例子只使用基本映像,但Docker的神奇之处在于,这个相同的DAG可以用于您想要的任何图像/命令配对。 以下是推荐的CI / CD管道,用于在Airflow DAG上运行生产就绪代码。 + + + +### 1:github中的PR + +使用Travis或Jenkins运行单元和集成测试,请您的朋友PR您的代码,并合并到主分支以触发自动CI构建。 + + + +### 2:CI / CD构建Jenkins - > Docker Image + + + +[在Jenkins构建中生成Docker镜像和缓冲版本](https://getintodevops.com/blog/building-your-first-Docker-image-with-jenkins-2-guide-for-developers)。 + + + +### 3:Airflow启动任务 + + + +最后,更新您的DAG以反映新版本,您应该准备好了! + + + +```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 + + ) + +``` + + + + + +#启动测试部署 + + + +由于Kubernetes运营商尚未发布,我们尚未发布官方[helm](https://helm.sh/) 图表或operator(但两者目前都在进行中)。 但是,我们在下面列出了基本部署的说明,并且正在积极寻找测试人员来尝试这一新功能。 要试用此系统,请按以下步骤操作: + + + +##步骤1:将kubeconfig设置为指向kubernetes集群 + + + +##步骤2:clone Airflow 仓库: + + + +运行git clone https:// github.com / apache / incubator-airflow.git来clone官方Airflow仓库。 + + + +##步骤3:运行 + + + +为了运行这个基本Deployment,我们正在选择我们目前用于Kubernetes Executor的集成测试脚本(将在本系列的下一篇文章中对此进行解释)。 要启动此部署,请运行以下三个命令: + + + +``` + +sed -ie "s/KubernetesExecutor/LocalExecutor/g" scripts/ci/kubernetes/kube/configmaps.yaml + +./scripts/ci/kubernetes/Docker/build.sh + +./scripts/ci/kubernetes/kube/deploy.sh + +``` + + + + + +在我们继续之前,让我们讨论这些命令正在做什么: + + + +### sed -ie“s / KubernetesExecutor / LocalExecutor / g”scripts / ci / kubernetes / kube / configmaps.yaml + + + +Kubernetes Executor是另一种Airflow功能,允许动态分配任务已解决幂等pod的问题。我们将其切换到LocalExecutor的原因只是一次引入一个功能。如果您想尝试Kubernetes Executor,欢迎您跳过此步骤,但我们将在以后的文章中详细介绍。 + + + +### ./scripts/ci/kubernetes/Docker/build.sh + + + +此脚本将对Airflow主分支代码进行打包,以根据Airflow的发行文件构建Docker容器 + + + +### ./scripts/ci/kubernetes/kube/deploy.sh + + + +最后,我们在您的群集上创建完整的Airflow部署。这包括Airflow配置,postgres后端,webserver +调度程序以及之间的所有必要服务。需要注意的一点是,提供的角色绑定是集群管理员,因此如果您没有该集群的权限级别,可以在scripts / ci / kubernetes / kube / airflow.yaml中进行修改。 + + + +##步骤4:登录您的网络服务器 + + + +现在您的Airflow实例正在运行,让我们来看看UI!用户界面位于Airflow pod的8080端口,因此只需运行即可 + + + +``` + +WEB=$(kubectl get pods -o go-template --template '{{range .items}}{{.metadata.name}}{{"\n"}}{{end}}' | grep "airflow" | head -1) + +kubectl port-forward $WEB 8080:8080 + + ``` + + + + + +现在,Airflow UI将存在于http://localhost:8080上。 要登录,只需输入airflow /airflow,您就可以完全访问Airflow Web UI。 + + + +##步骤5:上传测试文档 + + + +要修改/添加自己的DAG,可以使用kubectl cp将本地文件上传到Airflow调度程序的DAG文件夹中。 然后,Airflow将读取新的DAG并自动将其上传到其系统。 以下命令将任何本地文件上载到正确的目录中: + + + +kubectl cp /:/root/airflow/dags -c scheduler + + + + + + + +##步骤6:使用它! + + + +#那么我什么时候可以使用它? + + + + 虽然此功能仍处于早期阶段,但我们希望在未来几个月内发布该功能以进行广泛发布。 + + + +#参与其中 + + + +此功能只是将Apache Airflow集成到Kubernetes中的多项主要工作的开始。 Kubernetes Operator已合并到[Airflow的1.10发布分支](https://github.com/apache/incubator-airflow/tree/v1-10-test)(实验模式中的执行模块),以及完整的k8s本地调度程序称为Kubernetes Executor(即将发布文章)。这些功能仍处于早期采用者/贡献者可能对这些功能的未来产生巨大影响的阶段。 + + + +对于有兴趣加入这些工作的人,我建议按照以下步骤: + + + + *加入airflow-dev邮件列表dev@airflow.apache.org。 + + *在[Apache Airflow JIRA]中提出问题(https://issues.apache.org/jira/projects/AIRFLOW/issues/) + + *周三上午10点太平洋标准时间加入我们的SIG-BigData会议。 + + *在kubernetes.slack.com上的#sig-big-data找到我们。 + + + +特别感谢Apache Airflow和Kubernetes社区,特别是Grant Nicholas,Ben Goldberg,Anirudh Ramanathan,Fokko Dreisprong和Bolke de Bruin,感谢您对这些功能的巨大帮助以及我们未来的努力。 diff --git a/content/zh/blog/_posts/2018-07-09-IPVS-In-Cluster-Load-Balancing.md b/content/zh/blog/_posts/2018-07-09-IPVS-In-Cluster-Load-Balancing.md new file mode 100644 index 0000000000..560fe618bc --- /dev/null +++ b/content/zh/blog/_posts/2018-07-09-IPVS-In-Cluster-Load-Balancing.md @@ -0,0 +1,401 @@ +--- +title: 基于IPVS的集群内部负载均衡 +cn-approvers: +- congfairy +layout: blog +title: 'IPVS-Based In-Cluster Load Balancing Deep Dive' +date: 2018-07-09 +--- + + + +作者: Jun Du(华为), Haibin Xie(华为), Wei Liang(华为) + +注意: 这篇文章出自 系列深度文章 介绍 Kubernetes 1.11 的新特性 + + + +介绍 + +根据 Kubernetes 1.11 发布的博客文章, 我们宣布基于 IPVS 的集群内部服务负载均衡已达到一般可用性。 在这篇博客中,我们将带您深入了解该功能。 + + + +什么是 IPVS ? + +IPVS (IP Virtual Server)是在 Netfilter 上层构建的,并作为 Linux 内核的一部分,实现传输层负载均衡。 + +IPVS 集成在 LVS(Linux Virtual Server,Linux 虚拟服务器)中,它在主机上运行,并在物理服务器集群前作为负载均衡器。IPVS 可以将基于 TCP 和 UDP 服务的请求定向到真实服务器,并使真实服务器的服务在单个IP地址上显示为虚拟服务。 因此,IPVS 自然支持 Kubernetes 服务。 + + + +为什么为 Kubernetes 选择 IPVS ? + +随着 Kubernetes 的使用增长,其资源的可扩展性变得越来越重要。特别是,服务的可扩展性对于运行大型工作负载的开发人员/公司采用 Kubernetes 至关重要。 + +Kube-proxy 是服务路由的构建块,它依赖于经过强化攻击的 iptables 来实现支持核心的服务类型,如 ClusterIP 和 NodePort。 但是,iptables 难以扩展到成千上万的服务,因为它纯粹是为防火墙而设计的,并且基于内核规则列表。 + +尽管 Kubernetes 在版本v1.6中已经支持5000个节点,但使用 iptables 的 kube-proxy 实际上是将集群扩展到5000个节点的瓶颈。 一个例子是,在5000节点集群中使用 NodePort 服务,如果我们有2000个服务并且每个服务有10个 pod,这将在每个工作节点上至少产生20000个 iptable 记录,这可能使内核非常繁忙。 + +另一方面,使用基于 IPVS 的集群内服务负载均衡可以为这种情况提供很多帮助。 IPVS 专门用于负载均衡,并使用更高效的数据结构(哈希表),允许几乎无限的规模扩张。 + + + +基于 IPVS 的 Kube-proxy + +参数更改 + +参数: --proxy-mode 除了现有的用户空间和 iptables 模式,IPVS 模式通过--proxy-mode = ipvs 进行配置。 它隐式使用 IPVS NAT 模式进行服务端口映射。 + + + +参数: --ipvs-scheduler + +添加了一个新的 kube-proxy 参数来指定 IPVS 负载均衡算法,参数为 --ipvs-scheduler。 如果未配置,则默认为 round-robin 算法(rr)。 + +- rr: round-robin +- lc: least connection +- dh: destination hashing +- sh: source hashing +- sed: shortest expected delay +- nq: never queue + +将来,我们可以实现特定于服务的调度程序(可能通过注释),该调度程序具有更高的优先级并覆盖该值。 + + + +参数: --cleanup-ipvs 类似于 --cleanup-iptables 参数,如果为 true,则清除在 IPVS 模式下创建的 IPVS 配置和 IPTables 规则。 + +参数: --ipvs-sync-period 刷新 IPVS 规则的最大间隔时间(例如'5s','1m')。 必须大于0。 + +参数: --ipvs-min-sync-period 刷新 IPVS 规则的最小间隔时间间隔(例如'5s','1m')。 必须大于0。 + + + +参数: --ipvs-exclude-cidrs 清除 IPVS 规则时 IPVS 代理不应触及的 CIDR 的逗号分隔列表,因为 IPVS 代理无法区分 kube-proxy 创建的 IPVS 规则和用户原始规则 IPVS 规则。 如果您在环境中使用 IPVS proxier 和您自己的 IPVS 规则,则应指定此参数,否则将清除原始规则。 + + + +设计注意事项 + +IPVS 服务网络拓扑 + +创建 ClusterIP 类型服务时,IPVS proxier 将执行以下三项操作: + +- 确保节点中存在虚拟接口,默认为 kube-ipvs0 +- 将服务 IP 地址绑定到虚拟接口 +- 分别为每个服务 IP 地址创建 IPVS 虚拟服务器 + + + +这是一个例子: + + # 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 + + + +请注意,Kubernetes 服务和 IPVS 虚拟服务器之间的关系是“1:N”。 例如,考虑具有多个 IP 地址的 Kubernetes 服务。 外部 IP 类型服务有两个 IP 地址 - 集群IP和外部 IP。 然后,IPVS 代理将创建2个 IPVS 虚拟服务器 - 一个用于集群 IP,另一个用于外部 IP。 Kubernetes 的 endpoint(每个IP +端口对)与 IPVS 虚拟服务器之间的关系是“1:1”。 + +删除 Kubernetes 服务将触发删除相应的 IPVS 虚拟服务器,IPVS 物理服务器及其绑定到虚拟接口的 IP 地址。 + +端口映射 + +IPVS 中有三种代理模式:NAT(masq),IPIP 和 DR。 只有 NAT 模式支持端口映射。 Kube-proxy 利用 NAT 模式进行端口映射。 以下示例显示 IPVS 服务端口3080到Pod端口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 + + + +会话关系 + +IPVS 支持客户端 IP 会话关联(持久连接)。 当服务指定会话关系时,IPVS 代理将在 IPVS 虚拟服务器中设置超时值(默认为180分钟= 10800秒)。 例如: + + # 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 + + + +IPVS 代理中的 Iptables 和 Ipset + +IPVS 用于负载均衡,它无法处理 kube-proxy 中的其他问题,例如 包过滤,数据包欺骗,SNAT 等 + +IPVS proxier 在上述场景中利用 iptables。 具体来说,ipvs proxier 将在以下4种情况下依赖于 iptables: + +- kube-proxy 以 --masquerade-all = true 开头 +- 在 kube-proxy 启动中指定集群 CIDR +- 支持 Loadbalancer 类型服务 +- 支持 NodePort 类型的服务 + +但是,我们不想创建太多的 iptables 规则。 所以我们采用 ipset 来减少 iptables 规则。 以下是 IPVS proxier 维护的 ipset 集表: + + + + 设置名称 成员 用法 + KUBE-CLUSTER-IP 所有服务 IP + 端口 masquerade-all=true 或 clusterCIDR 指定的情况下进行伪装 + KUBE-LOOP-BACK 所有服务 IP +端口+ IP 解决数据包欺骗问题 + KUBE-EXTERNAL-IP 服务外部 IP +端口 将数据包伪装成外部 IP + KUBE-LOAD-BALANCER 负载均衡器入口 IP +端口 将数据包伪装成 Load Balancer 类型的服务 + KUBE-LOAD-BALANCER-LOCAL 负载均衡器入口 IP +端口 以及 externalTrafficPolicy=local 接受数据包到 Load Balancer externalTrafficPolicy=local + KUBE-LOAD-BALANCER-FW 负载均衡器入口 IP +端口 以及 loadBalancerSourceRanges 使用指定的 loadBalancerSourceRanges 丢弃 Load Balancer类型Service的数据包 + KUBE-LOAD-BALANCER-SOURCE-CIDR 负载均衡器入口 IP +端口 + 源 CIDR 接受 Load Balancer 类型 Service 的数据包,并指定loadBalancerSourceRanges + KUBE-NODE-PORT-TCP NodePort 类型服务 TCP 将数据包伪装成 NodePort(TCP) + KUBE-NODE-PORT-LOCAL-TCP NodePort 类型服务 TCP 端口,带有 externalTrafficPolicy=local 接受数据包到 NodePort 服务 使用 externalTrafficPolicy=local + KUBE-NODE-PORT-UDP NodePort 类型服务 UDP 端口 将数据包伪装成 NodePort(UDP) + KUBE-NODE-PORT-LOCAL-UDP NodePort 类型服务 UDP 端口 使用 externalTrafficPolicy=local 接受数据包到NodePort服务 使用 externalTrafficPolicy=local + + + +通常,对于 IPVS proxier,无论我们有多少 Service/ Pod,iptables 规则的数量都是静态的。 + + + +在 IPVS 模式下运行 kube-proxy + +目前,本地脚本,GCE 脚本和 kubeadm 支持通过导出环境变量(KUBE_PROXY_MODE=ipvs)或指定标志(--proxy-mode=ipvs)来切换 IPVS 代理模式。 在运行IPVS 代理之前,请确保已安装 IPVS 所需的内核模块。 + + ip_vs + ip_vs_rr + ip_vs_wrr + ip_vs_sh + nf_conntrack_ipv4 + +最后,对于 Kubernetes v1.10,“SupportIPVSProxyMode” 默认设置为 “true”。 对于 Kubernetes v1.11 ,该选项已完全删除。 但是,您需要在v1.10之前为Kubernetes 明确启用 --feature-gates = SupportIPVSProxyMode = true。 + + + +参与其中 + +参与 Kubernetes 的最简单方法是加入众多[特别兴趣小组](https://github.com/kubernetes/community/blob/master/sig-list.md) (SIG)中与您的兴趣一致的小组。 你有什么想要向 Kubernetes 社区广播的吗? 在我们的每周[社区会议](https://github.com/kubernetes/community/blob/master/communication.md#weekly-meeting)或通过以下渠道分享您的声音。 + +感谢您的持续反馈和支持。 +在[Stack Overflow](http://stackoverflow.com/questions/tagged/kubernetes)上发布问题(或回答问题) + +加入[K8sPort](http://k8sport.org/)的倡导者社区门户网站 + +在 Twitter 上关注我们 [@Kubernetesio](https://twitter.com/kubernetesio )获取最新更新 + +在[Slack](http://slack.k8s.io/)上与社区聊天 + +分享您的 Kubernetes [故事](https://docs.google.com/a/linuxfoundation.org/forms/d/e/1FAIpQLScuI7Ye3VQHQTwBASrgkjQDSS5TP0g3AXfFhwSM9YpHgxRKFA/viewform) diff --git a/content/cn/docs/.gitkeep b/content/zh/docs/.gitkeep similarity index 100% rename from content/cn/docs/.gitkeep rename to content/zh/docs/.gitkeep diff --git a/content/cn/docs/_index.md b/content/zh/docs/_index.md similarity index 100% rename from content/cn/docs/_index.md rename to content/zh/docs/_index.md diff --git a/content/cn/docs/admin/accessing-the-api.md b/content/zh/docs/admin/accessing-the-api.md similarity index 100% rename from content/cn/docs/admin/accessing-the-api.md rename to content/zh/docs/admin/accessing-the-api.md diff --git a/content/cn/docs/admin/authorization/_index.md b/content/zh/docs/admin/authorization/_index.md similarity index 100% rename from content/cn/docs/admin/authorization/_index.md rename to content/zh/docs/admin/authorization/_index.md diff --git a/content/cn/docs/admin/authorization/abac.md b/content/zh/docs/admin/authorization/abac.md similarity index 100% rename from content/cn/docs/admin/authorization/abac.md rename to content/zh/docs/admin/authorization/abac.md diff --git a/content/cn/docs/admin/authorization/webhook.md b/content/zh/docs/admin/authorization/webhook.md similarity index 100% rename from content/cn/docs/admin/authorization/webhook.md rename to content/zh/docs/admin/authorization/webhook.md diff --git a/content/cn/docs/admin/bootstrap-tokens.md b/content/zh/docs/admin/bootstrap-tokens.md similarity index 100% rename from content/cn/docs/admin/bootstrap-tokens.md rename to content/zh/docs/admin/bootstrap-tokens.md diff --git a/content/cn/docs/admin/cluster-large.md b/content/zh/docs/admin/cluster-large.md similarity index 100% rename from content/cn/docs/admin/cluster-large.md rename to content/zh/docs/admin/cluster-large.md diff --git a/content/cn/docs/admin/daemon.yaml b/content/zh/docs/admin/daemon.yaml similarity index 100% rename from content/cn/docs/admin/daemon.yaml rename to content/zh/docs/admin/daemon.yaml diff --git a/content/cn/docs/admin/high-availability/_index.md b/content/zh/docs/admin/high-availability/_index.md similarity index 100% rename from content/cn/docs/admin/high-availability/_index.md rename to content/zh/docs/admin/high-availability/_index.md diff --git a/content/cn/docs/admin/kube-apiserver.md b/content/zh/docs/admin/kube-apiserver.md similarity index 100% rename from content/cn/docs/admin/kube-apiserver.md rename to content/zh/docs/admin/kube-apiserver.md diff --git a/content/cn/docs/admin/kubelet-authentication-authorization.md b/content/zh/docs/admin/kubelet-authentication-authorization.md similarity index 100% rename from content/cn/docs/admin/kubelet-authentication-authorization.md rename to content/zh/docs/admin/kubelet-authentication-authorization.md diff --git a/content/cn/docs/admin/kubelet-tls-bootstrapping.md b/content/zh/docs/admin/kubelet-tls-bootstrapping.md similarity index 100% rename from content/cn/docs/admin/kubelet-tls-bootstrapping.md rename to content/zh/docs/admin/kubelet-tls-bootstrapping.md diff --git a/content/cn/docs/admin/multiple-zones.md b/content/zh/docs/admin/multiple-zones.md similarity index 100% rename from content/cn/docs/admin/multiple-zones.md rename to content/zh/docs/admin/multiple-zones.md diff --git a/content/cn/docs/admin/node-conformance.md b/content/zh/docs/admin/node-conformance.md similarity index 100% rename from content/cn/docs/admin/node-conformance.md rename to content/zh/docs/admin/node-conformance.md diff --git a/content/cn/docs/admin/ovs-networking.md b/content/zh/docs/admin/ovs-networking.md similarity index 100% rename from content/cn/docs/admin/ovs-networking.md rename to content/zh/docs/admin/ovs-networking.md diff --git a/content/cn/docs/admin/service-accounts-admin.md b/content/zh/docs/admin/service-accounts-admin.md similarity index 100% rename from content/cn/docs/admin/service-accounts-admin.md rename to content/zh/docs/admin/service-accounts-admin.md diff --git a/content/cn/docs/concepts/architecture/cloud-controller.md b/content/zh/docs/concepts/architecture/cloud-controller.md similarity index 100% rename from content/cn/docs/concepts/architecture/cloud-controller.md rename to content/zh/docs/concepts/architecture/cloud-controller.md diff --git a/content/cn/docs/concepts/architecture/master-node-communication.md b/content/zh/docs/concepts/architecture/master-node-communication.md similarity index 100% rename from content/cn/docs/concepts/architecture/master-node-communication.md rename to content/zh/docs/concepts/architecture/master-node-communication.md diff --git a/content/cn/docs/concepts/architecture/nodes.md b/content/zh/docs/concepts/architecture/nodes.md similarity index 100% rename from content/cn/docs/concepts/architecture/nodes.md rename to content/zh/docs/concepts/architecture/nodes.md diff --git a/content/cn/docs/concepts/cluster-administration/addons.md b/content/zh/docs/concepts/cluster-administration/addons.md similarity index 100% rename from content/cn/docs/concepts/cluster-administration/addons.md rename to content/zh/docs/concepts/cluster-administration/addons.md diff --git a/content/cn/docs/concepts/cluster-administration/certificates.md b/content/zh/docs/concepts/cluster-administration/certificates.md similarity index 100% rename from content/cn/docs/concepts/cluster-administration/certificates.md rename to content/zh/docs/concepts/cluster-administration/certificates.md diff --git a/content/cn/docs/concepts/cluster-administration/cloud-providers.md b/content/zh/docs/concepts/cluster-administration/cloud-providers.md similarity index 100% rename from content/cn/docs/concepts/cluster-administration/cloud-providers.md rename to content/zh/docs/concepts/cluster-administration/cloud-providers.md diff --git a/content/cn/docs/concepts/cluster-administration/cluster-administration-overview.md b/content/zh/docs/concepts/cluster-administration/cluster-administration-overview.md similarity index 100% rename from content/cn/docs/concepts/cluster-administration/cluster-administration-overview.md rename to content/zh/docs/concepts/cluster-administration/cluster-administration-overview.md diff --git a/content/cn/docs/concepts/cluster-administration/device-plugins.md b/content/zh/docs/concepts/cluster-administration/device-plugins.md similarity index 100% rename from content/cn/docs/concepts/cluster-administration/device-plugins.md rename to content/zh/docs/concepts/cluster-administration/device-plugins.md diff --git a/content/cn/docs/concepts/cluster-administration/federation.md b/content/zh/docs/concepts/cluster-administration/federation.md similarity index 100% rename from content/cn/docs/concepts/cluster-administration/federation.md rename to content/zh/docs/concepts/cluster-administration/federation.md diff --git a/content/cn/docs/concepts/cluster-administration/proxies.md b/content/zh/docs/concepts/cluster-administration/proxies.md similarity index 100% rename from content/cn/docs/concepts/cluster-administration/proxies.md rename to content/zh/docs/concepts/cluster-administration/proxies.md diff --git a/content/cn/docs/concepts/cluster-administration/sysctl-cluster.md b/content/zh/docs/concepts/cluster-administration/sysctl-cluster.md similarity index 100% rename from content/cn/docs/concepts/cluster-administration/sysctl-cluster.md rename to content/zh/docs/concepts/cluster-administration/sysctl-cluster.md diff --git a/content/cn/docs/concepts/configuration/commands.yaml b/content/zh/docs/concepts/configuration/commands.yaml similarity index 100% rename from content/cn/docs/concepts/configuration/commands.yaml rename to content/zh/docs/concepts/configuration/commands.yaml diff --git a/content/cn/docs/concepts/configuration/manage-compute-resources-container.md b/content/zh/docs/concepts/configuration/manage-compute-resources-container.md similarity index 100% rename from content/cn/docs/concepts/configuration/manage-compute-resources-container.md rename to content/zh/docs/concepts/configuration/manage-compute-resources-container.md diff --git a/content/cn/docs/concepts/configuration/pod-with-node-affinity.yaml b/content/zh/docs/concepts/configuration/pod-with-node-affinity.yaml similarity index 100% rename from content/cn/docs/concepts/configuration/pod-with-node-affinity.yaml rename to content/zh/docs/concepts/configuration/pod-with-node-affinity.yaml diff --git a/content/cn/docs/concepts/configuration/pod-with-pod-affinity.yaml b/content/zh/docs/concepts/configuration/pod-with-pod-affinity.yaml similarity index 100% rename from content/cn/docs/concepts/configuration/pod-with-pod-affinity.yaml rename to content/zh/docs/concepts/configuration/pod-with-pod-affinity.yaml diff --git a/content/cn/docs/concepts/configuration/pod.yaml b/content/zh/docs/concepts/configuration/pod.yaml similarity index 100% rename from content/cn/docs/concepts/configuration/pod.yaml rename to content/zh/docs/concepts/configuration/pod.yaml diff --git a/content/cn/docs/concepts/configuration/secret.md b/content/zh/docs/concepts/configuration/secret.md similarity index 98% rename from content/cn/docs/concepts/configuration/secret.md rename to content/zh/docs/concepts/configuration/secret.md index 5d59573aa7..fd1a9d0377 100644 --- a/content/cn/docs/concepts/configuration/secret.md +++ b/content/zh/docs/concepts/configuration/secret.md @@ -104,7 +104,7 @@ $ kubectl create -f ./secret.yaml secret "mysecret" created ``` -**编码注意:** secret 数据的序列化 JSON 和 YAML 值使用 base64 编码成字符串。换行符在这些字符串中无效,必须省略。当在 Darwin/macOS 上使用 `base64` 实用程序时,用户应避免使用 `-b` 选项来拆分长行。另外,对于 Linux 用户如果 `-w` 选项不可用的话,应该添加选项 `-w 0` 到 `base64` 命令或管道 `base64 | tr -d '\n' ` 。 +**编码注意:** secret 数据的序列化 JSON 和 YAML 值使用 base64 编码成字符串。换行符在这些字符串中无效,必须省略。当在 Darwin/OS X 上使用 `base64` 实用程序时,用户应避免使用 `-b` 选项来拆分长行。另外,对于 Linux 用户如果 `-w` 选项不可用的话,应该添加选项 `-w 0` 到 `base64` 命令或管道 `base64 | tr -d '\n' ` 。 #### 解码 Secret diff --git a/content/zh/docs/concepts/configuration/taint-and-toleration.md b/content/zh/docs/concepts/configuration/taint-and-toleration.md new file mode 100755 index 0000000000..a3c0eda8dd --- /dev/null +++ b/content/zh/docs/concepts/configuration/taint-and-toleration.md @@ -0,0 +1,464 @@ +--- +approvers: +- davidopp +- kevin-wangzefeng +- bsalamat +cn-approvers: +- linyouchong +title: Taint 和 Toleration +content_template: templates/concept +weight: 40 +--- + + + +{{< toc >}} + +{{% capture overview %}} + +节点亲和性(详见[这里](/docs/concepts/configuration/assign-pod-node/#node-affinity-beta-feature)),是 *pod* 的一种属性(偏好或硬性要求),它使 *pod* 被吸引到一类特定的节点。Taint 则相反,它使 *节点* 能够 *排斥* 一类特定的 pod。 + + +Taint 和 toleration 相互配合,可以用来避免 pod 被分配到不合适的节点上。每个节点上都可以应用一个或多个 taint ,这表示对于那些不能容忍这些 taint 的 pod,是不会被该节点接受的。如果将 toleration 应用于 pod 上,则表示这些 pod 可以(但不要求)被调度到具有匹配 taint 的节点上。 + +{{% /capture %}} + +{{% capture body %}} + + + +## 概念 + + +您可以使用命令 [kubectl taint](/docs/reference/generated/kubectl/kubectl-commands#taint) 给节点增加一个 taint。比如, + +```shell +kubectl taint nodes node1 key=value:NoSchedule +``` + + +给节点 `node1` 增加一个 taint,它的 key 是 `key`,value 是 `value`,effect 是 `NoSchedule`。这表示只有拥有和这个 taint 相匹配的 toleration 的 pod 才能够被分配到 `node1` 这个节点。您可以在 PodSpec 中定义 pod 的 toleration。下面两个 toleration 均与上面例子中使用 `kubectl taint` 命令创建的 taint 相匹配,因此如果一个 pod 拥有其中的任何一个 toleration 都能够被分配到 `node1` : + + +想删除上述命令添加的 taint ,您可以运行: +```shell +kubectl taint nodes kube11 key:NoSchedule- +``` + +```yaml +tolerations: +- key: "key" + operator: "Equal" + value: "value" + effect: "NoSchedule" +``` + +```yaml +tolerations: +- key: "key" + operator: "Exists" + effect: "NoSchedule" +``` + + +一个 toleration 和一个 taint 相“匹配”是指它们有一样的 key 和 effect ,并且: + +* 如果 `operator` 是 `Exists` (此时 toleration 不能指定 `value`),或者 +* 如果 `operator` 是 `Equal` ,则它们的 `value` 应该相等 + +{{< note >}} + + +**注意:** 存在两种特殊情况: + +* 如果一个 toleration 的 `key` 为空且 operator 为 `Exists` ,表示这个 toleration 与任意的 key 、 value 和 effect 都匹配,即这个 toleration 能容忍任意 taint。 + +```yaml +tolerations: +- operator: "Exists" +``` + + +* 如果一个 toleration 的 `effect` 为空,则 `key` 值与之相同的相匹配 taint 的 `effect` 可以是任意值。 + +```yaml +tolerations: +- key: "key" + operator: "Exists" +``` +{{< /note >}} + + +上述例子使用到的 `effect` 的一个值 `NoSchedule`,您也可以使用另外一个值 `PreferNoSchedule`。这是“优化”或“软”版本的 `NoSchedule` ——系统会*尽量*避免将 pod 调度到存在其不能容忍 taint 的节点上,但这不是强制的。`effect` 的值还可以设置为 `NoExecute` ,下文会详细描述这个值。 + + +您可以给一个节点添加多个 taint ,也可以给一个 pod 添加多个 toleration。Kubernetes 处理多个 taint 和 toleration 的过程就像一个过滤器:从一个节点的所有 taint 开始遍历,过滤掉那些 pod 中存在与之相匹配的 toleration 的 taint。余下未被过滤的 taint 的 effect 值决定了 pod 是否会被分配到该节点,特别是以下情况: + + +* 如果未被过滤的 taint 中存在一个以上 effect 值为 `NoSchedule` 的 taint,则 Kubernetes 不会将 pod 分配到该节点。 +* 如果未被过滤的 taint 中不存在 effect 值为 `NoSchedule` 的 taint,但是存在 effect 值为 `PreferNoSchedule` 的 taint,则 Kubernetes 会*尝试*将 pod 分配到该节点。 +* 如果未被过滤的 taint 中存在一个以上 effect 值为 `NoExecute` 的 taint,则 Kubernetes 不会将 pod 分配到该节点(如果 pod 还未在节点上运行),或者将 pod 从该节点驱逐(如果 pod 已经在节点上运行)。 + + +例如,假设您给一个节点添加了如下的 taint + +```shell +kubectl taint nodes node1 key1=value1:NoSchedule +kubectl taint nodes node1 key1=value1:NoExecute +kubectl taint nodes node1 key2=value2:NoSchedule +``` + + +然后存在一个 pod,它有两个 toleration + +```yaml +tolerations: +- key: "key1" + operator: "Equal" + value: "value1" + effect: "NoSchedule" +- key: "key1" + operator: "Equal" + value: "value1" + effect: "NoExecute" +``` + + +在这个例子中,上述 pod 不会被分配到上述节点,因为其没有 toleration 和第三个 taint 相匹配。但是如果在给节点添加 上述 taint 之前,该 pod 已经在上述节点运行,那么它还可以继续运行在该节点上,因为第三个 taint 是三个 taint 中唯一不能被这个 pod 容忍的。 + + +通常情况下,如果给一个节点添加了一个 effect 值为 `NoExecute` 的 taint,则任何不能忍受这个 taint 的 pod 都会马上被驱逐,任何可以忍受这个 taint 的 pod 都不会被驱逐。但是,如果 pod 存在一个 effect 值为 `NoExecute` 的 toleration 指定了可选属性 `tolerationSeconds` 的值,则表示在给节点添加了上述 taint 之后,pod 还能继续在节点上运行的时间。例如, + +```yaml +tolerations: +- key: "key1" + operator: "Equal" + value: "value1" + effect: "NoExecute" + tolerationSeconds: 3600 +``` + + +这表示如果这个 pod 正在运行,然后一个匹配的 taint 被添加到其所在的节点,那么 pod 还将继续在节点上运行 3600 秒,然后被驱逐。如果在此之前上述 taint 被删除了,则 pod 不会被驱逐。 + + + +## 使用例子 + + +通过 taint 和 toleration ,可以灵活地让 pod *避开*某些节点或者将 pod 从某些节点驱逐。下面是几个使用例子: + + +* **专用节点**:如果您想将某些节点专门分配给特定的一组用户使用,您可以给这些节点添加一个 taint(即, + `kubectl taint nodes nodename dedicated=groupName:NoSchedule`),然后给这组用户的 pod 添加一个相对应的 toleration(通过编写一个自定义的[admission controller](/docs/admin/admission-controllers/),很容易就能做到)。拥有上述 toleration 的 pod 就能够被分配到上述专用节点,同时也能够被分配到集群中的其它节点。如果您希望这些 pod 只能被分配到上述专用节点,那么您还需要给这些专用节点另外添加一个和上述 taint 类似的 label (例如:`dedicated=groupName`),同时 还要在上述 admission controller 中给 pod 增加节点亲和性要求上述 pod 只能被分配到添加了 `dedicated=groupName` 标签的节点上。 + + +* **配备了特殊硬件的节点**:在部分节点配备了特殊硬件(比如 GPU)的集群中,我们希望不需要这类硬件的 pod 不要被分配到这些特殊节点,以便为后继需要这类硬件的 pod 保留资源。要达到这个目的,可以先给配备了特殊硬件的节点添加 taint(例如 `kubectl taint nodes nodename special=true:NoSchedule` or `kubectl taint nodes nodename special=true:PreferNoSchedule`),然后给使用了这类特殊硬件的 pod 添加一个相匹配的 toleration。和专用节点的例子类似,添加这个 toleration 的最简单的方法是使用自定义 [admission controller](/docs/reference/access-authn-authz/admission-controllers/)。比如,我们推荐使用 [Extended Resources](/docs/concepts/configuration/manage-compute-resources-container/#extended-resources) 来表示特殊硬件,给配置了特殊硬件的节点添加 taint 时包含 extended resource 名称,然后运行一个 [ExtendedResourceToleration](/docs/reference/access-authn-authz/admission-controllers/#extendedresourcetoleration) admission controller。此时,因为节点已经被 taint 了,没有对应 toleration 的 Pod 会被调度到这些节点。但当你创建一个使用了 extended resource 的 Pod 时,`ExtendedResourceToleration` admission controller 会自动给 Pod 加上正确的 toleration ,这样 Pod 就会被自动调度到这些配置了特殊硬件件的节点上。这样就能够确保这些配置了特殊硬件的节点专门用于运行 需要使用这些硬件的 Pod,并且您无需手动给这些 Pod 添加 toleration。 + + +* **基于 taint 的驱逐 (alpha 特性)**: 这是在每个 pod 中配置的在节点出现问题时的驱逐行为,接下来的章节会描述这个特性 + + + +## 基于 taint 的驱逐 + + + 前文我们提到过 taint 的 effect 值 `NoExecute` ,它会影响已经在节点上运行的 pod + * 如果 pod 不能忍受effect 值为 `NoExecute` 的 taint,那么 pod 将马上被驱逐 + * 如果 pod 能够忍受effect 值为 `NoExecute` 的 taint,但是在 toleration 定义中没有指定 `tolerationSeconds`,则 pod 还会一直在这个节点上运行。 + * 如果 pod 能够忍受effect 值为 `NoExecute` 的 taint,而且指定了 `tolerationSeconds`,则 pod 还能在这个节点上继续运行这个指定的时间长度。 + + + 此外,Kubernetes 1.6 已经支持(alpha阶段)节点问题的表示。换句话说,当某种条件为真时,node controller会自动给节点添加一个 taint。当前内置的 taint 包括: + * `node.kubernetes.io/not-ready`:节点未准备好。这相当于节点状态 `Ready` 的值为 "`False`"。 + * `node.kubernetes.io/unreachable`:node controller 访问不到节点. 这相当于节点状态 `Ready` 的值为 "`Unknown`"。 + * `node.kubernetes.io/out-of-disk`:节点磁盘耗尽。 + * `node.kubernetes.io/memory-pressure`:节点存在内存压力。 + * `node.kubernetes.io/disk-pressure`:节点存在磁盘压力。 + * `node.kubernetes.io/network-unavailable`:节点网络不可用。 + * `node.kubernetes.io/unschedulable`: 节点不可调度。 + * `node.cloudprovider.kubernetes.io/uninitialized`:如果 kubelet 启动时指定了一个 "外部" cloud provider,它将给当前节点添加一个 taint 将其标志为不可用。在 cloud-controller-manager 的一个 controller 初始化这个节点后,kubelet 将删除这个 taint。 + + +在启用了 `TaintBasedEvictions` 这个 alpha 功能特性后(在 Kubernetes controller manager 的 `--feature-gates` 参数中包含`TaintBasedEvictions=true` 开启这个功能特性,例如:`--feature-gates=FooBar=true,TaintBasedEvictions=true`),NodeController (或 kubelet)会自动给节点添加这类 taint,上述基于节点状态 Ready 对 pod 进行驱逐的逻辑会被禁用。 + +{{< note >}} + +注意:为了保证由于节点问题引起的 pod 驱逐[rate limiting](/docs/concepts/architecture/nodes/)行为正常,系统实际上会以 rate-limited 的方式添加 taint。在像 master 和 node 通讯中断等场景下,这避免了 pod 被大量驱逐。 +{{< /note >}} + + +使用这个 alpha 功能特性,结合 `tolerationSeconds` ,pod 就可以指定当节点出现一个或全部上述问题时还将在这个节点上运行多长的时间。 + + +比如,一个使用了很多本地状态的应用程序在网络断开时,仍然希望停留在当前节点上运行一段较长的时间,愿意等待网络恢复以避免被驱逐。在这种情况下,pod 的 toleration 可能是下面这样的: + +```yaml +tolerations: +- key: "node.alpha.kubernetes.io/unreachable" + operator: "Exists" + effect: "NoExecute" + tolerationSeconds: 6000 +``` + + +注意,Kubernetes 会自动给 pod 添加一个 key 为 `node.kubernetes.io/not-ready` 的 toleration 并配置 `tolerationSeconds=300`,除非用户提供的 pod 配置中已经已存在了 key 为 `node.kubernetes.io/not-ready` 的 toleration。同样,Kubernetes 会给 pod 添加一个 key 为 `node.kubernetes.io/unreachable` 的 toleration 并配置 `tolerationSeconds=300`,除非用户提供的 pod 配置中已经已存在了 key 为 `node.kubernetes.io/unreachable` 的 toleration。 + + +这种自动添加 toleration 机制保证了在其中一种问题被检测到时 pod 默认能够继续停留在当前节点运行 5 分钟。这两个默认 toleration 是由 [DefaultTolerationSeconds +admission controller](https://git.k8s.io/kubernetes/plugin/pkg/admission/defaulttolerationseconds)添加的。 + + +[DaemonSet](/docs/concepts/workloads/controllers/daemonset/) 中的 pod 被创建时,针对以下 taint 自动添加的 `NoExecute` 的 toleration 将不会指定 `tolerationSeconds`: + + * `node.alpha.kubernetes.io/unreachable` + * `node.kubernetes.io/not-ready` + +这保证了出现上述问题时 DaemonSet 中的 pod 永远不会被驱逐,这和 `TaintBasedEvictions` 这个特性被禁用后的行为是一样的。 + + + +## 基于节点状态添加 taint + + +1.8 版本引入了一个 alpha 特性,让 node controller 根据节点的状态创建 taint。当开启了这个特性时(通过给 scheduler 的 `--feature-gates` 添加 `TaintNodesByCondition=true` 参数,例如:`--feature-gates=FooBar=true,TaintNodesByCondition=true`),scheduler不会去检查节点的状态,而是检查节点的 taint。这确保了节点的状态不影响应该调度哪些 Pod 到节点上。用户可以通过给 Pod 添加 toleration 来选择忽略节点的一些问题(节点状态的形式表示)。 +从 Kubernetes 1.8 开始,DaemonSet controller 会自动添加如下 `NoSchedule` toleration,以防止 DaemonSet 中断。 + * `node.kubernetes.io/memory-pressure` + * `node.kubernetes.io/disk-pressure` + * `node.kubernetes.io/out-of-disk` (*只适合 critical pod*) + * `node.kubernetes.io/unschedulable` (1.10 或更高版本) + * `node.kubernetes.io/network-unavailable` (*只适合 host network*) + + +添加上述 toleration 确保了向后兼容,您也可以选择自由的向 DaemonSet 添加 toleration。 diff --git a/content/cn/docs/concepts/containers/container-environment-variables.md b/content/zh/docs/concepts/containers/container-environment-variables.md similarity index 100% rename from content/cn/docs/concepts/containers/container-environment-variables.md rename to content/zh/docs/concepts/containers/container-environment-variables.md diff --git a/content/cn/docs/concepts/containers/images.md b/content/zh/docs/concepts/containers/images.md similarity index 99% rename from content/cn/docs/concepts/containers/images.md rename to content/zh/docs/concepts/containers/images.md index 11f9024448..cc123251be 100644 --- a/content/cn/docs/concepts/containers/images.md +++ b/content/zh/docs/concepts/containers/images.md @@ -87,7 +87,7 @@ Kubelet会获取并且定期刷新ECR的凭证。它需要以下权限 - 验证是否满足以上要求 - 获取工作站的$REGION (例如 `us-west-2`)凭证,使用凭证SSH到主机手动运行docker,检查是否运行 -- 验证kublet是否使用参数`--cloud-provider=aws`运行 +- 验证kubelet是否使用参数`--cloud-provider=aws`运行 - 检查kubelet日志(例如 `journalctl -u kubelet`),是否有类似的行 - `plugins.go:56] Registering credential provider: aws-ecr-key` - `provider.go:91] Refreshing cache for provider: *aws_credentials.ecrProvider` diff --git a/content/cn/docs/concepts/example-concept-template.md b/content/zh/docs/concepts/example-concept-template.md similarity index 100% rename from content/cn/docs/concepts/example-concept-template.md rename to content/zh/docs/concepts/example-concept-template.md diff --git a/content/cn/docs/concepts/overview/components.md b/content/zh/docs/concepts/overview/components.md similarity index 100% rename from content/cn/docs/concepts/overview/components.md rename to content/zh/docs/concepts/overview/components.md diff --git a/content/cn/docs/concepts/overview/kubernetes-api.md b/content/zh/docs/concepts/overview/kubernetes-api.md similarity index 100% rename from content/cn/docs/concepts/overview/kubernetes-api.md rename to content/zh/docs/concepts/overview/kubernetes-api.md diff --git a/content/cn/docs/concepts/overview/what-is-kubernetes.md b/content/zh/docs/concepts/overview/what-is-kubernetes.md similarity index 100% rename from content/cn/docs/concepts/overview/what-is-kubernetes.md rename to content/zh/docs/concepts/overview/what-is-kubernetes.md diff --git a/content/cn/docs/concepts/overview/working-with-objects/kubernetes-objects.md b/content/zh/docs/concepts/overview/working-with-objects/kubernetes-objects.md similarity index 100% rename from content/cn/docs/concepts/overview/working-with-objects/kubernetes-objects.md rename to content/zh/docs/concepts/overview/working-with-objects/kubernetes-objects.md diff --git a/content/cn/docs/concepts/overview/working-with-objects/nginx-deployment.yaml b/content/zh/docs/concepts/overview/working-with-objects/nginx-deployment.yaml similarity index 100% rename from content/cn/docs/concepts/overview/working-with-objects/nginx-deployment.yaml rename to content/zh/docs/concepts/overview/working-with-objects/nginx-deployment.yaml diff --git a/content/cn/docs/concepts/policy/pod-security-policy.md b/content/zh/docs/concepts/policy/pod-security-policy.md similarity index 100% rename from content/cn/docs/concepts/policy/pod-security-policy.md rename to content/zh/docs/concepts/policy/pod-security-policy.md diff --git a/content/cn/docs/concepts/policy/psp.yaml b/content/zh/docs/concepts/policy/psp.yaml similarity index 100% rename from content/cn/docs/concepts/policy/psp.yaml rename to content/zh/docs/concepts/policy/psp.yaml diff --git a/content/cn/docs/concepts/policy/resource-quotas.md b/content/zh/docs/concepts/policy/resource-quotas.md similarity index 100% rename from content/cn/docs/concepts/policy/resource-quotas.md rename to content/zh/docs/concepts/policy/resource-quotas.md diff --git a/content/cn/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases.md b/content/zh/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases.md similarity index 100% rename from content/cn/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases.md rename to content/zh/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases.md diff --git a/content/cn/docs/concepts/services-networking/connect-applications-service.md b/content/zh/docs/concepts/services-networking/connect-applications-service.md similarity index 100% rename from content/cn/docs/concepts/services-networking/connect-applications-service.md rename to content/zh/docs/concepts/services-networking/connect-applications-service.md diff --git a/content/cn/docs/concepts/services-networking/curlpod.yaml b/content/zh/docs/concepts/services-networking/curlpod.yaml similarity index 100% rename from content/cn/docs/concepts/services-networking/curlpod.yaml rename to content/zh/docs/concepts/services-networking/curlpod.yaml diff --git a/content/cn/docs/concepts/services-networking/dns-pod-service.md b/content/zh/docs/concepts/services-networking/dns-pod-service.md similarity index 100% rename from content/cn/docs/concepts/services-networking/dns-pod-service.md rename to content/zh/docs/concepts/services-networking/dns-pod-service.md diff --git a/content/cn/docs/concepts/services-networking/hostaliases-pod.yaml b/content/zh/docs/concepts/services-networking/hostaliases-pod.yaml similarity index 100% rename from content/cn/docs/concepts/services-networking/hostaliases-pod.yaml rename to content/zh/docs/concepts/services-networking/hostaliases-pod.yaml diff --git a/content/cn/docs/concepts/services-networking/ingress.yaml b/content/zh/docs/concepts/services-networking/ingress.yaml similarity index 100% rename from content/cn/docs/concepts/services-networking/ingress.yaml rename to content/zh/docs/concepts/services-networking/ingress.yaml diff --git a/content/cn/docs/concepts/services-networking/network-policies.md b/content/zh/docs/concepts/services-networking/network-policies.md similarity index 100% rename from content/cn/docs/concepts/services-networking/network-policies.md rename to content/zh/docs/concepts/services-networking/network-policies.md diff --git a/content/cn/docs/concepts/services-networking/nginx-secure-app.yaml b/content/zh/docs/concepts/services-networking/nginx-secure-app.yaml similarity index 100% rename from content/cn/docs/concepts/services-networking/nginx-secure-app.yaml rename to content/zh/docs/concepts/services-networking/nginx-secure-app.yaml diff --git a/content/cn/docs/concepts/services-networking/nginx-svc.yaml b/content/zh/docs/concepts/services-networking/nginx-svc.yaml similarity index 100% rename from content/cn/docs/concepts/services-networking/nginx-svc.yaml rename to content/zh/docs/concepts/services-networking/nginx-svc.yaml diff --git a/content/cn/docs/concepts/services-networking/run-my-nginx.yaml b/content/zh/docs/concepts/services-networking/run-my-nginx.yaml similarity index 100% rename from content/cn/docs/concepts/services-networking/run-my-nginx.yaml rename to content/zh/docs/concepts/services-networking/run-my-nginx.yaml diff --git a/content/cn/docs/concepts/services-networking/service.md b/content/zh/docs/concepts/services-networking/service.md similarity index 100% rename from content/cn/docs/concepts/services-networking/service.md rename to content/zh/docs/concepts/services-networking/service.md diff --git a/content/cn/docs/concepts/workloads/controllers/cron-jobs.md b/content/zh/docs/concepts/workloads/controllers/cron-jobs.md similarity index 100% rename from content/cn/docs/concepts/workloads/controllers/cron-jobs.md rename to content/zh/docs/concepts/workloads/controllers/cron-jobs.md diff --git a/content/cn/docs/concepts/workloads/controllers/daemonset.md b/content/zh/docs/concepts/workloads/controllers/daemonset.md similarity index 100% rename from content/cn/docs/concepts/workloads/controllers/daemonset.md rename to content/zh/docs/concepts/workloads/controllers/daemonset.md diff --git a/content/cn/docs/concepts/workloads/controllers/daemonset.yaml b/content/zh/docs/concepts/workloads/controllers/daemonset.yaml similarity index 100% rename from content/cn/docs/concepts/workloads/controllers/daemonset.yaml rename to content/zh/docs/concepts/workloads/controllers/daemonset.yaml diff --git a/content/cn/docs/concepts/workloads/controllers/deployment.md b/content/zh/docs/concepts/workloads/controllers/deployment.md similarity index 100% rename from content/cn/docs/concepts/workloads/controllers/deployment.md rename to content/zh/docs/concepts/workloads/controllers/deployment.md diff --git a/content/cn/docs/concepts/workloads/controllers/frontend.yaml b/content/zh/docs/concepts/workloads/controllers/frontend.yaml similarity index 100% rename from content/cn/docs/concepts/workloads/controllers/frontend.yaml rename to content/zh/docs/concepts/workloads/controllers/frontend.yaml diff --git a/content/cn/docs/concepts/workloads/controllers/garbage-collection.md b/content/zh/docs/concepts/workloads/controllers/garbage-collection.md similarity index 100% rename from content/cn/docs/concepts/workloads/controllers/garbage-collection.md rename to content/zh/docs/concepts/workloads/controllers/garbage-collection.md diff --git a/content/cn/docs/concepts/workloads/controllers/hpa-rs.yaml b/content/zh/docs/concepts/workloads/controllers/hpa-rs.yaml similarity index 100% rename from content/cn/docs/concepts/workloads/controllers/hpa-rs.yaml rename to content/zh/docs/concepts/workloads/controllers/hpa-rs.yaml diff --git a/content/cn/docs/concepts/workloads/controllers/job.yaml b/content/zh/docs/concepts/workloads/controllers/job.yaml similarity index 100% rename from content/cn/docs/concepts/workloads/controllers/job.yaml rename to content/zh/docs/concepts/workloads/controllers/job.yaml diff --git a/content/cn/docs/concepts/workloads/controllers/my-repset.yaml b/content/zh/docs/concepts/workloads/controllers/my-repset.yaml similarity index 100% rename from content/cn/docs/concepts/workloads/controllers/my-repset.yaml rename to content/zh/docs/concepts/workloads/controllers/my-repset.yaml diff --git a/content/cn/docs/concepts/workloads/controllers/nginx-deployment.yaml b/content/zh/docs/concepts/workloads/controllers/nginx-deployment.yaml similarity index 100% rename from content/cn/docs/concepts/workloads/controllers/nginx-deployment.yaml rename to content/zh/docs/concepts/workloads/controllers/nginx-deployment.yaml diff --git a/content/cn/docs/concepts/workloads/controllers/replication.yaml b/content/zh/docs/concepts/workloads/controllers/replication.yaml similarity index 100% rename from content/cn/docs/concepts/workloads/controllers/replication.yaml rename to content/zh/docs/concepts/workloads/controllers/replication.yaml diff --git a/content/cn/docs/concepts/workloads/pods/init-containers.md b/content/zh/docs/concepts/workloads/pods/init-containers.md similarity index 100% rename from content/cn/docs/concepts/workloads/pods/init-containers.md rename to content/zh/docs/concepts/workloads/pods/init-containers.md diff --git a/content/cn/docs/concepts/workloads/pods/pod-lifecycle.md b/content/zh/docs/concepts/workloads/pods/pod-lifecycle.md similarity index 100% rename from content/cn/docs/concepts/workloads/pods/pod-lifecycle.md rename to content/zh/docs/concepts/workloads/pods/pod-lifecycle.md diff --git a/content/cn/docs/concepts/workloads/pods/podpreset.md b/content/zh/docs/concepts/workloads/pods/podpreset.md similarity index 100% rename from content/cn/docs/concepts/workloads/pods/podpreset.md rename to content/zh/docs/concepts/workloads/pods/podpreset.md diff --git a/content/zh/docs/getting-started-guides/ubuntu/security.md b/content/zh/docs/getting-started-guides/ubuntu/security.md new file mode 100644 index 0000000000..49839858b2 --- /dev/null +++ b/content/zh/docs/getting-started-guides/ubuntu/security.md @@ -0,0 +1,68 @@ +--- +title: 安全考虑 +content_template: templates/task +--- + + +{{% capture overview %}} + +默认情况下,所有提供的节点之间的所有连接(包括 etcd 集群)都通过 easyrsa 的 TLS 进行保护。 + +本文介绍已部署集群的安全注意事项和生产环境建议。 +{{% /capture %}} +{{% capture prerequisites %}} + +本文假定您拥有一个使用 Juju 部署的正在运行的集群。 +{{% /capture %}} + + +{{% capture steps %}} + +## 实现 + +TLS 和 easyrsa 的实现使用以下 [layers](https://jujucharms.com/docs/2.2/developer-layers)。 + +[layer-tls-client](https://github.com/juju-solutions/layer-tls-client) +[layer-easyrsa](https://github.com/juju-solutions/layer-easyrsa) + + +## 限制 ssh 访问 + +默认情况下,管理员可以 ssh 到集群中的任意已部署节点。您可以通过以下命令来批量禁用集群节点的 ssh 访问权限。 + + juju model-config proxy-ssh=true + +注意:Juju 控制器节点在您的云中仍然有开放的 ssh 访问权限,并且在这种情况下将被用作跳板机。 + +有关如何管理 ssh 密钥的说明,请参阅 Juju 文档中的 [模型管理](https://jujucharms.com/docs/2.2/models) 页面。 +{{% /capture %}} + + diff --git a/content/zh/docs/reference/access-authn-authz/admission-controllers.md b/content/zh/docs/reference/access-authn-authz/admission-controllers.md new file mode 100755 index 0000000000..d855803396 --- /dev/null +++ b/content/zh/docs/reference/access-authn-authz/admission-controllers.md @@ -0,0 +1,563 @@ +--- +assignees: +- bprashanth +- davidopp +- derekwaynecarr +- erictune +- janetkuo +- thockin +cn-approvers: +- linyouchong +title: 使用准入控制插件 +--- + + +* TOC +{:toc} + + +## 什么是准入控制插件? + + +一个准入控制插件是一段代码,它会在请求通过认证和授权之后、对象被持久化之前拦截到达 API server 的请求。插件代码运行在 API server 进程中,必须将其编译为二进制文件,以便在此时使用。 + + +在每个请求被集群接受之前,准入控制插件依次执行。如果插件序列中任何一个拒绝了该请求,则整个请求将立即被拒绝并且返回一个错误给终端用户。 + + +准入控制插件可能会在某些情况下改变传入的对象,从而应用系统配置的默认值。另外,作为请求处理的一部分,准入控制插件可能会对相关的资源进行变更,以实现类似增加配额使用量这样的功能。 + + +## 为什么需要准入控制插件? + + +Kubernetes 的许多高级功能都要求启用一个准入控制插件,以便正确地支持该特性。因此,一个没有正确配置准入控制插件的 Kubernetes API server 是不完整的,它不会支持您所期望的所有特性。 + + +## 如何启用一个准入控制插件? + + +Kubernetes API server 支持一个标志参数 `admission-control` ,它指定了一个用于在集群修改对象之前调用的以逗号分隔的准入控制插件顺序列表。 + + +## 每个插件的功能是什么? + +### AlwaysAdmit + + +使用这个插件自行通过所有的请求。 + +### AlwaysPullImages + + +这个插件修改每一个新创建的 Pod 的镜像拉取策略为 Always 。这在多租户集群中是有用的,这样用户就可以放心,他们的私有镜像只能被那些有凭证的人使用。没有这个插件,一旦镜像被拉取到节点上,任何用户的 pod 都可以通过已了解到的镜像的名称(假设 pod 被调度到正确的节点上)来使用它,而不需要对镜像进行任何授权检查。当启用这个插件时,总是在启动容器之前拉取镜像,这意味着需要有效的凭证。 + +### AlwaysDeny + + +拒绝所有的请求。用于测试。 + + +### DenyExecOnPrivileged (已废弃) + + +如果一个 pod 拥有一个特权容器,这个插件将拦截所有在该 pod 中执行 exec 命令的请求。 + + +如果集群支持特权容器,并且希望限制最终用户在这些容器中执行 exec 命令的能力,我们强烈建议启用这个插件。 + + +此功能已合并到 [DenyEscalatingExec](#denyescalatingexec)。 + +### DenyEscalatingExec + + +这个插件将拒绝在拥有衍生特权而具备访问宿主机能力的 pod 中执行 exec 和 attach 命令。这包括在特权模式运行的 pod ,可以访问主机 IPC 命名空间的 pod ,和访问主机 PID 命名空间的 pod 。 + + +如果集群支持使用以衍生特权运行的容器,并且希望限制最终用户在这些容器中执行 exec 命令的能力,我们强烈建议启用这个插件。 + +### ImagePolicyWebhook + + +ImagePolicyWebhook 插件允许使用一个后端的 webhook 做出准入决策。您可以按照如下配置 admission-control 选项来启用这个插件: + +```shell +--admission-control=ImagePolicyWebhook +``` + + +#### 配置文件格式 + +ImagePolicyWebhook 插件使用了admission config 文件 `--admission-control-config-file` 来为后端行为设置配置选项。该文件可以是 json 或 yaml ,并具有以下格式: + +```javascript +{ + "imagePolicy": { + "kubeConfigFile": "path/to/kubeconfig/for/backend", + "allowTTL": 50, // time in s to cache approval + "denyTTL": 50, // time in s to cache denial + "retryBackoff": 500, // time in ms to wait between retries + "defaultAllow": true // determines behavior if the webhook backend fails + } +} +``` + + +这个配置文件必须引用一个 [kubeconfig](/docs/concepts/cluster-administration/authenticate-across-clusters-kubeconfig/) 格式的文件,并在其中配置指向后端的连接。且需要在 TLS 上与后端进行通信。 + + +kubeconfig 文件的 cluster 字段需要指向远端服务,user 字段需要包含已返回的授权者。 + +```yaml +# clusters refers to the remote service. +clusters: +- name: name-of-remote-imagepolicy-service + cluster: + certificate-authority: /path/to/ca.pem # CA for verifying the remote service. + server: https://images.example.com/policy # URL of remote service to query. Must use 'https'. + +# users refers to the API server's webhook configuration. +users: +- name: name-of-api-server + user: + client-certificate: /path/to/cert.pem # cert for the webhook plugin to use + client-key: /path/to/key.pem # key matching the cert +``` + +对于更多的 HTTP 配置,请参阅 [kubeconfig](/docs/concepts/cluster-administration/authenticate-across-clusters-kubeconfig/) 文档。 + + +#### 请求载荷 + + +当面对一个准入决策时,API server 发送一个描述操作的 JSON 序列化的 api.imagepolicy.v1alpha1.ImageReview 对象。该对象包含描述被审核容器的字段,以及所有匹配 `*.image-policy.k8s.io/*` 的 pod 注释。 + + +注意,webhook API 对象与其他 Kubernetes API 对象一样受制于相同的版本控制兼容性规则。实现者应该知道对 alpha 对象的更宽松的兼容性,并检查请求的 "apiVersion" 字段,以确保正确的反序列化。此外,API server 必须启用 imagepolicy.k8s.io/v1alpha1 API 扩展组 (`--runtime-config=imagepolicy.k8s.io/v1alpha1=true`)。 + + +请求载荷例子: + +``` +{ + "apiVersion":"imagepolicy.k8s.io/v1alpha1", + "kind":"ImageReview", + "spec":{ + "containers":[ + { + "image":"myrepo/myimage:v1" + }, + { + "image":"myrepo/myimage@sha256:beb6bd6a68f114c1dc2ea4b28db81bdf91de202a9014972bec5e4d9171d90ed" + } + ], + "annotations":[ + "mycluster.image-policy.k8s.io/ticket-1234": "break-glass" + ], + "namespace":"mynamespace" + } +} +``` + + +远程服务将填充请求的 ImageReviewStatus 字段,并返回允许或不允许访问。响应主体的 "spec" 字段会被忽略,并且可以省略。一个允许访问应答会返回: + +``` +{ + "apiVersion": "imagepolicy.k8s.io/v1alpha1", + "kind": "ImageReview", + "status": { + "allowed": true + } +} +``` + + +不允许访问,服务将返回: + +``` +{ + "apiVersion": "imagepolicy.k8s.io/v1alpha1", + "kind": "ImageReview", + "status": { + "allowed": false, + "reason": "image currently blacklisted" + } +} +``` + + +更多的文档,请参阅 `imagepolicy.v1alpha1` API 对象 和 `plugin/pkg/admission/imagepolicy/admission.go`。 + + +使用注解进行扩展 + + +一个 pod 中匹配 `*.image-policy.k8s.io/*` 的注解都会被发送给 webhook。这允许了解镜像策略后端的用户向它发送额外的信息,并为不同的后端实现接收不同的信息。 + + +您可以在这里输入的信息有: + + + * 在紧急情况下,请求 "break glass" 覆盖一个策略。 + + * 从一个记录了 break-glass 的请求的票证系统得到的一个票证编号 + + * 向策略服务器提供一个提示,用于提供镜像的 imageID,以方便它进行查找 + + +在任何情况下,注解都是由用户提供的,并不会被 Kubernetes 以任何方式进行验证。在将来,如果一个注解确定将被广泛使用,它可能会被提升为 ImageReviewSpec 的一个命名字段。 + +### ServiceAccount + + +这个插件实现了 [serviceAccounts](/docs/user-guide/service-accounts) 的自动化。 +如果您打算使用 Kubernetes 的 ServiceAccount 对象,我们强烈建议您使用这个插件。 + +### SecurityContextDeny + + +该插件将拒绝任何试图设置特定扩展 [SecurityContext](/docs/user-guide/security-context) 字段的 pod。如果集群没有使用 [ pod 安全策略](/docs/user-guide/pod-security-policy) 来限制安全上下文所能获取的值集,那么应该启用这个功能。 + +### ResourceQuota + + +此插件将观察传入的请求,并确保它不违反任何一个 `Namespace` 中的 `ResourceQuota` 对象中枚举出来的约束。如果您在 Kubernetes 部署中使用了 `ResourceQuota` +,您必须使用这个插件来强制执行配额限制。 + + +请查看 [resourceQuota 设计文档](https://git.k8s.io/community/contributors/design-proposals/admission_control_resource_quota.md) 和 [Resource Quota 例子](/docs/concepts/policy/resource-quotas/) 了解更多细节。 + + +强烈建议将这个插件配置在准入控制插件序列的末尾。这样配额就不会过早地增加,只会在稍后的准入控制中被拒绝。 + +### LimitRanger + + +这个插件将观察传入的请求,并确保它不会违反 `Namespace` 中 `LimitRange` 对象枚举的任何约束。如果您在 Kubernetes 部署中使用了 `LimitRange` 对象,则必须使用此插件来执行这些约束。LimitRanger 插件还可以用于将默认资源请求应用到没有指定任何内容的 Pod ;当前,默认的 LimitRanger 对 `default` 命名空间中的所有 pod 应用了0.1 CPU 的需求。 + + +请查看 [limitRange 设计文档](https://git.k8s.io/community/contributors/design-proposals/admission_control_limit_range.md) 和 [Limit Range 例子](/docs/tasks/configure-pod-container/limit-range/) 了解更多细节。 + + +### InitialResources (试验) + + +此插件观察 pod 创建请求。如果容器忽略了 requests 和 limits 计算资源,那么插件就会根据运行相同镜像的容器的历史使用记录来自动填充计算资源请求。如果没有足够的数据进行决策,则请求将保持不变。当插件设置了一个计算资源请求时,它会用它自动填充的计算资源对 pod 进行注解。 + + +请查看 [InitialResouces 建议书](https://git.k8s.io/community/contributors/design-proposals/initial-resources.md) 了解更多细节。 + +### NamespaceLifecycle + + +这个插件强制不能在一个正在被终止的 `Namespace` 中创建新对象,和确保使用不存在 `Namespace` 的请求被拒绝。 + + +删除 `Namespace` 触发了在该命名空间中删除所有对象( pod 、 services 等)的一系列操作。为了确保这个过程的完整性,我们强烈建议启用这个插件。 + +### DefaultStorageClass + + +这个插件观察不指定 storage class 字段的 `PersistentVolumeClaim` 对象的创建,并自动向它们添加默认的 storage class 。这样,不指定 storage class 字段的用户根本无需关心它们,它们将得到默认的 storage class 。 + + +当没有配置默认 storage class 时,这个插件不会执行任何操作。当一个以上的 storage class 被标记为默认时,它拒绝 `PersistentVolumeClaim` 创建并返回一个错误,管理员必须重新检查 `StorageClass` 对象,并且只标记一个作为默认值。这个插件忽略了任何 `PersistentVolumeClaim` 更新,它只对创建起作用。 + + +查看 [persistent volume](/docs/user-guide/persistent-volumes) 文档了解 persistent volume claims 和 storage classes 并了解如何将一个 storage classes 标志为默认。 + +### DefaultTolerationSeconds + + +这个插件设置了 pod 默认的宽恕容忍时间,对于那些没有设置宽恕容忍时间的 pod ,可以容忍 `notready:NoExecute` 和 `unreachable:NoExecute` 这些 taint 5分钟。 + +### PodNodeSelector + + +通过读取命名空间注释和全局配置,这个插件默认并限制了在一个命名空间中使用什么节点选择器。 + + +#### 配置文件格式 + +PodNodeSelector 插件使用准入配置文件 `--admission-control-config-file` 来设置后端行为的配置选项。 + + +请注意,配置文件格式将在未来版本中移至版本化文件。 + + +这个文件可能是 json 或 yaml ,格式如下: + +```yaml +podNodeSelectorPluginConfig: + clusterDefaultNodeSelector: + namespace1: + namespace2: +``` + + +#### 配置注解格式 + +PodNodeSelector 插件使用键为 `scheduler.alpha.kubernetes.io/node-selector` 的注解将节点选择器分配给 namespace 。 + +```yaml +apiVersion: v1 +kind: Namespace +metadata: + annotations: + scheduler.alpha.kubernetes.io/node-selector: + name: namespace3 +``` + +### PodSecurityPolicy + + +此插件负责在创建和修改 pod 时根据请求的安全上下文和可用的 pod 安全策略确定是否应该通过 pod。 + + +对于 Kubernetes < 1.6.0 的版本,API Server 必须启用 extensions/v1beta1/podsecuritypolicy API 扩展组 (`--runtime-config=extensions/v1beta1/podsecuritypolicy=true`)。 + + +查看 [Pod 安全策略文档](/docs/concepts/policy/pod-security-policy/) 了解更多细节。 + +### NodeRestriction + + +这个插件限制了 kubelet 可以修改的 `Node` 和 `Pod` 对象。 为了受到这个入场插件的限制,kubelet 必须在 `system:nodes` 组中使用凭证,并使用 `system:node:` 形式的用户名。这样的 kubelet 只允许修改自己的 `Node` API 对象,只能修改绑定到节点本身的 `Pod` 对象。 + +未来的版本可能会添加额外的限制,以确保 kubelet 具有正确操作所需的最小权限集。 + + +## 是否有推荐的一组插件可供使用? + + +有。 +对于 Kubernetes >= 1.6.0 版本,我们强烈建议运行以下一系列准入控制插件(顺序也很重要) + +```shell +--admission-control=NamespaceLifecycle,LimitRanger,ServiceAccount,PersistentVolumeLabel,DefaultStorageClass,ResourceQuota,DefaultTolerationSeconds +``` + + +对于 Kubernetes >= 1.4.0 版本,我们强烈建议运行以下一系列准入控制插件(顺序也很重要) + +```shell +--admission-control=NamespaceLifecycle,LimitRanger,ServiceAccount,DefaultStorageClass,ResourceQuota +``` + + +对于 Kubernetes >= 1.2.0 版本,我们强烈建议运行以下一系列准入控制插件(顺序也很重要) + +```shell +--admission-control=NamespaceLifecycle,LimitRanger,ServiceAccount,ResourceQuota +``` + + +对于 Kubernetes >= 1.0.0 版本,我们强烈建议运行以下一系列准入控制插件(顺序也很重要) + +```shell +--admission-control=NamespaceLifecycle,LimitRanger,SecurityContextDeny,ServiceAccount,PersistentVolumeLabel,ResourceQuota +``` diff --git a/content/zh/docs/reference/access-authn-authz/authorization.md b/content/zh/docs/reference/access-authn-authz/authorization.md new file mode 100644 index 0000000000..e8d8d8043e --- /dev/null +++ b/content/zh/docs/reference/access-authn-authz/authorization.md @@ -0,0 +1,304 @@ +--- +reviewers: +- erictune +- lavalamp +- deads2k +- liggitt +cnapprove: +- fatalc + +title: 授权概述 +content_template: templates/concept +weight: 60 +--- + +{{% capture overview %}} + +了解有关 Kubernetes 授权的更多信息,包括使用支持的授权模块创建策略的详细信息。 +{{% /capture %}} + +{{% capture body %}} + + +在Kubernetes中,您必须在授权(授予访问权限)之前进行身份验证(登录),有关身份验证的信息, +请参阅 [访问控制概述](/docs/reference/access-authn-authz/controlling-access/). + +Kubernetes期望REST API请求中常见的属性。 +这意味着Kubernetes授权适用于现有的组织范围或云提供商范围的访问控制系统, +除了Kubernetes API之外,它还可以处理其他API。 + + + +## 确定是允许还是拒绝请求 +Kubernetes 使用 API ​​服务器授权 API 请求。它根据所有策略评估所有请求属性来决定允许或拒绝请求。 +一个API请求的所有部分必须被某些策略允许才能继续。这意味着默认情况下拒绝权限。 + +(尽管 Kubernetes 使用 API ​​服务器,但是依赖于特定种类对象的特定字段的访问控制和策略由准入控制器处理。) + +配置多个授权模块时,将按顺序检查每个模块。 +如果任何授权模块批准或拒绝请求,则立即返回该决定,并且不会与其他授权模块协商。 +如果所有模块对请求没有意见,则拒绝该请求。一个拒绝响应返回 HTTP 状态代码 403 。 + + + +## 审查您的请求属性 +Kubernetes仅审查以下API请求属性: + + * **user** - 身份验证期间提供的`user`字符串。 + * **group** - 经过身份验证的用户所属的组名列表。 + * **extra** - 由身份验证层提供的任意字符串键到字符串值的映射。 + * **API** - 指示请求是否针对 API 资源。 + * **Request path** - 各种非资源端点的路径,如`/api`或`/healthz`。 + * **API request verb** - API 动词`get`,`list`,`create`,`update`,`patch`,`watch`,`proxy`,`redirect`,`delete`和`deletecollection`用于资源请求。要确定资源API端点的请求动词,请参阅[确定请求动词](/docs/reference/access-authn-authz/authorization/#determine-whether-a-request-is-allowed-or-denied)。 + * **HTTP request verb** - HTTP 动词`get`,`post`,`put`和`delete`用于非资源请求。 + * **Resource** - 正在访问的资源的 ID 或名称(仅限资源请求) - 对于使用`get`,`update`,`patch`和`delete`动词的资源请求,您必须提供资源名称。 + * **Subresource** - 正在访问的子资源(仅限资源请求)。 + * **Namespace** - 正在访问的对象的名称空间(仅适用于命名空间资源请求)。 + * **API group** - 正在访问的 API 组(仅限资源请求)。空字符串表示[核心API组](/docs/concepts/overview/kubernetes-api/)。 + + + +## 确定请求动词 + +要确定资源API端点的请求谓词,请检查所使用的 HTTP 动词以及请求是否对单个资源或资源集合起作用: + +HTTP 动词 | request 动词 +----------|--------------- +POST | create +GET, HEAD | get (单个资源), list (资源集合) +PUT | update +PATCH | patch +DELETE | delete (单个资源), deletecollection (资源集合) + +Kubernetes有时使用专门的动词检查授权以获得额外的权限。例如: + +* [Pod安全策略](/docs/concepts/policy/pod-security-policy/) 检查`policy` API组中`podsecuritypolicies`资源的`use`动词的授权。 +* [RBAC](/docs/reference/access-authn-authz/rbac/#privilege-escalation-prevention-and-bootstrapping) 检查`rbac.authorization.k8s.io` API 组中`roles`和`clusterroles`资源的`bind`动词的授权。 +* [认证](/docs/reference/access-authn-authz/authentication/) layer检查核心API组中`users`,`groups`和`serviceaccounts`的`impersonate`动词的授权,以及`authentication.k8s.io` API组中的`userextras`。 + + + +## 授权模块 + * **Node** - 一个专用授权程序,根据计划运行的 pod 为 kubelet 授予权限。了解有关使用节点授权模式的更多信息,请参阅[节点授权](/docs/reference/access-authn-authz/node/). + * **ABAC** - 基于属性的访问控制(ABAC) 定义了一种访问控制范例,通过使用将属性组合在一起的策略,将访问权限授予用户。策略可以使用任何类型的属性(用户属性,资源属性,对象,环境属性等)。要了解有关使用 ABAC 模式的更多信息,请参阅[ABAC 模式](/docs/reference/access-authn-authz/abac/)。 + * **RBAC** - 基于角色的访问控制(RBAC)是一种基于企业内个人用户的角色来管理对计算机或网络资源的访问的方法。在此上下文中,权限是单个用户执行特定任务的能力,例如查看,创建或修改文件。要了解有关使用 RBAC 模式的更多信息,请参阅[RBAC 模式](/docs/reference/access-authn-authz/rbac/)。 + * 当指定的RBAC(基于角色的访问控制)使用`rbac.authorization.k8s.io` API 组来驱动授权决策时,允许管理员通过 Kubernetes API 动态配置权限策略。 + * 要启用RBAC,请使用`--authorization-mode = RBAC`启动 apiserver 。 + * **Webhook** - WebHook 是一个 HTTP 回调: 发生某些事情时调用的 HTTP POST;通过 HTTP POST 进行简单的事件通知。实现 WebHooks 的 Web 应用程序会在发生某些事情时将消息发布到URL。要了解有关使用 Webhook 模式的更多信息,请参阅[Webhook 模式](/docs/reference/access-authn-authz/webhook/)。 + + + +#### 检查API访问 + +`kubectl`提供`auth can-i`子命令,用于快速查询 API 授权层。 +该命令使用`SelfSubjectAccessReview` API来确定当前用户是否可以执行给定操作,并且无论使用何种授权模式都可以工作。 + +```bash +$ kubectl auth can-i create deployments --namespace dev +yes +$ kubectl auth can-i create deployments --namespace prod +no +``` + +管理员可以将此与[用户模拟](/docs/reference/access-authn-authz/authentication/#user-impersonation)结合使用,以确定其他用户可以执行的操作。 + +```bash +$ kubectl auth can-i list secrets --namespace dev --as dave +no +``` + + +`SelfSubjectAccessReview`是`authorization.k8s.io` API组的一部分,它将 API 服务器授权公开给外部服务。 +该组中的其他资源包括: + +* `SubjectAccessReview` - 访问任何用户的 Review ,而不仅仅是当前用户。用于将授权决策委派给API服务器。例如,kubelet 和扩展 API 服务器使用它来确定用户对自己的API的访问权限。 +* `LocalSubjectAccessReview` - 与`SubjectAccessReview`类似,但仅限于特定的命名空间。 +* `SelfSubjectRulesReview` - 返回用户可在命名空间内执行的操作集的审阅。用户可以快速汇总自己的访问权限,或者用于隐藏/显示操作的UI。 + +可以通过创建普通 Kubernetes 资源来查询这些 API ,其中返回对象的响应“status”字段是查询的结果。 + +```bash +$ kubectl create -f - -o yaml << EOF +apiVersion: authorization.k8s.io/v1 +kind: SelfSubjectAccessReview +spec: + resourceAttributes: + group: apps + name: deployments + verb: create + namespace: dev +EOF + +apiVersion: authorization.k8s.io/v1 +kind: SelfSubjectAccessReview +metadata: + creationTimestamp: null +spec: + resourceAttributes: + group: apps + name: deployments + namespace: dev + verb: create +status: + allowed: true + denied: false +``` + + + +## 为您的授权模块使用标志 + +您必须在策略中包含一个标志,以指明您的策略包含哪个授权模块: + +可以使用以下标志: + + * `--authorization-mode=ABAC` 基于属性的访问控制(ABAC)模式允许您使用本地文件配置策略。 + * `--authorization-mode=RBAC` 基于角色的访问控制(RBAC)模式允许您使用 Kubernetes API 创建和存储策略。 + * `--authorization-mode=Webhook` WebHook 是一种 HTTP 回调模式,允许您使用远程REST端点管理授权。 + * `--authorization-mode=Node` 节点授权是一种特殊用途的授权模式,专门授权由 kubelet 发出的API请求。 + * `--authorization-mode=AlwaysDeny` 该标志阻止所有请求。仅将此标志用于测试。 + * `--authorization-mode=AlwaysAllow` 此标志允许所有请求。仅在您不需要 API 请求的授权时才使用此标志。 + +您可以选择多个授权模块。按顺序检查模块,以便较早的模块具有更高的优先级来允许或拒绝请求。 + + +## 通过pod创建权限升级 + +能够在命名空间中创建 pod 的用户可能会升级其在该命名空间内的权限。 +他们可以创建在该命名空间内访问其权限的 pod 。 +他们可以创建用户无法自己读取 secret 的 pod ,或者在具有不同/更高权限的服务帐户下运行的 pod 。 + +{{< caution >}} + +**注意:** 系统管理员在授予对 pod 创建的访问权限时要小心。 +授予在命名空间中创建 pod(或创建pod的控制器)的权限的用户可以: +读取命名空间中的所有秘密;读取命名空间中的所有配置映射; +并模拟命名空间中的任何服务帐户并执行帐户可以执行的任何操作。 +无论采用何种授权方式,这都适用。 +{{< /caution >}} +{{% /capture %}} + +{{% capture whatsnext %}} + +* 要了解有关身份验证的更多信息,请参阅 **身份验证** [控制对Kubernetes API的访问](/docs/reference/access-authn-authz/controlling-access/). +* 要了解有关准入控制的更多信息,请参阅 [使用准入控制器](/docs/reference/access-authn-authz/admission-controllers/). +{{% /capture %}} \ No newline at end of file diff --git a/content/zh/docs/reference/command-line-tools-reference/kube-proxy.md b/content/zh/docs/reference/command-line-tools-reference/kube-proxy.md new file mode 100644 index 0000000000..80acad7403 --- /dev/null +++ b/content/zh/docs/reference/command-line-tools-reference/kube-proxy.md @@ -0,0 +1,491 @@ +--- +title: kube-proxy +notitle: true +--- +## kube-proxy + + + +### 概要 + +Kubernetes 在每个节点上运行网络代理。这反映每个节点上 Kubernetes API 中定义的服务,并且可以做简单的 +TCP 和 UDP 流转发或在一组后端中轮询,进行 TCP 和 UDP 转发。目前服务集群 IP 和端口通过由服务代理打开的端口 +的 Docker-links-compatible 环境变量找到。有一个可选的为这些集群 IP 提供集群 DNS 的插件。用户必须 +通过 apiserver API 创建服务去配置代理。 + +``` +kube-proxy [flags] +``` + + +### 选项 + +

loadBalancerIP

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.

Only applies to Service Type: 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.

false

string

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--azure-container-registry-config string
包含 Azure 容器仓库配置信息的文件的路径。
--bind-address 0.0.0.0     默认: 0.0.0.0
要服务的代理服务器的 IP 地址(对于所有 IPv4 接口设置为 0.0.0.0,对于所有 IPv6 接口设置为 ::)
--cleanup
如果为 true,清理 iptables 和 ipvs 规则并退出。
--cleanup-ipvs     默认: true
如果为 true,则使 kube-proxy 在运行之前清理 ipvs 规则。 默认为 true
--cluster-cidr string
集群中的 CIDR 范围。 配置后,从该范围之外发送到服务集群 IP 的流量将被伪装,从 pod 发送到外部 LoadBalancer IP 的流量将被定向到相应的集群 IP
--config string
配置文件的路径。
--config-sync-period duration     默认: 15m0s
来自 apiserver 的配置的刷新频率。必须大于 0。
--conntrack-max-per-core int32     默认: 32768
每个 CPU 核跟踪的最大 NAT 连接数(0 表示保留原样限制并忽略 conntrack-min)。
--conntrack-min int32     默认: 131072
要分配的最小 conntrack 条目数,不管 conntrack-max-per-core(设置 conntrack-max-per-core = 0 保留原样限制)。
--conntrack-tcp-timeout-close-wait duration     默认: 1h0m0s
处于 CLOSE_WAIT 状态的 TCP 连接的 NAT 超时
--conntrack-tcp-timeout-established duration     默认: 24h0m0s
已建立的 TCP 连接的空闲超时(0 保持原样)
--feature-gates mapStringBool
一组 key=value 对,用于描述 alpha/experimental 特征的特征门。选项包括:
APIListChunking=true|false (BETA - 默认=true)
APIResponseCompression=true|false (ALPHA - 默认=false)
AdvancedAuditing=true|false (BETA - 默认=true)
AllAlpha=true|false (ALPHA - 默认=false)
AppArmor=true|false (BETA - 默认=true)
AttachVolumeLimit=true|false (ALPHA - 默认=false)
BalanceAttachedNodeVolumes=true|false (ALPHA - 默认=false)
BlockVolume=true|false (ALPHA - 默认=false)
CPUManager=true|false (BETA - 默认=true)
CRIContainerLogRotation=true|false (BETA - 默认=true)
CSIBlockVolume=true|false (ALPHA - 默认=false)
CSIPersistentVolume=true|false (BETA - 默认=true)
CustomPodDNS=true|false (BETA - 默认=true)
CustomResourceSubresources=true|false (BETA - 默认=true)
CustomResourceValidation=true|false (BETA - 默认=true)
DebugContainers=true|false (ALPHA - 默认=false)
DevicePlugins=true|false (BETA - 默认=true)
DynamicKubeletConfig=true|false (BETA - 默认=true)
DynamicProvisioningScheduling=true|false (ALPHA - 默认=false)
EnableEquivalenceClassCache=true|false (ALPHA - 默认=false)
ExpandInUsePersistentVolumes=true|false (ALPHA - 默认=false)
ExpandPersistentVolumes=true|false (BETA - 默认=true)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - 默认=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - 默认=false)
GCERegionalPersistentDisk=true|false (BETA - 默认=true)
HugePages=true|false (BETA - 默认=true)
HyperVContainer=true|false (ALPHA - 默认=false)
Initializers=true|false (ALPHA - 默认=false)
KubeletPluginsWatcher=true|false (ALPHA - 默认=false)
LocalStorageCapacityIsolation=true|false (BETA - default=true)
MountContainers=true|false (ALPHA - 默认=false)
MountPropagation=true|false (BETA - 默认=true)
PersistentLocalVolumes=true|false (BETA - 默认=true)
PodPriority=true|false (BETA - 默认=true)
PodReadinessGates=true|false (BETA - 默认=false)
PodShareProcessNamespace=true|false (ALPHA - 默认=false)
QOSReserved=true|false (ALPHA - 默认=false)
ReadOnlyAPIDataVolumes=true|false (弃用 - 默认=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - 默认=false)
ResourceQuotaScopeSelectors=true|false (ALPHA - 默认=false)
RotateKubeletClientCertificate=true|false (BETA - 默认=true)
RotateKubeletServerCertificate=true|false (ALPHA - 默认=false)
RunAsGroup=true|false (ALPHA - 默认=false)
ScheduleDaemonSetPods=true|false (ALPHA - 默认=false)
ServiceNodeExclusion=true|false (ALPHA - 默认=false)
ServiceProxyAllowExternalIPs=true|false (弃用 - 默认=false)
StorageObjectInUseProtection=true|false (default=true)
StreamingProxyRedirects=true|false (BETA - 默认=true)
SupportIPVSProxyMode=true|false (默认=true)
SupportPodPidsLimit=true|false (ALPHA - 默认=false)
Sysctls=true|false (BETA - 默认=true)
TaintBasedEvictions=true|false (ALPHA - 默认=false)
TaintNodesByCondition=true|false (ALPHA - 默认=false)
TokenRequest=true|false (ALPHA - 默认=false)
TokenRequestProjection=true|false (ALPHA - 默认=false)
VolumeScheduling=true|false (BETA - 默认=true)
VolumeSubpath=true|false (默认=true)
VolumeSubpathEnvExpansion=true|false (ALPHA - 默认=false)
--healthz-bind-address 0.0.0.0     默认: 0.0.0.0:10256
服务健康检查的 IP 地址和端口(对于所有 IPv4 接口设置为 0.0.0.0,对于所有 IPv6 接口设置为 ::)
--healthz-port int32     默认: 10256
绑定健康检查服务的端口。使用 0 禁用。
-h, --help
kube-proxy 帮助信息
--hostname-override string
如果非空,将使用此字符串作为标识而不是实际的主机名。
--iptables-masquerade-bit int32     默认: 14
如果使用纯 iptables 代理,则 fwmark 空间的位用于标记需要 SNAT 的数据包。 必须在 [0,31] 范围内。
--iptables-min-sync-period duration
当端点和服务发生变化时,iptables 规则的刷新的最小间隔(例如 '5s','1m','2h22m')。
--iptables-sync-period duration     默认: 30s
iptables 规则刷新的最大时间间隔(例如 '5s','1m','2h22m')。必须大于 0。
--ipvs-exclude-cidrs stringSlice
以逗号分隔的 CIDR 列表,在清理 IPVS 规则时,不应该触及 ipvs proxier。
--ipvs-min-sync-period duration
当端点和服务发生变化时,ipvs 规则的刷新的最小间隔(例如 '5s','1m','2h22m')。
--ipvs-scheduler string
代理模式为 ipvs 时的 ipvs 调度器类型
--ipvs-sync-period duration     默认: 30s
ipvs 规则刷新的最大时间间隔(例如 '5s','1m','2h22m')。必须大于 0。
--kube-api-burst int32     默认: 10
每秒与 kubernetes apiserver 交互的数量
--kube-api-content-type string     默认: "application/vnd.kubernetes.protobuf"
发送到 apiserver 的请求的内容类型。
--kube-api-qps float32     默认: 5
与 kubernetes apiserver 交互时使用的 QPS
--kubeconfig string
包含授权信息的 kubeconfig 文件的路径(master 位置由 master 标志设置)。
--log-flush-frequency duration     默认: 5s
日志刷新最大间隔
--masquerade-all
如果使用纯 iptables 代理,SNAT 所有通过服务句群 IP 发送的流量(这通常不需要)
--master string
Kubernetes API 服务器的地址(覆盖 kubeconfig 中的任何值)
--metrics-bind-address 0.0.0.0     默认: 127.0.0.1:10249
要服务的度量服务器的 IP 地址和端口(对于所有 IPv4 接口设置为 0.0.0.0,对于所有 IPv6 接口设置为 ::)
--nodeport-addresses stringSlice
一个字符串值,指定用于 NodePorts 的地址。 值可以是有效的 IP 块(例如 1.2.3.0/24, 1.2.3.4/32)。 默认的空字符串切片([])表示使用所有本地地址。
--oom-score-adj int32     默认: -999
kube-proxy 进程的 oom-score-adj 值。 值必须在 [-1000,1000] 范围内
--profiling
如果为 true,则通过 Web 接口 /debug/pprof 启用性能分析。
--proxy-mode ProxyMode
使用哪种代理模式:'userspace'(较旧)或 'iptables'(较快)或 'ipvs'(实验)。 如果为空,使用最佳可用代理(当前为 iptables)。 如果选择了 iptables 代理,无论如何,但系统的内核或 iptables 版本不足,这总是会回退到用户空间代理。
--proxy-port-range port-range
主机端口的范围(beginPort-endPort,单端口或 beginPort + offset,包括),可以被代理服务流量消耗。 如果(未指定,0 或 0-0)则随机选择端口。
--udp-timeout duration     默认: 250ms
空闲 UDP 连接将保持打开的时长(例如 '250ms','2s')。 必须大于 0。仅适用于 proxy-mode=userspace
--version version[=true]
打印版本信息并退出
--write-config-to string
如果设置,将配置值写入此文件并退出。
diff --git a/content/zh/docs/reference/command-line-tools-reference/kube-scheduler.md b/content/zh/docs/reference/command-line-tools-reference/kube-scheduler.md new file mode 100644 index 0000000000..4180967d69 --- /dev/null +++ b/content/zh/docs/reference/command-line-tools-reference/kube-scheduler.md @@ -0,0 +1,380 @@ +--- +title: kube-scheduler +notitle: true +--- +## kube-scheduler + + + + +### 概要 + + +Kubernetes 调度器是一个策略丰富、拓扑感知、工作负载特定的功能,显著影响可用性、性能和容量。调度器需要考虑个人和集体 +的资源要求、服务质量要求、硬件/软件/政策约束、亲和力和反亲和力规范、数据局部性、负载间干扰、完成期限等。 +工作负载特定的要求必要时将通过 API 暴露。 + +``` +kube-scheduler [flags] +``` + + +### 选项 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--address string     默认: "0.0.0.0"
弃用: 要监听 --port 端口的 IP 地址(对于所有 IPv4 接口设置为 0.0.0.0,对于所有 IPv6 接口设置为 ::)。 请参阅 --bind-address。
--algorithm-provider string
弃用: 要使用的调度算法,可选值:ClusterAutoscalerProvider |DefaultProvider
--azure-container-registry-config string
包含 Azure 容器仓库配置信息的文件的路径。
--config string
配置文件的路径。标志会覆盖此文件中的值。
--contention-profiling
弃用: 如果启用了性能分析,则启用锁竞争分析
--feature-gates mapStringBool
一组 key=value 对,用于描述 alpha/experimental 特征的特征门。选项包括:
APIListChunking=true|false (BETA - 默认=true)
APIResponseCompression=true|false (ALPHA - 默认=false)
AdvancedAuditing=true|false (BETA - 默认=true)
AllAlpha=true|false (ALPHA - 默认=false)
AppArmor=true|false (BETA - 默认=true)
AttachVolumeLimit=true|false (ALPHA - 默认=false)
BalanceAttachedNodeVolumes=true|false (ALPHA - 默认=false)
BlockVolume=true|false (ALPHA - 默认=false)
CPUManager=true|false (BETA - 默认=true)
CRIContainerLogRotation=true|false (BETA - 默认=true)
CSIBlockVolume=true|false (ALPHA - 默认=false)
CSIPersistentVolume=true|false (BETA - 默认=true)
CustomPodDNS=true|false (BETA - 默认=true)
CustomResourceSubresources=true|false (BETA - 默认=true)
CustomResourceValidation=true|false (BETA - 默认=true)
DebugContainers=true|false (ALPHA - 默认=false)
DevicePlugins=true|false (BETA - 默认=true)
DynamicKubeletConfig=true|false (BETA - 默认=true)
DynamicProvisioningScheduling=true|false (ALPHA - 默认=false)
EnableEquivalenceClassCache=true|false (ALPHA - 默认=false)
ExpandInUsePersistentVolumes=true|false (ALPHA - 默认=false)
ExpandPersistentVolumes=true|false (BETA - 默认=true)
ExperimentalCriticalPodAnnotation=true|false (ALPHA - 默认=false)
ExperimentalHostUserNamespaceDefaulting=true|false (BETA - 默认=false)
GCERegionalPersistentDisk=true|false (BETA - 默认=true)
HugePages=true|false (BETA - 默认=true)
HyperVContainer=true|false (ALPHA - 默认=false)
Initializers=true|false (ALPHA - 默认=false)
KubeletPluginsWatcher=true|false (ALPHA - 默认=false)
LocalStorageCapacityIsolation=true|false (BETA - 默认=true)
MountContainers=true|false (ALPHA - 默认=false)
MountPropagation=true|false (BETA - 默认=true)
PersistentLocalVolumes=true|false (BETA - 默认=true)
PodPriority=true|false (BETA - 默认=true)
PodReadinessGates=true|false (BETA - 默认=false)
PodShareProcessNamespace=true|false (ALPHA - 默认=false)
QOSReserved=true|false (ALPHA - 默认=false)
ReadOnlyAPIDataVolumes=true|false (弃用 - 默认=true)
ResourceLimitsPriorityFunction=true|false (ALPHA - 默认=false)
ResourceQuotaScopeSelectors=true|false (ALPHA - 默认=false)
RotateKubeletClientCertificate=true|false (BETA - 默认=true)
RotateKubeletServerCertificate=true|false (ALPHA - 默认=false)
RunAsGroup=true|false (ALPHA - 默认=false)
ScheduleDaemonSetPods=true|false (ALPHA - 默认=false)
ServiceNodeExclusion=true|false (ALPHA - 默认=false)
ServiceProxyAllowExternalIPs=true|false (弃用 - 默认=false)
StorageObjectInUseProtection=true|false (默认=true)
StreamingProxyRedirects=true|false (BETA - 默认=true)
SupportIPVSProxyMode=true|false (默认=true)
SupportPodPidsLimit=true|false (ALPHA - 默认=false)
Sysctls=true|false (BETA - 默认=true)
TaintBasedEvictions=true|false (ALPHA - 默认=false)
TaintNodesByCondition=true|false (ALPHA - 默认=false)
TokenRequest=true|false (ALPHA - 默认=false)
TokenRequestProjection=true|false (ALPHA - 默认=false)
VolumeScheduling=true|false (BETA - 默认=true)
VolumeSubpath=true|false (默认=true)
VolumeSubpathEnvExpansion=true|false (ALPHA - 默认=false)
-h, --help
kube-scheduler 帮助信息
--kube-api-burst int32     默认: 100
弃用: 每秒与 kubernetes apiserver 交互的数量
--kube-api-content-type string     默认: "application/vnd.kubernetes.protobuf"
弃用: 发送到 apiserver 的请求的内容类型
--kube-api-qps float32     默认: 50
弃用: 与 kubernetes apiserver 交互时使用的 QPS
--kubeconfig string
弃用: 包含授权和 master 位置信息的 kubeconfig 文件的路径。
--leader-elect     默认: true
在执行主循环之前,启动 leader 选举客户端并获得领导能力。在运行复制组件以实现高可用性时启用此选项。
--leader-elect-lease-duration duration     默认: 15s
非 leader 候选人在观察领导层续约之后将等待的时间,直到试图获得领导但尚未更新的 leader 位置。这实际上是 leader 在被另一个候选人替换之前可以停止的最长持续时间。这仅适用于启用 leader 选举的情况。
--leader-elect-renew-deadline duration     默认: 10s
代理 master 在停止领导之前更新领导位置的时间间隔。这必须小于或等于租约期限。这仅适用于启用 leader 选举的情况
--leader-elect-resource-lock endpoints     默认: "endpoints"
在 leader 选举期间用于锁定的资源对象的类型。支持的选项是 endpoints (默认) 和 `configmaps`。
--leader-elect-retry-period duration     默认: 2s
客户端在尝试获取和更新领导之间应该等待的持续时间。这仅适用于启用leader选举的情况。
--lock-object-name string     默认: "kube-scheduler"
弃用: 定义锁对象的名称。
--lock-object-namespace string     默认: "kube-system"
弃用: 定义锁对象的命名空间。
--log-flush-frequency duration     默认: 5s
日志刷新最大间隔
--master string
Kubernetes API 服务器的地址(覆盖 kubeconfig 中的任何值)
--policy-config-file string
弃用: 包含调度器策略配置的文件。如果未提供策略 ConfigMap 或 --use-legacy-policy-config==true,则使用此文件
--policy-configmap string
弃用: 包含调度器策略配置的 ConfigMap 对象的名称。如果 --use-legacy-policy-config==false,它必须在调度器初始化之前存在于系统命名空间中。配置必须作为 'Data' 映射中元素的值提供,其中 key='policy.cfg'
--policy-configmap-namespace string     默认: "kube-system"
弃用: 策略 ConfigMap 所在的命名空间。 如果未提供此命名空间或为空,则将使用系统命名空间。
--port int     默认: 10251
弃用: 不安全地提供没有身份验证和授权的 HTTP 端口。 如果为0,则根本不提供 HTTPS。 请参阅 --secure-port。
--profiling
弃用: 通过 web 接口 host:port/debug/pprof/ 启动性能分析
--scheduler-name string     默认: "default-scheduler"
弃用: 调度器名称,用于根据 pod 的 "spec.SchedulerName" 选择哪些 pod 将被此调度器处理。
--use-legacy-policy-config
弃用: 当设置为 true 时,调度器将忽略策略 ConfigMap 并使用策略配置文件
--version version[=true]
打印版本信息并退出
--write-config-to string
如果设置,将配置值写入此文件并退出。
diff --git a/content/zh/docs/reference/command-line-tools-reference/kubelet.md b/content/zh/docs/reference/command-line-tools-reference/kubelet.md new file mode 100644 index 0000000000..0413ade7d9 --- /dev/null +++ b/content/zh/docs/reference/command-line-tools-reference/kubelet.md @@ -0,0 +1,112 @@ +--- +title: kubelet +notitle: true +--- +## kubelet + + + + +### 概要 + + + +kubelet 是在每个节点上运行的主要 "节点代理"。kubelet 以 PodSpec 为单位来运行任务,PodSpec 是一个描述 pod 的 YAML 或 JSON 对象。 +kubelet 运行多种机制(主要通过 apiserver)提供的一组 PodSpec,并确保这些 PodSpecs 中描述的容器健康运行。 +不是 Kubernetes 创建的容器将不在 kubelet 的管理范围。 + + +除了来自 apiserver 的 PodSpec 之外,还有三种方法可以将容器清单提供给 Kubelet。 + +文件:通过命令行传入的文件路径。kubelet 将定期监听该路径下的文件以获得更新。监视周期默认为 20 秒,可通过参数进行配置。 + +HTTP 端点:HTTP 端点以命令行参数传入。每 20 秒检查一次该端点(该时间间隔也是可以通过命令行配置的)。 + +HTTP 服务:kubelet 还可以监听 HTTP 并响应简单的 API(当前未指定)以提交新的清单。 + +``` +kubelet [flags] +``` + + +### 选项 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
--azure-container-registry-config string
包含 Azure 容器注册配置信息的文件路径
-h, --help
kubelet 的帮助信息
--log-flush-frequency 间隔     默认: 5s
日志刷新间隔的最大秒数
--version version[=true]
打印版本信息并退出
+ + + diff --git a/content/zh/docs/reference/kubectl/kubectl.md b/content/zh/docs/reference/kubectl/kubectl.md new file mode 100644 index 0000000000..052ce700a6 --- /dev/null +++ b/content/zh/docs/reference/kubectl/kubectl.md @@ -0,0 +1,178 @@ +--- +title: kubectl +notitle: true +--- + +## kubectl + +kubectl Բٿ Kubernetes Ⱥ + + +### + +kubectl Բٿ Kubernetes Ⱥ + +ȡϢʣhttps://kubernetes.io/docs/reference/kubectl/overview/ + +``` +kubectl [flags] +``` + +### ѡ +``` + --alsologtostderr ͬʱ־׼̨ļ + --as string ָûִв + --as-group stringArray ģ飬ʹʶָ顣 + --cache-dir string Ĭ HTTP Ŀ¼Ĭֵ "/home/username/.kube/http-cache" + --certificate-authority string ڽ֤Ȩ .cert ļ· + --client-certificate string TLS ʹõĿͻ֤· + --client-key string TLS ʹõĿͻԿļ· + --cluster string ָҪʹõ kubeconfig ļмȺ + --context string ָҪʹõ kubeconfig ļ + -h, --help kubectl + --insecure-skip-tls-verify ֵΪ true򲻻֤Чԡ ⽫ʹHTTPSӲȫ + --kubeconfig string CLI ʹõ kubeconfig ļ· + --log-backtrace-at traceLocation ־ȳ涨ʱԶջϢĬֵ0 + --log-dir string Ϊգ־ļдĿ¼ + --logtostderr ־׼̨ļ + --match-server-version Ҫͻ˰汾ͷ˰汾ƥ + -n, --namespace string ڣCLI ʹôռ + --request-timeout string һ򵥷ǰĵȴʱ䣬ֵҪӦʱ䵥λ(磺1s, 2m, 3h)ֵΪʱ (Ĭֵ "0") + -s, --server string Kubernetes API server ĵַͶ˿ + --stderrthreshold severity ڻڴֵ־׼̨Ĭֵ2 + --token string API server ֤ij + --user string ָʹõ kubeconfig ļеû + -v, --v Level ָ־־ + --vmodule moduleSpec ָ־ģ飬ʽ£pattern=Nʹöŷָ +``` + +### + +* [kubectl alpha](kubectl_alpha.md) - alpha +* [kubectl annotate](kubectl_annotate.md) - Դע +* [kubectl api-resources](kubectl_api-resources.md) - ڷϴӡֵ֧ API Դ +* [kubectl api-versions](kubectl_api-versions.md) - "group/version" ʽڷϴӡֵ֧ API 汾 +* [kubectl apply](kubectl_apply.md) - ͨļ׼뽫ӸԴ +* [kubectl attach](kubectl_attach.md) - ӵе +* [kubectl auth](kubectl_auth.md) - Ȩ +* [kubectl autoscale](kubectl_autoscale.md) - Զչ Deployment, ReplicaSet ReplicationController +* [kubectl certificate](kubectl_certificate.md) - ޸֤Դ +* [kubectl cluster-info](kubectl_cluster-info.md) - չʾȺϢ +* [kubectl completion](kubectl_completion.md) - Ϊ shell ɴ루 bash zsh +* [kubectl config](kubectl_config.md) - ޸ kubeconfig ļ +* [kubectl convert](kubectl_convert.md) - ڲͬ API 汾֮תļ +* [kubectl cordon](kubectl_cordon.md) - node ڵΪɵ +* [kubectl cp](kubectl_cp.md) - ļĿ¼ҲɽļĿ¼Ƶ +* [kubectl create](kubectl_create.md) - ͨļ׼봴Դ +* [kubectl delete](kubectl_delete.md) - ͨļ׼룬ԴƻԴͱǩѡɾԴ +* [kubectl describe](kubectl_describe.md) - ʾضԴԴϸϢ +* [kubectl drain](kubectl_drain.md) - ΪάҪǰnodeڵ +* [kubectl edit](kubectl_edit.md) - ڷ༭Դ +* [kubectl exec](kubectl_exec.md) - ˳ +* [kubectl explain](kubectl_explain.md) - Դĵ +* [kubectl expose](kubectl_expose.md) - ȡ replication controller, service, deployment pod ԴΪµ Kubernetes ¶ +* [kubectl get](kubectl_get.md) - չʾһԴ +* [kubectl label](kubectl_label.md) - Դǩ +* [kubectl logs](kubectl_logs.md) - Ϊ pod еӡ־ +* [kubectl options](kubectl_options.md) - ӡ̳еıʶб +* [kubectl patch](kubectl_patch.md) - ʹսԺϲԴֶ +* [kubectl plugin](kubectl_plugin.md) - в +* [kubectl port-forward](kubectl_port-forward.md) - pod һض˿ +* [kubectl proxy](kubectl_proxy.md) - Ϊ Kubernetes API server д +* [kubectl replace](kubectl_replace.md) - ͨļ׼滻Դ +* [kubectl rollout](kubectl_rollout.md) - Դչʾ +* [kubectl run](kubectl_run.md) - ڼȺָ +* [kubectl scale](kubectl_scale.md) - Deployment, ReplicaSet, Replication Controller Job ¸ģ +* [kubectl set](kubectl_set.md) - ض +* [kubectl taint](kubectl_taint.md) - һ node ڵ۵Ϣ +* [kubectl top](kubectl_top.md) - չʾԴ (CPU/Memory/Storage) ʹϢ +* [kubectl uncordon](kubectl_uncordon.md) - node ڵΪɵ +* [kubectl version](kubectl_version.md) - ӡͻ˺ͷ˰汾Ϣ +* [kubectl wait](kubectl_wait.md) - : һԴϵȴ + + +######2018616գͨspf13/cobraԶ + diff --git a/content/cn/docs/reference/labels-annotations-taints.md b/content/zh/docs/reference/labels-annotations-taints.md similarity index 100% rename from content/cn/docs/reference/labels-annotations-taints.md rename to content/zh/docs/reference/labels-annotations-taints.md diff --git a/content/zh/docs/reference/tools.md b/content/zh/docs/reference/tools.md new file mode 100644 index 0000000000..4fa74d6821 --- /dev/null +++ b/content/zh/docs/reference/tools.md @@ -0,0 +1,109 @@ + +--- +reviewers: +- janetkuo +title: +content_template: templates/concept +--- + + +{{% capture overview %}} +Kubernetes һЩùߣ԰ûõʹ Kubernetes ϵͳ +{{% /capture %}} + +{{% capture body %}} +## Kubectl + + +[`kubectl`](/docs/tasks/tools/install-kubectl/) Kubernetes йߣٿ Kubernetes Ⱥ + +## Kubeadm + + +[`kubeadm`](/docs/tasks/tools/install-kubeadm/) һйߣƷĿǰ alpha ׶Σɲһȫɿ Kubernetes Ⱥ + +## Kubefed + + +[`kubefed`](/docs/tasks/federation/set-up-cluster-federation-kubefed/) һйߣûȺ + + +## Minikube + + +[`minikube`](/docs/tasks/tools/install-minikube/) һԷû乤վ㱾زһڵ Kubernetes ȺĹߣڿͲԡ + + +## Dashboard + + +[`Dashboard`](/docs/tasks/access-application-cluster/web-ui-dashboard/), Kubernetes Web û棬ûӦõ Kubernetes ȺйŲԼȺͼȺԴ + +## Helm + + +[`Kubernetes Helm`](https://github.com/kubernetes/helm) һԤ Kubernetes ԴĹߣԴ Helm Ҳ Kubernetes charts + + +ʹ Helm + +*ҲʹѾΪ Kubernetes charts +*ԼӦΪ Kubernetes charts +*Ϊ Kubernetes ӦôظִеĹ +*Ϊ Kubernetes 嵥ļṩܻĹ +* Helm ķ + +## Kompose + + +[`Kompose`](https://github.com/kubernetes-incubator/kompose) һתߣ Docker Compose ûǨ Kubernetes + + +ʹ Kompose: + +* һ Docker Compose ļͳ Kubernetes +* Docker תͨ Kubernetes +* ת v1 v2 Docker Compose `yaml` ļ [ֲʽӦó](https://docs.docker.com/compose/bundles/) +{{% /capture %}} \ No newline at end of file diff --git a/content/zh/docs/setup/salt.md b/content/zh/docs/setup/salt.md new file mode 100755 index 0000000000..aa5ef2a87d --- /dev/null +++ b/content/zh/docs/setup/salt.md @@ -0,0 +1,244 @@ +--- +cn-approvers: +- linyouchong +reviewers: +- davidopp +title: 使用 Salt 配置 Kubernetes 集群 +weight: 70 +content_template: templates/concept +--- + + +{{% capture overview %}} + + +Kubernetes 集群可以使用 Salt 进行配置 + + +这些 Salt 脚本可以跨多个托管提供商共享,这取决于您在何处托管 Kubernetes 集群,您可能正在使用多种不同的操作系统和多种不同的网络配置。因此,在做修改 Salt 配置之前了解一些背景信息是很重要的,以便在使用其他主机托管提供商时降低集群配置失败的可能。 + +{{% /capture %}} + +{{% capture body %}} + + +## 创建 Salt 集群 + + +**salt-master** 服务运行在 kubernetes-master 节点 [(除了在默认的 GCE 环境和 OpenStack-Heat 环境)](#standalone-salt-configuration-on-gce-and-others)。 + + +**salt-minion** 服务运行在 kubernetes-master 节点和每个 kubernetes-node 节点。 + + +每个 salt-minion 服务在 **master.conf** 文件中配置与 kubernetes-master 节点上的 **salt-master** 服务进行交互 [(除了 GCE 环境和 OpenStack-Heat 环境)](#standalone-salt-configuration-on-gce-and-others)。 + +```shell +cat /etc/salt/minion.d/master.conf +``` + +```none +master: kubernetes-master +``` + + +每个 salt-minion 都会与 salt-master 联系,根据其提供的机器信息,salt-master 会向其提供作为 kubernetes-master 或 kubernetes-node 用于运行 Kubernetes 所需要的能力。 + + +如果您正使用基于 Vagrant 的环境,**salt-api** 服务运行在 kubernetes-master 节点。它被配置为使 Vagrant 用户能够对 Salt 集群进行内省,以便通过 REST API 了解 Vagrant 环境中的机器的信息。 + + +## 在 GCE 和其它环境下独立配置 Salt + + +在 GCE 和 OpenStack 环境,使用 Openstack-Heat 提供商,master 和 node 节点被配置为 [standalone minions](http://docs.saltstack.com/en/latest/topics/tutorials/standalone_minion.html)。每个 VM 的配置都源于它的 [instance metadata](https://cloud.google.com/compute/docs/metadata) 并被保存在 Salt grains (`/etc/salt/minion.d/grains.conf`) 和本地 Salt 用于保存执行状态的 pillars (`/srv/salt-overlay/pillar/cluster-params.sls`) 中。 + + +对于 GCE 和 OpenStack ,所有引用 master/minion 设置的其余部分都应该被忽略。这种设置的一个后果是,Salt 不存在 - 节点之间不存在配置共享。 + + +## Salt 安全 + + +*(不适用于 默认的 GCE 和 OpenStack-Heat 配置环境。)* + + +salt-master 没有启用安全功能,salt-master 被配置为自动接受所有来自 minion 的接入请求。在深入研究之前,不推荐在生产环境中启用安全配置。(在某些环境中,如果 salt-master 端口不能从外部访问,并且您信任您的网络上的每个节点,这并不像它看起来那么糟糕) + +```shell +cat /etc/salt/master.d/auto-accept.conf +``` + +```shell +open_mode: True +auto_accept: True +``` + + +## 配置 Salt minion + + +Salt 集群中的每个 minion 都有一个相关的配置,它指示 salt-master 如何在机器上提供所需的资源。 + + +下面是一个基于 Vagrant 环境的示例文件: + +```shell +cat /etc/salt/minion.d/grains.conf +``` + +```yaml +grains: + etcd_servers: $MASTER_IP + cloud: vagrant + roles: + - kubernetes-master +``` + + +每个托管环境都使用了略微不同的 grains.conf 文件,用于在需要的 Salt 文件中构建条件逻辑。 + + +下面列举了目前支持的定义键/值对的集合。如果你添加了新的,请确保更新这个列表。 + + +键 | 值 +-----------------------------------|---------------------------------------------------------------- + +`api_servers` | (可选) IP 地址/主机名 ,kubelet 用其访问 kube-apiserver + +`cbr-cidr` | (可选) docker 容器网桥分配给 minion 节点的 IP 地址范围 + +`cloud` | (可选) 托管 Kubernetes 的 IaaS 平台, *gce*, *azure*, *aws*, *vagrant* + +`etcd_servers` | (可选) 以逗号分隔的 IP 地址列表,kube-apiserver 和 kubelet 使用其访问 etcd。kubernetes_master 角色的节点使用第一个机器的 IP ,在 GCE 环境上使用 127.0.0.1。 + +`hostnamef` | (可选) 机器的完整主机名,即:uname -n + +`node_ip` | (可选)用于定位本节点的 IP 地址 + +`hostname_override` | (可选)对应 kubelet 的 hostname-override 参数 + +`network_mode` | (可选)节点间使用的网络模型:*openvswitch* + +`networkInterfaceName` | (可选)用于绑定地址的网络接口,默认值 *eth0* + +`publicAddressOverride` | (可选)kube-apiserver 用于外部只读访问而绑定的IP地址 + +`roles` | (必选)1、`kubernetes-master` 表示本节点是 Kubernetes 集群的 master。2、`kubernetes-pool` 表示本节点是一个 kubernetes-node。根据角色,Salt 脚本会在机器上提供不同的资源 + + +Salt sls 文件可以应用这些键到分支行为。 + + +此外,一个集群可能运行在基于 Debian 的操作系统或基于 Red Hat 的操作系统(Centos、Fedora、RHEL等)。因此,有时区分基于操作系统的行为(如果像下面这样的分支)是很重要的。 + +```liquid + +{% if grains['os_family'] == 'RedHat' %} +// something specific to a RedHat environment (Centos, Fedora, RHEL) where you may use yum, systemd, etc. +{% else %} +// something specific to Debian environment (apt-get, initd) +{% endif %} + +``` + + +## 最佳实践 + + +在为进程配置默认参数时,最好避免使用环境文件( Red Hat 环境中的 Systemd )或 init.d 文件( Debian 发行版)以保留在操作系统环境中应该通用的默认值。这有助于保持我们的 Salt 模板文件易于理解,因为管理员可能不熟悉每个发行版的细节。 + + +## 未来的增强(网络) + + +每个 pod IP 配置都是特定于提供商的,因此在进行网络更改时,必须将这些设置为沙箱,因为不同的提供商可能不会使用相同的机制( iptables 、openvswitch 等)。 + + +我们应该定义一个 grains.conf 键,这样能更明确地捕获正在使用的网络环境配置,以避免将来在不同的提供商之间产生混淆。 + +{{% /capture %}} \ No newline at end of file diff --git a/content/zh/docs/tasks/access-application-cluster/access-cluster.md b/content/zh/docs/tasks/access-application-cluster/access-cluster.md new file mode 100644 index 0000000000..3b6f66b203 --- /dev/null +++ b/content/zh/docs/tasks/access-application-cluster/access-cluster.md @@ -0,0 +1,573 @@ + +--- +title: 访问集群 +weight: 20 +content_template: templates/concept +--- + +{{% capture overview %}} + + +本文阐述多种与集群交互的方法。 + +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + + +## 使用 kubectl 完成集群的第一次访问 + +当您第一次访问 Kubernetes API 的时候,我们建议您使用 Kubernetes CLI,`kubectl`。 + +访问集群时,您需要知道集群的地址并且拥有访问的凭证。通常,这些在您通过 [Getting started guide](/docs/setup/) 安装集群时都是自动安装好的,或者其他人安装时也应该提供了凭证和集群地址。 + +通过以下命令检查 kubectl 是否知道集群地址及凭证: + +```shell +$ kubectl config view +``` + + +有许多 [例子](/docs/user-guide/kubectl-cheatsheet) 介绍了如何使用 kubectl,可以在 [kubectl手册](/docs/user-guide/kubectl-overview) 中找到更完整的文档。 + +## 直接访问 REST API +Kubectl 处理 apiserver 的定位和身份验证。 +如果要使用 curl 或 wget 等 http 客户端或浏览器直接访问 REST API,可以通过多种方式查找和验证: + + + - 以代理模式运行 kubectl。 + - 推荐此方式。 + - 使用已存储的 apiserver 地址。 + - 使用自签名的证书来验证 apiserver 的身份。杜绝 MITM 攻击。 + - 对 apiserver 进行身份验证。 + - 未来可能会实现智能化的客户端负载均衡和故障恢复。 + - 直接向 http 客户端提供位置和凭据。 + - 可选的方案。 + - 适用于代理可能引起混淆的某些客户端类型。 + - 需要引入根证书到您的浏览器以防止 MITM 攻击。 + + +### 使用 kubectl 代理 + +以下命令以反向代理的模式运行kubectl。它处理 apiserver 的定位和验证。 +像这样运行: + +```shell +$ kubectl proxy --port=8080 & +``` + + +参阅 [kubectl proxy](/docs/reference/generated/kubectl/kubectl-commands/#proxy) 获取更多详细信息。 + +然后,您可以使用 curl、wget 或浏览器访问 API,如果是 IPv6 则用 [::1] 替换 localhost,如下所示: + +```shell +$ curl http://localhost:8080/api/ +{ + "versions": [ + "v1" + ] +} +``` + + + +### 不使用 kubectl 代理 + +在 Kubernetes 1.3 或更高版本中,`kubectl config view` 不再显示 token。使用 `kubectl describe secret ...` 来获取默认服务帐户的 token,如下所示: + +```shell +$ APISERVER=$(kubectl config view | grep server | cut -f 2- -d ":" | tr -d " ") +$ TOKEN=$(kubectl describe secret $(kubectl get secrets | grep default | cut -f1 -d ' ') | grep -E '^token' | cut -f2 -d':' | tr -d '\t') +$ curl $APISERVER/api --header "Authorization: Bearer $TOKEN" --insecure +{ + "kind": "APIVersions", + "versions": [ + "v1" + ], + "serverAddressByClientCIDRs": [ + { + "clientCIDR": "0.0.0.0/0", + "serverAddress": "10.0.1.149:443" + } + ] +} +``` + + +上面的例子使用了 `--insecure` 参数,这使得它很容易受到 MITM 攻击。当 kubectl 访问集群时,它使用存储的根证书和客户端证书来访问服务器(这些安装在 `~/.kube` 目录中)。由于集群证书通常是自签名的,因此可能需要特殊配置才能让您的 http 客户端使用根证书。 + +在一些集群中,apiserver 不需要身份验证;它可能只服务于 localhost,或者被防火墙保护,这个没有一定的标准。 [配置对 API 的访问](/docs/admin/accessing-the-api) 描述了集群管理员如何进行配置。此类方法可能与未来的高可用性支持相冲突。 + + +## 以编程方式访问 API + +Kubernetes 官方提供对 [Go](#go-client) 和 [Python](#python-client) 的客户端库支持。 + +### Go 客户端 + +* 想要获得这个库,请运行命令:`go get k8s.io/client-go//kubernetes`。参阅 [https://github.com/kubernetes/client-go](https://github.com/kubernetes/client-go) 来查看目前支持哪些版本。 +* 基于这个 client-go 客户端库编写应用程序。 请注意,client-go 定义了自己的 API 对象,因此如果需要,请从 client-go 而不是从主存储库导入 API 定义,例如,`import "k8s.io/client-go/1.4/pkg/api/v1"` 才是对的。 + +Go 客户端可以像 kubectl CLI 一样使用相同的 [kubeconfig 文件](/docs/concepts/cluster-administration/authenticate-across-clusters-kubeconfig/) 来定位和验证 apiserver。可参阅 [示例](https://git.k8s.io/client-go/examples/out-of-cluster-client-configuration/main.go)。 + +如果应用程序以 Pod 的形式部署在集群中,那么请参阅 [下一章](#accessing-the-api-from-a-pod)。 + + +### Python 客户端 + +如果想要使用 [Python 客户端](https://github.com/kubernetes-client/python),请运行命令:`pip install kubernetes`。参阅 [Python Client Library page](https://github.com/kubernetes-client/python) 以获得更详细的安装参数。 + +Python 客户端可以像 kubectl CLI 一样使用相同的 [kubeconfig 文件](/docs/concepts/cluster-administration/authenticate-across-clusters-kubeconfig/) 来定位和验证 apiserver,可参阅 [示例](https://github.com/kubernetes-client/python/tree/master/examples/example1.py)。 + +### 其它语言 + +目前有多个 [客户端库](/docs/reference/using-api/client-libraries/) 为其它语言提供访问 API 的方法。 +参阅其它库的相关文档以获取他们是如何验证的。 + + +### 从 Pod 中访问 API + +当你从 Pod 中访问 API 时,定位和验证 apiserver 会有些许不同。 + +在 Pod 中定位 apiserver 的推荐方式是通过 `kubernetes.default.svc` 这个 DNS 名称,该名称将会解析为服务 IP,然后服务 IP 将会路由到 apiserver。 + +向 apiserver 进行身份验证的推荐方法是使用 [服务帐户](/docs/tasks/configure-pod-container/configure-service-account/) 凭据。 +通过 kube-system,pod 与服务帐户相关联,并且该服务帐户的凭证(token)被放置在该 pod 中每个容器的文件系统中,位于 `/var/run/secrets/kubernetes.io/serviceaccount/token`。 + + +如果可用,则将证书放入每个容器的文件系统中的 `/var/run/secrets/kubernetes.io/serviceaccount/ca.crt`,并且应该用于验证 apiserver 的服务证书。 + +最后,命名空间化的 API 操作所使用的默认命名空间将被放置在每个容器的 `/var/run/secrets/kubernetes.io/serviceaccount/namespace` 文件中。 + +在 pod 中,建议连接 API 的方法是: + + - 在 pod 的 sidecar 容器中运行 `kubectl proxy`,或者以后台进程的形式运行。 + 这将把 Kubernetes API 代理到当前 pod 的 localhost interface,所以 pod 中的所有容器中的进程都能访问它。 + - 使用 Go 客户端库,并使用 `rest.InClusterConfig()` 和 `kubernetes.NewForConfig()` 函数创建一个客户端。 + 他们处理 apiserver 的定位和身份验证。[示例](https://git.k8s.io/client-go/examples/in-cluster-client-configuration/main.go) + +在每种情况下,pod 的凭证都是为了与 apiserver 安全地通信。 + + +## 访问集群中正在运行的服务 + +上一节介绍了如何连接 Kubernetes API 服务。本节介绍如何连接到 Kubernetes 集群上运行的其他服务。 +在 Kubernetes 中,[节点](/docs/admin/node),[pods](/docs/user-guide/pods) 和 [服务](/docs/user-guide/services) 都有自己的 IP。 +在许多情况下,集群上的节点 IP,pod IP 和某些服务 IP 将无法路由,因此无法从集群外部的计算机(例如桌面计算机)访问它们。 + + +### 连接的方法 + +有多种方式可以从集群外部连接节点、pod 和服务: + + - 通过公共 IP 访问服务。 + - 类型为 `NodePort` 或 `LoadBalancer` 的服务,集群外部可以访问。 + 请参阅 [服务](/docs/user-guide/services) 和 [kubectl expose](/docs/reference/generated/kubectl/kubectl-commands/#expose) 文档。 + - 取决于您的集群环境,该服务可能仅暴露给您的公司网络,或者也可能暴露给整个互联网。 + 请考虑公开该服务是否安全。它是否进行自己的身份验证? + - 在服务后端放置 pod。要从一组副本中访问一个特定的 pod,例如进行调试,请在 pod 上放置一个唯一的标签,然后创建一个选择此标签的新服务。 + - 在大多数情况下,应用程序开发人员不应该通过其 nodeIP 直接访问节点。 + - 使用 Proxy Verb 访问服务、node 或者 pod。 + - 在访问远程服务之前进行 apiserver 身份验证和授权。 + 如果服务不能够安全地暴露到互联网,或者服务不能获得节点 IP 端口的访问权限,或者是为了 debug,那么请使用此选项。 + - 代理可能会给一些 web 应用带来问题。 + - 只适用于 HTTP/HTTPS。 + - 更多详细信息在 [这里]。 + - 从集群中的 node 或者 pod 中访问。 + - 运行一个 pod,然后使用 [kubectl exec](/docs/reference/generated/kubectl/kubectl-commands/#exec) 来连接 pod 里的 shell。 + 然后从 shell 中连接其它的节点、pod 和服务。 + - 有些集群可能允许您通过 ssh 连接到 node,从那您可能可以访问集群的服务。 + 这是一个非正式的方式,可能可以运行在个别的集群上。 + 浏览器和其它一些工具可能没有被安装。集群的 DNS 可能无法使用。 + + +### 发现内建服务 + +通常来说,集群中会有 kube-system 创建的一些运行的服务。 + +通过 `kubectl cluster-info` 命令获得这些服务列表: + +```shell +$ kubectl cluster-info + + Kubernetes master is running at https://104.197.5.247 + elasticsearch-logging is running at https://104.197.5.247/api/v1/namespaces/kube-system/services/elasticsearch-logging/proxy + kibana-logging is running at https://104.197.5.247/api/v1/namespaces/kube-system/services/kibana-logging/proxy + kube-dns is running at https://104.197.5.247/api/v1/namespaces/kube-system/services/kube-dns/proxy + grafana is running at https://104.197.5.247/api/v1/namespaces/kube-system/services/monitoring-grafana/proxy + heapster is running at https://104.197.5.247/api/v1/namespaces/kube-system/services/monitoring-heapster/proxy +``` + + +这展示了访问每个服务的 proxy-verb URL。 +例如,如果集群启动了集群级别的日志(使用 Elasticsearch),并且传递合适的凭证,那么可以通过 `https://104.197.5.247/api/v1/namespaces/kube-system/services/elasticsearch-logging/proxy/` 进行访问。日志也能通过 kubectl 代理获取,例如: +`http://localhost:8080/api/v1/namespaces/kube-system/services/elasticsearch-logging/proxy/`。 +(参阅 [上面的内容](#accessing-the-cluster-api) 来获取如何使用 kubectl 代理来传递凭证) + + +#### 手动构建 apiserver 代理 URL + +如上所述,您可以使用 `kubectl cluster-info` 命令来获得服务的代理 URL。要创建包含服务端点、后缀和参数的代理 URL,只需添加到服务的代理 URL: +`http://`*`kubernetes_master_address`*`/api/v1/namespaces/`*`namespace_name`*`/services/`*`service_name[:port_name]`*`/proxy` + +如果尚未为端口指定名称,则不必在 URL 中指定 *port_name*。 + +默认情况下,API server 使用 http 代理您的服务。要使用 https,请在服务名称前加上 `https:`: +`http://`*`kubernetes_master_address`*`/api/v1/namespaces/`*`namespace_name`*`/services/`*`https:service_name:[port_name]`*`/proxy` + +URL 名称段支持的格式为: + +* `` - 使用 http 代理到默认或未命名的端口 +* `:` - 使用 http 代理到指定的端口 +* `https::` - 使用 https 代理到默认或未命名的端口(注意后面的冒号) +* `https::` - 使用 https 代理到指定的端口 + + +##### 示例 + + * 要访问 Elasticsearch 服务端点 `_search?q=user:kimchy`,您需要使用:`http://104.197.5.247/api/v1/namespaces/kube-system/services/elasticsearch-logging/proxy/_search?q=user:kimchy` + * 要访问 Elasticsearch 集群健康信息 `_cluster/health?pretty=true`,您需要使用:`https://104.197.5.247/api/v1/namespaces/kube-system/services/elasticsearch-logging/proxy/_cluster/health?pretty=true` + +```json + { + "cluster_name" : "kubernetes_logging", + "status" : "yellow", + "timed_out" : false, + "number_of_nodes" : 1, + "number_of_data_nodes" : 1, + "active_primary_shards" : 5, + "active_shards" : 5, + "relocating_shards" : 0, + "initializing_shards" : 0, + "unassigned_shards" : 5 + } +``` + + +### 使用 web 浏览器访问运行在集群上的服务 + +您可以在浏览器地址栏中输入 apiserver 代理 URL。但是: + + - Web 浏览器通常不能传递 token,因此您可能需要使用基本(密码)身份验证。Apiserver 可以配置为接受基本身份验证,但您的集群可能未进行配置。 + - 某些 Web 应用程序可能无法运行,尤其是那些使用客户端 javascript 以不知道代理路径前缀的方式构建 URL 的应用程序。 + + +## 请求重定向 + +已弃用并删除了重定向功能。请改用代理(见下文)。 + + +## 多种代理 + +使用 Kubernetes 时可能会遇到几种不同的代理: + +1. [kubectl 代理](#directly-accessing-the-rest-api): + + - 在用户的桌面或 pod 中运行 + - 代理从本地主机地址到 Kubernetes apiserver + - 客户端到代理将使用 HTTP + - 代理到 apiserver 使用 HTTPS + - 定位 apiserver + - 添加身份验证 header + + +1. [apiserver 代理](#discovering-builtin-services): + + - 内置于 apiserver 中 + - 将集群外部的用户连接到集群 IP,否则这些 IP 可能无法访问 + - 运行在 apiserver 进程中 + - 客户端代理使用 HTTPS(也可配置为 http) + - 代理将根据可用的信息决定使用 HTTP 或者 HTTPS 代理到目标 + - 可用于访问节点、Pod 或服务 + - 在访问服务时进行负载平衡 + + +1. [kube proxy](/docs/concepts/services-networking/service/#ips-and-vips): + + - 运行在每个节点上 + - 代理 UDP 和 TCP + - 不能代理 HTTP + - 提供负载均衡 + - 只能用来访问服务 + + +1. 位于 apiserver 之前的 Proxy/Load-balancer: + + - 存在和实现因集群而异(例如 nginx) + - 位于所有客户和一个或多个 apiserver 之间 + - 如果有多个 apiserver,则充当负载均衡器 + + +1. 外部服务上的云负载均衡器: + + - 由一些云提供商提供(例如 AWS ELB,Google Cloud Load Balancer) + - 当 Kubernetes 服务类型为 `LoadBalancer` 时自动创建 + - 只使用 UDP/TCP + - 具体实现因云提供商而异。 + +除了前两种类型之外,Kubernetes 用户通常不需要担心任何其他问题。集群管理员通常会确保后者的正确配置。 + +{{% /capture %}} diff --git a/content/cn/docs/tasks/access-application-cluster/communicate-containers-same-pod-shared-volume.md b/content/zh/docs/tasks/access-application-cluster/communicate-containers-same-pod-shared-volume.md similarity index 100% rename from content/cn/docs/tasks/access-application-cluster/communicate-containers-same-pod-shared-volume.md rename to content/zh/docs/tasks/access-application-cluster/communicate-containers-same-pod-shared-volume.md diff --git a/content/cn/docs/tasks/access-application-cluster/configure-access-multiple-clusters.md b/content/zh/docs/tasks/access-application-cluster/configure-access-multiple-clusters.md similarity index 100% rename from content/cn/docs/tasks/access-application-cluster/configure-access-multiple-clusters.md rename to content/zh/docs/tasks/access-application-cluster/configure-access-multiple-clusters.md diff --git a/content/cn/docs/tasks/access-application-cluster/configure-cloud-provider-firewall.md b/content/zh/docs/tasks/access-application-cluster/configure-cloud-provider-firewall.md similarity index 100% rename from content/cn/docs/tasks/access-application-cluster/configure-cloud-provider-firewall.md rename to content/zh/docs/tasks/access-application-cluster/configure-cloud-provider-firewall.md diff --git a/content/zh/docs/tasks/access-application-cluster/configure-dns-cluster.md b/content/zh/docs/tasks/access-application-cluster/configure-dns-cluster.md new file mode 100644 index 0000000000..48cc0a019a --- /dev/null +++ b/content/zh/docs/tasks/access-application-cluster/configure-dns-cluster.md @@ -0,0 +1,26 @@ + +--- +title: 为集群配置 DNS +weight: 120 +content_template: templates/concept +--- + +{{% capture overview %}} + +Kubernetes 提供 DNS 集群插件,大多数支持的环境默认情况下都会启用。 +{{% /capture %}} +{{% capture body %}} + +有关如何为 Kubernetes 集群配置 DNS 的详细信息,请参阅 [Kubernetes DNS 插件示例.](https://github.com/kubernetes/kubernetes/tree/release-1.5/examples/cluster-dns) + +{{% /capture %}} diff --git a/content/cn/docs/tasks/access-application-cluster/connecting-frontend-backend.md b/content/zh/docs/tasks/access-application-cluster/connecting-frontend-backend.md similarity index 98% rename from content/cn/docs/tasks/access-application-cluster/connecting-frontend-backend.md rename to content/zh/docs/tasks/access-application-cluster/connecting-frontend-backend.md index 74ba22eaa4..0c12f2410d 100644 --- a/content/cn/docs/tasks/access-application-cluster/connecting-frontend-backend.md +++ b/content/zh/docs/tasks/access-application-cluster/connecting-frontend-backend.md @@ -34,7 +34,7 @@ content_template: templates/tutorial * 本任务使用 [外部负载均衡服务](/docs/tasks/access-application-cluster/create-external-load-balancer/), 所以需要对应的可支持此功能的环境。如果你的环境不能支持,你可以使用 - [NodePort](/docs/user-guide/services/#nodeport) 类型的服务代替。 + [NodePort](/docs/user-guide/services/#type-nodeport) 类型的服务代替。 {{% /capture %}} diff --git a/content/zh/docs/tasks/access-application-cluster/create-external-load-balancer.md b/content/zh/docs/tasks/access-application-cluster/create-external-load-balancer.md new file mode 100644 index 0000000000..45ba1aa7e8 --- /dev/null +++ b/content/zh/docs/tasks/access-application-cluster/create-external-load-balancer.md @@ -0,0 +1,322 @@ + +--- +title: 创建一个外部负载均衡器 +content_template: templates/task +weight: 80 +--- + + +{{% capture overview %}} + + +本文展示如何创建一个外部负载均衡器。 + +创建服务时,您可以选择自动创建云网络负载均衡器。这提供了一个外部可访问的 IP 地址,可将流量分配到集群节点上的正确端口上 _假设集群在支持的环境中运行,并配置了正确的云负载平衡器提供商包_。 + +有关如何配置和使用 Ingress 资源以为服务提供外部可访问的 URL、负载均衡流量、终止 SSL 等功能,请查看 [Ingress](/docs/concepts/services-networking/ingress/) 文档。 + +{{% /capture %}} + +{{% capture prerequisites %}} + +* {{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + +{{% /capture %}} + +{{% capture steps %}} + + +## 配置文件 + +要创建外部负载均衡器,请将以下内容添加到 [服务配置文件](/docs/concepts/services-networking/service/#type-loadbalancer): + +```json + "type": "LoadBalancer" +``` + + +您的配置文件可能会如下所示: + +```json + { + "kind": "Service", + "apiVersion": "v1", + "metadata": { + "name": "example-service" + }, + "spec": { + "ports": [{ + "port": 8765, + "targetPort": 9376 + }], + "selector": { + "app": "example" + }, + "type": "LoadBalancer" + } + } +``` + + +## 使用 kubectl + +您也可以使用 `kubectl expose` 命令及其 `--type=LoadBalancer` 参数创建服务: + +```bash +kubectl expose rc example --port=8765 --target-port=9376 \ + --name=example-service --type=LoadBalancer +``` + + +此命令通过使用与引用资源(在上面的示例的情况下,名为 `example` 的 replication controller)相同的选择器来创建一个新的服务。 + +更多信息(包括更多的可选参数),请参阅 [`kubectl expose` reference](/docs/reference/generated/kubectl/kubectl-commands/#expose)。 + + +## 找到您的 IP 地址 + +您可以通过 `kubectl` 获取服务信息,找到为您的服务创建的 IP 地址: + +```bash +kubectl describe services example-service +``` + + +这将获得如下输出: + +```bash + Name: example-service + Namespace: default + Labels: + Annotations: + Selector: app=example + Type: LoadBalancer + IP: 10.67.252.103 + LoadBalancer Ingress: 123.45.678.9 + Port: 80/TCP + NodePort: 32445/TCP + Endpoints: 10.64.0.4:80,10.64.1.5:80,10.64.2.4:80 + Session Affinity: None + Events: +``` + + +IP 地址列在 `LoadBalancer Ingress` 旁边。 + +{{< note >}} + +**注意:** 如果您在 Minikube 上运行服务,您可以通过以下命令找到分配的 IP 地址和端口: +{{< /note >}} +```bash +minikube service example-service --url +``` + + +## 保留客户端源 IP + +由于此功能的实现,目标容器中看到的源 IP 将 *不是客户端的原始源 IP*。要启用保留客户端 IP,可以在服务的 spec 中配置以下字段(支持 GCE/Google Kubernetes Engine 环境): + +* `service.spec.externalTrafficPolicy` - 表示此服务是否希望将外部流量路由到节点本地或集群范围的端点。有两个可用选项:"Cluster"(默认)和 "Local"。"Cluster" 隐藏了客户端源 IP,可能导致第二跳到另一个节点,但具有良好的整体负载分布。 "Local" 保留客户端源 IP 并避免 LoadBalancer 和 NodePort 类型服务的第二跳,但存在潜在的不均衡流量传播风险。 +* `service.spec.healthCheckNodePort` - 指定服务的 healthcheck nodePort(数字端口号)。如果未指定,则 serviceCheckNodePort 由服务 API 后端使用已分配的 nodePort 创建。如果客户端指定,它将使用客户端指定的 nodePort 值。仅当 type 设置为 "LoadBalancer" 并且 externalTrafficPolicy 设置为 "Local" 时才生效。 + +可以通过在服务的配置文件中将 `externalTrafficPolicy` 设置为 "Local" 来激活此功能。 + +```json + { + "kind": "Service", + "apiVersion": "v1", + "metadata": { + "name": "example-service" + }, + "spec": { + "ports": [{ + "port": 8765, + "targetPort": 9376 + }], + "selector": { + "app": "example" + }, + "type": "LoadBalancer", + "externalTrafficPolicy": "Local" + } + } +``` + + +### 特性可用性 + +| k8s 版本 | 特性支持 | +| :---------: |:-----------:| +| 1.7+ | 支持完整的 API 字段 | +| 1.5 - 1.6 | 支持 Beta Annotation | +| <1.5 | 不支持 | + +您可以在下面找到已弃用的 Beta annotation,在稳定版本前使用它来使用该功能。较新的 Kubernetes 版本可能会在 v1.7 之后停止支持这些功能。 +请更新现有应用程序以直接使用这些字段。 + +* `service.beta.kubernetes.io/external-traffic` annotation <-> `service.spec.externalTrafficPolicy` 字段 +* `service.beta.kubernetes.io/healthcheck-nodeport` annotation <-> `service.spec.healthCheckNodePort` 字段 + +`service.beta.kubernetes.io/external-traffic` annotation 与 `service.spec.externalTrafficPolicy` 字段相比拥有一组不同的值。值匹配如下: + +* "OnlyLocal" annotation <-> "Local" 字段 +* "Global" annotation <-> "Cluster" 字段 + +**请注意,此功能目前尚未实现在所有云提供商/环境中。** + + +已知的问题: + +* AWS: [kubernetes/kubernetes#35758](https://github.com/kubernetes/kubernetes/issues/35758) +* Weave-Net: [weaveworks/weave/#2924](https://github.com/weaveworks/weave/issues/2924) + +{{% /capture %}} + +{{% capture discussion %}} + + +## 外部负载均衡器提供商 + +请务必注意,此功能的数据路径由 Kubernetes 集群外部的负载均衡器提供。 + +当服务类型设置为 `LoadBalancer` 时,Kubernetes 向集群中的 pod 提供与 `type=` 等效的功能,并通过使用 Kubernetes pod 的条目对负载均衡器(从外部到 Kubernetes)进行编程来扩展它。 Kubernetes 服务控制器自动创建外部负载均衡器,健康检查(如果需要),防火墙规则(如果需要),并获取云提供商分配的外部 IP 并将其填充到服务对象中。 + + +## 保留源 IP 时的注意事项和限制 + +GCE/AWS 负载均衡器不为其目标池提供权重。对于旧的 LB kube-proxy 规则来说,这不是一个问题,它可以在所有端点之间正确平衡。 + +使用新功能,外部流量不会在 pod 之间平均负载,而是在节点级别平均负载(因为 GCE/AWS 和其他外部 LB 实现无法指定每个节点的权重,因此它们的平衡跨所有目标节点,并忽略每个节点上的 pod 数量)。 + +但是,我们可以声明,对于 NumServicePods << NumNodes 或 NumServicePods >> NumNodes 时,即使没有权重,也会看到接近相等的分布。 + +一旦外部负载平衡器提供权重,就可以将此功能添加到 LB 编程路径中。 +*未来工作:1.4 版本不提供权重支持,但可能会在将来版本中添加* + +内部 pod 到 pod 的流量应该与 ClusterIP 服务类似,所有 pod 的概率相同。 + +{{% /capture %}} + + diff --git a/content/cn/docs/tasks/access-application-cluster/frontend.yaml b/content/zh/docs/tasks/access-application-cluster/frontend.yaml similarity index 100% rename from content/cn/docs/tasks/access-application-cluster/frontend.yaml rename to content/zh/docs/tasks/access-application-cluster/frontend.yaml diff --git a/content/cn/docs/tasks/access-application-cluster/frontend/frontend.conf b/content/zh/docs/tasks/access-application-cluster/frontend/frontend.conf similarity index 100% rename from content/cn/docs/tasks/access-application-cluster/frontend/frontend.conf rename to content/zh/docs/tasks/access-application-cluster/frontend/frontend.conf diff --git a/content/cn/docs/tasks/access-application-cluster/hello-service.yaml b/content/zh/docs/tasks/access-application-cluster/hello-service.yaml similarity index 100% rename from content/cn/docs/tasks/access-application-cluster/hello-service.yaml rename to content/zh/docs/tasks/access-application-cluster/hello-service.yaml diff --git a/content/cn/docs/tasks/access-application-cluster/hello.yaml b/content/zh/docs/tasks/access-application-cluster/hello.yaml similarity index 100% rename from content/cn/docs/tasks/access-application-cluster/hello.yaml rename to content/zh/docs/tasks/access-application-cluster/hello.yaml diff --git a/content/zh/docs/tasks/access-application-cluster/list-all-running-container-images.md b/content/zh/docs/tasks/access-application-cluster/list-all-running-container-images.md new file mode 100644 index 0000000000..a376b4c098 --- /dev/null +++ b/content/zh/docs/tasks/access-application-cluster/list-all-running-container-images.md @@ -0,0 +1,193 @@ + +--- +title: 列出集群中所有运行容器的镜像 +content_template: templates/task +weight: 100 +--- + +{{% capture overview %}} + + +本文展示如何使用 kubectl 来列出集群中所有运行 pod 的容器的镜像 + +{{% /capture %}} + +{{% capture prerequisites %}} + +{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + +{{% /capture %}} + +{{% capture steps %}} + + +在本练习中,您将使用 kubectl 来获取集群中运行的所有 Pod,并格式化输出来提取每个 pod 中的容器列表。 + + +## 列出所有命名空间下的所有容器 + +- 使用 `kubectl get pods --all-namespaces` 获取所有命名空间下的所有 Pod +- 使用 `-o jsonpath={..image}` 来格式化输出,以仅包含容器镜像名称。 + 这将以递归方式从返回的 json 中解析出 `image` 字段。 + - 参阅 [jsonpath reference](/docs/user-guide/jsonpath/) 来获取更多关于如何使用 jsonpath 的信息。 +- 使用标准化工具来格式化输出:`tr`, `sort`, `uniq` + - 使用 `tr` 以用换行符替换空格 + - 使用 `sort` 来对结果进行排序 + - 使用 `uniq` 来聚合镜像计数 + +```sh +kubectl get pods --all-namespaces -o jsonpath="{..image}" |\ +tr -s '[[:space:]]' '\n' |\ +sort |\ +uniq -c +``` + + +上面的命令将递归获取所有返回项目的名为 `image` 的字段。 + +作为替代方案,可以使用 Pod 的镜像字段的绝对路径。这确保即使字段名称重复的情况下也能检索到正确的字段,例如,特定项目中的许多字段都称为 `name`: + +```sh +kubectl get pods --all-namespaces -o jsonpath="{.items[*].spec.containers[*].image}" +``` + + +jsonpath 解释如下: + +- `.items[*]`: 对于每个返回的值 +- `.spec`: 获取 spec +- `.containers[*]`: 对于每个容器 +- `.image`: 获取镜像 + +{{< note >}} + +**注意:** 按名字获取单个 Pod 时,例如 `kubectl get pod nginx`,路径的 `.items[*]` 部分应该省略,因为返回的是一个 Pod 而不是一个项目列表。 +{{< /note >}} + + +## 列出 Pod 中的容器 + +可以使用 `range` 操作进一步控制格式化,以单独操作每个元素。 + +```sh +kubectl get pods --all-namespaces -o=jsonpath='{range .items[*]}{"\n"}{.metadata.name}{":\t"}{range .spec.containers[*]}{.image}{", "}{end}{end}' |\ +sort +``` + + +## 列出以 label 过滤后的 Pod 的所有容器 + +要获取匹配特定标签的 Pod,请使用 -l 参数。以下匹配仅与标签 `app=nginx` 相符的 Pod。 + +```sh +kubectl get pods --all-namespaces -o=jsonpath="{..image}" -l app=nginx +``` + + +## 列出以命名空间过滤后的 Pod 的所有容器 + +要获取匹配特定命名空间的 Pod,请使用 namespace 参数。以下仅匹配 `kube-system` 命名空间下的 Pod。 + +```sh +kubectl get pods --namespace kube-system -o jsonpath="{..image}" +``` + + +## 使用 go-template 代替 jsonpath 来获取容器 + +作为 jsonpath 的替代,Kubectl 支持使用 [go-templates](https://golang.org/pkg/text/template/) 来格式化输出: + + +```sh +kubectl get pods --all-namespaces -o go-template --template="{{range .items}}{{range .spec.containers}}{{.image}} {{end}}{{end}}" +``` + + + +{{% /capture %}} + +{{% capture discussion %}} + +{{% /capture %}} + +{{% capture whatsnext %}} + + +### 参考 + +* [Jsonpath](/docs/user-guide/jsonpath/) 参考指南 +* [Go template](https://golang.org/pkg/text/template/) 参考指南 + +{{% /capture %}} + + diff --git a/content/zh/docs/tasks/access-application-cluster/load-balance-access-application-cluster.md b/content/zh/docs/tasks/access-application-cluster/load-balance-access-application-cluster.md new file mode 100644 index 0000000000..3308069220 --- /dev/null +++ b/content/zh/docs/tasks/access-application-cluster/load-balance-access-application-cluster.md @@ -0,0 +1,190 @@ + +--- +title: 提供对集群中应用程序的负载均衡访问 +content_template: templates/tutorial +weight: 50 +--- + +{{% capture overview %}} + + +本文展示如何创建一个 Kubernetes 服务对象,来提供负载均衡入口以访问集群内正在运行的应用程序。 + +{{% /capture %}} + + +{{% capture prerequisites %}} + +{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + +{{% /capture %}} + + +{{% capture objectives %}} + + +* 运行两个 Hello World 应用示例 +* 创建一个服务对象 +* 使用这个服务对象来访问正在运行的应用 + +{{% /capture %}} + + +{{% capture lessoncontent %}} + + +## 为在两个 pod 中运行的应用程序创建服务 + +1. 在您的集群中运行一个 Hello World 应用: + + ``` + kubectl run hello-world --replicas=2 --labels="run=load-balancer-example" --image=gcr.io/google-samples/node-hello:1.0 --port=8080 + ``` + + +1. 列出运行 Hello World 应用的 pod: + + ``` + kubectl get pods --selector="run=load-balancer-example" + ``` + + + 输出应类似于: + + ``` + NAME READY STATUS RESTARTS AGE + hello-world-2189936611-8fyp0 1/1 Running 0 6m + hello-world-2189936611-9isq8 1/1 Running 0 6m + ``` + + +1. 创建一个服务对象来暴露这个 deployment: + + ``` + kubectl expose deployment --type=NodePort --name=example-service + ``` + + + 这里的 `` 是您的 deployment 的名称。 + +1. 显示您服务的 IP 地址: + + ``` + kubectl get services example-service + ``` + + + 输出展示了您服务的内部和外部 IP 地址。如果外部 IP 地址显示 ``,那么您需要重复运行以上命令。 + + {{< note >}} + + **注意:** 如果您使用 Minikube,那么您将不会获得外部 IP 地址。外部 IP 地址将保持 pending 状态。 + {{< /note >}} + + NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE + example-service 10.0.0.160 8080/TCP 40s + + +1. 使用您的服务对象来访问这个 Hello World 应用: + + curl :8080 + + + 这里的 `` 是您服务的外部 IP 地址。 + + 输出是来自应用的 hello 消息: + + Hello Kubernetes! + + {{< note >}} + + **注意:** 如果您使用 Minikube,输入以下命令: + {{< /note >}} + + kubectl cluster-info + kubectl describe services example-service + + + 输出将展示您的 Minikube 节点的 IP 地址和您服务的 NodePort 值。然后输入以下命令来访问这个 Hello World 应用: + + curl : + + + 这里的 `` 是您的 Minikube 节点的 IP 地址,`` 是您服务的 NodePort 值。 + + +## 使用服务配置文件 + +作为 `kubectl expose` 的替代方法,您可以使用 [服务配置文件](/docs/concepts/services-networking/service/) 来创建服务。 + + +{{% /capture %}} + + +{{% capture whatsnext %}} + + +学习更多关于如何 [通过服务连接应用](/docs/concepts/services-networking/connect-applications-service/)。 +{{% /capture %}} + + + diff --git a/content/zh/docs/tasks/access-application-cluster/port-forward-access-application-cluster.md b/content/zh/docs/tasks/access-application-cluster/port-forward-access-application-cluster.md new file mode 100644 index 0000000000..6bccf05cda --- /dev/null +++ b/content/zh/docs/tasks/access-application-cluster/port-forward-access-application-cluster.md @@ -0,0 +1,222 @@ + +--- +title: 使用端口转发来访问集群中的应用 +content_template: templates/task +weight: 40 +--- + +{{% capture overview %}} + + +本文展示如何使用 `kubectl port-forward` 连接到在 Kubernetes 集群中运行的 Redis 服务。这种类型的连接对数据库调试很有用。 +{{% /capture %}} + + +{{% capture prerequisites %}} + +* {{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + + +* 安装 [redis-cli](http://redis.io/topics/rediscli)。 + +{{% /capture %}} + + +{{% capture steps %}} + + +## 创建 Redis deployment 和服务 + +1. 创建一个 Redis deployment: + + kubectl create -f https://k8s.io/docs/tutorials/stateless-application/guestbook/redis-master-deployment.yaml + + + 查看输出是否成功,以验证是否成功创建 deployment: + + deployment "redis-master" created + + + 当 pod 是 ready 时,您将得到: + + kubectl get pods + + NAME READY STATUS RESTARTS AGE + redis-master-765d459796-258hz 1/1 Running 0 50s + + kubectl get deployment + + NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE + redis-master 1 1 1 1 55s + + kubectl get rs + + NAME DESIRED CURRENT READY AGE + redis-master-765d459796 1 1 1 1m + + + +2. 创建一个 Redis 服务: + + kubectl create -f https://k8s.io/docs/tutorials/stateless-application/guestbook/redis-master-service.yaml + + + 查看输出是否成功,以验证是否成功创建服务: + + service "redis-master" created + + + 检查服务是否创建: + + kubectl get svc | grep redis + + NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE + redis-master ClusterIP 10.0.0.213 6379/TCP 27s + + +3. 验证 Redis 服务是否运行在 pod 中并且监听 6379 端口: + + + kubectl get pods redis-master-765d459796-258hz --template='{{(index (index .spec.containers 0).ports 0).containerPort}}{{"\n"}}' + + + + 输出应该显示端口: + + 6379 + + + +## 转发一个本地端口到 pod 端口 + +1. 从 Kubernetes v1.10 开始,`kubectl port-forward` 允许使用资源名称(例如服务名称)来选择匹配的 pod 来进行端口转发。 + + kubectl port-forward redis-master-765d459796-258hz 6379:6379 + + + 这相当于 + + kubectl port-forward pods/redis-master-765d459796-258hz 6379:6379 + + + 或者 + + kubectl port-forward deployment/redis-master 6379:6379 + + + 或者 + + kubectl port-forward rs/redis-master 6379:6379 + + + 或者 + + kubectl port-forward svc/redis-master 6379:6379 + + + 以上所有命令都应该有效。输出应该类似于: + + I0710 14:43:38.274550 3655 portforward.go:225] Forwarding from 127.0.0.1:6379 -> 6379 + I0710 14:43:38.274797 3655 portforward.go:225] Forwarding from [::1]:6379 -> 6379 + + +2. 启动 Redis 命令行接口: + + redis-cli + + +3. 在 Redis 命令行提示符下,输入 `ping` 命令: + + 127.0.0.1:6379>ping + + + 成功的 ping 请求应该返回 PONG。 + +{{% /capture %}} + + +{{% capture discussion %}} + + +## 讨论 + +与本地 6379 端口建立的连接将转发到运行 Redis 服务器的 pod 的 6379 端口。通过此连接,您可以使用本地工作站来调试在 pod 中运行的数据库。 + +{{< warning >}} + +**警告:** 由于已知的限制,目前的端口转发仅适用于 TCP 协议。 +在 [issue 47862](https://github.com/kubernetes/kubernetes/issues/47862) 中正在跟踪对 UDP 协议的支持。 +{{< /warning >}} + +{{% /capture %}} + + +{{% capture whatsnext %}} + +学习更多关于 [kubectl port-forward](/docs/reference/generated/kubectl/kubectl-commands/#port-forward)。 +{{% /capture %}} + + + diff --git a/content/cn/docs/tasks/access-application-cluster/redis-master.yaml b/content/zh/docs/tasks/access-application-cluster/redis-master.yaml similarity index 100% rename from content/cn/docs/tasks/access-application-cluster/redis-master.yaml rename to content/zh/docs/tasks/access-application-cluster/redis-master.yaml diff --git a/content/zh/docs/tasks/access-application-cluster/service-access-application-cluster.md b/content/zh/docs/tasks/access-application-cluster/service-access-application-cluster.md new file mode 100644 index 0000000000..908280e29d --- /dev/null +++ b/content/zh/docs/tasks/access-application-cluster/service-access-application-cluster.md @@ -0,0 +1,225 @@ + +--- +title: 使用服务来访问集群中的应用 +content_template: templates/tutorial +weight: 60 +--- + +{{% capture overview %}} + + +本文展示如何创建一个 Kubernetes 服务对象,能让外部客户端访问在集群中运行的应用。该服务为一个应用的两个运行实例提供负载均衡。 + +{{% /capture %}} + + +{{% capture prerequisites %}} + +{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + +{{% /capture %}} + + +{{% capture objectives %}} + + +* 运行 Hello World 应用的两个实例。 +* 创建一个服务对象来暴露一个 node port。 +* 使用服务对象来访问正在运行的应用。 + +{{% /capture %}} + + +{{% capture lessoncontent %}} + + +## 为运行在两个 pod 中的应用创建一个服务: + +1. 在您的集群中运行一个 Hello World 应用: + ```shell + kubectl run hello-world --replicas=2 --labels="run=load-balancer-example" --image=gcr.io/google-samples/node-hello:1.0 --port=8080 + ``` + + 上面的命令创建一个 [Deployment](/docs/concepts/workloads/controllers/deployment/) 对象和一个关联的 [ReplicaSet](/docs/concepts/workloads/controllers/replicaset/) 对象。这个 ReplicaSet 有两个 [Pod](/docs/concepts/workloads/pods/pod/),每个 Pod 都运行着 Hello World 应用。 + + +1. 展示 Deployment 的信息: + ```shell + kubectl get deployments hello-world + kubectl describe deployments hello-world + ``` + + +1. 展示您的 ReplicaSet 对象信息: + ```shell + kubectl get replicasets + kubectl describe replicasets + ``` + + +1. 创建一个服务对象来暴露 deployment: + ```shell + kubectl expose deployment hello-world --type=NodePort --name=example-service + ``` + + +1. 展示服务信息: + ```shell + kubectl describe services example-service + ``` + + 输出类似于: + ```shell + Name: example-service + Namespace: default + Labels: run=load-balancer-example + Annotations: + Selector: run=load-balancer-example + Type: NodePort + IP: 10.32.0.16 + Port: 8080/TCP + TargetPort: 8080/TCP + NodePort: 31496/TCP + Endpoints: 10.200.1.4:8080,10.200.2.5:8080 + Session Affinity: None + Events: + ``` + + 注意服务中的 NodePort 值。例如在上面的输出中,NodePort 是 31496。 + + +1. 列出运行 Hello World 应用的 pod: + ```shell + kubectl get pods --selector="run=load-balancer-example" --output=wide + ``` + + 输出类似于: + ```shell + NAME READY STATUS ... IP NODE + hello-world-2895499144-bsbk5 1/1 Running ... 10.200.1.4 worker1 + hello-world-2895499144-m1pwt 1/1 Running ... 10.200.2.5 worker2 + ``` + +1. 获取运行 Hello World 的 pod 的其中一个节点的公共 IP 地址。如何获得此地址取决于您设置集群的方式。 + 例如,如果您使用的是 Minikube,则可以通过运行 `kubectl cluster-info` 来查看节点地址。 + 如果您使用的是 Google Compute Engine 实例,则可以使用 `gcloud compute instances list` 命令查看节点的公共地址。 + +1. 在您选择的节点上,创建一个防火墙规则以开放 node port 上的 TCP 流量。 + 例如,如果您的服务的 NodePort 值为 31568,请创建一个防火墙规则以允许 31568 端口上的 TCP 流量。 + 不同的云提供商提供了不同方法来配置防火墙规则。 + +1. 使用节点地址和 node port 来访问 Hello World 应用: + ```shell + curl http://: + ``` + + 这里的 `` 是您节点的公共 IP 地址,`` 是您服务的 NodePort 值。 + 对于请求成功的响应是一个 hello 消息: + ```shell + Hello Kubernetes! + ``` + + +## 使用服务配置文件 + +作为 `kubectl expose` 的替代方法,您可以使用 [服务配置文件](/docs/concepts/services-networking/service/) 来创建服务。 + +{{% /capture %}} + + +{{% capture cleanup %}} + + +想要删除服务,输入以下命令: + + kubectl delete services example-service + + +想要删除运行 Hello World 应用的 Deployment、ReplicaSet 和 Pod,输入以下命令: + + kubectl delete deployment hello-world + +{{% /capture %}} + + +{{% capture whatsnext %}} + + +学习更多关于如何 [通过服务连接应用](/docs/concepts/services-networking/connect-applications-service/)。 +{{% /capture %}} diff --git a/content/cn/docs/tasks/access-application-cluster/two-container-pod.yaml b/content/zh/docs/tasks/access-application-cluster/two-container-pod.yaml similarity index 100% rename from content/cn/docs/tasks/access-application-cluster/two-container-pod.yaml rename to content/zh/docs/tasks/access-application-cluster/two-container-pod.yaml diff --git a/content/zh/docs/tasks/access-kubernetes-api/setup-extension-api-server.md b/content/zh/docs/tasks/access-kubernetes-api/setup-extension-api-server.md new file mode 100644 index 0000000000..f7b3fff81a --- /dev/null +++ b/content/zh/docs/tasks/access-kubernetes-api/setup-extension-api-server.md @@ -0,0 +1,112 @@ + +--- +title: 设置一个扩展的 API server +reviewers: +- lavalamp +- cheftako +- chenopis +content_template: templates/task +weight: 15 +--- + +{{% capture overview %}} + + +设置一个扩展的 API server 来使用聚合层以让 Kubernetes apiserver 使用其它 API 进行扩展,这些 API 不是核心 Kubernetes API 的一部分。 + +{{% /capture %}} + +{{% capture prerequisites %}} + + +* 您需要拥有一个运行的 Kubernetes 集群。 +* 您必须 [配置聚合层](/docs/tasks/access-kubernetes-api/configure-aggregation-layer/) 并且启用 apiserver 的相关参数。 + +{{% /capture %}} + +{{% capture prerequisites %}} + +{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + +{{% /capture %}} + +{{% capture steps %}} + + +## 设置一个扩展的 api-server 来使用聚合层 + +以下步骤描述如何 *在一个高层次* 设置一个扩展的 apiserver。无论您使用的是 YAML 配置还是使用 API,这些步骤都适用。目前我们正在尝试区分出两者的区别。有关使用 YAML 配置的具体示例,您可以在 Kubernetes 库中查看 [sample-apiserver](https://github.com/kubernetes/sample-apiserver/blob/master/README.md)。 + +或者,您可以使用现有的第三方解决方案,例如 [apiserver-builder](https://github.com/Kubernetes-incubator/apiserver-builder/blob/master/README.md),它将生成框架并自动执行以下所有步骤。 + + +1. 确保启用了 APIService API(检查 `--runtime-config`)。默认应该是启用的,除非被特意关闭了。 +1. 您可能需要制定一个 RBAC 规则,以允许您添加 APIService 对象,或让您的集群管理员创建一个。(由于 API 扩展会影响整个集群,因此不建议在实时集群中对 API 扩展进行测试/开发/调试) +1. 创建 Kubernetes 命名空间,扩展的 api-service 将运行在该命名空间中。 +1. 创建(或获取)用来签署服务器证书的 CA 证书,扩展 api-server 中将使用该证书做 HTTPS 连接。 +1. 为 api-server 创建一个服务端的证书(或秘钥)以使用 HTTPS。这个证书应该由上述的 CA 签署。同时应该还要有一个 Kube DNS 名称的 CN,这是从 Kubernetes 服务派生而来的,格式为 `..svc`。 +1. 使用命名空间中的证书(或秘钥)创建一个 Kubernetes secret。 +1. 为扩展 api-server 创建一个 Kubernetes deployment,并确保以卷的方式挂载了 secret。它应该包含对扩展 api-server 镜像的引用。Deployment 也应该在同一个命名空间中。 +1. 确保您的扩展 apiserver 从该卷中加载了那些证书,并在 HTTPS 握手过程中使用它们。 +1. 在您的命令空间中创建一个 Kubernetes service account。 +1. 为资源允许的操作创建 Kubernetes 集群角色。 +1. 以您命令空间中的 service account 创建一个 Kubernetes 集群角色绑定,绑定到您刚创建的角色上。 +1. 以您命令空间中的 service account 创建一个 Kubernetes 集群角色绑定,绑定到 `system:auth-delegator` 集群角色,以将 auth 决策委派给 Kubernetes 核心 API 服务器。 +1. 以您命令空间中的 service account 创建一个 Kubernetes 集群角色绑定,绑定到 `extension-apiserver-authentication-reader` 角色。这将让您的扩展 api-server 能够访问 `extension-apiserver-authentication` configmap。 +1. 创建一个 Kubernetes apiservice。上述的 CA 证书应该使用 base64 编码,剥离新行并用作 apiservice 中的 spec.caBundle。这不应该是命名空间化的。如果使用了 [kube-aggregator API](https://github.com/kubernetes/kube-aggregator/),那么只需要传入 PEM 编码的 CA 绑定,因为 base 64 编码已经完成了。 +1. 使用 kubectl 来获得您的资源。它应该返回 "找不到资源"。这意味着一切正常,但您目前还没有创建该资源类型的对象。 + +{{% /capture %}} + +{{% capture whatsnext %}} + + +* 如果你还未配置,请 [配置聚合层](/docs/tasks/access-kubernetes-api/configure-aggregation-layer/) 并启用 apiserver 的相关参数。 +* 高级概述,请参阅 [使用聚合层扩展 Kubernetes API](/docs/concepts/api-extension/apiserver-aggregation)。 +* 了解如何 [使用 Custom Resource Definition 扩展 Kubernetes API](/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/)。 + +{{% /capture %}} + + + diff --git a/content/cn/docs/tasks/administer-cluster/access-cluster-services.md b/content/zh/docs/tasks/administer-cluster/access-cluster-services.md similarity index 100% rename from content/cn/docs/tasks/administer-cluster/access-cluster-services.md rename to content/zh/docs/tasks/administer-cluster/access-cluster-services.md diff --git a/content/cn/docs/tasks/administer-cluster/apply-resource-quota-limit.md b/content/zh/docs/tasks/administer-cluster/apply-resource-quota-limit.md similarity index 100% rename from content/cn/docs/tasks/administer-cluster/apply-resource-quota-limit.md rename to content/zh/docs/tasks/administer-cluster/apply-resource-quota-limit.md diff --git a/content/cn/docs/tasks/administer-cluster/calico-network-policy.md b/content/zh/docs/tasks/administer-cluster/calico-network-policy.md similarity index 100% rename from content/cn/docs/tasks/administer-cluster/calico-network-policy.md rename to content/zh/docs/tasks/administer-cluster/calico-network-policy.md diff --git a/content/cn/docs/tasks/administer-cluster/change-default-storage-class.md b/content/zh/docs/tasks/administer-cluster/change-default-storage-class.md similarity index 100% rename from content/cn/docs/tasks/administer-cluster/change-default-storage-class.md rename to content/zh/docs/tasks/administer-cluster/change-default-storage-class.md diff --git a/content/cn/docs/tasks/administer-cluster/change-pv-reclaim-policy.md b/content/zh/docs/tasks/administer-cluster/change-pv-reclaim-policy.md similarity index 100% rename from content/cn/docs/tasks/administer-cluster/change-pv-reclaim-policy.md rename to content/zh/docs/tasks/administer-cluster/change-pv-reclaim-policy.md diff --git a/content/cn/docs/tasks/administer-cluster/cluster-management.md b/content/zh/docs/tasks/administer-cluster/cluster-management.md similarity index 100% rename from content/cn/docs/tasks/administer-cluster/cluster-management.md rename to content/zh/docs/tasks/administer-cluster/cluster-management.md diff --git a/content/cn/docs/tasks/administer-cluster/cpu-constraints-pod-2.yaml b/content/zh/docs/tasks/administer-cluster/cpu-constraints-pod-2.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/cpu-constraints-pod-2.yaml rename to content/zh/docs/tasks/administer-cluster/cpu-constraints-pod-2.yaml diff --git a/content/cn/docs/tasks/administer-cluster/cpu-constraints-pod-3.yaml b/content/zh/docs/tasks/administer-cluster/cpu-constraints-pod-3.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/cpu-constraints-pod-3.yaml rename to content/zh/docs/tasks/administer-cluster/cpu-constraints-pod-3.yaml diff --git a/content/cn/docs/tasks/administer-cluster/cpu-constraints-pod-4.yaml b/content/zh/docs/tasks/administer-cluster/cpu-constraints-pod-4.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/cpu-constraints-pod-4.yaml rename to content/zh/docs/tasks/administer-cluster/cpu-constraints-pod-4.yaml diff --git a/content/cn/docs/tasks/administer-cluster/cpu-constraints-pod.yaml b/content/zh/docs/tasks/administer-cluster/cpu-constraints-pod.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/cpu-constraints-pod.yaml rename to content/zh/docs/tasks/administer-cluster/cpu-constraints-pod.yaml diff --git a/content/cn/docs/tasks/administer-cluster/cpu-constraints.yaml b/content/zh/docs/tasks/administer-cluster/cpu-constraints.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/cpu-constraints.yaml rename to content/zh/docs/tasks/administer-cluster/cpu-constraints.yaml diff --git a/content/cn/docs/tasks/administer-cluster/cpu-defaults-pod-2.yaml b/content/zh/docs/tasks/administer-cluster/cpu-defaults-pod-2.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/cpu-defaults-pod-2.yaml rename to content/zh/docs/tasks/administer-cluster/cpu-defaults-pod-2.yaml diff --git a/content/cn/docs/tasks/administer-cluster/cpu-defaults-pod-3.yaml b/content/zh/docs/tasks/administer-cluster/cpu-defaults-pod-3.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/cpu-defaults-pod-3.yaml rename to content/zh/docs/tasks/administer-cluster/cpu-defaults-pod-3.yaml diff --git a/content/cn/docs/tasks/administer-cluster/cpu-defaults-pod.yaml b/content/zh/docs/tasks/administer-cluster/cpu-defaults-pod.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/cpu-defaults-pod.yaml rename to content/zh/docs/tasks/administer-cluster/cpu-defaults-pod.yaml diff --git a/content/cn/docs/tasks/administer-cluster/cpu-defaults.yaml b/content/zh/docs/tasks/administer-cluster/cpu-defaults.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/cpu-defaults.yaml rename to content/zh/docs/tasks/administer-cluster/cpu-defaults.yaml diff --git a/content/cn/docs/tasks/administer-cluster/cpu-management-policies.md b/content/zh/docs/tasks/administer-cluster/cpu-management-policies.md similarity index 100% rename from content/cn/docs/tasks/administer-cluster/cpu-management-policies.md rename to content/zh/docs/tasks/administer-cluster/cpu-management-policies.md diff --git a/content/cn/docs/tasks/administer-cluster/cpu-memory-limit.md b/content/zh/docs/tasks/administer-cluster/cpu-memory-limit.md similarity index 99% rename from content/cn/docs/tasks/administer-cluster/cpu-memory-limit.md rename to content/zh/docs/tasks/administer-cluster/cpu-memory-limit.md index d867fc14b7..3988b9b9c8 100644 --- a/content/cn/docs/tasks/administer-cluster/cpu-memory-limit.md +++ b/content/zh/docs/tasks/administer-cluster/cpu-memory-limit.md @@ -195,7 +195,7 @@ spec: 注意到这个 Pod 显式地指定了资源 *limits* 和 *requests*,所以它不会使用该 Namespace 的默认值。 -注意:在物理节点上默认安装的 Kubernetes 集群中,CPU 资源的 *limits* 是被强制使用的,该 Kubernetes 集群运行容器,除非管理员在部署 kublet 时使用了如下标志: +注意:在物理节点上默认安装的 Kubernetes 集群中,CPU 资源的 *limits* 是被强制使用的,该 Kubernetes 集群运行容器,除非管理员在部署 kubelet 时使用了如下标志: ```shell $ kubelet --help diff --git a/content/cn/docs/tasks/administer-cluster/declare-network-policy.md b/content/zh/docs/tasks/administer-cluster/declare-network-policy.md similarity index 100% rename from content/cn/docs/tasks/administer-cluster/declare-network-policy.md rename to content/zh/docs/tasks/administer-cluster/declare-network-policy.md diff --git a/content/cn/docs/tasks/administer-cluster/dns-custom-nameservers.md b/content/zh/docs/tasks/administer-cluster/dns-custom-nameservers.md similarity index 100% rename from content/cn/docs/tasks/administer-cluster/dns-custom-nameservers.md rename to content/zh/docs/tasks/administer-cluster/dns-custom-nameservers.md diff --git a/content/cn/docs/tasks/administer-cluster/dns-horizontal-autoscaler.yaml b/content/zh/docs/tasks/administer-cluster/dns-horizontal-autoscaler.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/dns-horizontal-autoscaler.yaml rename to content/zh/docs/tasks/administer-cluster/dns-horizontal-autoscaler.yaml diff --git a/content/zh/docs/tasks/administer-cluster/encrypt-data.md b/content/zh/docs/tasks/administer-cluster/encrypt-data.md new file mode 100644 index 0000000000..c454ec9945 --- /dev/null +++ b/content/zh/docs/tasks/administer-cluster/encrypt-data.md @@ -0,0 +1,323 @@ + +--- +reviewers: +- smarterclayton +title: 加密静态 Secret 数据 +content_template: templates/task +--- + +{{% capture overview %}} + +本文展示如何启用和配置静态 Secret 数据的加密 +{{% /capture %}} + +{{% capture prerequisites %}} + +* {{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + + +* 需要 Kubernetes 1.7.0 或者更高版本 + +* 需要 etcd v3 或者更高版本 + +* 静态数据加密在 1.7.0 中仍然是 alpha 版本,这意味着它可能会在没有通知的情况下进行更改。在升级到 1.8.0 之前,用户可能需要解密他们的数据。 + +{{% /capture %}} + +{{< toc >}} + +{{% capture prerequisites %}} + +{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + +{{% /capture %}} + +{{% capture steps %}} + + +## 配置并确定是否已启用静态数据加密 + +`kube-apiserver` 的参数 `--experimental-encryption-provider-config` 控制 API 数据在 etcd 中的加密方式。 +下面提供一个配置示例。 + +## 理解静态数据加密 + +```yaml +kind: EncryptionConfig +apiVersion: v1 +resources: + - resources: + - secrets + providers: + - identity: {} + - aesgcm: + keys: + - name: key1 + secret: c2VjcmV0IGlzIHNlY3VyZQ== + - name: key2 + secret: dGhpcyBpcyBwYXNzd29yZA== + - aescbc: + keys: + - name: key1 + secret: c2VjcmV0IGlzIHNlY3VyZQ== + - name: key2 + secret: dGhpcyBpcyBwYXNzd29yZA== + - secretbox: + keys: + - name: key1 + secret: YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXoxMjM0NTY= +``` + + +每个 `resources` 数组项目是一个单独的完整的配置。 `resources.resources` 字段是要加密的 Kubernetes 资源名称(`resource` 或 `resource.group`)的数组。 +`providers` 数组是可能的加密 provider 的有序列表。每个条目只能指定一个 provider 类型(可以是 `identity` 或 `aescbc`,但不能在同一个项目中同时指定)。 + +列表中的第一个提供者用于加密进入存储的资源。当从存储器读取资源时,与存储的数据匹配的所有提供者将尝试按顺序解密数据。 +如果由于格式或密钥不匹配而导致提供者无法读取存储的数据,则会返回一个错误,以防止客户端访问该资源。 + +**重要:** 如果通过加密配置无法读取资源(因为密钥已更改),唯一的方法是直接从基础 etcd 中删除该密钥。任何尝试读取资源的调用将会失败,直到它被删除或提供有效的解密密钥。 + +### Providers: + + +名称 | 加密类型 | 强度 | 速度 | 密钥长度 | 其它事项 +-----|------------|----------|-------|------------|--------------------- +`identity` | 无 | N/A | N/A | N/A | 不加密写入的资源。当设置为第一个 provider 时,资源将在新值写入时被解密。 +`aescbc` | 填充 PKCS#7 的 AES-CBC | 最强 | 快 | 32字节 | 建议使用的加密项,但可能比 `secretbox` 稍微慢一些。 +`secretbox` | XSalsa20 和 Poly1305 | 强 | 更快 | 32字节 | 较新的标准,在需要高度评审的环境中可能不被接受。 +`aesgcm` | 带有随机数的 AES-GCM | 必须每 200k 写入一次 | 最快 | 16, 24, 或者 32字节 | 建议不要使用,除非实施了自动密钥循环方案。 +`kms` | 使用信封加密方案:数据使用带有 PKCS#7 填充的 AES-CBC 通过 data encryption keys(DEK)加密,DEK 根据 Key Management Service(KMS)中的配置通过 key encryption keys(KEK)加密 | 最强 | 快 | 32字节 | 建议使用第三方工具进行密钥管理。为每个加密生成新的 DEK,并由用户控制 KEK 轮换来简化密钥轮换。[配置 KMS 提供程序](/docs/tasks/administer-cluster/kms-provider/) + +每个 provider 都支持多个密钥 - 在解密时会按顺序使用密钥,如果是第一个 provider,则第一个密钥用于加密。 + + +## 加密您的数据 + +创建一个新的加密配置文件: + +```yaml +kind: EncryptionConfig +apiVersion: v1 +resources: + - resources: + - secrets + providers: + - aescbc: + keys: + - name: key1 + secret: + - identity: {} +``` + + +遵循如下步骤来创建一个新的 secret: + +1. 生成一个 32 字节的随机密钥并进行 base64 编码。如果您在 Linux 或 Mac OS X 上,请运行以下命令: + + ``` + head -c 32 /dev/urandom | base64 + ``` + + +2. 将这个值放入到 secret 字段中。 +3. 设置 `kube-apiserver` 的 `--experimental-encryption-provider-config` 参数,将其指定到配置文件所在位置。 +4. 重启您的 API server。 + +**重要:** 您的配置文件包含可以解密 etcd 内容的密钥,因此您必须正确限制主设备的权限,以便只有能运行 kube-apiserver 的用户才能读取它。 + + + +## 验证数据是否被加密 + +数据在写入 etcd 时会被加密。重新启动你的 `kube-apiserver` 后,任何新创建或更新的密码在存储时都应该被加密。 +如果想要检查,你可以使用 `etcdctl` 命令行程序来检索你的加密内容。 + +1. 创建一个新的 secret,名称为 `secret1`,命名空间为 `default`: + + ``` + kubectl create secret generic secret1 -n default --from-literal=mykey=mydata + ``` + + +2. 使用 etcdctl 命令行,从 etcd 中读取 secret: + + ``` +    ETCDCTL_API=3 etcdctl get /registry/secrets/default/secret1 [...] | hexdump -C + ``` + + + 这里的 `[...]` 是用来连接 etcd 服务的额外参数。 +3. 验证存储的密钥前缀是否为 `k8s:enc:aescbc:v1:`,这表明 `aescbc` provider 已加密结果数据。 +4. 通过 API 检索,验证 secret 是否被正确解密: + + ``` + kubectl describe secret secret1 -n default + ``` + + + 必须匹配 `mykey: mydata` + + + +## 确保所有 secret 都被加密 + +由于 secret 是在写入时被加密,因此对 secret 执行更新也会加密该内容。 + +``` +kubectl get secrets --all-namespaces -o json | kubectl replace -f - +``` + + +上面的命令读取所有 secret,然后使用服务端加密来进行更新。 +如果由于冲突写入而发生错误,请重试该命令。 +对于较大的集群,您可能希望通过命名空间或更新脚本来分割 secret。 + + + +## 回滚解密密钥 + +在不发生停机的情况下更改 secret 需要多步操作,特别是在有多个 `kube-apiserver` 进程正在运行的高可用部署的情况下。 + +1. 生成一个新密钥并将其添加为所有服务器上当前提供程序的第二个密钥条目 +2. 重新启动所有 `kube-apiserver` 进程以确保每台服务器都可以使用新密钥进行解密 +3. 将新密钥设置为 `keys` 数组中的第一个条目,以便在配置中使用其进行加密 +4. 重新启动所有 `kube-apiserver` 进程以确保每个服务器现在都使用新密钥进行加密 +5. 运行 `kubectl get secrets --all-namespaces -o json | kubectl replace -f -` 以用新密钥加密所有现有的秘密 +6. 在使用新密钥备份 etcd 后,从配置中删除旧的解密密钥并更新所有密钥 + +如果只有一个 `kube-apiserver`,第 2 步可能可以忽略。 + + + +## 解密所有数据 + +要禁用 rest 加密,请将 `identity` provider 作为配置中的第一个条目: + +```yaml +kind: EncryptionConfig +apiVersion: v1 +resources: + - resources: + - secrets + providers: + - identity: {} + - aescbc: + keys: + - name: key1 + secret: +``` + + +并重新启动所有 `kube-apiserver` 进程。然后运行命令 `kubectl get secrets --all-namespaces -o json | kubectl replace -f -` 强制解密所有 secret。 + +{{% /capture %}} + + diff --git a/content/cn/docs/tasks/administer-cluster/guaranteed-scheduling-critical-addon-pods.md b/content/zh/docs/tasks/administer-cluster/guaranteed-scheduling-critical-addon-pods.md similarity index 100% rename from content/cn/docs/tasks/administer-cluster/guaranteed-scheduling-critical-addon-pods.md rename to content/zh/docs/tasks/administer-cluster/guaranteed-scheduling-critical-addon-pods.md diff --git a/content/zh/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-9.md b/content/zh/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-9.md new file mode 100644 index 0000000000..56dae7aa97 --- /dev/null +++ b/content/zh/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-1-9.md @@ -0,0 +1,453 @@ +--- +reviewers: +- pipejakob +- luxas +- roberthbailey +- jbeda +title: 将 kubeadm 集群在 v1.8 版本到 v1.9 版本之间升级/降级 +content_template: templates/task +--- + + + +{{% capture overview %}} + + +本文主要描述如何将 `kubeadm` 集群从 1.8.x 版本升级到 1.9.x 版本,包括从 1.8.x 版本升级到 1.8.y 版本,和从版本 1.9.x 版本到 1.9.y 版本(`y > x`)。 +如果您目前安装的是集群是 1.7 版本,也可以查看[ kubeadm clusters 集群从 1.7 版本升级到 1.8 版本](/docs/tasks/administer-cluster/kubeadm-upgrade-1-8/) +{{% /capture %}} + +{{% capture prerequisites %}} + +升级之前: + +- 您需要先安装一个版本为 1.8.0 或更高版本的 `kubeadm` Kubernetes 集群。另外还需要禁用节点的交换分区。 +- 一定要认真阅读[发布说明](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.9.md) +- `kubeadm upgrade` 可以更新 etcd。默认情况下,从 Kubernetes 1.8 版本升级到 1.9 版本时,`kubeadm upgrade` 也会升级 etcd 到 3.1.10 版本。这是由于 etcd3.1.10 是官方验证的 etcd 版本对于 kubernetes1.9。kubeadm 为您提供了自动化的升级过程。 +- 请注意,`kubeadm upgrade`命令 不会触及任何工作负载,只有 kubernetes 内部组件。作为最佳实践,您应当备份,因为备份相当的重要。例如,任何应用程序级别的状态(如应用程序可能依赖的数据库,如 mysql 或 mongoDB)必须预先备份。 +{{< caution >}} + +**注意:** 由于容器的具体哈希值改变了,所有的容器在升级之后会重新启动。 + +{{< /caution >}} + + +同时,也要注意只有小范围的升级是支持的。例如,您只可以从 1.8 版本升级到 1.9 版本,但是不能从 1.7 版本升级到 1.9 版本。 + + +{{% /capture %}} + +{{% capture steps %}} + +## 升级控制面板 + +在您的 master 节点上执行这些命令: + +1. 使用 `curl` 命令进行安装最新的版本的 `kubeadm` ,例如: +```shell +export VERSION=$(curl -sSL https://dl.k8s.io/release/stable.txt) # or manually specify a released Kubernetes version +export ARCH=amd64 # or: arm, arm64, ppc64le, s390x +curl -sSL https://dl.k8s.io/release/${VERSION}/bin/linux/${ARCH}/kubeadm > /usr/bin/kubeadm +chmod a+rx /usr/bin/kubeadm +``` + +{{< caution >}} + +**注意:** 在您的系统上升级控制面板之前升级 `kubeadm` 包会导致升级失败。 +尽管 `kubeadm` ships 在 kubernetes 仓库中,手动安装 `kubeadm` 是重要的。kubeadm 团队在努力解决这种手动安装的限制。 +{{< /caution >}} + +验证 kubeadm 下载工作是否正常,并是否有达到预期的版本: +```shell +kubeadm version +``` + +2. 在master节点上运行如下命令: +```shell +kubeadm upgrade plan +``` + +可以得到类型的结果: + + + ```shell + [preflight] Running pre-flight checks + [upgrade] Making sure the cluster is healthy: + [upgrade/health] Checking API Server health: Healthy + [upgrade/health] Checking Node health: All Nodes are healthy + [upgrade/health] Checking Static Pod manifests exists on disk: All manifests exist on disk + [upgrade/config] Making sure the configuration is correct: + [upgrade/config] Reading configuration from the cluster... + [upgrade/config] FYI: You can look at this config file with 'kubectl -n kube-system get cm kubeadm-config -o yaml' + [upgrade] Fetching available versions to upgrade to: + [upgrade/versions] Cluster version: v1.8.1 + [upgrade/versions] kubeadm version: v1.9.0 + [upgrade/versions] Latest stable version: v1.9.0 + [upgrade/versions] Latest version in the v1.8 series: v1.8.6 + + 在升级控制面板并使用 'kubeadm upgrade apply' 后,必须手动升级组件: + COMPONENT CURRENT AVAILABLE + Kubelet 1 x v1.8.1 v1.8.6 + + 升级到最新的 v1.8 系列的版本: + COMPONENT CURRENT AVAILABLE + API Server v1.8.1 v1.8.6 + Controller Manager v1.8.1 v1.8.6 + Scheduler v1.8.1 v1.8.6 + Kube Proxy v1.8.1 v1.8.6 + Kube DNS 1.14.4 1.14.5 + + 您可以通过以下的命令来进行升级: + kubeadm upgrade apply v1.8.6 + + _____________________________________________________________________ + + 在升级控制面板并使用 'kubeadm upgrade apply' 后,必须手动升级组件: + COMPONENT CURRENT AVAILABLE + Kubelet 1 x v1.8.1 v1.9.0 + + 升级到最新和稳定的版本: + COMPONENT CURRENT AVAILABLE + API Server v1.8.1 v1.9.0 + Controller Manager v1.8.1 v1.9.0 + Scheduler v1.8.1 v1.9.0 + Kube Proxy v1.8.1 v1.9.0 + Kube DNS 1.14.5 1.14.7 + + 您可以通过以下命令来进行升级: + kubeadm upgrade apply v1.9.0 + + 请注意:在您执行升级之前,您必须升级 kubeadm 到 v1.9.0 版本 +_____________________________________________________________________ +``` + + +`kubeadm upgrade plan` 命令检查您的集群是否处于可升级的状态并且获取可以以用户友好方式升级的版本。 + +检查 coreDNS 版本,包括 `--feature-gates=CoreDNS=true` 标志来验证存放 kube-dns 在某个位置的 coreDNS 版本。 + +3. 选择一个版本来进行升级和运行,例如: +```shell +kubeadm upgrade apply v1.9.0 +``` + +可以得到如下类似的输出: +```shell +[preflight] Running pre-flight checks. +[upgrade] Making sure the cluster is healthy: +[upgrade/config] Making sure the configuration is correct: +[upgrade/config] Reading configuration from the cluster... +[upgrade/config] FYI: You can look at this config file with 'kubectl -n kube-system get cm kubeadm-config -oyaml' +[upgrade/version] You have chosen to upgrade to version "v1.9.0" +[upgrade/versions] Cluster version: v1.8.1 +[upgrade/versions] kubeadm version: v1.9.0 +[upgrade/confirm] Are you sure you want to proceed with the upgrade? [y/N]: y +[upgrade/prepull] Will prepull images for components [kube-apiserver kube-controller-manager kube-scheduler] +[upgrade/apply] Upgrading your Static Pod-hosted control plane to version "v1.9.0"... +[etcd] Wrote Static Pod manifest for a local etcd instance to "/etc/kubernetes/tmp/kubeadm-upgraded-manifests802453804/etcd.yaml" +[upgrade/staticpods] Moved upgraded manifest to "/etc/kubernetes/manifests/etcd.yaml" and backed up old manifest to "/etc/kubernetes/tmp/kubeadm-backup-manifests502223003/etcd.yaml" +[upgrade/staticpods] Waiting for the kubelet to restart the component +[apiclient] Found 1 Pods for label selector component=etcd +[upgrade/staticpods] Component "etcd" upgraded successfully! +[upgrade/staticpods] Writing upgraded Static Pod manifests to "/etc/kubernetes/tmp/kubeadm-upgraded-manifests802453804" +[controlplane] Wrote Static Pod manifest for component kube-apiserver to "/etc/kubernetes/tmp/kubeadm-upgraded-manifests802453804/kube-apiserver.yaml" +[controlplane] Wrote Static Pod manifest for component kube-controller-manager to "/etc/kubernetes/tmp/kubeadm-upgraded-manifests802453804/kube-controller-manager.yaml" +[controlplane] Wrote Static Pod manifest for component kube-scheduler to "/etc/kubernetes/tmp/kubeadm-upgraded-manifests802453804/kube-scheduler.yaml" +[upgrade/staticpods] Moved upgraded manifest to "/etc/kubernetes/manifests/kube-apiserver.yaml" and backed up old manifest to "/etc/kubernetes/tmp/kubeadm-backup-manifests502223003/kube-apiserver.yaml" +[upgrade/staticpods] Waiting for the kubelet to restart the component +[apiclient] Found 1 Pods for label selector component=kube-apiserver +[upgrade/staticpods] Component "kube-apiserver" upgraded successfully! +[upgrade/staticpods] Moved upgraded manifest to "/etc/kubernetes/manifests/kube-controller-manager.yaml" and backed up old manifest to "/etc/kubernetes/tmp/kubeadm-backup-manifests502223003/kube-controller-manager.yaml" +[upgrade/staticpods] Waiting for the kubelet to restart the component +[apiclient] Found 1 Pods for label selector component=kube-controller-manager +[upgrade/staticpods] Component "kube-controller-manager" upgraded successfully! +[upgrade/staticpods] Moved upgraded manifest to "/etc/kubernetes/manifests/kube-scheduler.yaml" and backed up old manifest to "/etc/kubernetes/tmp/kubeadm-backup-manifests502223003/kube-scheduler.yaml" +[upgrade/staticpods] Waiting for the kubelet to restart the component +[apiclient] Found 1 Pods for label selector component=kube-scheduler +[upgrade/staticpods] Component "kube-scheduler" upgraded successfully! +[uploadconfig] Storing the configuration used in ConfigMap "kubeadm-config" in the "kube-system" Namespace +[bootstraptoken] Configured RBAC rules to allow Node Bootstrap tokens to post CSRs in order for nodes to get long term certificate credentials +[bootstraptoken] Configured RBAC rules to allow the csrapprover controller automatically approve CSRs from a Node Bootstrap Token +[bootstraptoken] Configured RBAC rules to allow certificate rotation for all node client certificates in the cluster +[addons] Applied essential addon: kube-dns +[addons] Applied essential addon: kube-proxy + +[upgrade/successful] SUCCESS! Your cluster was upgraded to "v1.9.0". Enjoy! + +[upgrade/kubelet] Now that your control plane is upgraded, please proceed with upgrading your kubelets in turn. +``` + + +升级具有默认内部的 DNS 的 coreDNS 集群,调用具有 `--feature-gates=CoreDNS=true` 标记的 `kubeadm upgrade apply`。 +`kubeadm upgrade apply`按照如下进行: + +- 检查集群是否处于可升级状态: + -API服务器是否可达 + -所有的节点处于`Ready`状态 + -控制面板是健康的 +- 强制执行版本倾斜策略 +- 确保控制面板镜像可用或者可用于机器pull +- 升级控制面板组件或者回滚如果其中一个无法出现 +- 应用新的`kube-dns`和`kube-proxy`清单并强制创建所必须的RBAC规则 +- 创建API服务器新的证书和秘钥文件,并备份旧文件(如果它们即将在180天到期) + + +4. 手动升级定义网络(SDN)的软件 + + 容器网络接口(CNI)提供者具有升级说明指导。 + 检查这个[插件](/docs/concepts/cluster-administration/addons/)页面来找到 CNI 提供者和查看是否需要额外的升级步骤。 + + + +## 升级master和node包 + +在集群中涉及 `$HOST` 的每个主机,执行如下命令来升级 `kubelet` : + +1. 准备主机维修,并标记为不可调度和驱逐工作负载: +```shell +kubectl drain $HOST --ignore-daemonsets +``` + +当在 master 主机上运行这个命令,这个错误是可以预料的并且可以忽略(因为静态的 pods 运行在 master 上) +```shell +node "master" already cordoned +error: pods not managed by ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet (use --force to override): etcd-kubeadm, kube-apiserver-kubeadm, kube-controller-manager-kubeadm, kube-scheduler-kubeadm +``` + +2. 在 `$HOST` 节点上使用特定的包管理器升级 kubernetes 包版本: + +如果主机运行 Debian-based 发行版如 ubuntu,运行如下: +```shell +apt-get update +apt-get upgrade +``` + +如果主机运行centos或者类似,运行如下: +```shell +yum update +``` + +现在 `kubelet` 新的版本运行在主机上。在` $HOST` 上使用如下命令验证: +```shell +systemctl status kubelet +``` + +3. 通过标记可计划的将主机从新联机: +```shell +kubectl uncordon $HOST +``` + +在所以主机升级 `kubelet` 后,通过从任意位置运行以下命令例如从集群外来验证所有节点是否可用: +```shell +kubectl get nodes +``` + +如果上面命令的 `STATUS` 列显示所有的主机的 `Ready`,就完成了。 + +## ##从坏的状态中恢复 + +如果 `kubeadm upgrade` 以某种方式失败了并无法回滚,原因有在执行过程中出现意外关机,可以再次运行 `kubeadm upgrade`,因为它是幂等的,并且最终确保实际状态是期待的状态。 + + + +可以使用 `kubeadm upgrade` 来更改运行的集群并使用具有 `--force` 参数的 `x.x.x --> x.x.x`,这样可以恢复坏的状态。 + +{{% /capture %}} + + diff --git a/content/cn/docs/tasks/administer-cluster/kubelet-config-file.md b/content/zh/docs/tasks/administer-cluster/kubelet-config-file.md similarity index 100% rename from content/cn/docs/tasks/administer-cluster/kubelet-config-file.md rename to content/zh/docs/tasks/administer-cluster/kubelet-config-file.md diff --git a/content/cn/docs/tasks/administer-cluster/memory-constraints-pod-2.yaml b/content/zh/docs/tasks/administer-cluster/memory-constraints-pod-2.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/memory-constraints-pod-2.yaml rename to content/zh/docs/tasks/administer-cluster/memory-constraints-pod-2.yaml diff --git a/content/cn/docs/tasks/administer-cluster/memory-constraints-pod-3.yaml b/content/zh/docs/tasks/administer-cluster/memory-constraints-pod-3.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/memory-constraints-pod-3.yaml rename to content/zh/docs/tasks/administer-cluster/memory-constraints-pod-3.yaml diff --git a/content/cn/docs/tasks/administer-cluster/memory-constraints-pod-4.yaml b/content/zh/docs/tasks/administer-cluster/memory-constraints-pod-4.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/memory-constraints-pod-4.yaml rename to content/zh/docs/tasks/administer-cluster/memory-constraints-pod-4.yaml diff --git a/content/cn/docs/tasks/administer-cluster/memory-constraints-pod.yaml b/content/zh/docs/tasks/administer-cluster/memory-constraints-pod.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/memory-constraints-pod.yaml rename to content/zh/docs/tasks/administer-cluster/memory-constraints-pod.yaml diff --git a/content/cn/docs/tasks/administer-cluster/memory-constraints.yaml b/content/zh/docs/tasks/administer-cluster/memory-constraints.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/memory-constraints.yaml rename to content/zh/docs/tasks/administer-cluster/memory-constraints.yaml diff --git a/content/cn/docs/tasks/administer-cluster/memory-defaults-pod-2.yaml b/content/zh/docs/tasks/administer-cluster/memory-defaults-pod-2.yaml similarity index 81% rename from content/cn/docs/tasks/administer-cluster/memory-defaults-pod-2.yaml rename to content/zh/docs/tasks/administer-cluster/memory-defaults-pod-2.yaml index aa80610d84..1013293edd 100644 --- a/content/cn/docs/tasks/administer-cluster/memory-defaults-pod-2.yaml +++ b/content/zh/docs/tasks/administer-cluster/memory-defaults-pod-2.yaml @@ -4,7 +4,7 @@ metadata: name: default-mem-demo-2 spec: containers: - - name: default-mem-demo-2-ctr + - name: defalt-mem-demo-2-ctr image: nginx resources: limits: diff --git a/content/cn/docs/tasks/administer-cluster/memory-defaults-pod-3.yaml b/content/zh/docs/tasks/administer-cluster/memory-defaults-pod-3.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/memory-defaults-pod-3.yaml rename to content/zh/docs/tasks/administer-cluster/memory-defaults-pod-3.yaml diff --git a/content/cn/docs/tasks/administer-cluster/memory-defaults-pod.yaml b/content/zh/docs/tasks/administer-cluster/memory-defaults-pod.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/memory-defaults-pod.yaml rename to content/zh/docs/tasks/administer-cluster/memory-defaults-pod.yaml diff --git a/content/cn/docs/tasks/administer-cluster/memory-defaults.yaml b/content/zh/docs/tasks/administer-cluster/memory-defaults.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/memory-defaults.yaml rename to content/zh/docs/tasks/administer-cluster/memory-defaults.yaml diff --git a/content/cn/docs/tasks/administer-cluster/my-scheduler.yaml b/content/zh/docs/tasks/administer-cluster/my-scheduler.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/my-scheduler.yaml rename to content/zh/docs/tasks/administer-cluster/my-scheduler.yaml diff --git a/content/zh/docs/tasks/administer-cluster/network-policy-provider/calico-network-policy.md b/content/zh/docs/tasks/administer-cluster/network-policy-provider/calico-network-policy.md new file mode 100644 index 0000000000..78d0d8e675 --- /dev/null +++ b/content/zh/docs/tasks/administer-cluster/network-policy-provider/calico-network-policy.md @@ -0,0 +1,86 @@ +--- +reviewers: +- caseydavenport +title: 使用 Calico 作为 NetworkPolicy +content_template: templates/task +weight: 10 +--- + +{{% capture overview %}} + +本页展示了两种在 Kubernetes 上快速创建 Calico 集群的方法。 +{{% /capture %}} + +{{% capture prerequisites %}} + + +决定您想部署一个[云](#在-Google-Kubernetes-Engine-GKE-上创建一个-Calico-集群) 还是 [本地](#使用-kubeadm-创建一个本地-Calico-集群) 集群。 +{{% /capture %}} + +{{% capture steps %}} + +## 在 Google Kubernetes Engine (GKE) 上创建一个 Calico 集群 + +**先决条件**: [gcloud](https://cloud.google.com/sdk/docs/quickstarts) + +1. 启动一个带有 Calico 的 GKE 集群,只需加上flag `--enable-network-policy`。 + + **语法** + ```shell + gcloud container clusters create [CLUSTER_NAME] --enable-network-policy + ``` + + **示例** + ```shell + gcloud container clusters create my-calico-cluster --enable-network-policy + ``` + +1. 使用如下命令验证部署是否正确。 + + ```shell + kubectl get pods --namespace=kube-system + ``` + + Calico 的 pods 名以 `calico` 打头,检查确认每个 pods 状态为 `Running`。 + + +## 使用 kubeadm 创建一个本地 Calico 集群 + +在15分钟内使用 kubeadm 得到一个本地单主机 Calico 集群,请参考 +[Calico 快速入门](https://docs.projectcalico.org/latest/getting-started/kubernetes/)。 + +{{% /capture %}} + + +{{% capture whatsnext %}} + +集群运行后,您可以按照 [声明 Network Policy](/docs/tasks/administer-cluster/declare-network-policy/) 去尝试使用 Kubernetes NetworkPolicy。 +{{% /capture %}} diff --git a/content/zh/docs/tasks/administer-cluster/network-policy-provider/cilium-network-policy.md b/content/zh/docs/tasks/administer-cluster/network-policy-provider/cilium-network-policy.md new file mode 100644 index 0000000000..61be3718b3 --- /dev/null +++ b/content/zh/docs/tasks/administer-cluster/network-policy-provider/cilium-network-policy.md @@ -0,0 +1,133 @@ +--- +reviewers: +- danwent +title: 使用 Cilium 作为 NetworkPolicy +content_template: templates/task +weight: 20 +--- + +{{% capture overview %}} + + +本页展示了如何使用 Cilium 作为 NetworkPolicy。 + +关于 Cilium 的背景知识,请阅读 [Cilium 介绍](https://cilium.readthedocs.io/en/latest/intro)。 + +{{% /capture %}} + +{{% capture prerequisites %}} + +{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + +{{% /capture %}} + +{{% capture steps %}} + + +## 在 Minikube 上部署 Cilium 用于基本测试 + +为了轻松熟悉 Cilium 您可以根据[Cilium Kubernetes 入门指南](https://docs.cilium.io/en/latest/gettingstarted/minikube/)在 minikube 中执行一个 cilium 的基本的 DaemonSet 安装。 + +在 minikube 中的安装配置使用一个简单的“一体化” YAML 文件,包括了 Cilium 的 DaemonSet 配置,连接 minikube 的 etcd 实例,以及适当的 RBAC 设置。 + +```shell +$ kubectl create -f https://raw.githubusercontent.com/cilium/cilium/master/examples/kubernetes/cilium.yaml +configmap "cilium-config" created +secret "cilium-etcd-secrets" created +serviceaccount "cilium" created +clusterrolebinding "cilium" created +daemonset "cilium" created +clusterrole "cilium" created +``` + +入门指南其余的部分用一个示例应用说明了如何强制执行L3/L4(即 IP 地址+端口)的安全策略以及L7 (如 HTTP)的安全策略。 + + + +## 部署 Cilium 用于生产用途 +关于部署 Cilium 用于生产的详细说明,请见[Cilium Kubernetes 安装指南](https://cilium.readthedocs.io/en/latest/kubernetes/install/) +,此文档包括详细的需求、说明和生产用途 DaemonSet 文件示例。 + +{{% /capture %}} + +{{% capture discussion %}} + +## 了解 Cilium 组件 + +部署使用 Cilium 的集群会添加 Pods 到`kube-system`命名空间。 要查看此Pod列表,运行: + +```shell +kubectl get pods --namespace=kube-system +``` + + +您将看到像这样的 Pods 列表: + +```console +NAME DESIRED CURRENT READY NODE-SELECTOR AGE +cilium 1 1 1 2m +... +``` + +有两个主要组件需要注意: + +- 在集群中的每个节点上都会运行一个 `cilium` Pod,并利用Linux BPF执行网络策略管理该节点上进出 Pod 的流量。 +- 对于生产部署,Cilium 应该复用 Kubernetes 所使用的键值存储集群(如 etcd),其通常在Kubernetes 的 master 节点上运行。 +[Cilium Kubernetes安装指南](https://cilium.readthedocs.io/en/latest/kubernetes/install/) +包括了一个示例 DaemonSet,可以自定义指定此键值存储集群。 +简单的 minikube 的“一体化” DaemonSet 不需要这样的配置,因为它会自动连接到 minikube 的 etcd 实例。 + +{{% /capture %}} + +{{% capture whatsnext %}} + +群集运行后,您可以按照[声明网络策略](/docs/tasks/administer-cluster/declare-network-policy/) +用 Cilium 试用 Kubernetes NetworkPolicy。 +玩得开心,如果您有任何疑问,请联系我们 +[Cilium Slack Channel](https://cilium.herokuapp.com/)。 + +{{% /capture %}} + diff --git a/content/zh/docs/tasks/administer-cluster/network-policy-provider/kube-router-network-policy.md b/content/zh/docs/tasks/administer-cluster/network-policy-provider/kube-router-network-policy.md new file mode 100644 index 0000000000..901184cb25 --- /dev/null +++ b/content/zh/docs/tasks/administer-cluster/network-policy-provider/kube-router-network-policy.md @@ -0,0 +1,31 @@ +--- +reviewers: +- murali-reddy +title: 使用 Kube-router 作为 NetworkPolicy +content_template: templates/task +weight: 30 +--- + +{{% capture overview %}} + +本页展示了如何使用 [Kube-router](https://github.com/cloudnativelabs/kube-router) 作为 NetworkPolicy。 +{{% /capture %}} + +{{% capture prerequisites %}} + + +您需要拥有一个正在运行的 Kubernetes 集群。如果您还没有集群,可以使用任意的集群安装器如 Kops,Bootkube,Kubeadm 等创建一个。 +{{% /capture %}} + +{{% capture steps %}} + + +## 安装 Kube-router 插件 +Kube-router 插件自带一个Network Policy 控制器,监视来自于Kubernetes API server 的 NetworkPolicy 和 pods 的变化,根据策略指示配置 iptables 规则和 ipsets 来允许或阻止流量。请根据 [尝试通过集群安装器使用 Kube-router](https://www.kube-router.io/docs/user-guide/#try-kube-router-with-cluster-installers) 指南安装 Kube-router 插件。 +{{% /capture %}} + +{{% capture whatsnext %}} + +在您安装 Kube-router 插件后,可以根据 [声明 Network Policy](/docs/tasks/administer-cluster/declare-network-policy/) 去尝试使用 Kubernetes NetworkPolicy。 +{{% /capture %}} diff --git a/content/zh/docs/tasks/administer-cluster/network-policy-provider/romana-network-policy.md b/content/zh/docs/tasks/administer-cluster/network-policy-provider/romana-network-policy.md new file mode 100644 index 0000000000..5867bfec5c --- /dev/null +++ b/content/zh/docs/tasks/administer-cluster/network-policy-provider/romana-network-policy.md @@ -0,0 +1,57 @@ +--- +reviewers: +- chrismarino +title: 使用 Romana 作为 NetworkPolicy +content_template: templates/task +weight: 40 +--- + +{{% capture overview %}} + + +本页展示如何使用 Romana 作为 NetworkPolicy。 + +{{% /capture %}} + +{{% capture prerequisites %}} + + +完成[kubeadm 入门指南](/docs/getting-started-guides/kubeadm/)中的1、2、3步。 + +{{% /capture %}} + +{{% capture steps %}} + +## 使用 kubeadm 安装 Romana + +按照[容器化安装指南](https://github.com/romana/romana/tree/master/containerize)获取 kubeadmin。 + +## 运用网络策略 + +使用以下的一种方式去运用网络策略: + +* [Romana 网络策略](https://github.com/romana/romana/wiki/Romana-policies) + * [Romana 网络策略例子](https://github.com/romana/core/blob/master/doc/policy.md) +* NetworkPolicy API + +{{% /capture %}} + +{{% capture whatsnext %}} + +Romana 安装完成后,您可以按照[声明 Network Policy](/docs/tasks/administer-cluster/declare-network-policy/)去尝试使用 Kubernetes NetworkPolicy。 + +{{% /capture %}} diff --git a/content/zh/docs/tasks/administer-cluster/network-policy-provider/weave-network-policy.md b/content/zh/docs/tasks/administer-cluster/network-policy-provider/weave-network-policy.md new file mode 100644 index 0000000000..26eb7434ba --- /dev/null +++ b/content/zh/docs/tasks/administer-cluster/network-policy-provider/weave-network-policy.md @@ -0,0 +1,78 @@ +--- +reviewers: +- bboreham +title: 使用 Weave Net 作为 NetworkPolicy +content_template: templates/task +weight: 50 +--- + +{{% capture overview %}} + + + +本页展示了如何使用使用 Weave Net 作为 NetworkPolicy。 + +{{% /capture %}} + +{{% capture prerequisites %}} + +您需要拥有一个 Kubernetes 集群。按照[kubeadm 入门指南](/docs/getting-started-guides/kubeadm/)来引导一个。 +{{% /capture %}} + +{{% capture steps %}} + +## 安装 Weave Net 插件 + +按照[通过插件集成Kubernetes](https://www.weave.works/docs/net/latest/kube-addon/)指南。 + +Kubernetes 的 Weave Net 插件带有[网络策略控制器](https://www.weave.works/docs/net/latest/kube-addon/#npc),可自动监控 Kubernetes 所有名称空间中的任何 NetworkPolicy 注释。 配置`iptables`规则以允许或阻止策略指示的流量。 + + +## 测试安装 + +验证 weave 是否有效。 + +输入以下命令: + +```shell +kubectl get po -n kube-system -o wide +``` + + +输出类似这样: + +``` +NAME READY STATUS RESTARTS AGE IP NODE +weave-net-1t1qg 2/2 Running 0 9d 192.168.2.10 worknode3 +weave-net-231d7 2/2 Running 1 7d 10.2.0.17 worknodegpu +weave-net-7nmwt 2/2 Running 3 9d 192.168.2.131 masternode +weave-net-pmw8w 2/2 Running 0 9d 192.168.2.216 worknode2 +``` + + +每个 Node 都有一个 weave Pod,所有 Pod 都是`Running`和`2/2 READY`。(`2/2`表示每个Pod都有`weave`和`weave-npc`。) + +{{% /capture %}} + +{{% capture whatsnext %}} + + +安装Weave Net插件后,您可以按照[声明网络策略](/docs/tasks/administration-cluster/declare-network-policy/)来试用 Kubernetes NetworkPolicy。 如果您有任何疑问,请联系我们[#weave-community on Slack 或 Weave User Group](https://github.com/weaveworks/weave#getting-help)。 +{{% /capture %}} + diff --git a/content/cn/docs/tasks/administer-cluster/pod1.yaml b/content/zh/docs/tasks/administer-cluster/pod1.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/pod1.yaml rename to content/zh/docs/tasks/administer-cluster/pod1.yaml diff --git a/content/cn/docs/tasks/administer-cluster/pod2.yaml b/content/zh/docs/tasks/administer-cluster/pod2.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/pod2.yaml rename to content/zh/docs/tasks/administer-cluster/pod2.yaml diff --git a/content/cn/docs/tasks/administer-cluster/pod3.yaml b/content/zh/docs/tasks/administer-cluster/pod3.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/pod3.yaml rename to content/zh/docs/tasks/administer-cluster/pod3.yaml diff --git a/content/cn/docs/tasks/administer-cluster/quota-mem-cpu-pod-2.yaml b/content/zh/docs/tasks/administer-cluster/quota-mem-cpu-pod-2.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/quota-mem-cpu-pod-2.yaml rename to content/zh/docs/tasks/administer-cluster/quota-mem-cpu-pod-2.yaml diff --git a/content/cn/docs/tasks/administer-cluster/quota-mem-cpu-pod.yaml b/content/zh/docs/tasks/administer-cluster/quota-mem-cpu-pod.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/quota-mem-cpu-pod.yaml rename to content/zh/docs/tasks/administer-cluster/quota-mem-cpu-pod.yaml diff --git a/content/cn/docs/tasks/administer-cluster/quota-mem-cpu.yaml b/content/zh/docs/tasks/administer-cluster/quota-mem-cpu.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/quota-mem-cpu.yaml rename to content/zh/docs/tasks/administer-cluster/quota-mem-cpu.yaml diff --git a/content/cn/docs/tasks/administer-cluster/quota-objects-pvc-2.yaml b/content/zh/docs/tasks/administer-cluster/quota-objects-pvc-2.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/quota-objects-pvc-2.yaml rename to content/zh/docs/tasks/administer-cluster/quota-objects-pvc-2.yaml diff --git a/content/cn/docs/tasks/administer-cluster/quota-objects-pvc.yaml b/content/zh/docs/tasks/administer-cluster/quota-objects-pvc.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/quota-objects-pvc.yaml rename to content/zh/docs/tasks/administer-cluster/quota-objects-pvc.yaml diff --git a/content/cn/docs/tasks/administer-cluster/quota-objects.yaml b/content/zh/docs/tasks/administer-cluster/quota-objects.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/quota-objects.yaml rename to content/zh/docs/tasks/administer-cluster/quota-objects.yaml diff --git a/content/cn/docs/tasks/administer-cluster/quota-pod-deployment.yaml b/content/zh/docs/tasks/administer-cluster/quota-pod-deployment.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/quota-pod-deployment.yaml rename to content/zh/docs/tasks/administer-cluster/quota-pod-deployment.yaml diff --git a/content/cn/docs/tasks/administer-cluster/quota-pod-namespace.md b/content/zh/docs/tasks/administer-cluster/quota-pod-namespace.md similarity index 100% rename from content/cn/docs/tasks/administer-cluster/quota-pod-namespace.md rename to content/zh/docs/tasks/administer-cluster/quota-pod-namespace.md diff --git a/content/cn/docs/tasks/administer-cluster/quota-pod.yaml b/content/zh/docs/tasks/administer-cluster/quota-pod.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/quota-pod.yaml rename to content/zh/docs/tasks/administer-cluster/quota-pod.yaml diff --git a/content/cn/docs/tasks/administer-cluster/quota-pvc-2.yaml b/content/zh/docs/tasks/administer-cluster/quota-pvc-2.yaml similarity index 100% rename from content/cn/docs/tasks/administer-cluster/quota-pvc-2.yaml rename to content/zh/docs/tasks/administer-cluster/quota-pvc-2.yaml diff --git a/content/cn/docs/tasks/administer-cluster/romana-network-policy.md b/content/zh/docs/tasks/administer-cluster/romana-network-policy.md similarity index 100% rename from content/cn/docs/tasks/administer-cluster/romana-network-policy.md rename to content/zh/docs/tasks/administer-cluster/romana-network-policy.md diff --git a/content/cn/docs/tasks/administer-cluster/static-pod.md b/content/zh/docs/tasks/administer-cluster/static-pod.md similarity index 100% rename from content/cn/docs/tasks/administer-cluster/static-pod.md rename to content/zh/docs/tasks/administer-cluster/static-pod.md diff --git a/content/zh/docs/tasks/administer-cluster/sysctl-cluster.md b/content/zh/docs/tasks/administer-cluster/sysctl-cluster.md new file mode 100644 index 0000000000..9ca39883f3 --- /dev/null +++ b/content/zh/docs/tasks/administer-cluster/sysctl-cluster.md @@ -0,0 +1,329 @@ +--- +title: 在 Kubernetes 集群中使用 sysctl +reviewers: +- sttts +content_template: templates/task +--- + + + +{{% capture overview %}} +{{< feature-state for_k8s_version="v1.11" state="beta" >}} + + +本文档介绍如何通过 sysctl 接口在 Kubernetes 集群中配置和使用内核参数。 + +{{% /capture %}} + +{{% capture prerequisites %}} + +{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + +{{% /capture %}} + +{{% capture steps %}} + + +## 获取 Sysctl 的参数列表 + + +在 Linux 中,管理员可以通过 sysctl 接口修改内核运行时的参数。在 `/proc/sys/` 虚拟文件系统下存放许多内核参数。这些参数涉及了多个内核子系统,如: + + +- 内核子系统 (通常前缀为: `kernel.`) +- 网络子系统 (通常前缀为: `net.`) +- 虚拟内存子系统 (通常前缀为: `vm.`) +- MDADM 子系统 (通常前缀为: `dev.`) +- 更多子系统请参见 [内核文档](https://www.kernel.org/doc/Documentation/sysctl/README)。 + + +若要获取完整的参数列表,请执行以下命令 + +```shell +$ sudo sysctl -a +``` + + +## 启用非安全的 Sysctl 参数 + + +sysctl 参数分为 _安全_ 和 _非安全的_。_安全_ sysctl 参数除了需要设置恰当的命名空间外,在同一 node 上的不同 Pod 之间也必须是 _相互隔离的_。这意味着在 Pod 上设置 _安全_ sysctl 参数 + + +- 必须不能影响到节点上的其他 Pod +- 必须不能损害节点的健康 +- 必须不允许使用超出 Pod 的资源限制的 CPU 或内存资源。 + + +至今为止,大多数 _有命名空间的_ sysctl 参数不一定被认为是 _安全_ 的。以下几种 sysctl 参数是 _安全的_: + +- `kernel.shm_rmid_forced`, +- `net.ipv4.ip_local_port_range`, +- `net.ipv4.tcp_syncookies`. + +{{< note >}} + +**注意**: 示例中的 `net.ipv4.tcp_syncookies` 在Linux 内核 4.4 或更低的版本中是无命名空间的。 +{{< /note >}} + + +在未来的 Kubernetes 版本中,若kubelet 支持更好的隔离机制,则上述列表中将会列出更多 _安全的_ sysctl 参数。 + + +所有 _安全的_ sysctl 参数都默认启用。 + + +所有 _非安全的_ sysctl 参数都默认禁用,且必须由集群管理员在每个节点上手动开启。那些设置了不安全 sysctl 参数的 Pod 仍会被调度,但无法正常启动。 + + +参考上述警告,集群管理员只有在一些非常特殊的情况下(如:高可用或实时应用调整),才可以启用特定的 _非安全的_ sysctl 参数。如需启用 _非安全的_ sysctl 参数,请您在每个节点上分别设置 kubelet 命令行参数,例如: + +```shell +$ kubelet --allowed-unsafe-sysctls \ + 'kernel.msg*,net.ipv4.route.min_pmtu' ... +``` + +如果您使用 minikube,可以通过 `extra-config` 参数来配置: + +```shell +$ minikube start --extra-config="kubelet.AllowedUnsafeSysctls=kernel.msg*,net.ipv4.route.min_pmtu"... +``` + +只有 _有命名空间的_ sysctl 参数可以通过该方式启用。 + + +## 设置 Pod 的 Sysctl 参数 + + +目前,在 Linux 内核中,有许多的 sysctl 参数都是 _有命名空间的_ 。 这就意味着可以为节点上的每个 Pod 分别去设置它们的 sysctl 参数。 在 Kubernetes 中,只有那些有命名空间的 sysctl 参数可以通过 Pod 的 securityContext 对其进行配置。 + + +以下列出有命名空间的 sysctl 参数,在未来的 Linux 内核版本中,此列表可能会发生变化。 + +- `kernel.shm*`, +- `kernel.msg*`, +- `kernel.sem`, +- `fs.mqueue.*`, +- `net.*`. + + +没有命名空间的 sysctl 参数称为 _节点级别的_ sysctl 参数。 如果需要对其进行设置,则必须在每个节点的操作系统上手动地去配置它们,或者通过在 DaemonSet 中运行特权模式容器来配置。 + + +可使用 pod 的 securityContext 来配置有命名空间的 sysctl 参数,securityContext 应用于同一个 pod 中的所有容器。 + + +此示例中,使用 Pod SecurityContext 来对一个安全的 sysctl 参数 `kernel.shm_rmid_forced` 以及两个非安全的 sysctl 参数 `net.ipv4.route.min_pmtu`和 `kernel.msgmax` 进行设置。在 Pod 规格中对 _安全的_ 和 _非安全的_ sysctl 参数不做区分。 + +{{< warning >}} + +为了避免破坏操作系统的稳定性,请您在了解变更后果之后再修改 sysctl 参数。 +{{< /warning >}} + +```yaml +apiVersion: v1 +kind: Pod +metadata: + name: sysctl-example +spec: + securityContext: + sysctls: + - name: kernel.shm_rmid_forced + value: "0" + - name: net.ipv4.route.min_pmtu + value: "552" + - name: kernel.msgmax + value: "65536" + ... +``` +{{% /capture %}} + +{{% capture discussion %}} + +{{< warning >}} + +**警告**:由于 _非安全的_ sysctl 参数其本身具有不稳定性,在使用 _非安全的_ sysctl 参数时可能会导致一些严重问题,如容器的错误行为、机器资源不足或节点被完全破坏,用户需自行承担风险。 +{{< /warning >}} + + +最佳实践方案是将集群中具有特殊 sysctl 设置的节点视为 _受感染的_,并且只调度需要使用到特殊 sysctl 设置的 Pod 到这些节点上。 建议使用 Kubernetes 的 [ _taints 和 toleration_ 特性](/docs/reference/generated/kubectl/kubectl-commands/#taint) 来实现它。 + + +设置了 _非安全的_ sysctl 参数的 pod,在禁用了以下两种 _非安全的_ sysctl 参数配置的节点上启动都会失败。与 _节点级别的_ sysctl 一样,建议开启 +[_taints 和 toleration_ 特性](/docs/reference/generated/kubectl/kubectl-commands/#taint) 或 +[taints on nodes](/docs/concepts/configuration/taint-and-toleration/) +以便将 Pod 调度到正确的节点之上。 + +## PodSecurityPolicy + + +您可以通过在 PodSecurityPolicy 的 `forbiddenSysctls` 和/或 `allowedUnsafeSysctls` 字段中,指定 sysctl 或填写 sysctl 匹配模式来进一步为 Pod 设置 sysctl 参数。sysctl 参数匹配模式以 `*` 字符结尾,如 `kernel.*`。 单独的 `*` 字符匹配所有 sysctl 参数。 + + +所有 _安全的_ sysctl 参数都默认启用。 + + +`forbiddenSysctls` 和 `allowedUnsafeSysctls` 的值都是字符串列表类型,可以添加 sysctl 参数名称,也可以添加 sysctl 参数匹配模式(以`*`结尾)。 只填写 `*` 则匹配所有的 sysctl 参数。 + + +`forbiddenSysctls` 字段用于禁用特定的 sysctl 参数。 您可以在列表中禁用安全和非安全的 sysctl 参数的组合。 要禁用所有的 sysctl 参数,请设置为 `*`。 + + +如果要在 `allowedUnsafeSysctls` 字段中指定一个非安全的 sysctl 参数,并且它在`forbiddenSysctls` 字段中未被禁用,则可以在 Pod 中通过 PodSecurityPolicy 启用该 sysctl 参数。 若要在 PodSecurityPolicy 中开启所有非安全的 sysctl 参数,请设 `allowedUnsafeSysctls` 字段值为 `*`。 + + +`allowedUnsafeSysctls` 与 `forbiddenSysctls` 两字段的配置不能重叠,否则这就意味着存在某个 sysctl 参数既被启用又被禁用。 + +{{< warning >}} + +**警告**:如果您通过 PodSecurityPolicy 中的 `allowedUnsafeSysctls` 字段将非安全的 sysctl 参数列入白名单,但该 sysctl 参数未通过 kubelet 命令行参数 `--allowed-unsafe-sysctls` 在节点上将其列入白名单,则设置了这个 sysctl 参数的 Pod 将会启动失败。 +{{< /warning >}} + + +以下示例设置启用了以 `kernel.msg` 为前缀的非安全的 sysctl 参数,以及禁用了 sysctl 参数 `kernel.shm_rmid_forced`。 + +```yaml +apiVersion: policy/v1beta1 +kind: PodSecurityPolicy +metadata: + name: sysctl-psp +spec: + allowedUnsafeSysctls: + - kernel.msg* + forbiddenSysctls: + - kernel.shm_rmid_forced + ... +``` + +{{% /capture %}} diff --git a/content/cn/docs/tasks/administer-cluster/weave-network-policy.md b/content/zh/docs/tasks/administer-cluster/weave-network-policy.md similarity index 100% rename from content/cn/docs/tasks/administer-cluster/weave-network-policy.md rename to content/zh/docs/tasks/administer-cluster/weave-network-policy.md diff --git a/content/zh/docs/tasks/configure-pod-container/assign-pods-nodes.md b/content/zh/docs/tasks/configure-pod-container/assign-pods-nodes.md new file mode 100644 index 0000000000..ec39525304 --- /dev/null +++ b/content/zh/docs/tasks/configure-pod-container/assign-pods-nodes.md @@ -0,0 +1,135 @@ +--- +title: 将 Pod 分配给节点 +content_template: templates/task +weight: 120 +--- + + +{{% capture overview %}} + +此页面显示如何将 Kubernetes Pod 分配给 Kubernetes 集群中的特定节点。 +{{% /capture %}} + +{{% capture prerequisites %}} + +{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + +{{% /capture %}} + +{{% capture steps %}} + + +## 给节点添加标签 + + +1. 列出集群中的节点 + + kubectl get nodes + + + 输出类似如下: + + NAME STATUS AGE VERSION + worker0 Ready 1d v1.6.0+fff5156 + worker1 Ready 1d v1.6.0+fff5156 + worker2 Ready 1d v1.6.0+fff5156 + + +1. 选择其中一个节点,为它添加标签: + + kubectl label nodes disktype=ssd + + + `` 是你选择的节点的名称。 + + +1. 验证你选择的节点是否有 `disktype=ssd` 标签: + + kubectl get nodes --show-labels + + + + 输出类似如下: + + NAME STATUS AGE VERSION LABELS + worker0 Ready 1d v1.6.0+fff5156 ...,disktype=ssd,kubernetes.io/hostname=worker0 + worker1 Ready 1d v1.6.0+fff5156 ...,kubernetes.io/hostname=worker1 + worker2 Ready 1d v1.6.0+fff5156 ...,kubernetes.io/hostname=worker2 + + + 在前面的输出中,你可以看到 `worker0` 节点有 `disktype=ssd` 标签。 + + +## 创建一个调度到你选择的节点的 pod + + +该 pod 配置文件描述了一个拥有节点选择器 `disktype: ssd` 的 pod。这表明该 pod 将被调度到 +有 `disktype=ssd` 标签的节点。 + +{{< codenew file="pods/pod-nginx.yaml" >}} + + +1. 使用该配置文件去创建一个 pod,该 pod 将被调度到你选择的节点上: + + kubectl create -f https://k8s.io/examples/pods/pod-nginx.yaml + + +1. 验证 pod 是不是运行在你选择的节点上: + + kubectl get pods --output=wide + + + 输出类似如下: + + NAME READY STATUS RESTARTS AGE IP NODE + nginx 1/1 Running 0 13s 10.200.0.4 worker0 + +{{% /capture %}} + +{{% capture whatsnext %}} + +了解更多关于 +[标签和选择器](/docs/concepts/overview/working-with-objects/labels/)。 +{{% /capture %}} diff --git a/content/cn/docs/tasks/configure-pod-container/cpu-request-limit-2.yaml b/content/zh/docs/tasks/configure-pod-container/cpu-request-limit-2.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/cpu-request-limit-2.yaml rename to content/zh/docs/tasks/configure-pod-container/cpu-request-limit-2.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/cpu-request-limit.yaml b/content/zh/docs/tasks/configure-pod-container/cpu-request-limit.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/cpu-request-limit.yaml rename to content/zh/docs/tasks/configure-pod-container/cpu-request-limit.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/exec-liveness.yaml b/content/zh/docs/tasks/configure-pod-container/exec-liveness.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/exec-liveness.yaml rename to content/zh/docs/tasks/configure-pod-container/exec-liveness.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/http-liveness.yaml b/content/zh/docs/tasks/configure-pod-container/http-liveness.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/http-liveness.yaml rename to content/zh/docs/tasks/configure-pod-container/http-liveness.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/init-containers.yaml b/content/zh/docs/tasks/configure-pod-container/init-containers.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/init-containers.yaml rename to content/zh/docs/tasks/configure-pod-container/init-containers.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/lifecycle-events.yaml b/content/zh/docs/tasks/configure-pod-container/lifecycle-events.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/lifecycle-events.yaml rename to content/zh/docs/tasks/configure-pod-container/lifecycle-events.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/mem-limit-range.yaml b/content/zh/docs/tasks/configure-pod-container/mem-limit-range.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/mem-limit-range.yaml rename to content/zh/docs/tasks/configure-pod-container/mem-limit-range.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/memory-request-limit-2.yaml b/content/zh/docs/tasks/configure-pod-container/memory-request-limit-2.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/memory-request-limit-2.yaml rename to content/zh/docs/tasks/configure-pod-container/memory-request-limit-2.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/memory-request-limit-3.yaml b/content/zh/docs/tasks/configure-pod-container/memory-request-limit-3.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/memory-request-limit-3.yaml rename to content/zh/docs/tasks/configure-pod-container/memory-request-limit-3.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/memory-request-limit.yaml b/content/zh/docs/tasks/configure-pod-container/memory-request-limit.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/memory-request-limit.yaml rename to content/zh/docs/tasks/configure-pod-container/memory-request-limit.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/oir-pod-2.yaml b/content/zh/docs/tasks/configure-pod-container/oir-pod-2.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/oir-pod-2.yaml rename to content/zh/docs/tasks/configure-pod-container/oir-pod-2.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/oir-pod.yaml b/content/zh/docs/tasks/configure-pod-container/oir-pod.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/oir-pod.yaml rename to content/zh/docs/tasks/configure-pod-container/oir-pod.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/opaque-integer-resource.md b/content/zh/docs/tasks/configure-pod-container/opaque-integer-resource.md similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/opaque-integer-resource.md rename to content/zh/docs/tasks/configure-pod-container/opaque-integer-resource.md diff --git a/content/cn/docs/tasks/configure-pod-container/pod-redis.yaml b/content/zh/docs/tasks/configure-pod-container/pod-redis.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/pod-redis.yaml rename to content/zh/docs/tasks/configure-pod-container/pod-redis.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/pod.yaml b/content/zh/docs/tasks/configure-pod-container/pod.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/pod.yaml rename to content/zh/docs/tasks/configure-pod-container/pod.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/private-reg-pod.yaml b/content/zh/docs/tasks/configure-pod-container/private-reg-pod.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/private-reg-pod.yaml rename to content/zh/docs/tasks/configure-pod-container/private-reg-pod.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/projected-volume.yaml b/content/zh/docs/tasks/configure-pod-container/projected-volume.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/projected-volume.yaml rename to content/zh/docs/tasks/configure-pod-container/projected-volume.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/qos-pod-2.yaml b/content/zh/docs/tasks/configure-pod-container/qos-pod-2.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/qos-pod-2.yaml rename to content/zh/docs/tasks/configure-pod-container/qos-pod-2.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/qos-pod-3.yaml b/content/zh/docs/tasks/configure-pod-container/qos-pod-3.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/qos-pod-3.yaml rename to content/zh/docs/tasks/configure-pod-container/qos-pod-3.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/qos-pod-4.yaml b/content/zh/docs/tasks/configure-pod-container/qos-pod-4.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/qos-pod-4.yaml rename to content/zh/docs/tasks/configure-pod-container/qos-pod-4.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/qos-pod.yaml b/content/zh/docs/tasks/configure-pod-container/qos-pod.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/qos-pod.yaml rename to content/zh/docs/tasks/configure-pod-container/qos-pod.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/rq-compute-resources.yaml b/content/zh/docs/tasks/configure-pod-container/rq-compute-resources.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/rq-compute-resources.yaml rename to content/zh/docs/tasks/configure-pod-container/rq-compute-resources.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/security-context-2.yaml b/content/zh/docs/tasks/configure-pod-container/security-context-2.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/security-context-2.yaml rename to content/zh/docs/tasks/configure-pod-container/security-context-2.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/security-context-3.yaml b/content/zh/docs/tasks/configure-pod-container/security-context-3.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/security-context-3.yaml rename to content/zh/docs/tasks/configure-pod-container/security-context-3.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/security-context-4.yaml b/content/zh/docs/tasks/configure-pod-container/security-context-4.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/security-context-4.yaml rename to content/zh/docs/tasks/configure-pod-container/security-context-4.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/security-context.yaml b/content/zh/docs/tasks/configure-pod-container/security-context.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/security-context.yaml rename to content/zh/docs/tasks/configure-pod-container/security-context.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/task-pv-claim.yaml b/content/zh/docs/tasks/configure-pod-container/task-pv-claim.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/task-pv-claim.yaml rename to content/zh/docs/tasks/configure-pod-container/task-pv-claim.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/task-pv-pod.yaml b/content/zh/docs/tasks/configure-pod-container/task-pv-pod.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/task-pv-pod.yaml rename to content/zh/docs/tasks/configure-pod-container/task-pv-pod.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/task-pv-volume.yaml b/content/zh/docs/tasks/configure-pod-container/task-pv-volume.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/task-pv-volume.yaml rename to content/zh/docs/tasks/configure-pod-container/task-pv-volume.yaml diff --git a/content/cn/docs/tasks/configure-pod-container/tcp-liveness-readiness.yaml b/content/zh/docs/tasks/configure-pod-container/tcp-liveness-readiness.yaml similarity index 100% rename from content/cn/docs/tasks/configure-pod-container/tcp-liveness-readiness.yaml rename to content/zh/docs/tasks/configure-pod-container/tcp-liveness-readiness.yaml diff --git a/content/zh/docs/tasks/debug-application-cluster/audit.md b/content/zh/docs/tasks/debug-application-cluster/audit.md new file mode 100644 index 0000000000..fe551d011d --- /dev/null +++ b/content/zh/docs/tasks/debug-application-cluster/audit.md @@ -0,0 +1,612 @@ +--- +reviewers: +- soltysh +- sttts +- ericchiang +content_template: templates/concept +title: Auditing +--- + +{{% capture overview %}} + +{{< feature-state state="beta" >}} + + +Kubernetes 审计功能提供了与安全相关的按时间顺序排列的记录集,记录单个用户、管理员或系统其他组件影响系统的活动顺序。 +它能帮助集群管理员处理以下问题: + + + - 发生了什么? + - 什么时候发生的? + - 谁触发的? + - 活动发生在哪个(些)对象上? + - 在哪观察到的? + - 它从哪触发的? + - 活动的后续处理行为是什么? + +{{% /capture %}} + +{{< toc >}} + +{{% capture body %}} + + +[Kube-apiserver][kube-apiserver] 执行审计。每个执行阶段的每个请求都会生成一个事件,然后根据特定策略对事件进行预处理并写入后端。 +您可以在 [设计方案][auditing-proposal] 中找到更多详细信息。 +该策略确定记录的内容并且在后端存储记录。当前的后端支持日志文件和 webhook。 + + + +每个请求都可以用相关的 "stage" 记录。已知的 stage 有: + +- `RequestReceived` - 事件的 stage 将在审计处理器接收到请求后,并且在委托给其余处理器之前生成。 + +- `ResponseStarted` - 在响应消息的头部发送后,但是响应消息体发送前。这个 stage 仅为长时间运行的请求生成(例如 watch)。 + +- `ResponseComplete` - 当响应消息体完成并且没有更多数据需要传输的时候。 +- `Panic` - 当 panic 发生时生成。 + +{{< note >}} + +**注意** 审计日志记录功能会增加 API server 的内存消耗,因为需要为每个请求存储审计所需的某些上下文。 +此外,内存消耗取决于审计日志记录的配置。 +{{< /note >}} + + +## 审计策略 + +审计政策定义了关于应记录哪些事件以及应包含哪些数据的规则。审计策略对象结构在 [`audit.k8s.io` API 组][auditing-api] 中定义。 +处理事件时,将按顺序与规则列表进行比较。第一个匹配规则设置事件的 [审计级别][auditing-level]。已知的审计级别有: + + +- `None` - 符合这条规则的日志将不会记录。 +- `Metadata` - 记录请求的 metadata(请求的用户、timestamp、resource、verb 等等),但是不记录请求或者响应的消息体。 +- `Request` - 记录事件的 metadata 和请求的消息体,但是不记录响应的消息体。这不适用于非资源类型的请求。 +- `RequestResponse` - 记录事件的 metadata,请求和响应的消息体。这不适用于非资源类型的请求。 + + +您可以使用 `--audit-policy-file` 标志将包含策略的文件传递给 [kube-apiserver][kube-apiserver]。如果不设置该标志,则不记录事件。 +注意 `rules` 字段 __必须__ 在审计策略文件中提供。没有(0)规则的策略将被视为非法配置。 + +以下是一个审计策略文件的示例: + +{{< codenew file="audit/audit-policy.yaml" >}} + + +您可以使用最低限度的审计策略文件在 `Metadata` 级别记录所有请求: + +```yaml +# Log all requests at the Metadata level. +apiVersion: audit.k8s.io/v1beta1 +kind: Policy +rules: +- level: Metadata +``` + + +管理员构建自己的审计配置文件时,应使用 [GCE 使用的审计配置文件][gce-audit-profile] 作为参考。 + + +## 审计后端 + +审计后端实现将审计事件导出到外部存储。 +[Kube-apiserver][kube-apiserver] 提供两个后端: + +- Log 后端,将事件写入到磁盘 +- Webhook 后端,将事件发送到外部 API + +在这两种情况下,审计事件结构均由 `audit.k8s.io` API 组中的 API 定义。当前版本的 API 是 [`v1beta1`][auditing-api]。 + +{{< note >}} + +**注意:** 在 patch 请求的情况下,请求的消息体需要是一个 JSON 串指定 patch 操作,而不是一个完整的 Kubernetes API 对象 JSON 串。 +例如,以下的示例是一个合法的 patch 请求消息体,该请求对应 `/apis/batch/v1/namespaces/some-namespace/jobs/some-job-name`。 + +```json +[ + { + "op": "replace", + "path": "/spec/parallelism", + "value": 0 + }, + { + "op": "remove", + "path": "/spec/template/spec/containers/0/terminationMessagePolicy" + } +] +``` +{{< /note >}} + + +### Log 后端 + +Log 后端将审计事件写入 JSON 格式的文件。您可以使用以下 [kube-apiserver][kube-apiserver] 标志配置 Log 审计后端: + + +- `--audit-log-path` 指定用来写入审计事件的日志文件路径。不指定此标志会禁用日志后端。`-` 意味着标准化 +- `--audit-log-maxage` 定义了保留旧审计日志文件的最大天数 +- `--audit-log-maxbackup` 定义了要保留的审计日志文件的最大数量 +- `--audit-log-maxsize` 定义审计日志文件的最大大小(兆字节) + + +### Webhook 后端 + +Webhook 后端将审计事件发送到远程 API,该远程 API 应该暴露与 [kube-apiserver][kube-apiserver] 相同的API。 +您可以使用如下 kube-apiserver 标志来配置 webhook 审计后端: + + +- `--audit-webhook-config-file` webhook 配置文件的路径。Webhook 配置文件实际上是一个 [kubeconfig][kubeconfig]。 +- `--audit-webhook-initial-backoff` 指定在第一次失败后重发请求等待的时间。随后的请求将以指数退避重试。 + +webhook 配置文件使用 kubeconfig 格式指定服务的远程地址和用于连接它的凭据。 + +### Batching + + + +log 和 webhook 后端都支持 batch。以 webhook 为例,以下是可用参数列表。要获取 log 后端的同样参数,请在参数名称中将 `webhook` 替换为 `log`。 +默认情况下,在 `webhook` 中启用 batch,在 `log` 中禁用 batch。同样,默认情况下,在 `webhook` 中启用限制,在 `log` 中禁用限制。 + +- `--audit-webhook-mode` 定义缓存策略,可选值如下: + - `batch` - 以批处理缓存事件和异步的过程。这是默认值。 + - `blocking` - 阻止 API server 处理每个单独事件的响应。 + + +以下参数仅用于 `batch` 模式。 + +- `--audit-webhook-batch-buffer-size` 定义 batch 之前要缓存的事件数。 + 如果传入事件的速率溢出缓存区,则会丢弃事件。 +- `--audit-webhook-batch-max-size` 定义一个 batch 中的最大事件数。 +- `--audit-webhook-batch-max-wait` 无条件 batch 队列中的事件前等待的最大事件。 +- `--audit-webhook-batch-throttle-qps` 每秒生成的最大 batch 平均值。 +- `--audit-webhook-batch-throttle-burst` 在达到允许的 QPS 前,同一时刻允许存在的最大 batch 生成数。 + + +#### 参数调整 + +需要设置参数以适应 apiserver 上的负载。 + + +例如,如果 kube-apiserver 每秒收到 100 个请求,并且每个请求仅在 `ResponseStarted` 和 `ResponseComplete` 阶段进行审计,则应该考虑每秒生成约 200 个审计事件。 +假设批处理中最多有 100 个事件,则应将限制级别设置为至少 2 个 QPS。 +假设后端最多需要 5 秒钟来写入事件,您应该设置缓冲区大小以容纳最多 5 秒的事件,即 10 个 batch,即 1000 个事件。 + + +但是,在大多数情况下,默认参数应该足够了,您不必手动设置它们。您可以查看 kube-apiserver 公开的以下 Prometheus 指标,并在日志中监控审计子系统的状态。 + +- `apiserver_audit_event_total` 包含所有暴露的审计事件数量的指标。 +- `apiserver_audit_error_total` 在暴露时由于发生错误而被丢弃的事件的数量。 + + +## 多集群配置 + +如果您通过 [aggregation layer][kube-aggregator] 对 Kubernetes API 进行扩展,那么您也可以为聚合的 apiserver 设置审计日志。 +想要这么做,您需要以上述的格式给聚合的 apiserver 配置参数,并且配置日志管道以采用审计日志。不同的 apiserver 可以配置不同的审计配置和策略。 + + +## 日志选择器示例 + +### 使用 fluentd 从日志文件中选择并且分发审计日志 + +[Fluentd][fluentd] 是一个开源的数据采集器,可以从统一的日志层中采集。 +在以下示例中,我们将使用 fluentd 来按照命名空间划分审计事件。 + +1. 在 kube-apiserver node 节点上安装 [fluentd, fluent-plugin-forest and fluent-plugin-rewrite-tag-filter][fluentd_install_doc] +1. 为 fluentd 创建一个配置文件 + + ```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. 启动 fluentd + + ```shell + $ fluentd -c /etc/fluentd/config -vv + ``` + + +1. 给 kube-apiserver 配置以下参数并启动: + + ```shell + --audit-policy-file=/etc/kubernetes/audit-policy.yaml --audit-log-path=/var/log/kube-audit --audit-log-format=json + ``` + + +1. 在 `/var/log/audit-*.log` 文件中检查不同命名空间的审计事件 + + +### 使用 logstash 采集并分发 webhook 后端的审计事件 + +[Logstash][logstash] 是一个开源的、服务器端的数据处理工具。在下面的示例中,我们将使用 logstash 采集 webhook 后端的审计事件,并且将来自不同用户的事件存入不同的文件。 + +1. 安装 [logstash][logstash_install_doc] +1. 为 logstash 创建配置文件 + + ```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. 启动 logstash + + ```shell + $ bin/logstash -f /etc/logstash/config --path.settings /etc/logstash/ + ``` + + +1. 为 kube-apiserver webhook 审计后端创建一个 [kubeconfig 文件](/docs/tasks/access-application-cluster/authenticate-across-clusters-kubeconfig/) + + ```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. 为 kube-apiserver 配置以下参数并启动: + + ```shell + --audit-policy-file=/etc/kubernetes/audit-policy.yaml --audit-webhook-config-file=/etc/kubernetes/audit-webhook-kubeconfig + ``` + + +1. 在 logstash node 节点的 `/var/log/kube-audit-*/audit` 目录中检查审计事件 + +注意到,除了文件输出插件外,logstash 还有其它多种输出可以让用户路由不同的数据。例如,用户可以将审计事件发送给支持全文搜索和分析的 elasticsearch 插件。 + + +## 传统的审计 + +__注意:__ 传统审计已被弃用,自 1.8 版本以后默认禁用,并且将会在 1.12 版本中彻底移除。 +如果想要回退到传统的审计功能,请使用 [kube-apiserver][kube-apiserver] 中 feature gate 的 `AdvancedAuditing` 功能来禁用高级审核功能: + +``` +--feature-gates=AdvancedAuditing=false +``` + + +在传统格式中,每个审计文件条目包含两行: + +1. 请求行包含唯一 ID 以匹配响应和请求元数据,例如源 IP、请求用户、模拟信息和请求的资源等。 +2. 响应行包含与请求行和响应代码相匹配的唯一 ID。 + +``` +2017-03-21T03:57:09.106841886-04:00 AUDIT: id="c939d2a7-1c37-4ef1-b2f7-4ba9b1e43b53" ip="127.0.0.1" method="GET" user="admin" groups="\"system:masters\",\"system:authenticated\"" as="" asgroups="" namespace="default" uri="/api/v1/namespaces/default/pods" +2017-03-21T03:57:09.108403639-04:00 AUDIT: id="c939d2a7-1c37-4ef1-b2f7-4ba9b1e43b53" response="200" +``` + + +### 配置 + +[Kube-apiserver][kube-apiserver] 提供以下选项,负责配置审核日志的位置和处理方式: + + +- `audit-log-path` - 使审计日志指向请求被记录到的文件,'-' 表示标准输出。 +- `audit-log-maxage` - 根据文件名中编码的时间戳指定保留旧审计日志文件的最大天数。 +- `audit-log-maxbackup` - 指定要保留的旧审计日志文件的最大数量。 +- `audit-log-maxsize` - 指定审核日志文件的最大大小(兆字节)。默认为100MB。 + + +如果审核日志文件已经存在,则 Kubernetes 会将新的审核日志附加到该文件。 +否则,Kubernetes 会在您在 `audit-log-path` 中指定的位置创建一个审计日志文件。 +如果审计日志文件超过了您在 `audit-log-maxsize` 中指定的大小,则 Kubernetes 将通过在文件名(在文件扩展名之前)附加当前时间戳并重新创建一个新的审计日志文件来重命名当前日志文件。 +Kubernetes 可能会在创建新的日志文件时删除旧的日志文件; 您可以通过指定 `audit-log-maxbackup` 和 `audit-log-maxage` 选项来配置保留多少文件以及它们的保留时间。 + +[kube-apiserver]: /docs/admin/kube-apiserver +[auditing-proposal]: https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/auditing.md +[auditing-api]: https://github.com/kubernetes/kubernetes/blob/{{< param "githubbranch" >}}/staging/src/k8s.io/apiserver/pkg/apis/audit/v1beta1/types.go +[gce-audit-profile]: https://github.com/kubernetes/kubernetes/blob/{{< param "githubbranch" >}}/cluster/gce/gci/configure-helper.sh#L735 +[kubeconfig]: https://kubernetes.io/docs/tasks/access-application-cluster/configure-access-multiple-clusters/ +[fluentd]: http://www.fluentd.org/ +[fluentd_install_doc]: http://docs.fluentd.org/v0.12/articles/quickstart#step1-installing-fluentd +[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/cn/docs/tasks/debug-application-cluster/debug-application.md b/content/zh/docs/tasks/debug-application-cluster/debug-application.md similarity index 100% rename from content/cn/docs/tasks/debug-application-cluster/debug-application.md rename to content/zh/docs/tasks/debug-application-cluster/debug-application.md diff --git a/content/cn/docs/tasks/debug-application-cluster/debug-cluster.md b/content/zh/docs/tasks/debug-application-cluster/debug-cluster.md similarity index 100% rename from content/cn/docs/tasks/debug-application-cluster/debug-cluster.md rename to content/zh/docs/tasks/debug-application-cluster/debug-cluster.md diff --git a/content/cn/docs/tasks/debug-application-cluster/debug-pod-replication-controller.md b/content/zh/docs/tasks/debug-application-cluster/debug-pod-replication-controller.md similarity index 100% rename from content/cn/docs/tasks/debug-application-cluster/debug-pod-replication-controller.md rename to content/zh/docs/tasks/debug-application-cluster/debug-pod-replication-controller.md diff --git a/content/cn/docs/tasks/debug-application-cluster/debug-stateful-set.md b/content/zh/docs/tasks/debug-application-cluster/debug-stateful-set.md similarity index 100% rename from content/cn/docs/tasks/debug-application-cluster/debug-stateful-set.md rename to content/zh/docs/tasks/debug-application-cluster/debug-stateful-set.md diff --git a/content/cn/docs/tasks/inject-data-application/commands.yaml b/content/zh/docs/tasks/inject-data-application/commands.yaml similarity index 100% rename from content/cn/docs/tasks/inject-data-application/commands.yaml rename to content/zh/docs/tasks/inject-data-application/commands.yaml diff --git a/content/cn/docs/tasks/inject-data-application/dapi-envars-container.yaml b/content/zh/docs/tasks/inject-data-application/dapi-envars-container.yaml similarity index 100% rename from content/cn/docs/tasks/inject-data-application/dapi-envars-container.yaml rename to content/zh/docs/tasks/inject-data-application/dapi-envars-container.yaml diff --git a/content/cn/docs/tasks/inject-data-application/dapi-envars-pod.yaml b/content/zh/docs/tasks/inject-data-application/dapi-envars-pod.yaml similarity index 100% rename from content/cn/docs/tasks/inject-data-application/dapi-envars-pod.yaml rename to content/zh/docs/tasks/inject-data-application/dapi-envars-pod.yaml diff --git a/content/cn/docs/tasks/inject-data-application/dapi-volume-resources.yaml b/content/zh/docs/tasks/inject-data-application/dapi-volume-resources.yaml similarity index 100% rename from content/cn/docs/tasks/inject-data-application/dapi-volume-resources.yaml rename to content/zh/docs/tasks/inject-data-application/dapi-volume-resources.yaml diff --git a/content/cn/docs/tasks/inject-data-application/dapi-volume.yaml b/content/zh/docs/tasks/inject-data-application/dapi-volume.yaml similarity index 100% rename from content/cn/docs/tasks/inject-data-application/dapi-volume.yaml rename to content/zh/docs/tasks/inject-data-application/dapi-volume.yaml diff --git a/content/cn/docs/tasks/inject-data-application/define-command-argument-container.md b/content/zh/docs/tasks/inject-data-application/define-command-argument-container.md similarity index 100% rename from content/cn/docs/tasks/inject-data-application/define-command-argument-container.md rename to content/zh/docs/tasks/inject-data-application/define-command-argument-container.md diff --git a/content/cn/docs/tasks/inject-data-application/define-environment-variable-container.md b/content/zh/docs/tasks/inject-data-application/define-environment-variable-container.md similarity index 100% rename from content/cn/docs/tasks/inject-data-application/define-environment-variable-container.md rename to content/zh/docs/tasks/inject-data-application/define-environment-variable-container.md diff --git a/content/cn/docs/tasks/inject-data-application/distribute-credentials-secure.md b/content/zh/docs/tasks/inject-data-application/distribute-credentials-secure.md similarity index 100% rename from content/cn/docs/tasks/inject-data-application/distribute-credentials-secure.md rename to content/zh/docs/tasks/inject-data-application/distribute-credentials-secure.md diff --git a/content/cn/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information.md b/content/zh/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information.md similarity index 100% rename from content/cn/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information.md rename to content/zh/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information.md diff --git a/content/cn/docs/tasks/inject-data-application/envars.yaml b/content/zh/docs/tasks/inject-data-application/envars.yaml similarity index 100% rename from content/cn/docs/tasks/inject-data-application/envars.yaml rename to content/zh/docs/tasks/inject-data-application/envars.yaml diff --git a/content/cn/docs/tasks/inject-data-application/environment-variable-expose-pod-information.md b/content/zh/docs/tasks/inject-data-application/environment-variable-expose-pod-information.md similarity index 100% rename from content/cn/docs/tasks/inject-data-application/environment-variable-expose-pod-information.md rename to content/zh/docs/tasks/inject-data-application/environment-variable-expose-pod-information.md diff --git a/content/cn/docs/tasks/inject-data-application/podpreset-allow-db-merged.yaml b/content/zh/docs/tasks/inject-data-application/podpreset-allow-db-merged.yaml similarity index 100% rename from content/cn/docs/tasks/inject-data-application/podpreset-allow-db-merged.yaml rename to content/zh/docs/tasks/inject-data-application/podpreset-allow-db-merged.yaml diff --git a/content/cn/docs/tasks/inject-data-application/podpreset-allow-db.yaml b/content/zh/docs/tasks/inject-data-application/podpreset-allow-db.yaml similarity index 100% rename from content/cn/docs/tasks/inject-data-application/podpreset-allow-db.yaml rename to content/zh/docs/tasks/inject-data-application/podpreset-allow-db.yaml diff --git a/content/cn/docs/tasks/inject-data-application/podpreset-configmap.yaml b/content/zh/docs/tasks/inject-data-application/podpreset-configmap.yaml similarity index 100% rename from content/cn/docs/tasks/inject-data-application/podpreset-configmap.yaml rename to content/zh/docs/tasks/inject-data-application/podpreset-configmap.yaml diff --git a/content/cn/docs/tasks/inject-data-application/podpreset-conflict-pod.yaml b/content/zh/docs/tasks/inject-data-application/podpreset-conflict-pod.yaml similarity index 100% rename from content/cn/docs/tasks/inject-data-application/podpreset-conflict-pod.yaml rename to content/zh/docs/tasks/inject-data-application/podpreset-conflict-pod.yaml diff --git a/content/cn/docs/tasks/inject-data-application/podpreset-conflict-preset.yaml b/content/zh/docs/tasks/inject-data-application/podpreset-conflict-preset.yaml similarity index 100% rename from content/cn/docs/tasks/inject-data-application/podpreset-conflict-preset.yaml rename to content/zh/docs/tasks/inject-data-application/podpreset-conflict-preset.yaml diff --git a/content/cn/docs/tasks/inject-data-application/podpreset-merged.yaml b/content/zh/docs/tasks/inject-data-application/podpreset-merged.yaml similarity index 100% rename from content/cn/docs/tasks/inject-data-application/podpreset-merged.yaml rename to content/zh/docs/tasks/inject-data-application/podpreset-merged.yaml diff --git a/content/cn/docs/tasks/inject-data-application/podpreset-multi-merged.yaml b/content/zh/docs/tasks/inject-data-application/podpreset-multi-merged.yaml similarity index 100% rename from content/cn/docs/tasks/inject-data-application/podpreset-multi-merged.yaml rename to content/zh/docs/tasks/inject-data-application/podpreset-multi-merged.yaml diff --git a/content/cn/docs/tasks/inject-data-application/podpreset-pod.yaml b/content/zh/docs/tasks/inject-data-application/podpreset-pod.yaml similarity index 100% rename from content/cn/docs/tasks/inject-data-application/podpreset-pod.yaml rename to content/zh/docs/tasks/inject-data-application/podpreset-pod.yaml diff --git a/content/cn/docs/tasks/inject-data-application/podpreset-preset.yaml b/content/zh/docs/tasks/inject-data-application/podpreset-preset.yaml similarity index 100% rename from content/cn/docs/tasks/inject-data-application/podpreset-preset.yaml rename to content/zh/docs/tasks/inject-data-application/podpreset-preset.yaml diff --git a/content/cn/docs/tasks/inject-data-application/podpreset-proxy.yaml b/content/zh/docs/tasks/inject-data-application/podpreset-proxy.yaml similarity index 100% rename from content/cn/docs/tasks/inject-data-application/podpreset-proxy.yaml rename to content/zh/docs/tasks/inject-data-application/podpreset-proxy.yaml diff --git a/content/cn/docs/tasks/inject-data-application/podpreset-replicaset-merged.yaml b/content/zh/docs/tasks/inject-data-application/podpreset-replicaset-merged.yaml similarity index 100% rename from content/cn/docs/tasks/inject-data-application/podpreset-replicaset-merged.yaml rename to content/zh/docs/tasks/inject-data-application/podpreset-replicaset-merged.yaml diff --git a/content/cn/docs/tasks/inject-data-application/podpreset-replicaset.yaml b/content/zh/docs/tasks/inject-data-application/podpreset-replicaset.yaml similarity index 100% rename from content/cn/docs/tasks/inject-data-application/podpreset-replicaset.yaml rename to content/zh/docs/tasks/inject-data-application/podpreset-replicaset.yaml diff --git a/content/cn/docs/tasks/inject-data-application/podpreset.md b/content/zh/docs/tasks/inject-data-application/podpreset.md similarity index 100% rename from content/cn/docs/tasks/inject-data-application/podpreset.md rename to content/zh/docs/tasks/inject-data-application/podpreset.md diff --git a/content/cn/docs/tasks/inject-data-application/secret-envars-pod.yaml b/content/zh/docs/tasks/inject-data-application/secret-envars-pod.yaml similarity index 100% rename from content/cn/docs/tasks/inject-data-application/secret-envars-pod.yaml rename to content/zh/docs/tasks/inject-data-application/secret-envars-pod.yaml diff --git a/content/cn/docs/tasks/inject-data-application/secret-pod.yaml b/content/zh/docs/tasks/inject-data-application/secret-pod.yaml similarity index 100% rename from content/cn/docs/tasks/inject-data-application/secret-pod.yaml rename to content/zh/docs/tasks/inject-data-application/secret-pod.yaml diff --git a/content/cn/docs/tasks/inject-data-application/secret.yaml b/content/zh/docs/tasks/inject-data-application/secret.yaml similarity index 100% rename from content/cn/docs/tasks/inject-data-application/secret.yaml rename to content/zh/docs/tasks/inject-data-application/secret.yaml diff --git a/content/zh/docs/tasks/job/fine-parallel-processing-work-queue.md b/content/zh/docs/tasks/job/fine-parallel-processing-work-queue.md new file mode 100755 index 0000000000..4d4d3432dc --- /dev/null +++ b/content/zh/docs/tasks/job/fine-parallel-processing-work-queue.md @@ -0,0 +1,380 @@ +--- +cn-approvers: +- linyouchong +title: 使用工作队列进行精细的并行处理 +content_template: templates/task +weight: 40 +--- + + +{{% capture overview %}} + + +在这个例子中,我们会运行一个Kubernetes Job,其中的 Pod 会运行多个并行工作进程。 + + +在这个例子中,当每个pod被创建时,它会从一个任务队列中获取一个工作单元,处理它,然后重复,直到到达队列的尾部。 + + + +下面是这个示例的步骤概述 + + +1. **启动存储服务用于保存工作队列。** 在这个例子中,我们使用 Redis 来存储工作项。在上一个例子中,我们使用了 RabbitMQ。在这个例子中,由于 AMQP 不能为客户端提供一个良好的方法来检测一个有限长度的工作队列是否为空,我们使用了 Redis 和一个自定义的工作队列客户端库。在实践中,您可能会设置一个类似于 Redis 的存储库,并将其同时用于多项任务或其他事务的工作队列。 + +1. **创建一个队列,然后向其中填充消息。** 每个消息表示一个将要被处理的工作任务。在这个例子中,消息只是一个我们将用于进行长度计算的整数。 + +1. **启动一个 Job 对队列中的任务进行处理**。这个 Job 启动了若干个 Pod 。每个 Pod 从消息队列中取出一个工作任务,处理它,然后重复,直到到达队列的尾部。 + +{{% /capture %}} + +{{< toc >}} + +{{% capture prerequisites %}} + +{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} + +{{% /capture %}} + +{{% capture steps %}} + + +熟秋基础知识,非并行方式运行 [Job](/docs/concepts/jobs/run-to-completion-finite-workloads/)。 + +{{% /capture %}} + +{{% capture steps %}} + + +## 启动 Redis + + +对于这个例子,为了简单起见,我们将启动一个单实例的 Redis。 +了解如何部署一个可伸缩、高可用的 Redis 例子,请查看 [Redis 样例](https://github.com/kubernetes/examples/tree/master/guestbook) + + +如果您在使用本文档库的源代码目录,您可以进入如下目录,然后启动一个临时的 Pod 用于运行 Redis 和 一个临时的 service 以便我们能够找到这个 Pod + +```shell +$ cd content/en/examples/application/job/redis +$ kubectl create -f ./redis-pod.yaml +pod/redis-master created +$ kubectl create -f ./redis-service.yaml +service/redis created +``` + + +如果您没有使用本文档库的源代码目录,您可以直接下载如下文件: + +- [`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) + + +## 使用任务填充队列 + + +现在,让我们往队列里添加一些“任务”。在这个例子中,我们的任务只是一些将被打印出来的字符串。 + + +启动一个临时的可交互的 pod 用于运行 Redis 命令行界面。 + +```shell +$ kubectl run -i --tty temp --image redis --command "/bin/sh" +Waiting for pod default/redis2-c7h78 to be running, status is Pending, pod ready: false +Hit enter for command prompt +``` + + +现在按回车键,启动 redis 命令行界面,然后创建一个存在若干个工作项的列表。 + +``` +# redis-cli -h redis +redis:6379> rpush job2 "apple" +(integer) 1 +redis:6379> rpush job2 "banana" +(integer) 2 +redis:6379> rpush job2 "cherry" +(integer) 3 +redis:6379> rpush job2 "date" +(integer) 4 +redis:6379> rpush job2 "fig" +(integer) 5 +redis:6379> rpush job2 "grape" +(integer) 6 +redis:6379> rpush job2 "lemon" +(integer) 7 +redis:6379> rpush job2 "melon" +(integer) 8 +redis:6379> rpush job2 "orange" +(integer) 9 +redis:6379> lrange job2 0 -1 +1) "apple" +2) "banana" +3) "cherry" +4) "date" +5) "fig" +6) "grape" +7) "lemon" +8) "melon" +9) "orange" +``` + + +因此,这个键为 `job2` 的列表就是我们的工作队列。 + + +注意:如果您还没有正确地配置 Kube DNS,您可能需要将上面的第一步改为 `redis-cli -h $REDIS_SERVICE_HOST`。 + + + +创建镜像 + + +现在我们已经准备好创建一个我们要运行的镜像 + + +我们会使用一个带有 redis 客户端的 python 工作程序从消息队列中读出消息。 + + +这里提供了一个简单的 Redis 工作队列客户端库,叫 rediswq.py ([下载](/examples/application/job/redis/rediswq.py))。 + + +Job 中每个 Pod 内的 “工作程序” 使用工作队列客户端库获取工作。如下: + +{{< codenew language="python" file="application/job/redis/worker.py" >}} + + +如果您在使用本文档库的源代码目录,请将当前目录切换到 `content/en/examples/application/job/redis/`。否则,请点击链接下载 [`worker.py`](/examples/application/job/redis/worker.py)、 [`rediswq.py`](/examples/application/job/redis/rediswq.py) 和 [`Dockerfile`](/examples/application/job/redis/Dockerfile)。然后构建镜像: + +```shell +docker build -t job-wq-2 . +``` + + +### Push 镜像 + + +对于 [Docker Hub](https://hub.docker.com/),请先用您的用户名给镜像打上标签,然后使用下面的命令 push 您的镜像到仓库。请将 `` 替换为您自己的用户名。 + +```shell +docker tag job-wq-2 /job-wq-2 +docker push /job-wq-2 +``` + + +您需要将镜像 push 到一个公共仓库或者 [配置集群访问您的私有仓库](/docs/concepts/containers/images/)。 + + +如果您使用的是 [Google Container +Registry](https://cloud.google.com/tools/container-registry/),请先用您的 project ID 给您的镜像打上标签,然后 push 到 GCR 。请将 `` 替换为您自己的 project ID + +```shell +docker tag job-wq-2 gcr.io//job-wq-2 +gcloud docker -- push gcr.io//job-wq-2 +``` + + +## 定义一个 Job + + +这是 job 定义: + +{{< codenew file="application/job/redis/job.yaml" >}} + + +请确保将 job 模板中的 `gcr.io/myproject` 更改为您自己的路径。 + + +在这个例子中,每个 pod 处理了队列中的多个项目,直到队列中没有项目时便退出。因为是由工作程序自行检测工作队列是否为空,并且 Job 控制器不知道工作队列的存在,所以依赖于工作程序在完成工作时发出信号。工作程序以成功退出的形式发出信号表示工作队列已经为空。所以,只要有任意一个工作程序成功退出,控制器就知道工作已经完成了,所有的 Pod 将很快会退出。因此,我们将 Job 的 completion count 设置为 1 。尽管如此,Job 控制器还是会等待其它 Pod 完成。 + + + +## 运行 Job + + +现在运行这个 Job : + +```shell +kubectl create -f ./job.yaml +``` + + +稍等片刻,然后检查这个 Job。 + +```shell +$ kubectl describe jobs/job-wq-2 +Name: job-wq-2 +Namespace: default +Selector: controller-uid=b1c7e4e3-92e1-11e7-b85e-fa163ee3c11f +Labels: controller-uid=b1c7e4e3-92e1-11e7-b85e-fa163ee3c11f + job-name=job-wq-2 +Annotations: +Parallelism: 2 +Completions: +Start Time: Mon, 11 Jan 2016 17:07:59 -0800 +Pods Statuses: 1 Running / 0 Succeeded / 0 Failed +Pod Template: + Labels: controller-uid=b1c7e4e3-92e1-11e7-b85e-fa163ee3c11f + job-name=job-wq-2 + Containers: + c: + Image: gcr.io/exampleproject/job-wq-2 + Port: + Environment: + Mounts: + Volumes: +Events: + FirstSeen LastSeen Count From SubobjectPath Type Reason Message + --------- -------- ----- ---- ------------- -------- ------ ------- + 33s 33s 1 {job-controller } Normal SuccessfulCreate Created pod: job-wq-2-lglf8 + + +$ kubectl logs pods/job-wq-2-7r7b2 +Worker with sessionID: bbd72d0a-9e5c-4dd6-abf6-416cc267991f +Initial queue state: empty=False +Working on banana +Working on date +Working on lemon +``` + + +您可以看到,其中的一个 pod 处理了若干个工作单元。 + +{{% /capture %}} + +{{% capture discussion %}} + + +## 其它 + + +如果您不方便运行一个队列服务或者修改您的容器用于运行一个工作队列,您可以考虑其它的 [job 模式](/docs/concepts/jobs/run-to-completion-finite-workloads/#job-patterns)。 + + +如果您有连续的后台处理业务,那么可以考虑使用 `replicationController` 来运行您的后台业务,和运行一个类似 [https://github.com/resque/resque](https://github.com/resque/resque) 的后台处理库。 + +{{% /capture %}} diff --git a/content/cn/docs/tasks/manage-daemon/rollback-daemon-set.md b/content/zh/docs/tasks/manage-daemon/rollback-daemon-set.md similarity index 100% rename from content/cn/docs/tasks/manage-daemon/rollback-daemon-set.md rename to content/zh/docs/tasks/manage-daemon/rollback-daemon-set.md diff --git a/content/cn/docs/tasks/manage-gpus/scheduling-gpus.md b/content/zh/docs/tasks/manage-gpus/scheduling-gpus.md similarity index 100% rename from content/cn/docs/tasks/manage-gpus/scheduling-gpus.md rename to content/zh/docs/tasks/manage-gpus/scheduling-gpus.md diff --git a/content/cn/docs/tasks/manage-hugepages/scheduling-hugepages.md b/content/zh/docs/tasks/manage-hugepages/scheduling-hugepages.md similarity index 100% rename from content/cn/docs/tasks/manage-hugepages/scheduling-hugepages.md rename to content/zh/docs/tasks/manage-hugepages/scheduling-hugepages.md diff --git a/content/cn/docs/tasks/run-application/deployment-patch-demo.yaml b/content/zh/docs/tasks/run-application/deployment-patch-demo.yaml similarity index 100% rename from content/cn/docs/tasks/run-application/deployment-patch-demo.yaml rename to content/zh/docs/tasks/run-application/deployment-patch-demo.yaml diff --git a/content/cn/docs/tasks/run-application/deployment-scale.yaml b/content/zh/docs/tasks/run-application/deployment-scale.yaml similarity index 100% rename from content/cn/docs/tasks/run-application/deployment-scale.yaml rename to content/zh/docs/tasks/run-application/deployment-scale.yaml diff --git a/content/cn/docs/tasks/run-application/deployment-update.yaml b/content/zh/docs/tasks/run-application/deployment-update.yaml similarity index 100% rename from content/cn/docs/tasks/run-application/deployment-update.yaml rename to content/zh/docs/tasks/run-application/deployment-update.yaml diff --git a/content/cn/docs/tasks/run-application/deployment.yaml b/content/zh/docs/tasks/run-application/deployment.yaml similarity index 100% rename from content/cn/docs/tasks/run-application/deployment.yaml rename to content/zh/docs/tasks/run-application/deployment.yaml diff --git a/content/cn/docs/tasks/run-application/gce-volume.yaml b/content/zh/docs/tasks/run-application/gce-volume.yaml similarity index 100% rename from content/cn/docs/tasks/run-application/gce-volume.yaml rename to content/zh/docs/tasks/run-application/gce-volume.yaml diff --git a/content/cn/docs/tasks/run-application/mysql-configmap.yaml b/content/zh/docs/tasks/run-application/mysql-configmap.yaml similarity index 100% rename from content/cn/docs/tasks/run-application/mysql-configmap.yaml rename to content/zh/docs/tasks/run-application/mysql-configmap.yaml diff --git a/content/cn/docs/tasks/run-application/mysql-deployment.yaml b/content/zh/docs/tasks/run-application/mysql-deployment.yaml similarity index 100% rename from content/cn/docs/tasks/run-application/mysql-deployment.yaml rename to content/zh/docs/tasks/run-application/mysql-deployment.yaml diff --git a/content/cn/docs/tasks/run-application/mysql-services.yaml b/content/zh/docs/tasks/run-application/mysql-services.yaml similarity index 100% rename from content/cn/docs/tasks/run-application/mysql-services.yaml rename to content/zh/docs/tasks/run-application/mysql-services.yaml diff --git a/content/cn/docs/tasks/run-application/mysql-statefulset.yaml b/content/zh/docs/tasks/run-application/mysql-statefulset.yaml similarity index 100% rename from content/cn/docs/tasks/run-application/mysql-statefulset.yaml rename to content/zh/docs/tasks/run-application/mysql-statefulset.yaml diff --git a/content/cn/docs/tasks/run-application/rolling-update-replication-controller.md b/content/zh/docs/tasks/run-application/rolling-update-replication-controller.md similarity index 100% rename from content/cn/docs/tasks/run-application/rolling-update-replication-controller.md rename to content/zh/docs/tasks/run-application/rolling-update-replication-controller.md diff --git a/content/cn/docs/tasks/run-application/run-single-instance-stateful-application.md b/content/zh/docs/tasks/run-application/run-single-instance-stateful-application.md similarity index 100% rename from content/cn/docs/tasks/run-application/run-single-instance-stateful-application.md rename to content/zh/docs/tasks/run-application/run-single-instance-stateful-application.md diff --git a/content/cn/docs/tasks/run-application/run-stateless-application-deployment.md b/content/zh/docs/tasks/run-application/run-stateless-application-deployment.md similarity index 100% rename from content/cn/docs/tasks/run-application/run-stateless-application-deployment.md rename to content/zh/docs/tasks/run-application/run-stateless-application-deployment.md diff --git a/content/cn/docs/tasks/run-application/scale-stateful-set.md b/content/zh/docs/tasks/run-application/scale-stateful-set.md similarity index 100% rename from content/cn/docs/tasks/run-application/scale-stateful-set.md rename to content/zh/docs/tasks/run-application/scale-stateful-set.md diff --git a/content/cn/docs/tasks/tls/certificate-rotation.md b/content/zh/docs/tasks/tls/certificate-rotation.md similarity index 100% rename from content/cn/docs/tasks/tls/certificate-rotation.md rename to content/zh/docs/tasks/tls/certificate-rotation.md diff --git a/content/cn/docs/templates/index.md b/content/zh/docs/templates/index.md similarity index 100% rename from content/cn/docs/templates/index.md rename to content/zh/docs/templates/index.md diff --git a/content/cn/docs/tutorials/configuration/configure-redis-using-configmap.md b/content/zh/docs/tutorials/configuration/configure-redis-using-configmap.md similarity index 100% rename from content/cn/docs/tutorials/configuration/configure-redis-using-configmap.md rename to content/zh/docs/tutorials/configuration/configure-redis-using-configmap.md diff --git a/content/cn/docs/tutorials/kubernetes-basics/_index.html b/content/zh/docs/tutorials/kubernetes-basics/_index.html similarity index 100% rename from content/cn/docs/tutorials/kubernetes-basics/_index.html rename to content/zh/docs/tutorials/kubernetes-basics/_index.html diff --git a/content/cn/docs/tutorials/kubernetes-basics/cluster-interactive.html b/content/zh/docs/tutorials/kubernetes-basics/cluster-interactive.html similarity index 100% rename from content/cn/docs/tutorials/kubernetes-basics/cluster-interactive.html rename to content/zh/docs/tutorials/kubernetes-basics/cluster-interactive.html diff --git a/content/cn/docs/tutorials/kubernetes-basics/cluster-intro.html b/content/zh/docs/tutorials/kubernetes-basics/cluster-intro.html similarity index 100% rename from content/cn/docs/tutorials/kubernetes-basics/cluster-intro.html rename to content/zh/docs/tutorials/kubernetes-basics/cluster-intro.html diff --git a/content/cn/docs/tutorials/kubernetes-basics/deploy-interactive.html b/content/zh/docs/tutorials/kubernetes-basics/deploy-interactive.html similarity index 100% rename from content/cn/docs/tutorials/kubernetes-basics/deploy-interactive.html rename to content/zh/docs/tutorials/kubernetes-basics/deploy-interactive.html diff --git a/content/cn/docs/tutorials/kubernetes-basics/deploy-intro.html b/content/zh/docs/tutorials/kubernetes-basics/deploy-intro.html similarity index 100% rename from content/cn/docs/tutorials/kubernetes-basics/deploy-intro.html rename to content/zh/docs/tutorials/kubernetes-basics/deploy-intro.html diff --git a/content/cn/docs/tutorials/kubernetes-basics/explore-interactive.html b/content/zh/docs/tutorials/kubernetes-basics/explore-interactive.html similarity index 100% rename from content/cn/docs/tutorials/kubernetes-basics/explore-interactive.html rename to content/zh/docs/tutorials/kubernetes-basics/explore-interactive.html diff --git a/content/cn/docs/tutorials/kubernetes-basics/explore-intro.html b/content/zh/docs/tutorials/kubernetes-basics/explore-intro.html similarity index 100% rename from content/cn/docs/tutorials/kubernetes-basics/explore-intro.html rename to content/zh/docs/tutorials/kubernetes-basics/explore-intro.html diff --git a/content/cn/docs/tutorials/kubernetes-basics/expose-interactive.html b/content/zh/docs/tutorials/kubernetes-basics/expose-interactive.html similarity index 100% rename from content/cn/docs/tutorials/kubernetes-basics/expose-interactive.html rename to content/zh/docs/tutorials/kubernetes-basics/expose-interactive.html diff --git a/content/cn/docs/tutorials/kubernetes-basics/expose-intro.html b/content/zh/docs/tutorials/kubernetes-basics/expose-intro.html similarity index 100% rename from content/cn/docs/tutorials/kubernetes-basics/expose-intro.html rename to content/zh/docs/tutorials/kubernetes-basics/expose-intro.html diff --git a/content/cn/docs/tutorials/kubernetes-basics/scale-interactive.html b/content/zh/docs/tutorials/kubernetes-basics/scale-interactive.html similarity index 100% rename from content/cn/docs/tutorials/kubernetes-basics/scale-interactive.html rename to content/zh/docs/tutorials/kubernetes-basics/scale-interactive.html diff --git a/content/cn/docs/tutorials/kubernetes-basics/scale-intro.html b/content/zh/docs/tutorials/kubernetes-basics/scale-intro.html similarity index 100% rename from content/cn/docs/tutorials/kubernetes-basics/scale-intro.html rename to content/zh/docs/tutorials/kubernetes-basics/scale-intro.html diff --git a/content/zh/docs/tutorials/kubernetes-basics/scale/scale-intro.html b/content/zh/docs/tutorials/kubernetes-basics/scale/scale-intro.html new file mode 100644 index 0000000000..aeff024382 --- /dev/null +++ b/content/zh/docs/tutorials/kubernetes-basics/scale/scale-intro.html @@ -0,0 +1,136 @@ + +--- +title: 运行应用程序的多个实例 +weight: 10 +--- + + + + + +
+
+
+
+ +

目的

+
    + +
  • 用 kubectl 扩缩应用程序
  • +
+
+ +
+ +

扩缩应用程序

+ + +

在之前的模块中,我们创建了一个 Deployment,然后通过 Service让其可以开放访问。Deployment 仅为跑这个应用程序创建了一个 Pod。 当流量增加时,我们需要扩容应用程序满足用户需求。

+ + +

扩缩 是通过改变 Deployment 中的副本数量来实现的。

+ +
+
+
+ +

小结:

+
    + +
  • 扩缩一个 Deployment
  • +
+
+
+ +

在运行 kubectl run 命令时,你可以通过设置 --replicas 参数来设置 Deployment 的副本数。

+
+
+
+
+ +
+
+ +

扩缩概述

+
+
+ +
+
+
+ +
+
+ +
+ +
+
+ + +

扩展 Deployment 将创建新的 Pods,并将资源调度请求分配到有可用资源的节点上,收缩 会将 Pods 数量减少至所需的状态。Kubernetes 还支持 Pods 的自动缩放,但这并不在本教程的讨论范围内。将 Pods 数量收缩到0也是可以的,但这会终止 Deployment 上所有已经部署的 Pods。

+ + +

运行应用程序的多个实例需要在它们之间分配流量。服务 (Service)有一种负载均衡器类型,可以将网络流量均衡分配到外部可访问的 Pods 上。服务将会一直通过端点来监视 Pods 的运行,保证流量只分配到可用的 Pods 上。

+ +
+
+
+ +

扩缩是通过改变 Deployment 中的副本数量来实现的。

+
+
+
+ +
+ +
+
+ +

一旦有了多个应用实例,就可以没有宕机地滚动更新。我们将会在下面的模块中介绍这些。现在让我们使用在线终端来体验一下应用程序的扩缩过程。

+
+
+
+ + + +
+ +
+ + + diff --git a/content/cn/docs/tutorials/kubernetes-basics/update-interactive.html b/content/zh/docs/tutorials/kubernetes-basics/update-interactive.html similarity index 100% rename from content/cn/docs/tutorials/kubernetes-basics/update-interactive.html rename to content/zh/docs/tutorials/kubernetes-basics/update-interactive.html diff --git a/content/cn/docs/tutorials/kubernetes-basics/update-intro.html b/content/zh/docs/tutorials/kubernetes-basics/update-intro.html similarity index 100% rename from content/cn/docs/tutorials/kubernetes-basics/update-intro.html rename to content/zh/docs/tutorials/kubernetes-basics/update-intro.html diff --git a/content/cn/docs/tutorials/object-management-kubectl/imperative-object-management-command.md b/content/zh/docs/tutorials/object-management-kubectl/imperative-object-management-command.md similarity index 100% rename from content/cn/docs/tutorials/object-management-kubectl/imperative-object-management-command.md rename to content/zh/docs/tutorials/object-management-kubectl/imperative-object-management-command.md diff --git a/content/cn/docs/tutorials/object-management-kubectl/object-management.md b/content/zh/docs/tutorials/object-management-kubectl/object-management.md similarity index 100% rename from content/cn/docs/tutorials/object-management-kubectl/object-management.md rename to content/zh/docs/tutorials/object-management-kubectl/object-management.md diff --git a/content/cn/docs/tutorials/services/source-ip.md b/content/zh/docs/tutorials/services/source-ip.md similarity index 95% rename from content/cn/docs/tutorials/services/source-ip.md rename to content/zh/docs/tutorials/services/source-ip.md index c4b4bd34e9..77da6af9d0 100644 --- a/content/cn/docs/tutorials/services/source-ip.md +++ b/content/zh/docs/tutorials/services/source-ip.md @@ -116,7 +116,7 @@ command=GET ## Type=NodePort 类型 Services 的 Source IP -对于 Kubernetes 1.5,发送给类型为 [Type=NodePort](/docs/user-guide/services/#nodeport) Services 的数据包默认进行源地址 NAT。你可以创建一个 `NodePort` Service 来进行测试: +对于 Kubernetes 1.5,发送给类型为 [Type=NodePort](/docs/user-guide/services/#type-nodeport) Services 的数据包默认进行源地址 NAT。你可以创建一个 `NodePort` Service 来进行测试: ```console $ kubectl expose deployment source-ip-app --name=nodeport --port=80 --target-port=8080 --type=NodePort @@ -210,7 +210,7 @@ client_address=104.132.1.79 ## Type=LoadBalancer 类型 Services 的 Source IP -对于 Kubernetes 1.5,发送给类型为 [Type=LoadBalancer](/docs/user-guide/services/#nodeport) Services 的数据包默认进行源地址 NAT,这是由于所有处于 `Ready` 状态的 Kubernetes 节点对于负载均衡的流量都是符合条件的。所以如果数据包到达一个没有 endpoint 的节点,系统将把这个包代理到*有* endpoint 的节点,并替换数据包的源 IP 为节点的 IP(如前面章节所述)。 +对于 Kubernetes 1.5,发送给类型为 [Type=LoadBalancer](/docs/user-guide/services/#type-nodeport) Services 的数据包默认进行源地址 NAT,这是由于所有处于 `Ready` 状态的 Kubernetes 节点对于负载均衡的流量都是符合条件的。所以如果数据包到达一个没有 endpoint 的节点,系统将把这个包代理到*有* endpoint 的节点,并替换数据包的源 IP 为节点的 IP(如前面章节所述)。 你可以通过在一个 loadbalancer 上暴露这个 source-ip-app 来进行测试。 diff --git a/content/cn/docs/tutorials/stateful-application/Dockerfile b/content/zh/docs/tutorials/stateful-application/Dockerfile similarity index 100% rename from content/cn/docs/tutorials/stateful-application/Dockerfile rename to content/zh/docs/tutorials/stateful-application/Dockerfile diff --git a/content/cn/docs/tutorials/stateful-application/FETCH_HEAD b/content/zh/docs/tutorials/stateful-application/FETCH_HEAD similarity index 100% rename from content/cn/docs/tutorials/stateful-application/FETCH_HEAD rename to content/zh/docs/tutorials/stateful-application/FETCH_HEAD diff --git a/content/cn/docs/tutorials/stateful-application/basic-stateful-set.md b/content/zh/docs/tutorials/stateful-application/basic-stateful-set.md similarity index 99% rename from content/cn/docs/tutorials/stateful-application/basic-stateful-set.md rename to content/zh/docs/tutorials/stateful-application/basic-stateful-set.md index 9a5bfd9ed3..81a6b1b356 100644 --- a/content/cn/docs/tutorials/stateful-application/basic-stateful-set.md +++ b/content/zh/docs/tutorials/stateful-application/basic-stateful-set.md @@ -107,9 +107,10 @@ web-1 1/1 Running 0 18s 请注意在 `web-0` Pod 处于 [Running和Ready](/docs/user-guide/pod-states) 状态后 `web-1` Pod 才会被启动。 - + ## StatefulSet 中的 Pod diff --git a/content/cn/docs/tutorials/stateful-application/cassandra-service.yaml b/content/zh/docs/tutorials/stateful-application/cassandra-service.yaml similarity index 100% rename from content/cn/docs/tutorials/stateful-application/cassandra-service.yaml rename to content/zh/docs/tutorials/stateful-application/cassandra-service.yaml diff --git a/content/cn/docs/tutorials/stateful-application/cassandra-statefulset.yaml b/content/zh/docs/tutorials/stateful-application/cassandra-statefulset.yaml similarity index 100% rename from content/cn/docs/tutorials/stateful-application/cassandra-statefulset.yaml rename to content/zh/docs/tutorials/stateful-application/cassandra-statefulset.yaml diff --git a/content/cn/docs/tutorials/stateful-application/cassandra.md b/content/zh/docs/tutorials/stateful-application/cassandra.md similarity index 100% rename from content/cn/docs/tutorials/stateful-application/cassandra.md rename to content/zh/docs/tutorials/stateful-application/cassandra.md diff --git a/content/cn/docs/tutorials/stateful-application/dev b/content/zh/docs/tutorials/stateful-application/dev similarity index 100% rename from content/cn/docs/tutorials/stateful-application/dev rename to content/zh/docs/tutorials/stateful-application/dev diff --git a/content/cn/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md b/content/zh/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md similarity index 98% rename from content/cn/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md rename to content/zh/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md index 5d521f02c7..030d2c24e5 100644 --- a/content/cn/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md +++ b/content/zh/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume.md @@ -15,7 +15,7 @@ approvers: * [Persistent Volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) 定义持久化磁盘(磁盘生命周期不和 Pods 绑定)。 * [Services](https://kubernetes.io/docs/concepts/services-networking/service/) 使得 Pods 能够找到其它 Pods。 -* [External Load Balancers](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer) 对外暴露 Services。 +* [External Load Balancers](https://kubernetes.io/docs/concepts/services-networking/service/#type-loadbalancer) 对外暴露 Services。 * [Deployments](http://kubernetes.io/docs/user-guide/deployments/) 确保 Pods 持续运行。 * [Secrets](http://kubernetes.io/docs/user-guide/secrets/) 保存敏感密码信息。 @@ -66,7 +66,7 @@ kubectl create -f https://raw.githubusercontent.com/kubernetes/examples/master/m Kubernetes本质是模块化的,可以在各种环境中运行。但并不是所有集群都相同。此处是本示例的一些要求: * 需要 1.2 版本以上的 Kubernetes,以使用更新的特性,例如 PV Claims 和 Deployments。运行 `kubectl version` 来查看你的集群版本。 * [Cluster DNS](https://github.com/kubernetes/dns) 将被用于服务发现。 -* 一个 [external load balancer](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer) 将被用于接入 WordPress。 +* 一个 [external load balancer](https://kubernetes.io/docs/concepts/services-networking/service/#type-loadbalancer) 将被用于接入 WordPress。 * 使用了 [Persistent Volume Claims](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims)。你必须创建集群中需要的 Persistent Volumes。本示例将展示两种类型的 volume 的创建方法,但是任何类型的 volume 都是足够使用的。 diff --git a/content/cn/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/local-volumes.yaml b/content/zh/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/local-volumes.yaml similarity index 100% rename from content/cn/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/local-volumes.yaml rename to content/zh/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/local-volumes.yaml diff --git a/content/cn/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/mysql-deployment.yaml b/content/zh/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/mysql-deployment.yaml similarity index 100% rename from content/cn/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/mysql-deployment.yaml rename to content/zh/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/mysql-deployment.yaml diff --git a/content/cn/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/wordpress-deployment.yaml b/content/zh/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/wordpress-deployment.yaml similarity index 100% rename from content/cn/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/wordpress-deployment.yaml rename to content/zh/docs/tutorials/stateful-application/mysql-wordpress-persistent-volume/wordpress-deployment.yaml diff --git a/content/cn/docs/tutorials/stateful-application/web.yaml b/content/zh/docs/tutorials/stateful-application/web.yaml similarity index 100% rename from content/cn/docs/tutorials/stateful-application/web.yaml rename to content/zh/docs/tutorials/stateful-application/web.yaml diff --git a/content/cn/docs/tutorials/stateful-application/webp.yaml b/content/zh/docs/tutorials/stateful-application/webp.yaml similarity index 100% rename from content/cn/docs/tutorials/stateful-application/webp.yaml rename to content/zh/docs/tutorials/stateful-application/webp.yaml diff --git a/content/cn/docs/tutorials/stateful-application/zookeeper.md b/content/zh/docs/tutorials/stateful-application/zookeeper.md similarity index 100% rename from content/cn/docs/tutorials/stateful-application/zookeeper.md rename to content/zh/docs/tutorials/stateful-application/zookeeper.md diff --git a/content/cn/docs/tutorials/stateful-application/zookeeper.yaml b/content/zh/docs/tutorials/stateful-application/zookeeper.yaml similarity index 100% rename from content/cn/docs/tutorials/stateful-application/zookeeper.yaml rename to content/zh/docs/tutorials/stateful-application/zookeeper.yaml diff --git a/content/cn/docs/user-guide/bad-nginx-deployment.yaml b/content/zh/docs/user-guide/bad-nginx-deployment.yaml similarity index 100% rename from content/cn/docs/user-guide/bad-nginx-deployment.yaml rename to content/zh/docs/user-guide/bad-nginx-deployment.yaml diff --git a/content/cn/docs/user-guide/curlpod.yaml b/content/zh/docs/user-guide/curlpod.yaml similarity index 100% rename from content/cn/docs/user-guide/curlpod.yaml rename to content/zh/docs/user-guide/curlpod.yaml diff --git a/content/cn/docs/user-guide/deployment.yaml b/content/zh/docs/user-guide/deployment.yaml similarity index 100% rename from content/cn/docs/user-guide/deployment.yaml rename to content/zh/docs/user-guide/deployment.yaml diff --git a/content/cn/docs/user-guide/docker-cli-to-kubectl.md b/content/zh/docs/user-guide/docker-cli-to-kubectl.md similarity index 100% rename from content/cn/docs/user-guide/docker-cli-to-kubectl.md rename to content/zh/docs/user-guide/docker-cli-to-kubectl.md diff --git a/content/cn/docs/user-guide/ingress.yaml b/content/zh/docs/user-guide/ingress.yaml similarity index 100% rename from content/cn/docs/user-guide/ingress.yaml rename to content/zh/docs/user-guide/ingress.yaml diff --git a/content/cn/docs/user-guide/job.yaml b/content/zh/docs/user-guide/job.yaml similarity index 100% rename from content/cn/docs/user-guide/job.yaml rename to content/zh/docs/user-guide/job.yaml diff --git a/content/cn/docs/user-guide/jsonpath.md b/content/zh/docs/user-guide/jsonpath.md similarity index 100% rename from content/cn/docs/user-guide/jsonpath.md rename to content/zh/docs/user-guide/jsonpath.md diff --git a/content/cn/docs/user-guide/kubectl-overview.md b/content/zh/docs/user-guide/kubectl-overview.md similarity index 100% rename from content/cn/docs/user-guide/kubectl-overview.md rename to content/zh/docs/user-guide/kubectl-overview.md diff --git a/content/cn/docs/user-guide/multi-pod.yaml b/content/zh/docs/user-guide/multi-pod.yaml similarity index 100% rename from content/cn/docs/user-guide/multi-pod.yaml rename to content/zh/docs/user-guide/multi-pod.yaml diff --git a/content/cn/docs/user-guide/new-nginx-deployment.yaml b/content/zh/docs/user-guide/new-nginx-deployment.yaml similarity index 100% rename from content/cn/docs/user-guide/new-nginx-deployment.yaml rename to content/zh/docs/user-guide/new-nginx-deployment.yaml diff --git a/content/cn/docs/user-guide/nginx-app.yaml b/content/zh/docs/user-guide/nginx-app.yaml similarity index 100% rename from content/cn/docs/user-guide/nginx-app.yaml rename to content/zh/docs/user-guide/nginx-app.yaml diff --git a/content/cn/docs/user-guide/nginx-deployment.yaml b/content/zh/docs/user-guide/nginx-deployment.yaml similarity index 100% rename from content/cn/docs/user-guide/nginx-deployment.yaml rename to content/zh/docs/user-guide/nginx-deployment.yaml diff --git a/content/cn/docs/user-guide/nginx-init-containers.yaml b/content/zh/docs/user-guide/nginx-init-containers.yaml similarity index 100% rename from content/cn/docs/user-guide/nginx-init-containers.yaml rename to content/zh/docs/user-guide/nginx-init-containers.yaml diff --git a/content/cn/docs/user-guide/nginx-lifecycle-deployment.yaml b/content/zh/docs/user-guide/nginx-lifecycle-deployment.yaml similarity index 100% rename from content/cn/docs/user-guide/nginx-lifecycle-deployment.yaml rename to content/zh/docs/user-guide/nginx-lifecycle-deployment.yaml diff --git a/content/cn/docs/user-guide/nginx-probe-deployment.yaml b/content/zh/docs/user-guide/nginx-probe-deployment.yaml similarity index 100% rename from content/cn/docs/user-guide/nginx-probe-deployment.yaml rename to content/zh/docs/user-guide/nginx-probe-deployment.yaml diff --git a/content/cn/docs/user-guide/nginx-secure-app.yaml b/content/zh/docs/user-guide/nginx-secure-app.yaml similarity index 100% rename from content/cn/docs/user-guide/nginx-secure-app.yaml rename to content/zh/docs/user-guide/nginx-secure-app.yaml diff --git a/content/cn/docs/user-guide/nginx-svc.yaml b/content/zh/docs/user-guide/nginx-svc.yaml similarity index 100% rename from content/cn/docs/user-guide/nginx-svc.yaml rename to content/zh/docs/user-guide/nginx-svc.yaml diff --git a/content/cn/docs/user-guide/pod-w-message.yaml b/content/zh/docs/user-guide/pod-w-message.yaml similarity index 100% rename from content/cn/docs/user-guide/pod-w-message.yaml rename to content/zh/docs/user-guide/pod-w-message.yaml diff --git a/content/cn/docs/user-guide/pod.yaml b/content/zh/docs/user-guide/pod.yaml similarity index 100% rename from content/cn/docs/user-guide/pod.yaml rename to content/zh/docs/user-guide/pod.yaml diff --git a/content/cn/docs/user-guide/redis-deployment.yaml b/content/zh/docs/user-guide/redis-deployment.yaml similarity index 100% rename from content/cn/docs/user-guide/redis-deployment.yaml rename to content/zh/docs/user-guide/redis-deployment.yaml diff --git a/content/cn/docs/user-guide/redis-resource-deployment.yaml b/content/zh/docs/user-guide/redis-resource-deployment.yaml similarity index 100% rename from content/cn/docs/user-guide/redis-resource-deployment.yaml rename to content/zh/docs/user-guide/redis-resource-deployment.yaml diff --git a/content/cn/docs/user-guide/redis-secret-deployment.yaml b/content/zh/docs/user-guide/redis-secret-deployment.yaml similarity index 100% rename from content/cn/docs/user-guide/redis-secret-deployment.yaml rename to content/zh/docs/user-guide/redis-secret-deployment.yaml diff --git a/content/cn/docs/user-guide/run-my-nginx.yaml b/content/zh/docs/user-guide/run-my-nginx.yaml similarity index 100% rename from content/cn/docs/user-guide/run-my-nginx.yaml rename to content/zh/docs/user-guide/run-my-nginx.yaml diff --git a/content/cn/docs/whatisk8s.md b/content/zh/docs/whatisk8s.md similarity index 100% rename from content/cn/docs/whatisk8s.md rename to content/zh/docs/whatisk8s.md diff --git a/content/zh/examples/application/job/redis/job.yaml b/content/zh/examples/application/job/redis/job.yaml new file mode 100644 index 0000000000..ee7a06c732 --- /dev/null +++ b/content/zh/examples/application/job/redis/job.yaml @@ -0,0 +1,14 @@ +apiVersion: batch/v1 +kind: Job +metadata: + name: job-wq-2 +spec: + parallelism: 2 + template: + metadata: + name: job-wq-2 + spec: + containers: + - name: c + image: gcr.io/myproject/job-wq-2 + restartPolicy: OnFailure diff --git a/content/zh/examples/application/job/redis/worker.py b/content/zh/examples/application/job/redis/worker.py new file mode 100644 index 0000000000..49e5dae798 --- /dev/null +++ b/content/zh/examples/application/job/redis/worker.py @@ -0,0 +1,23 @@ +#!/usr/bin/env python + +import time +import rediswq + +host="redis" +# Uncomment next two lines if you do not have Kube-DNS working. +# import os +# host = os.getenv("REDIS_SERVICE_HOST") + +q = rediswq.RedisWQ(name="job2", host="redis") +print("Worker with sessionID: " + q.sessionID()) +print("Initial queue state: empty=" + str(q.empty())) +while not q.empty(): + item = q.lease(lease_secs=10, block=True, timeout=2) + if item is not None: + itemstr = item.decode("utf=8") + print("Working on " + itemstr) + time.sleep(10) # Put your actual work here instead of sleep. + q.complete(item) + else: + print("Waiting for work") +print("Queue empty, exiting") diff --git a/content/zh/examples/audit/audit-policy.yaml b/content/zh/examples/audit/audit-policy.yaml new file mode 100644 index 0000000000..b5d66b3a18 --- /dev/null +++ b/content/zh/examples/audit/audit-policy.yaml @@ -0,0 +1,68 @@ +apiVersion: audit.k8s.io/v1beta1 # This is required. +kind: Policy +# Don't generate audit events for all requests in RequestReceived stage. +omitStages: + - "RequestReceived" +rules: + # Log pod changes at RequestResponse level + - level: RequestResponse + resources: + - group: "" + # Resource "pods" doesn't match requests to any subresource of pods, + # which is consistent with the RBAC policy. + resources: ["pods"] + # Log "pods/log", "pods/status" at Metadata level + - level: Metadata + resources: + - group: "" + resources: ["pods/log", "pods/status"] + + # Don't log requests to a configmap called "controller-leader" + - level: None + resources: + - group: "" + resources: ["configmaps"] + resourceNames: ["controller-leader"] + + # Don't log watch requests by the "system:kube-proxy" on endpoints or services + - level: None + users: ["system:kube-proxy"] + verbs: ["watch"] + resources: + - group: "" # core API group + resources: ["endpoints", "services"] + + # Don't log authenticated requests to certain non-resource URL paths. + - level: None + userGroups: ["system:authenticated"] + nonResourceURLs: + - "/api*" # Wildcard matching. + - "/version" + + # Log the request body of configmap changes in kube-system. + - level: Request + resources: + - group: "" # core API group + resources: ["configmaps"] + # This rule only applies to resources in the "kube-system" namespace. + # The empty string "" can be used to select non-namespaced resources. + namespaces: ["kube-system"] + + # Log configmap and secret changes in all other namespaces at the Metadata level. + - level: Metadata + resources: + - group: "" # core API group + resources: ["secrets", "configmaps"] + + # Log all other resources in core and extensions at the Request level. + - level: Request + resources: + - group: "" # core API group + - group: "extensions" # Version of group should NOT be included. + + # A catch-all rule to log all other requests at the Metadata level. + - level: Metadata + # Long-running requests like watches that fall under this rule will not + # generate an audit event in RequestReceived. + omitStages: + - "RequestReceived" \ No newline at end of file diff --git a/content/zh/examples/pods/pod-nginx.yaml b/content/zh/examples/pods/pod-nginx.yaml new file mode 100644 index 0000000000..134ddae2aa --- /dev/null +++ b/content/zh/examples/pods/pod-nginx.yaml @@ -0,0 +1,13 @@ +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/cn/includes/task-tutorial-prereqs.md b/content/zh/includes/task-tutorial-prereqs.md similarity index 100% rename from content/cn/includes/task-tutorial-prereqs.md rename to content/zh/includes/task-tutorial-prereqs.md diff --git a/content/zh/includes/user-guide-content-moved.md b/content/zh/includes/user-guide-content-moved.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/data/tasks.yml b/data/tasks.yml index a65fc67798..ab03eec6bb 100644 --- a/data/tasks.yml +++ b/data/tasks.yml @@ -24,7 +24,7 @@ toc: - docs/tasks/configure-pod-container/configure-projected-volume-storage.md - docs/tasks/configure-pod-container/projected-volume.md - docs/tasks/configure-pod-container/security-context.md - - docs/tasks/configure-pod-container/environment-variable-expose-pod-information.md + - docs/tasks/inject-data-application/environment-variable-expose-pod-information.md - docs/tasks/configure-pod-container/configure-service-account.md - docs/tasks/configure-pod-container/pull-image-private-registry.md - docs/tasks/configure-pod-container/configure-liveness-readiness-probes.md diff --git a/functions-src/deploy-succeeded.js b/functions-src/deploy-succeeded.js new file mode 100644 index 0000000000..afe5c7e593 --- /dev/null +++ b/functions-src/deploy-succeeded.js @@ -0,0 +1,77 @@ +"use strict"; + +const + { IncomingWebhook } = require('@slack/client'), + kubernetesSiteRoot = 'https://kubernetes.io', + fetch = require('node-fetch').default, + { SLACK_WEBHOOK_URL } = process.env; + +const webhook = new IncomingWebhook(SLACK_WEBHOOK_URL); + +// A random smattering of Kubernetes documentation pages +// We can add as many pages here as we'd like +const kubernetesEndpoints = [ + 'docs/home', + 'docs/tutorials/configuration/configure-redis-using-configmap', + +] + +// Ensure that the SLACK_WEBHOOK_URL environment variable is set +const checkEnv = () => { + if (!SLACK_WEBHOOK_URL) { + return { + statusCode: 422, + body: "[FAILURE] The Slack webhook URL must be set via the SLACK_WEBHOOK_URL environment variable" + } + } +} + +// This function posts a warning message to Slack +const sendSlackMessage = (msg) => { + const slackMessageObject = { + username: "noindex checker", + text: msg + } + + // Send the message to the webhook + webhook.send(slackMessageObject, (err, res) => { + return (err) ? { statusCode: 422, body: `[ERROR] Slack webhook error: ${err}` } : + { statusCode: 200, body: `[SUCCESS] Response received from Slack: ${JSON.stringify(res)}` }; + }); +} + +// Iterate through each Kubernetes endpoint to check for noindex headers +const checkEndpoints = () => { + kubernetesEndpoints.forEach((endpoint) => { + const url = `${kubernetesSiteRoot}/${endpoint}`; + + fetch(url) + .then(res => { + const headers = res.headers; + + if ('x-robots-tag' in headers.raw() && (headers.get('x-robots-tag') == 'noindex')) { + const msg = `[WARNING] "X-Robots-Tag: noindex" header found on the following page: ${url}`; + + // Send Slack notification + sendSlackMessage(msg); + + return { statusCode: 404, body: msg }; + } else { + const msg = `[SUCCESS] No improper X-Robots-Tag: noindex headers found on ${url}`; + + return { statusCode: 200, body: msg }; + } + }) + .catch(err => { + return { statusCode: 422, body: err }; + }); + }); +} + +// The handler function +exports.handler = async (event, context) => { + checkEnv(); + + // Below are the various deploy succeeded checks + checkEndpoints(); +} diff --git a/i18n/en.toml b/i18n/en.toml index c5bd8c93eb..da41e45517 100644 --- a/i18n/en.toml +++ b/i18n/en.toml @@ -24,6 +24,9 @@ other = "Kubernetes Features" [main_cncf_project] other = """We are a CNCF graduated project

""" +[main_kubeweekly_signup] +other = "Subscribe" + [main_contribute] other = "Contribute" @@ -45,6 +48,21 @@ other = """The Kubernetes Authors | Documentation Distributed under Trademark Usage page""" +# Labels for the docs portal home page. +[docs_label_browse] +other = "Browse Docs" + +[docs_label_contributors] +other = "Contributors" + +[docs_label_users] +other = "Users" + +[docs_label_i_am] +other = "I AM..." + + + # Community links [community_twitter_name] other = "Twitter" @@ -61,4 +79,4 @@ other = "Events Calendar" # UI elements [ui_search_placeholder] -other = "Search" \ No newline at end of file +other = "Search" diff --git a/i18n/no.toml b/i18n/no.toml index 437a590fda..afb7591736 100644 --- a/i18n/no.toml +++ b/i18n/no.toml @@ -45,6 +45,10 @@ other = """Kubernetes-forfatterene | Dokumentasjonen er utgitt med Bruk av varemerker""" +# Labels for the docs portal home page. +[docs_label_browse] +other = "All dokumentasjon" + # Community links [community_twitter_name] other = "Twitter" diff --git a/layouts/blog/list.html b/layouts/blog/list.html index ad099ed461..2f199a6443 100644 --- a/layouts/blog/list.html +++ b/layouts/blog/list.html @@ -1,5 +1,14 @@ {{ define "main" }} - {{ range (.Paginator 1).Pages }} + {{ $pages := ($.Paginator 1).Pages }} + {{ with $.Site.Params.language_alternatives }} + {{ range . }} + {{ with (where $.Translations ".Lang" . ) }} + {{ $p := index . 0 }} + {{ $pages = $pages | lang.Merge ($p.Paginator 1).Pages }} + {{ end }} + {{ end }} + {{ end }} + {{ range $pages }} {{ .Render "post" }} {{ end }}
- - - + + +
-
I AM...
+
{{ T "docs_label_i_am" }}
.
diff --git a/layouts/docs/glossary.html b/layouts/docs/glossary.html index d279711f5d..f6ef5575a6 100644 --- a/layouts/docs/glossary.html +++ b/layouts/docs/glossary.html @@ -26,8 +26,10 @@ Deselect all

Click on the [+] indicators below to get a longer explanation for any particular term.

-{{ $glossary_terms := (.Site.GetPage "page" "docs/reference/glossary").Resources.ByType "page" }} -{{ $glossary_terms := sort $glossary_terms "Title" "asc" }} +{{ partial "docs/glossary-terms.html" . }} +{{ $glossary_items := $.Scratch.Get "glossary_items" }} +{{ with $glossary_items }} +{{ $glossary_terms := sort . "Title" "asc" }}
    {{ range $glossary_terms }} {{ $.Scratch.Set "tag_classes" "" }} @@ -53,4 +55,5 @@ {{ end }}
{{ end }} +{{ end }} diff --git a/layouts/index.html b/layouts/index.html index 494494311c..b0b579e0db 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -7,6 +7,36 @@ + +
+
+ + + +
+
+
+
+
+

Interested in receiving the latest Kubernetes news? Sign up for KubeWeekly.

+
+ + + +
+
+
+
View past newsletters
+
+
+
+ +
+
{{ end }} @@ -14,4 +44,4 @@ {{ with .Site.GetPage "section" "docs/tutorials/kubernetes-basics" }} {{ .LinkTitle }} {{ end }} -{{ end }} \ No newline at end of file +{{ end }} diff --git a/layouts/partials/blog/archive.html b/layouts/partials/blog/archive.html index 7e069a7c08..7acab8d6a9 100644 --- a/layouts/partials/blog/archive.html +++ b/layouts/partials/blog/archive.html @@ -1,5 +1,14 @@ +{{ $pages := .CurrentSection.Pages }} +{{ with $.Site.Params.language_alternatives }} + {{ range . }} + {{ with (where $.CurrentSection.Translations ".Lang" . ) }} + {{ $p := index . 0 }} + {{ $pages = $pages | lang.Merge $p.Pages }} + {{ end }} + {{ end }} + {{ end }}
- {{ range $i, $e := .CurrentSection.Pages.GroupByPublishDate "2006" }} + {{ range $i, $e := $pages.GroupByPublishDate "2006" }}

@@ -11,7 +20,8 @@
    {{ range .Pages }} -
  • {{ .LinkTitle }} {{ .PublishDate.Format "Jan 2" }}
  • + {{ $isForeignLanguage := (ne .Lang $.Lang)}} +
  • {{ .LinkTitle }} {{ .PublishDate.Format "Jan 2" }}{{ if $isForeignLanguage }} ({{ .Lang | upper }}){{ end }}
  • {{ end }}
diff --git a/layouts/partials/css.html b/layouts/partials/css.html index 0e5e25750f..5629e7e6b4 100644 --- a/layouts/partials/css.html +++ b/layouts/partials/css.html @@ -1,19 +1,7 @@ -{{- $mainSass := "sass/styles.sass" }} -{{- $caseStudySass := "sass/case_study_styles.sass" }} -{{- if .Site.IsServer }} -{{- $mainCssOpts := (dict "targetPath" "css/styles.css") }} -{{- $mainCss := resources.Get $mainSass | toCSS $mainCssOpts }} - -{{- else }} -{{- $mainCssOpts := (dict "targetPath" "css/styles.css") }} -{{- $mainCss := resources.Get $mainSass | toCSS $mainCssOpts | minify | fingerprint }} - -{{- end }} + {{- if .Params.case_study_styles }} -{{- $caseStudyCssOpts := (dict "targetPath" "css/styles.css") }} -{{- $caseStudyCss := resources.Get $caseStudySass | toCSS $caseStudyCssOpts | minify | fingerprint }} - + {{- end }} @@ -26,7 +14,8 @@ {{- end }} {{- with .Params.css }} -{{- range (split . ",") }} +{{- $extraCss := split . "," }} +{{- range $extraCss }} {{- $url := trim . " " | relURL }} {{- end }} diff --git a/layouts/partials/docs/browse.html b/layouts/partials/docs/browse.html index 8055493a08..5f48a59796 100644 --- a/layouts/partials/docs/browse.html +++ b/layouts/partials/docs/browse.html @@ -1,22 +1,31 @@
-{{ range . }} -{{ template "docs-browse-section" . }} -{{ end }} +{{ template "docs-browse-section" (dict "ctx" . "page" .) }}
- {{ define "docs-browse-section" }} +{{ $pages := .page.Pages }} +{{ $sections := .page.Sections }} +{{ with $.ctx.Site.Params.language_alternatives }} + {{ range . }} + {{ with (where $.page.Translations ".Lang" . ) }} + {{ $p := index . 0 }} + {{ $pages = $pages | lang.Merge $p.Pages }} + {{ $sections = $sections | lang.Merge $p.Sections }} + {{ end }} + {{ end }} +{{ end }} +{{ $pages := where $pages ".Params.toc_hide" "!=" true }} +{{ $sections := where $sections ".Params.toc_hide" "!=" true }} +{{ if not .page.Parent.IsHome }}
- {{ $pages := .Pages | union .Sections }} - {{ $pages := where $pages ".Params.toc_hide" "!=" true }} {{ if ge (len $pages) 1 }}
{{ $num_pages := len $pages }} @@ -27,7 +36,8 @@ {{ if eq $offset 1 }}
{{ end }} - {{ printf "%02d - %s" (add $i 1) .LinkTitle }}
+ {{ $isForeignLanguage := (ne .Lang $.ctx.Lang)}} + {{ printf "%02d - %s" (add $i 1) .LinkTitle }}{{ if $isForeignLanguage }} ({{ .Lang | upper }}){{ end }}
{{ if or (eq $offset $column_size) (eq (add $i 1) $num_pages)}}
{{ end }} @@ -37,3 +47,7 @@ {{ end }}
{{ end }} +{{ range $sections.ByWeight }} +{{ template "docs-browse-section" (dict "ctx" $.ctx "page" .) }} +{{ end }} +{{ end }} diff --git a/layouts/partials/docs/content_page.html b/layouts/partials/docs/content_page.html index 1919b95232..533c5c3d3a 100644 --- a/layouts/partials/docs/content_page.html +++ b/layouts/partials/docs/content_page.html @@ -1,4 +1,4 @@ -

Edit This Page

+

Edit This Page

{{ if not .page.Params.notitle }}

{{ .page.Title }}

{{ end }} diff --git a/layouts/partials/docs/glossary-terms.html b/layouts/partials/docs/glossary-terms.html new file mode 100644 index 0000000000..1a2aa5b733 --- /dev/null +++ b/layouts/partials/docs/glossary-terms.html @@ -0,0 +1,13 @@ +{{ $glossaryBundle := .Site.GetPage "page" "docs/reference/glossary" }} +{{- if $glossaryBundle -}} + {{ $pages := $glossaryBundle.Resources.ByType "page" }} + {{- range $.Site.Params.language_alternatives -}} + {{- with (where $glossaryBundle.Translations ".Lang" . ) -}} + {{ $p := (index . 0) }} + {{ $pages = $pages | lang.Merge ($p.Resources.ByType "page") }} + {{ end }} + {{ end }} + {{- $.Scratch.Set "glossary_items" $pages -}} +{{- else -}} +{{- errorf "[%s] Glossary Bundle not found for language. Create at least an index.md file inside docs/reference/glossary" .Page.Site.Language.Lang -}} +{{- end -}} diff --git a/layouts/partials/head.html b/layouts/partials/head.html index 4cf943e8f3..270ac7e4ab 100644 --- a/layouts/partials/head.html +++ b/layouts/partials/head.html @@ -1,3 +1,5 @@ +{{- $isBlogPost := eq .Section "blog" }} +{{- $ogType := cond (.IsHome) "website" "article" }} diff --git a/layouts/partials/tree.html b/layouts/partials/tree.html index bef4d1009d..0bd5a2b109 100644 --- a/layouts/partials/tree.html +++ b/layouts/partials/tree.html @@ -1,27 +1,37 @@ -{{ template "section-tree-nav" . }} +{{ template "section-tree-nav" (dict "ctx" . "section" .) }} {{ define "section-tree-nav" }} - {{ $sections := where (union .Pages .Sections).ByWeight ".Params.toc_hide" "!=" true }} + {{ $pages := (union .section.Pages .section.Sections) }} + {{ with $.ctx.Site.Params.language_alternatives }} + {{ range . }} + {{ with (where $.section.Translations ".Lang" . ) }} + {{ $p := index . 0 }} + {{ $pages = $pages | lang.Merge (union $p.Pages $p.Sections) }} + {{ end }} + {{ end }} + {{ end }} + {{ $sections := where $pages.ByWeight ".Params.toc_hide" "!=" true }} {{ range $sections }} {{ if .IsPage }} - {{ template "section-tree-nav-page" . }} + {{ template "section-tree-nav-page" (dict "ctx" $.ctx "page" .) }} {{ else }} - {{ template "section-tree-nav-section" . }} + {{ template "section-tree-nav-section" (dict "ctx" $.ctx "section" .) }} {{ end }} {{ end }} {{ end }} {{ define "section-tree-nav-section" }} -
-
- {{ if ge (len .Content) 10 }} +
+
+ {{ if ge (len .section.Content) 10 }} {{/* The section page has content, so link to it. */}} - + {{ $isForeignLanguage := (ne .section.Lang $.ctx.Lang)}} + {{ end }} {{ template "section-tree-nav" . }} -
+
{{ end }} {{ define "section-tree-nav-page" }} - -{{ end }} - +{{ $isForeignLanguage := (ne .page.Lang $.ctx.Lang)}} + +{{ end }} \ No newline at end of file diff --git a/layouts/shortcodes/glossary_tooltip.html b/layouts/shortcodes/glossary_tooltip.html index b70ca794c7..2af40e2645 100644 --- a/layouts/shortcodes/glossary_tooltip.html +++ b/layouts/shortcodes/glossary_tooltip.html @@ -1,8 +1,11 @@ {{- $id := .Get "term_id" -}} {{- $text := .Get "text" -}} -{{- $glossaryBundle := .Site.GetPage "page" "docs/reference/glossary" -}} -{{- $glossaryItems := $glossaryBundle.Resources.ByType "page" -}} -{{- $term_info := $glossaryItems.GetMatch (printf "%s*" $id ) -}} +{{- partial "docs/glossary-terms.html" $.Page -}} +{{- $glossary_items := $.Page.Scratch.Get "glossary_items" -}} +{{- if not $glossary_items -}} +{{- errorf "[%s] No glossary items found" .Page.Site.Language.Lang -}} +{{- else -}} +{{- $term_info := $glossary_items.GetMatch (printf "%s*" $id ) -}} {{- if not $term_info -}} {{- errorf "[%s] %q: %q is not a valid glossary term_id, see ./docs/reference/glossary/* for a full list" .Page.Site.Language.Lang .Page.Path $id -}} {{- end }} @@ -19,4 +22,5 @@ {{- $tooltip | safeHTML -}} -{{- end -}} \ No newline at end of file +{{- end -}} +{{- end -}} diff --git a/layouts/shortcodes/hugoVersion.html b/layouts/shortcodes/hugoVersion.html new file mode 100644 index 0000000000..1e4aef0072 --- /dev/null +++ b/layouts/shortcodes/hugoVersion.html @@ -0,0 +1 @@ +{{ getenv "HUGO_VERSION" }} diff --git a/layouts/shortcodes/language-repos-list.html b/layouts/shortcodes/language-repos-list.html deleted file mode 100644 index 293efa1ffc..0000000000 --- a/layouts/shortcodes/language-repos-list.html +++ /dev/null @@ -1,38 +0,0 @@ -{{- $languages := .Site.Home.AllTranslations }} - - - - - - - - - - {{- range $languages.ByWeight }} - {{- $name := .Language.LanguageName }} - {{- $code := string .Language }} - {{- $repo := printf "https://github.com/%s" (index .Site.Data.repos $code) }} - - - - - - {{- end }} - -
- Language - - Language code - - Repository -
- - {{ $name }} - - - {{ $code }} - - - {{ $repo }} - -
\ No newline at end of file diff --git a/netlify.toml b/netlify.toml index 9be30e60a1..7cc9defa8e 100644 --- a/netlify.toml +++ b/netlify.toml @@ -3,10 +3,11 @@ # It is turned off for only for the production site by using [context.master] below # DO NOT REMOVE THIS (contact @chenopis or @sig-docs-maintainers) publish = "public" +functions = "functions" command = "make non-production-build" [build.environment] -HUGO_VERSION = "0.47.1" +HUGO_VERSION = "0.49" [context.production.environment] HUGO_BASEURL = "https://kubernetes.io/" diff --git a/package.json b/package.json new file mode 100644 index 0000000000..d1cf0bd89d --- /dev/null +++ b/package.json @@ -0,0 +1,10 @@ +{ + "private": true, + "devDependencies": { + "@babel/core": "^7.0.1", + "@slack/client": "^4.4.0", + "babel-loader": "^8.0.2", + "netlify-lambda": "^0.4.0", + "node-fetch": "^2.2.0" + } +} diff --git a/resources/_gen/assets/sass/cn/sass/styles.sass_a6e533854c4de092afe9278041939937.content b/resources/_gen/assets/sass/cn/sass/styles.sass_a6e533854c4de092afe9278041939937.content new file mode 100644 index 0000000000..4ea962f457 --- /dev/null +++ b/resources/_gen/assets/sass/cn/sass/styles.sass_a6e533854c4de092afe9278041939937.content @@ -0,0 +1,1943 @@ +html, body { + margin: 0; + padding: 0; } + +input, button { + outline: none; } + +button { + cursor: pointer; } + +ul, li { + list-style: none; } + +ul { + margin: 0; + padding: 0; } + +a { + text-decoration: none; } + +.clear { + display: block; + clear: both; } + +.light-text { + color: white; } + +.right { + float: right; } + +.left { + float: left; } + +.center { + text-align: center; } + +*, .button { + box-sizing: border-box; + font-family: "Roboto", sans-serif; + background: none; + margin: 0; + border: 0; } + +body { + font-family: "Roboto", sans-serif; } + +h1, h2, h5, p { + font-weight: 300; } + +h3, h4 { + font-weight: 400; } + +html, body { + margin: 0; + padding: 0; } + +input, button { + outline: none; } + +button { + cursor: pointer; } + +ul, li { + list-style: none; } + +ul { + margin: 0; + padding: 0; } + +a { + text-decoration: none; } + +.clear { + display: block; + clear: both; } + +.light-text { + color: white; } + +.right { + float: right; } + +.left { + float: left; } + +.center { + text-align: center; } + +h1 { + font-size: 32px; + line-height: 40px; } + +h2 { + font-size: 28px; + line-height: 60px; } + +h3 { + font-size: 24px; + line-height: 32px; } + +h4 { + font-size: 20px; + line-height: 40px; } + +h5 { + font-size: 16px; + line-height: 36px; } + +p { + font-size: 14px; + line-height: 22px; } + +section, header, #vendorStrip { + padding-left: 20px; + padding-right: 20px; } + section main, header main, #vendorStrip main { + width: 100%; + max-width: 100%; } + +header { + height: 80px; } + +.nav-buttons { + height: 80px; + line-height: 80px; } + .nav-buttons .button + * { + margin-left: 30px; } + +#hamburger { + width: 50px; + height: 50px; } + +#mainNav { + padding: 140px 0 30px; } + #mainNav h5 { + margin-bottom: 1em; } + #mainNav h3 { + margin-bottom: 0.6em; } + #mainNav .nav-box { + width: 20%; } + #mainNav .nav-box + .nav-box { + margin-left: calc(20% / 3); } + #mainNav main + main { + margin-top: 60px; } + #mainNav .left .button { + height: 50px; + line-height: 50px; + font-size: 18px; } + +.open-nav #tryKubernetes, .y-enough #tryKubernetes { + margin-left: 30px; } + +#hero { + padding-top: 80px; } + +#docs #hero h1, #docs #hero h5 { + padding-left: 20px; + padding-right: 20px; } + +#vendorStrip { + height: 88px; + line-height: 88px; + font-size: 16px; } + +body { + background-color: white; } + +section { + position: relative; + background-color: white; } + +section main, header main, footer main { + position: relative; + margin: auto; } + +p { + font-size: 14px; + font-weight: 400; } + +.button { + display: inline-block; + border-radius: 6px; + padding: 0 20px; + line-height: 40px; + color: white; + background-color: #3371e3; + text-decoration: none; } + +#cellophane { + position: fixed; + top: 0; + left: 0; + width: 100%; + height: 100%; + display: none; } + +header { + position: fixed; + top: 0; + left: 0; + width: 100%; + z-index: 8888; + background-color: transparent; + box-shadow: 0 0 0 transparent; + overflow: hidden; + transition: 0.3s; + text-align: center; } + +.logo { + position: relative; + float: left; + display: block; + width: 180px; + height: 88px; + top: 0; + left: 0; + transform: none; + background-image: url(/images/nav_logo.svg); + background-size: contain; + background-position: center center; + background-repeat: no-repeat; } + +#docs .flyout-button { + position: fixed; + top: 20px; + left: 20px; + width: 50px; + height: 50px; + background-image: url(/images/toc_icon.png); + background-position: center center; + background-repeat: no-repeat; + background-size: auto; + border-radius: 50%; + transition: 0.3s; + z-index: 99999; } + +#docs.open-nav .flyout-button { + display: none; } + +#docs .logo { + position: absolute; + top: 40px; + left: 50%; + transform: translate(-50%, -50%); + display: block; + width: 45px; + height: 44px; + background-image: url(/images/favicon.png); } + +#docs.flip-nav .flyout-button { + background-image: url(/images/toc_icon_grey.png); } + +.nav-buttons { + float: right; } + +#viewDocs, #tryKubernetes { + display: none; } + +#viewDocs { + border: 2px solid white; + background-color: transparent; + transition: 0.3s; } + #viewDocs:hover { + background-color: white; + color: #303030; } + +#tryKubernetes { + width: 0; + padding: 0 0; + border: 1px solid transparent; + background-color: transparent; + text-align: center; + white-space: nowrap; + vertical-align: middle; + overflow: hidden; + transition: 0.3s; } + +#hamburger { + display: inline-block; + position: relative; + vertical-align: middle; + padding: 0; + border: 0; + background: none; } + #hamburger div, #hamburger:before, #hamburger:after { + position: absolute; + left: 15%; + width: 70%; + height: 2px; + background-color: #3371e3; + transition: 0.3s; + content: ""; } + #hamburger div { + top: calc(50% - 1px); } + #hamburger:before { + top: 24%; } + #hamburger:after { + bottom: 24%; } + #hamburger:hover div, #hamburger:hover:before, #hamburger:hover:after { + background-color: white; } + +#mainNav h5 { + color: #3371e3; + font-weight: normal; } + +#mainNav main { + white-space: nowrap; + overflow: hidden; + clear: both; } + +#mainNav .nav-box { + float: left; + white-space: normal; } + +#mainNav h3 a { + color: #3371e3; + text-decoration: none; } + +ul.global-nav { + display: none; } + ul.global-nav li { + display: inline-block; + margin-right: 14px; } + ul.global-nav li a { + color: #fff; + font-weight: 400; + padding: 0; + position: relative; } + ul.global-nav li a.active:after { + position: absolute; + width: 100%; + height: 2px; + content: ''; + bottom: -4px; + left: 0; + background: #fff; } + ul.global-nav li a .ui-icon { + filter: brightness(0) invert(1); } + ul.global-nav li ul { + display: none; + position: fixed; + top: 40px; + text-align: left; } + ul.global-nav li ul li { + display: block; + height: 28px; } + ul.global-nav li ul li a { + background: #303030; + color: #fff; + padding: 7px; } + ul.global-nav li ul li:last-child a { + border-radius: 7px; } + ul.global-nav li:hover ul { + display: block; } + +.flip-nav ul.global-nav li a, +.open-nav ul.global-nav li a { + color: #303030; } + +.flip-nav ul.global-nav li a .ui-icon { + filter: brightness(0); } + +.flip-nav ul.global-nav li ul li a { + background: #fff; + color: #303030; } + +.flip-nav ul.global-nav li a.active:after, +.flip-nav ul.global-nav li ul li a.active:after, +.open-nav ul.global-nav li a.active:after { + background: #3371e3; } + +.flip-nav header { + background-color: white; } + +.open-nav body { + overflow: hidden; } + +.open-nav #cellophane { + display: block; + z-index: 9998; } + +.open-nav header { + background-color: #e8e8e8; + z-index: 9999; } + +.open-nav #hamburger div { + opacity: 0; } + +.open-nav #hamburger:before, .open-nav #hamburger:after { + left: 12px; + transform-origin: 0 1px; } + +.open-nav #hamburger:before { + transform: rotate(45deg); } + +.open-nav #hamburger:after { + transform: rotate(-45deg); } + +.open-nav #tryKubernetes, .y-enough #tryKubernetes { + width: 150px; + background-color: #3371e3; + border-color: #3371e3; } + +.flip-nav header, .open-nav header { + box-shadow: 0 1px 2px #4c4c4c; } + +.flip-nav #viewDocs, .open-nav #viewDocs { + border-color: #303030; + color: #303030; } + .flip-nav #viewDocs:hover, .open-nav #viewDocs:hover { + border-color: #3371e3; + background-color: #3371e3; + color: white; } + +.flip-nav #hamburger:hover div, .flip-nav #hamburger:hover:before, .flip-nav #hamburger:hover:after, .open-nav #hamburger:hover div, .open-nav #hamburger:hover:before, .open-nav #hamburger:hover:after { + background-color: #303030; } + +#hero { + background-image: url(/images/texture.png); + background-color: #303030; + text-align: center; + padding-left: 0; + padding-right: 0; + margin-bottom: 0; + position: relative; } + #hero.bot-bar:after { + display: block; + margin-bottom: -20px; + height: 8px; + width: 100%; + background-color: rgba(255, 255, 255, 0.1); + content: ''; } + #hero.no-sub h5 { + display: none; } + #hero.no-sub h1 { + margin-bottom: 20px; } + +#home #hero:after { + display: none; } + +#vendorStrip { + position: relative; + background-color: rgba(255, 255, 255, 0.1); + font-weight: 100; + white-space: nowrap; + text-align: center; } + #vendorStrip li a { + color: rgba(255, 255, 255, 0.5); } + #vendorStrip li a.YAH { + color: white; + position: relative; } + +footer { + width: 100%; + background-image: url(/images/texture.png); + background-color: #303030; } + footer main { + padding: 20px 0; } + footer nav a { + width: 100%; + text-align: center; + display: inline-block; + margin: 10px 0; + font-size: 24px; + font-weight: 300; + color: white; + text-decoration: none; } + footer .social { + margin: 20px 0; } + footer .social div { + text-align: center; + margin-bottom: 20px; } + footer .social div:last-child { + margin: 30px 0; } + footer .social span { + display: block; + margin-bottom: 8px; } + footer .social input { + text-align: center; } + +#search, #wishField { + background-color: transparent; + padding: 10px; + font-size: 16px; + font-weight: 100; + color: white; + border: 1px solid white; + transition: 0.3s; } + #search:focus, #wishField:focus { + background-color: #f7f7f7; + color: #303030; } + +.social a { + display: inline-block; + background-image: url(/images/social_sprite.png); + background-repeat: no-repeat; + background-size: auto; + width: 50px; + height: 50px; + border-radius: 5px; + margin-right: 10px; } + .social a:hover { + background-color: #fff; } + .social a span { + position: absolute; + display: block; + height: 0; + overflow: hidden; } + .social a.button { + background-image: none; + width: auto; + height: auto; } + .social a.button:hover { + color: #3371e3; } + +a.twitter { + background-position: 0 0; } + a.twitter:hover { + background-position: 0 100%; } + +a.stack-overflow { + background-position: -50px 0; } + a.stack-overflow:hover { + background-position: -50px 100%; } + +a.slack { + background-position: -100px 0; } + a.slack:hover { + background-position: -100px 100%; } + +a.github { + background-position: -150px 0; } + a.github:hover { + background-position: -150px 100%; } + +a.mailing-list { + background-position: -200px 0; } + a.mailing-list:hover { + background-position: -200px 100%; } + +a.calendar { + background-position: -250px 0; } + a.calendar:hover { + background-position: -250px 100%; } + +#viewDocs { + display: none; } + +section { + background-color: white; } + +#hero { + background-color: #303030; } + #hero h5 { + margin: 20px 0; + line-height: 28px; } + +#vendorStrip { + position: relative; } + #vendorStrip ul { + float: left; } + #vendorStrip li { + display: inline-block; + height: 100%; } + #vendorStrip a { + display: block; + height: 100%; + color: white; + font-size: 0.75em; + font-weight: bold; } + #vendorStrip li + li { + margin-left: 0; } + +#docs #vendorStrip { + line-height: 44px; } + #docs #vendorStrip ul { + float: none; } + #docs #vendorStrip #searchBox { + float: none; + display: block; + width: 80%; + margin: 0 auto; + height: 44px; + line-height: 44px; + position: relative; } + #docs #vendorStrip #searchBox:before { + position: absolute; + width: 15px; + height: 15px; + content: ''; + right: 8px; + top: 7px; + background-image: url(/images/search-icon.svg); + background-repeat: no-repeat; + background-size: 100% 100%; + z-index: 1; } + #docs #vendorStrip #search { + width: 100%; + padding: 0 10px; + height: 30px; + line-height: 30px; + font-size: 16px; + vertical-align: top; + background: #fff; + border: none; + border-radius: 4px; + position: relative; } + +#encyclopedia { + position: relative; + padding: 50px 20px 20px 20px; + overflow: hidden; + font-size: 14px; } + #encyclopedia > div { + height: 100%; } + +#docsToc { + position: fixed; + background-color: white; + top: 0; + left: 0; + width: 0; + height: 100vh; + overflow: hidden; + padding: 50px 0; + z-index: 999999; + transition: 0.3s; } + #docsToc .yah > .title { + background-color: #f7f7f7; + border-left: 3px solid #3371e3; + padding: 7.5px 10px 7.5px 18px; + margin-left: -3px; + color: #3371e3; } + +.open-toc body { + overflow: hidden; } + +.open-toc #docsToc { + padding: 50px 20px; + width: 400px; + max-width: 100vw; + overflow-y: auto; } + +.pi-accordion > .container:first-child > .item:first-child > .title:first-child { + padding-left: 0; + font-size: 1.5em; + font-weight: 700; } + +.pi-accordion > .container:first-child > .item.yah:first-child > .title:first-child { + margin-left: -20px !important; } + +.pi-accordion .item { + overflow: hidden; } + +.pi-accordion .title { + color: #303030; + position: relative; + padding: 7.5px 10px 7.5px 18px; + cursor: pointer; + transition: 0.3s; } + .pi-accordion .title:hover { + color: #3371e3; } + +.pi-accordion a.item > .title { + color: black; } + .pi-accordion a.item > .title:hover { + color: #3371e3; } + +.pi-accordion div.item > .title:before { + content: ""; + position: absolute; + top: 12px; + left: 2px; + border-style: solid; + border-width: 5px 0 5px 8px; + border-color: transparent transparent transparent #3371e3; + transform: rotate(0deg); + transition: 0.3s; } + +.pi-accordion .wrapper { + position: relative; + width: 100%; + transition: height 0.3s; } + +.pi-accordion .content { + padding-left: 20px; + opacity: 0; + transition: 0.3s; } + +.pi-accordion .item.on > .title:before { + transform: rotate(90deg); } + +.pi-accordion .item.on > .wrapper > .content { + opacity: 1; } + +dt { + margin-bottom: 8px; } + +dd { + margin-bottom: 16px; } + +.pi-pushmenu { + display: none; + position: fixed; + top: 0; + width: 100%; + height: 100%; + opacity: 0; + transition: opacity 0.3s; } + .pi-pushmenu.on { + opacity: 1; } + .pi-pushmenu .overlay { + position: fixed; + top: 0; + left: 0; + width: 100%; + height: 100%; + background-color: rgba(0, 0, 0, 0.4); } + .pi-pushmenu .sled { + position: absolute; + top: 0; + width: 0; + height: 100%; + background-color: white; + overflow: auto; + transition: 0.3s; } + .pi-pushmenu.on .sled { + width: 400px; + max-width: 100vw; } + .pi-pushmenu .top-bar { + height: 0; + line-height: 60px; + background-color: #444; } + .pi-pushmenu ul { + margin-top: 25px; } + .pi-pushmenu li { + position: relative; + display: block; + width: 100%; + min-height: 45px; + padding: 0 60px 0 20px; + border-bottom: 1px solid #cccccc; } + .pi-pushmenu a { + display: inline-block; + width: 100%; + height: 45px; + line-height: 45px; + font-family: "Roboto", sans-serif; + font-size: 20px; + color: #3371e3; } + .pi-pushmenu .button { + background: none; + padding: 0; } + .pi-pushmenu ul ul { + padding: 0 20px; } + .pi-pushmenu ul ul li { + min-height: 40px; } + .pi-pushmenu ul ul a { + height: 40px; + line-height: 40px; + font-size: 18px; + color: #555555; } + +.push-menu-close-button { + position: absolute; + top: 0; + right: 0; + width: 50px; + height: 50px; } + .push-menu-close-button:before, .push-menu-close-button:after { + content: ""; + position: absolute; + top: calc(50% - 1px); + left: 25%; + width: 50%; + height: 2px; + background-color: black; } + .push-menu-close-button:before { + transform: rotate(45deg); } + .push-menu-close-button:after { + transform: rotate(-45deg); } + +#docsContent { + position: relative; + float: right; + width: 100%; } + #docsContent * + h2, #docsContent * + h3, #docsContent * + h4, #docsContent * + h5, #docsContent * + h6 { + margin-top: 30px; } + #docsContent h1, #docsContent h2, #docsContent h3, #docsContent h4, #docsContent h5, #docsContent h6 { + line-height: normal; + font-weight: 500; + margin-bottom: 30px; + padding-bottom: 10px; } + #docsContent h1:before, #docsContent h2:before, #docsContent h3:before, #docsContent h4:before, #docsContent h5:before, #docsContent h6:before { + display: block; + content: " "; + margin-top: -100px; + height: 100px; + visibility: hidden; } + #docsContent h1, #docsContent h2 { + border-bottom: 1px solid #cccccc; } + #docsContent h1 { + font-size: 32px; + padding-right: 60px; } + #docsContent h2 { + font-size: 28px; } + #docsContent h3 { + font-size: 24px; + font-weight: 300; + margin-bottom: 5px; } + #docsContent h4 { + font-size: 20px; + margin-bottom: 0px; } + #docsContent h5, #docsContent h6 { + font-size: 16px; + font-weight: 500; } + #docsContent p { + font-size: 16px; + font-weight: 300; + line-height: 1.75em; } + #docsContent p + p { + margin-top: 10px; } + #docsContent code { + display: inline-block; + box-sizing: border-box; + background-color: #f7f7f7; + color: #303030; + font-family: "Roboto Mono", monospace; + vertical-align: baseline; + font-size: 14px; + font-weight: bold; + padding: 2px 4px; } + #docsContent a code { + color: #3371e3; + text-decoration: underline; } + #docsContent pre .pi, #docsContent pre .s { + margin: 0; + padding: 0; } + #docsContent .highlight code span, #docsContent code, #docsContent pre code { + font-family: "Roboto Mono", monospace; } + #docsContent code, #docsContent pre code { + color: #303030; } + #docsContent pre code { + padding: 0; } + #docsContent pre { + background-color: #f7f7f7; + display: block; + margin: 20px 0; + padding: 15px; + position: relative; + overflow-x: auto; } + #docsContent h1 code, #docsContent h2 code, #docsContent h3 code, #docsContent h4 code, #docsContent h5 code, #docsContent h6 code { + font-size: inherit; + background-color: transparent; } + #docsContent .includecode { + table-layout: fixed; } + #docsContent .includecode, #docsContent .includecode th, #docsContent .includecode td { + padding: 0 !important; } + #docsContent .includecode th { + text-align: right !important; + padding: 10px !important; } + #docsContent .includecode th a, #docsContent .includecode th a code { + color: white !important; + background-color: transparent !important; } + #docsContent .includecode pre { + margin: 0 !important; } + #docsContent ul li { + list-style: disc; } + #docsContent ol li { + list-style: decimal; } + #docsContent ul, #docsContent ol { + margin: 20px 0; + padding-left: 30px; + font-weight: 300; } + #docsContent ul ul, #docsContent ol ol, #docsContent ul ol, #docsContent ol ul { + margin: 0.75em 0; } + #docsContent li { + margin-bottom: 0.75em; + font-size: 16px; + line-height: 1.75em; } + #docsContent table { + width: 100%; + border: 1px solid #ccc; + border-spacing: 0; + margin-top: 30px; + margin-bottom: 30px; } + #docsContent thead, #docsContent tr:nth-child(even) { + background-color: #f7f7f7; } + #docsContent thead { + background-color: #555; + color: white; } + #docsContent th, #docsContent td { + padding: 8px; + text-align: left; + margin: 0; } + #docsContent th { + font-weight: normal; } + #docsContent td { + font-size: 0.85em; } + #docsContent #editPageButton { + position: absolute; + top: -25px; + right: 5px; + width: 50px; + height: 50px; + line-height: 50px; + border-radius: 50%; + white-space: nowrap; + text-indent: 50px; + overflow: hidden; + background: #3371e3 url(/images/icon-pencil.svg) no-repeat; + background-position: 12px 10px; + background-size: 29px 29px; } + #docsContent #markdown-toc, #docsContent #TableOfContents { + margin-bottom: 20px; } + #docsContent #markdown-toc ul, #docsContent #markdown-toc li, #docsContent #TableOfContents ul, #docsContent #TableOfContents li { + list-style: disc; + color: #3371e3; } + #docsContent #markdown-toc ul, #docsContent #TableOfContents ul { + padding: 0 15px; + margin: 0; } + #docsContent #markdown-toc li, #docsContent #TableOfContents li { + padding: 0; + line-height: 1.5em; + margin-bottom: 0; } + #docsContent #markdown-toc a, #docsContent #TableOfContents a { + position: relative; + color: #3371e3; + font-weight: 700; } + #docsContent img { + max-width: 100%; } + #docsContent #TableOfContents > ul > li { + list-style: none; } + #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; } + +html.search #docsContent { + position: relative; + float: none; + width: 90%; + max-width: 850px; + margin: 0 auto; } + html.search #docsContent #editPageButton { + display: none; } + html.search #docsContent table { + border: 0; + margin-bottom: 0; } + html.search #docsContent td { + padding: 0; } + html.search #docsContent h1 { + margin-bottom: 0; + border-bottom: 0; + padding-bottom: 0; + padding-left: 8px; } + +#home.flip-nav .logo, #home.open-nav .logo { + background-image: url(/images/nav_logo2.svg); } + +#home #hero { + margin-bottom: 0; + padding-bottom: 1px; } + #home #hero main { + padding: 0 10px; + margin-bottom: 30px; } + #home #hero #vendorStrip { + display: none; } + +#oceanNodes { + padding-top: 60px; + padding-bottom: 60px; } + #oceanNodes a { + color: #3371e3; } + #oceanNodes main { + margin-bottom: 60px; + min-height: 160px; } + #oceanNodes .image-wrapper { + max-width: 75%; + margin: 0 auto 20px; + text-align: center; } + #oceanNodes .image-wrapper img { + width: 100%; + max-width: 160px; } + #oceanNodes main:first-child .image-wrapper { + max-width: 100%; } + #oceanNodes main:first-child .image-wrapper img { + max-width: 491px; } + #oceanNodes h3 { + margin-bottom: 30px; } + +#video { + height: 200px; } + +#video { + width: 100%; + position: relative; + background-position: center center; + background-size: cover; } + #video > .light-text { + display: none; + position: absolute; + top: 50%; + left: 75%; + width: 525px; + padding-right: 80px; + transform: translate(-50%, -50%); + color: white; } + #video h2 { + font-size: 32px; + line-height: 44px; + margin-bottom: 20px; } + #video p { + margin-bottom: 20px; } + #video #desktopKCButton { + position: relative; + font-size: 18px; + background-color: #303030; + border-radius: 8px; + color: #ffffff; + padding: 20px 10px 20px 10px; } + #video #desktopShowVideoButton { + position: relative; + font-size: 24px; + background-color: white; + border-radius: 8px; + color: #3371e3; + padding: 15px 30px 15px 80px; + margin-bottom: 15px; } + #video #desktopShowVideoButton:before { + content: ""; + position: absolute; + position: absolute; + top: 50%; + left: 40px; + transform: translate(-50%, -50%); + width: 0; + height: 0; + border-style: solid; + border-width: 10px 0 10px 20px; + border-color: transparent transparent transparent #3371e3; } + #video #mobileShowVideoButton { + position: absolute; + top: 50%; + left: 50%; + transform: translate(-50%, -50%); + width: 80px; + height: 80px; + border-radius: 50%; + background-color: transparent; + border: 5px solid rgba(255, 255, 255, 0.2); + overflow: visible; } + #video #mobileShowVideoButton:after { + position: absolute; + top: 50%; + left: 50%; + transform: translate(-50%, -50%); + left: 40px; + content: ""; + width: 0; + height: 0; + border-style: solid; + border-width: 20px 0 20px 30px; + border-color: transparent transparent transparent #ffffff; } + +#videoPlayer { + position: fixed; + top: 0; + left: 0; + width: 100vw; + height: 100vh; + background-color: rgba(0, 0, 0, 0.9); + display: none; } + #videoPlayer iframe { + position: absolute; + top: 50%; + left: 50%; + transform: translate(-50%, -50%); + width: 80vw; + height: 45vw; + max-width: 142.22222222vh; + max-height: 80vh; } + #videoPlayer #closeButton { + position: absolute; + top: 20px; + right: 20px; + width: 50px; + height: 50px; + border: 2px solid transparent; + transition: 0.3s; } + #videoPlayer #closeButton:before, #videoPlayer #closeButton:after { + content: ""; + position: absolute; + top: calc(50% - 1px); + left: 10%; + width: 80%; + height: 2px; + background-color: white; } + #videoPlayer #closeButton:before { + transform: rotate(45deg); } + #videoPlayer #closeButton:after { + transform: rotate(-45deg); } + #videoPlayer #closeButton:hover { + border-color: white; } + +#cncf { + padding-top: 60px; + padding-bottom: 140px; + background-image: url(/images/cncf-color.png); + background-position: center 100px; + background-repeat: no-repeat; + background-size: 300px; } + +#kubeweekly { + background-color: #f7f7f7; + padding: 60px; + background-size: auto; + font-family: "Roboto Mono", monospace !important; + font-size: 24px; + font-weight: bold; } + #kubeweekly h5 { + font-size: 20px; } + +.subscribe-button { + border-radius: 6px; + padding: 0 20px; + line-height: 31px; + color: white; + background-color: #3371e3; + text-decoration: none; + font-size: 14px; } + +#features { + padding-top: 140px; + background-color: #f7f7f7; + background-image: url(/images/wheel.png); + background-position: center 60px; + background-repeat: no-repeat; + background-size: auto; } + +.feature-box { + width: 100%; + overflow: hidden; + clear: both; } + .feature-box h4 { + line-height: normal; + margin-bottom: 15px; } + .feature-box > div:first-child { + float: left; } + .feature-box > div:last-child { + float: right; } + +#features h3 { + margin-bottom: 20px; } + +#features .feature-box { + margin-bottom: 0; } + #features .feature-box > div { + width: 100%; + margin-bottom: 40px; } + +#community.open-nav .logo, #community.flip-nav .logo, .gridPage.open-nav .logo, .gridPage.flip-nav .logo { + background-image: url(/images/nav_logo2.svg); } + +#community #hero, .gridPage #hero { + padding-bottom: 20px; } + +#community #mainContent, .gridPage #mainContent { + padding: 20px 0; } + #community #mainContent main, .gridPage #mainContent main { + max-width: none; } + #community #mainContent a, .gridPage #mainContent a { + color: #3371e3; } + #community #mainContent .content, .gridPage #mainContent .content { + margin-bottom: 30px; + padding: 30px 0; } + #community #mainContent .content h1, #community #mainContent .content h2, #community #mainContent .content h3, #community #mainContent .content h4, #community #mainContent .content h5, #community #mainContent .content h6, #community #mainContent .content p, .gridPage #mainContent .content h1, .gridPage #mainContent .content h2, .gridPage #mainContent .content h3, .gridPage #mainContent .content h4, .gridPage #mainContent .content h5, .gridPage #mainContent .content h6, .gridPage #mainContent .content p { + line-height: normal; + max-width: 1200px; + padding: 0 20px; + margin: 0 auto 20px; } + #community #mainContent .content:nth-child(even), .gridPage #mainContent .content:nth-child(even) { + background-color: #f7f7f7; } + #community #mainContent .company-logos, .gridPage #mainContent .company-logos { + text-align: center; + max-width: 1200px; + margin: 0 auto; } + #community #mainContent .company-logos img, .gridPage #mainContent .company-logos img { + width: auto; + margin: 10px; + background-color: #f7f7f7; } + #community #mainContent .partner-logos, .gridPage #mainContent .partner-logos { + text-align: center; + max-width: 1200px; + margin: 0 auto; } + #community #mainContent .partner-logos img, .gridPage #mainContent .partner-logos img { + width: auto; + margin: 10px; + background-color: #ffffff; + box-shadow: 0 5px 5px rgba(0, 0, 0, 0.24), 0 0 5px rgba(0, 0, 0, 0.12); } + #community #mainContent #calendarMeetings, .gridPage #mainContent #calendarMeetings { + position: relative; + width: 80vw; + height: 60vw; + max-width: 1200px; + max-height: 900px; + margin: 20px auto; } + #community #mainContent #calendarEvents, .gridPage #mainContent #calendarEvents { + position: relative; + width: 80vw; + height: 30vw; + max-width: 1200px; + max-height: 450px; + margin: 20px auto; } + #community #mainContent iframe, .gridPage #mainContent iframe { + position: absolute; + border: 0; + width: 100%; + height: 100%; } + +.ui-icon { + display: inline-block !important; } + +#feature-state-dialog-link { + text-decoration: none !important; + padding: 5px !important; } + #feature-state-dialog-link a:visited { + color: #454545 !important; } + #feature-state-dialog-link a code { + display: inline-block !important; + box-sizing: border-box !important; + background-color: #f7f7f7 !important; + color: #303030 !important; + font-family: "Roboto Mono", monospace !important; + vertical-align: baseline !important; + font-size: 14px !important; + font-weight: bold !important; + padding: 0px 4px !important; } + +#feature-state-dialog { + background: #fff !important; + border: 1px solid #ddd !important; + padding: 0.5em 1em !important; } + #feature-state-dialog ul, #feature-state-dialog li { + list-style: disc !important; + margin: 4px 12px !important; } + #feature-state-dialog p { + margin: 8px 0px !important; } + #feature-state-dialog code { + display: inline-block !important; + box-sizing: border-box !important; + background-color: #f7f7f7 !important; + color: #303030 !important; + font-family: "Roboto Mono", monospace !important; + vertical-align: baseline !important; + font-size: 14px !important; + font-weight: bold !important; + padding: 0px 4px !important; } + +.ui-dialog { + background: #f7f7f7 !important; + padding: 0.5em; } + +.ui-dialog-content { + position: relative; + float: right; + width: 100%; } + .ui-dialog-content * + h2, .ui-dialog-content * + h3, .ui-dialog-content * + h4, .ui-dialog-content * + h5, .ui-dialog-content * + h6 { + margin-top: 30px; } + .ui-dialog-content h1, .ui-dialog-content h2, .ui-dialog-content h3, .ui-dialog-content h4, .ui-dialog-content h5, .ui-dialog-content h6 { + line-height: normal; + font-weight: 500; + margin-bottom: 30px; + padding-bottom: 10px; } + .ui-dialog-content h1:before, .ui-dialog-content h2:before, .ui-dialog-content h3:before, .ui-dialog-content h4:before, .ui-dialog-content h5:before, .ui-dialog-content h6:before { + display: block; + content: " "; + margin-top: -100px; + height: 100px; + visibility: hidden; } + .ui-dialog-content h1, .ui-dialog-content h2 { + border-bottom: 1px solid #cccccc; } + .ui-dialog-content h1 { + font-size: 32px; + padding-right: 60px; } + .ui-dialog-content h2 { + font-size: 28px; } + .ui-dialog-content h3 { + font-size: 24px; + font-weight: 300; + margin-bottom: 5px; } + .ui-dialog-content h4 { + font-size: 20px; + margin-bottom: 0px; } + .ui-dialog-content h5, .ui-dialog-content h6 { + font-size: 16px; + font-weight: 500; } + .ui-dialog-content p { + font-size: 16px; + font-weight: 300; + line-height: 1.75em; } + .ui-dialog-content p + p { + margin-top: 10px; } + .ui-dialog-content code { + display: inline-block; + box-sizing: border-box; + background-color: #f7f7f7; + color: #303030; + font-family: "Roboto Mono", monospace; + vertical-align: baseline; + font-size: 14px; + font-weight: bold; + padding: 2px 4px; } + .ui-dialog-content a code { + color: #3371e3; + text-decoration: underline; } + .ui-dialog-content pre .pi, .ui-dialog-content pre .s { + margin: 0; + padding: 0; } + .ui-dialog-content .highlight code span, .ui-dialog-content code, .ui-dialog-content pre code { + font-family: "Roboto Mono", monospace; } + .ui-dialog-content code, .ui-dialog-content pre code { + color: #303030; } + .ui-dialog-content pre code { + padding: 0; } + .ui-dialog-content pre { + background-color: #f7f7f7; + display: block; + margin: 20px 0; + padding: 15px; + position: relative; + overflow-x: auto; } + .ui-dialog-content h1 code, .ui-dialog-content h2 code, .ui-dialog-content h3 code, .ui-dialog-content h4 code, .ui-dialog-content h5 code, .ui-dialog-content h6 code { + font-family: inherit; + font-size: inherit; + background-color: transparent; } + .ui-dialog-content .includecode { + table-layout: fixed; } + .ui-dialog-content .includecode, .ui-dialog-content .includecode th, .ui-dialog-content .includecode td { + padding: 0 !important; } + .ui-dialog-content .includecode th { + text-align: right !important; + padding: 10px !important; } + .ui-dialog-content .includecode th a, .ui-dialog-content .includecode th a code { + color: white !important; + background-color: transparent !important; } + .ui-dialog-content .includecode pre { + margin: 0 !important; } + .ui-dialog-content ul li { + list-style: disc; } + .ui-dialog-content ol li { + list-style: decimal; } + .ui-dialog-content ul, .ui-dialog-content ol { + margin: 20px 0; + padding-left: 30px; + font-weight: 300; } + .ui-dialog-content ul ul, .ui-dialog-content ol ol, .ui-dialog-content ul ol, .ui-dialog-content ol ul { + margin: 0.75em 0; } + .ui-dialog-content li { + margin-bottom: 0.75em; + font-size: 16px; + line-height: 1.75em; } + .ui-dialog-content table { + width: 100%; + border: 1px solid #ccc; + border-spacing: 0; + margin-top: 30px; + margin-bottom: 30px; } + .ui-dialog-content thead, .ui-dialog-content tr:nth-child(even) { + background-color: #f7f7f7; } + .ui-dialog-content thead { + background-color: #555; + color: white; } + .ui-dialog-content th, .ui-dialog-content td { + padding: 8px; + text-align: left; + margin: 0; } + .ui-dialog-content th { + font-weight: normal; } + .ui-dialog-content td { + font-size: 0.85em; } + .ui-dialog-content #editPageButton { + position: absolute; + top: -25px; + right: 5px; + width: 50px; + height: 50px; + line-height: 50px; + border-radius: 50%; + white-space: nowrap; + text-indent: 50px; + overflow: hidden; + background: #3371e3 url(/images/icon-pencil.svg) no-repeat; + background-position: 12px 10px; + background-size: 29px 29px; } + .ui-dialog-content #markdown-toc { + margin-bottom: 20px; } + .ui-dialog-content #markdown-toc ul, .ui-dialog-content #markdown-toc li { + list-style: disc; + color: #3371e3; } + .ui-dialog-content #markdown-toc ul { + padding: 0 15px; + margin: 0; } + .ui-dialog-content #markdown-toc li { + padding: 0; + line-height: 1.5em; + margin-bottom: 0; } + .ui-dialog-content #markdown-toc a { + position: relative; + color: #3371e3; + font-weight: 700; } + .ui-dialog-content img { + max-width: 100%; } + .ui-dialog-content a { + text-decoration: underline; } + +.ui-dialog-buttonpane { + background: #f7f7f7 !important; } + +.ui-widget-header { + background: transparent !important; + background-color: transparent !important; + border: 0px !important; } + +.ui-tabs ul, .ui-tabs ol, .ui-tabs li { + padding: 0px !important; + list-style: none !important; + margin-bottom: 0px !important; + margin-left: 4px !important; } + +.ui-tabs-panel ul li { + list-style: disc !important; } + +.ui-tabs-panel ol li { + list-style: decimal !important; } + +.ui-widget-content { + border: 0px !important; } + .ui-widget-content table { + margin: 0px !important; } + +.ui-tabs .ui-tabs-panel { + border: 1px solid #ccc !important; } + +.ui-tabs-anchor { + text-decoration: none !important; } + +#talkToUs h3, #talkToUs h4 { + text-align: center; } + +#talkToUs h3 { + margin-bottom: 15px; } + +#talkToUs h4 { + line-height: normal; + margin-bottom: 50px; } + #talkToUs h4 br { + display: none; } + +#talkToUs #bigSocial { + overflow: hidden; } + #talkToUs #bigSocial div { + width: 100%; + float: left; + padding: 30px; + padding-top: 110px; + background-position: center top; + background-size: auto; + background-repeat: no-repeat; } + #talkToUs #bigSocial div:nth-child(1) { + background-image: url(/images/twitter_icon.png); } + #talkToUs #bigSocial div:nth-child(2) { + background-image: url(/images/github_icon.png); } + #talkToUs #bigSocial div:nth-child(3) { + background-image: url(/images/slack_icon.png); } + #talkToUs #bigSocial div:nth-child(4) { + background-image: url(/images/stackoverflow_icon.png); } + #talkToUs #bigSocial div + div { + margin-top: 20px; + margin-left: 0; } + #talkToUs #bigSocial a { + display: inline-block; + color: #3371e3; + font-size: 24px; + font-weight: 400; + text-decoration: none; + margin-bottom: 15px; } + #talkToUs #bigSocial a, #talkToUs #bigSocial p { + text-align: center; + width: 100%; } + +#home #talkToUs main { + padding: 30px 0; } + +#home #talkToUs h5 { + font-size: 20px; } + +#home #caseStudiesWrapper { + position: relative; + text-align: center; + margin-bottom: 30px; } + #home #caseStudiesWrapper img { + padding-bottom: 1rem; } + #home #caseStudiesWrapper div { + position: relative; + display: inline-block; + vertical-align: top; + width: 100%; + min-height: 230px; + margin-bottom: 60px; + padding-right: 1rem; + background-position: top center; } + #home #caseStudiesWrapper p { + font-size: 20px; } + #home #caseStudiesWrapper a { + position: absolute; + bottom: -30px; + left: 50%; + transform: translateX(-50%); + color: #3371e3; + font-weight: 400; } + +/* Google Search */ +.cse .gsc-control-cse, .gsc-control-cse { + padding: 0; } + +.gsc-control-cse table, .gsc-control-cse-en table { + margin: 0px !important; } + +.gsc-above-wrapper-area { + border-bottom: 0; } + +/* Bing Search */ +#bing-results-container { + margin-top: 30px; + margin-left: 20px; } + +.bing-result { + margin-bottom: 20px; } + +.bing-result-name a { + font-size: 16px; + color: #0000CC; } + +.bing-result-url { + color: #008000; + font-size: 13px; } + +.bing-result-snippet { + color: #000; + font-size: 11px; } + +#bing-pagination-container { + margin: 10px; + margin-left: 20px; } + +.bing-page-anchor { + text-decoration: none !important; + cursor: pointer; + color: #0000CC; + margin-right: 8px; } + +@media screen and (min-width: 750px) { + h1 { + font-size: 32px; + line-height: 40px; } + h2 { + font-size: 28px; + line-height: 60px; } + h3 { + font-size: 24px; + line-height: 32px; } + h4 { + font-size: 20px; + line-height: 40px; } + h5 { + font-size: 16px; + line-height: 36px; } + p { + font-size: 14px; + line-height: 22px; } + section, header, #vendorStrip { + padding-left: 20px; + padding-right: 20px; } + section main, header main, #vendorStrip main { + width: 100%; + max-width: 100%; } + header { + height: 80px; } + .nav-buttons { + height: 80px; + line-height: 80px; } + .nav-buttons .button + * { + margin-left: 30px; } + #hamburger { + width: 50px; + height: 50px; } + #mainNav { + padding: 140px 0 30px; } + #mainNav h5 { + margin-bottom: 1em; } + #mainNav h3 { + margin-bottom: 0.6em; } + #mainNav .nav-box { + width: 20%; } + #mainNav .nav-box + .nav-box { + margin-left: calc(20% / 3); } + #mainNav main + main { + margin-top: 60px; } + #mainNav .left .button { + height: 50px; + line-height: 50px; + font-size: 18px; } + .open-nav #tryKubernetes, .y-enough #tryKubernetes { + margin-left: 30px; } + #hero { + padding-top: 80px; } + #docs #hero h1, #docs #hero h5 { + padding-left: 20px; + padding-right: 20px; } + #vendorStrip { + height: 88px; + line-height: 88px; + font-size: 16px; } + p { + font-size: 16px; + line-height: 24px; + letter-spacing: 0.1px; } + h1 { + font-size: 36px; + line-height: 44px; } + h3 { + font-size: 28px; + line-height: 36px; } + h4 { + font-size: 24px; + line-height: 40px; } + #home #viewDocs, #home #tryKubernetes { + display: inline-block; } + #vendorStrip { + display: block; + text-align: center; } + #vendorStrip img { + max-height: 24px; + vertical-align: middle; + margin: 0 30px; } + #docs #vendorStrip li a { + font-size: 1em; + font-weight: normal; } + #docs #vendorStrip li li + li { + margin-left: 60px; } + #oceanNodes h3 { + text-align: left; + margin-bottom: 18px; } + #oceanNodes main { + position: relative; + clear: both; + display: table; } + #oceanNodes main .content { + display: table-cell; + position: relative; + vertical-align: middle; } + #oceanNodes main .image-wrapper { + position: absolute; + top: 50%; + max-width: 25%; + max-height: 100%; + transform: translateY(-50%); } + #oceanNodes main:nth-child(odd) { + padding-right: 210px; } + #oceanNodes main:nth-child(odd) .image-wrapper { + right: 0; } + #oceanNodes main:nth-child(even) { + padding-left: 210px; } + #oceanNodes main:nth-child(even) .image-wrapper { + left: 0; } + #oceanNodes main:nth-child(1) { + padding-right: 0; } + #oceanNodes main:nth-child(1) h3, #oceanNodes main:nth-child(1) p { + text-align: center; } + #oceanNodes main:nth-child(1) .image-wrapper { + position: relative; + display: block; + float: none; + max-width: 100%; + transform: none; } + #oceanNodes main:nth-child(1) .content { + display: block; } + #oceanNodes main img { + width: 100%; } + #video { + height: 400px; + display: block; } + #video > .light-text { + display: block; } + #mobileShowVideoButton { + display: none; } + #features { + padding-bottom: 60px; } + #features .feature-box { + margin-bottom: 30px; } + #features .feature-box:last-child { + margin-bottom: 0; } + #features h3 { + margin-bottom: 40px; } + #features .feature-box > div { + width: 45%; + margin-bottom: 0; } + #talkToUs #bigSocial div { + width: calc(50% - 15px); } + #talkToUs #bigSocial div + div { + margin-top: 0; } + #talkToUs #bigSocial div:nth-child(2) { + margin-left: 20px; } + #talkToUs #bigSocial div:nth-child(3) { + margin-top: 20px; } + #talkToUs #bigSocial div:nth-child(4) { + margin-top: 20px; + margin-left: 20px; } + #talkToUs #bigSocial a { + display: inline-block; + color: #3371e3; + font-weight: 400; + text-decoration: none; } + footer nav { + text-align: center; } + footer nav a { + width: 30%; + padding: 0 20px; } + footer .social { + text-align: center; } + footer .social div { + display: inline-block; } + footer .social div:last-child { + display: block; + margin: 0; } + footer .social span { + display: inline-block; + margin-right: 10px; } + footer .social input { + text-align: left; } + #home #caseStudiesWrapper div { + width: 48%; } } + +@media screen and (min-width: 1025px) { + #hamburger { + display: none; } + ul.global-nav { + display: inline-block; } + #docs #vendorStrip #searchBox:before { + top: 15px; } + #vendorStrip { + height: 44px; + line-height: 44px; } + #vendorStrip li a.YAH:after { + content: ""; + display: block; + position: absolute; + left: 0; + bottom: 0; + width: 100%; + height: 4px; + background-color: #3371e3; } + #vendorStrip #searchBox { + float: right; } + #home #hero #vendorStrip { + display: block; } + #docs #hero h1, #docs #hero h5 { + text-align: left; } + #docs #hero #vendorStrip ul { + float: left; } + #docs #hero #vendorStrip #searchBox { + float: right; + width: 250px; } + #docs #hero #vendorStrip #search { + vertical-align: middle; } + #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); } + #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; } + #docsContent { + width: calc(100% - 400px); } + #docsContent #editPageButton { + right: -25px; } + section main, header main, footer main { + max-width: 1200px; } + header, #vendorStrip, #encyclopedia, #hero h1, #hero h5, #docs #hero h1, #docs #hero h5, + #community #hero h1, .gridPage #hero h1, #community #hero h5, .gridPage #hero h5 { + padding-left: 100px; + padding-right: 100px; } + #vendorStrip { + padding-right: 10px; } + #home section main, #home header main, #home footer main { + max-width: 1000px; } + #oceanNodes main { + position: relative; + max-width: 830px; } + #oceanNodes main:nth-child(1) { + max-width: 1000px; + padding-right: 475px; } + #oceanNodes main:nth-child(1) h3, #oceanNodes main:nth-child(1) p { + text-align: left; } + #oceanNodes main:nth-child(1) .image-wrapper { + position: absolute; + max-width: 48%; + transform: translateY(-50%); } + #oceanNodes main:nth-child(1) .image-wrapper img { + max-width: 425px; } + #video { + height: 550px; + position: relative; + background-position: center center; + background-size: cover; } + #talkToUs h4 br { + display: block; } + #talkToUs #bigSocial div { + width: calc(25% - 18px); } + #talkToUs #bigSocial div + div { + margin-left: 20px; } + footer { + width: 100%; + background-image: url(../images/texture.png); + background-color: #303030; } + footer main { + padding: 20px 0; } + footer nav { + overflow: hidden; + margin-bottom: 20px; } + footer nav a { + width: 16.65%; + float: left; + font-size: 24px; + font-weight: 300; + white-space: nowrap; } + footer .social { + padding: 0 30px; + max-width: 1200px; } + footer .social div { + float: left; } + footer .social div:last-child { + float: right; } + #search, #wishField { + background-color: transparent; + padding: 10px; + font-size: 16px; + font-weight: 100; + color: white; + border: 1px solid white; + transition: 0.3s; } + #search:focus, #wishField:focus { + background-color: #f7f7f7; + color: #303030; } + .social a { + display: inline-block; + background-image: url(../images/social_sprite.png); + background-repeat: no-repeat; + background-size: auto; + width: 50px; + height: 50px; + border-radius: 5px; + margin-right: 10px; } + .social a:hover { + background-color: #fff; } + .social a span { + position: absolute; + display: block; + height: 0; + overflow: hidden; } + a.twitter { + background-position: 0 0; } + a.twitter:hover { + background-position: 0 100%; } + a.stack-overflow { + background-position: -50px 0; } + a.stack-overflow:hover { + background-position: -50px 100%; } + a.slack { + background-position: -100px 0; } + a.slack:hover { + background-position: -100px 100%; } + a.github { + background-position: -150px 0; } + a.github:hover { + background-position: -150px 100%; } + a.mailing-list { + background-position: -200px 0; } + a.mailing-list:hover { + background-position: -200px 100%; } + a.calendar { + background-position: -250px 0; } + a.calendar:hover { + background-position: -250px 100%; } + #community #hero, .gridPage #hero { + text-align: left; } + #community #hero h1, .gridPage #hero h1 { + padding: 20px 100px; } + #community #tryKubernetes, .gridPage #tryKubernetes { + width: auto; + background-color: #3371e3; + padding: 0 20px; } + #bigSocial div { + width: calc(25% - 18px); } + #home #caseStudiesWrapper div { + width: 24%; + min-height: 260px; } } + +@media screen and (min-width: 1300px) { + #vendorStrip { + padding-right: 100px; } } + +@media screen and (min-width: 456px) { + #vendorStrip li + li { + margin-left: 20px; } } diff --git a/resources/_gen/assets/sass/cn/sass/styles.sass_a6e533854c4de092afe9278041939937.json b/resources/_gen/assets/sass/cn/sass/styles.sass_a6e533854c4de092afe9278041939937.json new file mode 100644 index 0000000000..081a4beb86 --- /dev/null +++ b/resources/_gen/assets/sass/cn/sass/styles.sass_a6e533854c4de092afe9278041939937.json @@ -0,0 +1 @@ +{"Target":"css/styles.css","MediaType":"text/css","Data":{}} \ No newline at end of file diff --git a/resources/_gen/assets/sass/sass/case_study_styles.sass_cb957da2191fde4902dd41b139c8069d.content b/resources/_gen/assets/sass/sass/case_study_styles.sass_cb957da2191fde4902dd41b139c8069d.content deleted file mode 100644 index 4f9f97c843..0000000000 --- a/resources/_gen/assets/sass/sass/case_study_styles.sass_cb957da2191fde4902dd41b139c8069d.content +++ /dev/null @@ -1 +0,0 @@ -html,body{margin:0;padding:0}input,button{outline:0}button{cursor:pointer}ul,li{list-style:none}ul{margin:0;padding:0}a{text-decoration:none}.clear{display:block;clear:both}.light-text{color:#fff}.right{float:right}.left{float:left}.center{text-align:center}*,.button{box-sizing:border-box;font-family:roboto,sans-serif;background:0 0;margin:0;border:0}body{font-family:roboto,sans-serif}h1,h2,h5,p{font-weight:300}h3,h4{font-weight:400}html,body{margin:0;padding:0}input,button{outline:0}button{cursor:pointer}ul,li{list-style:none}ul{margin:0;padding:0}a{text-decoration:none}.clear{display:block;clear:both}.light-text{color:#fff}.right{float:right}.left{float:left}.center{text-align:center}h1{font-size:32px;line-height:40px}h2{font-size:28px;line-height:60px}h3{font-size:24px;line-height:32px}h4{font-size:20px;line-height:40px}h5{font-size:16px;line-height:36px}p{font-size:14px;line-height:22px}section,header,#vendorStrip{padding-left:20px;padding-right:20px}section main,header main,#vendorStrip main{width:100%;max-width:100%}header{height:80px}.nav-buttons{height:80px;line-height:80px}.nav-buttons .button+*{margin-left:30px}#hamburger{width:50px;height:50px}#mainNav{padding:140px 0 30px}#mainNav h5{margin-bottom:1em}#mainNav h3{margin-bottom:.6em}#mainNav .nav-box{width:20%}#mainNav .nav-box+.nav-box{margin-left:calc(20%/3)}#mainNav main+main{margin-top:60px}#mainNav .left .button{height:50px;line-height:50px;font-size:18px}.open-nav #tryKubernetes,.y-enough #tryKubernetes{margin-left:30px}#hero{padding-top:80px}#docs #hero h1,#docs #hero h5{padding-left:20px;padding-right:20px}#vendorStrip{height:88px;line-height:88px;font-size:16px}body{background-color:#fff}section{position:relative;background-color:#fff}section main,header main,footer main{position:relative;margin:auto}p{font-size:14px;font-weight:400}.button{display:inline-block;border-radius:6px;padding:0 20px;line-height:40px;color:#fff;background-color:#3371e3;text-decoration:none}#cellophane{position:fixed;top:0;left:0;width:100%;height:100%;display:none}header{position:fixed;top:0;left:0;width:100%;z-index:8888;background-color:transparent;box-shadow:0 0 0 transparent;overflow:hidden;transition:.3s;text-align:center}.logo{position:relative;float:left;display:block;width:180px;height:88px;top:0;left:0;transform:none;background-image:url(/images/nav_logo.svg);background-size:contain;background-position:center center;background-repeat:no-repeat}#docs .flyout-button{position:fixed;top:20px;left:20px;width:50px;height:50px;background-image:url(/images/toc_icon.png);background-position:center center;background-repeat:no-repeat;background-size:auto;border-radius:50%;transition:.3s;z-index:99999}#docs.open-nav .flyout-button{display:none}#docs .logo{position:absolute;top:40px;left:50%;transform:translate(-50%,-50%);display:block;width:45px;height:44px;background-image:url(/images/favicon.png)}#docs.flip-nav .flyout-button{background-image:url(/images/toc_icon_grey.png)}.nav-buttons{float:right}#viewDocs,#tryKubernetes{display:none}#viewDocs{border:2px solid #fff;background-color:transparent;transition:.3s}#viewDocs:hover{background-color:#fff;color:#303030}#tryKubernetes{width:0;padding:0;border:1px solid transparent;background-color:transparent;text-align:center;white-space:nowrap;vertical-align:middle;overflow:hidden;transition:.3s}#hamburger{display:inline-block;position:relative;vertical-align:middle;padding:0;border:0;background:0 0}#hamburger div,#hamburger:before,#hamburger:after{position:absolute;left:15%;width:70%;height:2px;background-color:#3371e3;transition:.3s;content:""}#hamburger div{top:calc(50% - 1px)}#hamburger:before{top:24%}#hamburger:after{bottom:24%}#hamburger:hover div,#hamburger:hover:before,#hamburger:hover:after{background-color:#fff}#mainNav h5{color:#3371e3;font-weight:400}#mainNav main{white-space:nowrap;overflow:hidden;clear:both}#mainNav .nav-box{float:left;white-space:normal}#mainNav h3 a{color:#3371e3;text-decoration:none}ul.global-nav{display:none}ul.global-nav li{display:inline-block;margin-right:14px}ul.global-nav li a{color:#fff;font-weight:400;padding:0;position:relative}ul.global-nav li a.active:after{position:absolute;width:100%;height:2px;content:'';bottom:-4px;left:0;background:#fff}ul.global-nav li a .ui-icon{filter:brightness(0) invert(1)}ul.global-nav li ul{display:none;position:fixed;top:40px;text-align:left}ul.global-nav li ul li{display:block;height:28px}ul.global-nav li ul li a{background:#303030;color:#fff;padding:7px}ul.global-nav li ul li:last-child a{border-radius:7px}ul.global-nav li:hover ul{display:block}.flip-nav ul.global-nav li a,.open-nav ul.global-nav li a{color:#303030}.flip-nav ul.global-nav li a .ui-icon{filter:brightness(0)}.flip-nav ul.global-nav li ul li a{background:#fff;color:#303030}.flip-nav ul.global-nav li a.active:after,.flip-nav ul.global-nav li ul li a.active:after,.open-nav ul.global-nav li a.active:after{background:#3371e3}.flip-nav header{background-color:#fff}.open-nav body{overflow:hidden}.open-nav #cellophane{display:block;z-index:9998}.open-nav header{background-color:#e8e8e8;z-index:9999}.open-nav #hamburger div{opacity:0}.open-nav #hamburger:before,.open-nav #hamburger:after{left:12px;transform-origin:0 1px}.open-nav #hamburger:before{transform:rotate(45deg)}.open-nav #hamburger:after{transform:rotate(-45deg)}.open-nav #tryKubernetes,.y-enough #tryKubernetes{width:150px;background-color:#3371e3;border-color:#3371e3}.flip-nav header,.open-nav header{box-shadow:0 1px 2px #4c4c4c}.flip-nav #viewDocs,.open-nav #viewDocs{border-color:#303030;color:#303030}.flip-nav #viewDocs:hover,.open-nav #viewDocs:hover{border-color:#3371e3;background-color:#3371e3;color:#fff}.flip-nav #hamburger:hover div,.flip-nav #hamburger:hover:before,.flip-nav #hamburger:hover:after,.open-nav #hamburger:hover div,.open-nav #hamburger:hover:before,.open-nav #hamburger:hover:after{background-color:#303030}#hero{background-image:url(/images/texture.png);background-color:#303030;text-align:center;padding-left:0;padding-right:0;margin-bottom:0;position:relative}#hero.bot-bar:after{display:block;margin-bottom:-20px;height:8px;width:100%;background-color:rgba(255,255,255,.1);content:''}#hero.no-sub h5{display:none}#hero.no-sub h1{margin-bottom:20px}#home #hero:after{display:none}#vendorStrip{position:relative;background-color:rgba(255,255,255,.1);font-weight:100;white-space:nowrap;text-align:center}#vendorStrip li a{color:rgba(255,255,255,.5)}#vendorStrip li a.YAH{color:#fff;position:relative}footer{width:100%;background-image:url(/images/texture.png);background-color:#303030}footer main{padding:20px 0}footer nav a{width:100%;text-align:center;display:inline-block;margin:10px 0;font-size:24px;font-weight:300;color:#fff;text-decoration:none}footer .social{margin:20px 0}footer .social div{text-align:center;margin-bottom:20px}footer .social div:last-child{margin:30px 0}footer .social span{display:block;margin-bottom:8px}footer .social input{text-align:center}#search,#wishField{background-color:transparent;padding:10px;font-size:16px;font-weight:100;color:#fff;border:1px solid #fff;transition:.3s}#search:focus,#wishField:focus{background-color:#f7f7f7;color:#303030}.social a{display:inline-block;background-image:url(/images/social_sprite.png);background-repeat:no-repeat;background-size:auto;width:50px;height:50px;border-radius:5px;margin-right:10px}.social a:hover{background-color:#fff}.social a span{position:absolute;display:block;height:0;overflow:hidden}.social a.button{background-image:none;width:auto;height:auto}.social a.button:hover{color:#3371e3}a.twitter{background-position:0 0}a.twitter:hover{background-position:0 100%}a.stack-overflow{background-position:-50px 0}a.stack-overflow:hover{background-position:-50px 100%}a.slack{background-position:-100px 0}a.slack:hover{background-position:-100px 100%}a.github{background-position:-150px 0}a.github:hover{background-position:-150px 100%}a.mailing-list{background-position:-200px 0}a.mailing-list:hover{background-position:-200px 100%}a.calendar{background-position:-250px 0}a.calendar:hover{background-position:-250px 100%}#viewDocs{display:none}section{background-color:#fff}#hero{background-color:#303030}#hero h5{margin:20px 0;line-height:28px}#vendorStrip{position:relative}#vendorStrip ul{float:left}#vendorStrip li{display:inline-block;height:100%}#vendorStrip a{display:block;height:100%;color:#fff;font-size:.75em;font-weight:700}#vendorStrip li+li{margin-left:0}#docs #vendorStrip{line-height:44px}#docs #vendorStrip ul{float:none}#docs #vendorStrip #searchBox{float:none;display:block;width:80%;margin:0 auto;height:44px;line-height:44px;position:relative}#docs #vendorStrip #searchBox:before{position:absolute;width:15px;height:15px;content:'';right:8px;top:7px;background-image:url(/images/search-icon.svg);background-repeat:no-repeat;background-size:100% 100%;z-index:1}#docs #vendorStrip #search{width:100%;padding:0 10px;height:30px;line-height:30px;font-size:16px;vertical-align:top;background:#fff;border:0;border-radius:4px;position:relative}#encyclopedia{position:relative;padding:50px 20px 20px;overflow:hidden;font-size:14px}#encyclopedia>div{height:100%}#docsToc{position:fixed;background-color:#fff;top:0;left:0;width:0;height:100vh;overflow:hidden;padding:50px 0;z-index:999999;transition:.3s}#docsToc .yah>.title{background-color:#f7f7f7;border-left:3px solid #3371e3;padding:7.5px 10px 7.5px 18px;margin-left:-3px;color:#3371e3}.open-toc body{overflow:hidden}.open-toc #docsToc{padding:50px 20px;width:400px;max-width:100vw;overflow-y:auto}.pi-accordion>.container:first-child>.item:first-child>.title:first-child{padding-left:0;font-size:1.5em;font-weight:700}.pi-accordion>.container:first-child>.item.yah:first-child>.title:first-child{margin-left:-20px!important}.pi-accordion .item{overflow:hidden}.pi-accordion .title{color:#303030;position:relative;padding:7.5px 10px 7.5px 18px;cursor:pointer;transition:.3s}.pi-accordion .title:hover{color:#3371e3}.pi-accordion a.item>.title{color:#000}.pi-accordion a.item>.title:hover{color:#3371e3}.pi-accordion div.item>.title:before{content:"";position:absolute;top:12px;left:2px;border-style:solid;border-width:5px 0 5px 8px;border-color:transparent transparent transparent #3371e3;transform:rotate(0deg);transition:.3s}.pi-accordion .wrapper{position:relative;width:100%;transition:height .3s}.pi-accordion .content{padding-left:20px;opacity:0;transition:.3s}.pi-accordion .item.on>.title:before{transform:rotate(90deg)}.pi-accordion .item.on>.wrapper>.content{opacity:1}dt{margin-bottom:8px}dd{margin-bottom:16px}.pi-pushmenu{display:none;position:fixed;top:0;width:100%;height:100%;opacity:0;transition:opacity .3s}.pi-pushmenu.on{opacity:1}.pi-pushmenu .overlay{position:fixed;top:0;left:0;width:100%;height:100%;background-color:rgba(0,0,0,.4)}.pi-pushmenu .sled{position:absolute;top:0;width:0;height:100%;background-color:#fff;overflow:auto;transition:.3s}.pi-pushmenu.on .sled{width:400px;max-width:100vw}.pi-pushmenu .top-bar{height:0;line-height:60px;background-color:#444}.pi-pushmenu ul{margin-top:25px}.pi-pushmenu li{position:relative;display:block;width:100%;min-height:45px;padding:0 60px 0 20px;border-bottom:1px solid #ccc}.pi-pushmenu a{display:inline-block;width:100%;height:45px;line-height:45px;font-family:roboto,sans-serif;font-size:20px;color:#3371e3}.pi-pushmenu .button{background:0 0;padding:0}.pi-pushmenu ul ul{padding:0 20px}.pi-pushmenu ul ul li{min-height:40px}.pi-pushmenu ul ul a{height:40px;line-height:40px;font-size:18px;color:#555}.push-menu-close-button{position:absolute;top:0;right:0;width:50px;height:50px}.push-menu-close-button:before,.push-menu-close-button:after{content:"";position:absolute;top:calc(50% - 1px);left:25%;width:50%;height:2px;background-color:#000}.push-menu-close-button:before{transform:rotate(45deg)}.push-menu-close-button:after{transform:rotate(-45deg)}#docsContent{position:relative;float:right;width:100%}#docsContent *+h2,#docsContent *+h3,#docsContent *+h4,#docsContent *+h5,#docsContent *+h6{margin-top:30px}#docsContent h1,#docsContent h2,#docsContent h3,#docsContent h4,#docsContent h5,#docsContent h6{line-height:normal;font-weight:500;margin-bottom:30px;padding-bottom:10px}#docsContent h1:before,#docsContent h2:before,#docsContent h3:before,#docsContent h4:before,#docsContent h5:before,#docsContent h6:before{display:block;content:" ";margin-top:-100px;height:100px;visibility:hidden}#docsContent h1,#docsContent h2{border-bottom:1px solid #ccc}#docsContent h1{font-size:32px;padding-right:60px}#docsContent h2{font-size:28px}#docsContent h3{font-size:24px;font-weight:300;margin-bottom:5px}#docsContent h4{font-size:20px;margin-bottom:0}#docsContent h5,#docsContent h6{font-size:16px;font-weight:500}#docsContent p{font-size:16px;font-weight:300;line-height:1.75em}#docsContent p+p{margin-top:10px}#docsContent code{display:inline-block;box-sizing:border-box;background-color:#f7f7f7;color:#303030;font-family:roboto mono,monospace;vertical-align:baseline;font-size:14px;font-weight:700;padding:2px 4px}#docsContent a code{color:#3371e3;text-decoration:underline}#docsContent pre .pi,#docsContent pre .s{margin:0;padding:0}#docsContent .highlight code span,#docsContent code,#docsContent pre code{font-family:roboto mono,monospace}#docsContent code,#docsContent pre code{color:#303030}#docsContent pre code{padding:0}#docsContent pre{background-color:#f7f7f7;display:block;margin:20px 0;padding:15px;position:relative;overflow-x:auto}#docsContent h1 code,#docsContent h2 code,#docsContent h3 code,#docsContent h4 code,#docsContent h5 code,#docsContent h6 code{font-size:inherit;background-color:transparent}#docsContent .includecode{table-layout:fixed}#docsContent .includecode,#docsContent .includecode th,#docsContent .includecode td{padding:0!important}#docsContent .includecode th{text-align:right!important;padding:10px!important}#docsContent .includecode th a,#docsContent .includecode th a code{color:#fff!important;background-color:transparent!important}#docsContent .includecode pre{margin:0!important}#docsContent ul li{list-style:disc}#docsContent ol li{list-style:decimal}#docsContent ul,#docsContent ol{margin:20px 0;padding-left:30px;font-weight:300}#docsContent ul ul,#docsContent ol ol,#docsContent ul ol,#docsContent ol ul{margin:.75em 0}#docsContent li{margin-bottom:.75em;font-size:16px;line-height:1.75em}#docsContent table{width:100%;border:1px solid #ccc;border-spacing:0;margin-top:30px;margin-bottom:30px}#docsContent thead,#docsContent tr:nth-child(even){background-color:#f7f7f7}#docsContent thead{background-color:#555;color:#fff}#docsContent th,#docsContent td{padding:8px;text-align:left;margin:0}#docsContent th{font-weight:400}#docsContent td{font-size:.85em}#docsContent #editPageButton{position:absolute;top:-25px;right:5px;width:50px;height:50px;line-height:50px;border-radius:50%;white-space:nowrap;text-indent:50px;overflow:hidden;background:#3371e3 url(/images/icon-pencil.svg) no-repeat;background-position:12px 10px;background-size:29px 29px}#docsContent #markdown-toc,#docsContent #TableOfContents{margin-bottom:20px}#docsContent #markdown-toc ul,#docsContent #markdown-toc li,#docsContent #TableOfContents ul,#docsContent #TableOfContents li{list-style:disc;color:#3371e3}#docsContent #markdown-toc ul,#docsContent #TableOfContents ul{padding:0 15px;margin:0}#docsContent #markdown-toc li,#docsContent #TableOfContents li{padding:0;line-height:1.5em;margin-bottom:0}#docsContent #markdown-toc a,#docsContent #TableOfContents a{position:relative;color:#3371e3;font-weight:700}#docsContent img{max-width:100%}#docsContent #TableOfContents>ul>li{list-style:none}#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}html.search #docsContent{position:relative;float:none;width:90%;max-width:850px;margin:0 auto}html.search #docsContent #editPageButton{display:none}html.search #docsContent table{border:0;margin-bottom:0}html.search #docsContent td{padding:0}html.search #docsContent h1{margin-bottom:0;border-bottom:0;padding-bottom:0;padding-left:8px}#home.flip-nav .logo,#home.open-nav .logo{background-image:url(/images/nav_logo2.svg)}#home #hero{margin-bottom:0;padding-bottom:1px}#home #hero main{padding:0 10px;margin-bottom:30px}#home #hero #vendorStrip{display:none}#oceanNodes{padding-top:60px;padding-bottom:60px}#oceanNodes a{color:#3371e3}#oceanNodes main{margin-bottom:60px;min-height:160px}#oceanNodes .image-wrapper{max-width:75%;margin:0 auto 20px;text-align:center}#oceanNodes .image-wrapper img{width:100%;max-width:160px}#oceanNodes main:first-child .image-wrapper{max-width:100%}#oceanNodes main:first-child .image-wrapper img{max-width:491px}#oceanNodes h3{margin-bottom:30px}#video{height:200px}#video{width:100%;position:relative;background-position:center center;background-size:cover}#video>.light-text{display:none;position:absolute;top:50%;left:75%;width:525px;padding-right:80px;transform:translate(-50%,-50%);color:#fff}#video h2{font-size:32px;line-height:44px;margin-bottom:20px}#video p{margin-bottom:20px}#video #desktopKCButton{position:relative;font-size:18px;background-color:#303030;border-radius:8px;color:#fff;padding:20px 10px}#video #desktopShowVideoButton{position:relative;font-size:24px;background-color:#fff;border-radius:8px;color:#3371e3;padding:15px 30px 15px 80px;margin-bottom:15px}#video #desktopShowVideoButton:before{content:"";position:absolute;position:absolute;top:50%;left:40px;transform:translate(-50%,-50%);width:0;height:0;border-style:solid;border-width:10px 0 10px 20px;border-color:transparent transparent transparent #3371e3}#video #mobileShowVideoButton{position:absolute;top:50%;left:50%;transform:translate(-50%,-50%);width:80px;height:80px;border-radius:50%;background-color:transparent;border:5px solid rgba(255,255,255,.2);overflow:visible}#video #mobileShowVideoButton:after{position:absolute;top:50%;left:50%;transform:translate(-50%,-50%);left:40px;content:"";width:0;height:0;border-style:solid;border-width:20px 0 20px 30px;border-color:transparent transparent transparent #fff}#videoPlayer{position:fixed;top:0;left:0;width:100vw;height:100vh;background-color:rgba(0,0,0,.9);display:none}#videoPlayer iframe{position:absolute;top:50%;left:50%;transform:translate(-50%,-50%);width:80vw;height:45vw;max-width:142.22222222vh;max-height:80vh}#videoPlayer #closeButton{position:absolute;top:20px;right:20px;width:50px;height:50px;border:2px solid transparent;transition:.3s}#videoPlayer #closeButton:before,#videoPlayer #closeButton:after{content:"";position:absolute;top:calc(50% - 1px);left:10%;width:80%;height:2px;background-color:#fff}#videoPlayer #closeButton:before{transform:rotate(45deg)}#videoPlayer #closeButton:after{transform:rotate(-45deg)}#videoPlayer #closeButton:hover{border-color:#fff}#cncf{padding-top:60px;padding-bottom:140px;background-color:#f7f7f7;background-image:url(/images/cncf-color.png);background-position:center 100px;background-repeat:no-repeat;background-size:300px}#features{padding-top:140px;background-color:#f7f7f7;background-image:url(/images/wheel.png);background-position:center 60px;background-repeat:no-repeat;background-size:auto}.feature-box{width:100%;overflow:hidden;clear:both}.feature-box h4{line-height:normal;margin-bottom:15px}.feature-box>div:first-child{float:left}.feature-box>div:last-child{float:right}#features h3{margin-bottom:20px}#features .feature-box{margin-bottom:0}#features .feature-box>div{width:100%;margin-bottom:40px}#community.open-nav .logo,#community.flip-nav .logo,.gridPage.open-nav .logo,.gridPage.flip-nav .logo{background-image:url(/images/nav_logo2.svg)}#community #hero,.gridPage #hero{padding-bottom:20px}#community #mainContent,.gridPage #mainContent{padding:20px 0}#community #mainContent main,.gridPage #mainContent main{max-width:none}#community #mainContent a,.gridPage #mainContent a{color:#3371e3}#community #mainContent .content,.gridPage #mainContent .content{margin-bottom:30px;padding:30px 0}#community #mainContent .content h1,#community #mainContent .content h2,#community #mainContent .content h3,#community #mainContent .content h4,#community #mainContent .content h5,#community #mainContent .content h6,#community #mainContent .content p,.gridPage #mainContent .content h1,.gridPage #mainContent .content h2,.gridPage #mainContent .content h3,.gridPage #mainContent .content h4,.gridPage #mainContent .content h5,.gridPage #mainContent .content h6,.gridPage #mainContent .content p{line-height:normal;max-width:1200px;padding:0 20px;margin:0 auto 20px}#community #mainContent .content:nth-child(even),.gridPage #mainContent .content:nth-child(even){background-color:#f7f7f7}#community #mainContent .company-logos,.gridPage #mainContent .company-logos{text-align:center;max-width:1200px;margin:0 auto}#community #mainContent .company-logos img,.gridPage #mainContent .company-logos img{width:auto;margin:10px;background-color:#f7f7f7}#community #mainContent .partner-logos,.gridPage #mainContent .partner-logos{text-align:center;max-width:1200px;margin:0 auto}#community #mainContent .partner-logos img,.gridPage #mainContent .partner-logos img{width:auto;margin:10px;background-color:#fff;box-shadow:0 5px 5px rgba(0,0,0,.24),0 0 5px rgba(0,0,0,.12)}#community #mainContent #calendarMeetings,.gridPage #mainContent #calendarMeetings{position:relative;width:80vw;height:60vw;max-width:1200px;max-height:900px;margin:20px auto}#community #mainContent #calendarEvents,.gridPage #mainContent #calendarEvents{position:relative;width:80vw;height:30vw;max-width:1200px;max-height:450px;margin:20px auto}#community #mainContent iframe,.gridPage #mainContent iframe{position:absolute;border:0;width:100%;height:100%}.ui-icon{display:inline-block!important}#feature-state-dialog-link{text-decoration:none!important;padding:5px!important}#feature-state-dialog-link a:visited{color:#454545!important}#feature-state-dialog-link a code{display:inline-block!important;box-sizing:border-box!important;background-color:#f7f7f7!important;color:#303030!important;font-family:roboto mono,monospace!important;vertical-align:baseline!important;font-size:14px!important;font-weight:700!important;padding:0 4px!important}#feature-state-dialog{background:#fff!important;border:1px solid #ddd!important;padding:.5em 1em!important}#feature-state-dialog ul,#feature-state-dialog li{list-style:disc!important;margin:4px 12px!important}#feature-state-dialog p{margin:8px 0!important}#feature-state-dialog code{display:inline-block!important;box-sizing:border-box!important;background-color:#f7f7f7!important;color:#303030!important;font-family:roboto mono,monospace!important;vertical-align:baseline!important;font-size:14px!important;font-weight:700!important;padding:0 4px!important}.ui-dialog{background:#f7f7f7!important;padding:.5em}.ui-dialog-content{position:relative;float:right;width:100%}.ui-dialog-content *+h2,.ui-dialog-content *+h3,.ui-dialog-content *+h4,.ui-dialog-content *+h5,.ui-dialog-content *+h6{margin-top:30px}.ui-dialog-content h1,.ui-dialog-content h2,.ui-dialog-content h3,.ui-dialog-content h4,.ui-dialog-content h5,.ui-dialog-content h6{line-height:normal;font-weight:500;margin-bottom:30px;padding-bottom:10px}.ui-dialog-content h1:before,.ui-dialog-content h2:before,.ui-dialog-content h3:before,.ui-dialog-content h4:before,.ui-dialog-content h5:before,.ui-dialog-content h6:before{display:block;content:" ";margin-top:-100px;height:100px;visibility:hidden}.ui-dialog-content h1,.ui-dialog-content h2{border-bottom:1px solid #ccc}.ui-dialog-content h1{font-size:32px;padding-right:60px}.ui-dialog-content h2{font-size:28px}.ui-dialog-content h3{font-size:24px;font-weight:300;margin-bottom:5px}.ui-dialog-content h4{font-size:20px;margin-bottom:0}.ui-dialog-content h5,.ui-dialog-content h6{font-size:16px;font-weight:500}.ui-dialog-content p{font-size:16px;font-weight:300;line-height:1.75em}.ui-dialog-content p+p{margin-top:10px}.ui-dialog-content code{display:inline-block;box-sizing:border-box;background-color:#f7f7f7;color:#303030;font-family:roboto mono,monospace;vertical-align:baseline;font-size:14px;font-weight:700;padding:2px 4px}.ui-dialog-content a code{color:#3371e3;text-decoration:underline}.ui-dialog-content pre .pi,.ui-dialog-content pre .s{margin:0;padding:0}.ui-dialog-content .highlight code span,.ui-dialog-content code,.ui-dialog-content pre code{font-family:roboto mono,monospace}.ui-dialog-content code,.ui-dialog-content pre code{color:#303030}.ui-dialog-content pre code{padding:0}.ui-dialog-content pre{background-color:#f7f7f7;display:block;margin:20px 0;padding:15px;position:relative;overflow-x:auto}.ui-dialog-content h1 code,.ui-dialog-content h2 code,.ui-dialog-content h3 code,.ui-dialog-content h4 code,.ui-dialog-content h5 code,.ui-dialog-content h6 code{font-family:inherit;font-size:inherit;background-color:transparent}.ui-dialog-content .includecode{table-layout:fixed}.ui-dialog-content .includecode,.ui-dialog-content .includecode th,.ui-dialog-content .includecode td{padding:0!important}.ui-dialog-content .includecode th{text-align:right!important;padding:10px!important}.ui-dialog-content .includecode th a,.ui-dialog-content .includecode th a code{color:#fff!important;background-color:transparent!important}.ui-dialog-content .includecode pre{margin:0!important}.ui-dialog-content ul li{list-style:disc}.ui-dialog-content ol li{list-style:decimal}.ui-dialog-content ul,.ui-dialog-content ol{margin:20px 0;padding-left:30px;font-weight:300}.ui-dialog-content ul ul,.ui-dialog-content ol ol,.ui-dialog-content ul ol,.ui-dialog-content ol ul{margin:.75em 0}.ui-dialog-content li{margin-bottom:.75em;font-size:16px;line-height:1.75em}.ui-dialog-content table{width:100%;border:1px solid #ccc;border-spacing:0;margin-top:30px;margin-bottom:30px}.ui-dialog-content thead,.ui-dialog-content tr:nth-child(even){background-color:#f7f7f7}.ui-dialog-content thead{background-color:#555;color:#fff}.ui-dialog-content th,.ui-dialog-content td{padding:8px;text-align:left;margin:0}.ui-dialog-content th{font-weight:400}.ui-dialog-content td{font-size:.85em}.ui-dialog-content #editPageButton{position:absolute;top:-25px;right:5px;width:50px;height:50px;line-height:50px;border-radius:50%;white-space:nowrap;text-indent:50px;overflow:hidden;background:#3371e3 url(/images/icon-pencil.svg) no-repeat;background-position:12px 10px;background-size:29px 29px}.ui-dialog-content #markdown-toc{margin-bottom:20px}.ui-dialog-content #markdown-toc ul,.ui-dialog-content #markdown-toc li{list-style:disc;color:#3371e3}.ui-dialog-content #markdown-toc ul{padding:0 15px;margin:0}.ui-dialog-content #markdown-toc li{padding:0;line-height:1.5em;margin-bottom:0}.ui-dialog-content #markdown-toc a{position:relative;color:#3371e3;font-weight:700}.ui-dialog-content img{max-width:100%}.ui-dialog-content a{text-decoration:underline}.ui-dialog-buttonpane{background:#f7f7f7!important}.ui-widget-header{background:0 0!important;background-color:transparent!important;border:0!important}.ui-tabs ul,.ui-tabs ol,.ui-tabs li{padding:0!important;list-style:none!important;margin-bottom:0!important;margin-left:4px!important}.ui-tabs-panel ul li{list-style:disc!important}.ui-tabs-panel ol li{list-style:decimal!important}.ui-widget-content{border:0!important}.ui-widget-content table{margin:0!important}.ui-tabs .ui-tabs-panel{border:1px solid #ccc!important}.ui-tabs-anchor{text-decoration:none!important}#talkToUs h3,#talkToUs h4{text-align:center}#talkToUs h3{margin-bottom:15px}#talkToUs h4{line-height:normal;margin-bottom:50px}#talkToUs h4 br{display:none}#talkToUs #bigSocial{overflow:hidden}#talkToUs #bigSocial div{width:100%;float:left;padding:30px;padding-top:110px;background-position:center top;background-size:auto;background-repeat:no-repeat}#talkToUs #bigSocial div:nth-child(1){background-image:url(/images/twitter_icon.png)}#talkToUs #bigSocial div:nth-child(2){background-image:url(/images/github_icon.png)}#talkToUs #bigSocial div:nth-child(3){background-image:url(/images/slack_icon.png)}#talkToUs #bigSocial div:nth-child(4){background-image:url(/images/stackoverflow_icon.png)}#talkToUs #bigSocial div+div{margin-top:20px;margin-left:0}#talkToUs #bigSocial a{display:inline-block;color:#3371e3;font-size:24px;font-weight:400;text-decoration:none;margin-bottom:15px}#talkToUs #bigSocial a,#talkToUs #bigSocial p{text-align:center;width:100%}#home #talkToUs main{padding:30px 0}#home #talkToUs h5{font-size:20px}#home #caseStudiesWrapper{position:relative;text-align:center;margin-bottom:30px}#home #caseStudiesWrapper img{padding-bottom:1rem}#home #caseStudiesWrapper div{position:relative;display:inline-block;vertical-align:top;width:100%;min-height:230px;margin-bottom:60px;padding-right:1rem;background-position:top center}#home #caseStudiesWrapper p{font-size:20px}#home #caseStudiesWrapper a{position:absolute;bottom:-30px;left:50%;transform:translateX(-50%);color:#3371e3;font-weight:400}.cse .gsc-control-cse,.gsc-control-cse{padding:0}.gsc-control-cse table,.gsc-control-cse-en table{margin:0!important}.gsc-above-wrapper-area{border-bottom:0}#bing-results-container{margin-top:30px;margin-left:20px}.bing-result{margin-bottom:20px}.bing-result-name a{font-size:16px;color:#00c}.bing-result-url{color:green;font-size:13px}.bing-result-snippet{color:#000;font-size:11px}#bing-pagination-container{margin:10px;margin-left:20px}.bing-page-anchor{text-decoration:none!important;cursor:pointer;color:#00c;margin-right:8px}hr{background-color:#999}h2{margin-bottom:15px!important}.subhead{padding-bottom:2%!important;padding-top:0%!important}.details{margin-left:1.9%;padding-right:5%;font-size:16px!important;padding-bottom:2%!important}.section1{margin-bottom:3%}.section1 .cols{width:80%!important;margin-left:6.8%;padding-top:1.5%}.section1 .cols .col1{width:52%!important;font-weight:300!important}.section1 .cols .col2{width:46%!important}.banner2text{width:63%;padding-top:10%;padding-left:0%!important;float:initial!important;text-align:center;margin:0 auto;position:relative}.banner3text,.banner4text,.banner5text{width:63%;padding-left:0%!important;float:initial!important;text-align:center;margin:0 auto;position:relative}.fullcol{float:initial!important}body footer{background-color:#585858!important}.section1{float:left!important}.banner1{padding-left:11.9%!important}.banner2{float:initial!important;padding-bottom:2%!important}footer{padding:0% 7%}.banner4,.banner3,.banner5{float:initial!important}@media screen and (max-width:910px){.banner2text{width:47%;padding-top:45%}.details{margin-left:0%;margin-bottom:3%}.subhead{padding-bottom:0%!important;padding-top:0%!important}.banner3{width:100%!important}}@media screen and (max-width:780px){.section1 .cols{width:100%!important;margin-left:0%;padding-top:5%}.section1 .cols .col1,.section1 .cols .col2{width:100%!important;margin-left:0%!important}.fullcol{width:90%!important;margin-left:5%!important}.banner1{padding-left:10%!important;margin-bottom:6%!important}.banner2text{padding-top:60%!important;padding-bottom:2%!important}}@media screen and (min-width:750px){h1{font-size:32px;line-height:40px}h2{font-size:28px;line-height:60px}h3{font-size:24px;line-height:32px}h4{font-size:20px;line-height:40px}h5{font-size:16px;line-height:36px}p{font-size:14px;line-height:22px}section,header,#vendorStrip{padding-left:20px;padding-right:20px}section main,header main,#vendorStrip main{width:100%;max-width:100%}header{height:80px}.nav-buttons{height:80px;line-height:80px}.nav-buttons .button+*{margin-left:30px}#hamburger{width:50px;height:50px}#mainNav{padding:140px 0 30px}#mainNav h5{margin-bottom:1em}#mainNav h3{margin-bottom:.6em}#mainNav .nav-box{width:20%}#mainNav .nav-box+.nav-box{margin-left:calc(20%/3)}#mainNav main+main{margin-top:60px}#mainNav .left .button{height:50px;line-height:50px;font-size:18px}.open-nav #tryKubernetes,.y-enough #tryKubernetes{margin-left:30px}#hero{padding-top:80px}#docs #hero h1,#docs #hero h5{padding-left:20px;padding-right:20px}#vendorStrip{height:88px;line-height:88px;font-size:16px}p{font-size:16px;line-height:24px;letter-spacing:.1px}h1{font-size:36px;line-height:44px}h3{font-size:28px;line-height:36px}h4{font-size:24px;line-height:40px}#home #viewDocs,#home #tryKubernetes{display:inline-block}#vendorStrip{display:block;text-align:center}#vendorStrip img{max-height:24px;vertical-align:middle;margin:0 30px}#docs #vendorStrip li a{font-size:1em;font-weight:400}#docs #vendorStrip li li+li{margin-left:60px}#oceanNodes h3{text-align:left;margin-bottom:18px}#oceanNodes main{position:relative;clear:both;display:table}#oceanNodes main .content{display:table-cell;position:relative;vertical-align:middle}#oceanNodes main .image-wrapper{position:absolute;top:50%;max-width:25%;max-height:100%;transform:translateY(-50%)}#oceanNodes main:nth-child(odd){padding-right:210px}#oceanNodes main:nth-child(odd) .image-wrapper{right:0}#oceanNodes main:nth-child(even){padding-left:210px}#oceanNodes main:nth-child(even) .image-wrapper{left:0}#oceanNodes main:nth-child(1){padding-right:0}#oceanNodes main:nth-child(1) h3,#oceanNodes main:nth-child(1) p{text-align:center}#oceanNodes main:nth-child(1) .image-wrapper{position:relative;display:block;float:none;max-width:100%;transform:none}#oceanNodes main:nth-child(1) .content{display:block}#oceanNodes main img{width:100%}#video{height:400px;display:block}#video>.light-text{display:block}#mobileShowVideoButton{display:none}#features{padding-bottom:60px}#features .feature-box{margin-bottom:30px}#features .feature-box:last-child{margin-bottom:0}#features h3{margin-bottom:40px}#features .feature-box>div{width:45%;margin-bottom:0}#talkToUs #bigSocial div{width:calc(50% - 15px)}#talkToUs #bigSocial div+div{margin-top:0}#talkToUs #bigSocial div:nth-child(2){margin-left:20px}#talkToUs #bigSocial div:nth-child(3){margin-top:20px}#talkToUs #bigSocial div:nth-child(4){margin-top:20px;margin-left:20px}#talkToUs #bigSocial a{display:inline-block;color:#3371e3;font-weight:400;text-decoration:none}footer nav{text-align:center}footer nav a{width:30%;padding:0 20px}footer .social{text-align:center}footer .social div{display:inline-block}footer .social div:last-child{display:block;margin:0}footer .social span{display:inline-block;margin-right:10px}footer .social input{text-align:left}#home #caseStudiesWrapper div{width:48%}}@media screen and (min-width:1025px){#hamburger{display:none}ul.global-nav{display:inline-block}#docs #vendorStrip #searchBox:before{top:15px}#vendorStrip{height:44px;line-height:44px}#vendorStrip li a.YAH:after{content:"";display:block;position:absolute;left:0;bottom:0;width:100%;height:4px;background-color:#3371e3}#vendorStrip #searchBox{float:right}#home #hero #vendorStrip{display:block}#docs #hero h1,#docs #hero h5{text-align:left}#docs #hero #vendorStrip ul{float:left}#docs #hero #vendorStrip #searchBox{float:right;width:250px}#docs #hero #vendorStrip #search{vertical-align:middle}#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)}#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}#docsContent{width:calc(100% - 400px)}#docsContent #editPageButton{right:-25px}section main,header main,footer main{max-width:1200px}header,#vendorStrip,#encyclopedia,#hero h1,#hero h5,#docs #hero h1,#docs #hero h5,#community #hero h1,.gridPage #hero h1,#community #hero h5,.gridPage #hero h5{padding-left:100px;padding-right:100px}#vendorStrip{padding-right:10px}#home section main,#home header main,#home footer main{max-width:1e3px}#oceanNodes main{position:relative;max-width:830px}#oceanNodes main:nth-child(1){max-width:1e3px;padding-right:475px}#oceanNodes main:nth-child(1) h3,#oceanNodes main:nth-child(1) p{text-align:left}#oceanNodes main:nth-child(1) .image-wrapper{position:absolute;max-width:48%;transform:translateY(-50%)}#oceanNodes main:nth-child(1) .image-wrapper img{max-width:425px}#video{height:550px;position:relative;background-position:center center;background-size:cover}#talkToUs h4 br{display:block}#talkToUs #bigSocial div{width:calc(25% - 18px)}#talkToUs #bigSocial div+div{margin-left:20px}footer{width:100%;background-image:url(../images/texture.png);background-color:#303030}footer main{padding:20px 0}footer nav{overflow:hidden;margin-bottom:20px}footer nav a{width:16.65%;float:left;font-size:24px;font-weight:300;white-space:nowrap}footer .social{padding:0 30px;max-width:1200px}footer .social div{float:left}footer .social div:last-child{float:right}#search,#wishField{background-color:transparent;padding:10px;font-size:16px;font-weight:100;color:#fff;border:1px solid #fff;transition:.3s}#search:focus,#wishField:focus{background-color:#f7f7f7;color:#303030}.social a{display:inline-block;background-image:url(../images/social_sprite.png);background-repeat:no-repeat;background-size:auto;width:50px;height:50px;border-radius:5px;margin-right:10px}.social a:hover{background-color:#fff}.social a span{position:absolute;display:block;height:0;overflow:hidden}a.twitter{background-position:0 0}a.twitter:hover{background-position:0 100%}a.stack-overflow{background-position:-50px 0}a.stack-overflow:hover{background-position:-50px 100%}a.slack{background-position:-100px 0}a.slack:hover{background-position:-100px 100%}a.github{background-position:-150px 0}a.github:hover{background-position:-150px 100%}a.mailing-list{background-position:-200px 0}a.mailing-list:hover{background-position:-200px 100%}a.calendar{background-position:-250px 0}a.calendar:hover{background-position:-250px 100%}#community #hero,.gridPage #hero{text-align:left}#community #hero h1,.gridPage #hero h1{padding:20px 100px}#community #tryKubernetes,.gridPage #tryKubernetes{width:auto;background-color:#3371e3;padding:0 20px}#bigSocial div{width:calc(25% - 18px)}#home #caseStudiesWrapper div{width:24%;min-height:260px}}@media screen and (min-width:1300px){#vendorStrip{padding-right:100px}}@media screen and (min-width:456px){#vendorStrip li+li{margin-left:20px}} \ No newline at end of file diff --git a/resources/_gen/assets/sass/sass/case_study_styles.sass_cb957da2191fde4902dd41b139c8069d.json b/resources/_gen/assets/sass/sass/case_study_styles.sass_cb957da2191fde4902dd41b139c8069d.json deleted file mode 100644 index b743159a37..0000000000 --- a/resources/_gen/assets/sass/sass/case_study_styles.sass_cb957da2191fde4902dd41b139c8069d.json +++ /dev/null @@ -1 +0,0 @@ -{"Target":"css/styles.min.544877f7aaf1761d19cb1da7afc725c3bbdd062dc307a515caaae3cbfcadafd5.css","MediaType":"text/css","Data":{"Integrity":"sha256-VEh396rxdh0Zyx2nr8clw7vdBi3DB6UVyqrjy/ytr9U="}} \ No newline at end of file diff --git a/resources/_gen/assets/sass/sass/styles.sass_a6e533854c4de092afe9278041939937.content b/resources/_gen/assets/sass/sass/styles.sass_a6e533854c4de092afe9278041939937.content new file mode 100644 index 0000000000..fbbc79a5e5 --- /dev/null +++ b/resources/_gen/assets/sass/sass/styles.sass_a6e533854c4de092afe9278041939937.content @@ -0,0 +1,1946 @@ +html, body { + margin: 0; + padding: 0; } + +input, button { + outline: none; } + +button { + cursor: pointer; } + +ul, li { + list-style: none; } + +ul { + margin: 0; + padding: 0; } + +a { + text-decoration: none; } + +.clear { + display: block; + clear: both; } + +.light-text { + color: white; } + +.right { + float: right; } + +.left { + float: left; } + +.center { + text-align: center; } + +*, .button { + box-sizing: border-box; + font-family: "Roboto", sans-serif; + background: none; + margin: 0; + border: 0; } + +body { + font-family: "Roboto", sans-serif; } + +h1, h2, h5, p { + font-weight: 300; } + +h3, h4 { + font-weight: 400; } + +html, body { + margin: 0; + padding: 0; } + +input, button { + outline: none; } + +button { + cursor: pointer; } + +ul, li { + list-style: none; } + +ul { + margin: 0; + padding: 0; } + +a { + text-decoration: none; } + +.clear { + display: block; + clear: both; } + +.light-text { + color: white; } + +.right { + float: right; } + +.left { + float: left; } + +.center { + text-align: center; } + +h1 { + font-size: 32px; + line-height: 40px; } + +h2 { + font-size: 28px; + line-height: 60px; } + +h3 { + font-size: 24px; + line-height: 32px; } + +h4 { + font-size: 20px; + line-height: 40px; } + +h5 { + font-size: 16px; + line-height: 36px; } + +p { + font-size: 14px; + line-height: 22px; } + +section, header, #vendorStrip { + padding-left: 20px; + padding-right: 20px; } + section main, header main, #vendorStrip main { + width: 100%; + max-width: 100%; } + +header { + height: 80px; } + +.nav-buttons { + height: 80px; + line-height: 80px; } + .nav-buttons .button + * { + margin-left: 30px; } + +#hamburger { + width: 50px; + height: 50px; } + +#mainNav { + padding: 140px 0 30px; } + #mainNav h5 { + margin-bottom: 1em; } + #mainNav h3 { + margin-bottom: 0.6em; } + #mainNav .nav-box { + width: 20%; } + #mainNav .nav-box + .nav-box { + margin-left: calc(20% / 3); } + #mainNav main + main { + margin-top: 60px; } + #mainNav .left .button { + height: 50px; + line-height: 50px; + font-size: 18px; } + +.open-nav #tryKubernetes, .y-enough #tryKubernetes { + margin-left: 30px; } + +#hero { + padding-top: 80px; } + +#docs #hero h1, #docs #hero h5 { + padding-left: 20px; + padding-right: 20px; } + +#vendorStrip { + height: 88px; + line-height: 88px; + font-size: 16px; } + +body { + background-color: white; } + +section { + position: relative; + background-color: white; } + +section main, header main, footer main { + position: relative; + margin: auto; } + +p { + font-size: 14px; + font-weight: 400; } + +.button { + display: inline-block; + border-radius: 6px; + padding: 0 20px; + line-height: 40px; + color: white; + background-color: #3371e3; + text-decoration: none; } + +#cellophane { + position: fixed; + top: 0; + left: 0; + width: 100%; + height: 100%; + display: none; } + +header { + position: fixed; + top: 0; + left: 0; + width: 100%; + z-index: 8888; + background-color: transparent; + box-shadow: 0 0 0 transparent; + overflow: hidden; + transition: 0.3s; + text-align: center; } + +.logo { + position: relative; + float: left; + display: block; + width: 180px; + height: 88px; + top: 0; + left: 0; + transform: none; + background-image: url(/images/nav_logo.svg); + background-size: contain; + background-position: center center; + background-repeat: no-repeat; } + +#docs .flyout-button { + position: fixed; + top: 20px; + left: 20px; + width: 50px; + height: 50px; + background-image: url(/images/toc_icon.png); + background-position: center center; + background-repeat: no-repeat; + background-size: auto; + border-radius: 50%; + transition: 0.3s; + z-index: 99999; } + +#docs.open-nav .flyout-button { + display: none; } + +#docs .logo { + position: absolute; + top: 40px; + left: 50%; + transform: translate(-50%, -50%); + display: block; + width: 45px; + height: 44px; + background-image: url(/images/favicon.png); } + +#docs.flip-nav .flyout-button { + background-image: url(/images/toc_icon_grey.png); } + +.nav-buttons { + float: right; } + +#viewDocs, #tryKubernetes { + display: none; } + +#viewDocs { + border: 2px solid white; + background-color: transparent; + transition: 0.3s; } + #viewDocs:hover { + background-color: white; + color: #303030; } + +#tryKubernetes { + width: 0; + padding: 0 0; + border: 1px solid transparent; + background-color: transparent; + text-align: center; + white-space: nowrap; + vertical-align: middle; + overflow: hidden; + transition: 0.3s; } + +#hamburger { + display: inline-block; + position: relative; + vertical-align: middle; + padding: 0; + border: 0; + background: none; } + #hamburger div, #hamburger:before, #hamburger:after { + position: absolute; + left: 15%; + width: 70%; + height: 2px; + background-color: #3371e3; + transition: 0.3s; + content: ""; } + #hamburger div { + top: calc(50% - 1px); } + #hamburger:before { + top: 24%; } + #hamburger:after { + bottom: 24%; } + #hamburger:hover div, #hamburger:hover:before, #hamburger:hover:after { + background-color: white; } + +#mainNav h5 { + color: #3371e3; + font-weight: normal; } + +#mainNav main { + white-space: nowrap; + overflow: hidden; + clear: both; } + +#mainNav .nav-box { + float: left; + white-space: normal; } + +#mainNav h3 a { + color: #3371e3; + text-decoration: none; } + +ul.global-nav { + display: none; } + ul.global-nav li { + display: inline-block; + margin-right: 14px; } + ul.global-nav li a { + color: #fff; + font-weight: 400; + padding: 0; + position: relative; } + ul.global-nav li a.active:after { + position: absolute; + width: 100%; + height: 2px; + content: ''; + bottom: -4px; + left: 0; + background: #fff; } + ul.global-nav li a .ui-icon { + filter: brightness(0) invert(1); } + ul.global-nav li ul { + display: none; + position: fixed; + top: 40px; + text-align: left; } + ul.global-nav li ul li { + display: block; + height: 28px; } + ul.global-nav li ul li a { + background: #303030; + color: #fff; + padding: 7px; } + ul.global-nav li ul li:last-child a { + border-radius: 7px; } + ul.global-nav li:hover ul { + display: block; } + +.flip-nav ul.global-nav li a, +.open-nav ul.global-nav li a { + color: #303030; } + +.flip-nav ul.global-nav li a .ui-icon { + filter: brightness(0); } + +.flip-nav ul.global-nav li ul li a { + background: #fff; + color: #303030; } + +.flip-nav ul.global-nav li a.active:after, +.flip-nav ul.global-nav li ul li a.active:after, +.open-nav ul.global-nav li a.active:after { + background: #3371e3; } + +.flip-nav header { + background-color: white; } + +.open-nav body { + overflow: hidden; } + +.open-nav #cellophane { + display: block; + z-index: 9998; } + +.open-nav header { + background-color: #e8e8e8; + z-index: 9999; } + +.open-nav #hamburger div { + opacity: 0; } + +.open-nav #hamburger:before, .open-nav #hamburger:after { + left: 12px; + transform-origin: 0 1px; } + +.open-nav #hamburger:before { + transform: rotate(45deg); } + +.open-nav #hamburger:after { + transform: rotate(-45deg); } + +.open-nav #tryKubernetes, .y-enough #tryKubernetes { + width: 150px; + background-color: #3371e3; + border-color: #3371e3; } + +.flip-nav header, .open-nav header { + box-shadow: 0 1px 2px #4c4c4c; } + +.flip-nav #viewDocs, .open-nav #viewDocs { + border-color: #303030; + color: #303030; } + .flip-nav #viewDocs:hover, .open-nav #viewDocs:hover { + border-color: #3371e3; + background-color: #3371e3; + color: white; } + +.flip-nav #hamburger:hover div, .flip-nav #hamburger:hover:before, .flip-nav #hamburger:hover:after, .open-nav #hamburger:hover div, .open-nav #hamburger:hover:before, .open-nav #hamburger:hover:after { + background-color: #303030; } + +#hero { + background-image: url(/images/texture.png); + background-color: #303030; + text-align: center; + padding-left: 0; + padding-right: 0; + margin-bottom: 0; + position: relative; } + #hero.bot-bar:after { + display: block; + margin-bottom: -20px; + height: 8px; + width: 100%; + background-color: rgba(255, 255, 255, 0.1); + content: ''; } + #hero.no-sub h5 { + display: none; } + #hero.no-sub h1 { + margin-bottom: 20px; } + +#home #hero:after { + display: none; } + +#vendorStrip { + position: relative; + background-color: rgba(255, 255, 255, 0.1); + font-weight: 100; + white-space: nowrap; + text-align: center; } + #vendorStrip li a { + color: rgba(255, 255, 255, 0.5); } + #vendorStrip li a.YAH { + color: white; + position: relative; } + +footer { + width: 100%; + background-image: url(/images/texture.png); + background-color: #303030; } + footer main { + padding: 20px 0; } + footer nav a { + width: 100%; + text-align: center; + display: inline-block; + margin: 10px 0; + font-size: 24px; + font-weight: 300; + color: white; + text-decoration: none; } + footer .social { + margin: 20px 0; } + footer .social div { + text-align: center; + margin-bottom: 20px; } + footer .social div:last-child { + margin: 30px 0; } + footer .social span { + display: block; + margin-bottom: 8px; } + footer .social input { + text-align: center; } + +#search, #wishField { + background-color: transparent; + padding: 10px; + font-size: 16px; + font-weight: 100; + color: white; + border: 1px solid white; + transition: 0.3s; } + #search:focus, #wishField:focus { + background-color: #f7f7f7; + color: #303030; } + +.social a { + display: inline-block; + background-image: url(/images/social_sprite.png); + background-repeat: no-repeat; + background-size: auto; + width: 50px; + height: 50px; + border-radius: 5px; + margin-right: 10px; } + .social a:hover { + background-color: #fff; } + .social a span { + position: absolute; + display: block; + height: 0; + overflow: hidden; } + .social a.button { + background-image: none; + width: auto; + height: auto; } + .social a.button:hover { + color: #3371e3; } + +a.twitter { + background-position: 0 0; } + a.twitter:hover { + background-position: 0 100%; } + +a.stack-overflow { + background-position: -50px 0; } + a.stack-overflow:hover { + background-position: -50px 100%; } + +a.slack { + background-position: -100px 0; } + a.slack:hover { + background-position: -100px 100%; } + +a.github { + background-position: -150px 0; } + a.github:hover { + background-position: -150px 100%; } + +a.mailing-list { + background-position: -200px 0; } + a.mailing-list:hover { + background-position: -200px 100%; } + +a.calendar { + background-position: -250px 0; } + a.calendar:hover { + background-position: -250px 100%; } + +#viewDocs { + display: none; } + +section { + background-color: white; } + +#hero { + background-color: #303030; } + #hero h5 { + margin: 20px 0; + line-height: 28px; } + +#vendorStrip { + position: relative; } + #vendorStrip ul { + float: left; } + #vendorStrip li { + display: inline-block; + height: 100%; } + #vendorStrip a { + display: block; + height: 100%; + color: white; + font-size: 0.75em; + font-weight: bold; } + #vendorStrip li + li { + margin-left: 0; } + +#docs #vendorStrip { + line-height: 44px; + max-width: 100%; + overflow-x: scroll; } + #docs #vendorStrip ul { + float: none; } + #docs #vendorStrip #searchBox { + float: none; + display: block; + width: 80%; + margin: 0 auto; + height: 44px; + line-height: 44px; + position: relative; } + #docs #vendorStrip #searchBox:before { + position: absolute; + width: 15px; + height: 15px; + content: ''; + right: 8px; + top: 7px; + background-image: url(/images/search-icon.svg); + background-repeat: no-repeat; + background-size: 100% 100%; + z-index: 1; } + #docs #vendorStrip #search { + width: 100%; + padding: 0 10px; + height: 30px; + line-height: 30px; + font-size: 16px; + vertical-align: top; + background: #fff; + border: none; + border-radius: 4px; + position: relative; } + +#encyclopedia { + position: relative; + padding: 50px 20px 20px 20px; + overflow: hidden; + font-size: 14px; } + #encyclopedia > div { + height: 100%; } + +#docsToc { + position: fixed; + background-color: white; + top: 0; + left: 0; + width: 0; + height: 100vh; + overflow: hidden; + padding: 50px 0; + z-index: 999999; + transition: 0.3s; } + #docsToc .yah > .title { + background-color: #f7f7f7; + border-left: 3px solid #3371e3; + padding: 7.5px 10px 7.5px 18px; + margin-left: -3px; + color: #3371e3; } + +.open-toc body { + overflow: hidden; } + +.open-toc #docsToc { + padding: 50px 20px; + width: 400px; + max-width: 100vw; + overflow-y: auto; } + +.pi-accordion > .container:first-child > .item:first-child > .title:first-child { + padding-left: 0; + font-size: 1.5em; + font-weight: 700; } + +.pi-accordion > .container:first-child > .item.yah:first-child > .title:first-child { + margin-left: -20px !important; } + +.pi-accordion .item { + overflow: hidden; } + +.pi-accordion .title { + color: #303030; + position: relative; + padding: 7.5px 10px 7.5px 18px; + cursor: pointer; + transition: 0.3s; } + .pi-accordion .title:hover { + color: #3371e3; } + +.pi-accordion a.item > .title { + color: black; } + .pi-accordion a.item > .title:hover { + color: #3371e3; } + +.pi-accordion div.item > .title:before { + content: ""; + position: absolute; + top: 12px; + left: 2px; + border-style: solid; + border-width: 5px 0 5px 8px; + border-color: transparent transparent transparent #3371e3; + transform: rotate(0deg); + transition: 0.3s; } + +.pi-accordion .wrapper { + position: relative; + width: 100%; + transition: height 0.3s; } + +.pi-accordion .content { + padding-left: 20px; + opacity: 0; + transition: 0.3s; } + +.pi-accordion .item.on > .title:before { + transform: rotate(90deg); } + +.pi-accordion .item.on > .wrapper > .content { + opacity: 1; } + +dt { + margin-bottom: 8px; } + +dd { + margin-bottom: 16px; } + +.pi-pushmenu { + display: none; + position: fixed; + top: 0; + width: 100%; + height: 100%; + opacity: 0; + transition: opacity 0.3s; } + .pi-pushmenu.on { + opacity: 1; } + .pi-pushmenu .overlay { + position: fixed; + top: 0; + left: 0; + width: 100%; + height: 100%; + background-color: rgba(0, 0, 0, 0.4); } + .pi-pushmenu .sled { + position: absolute; + top: 0; + width: 0; + height: 100%; + background-color: white; + overflow: auto; + transition: 0.3s; } + .pi-pushmenu.on .sled { + width: 400px; + max-width: 100vw; } + .pi-pushmenu .top-bar { + height: 0; + line-height: 60px; + background-color: #444; } + .pi-pushmenu ul { + margin-top: 25px; } + .pi-pushmenu li { + position: relative; + display: block; + width: 100%; + min-height: 45px; + padding: 0 60px 0 20px; + border-bottom: 1px solid #cccccc; } + .pi-pushmenu a { + display: inline-block; + width: 100%; + height: 45px; + line-height: 45px; + font-family: "Roboto", sans-serif; + font-size: 20px; + color: #3371e3; } + .pi-pushmenu .button { + background: none; + padding: 0; } + .pi-pushmenu ul ul { + padding: 0 20px; } + .pi-pushmenu ul ul li { + min-height: 40px; } + .pi-pushmenu ul ul a { + height: 40px; + line-height: 40px; + font-size: 18px; + color: #555555; } + +.push-menu-close-button { + position: absolute; + top: 0; + right: 0; + width: 50px; + height: 50px; } + .push-menu-close-button:before, .push-menu-close-button:after { + content: ""; + position: absolute; + top: calc(50% - 1px); + left: 25%; + width: 50%; + height: 2px; + background-color: black; } + .push-menu-close-button:before { + transform: rotate(45deg); } + .push-menu-close-button:after { + transform: rotate(-45deg); } + +#docsContent { + position: relative; + float: right; + width: 100%; } + #docsContent * + h2, #docsContent * + h3, #docsContent * + h4, #docsContent * + h5, #docsContent * + h6 { + margin-top: 30px; } + #docsContent h1, #docsContent h2, #docsContent h3, #docsContent h4, #docsContent h5, #docsContent h6 { + line-height: normal; + font-weight: 500; + margin-bottom: 30px; + padding-bottom: 10px; } + #docsContent h1:before, #docsContent h2:before, #docsContent h3:before, #docsContent h4:before, #docsContent h5:before, #docsContent h6:before { + display: block; + content: " "; + margin-top: -100px; + height: 100px; + visibility: hidden; } + #docsContent h1, #docsContent h2 { + border-bottom: 1px solid #cccccc; } + #docsContent h1 { + font-size: 32px; + padding-right: 60px; } + #docsContent h2 { + font-size: 28px; } + #docsContent h3 { + font-size: 24px; + font-weight: 300; + margin-bottom: 5px; } + #docsContent h4 { + font-size: 20px; + margin-bottom: 0px; } + #docsContent h5, #docsContent h6 { + font-size: 16px; + font-weight: 500; } + #docsContent p { + font-size: 16px; + font-weight: 300; + line-height: 1.75em; } + #docsContent p + p { + margin-top: 10px; } + #docsContent code { + display: inline-block; + box-sizing: border-box; + background-color: #f7f7f7; + color: #303030; + font-family: "Roboto Mono", monospace; + vertical-align: baseline; + font-size: 14px; + font-weight: bold; + padding: 2px 4px; } + #docsContent a code { + color: #3371e3; + text-decoration: underline; } + #docsContent pre .pi, #docsContent pre .s { + margin: 0; + padding: 0; } + #docsContent .highlight code span, #docsContent code, #docsContent pre code { + font-family: "Roboto Mono", monospace; } + #docsContent code, #docsContent pre code { + color: #303030; } + #docsContent pre code { + padding: 0; } + #docsContent pre { + background-color: #f7f7f7; + display: block; + margin: 20px 0; + padding: 15px; + position: relative; + overflow-x: auto; } + #docsContent h1 code, #docsContent h2 code, #docsContent h3 code, #docsContent h4 code, #docsContent h5 code, #docsContent h6 code { + font-size: inherit; + background-color: transparent; } + #docsContent .includecode { + table-layout: fixed; } + #docsContent .includecode, #docsContent .includecode th, #docsContent .includecode td { + padding: 0 !important; } + #docsContent .includecode th { + text-align: right !important; + padding: 10px !important; } + #docsContent .includecode th a, #docsContent .includecode th a code { + color: white !important; + background-color: transparent !important; } + #docsContent .includecode pre { + margin: 0 !important; } + #docsContent ul li { + list-style: disc; } + #docsContent ol li { + list-style: decimal; } + #docsContent ul, #docsContent ol { + margin: 20px 0; + padding-left: 30px; + font-weight: 300; } + #docsContent ul ul, #docsContent ol ol, #docsContent ul ol, #docsContent ol ul { + margin: 0.75em 0; } + #docsContent li { + margin-bottom: 0.75em; + font-size: 16px; + line-height: 1.75em; } + #docsContent table { + width: 100%; + border: 1px solid #ccc; + border-spacing: 0; + margin-top: 30px; + margin-bottom: 30px; } + #docsContent thead, #docsContent tr:nth-child(even) { + background-color: #f7f7f7; } + #docsContent thead { + background-color: #555; + color: white; } + #docsContent th, #docsContent td { + padding: 8px; + text-align: left; + margin: 0; } + #docsContent th { + font-weight: normal; } + #docsContent td { + font-size: 0.85em; } + #docsContent #editPageButton { + position: absolute; + top: -25px; + right: 5px; + width: 50px; + height: 50px; + line-height: 50px; + border-radius: 50%; + white-space: nowrap; + text-indent: 50px; + overflow: hidden; + background: #3371e3 url(/images/icon-pencil.svg) no-repeat; + background-position: 12px 10px; + background-size: 29px 29px; } + #docsContent #markdown-toc, #docsContent #TableOfContents { + margin-bottom: 20px; } + #docsContent #markdown-toc ul, #docsContent #markdown-toc li, #docsContent #TableOfContents ul, #docsContent #TableOfContents li { + list-style: disc; + color: #3371e3; } + #docsContent #markdown-toc ul, #docsContent #TableOfContents ul { + padding: 0 15px; + margin: 0; } + #docsContent #markdown-toc li, #docsContent #TableOfContents li { + padding: 0; + line-height: 1.5em; + margin-bottom: 0; } + #docsContent #markdown-toc a, #docsContent #TableOfContents a { + position: relative; + color: #3371e3; + font-weight: 700; } + #docsContent img { + max-width: 100%; } + #docsContent #TableOfContents > ul > li { + list-style: none; } + #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; } + +html.search #docsContent { + position: relative; + float: none; + width: 90%; + max-width: 850px; + margin: 0 auto; } + html.search #docsContent #editPageButton { + display: none; } + html.search #docsContent table { + border: 0; + margin-bottom: 0; } + html.search #docsContent td { + padding: 0; } + html.search #docsContent h1 { + margin-bottom: 0; + border-bottom: 0; + padding-bottom: 0; + padding-left: 8px; } + +#home.flip-nav .logo, #home.open-nav .logo { + background-image: url(/images/nav_logo2.svg); } + +#home #hero { + margin-bottom: 0; + padding-bottom: 1px; } + #home #hero main { + padding: 0 10px; + margin-bottom: 30px; } + #home #hero #vendorStrip { + display: none; } + +#oceanNodes { + padding-top: 60px; + padding-bottom: 60px; } + #oceanNodes a { + color: #3371e3; } + #oceanNodes main { + margin-bottom: 60px; + min-height: 160px; } + #oceanNodes .image-wrapper { + max-width: 75%; + margin: 0 auto 20px; + text-align: center; } + #oceanNodes .image-wrapper img { + width: 100%; + max-width: 160px; } + #oceanNodes main:first-child .image-wrapper { + max-width: 100%; } + #oceanNodes main:first-child .image-wrapper img { + max-width: 491px; } + #oceanNodes h3 { + margin-bottom: 30px; } + +#video { + height: 200px; } + +#video { + width: 100%; + position: relative; + background-position: center center; + background-size: cover; } + #video > .light-text { + display: none; + position: absolute; + top: 50%; + left: 75%; + width: 525px; + padding-right: 80px; + transform: translate(-50%, -50%); + color: white; } + #video h2 { + font-size: 32px; + line-height: 44px; + margin-bottom: 20px; } + #video p { + margin-bottom: 20px; } + #video #desktopKCButton { + position: relative; + font-size: 18px; + background-color: #303030; + border-radius: 8px; + color: #ffffff; + padding: 20px 10px 20px 10px; } + #video #desktopShowVideoButton { + position: relative; + font-size: 24px; + background-color: white; + border-radius: 8px; + color: #3371e3; + padding: 15px 30px 15px 80px; + margin-bottom: 15px; } + #video #desktopShowVideoButton:before { + content: ""; + position: absolute; + position: absolute; + top: 50%; + left: 40px; + transform: translate(-50%, -50%); + width: 0; + height: 0; + border-style: solid; + border-width: 10px 0 10px 20px; + border-color: transparent transparent transparent #3371e3; } + #video #mobileShowVideoButton { + position: absolute; + top: 50%; + left: 50%; + transform: translate(-50%, -50%); + width: 80px; + height: 80px; + border-radius: 50%; + background-color: transparent; + border: 5px solid rgba(255, 255, 255, 0.2); + overflow: visible; } + #video #mobileShowVideoButton:after { + position: absolute; + top: 50%; + left: 50%; + transform: translate(-50%, -50%); + left: 40px; + content: ""; + width: 0; + height: 0; + border-style: solid; + border-width: 20px 0 20px 30px; + border-color: transparent transparent transparent #ffffff; } + +#videoPlayer { + position: fixed; + top: 0; + left: 0; + width: 100vw; + height: 100vh; + background-color: rgba(0, 0, 0, 0.9); + display: none; } + #videoPlayer iframe { + position: absolute; + top: 50%; + left: 50%; + transform: translate(-50%, -50%); + width: 80vw; + height: 45vw; + max-width: 142.22222222vh; + max-height: 80vh; } + #videoPlayer #closeButton { + position: absolute; + top: 20px; + right: 20px; + width: 50px; + height: 50px; + border: 2px solid transparent; + transition: 0.3s; } + #videoPlayer #closeButton:before, #videoPlayer #closeButton:after { + content: ""; + position: absolute; + top: calc(50% - 1px); + left: 10%; + width: 80%; + height: 2px; + background-color: white; } + #videoPlayer #closeButton:before { + transform: rotate(45deg); } + #videoPlayer #closeButton:after { + transform: rotate(-45deg); } + #videoPlayer #closeButton:hover { + border-color: white; } + +#cncf { + padding-top: 60px; + padding-bottom: 140px; + background-image: url(/images/cncf-color.png); + background-position: center 100px; + background-repeat: no-repeat; + background-size: 300px; } + +#kubeweekly { + background-color: #f7f7f7; + padding: 60px; + background-size: auto; + font-family: "Roboto Mono", monospace !important; + font-size: 24px; + font-weight: bold; } + #kubeweekly h5 { + font-size: 20px; } + +.subscribe-button { + border-radius: 6px; + padding: 0 20px; + line-height: 31px; + color: white; + background-color: #3371e3; + text-decoration: none; + font-size: 14px; } + +#features { + padding-top: 140px; + background-color: #f7f7f7; + background-image: url(/images/wheel.png); + background-position: center 60px; + background-repeat: no-repeat; + background-size: auto; } + +.feature-box { + width: 100%; + overflow: hidden; + clear: both; } + .feature-box h4 { + line-height: normal; + margin-bottom: 15px; } + .feature-box > div:first-child { + float: left; } + .feature-box > div:last-child { + float: right; } + +#features h3 { + margin-bottom: 20px; } + +#features .feature-box { + margin-bottom: 0; } + #features .feature-box > div { + width: 100%; + margin-bottom: 40px; } + +#community.open-nav .logo, #community.flip-nav .logo, .gridPage.open-nav .logo, .gridPage.flip-nav .logo { + background-image: url(/images/nav_logo2.svg); } + +#community #hero, .gridPage #hero { + padding-bottom: 20px; } + +#community #mainContent, .gridPage #mainContent { + padding: 20px 0; } + #community #mainContent main, .gridPage #mainContent main { + max-width: none; } + #community #mainContent a, .gridPage #mainContent a { + color: #3371e3; } + #community #mainContent .content, .gridPage #mainContent .content { + margin-bottom: 30px; + padding: 30px 0; } + #community #mainContent .content h1, #community #mainContent .content h2, #community #mainContent .content h3, #community #mainContent .content h4, #community #mainContent .content h5, #community #mainContent .content h6, #community #mainContent .content p, .gridPage #mainContent .content h1, .gridPage #mainContent .content h2, .gridPage #mainContent .content h3, .gridPage #mainContent .content h4, .gridPage #mainContent .content h5, .gridPage #mainContent .content h6, .gridPage #mainContent .content p { + line-height: normal; + max-width: 1200px; + padding: 0 20px; + margin: 0 auto 20px; } + #community #mainContent .content:nth-child(even), .gridPage #mainContent .content:nth-child(even) { + background-color: #f7f7f7; } + #community #mainContent .company-logos, .gridPage #mainContent .company-logos { + text-align: center; + max-width: 1200px; + margin: 0 auto; } + #community #mainContent .company-logos img, .gridPage #mainContent .company-logos img { + width: auto; + margin: 10px; + background-color: #f7f7f7; } + #community #mainContent .partner-logos, .gridPage #mainContent .partner-logos { + text-align: center; + max-width: 1200px; + margin: 0 auto; } + #community #mainContent .partner-logos img, .gridPage #mainContent .partner-logos img { + width: auto; + margin: 10px; + background-color: #ffffff; + box-shadow: 0 5px 5px rgba(0, 0, 0, 0.24), 0 0 5px rgba(0, 0, 0, 0.12); } + #community #mainContent #calendarMeetings, .gridPage #mainContent #calendarMeetings { + position: relative; + width: 80vw; + height: 60vw; + max-width: 1200px; + max-height: 900px; + margin: 20px auto; } + #community #mainContent #calendarEvents, .gridPage #mainContent #calendarEvents { + position: relative; + width: 80vw; + height: 30vw; + max-width: 1200px; + max-height: 450px; + margin: 20px auto; } + #community #mainContent iframe, .gridPage #mainContent iframe { + position: absolute; + border: 0; + width: 100%; + height: 100%; } + +.ui-icon { + display: inline-block !important; } + +#feature-state-dialog-link { + text-decoration: none !important; + padding: 5px !important; } + #feature-state-dialog-link a:visited { + color: #454545 !important; } + #feature-state-dialog-link a code { + display: inline-block !important; + box-sizing: border-box !important; + background-color: #f7f7f7 !important; + color: #303030 !important; + font-family: "Roboto Mono", monospace !important; + vertical-align: baseline !important; + font-size: 14px !important; + font-weight: bold !important; + padding: 0px 4px !important; } + +#feature-state-dialog { + background: #fff !important; + border: 1px solid #ddd !important; + padding: 0.5em 1em !important; } + #feature-state-dialog ul, #feature-state-dialog li { + list-style: disc !important; + margin: 4px 12px !important; } + #feature-state-dialog p { + margin: 8px 0px !important; } + #feature-state-dialog code { + display: inline-block !important; + box-sizing: border-box !important; + background-color: #f7f7f7 !important; + color: #303030 !important; + font-family: "Roboto Mono", monospace !important; + vertical-align: baseline !important; + font-size: 14px !important; + font-weight: bold !important; + padding: 0px 4px !important; } + +.ui-dialog { + background: #f7f7f7 !important; + padding: 0.5em; } + +.ui-dialog-content { + position: relative; + float: right; + width: 100%; } + .ui-dialog-content * + h2, .ui-dialog-content * + h3, .ui-dialog-content * + h4, .ui-dialog-content * + h5, .ui-dialog-content * + h6 { + margin-top: 30px; } + .ui-dialog-content h1, .ui-dialog-content h2, .ui-dialog-content h3, .ui-dialog-content h4, .ui-dialog-content h5, .ui-dialog-content h6 { + line-height: normal; + font-weight: 500; + margin-bottom: 30px; + padding-bottom: 10px; } + .ui-dialog-content h1:before, .ui-dialog-content h2:before, .ui-dialog-content h3:before, .ui-dialog-content h4:before, .ui-dialog-content h5:before, .ui-dialog-content h6:before { + display: block; + content: " "; + margin-top: -100px; + height: 100px; + visibility: hidden; } + .ui-dialog-content h1, .ui-dialog-content h2 { + border-bottom: 1px solid #cccccc; } + .ui-dialog-content h1 { + font-size: 32px; + padding-right: 60px; } + .ui-dialog-content h2 { + font-size: 28px; } + .ui-dialog-content h3 { + font-size: 24px; + font-weight: 300; + margin-bottom: 5px; } + .ui-dialog-content h4 { + font-size: 20px; + margin-bottom: 0px; } + .ui-dialog-content h5, .ui-dialog-content h6 { + font-size: 16px; + font-weight: 500; } + .ui-dialog-content p { + font-size: 16px; + font-weight: 300; + line-height: 1.75em; } + .ui-dialog-content p + p { + margin-top: 10px; } + .ui-dialog-content code { + display: inline-block; + box-sizing: border-box; + background-color: #f7f7f7; + color: #303030; + font-family: "Roboto Mono", monospace; + vertical-align: baseline; + font-size: 14px; + font-weight: bold; + padding: 2px 4px; } + .ui-dialog-content a code { + color: #3371e3; + text-decoration: underline; } + .ui-dialog-content pre .pi, .ui-dialog-content pre .s { + margin: 0; + padding: 0; } + .ui-dialog-content .highlight code span, .ui-dialog-content code, .ui-dialog-content pre code { + font-family: "Roboto Mono", monospace; } + .ui-dialog-content code, .ui-dialog-content pre code { + color: #303030; } + .ui-dialog-content pre code { + padding: 0; } + .ui-dialog-content pre { + background-color: #f7f7f7; + display: block; + margin: 20px 0; + padding: 15px; + position: relative; + overflow-x: auto; } + .ui-dialog-content h1 code, .ui-dialog-content h2 code, .ui-dialog-content h3 code, .ui-dialog-content h4 code, .ui-dialog-content h5 code, .ui-dialog-content h6 code { + font-family: inherit; + font-size: inherit; + background-color: transparent; } + .ui-dialog-content .includecode { + table-layout: fixed; } + .ui-dialog-content .includecode, .ui-dialog-content .includecode th, .ui-dialog-content .includecode td { + padding: 0 !important; } + .ui-dialog-content .includecode th { + text-align: right !important; + padding: 10px !important; } + .ui-dialog-content .includecode th a, .ui-dialog-content .includecode th a code { + color: white !important; + background-color: transparent !important; } + .ui-dialog-content .includecode pre { + margin: 0 !important; } + .ui-dialog-content ul li { + list-style: disc; } + .ui-dialog-content ol li { + list-style: decimal; } + .ui-dialog-content ul, .ui-dialog-content ol { + margin: 20px 0; + padding-left: 30px; + font-weight: 300; } + .ui-dialog-content ul ul, .ui-dialog-content ol ol, .ui-dialog-content ul ol, .ui-dialog-content ol ul { + margin: 0.75em 0; } + .ui-dialog-content li { + margin-bottom: 0.75em; + font-size: 16px; + line-height: 1.75em; } + .ui-dialog-content table { + width: 100%; + border: 1px solid #ccc; + border-spacing: 0; + margin-top: 30px; + margin-bottom: 30px; } + .ui-dialog-content thead, .ui-dialog-content tr:nth-child(even) { + background-color: #f7f7f7; } + .ui-dialog-content thead { + background-color: #555; + color: white; } + .ui-dialog-content th, .ui-dialog-content td { + padding: 8px; + text-align: left; + margin: 0; } + .ui-dialog-content th { + font-weight: normal; } + .ui-dialog-content td { + font-size: 0.85em; } + .ui-dialog-content #editPageButton { + position: absolute; + top: -25px; + right: 5px; + width: 50px; + height: 50px; + line-height: 50px; + border-radius: 50%; + white-space: nowrap; + text-indent: 50px; + overflow: hidden; + background: #3371e3 url(/images/icon-pencil.svg) no-repeat; + background-position: 12px 10px; + background-size: 29px 29px; } + .ui-dialog-content #markdown-toc { + margin-bottom: 20px; } + .ui-dialog-content #markdown-toc ul, .ui-dialog-content #markdown-toc li { + list-style: disc; + color: #3371e3; } + .ui-dialog-content #markdown-toc ul { + padding: 0 15px; + margin: 0; } + .ui-dialog-content #markdown-toc li { + padding: 0; + line-height: 1.5em; + margin-bottom: 0; } + .ui-dialog-content #markdown-toc a { + position: relative; + color: #3371e3; + font-weight: 700; } + .ui-dialog-content img { + max-width: 100%; } + .ui-dialog-content a { + text-decoration: underline; } + +.ui-dialog-buttonpane { + background: #f7f7f7 !important; } + +.ui-widget-header { + background: transparent !important; + background-color: transparent !important; + border: 0px !important; } + +.ui-tabs ul, .ui-tabs ol, .ui-tabs li { + padding: 0px !important; + list-style: none !important; + margin-bottom: 0px !important; + margin-left: 4px !important; } + +.ui-tabs-panel ul li { + list-style: disc !important; } + +.ui-tabs-panel ol li { + list-style: decimal !important; } + +.ui-widget-content { + border: 0px !important; } + .ui-widget-content table { + margin: 0px !important; } + +.ui-tabs .ui-tabs-panel { + border: 1px solid #ccc !important; } + +.ui-tabs-anchor { + text-decoration: none !important; } + +#talkToUs h3, #talkToUs h4 { + text-align: center; } + +#talkToUs h3 { + margin-bottom: 15px; } + +#talkToUs h4 { + line-height: normal; + margin-bottom: 50px; } + #talkToUs h4 br { + display: none; } + +#talkToUs #bigSocial { + overflow: hidden; } + #talkToUs #bigSocial div { + width: 100%; + float: left; + padding: 30px; + padding-top: 110px; + background-position: center top; + background-size: auto; + background-repeat: no-repeat; } + #talkToUs #bigSocial div:nth-child(1) { + background-image: url(/images/twitter_icon.png); } + #talkToUs #bigSocial div:nth-child(2) { + background-image: url(/images/github_icon.png); } + #talkToUs #bigSocial div:nth-child(3) { + background-image: url(/images/slack_icon.png); } + #talkToUs #bigSocial div:nth-child(4) { + background-image: url(/images/stackoverflow_icon.png); } + #talkToUs #bigSocial div + div { + margin-top: 20px; + margin-left: 0; } + #talkToUs #bigSocial a { + display: inline-block; + color: #3371e3; + font-size: 24px; + font-weight: 400; + text-decoration: none; + margin-bottom: 15px; } + #talkToUs #bigSocial a, #talkToUs #bigSocial p { + text-align: center; + width: 100%; } + +#home #talkToUs main { + padding: 30px 0; } + +#home #talkToUs h5 { + font-size: 20px; } + +#home #caseStudiesWrapper { + position: relative; + text-align: center; + margin-bottom: 30px; } + #home #caseStudiesWrapper img { + padding-bottom: 1rem; } + #home #caseStudiesWrapper div { + position: relative; + display: inline-block; + vertical-align: top; + width: 100%; + min-height: 230px; + margin-bottom: 60px; + padding-right: 1rem; + background-position: top center; } + #home #caseStudiesWrapper p { + font-size: 20px; } + #home #caseStudiesWrapper a { + position: absolute; + bottom: -30px; + left: 50%; + transform: translateX(-50%); + color: #3371e3; + font-weight: 400; } + +/* Google Search */ +.cse .gsc-control-cse, .gsc-control-cse { + padding: 0; } + +.gsc-control-cse table, .gsc-control-cse-en table { + margin: 0px !important; } + +.gsc-above-wrapper-area { + border-bottom: 0; } + +/* Bing Search */ +#bing-results-container { + margin-top: 30px; + margin-left: 20px; } + +.bing-result { + margin-bottom: 20px; } + +.bing-result-name a { + font-size: 16px; + color: #0000CC; } + +.bing-result-url { + color: #008000; + font-size: 13px; } + +.bing-result-snippet { + color: #000; + font-size: 11px; } + +#bing-pagination-container { + margin: 10px; + margin-left: 20px; } + +.bing-page-anchor { + text-decoration: none !important; + cursor: pointer; + color: #0000CC; + margin-right: 8px; } + +@media screen and (min-width: 750px) { + h1 { + font-size: 32px; + line-height: 40px; } + h2 { + font-size: 28px; + line-height: 60px; } + h3 { + font-size: 24px; + line-height: 32px; } + h4 { + font-size: 20px; + line-height: 40px; } + h5 { + font-size: 16px; + line-height: 36px; } + p { + font-size: 14px; + line-height: 22px; } + section, header, #vendorStrip { + padding-left: 20px; + padding-right: 20px; } + section main, header main, #vendorStrip main { + width: 100%; + max-width: 100%; } + header { + height: 80px; } + .nav-buttons { + height: 80px; + line-height: 80px; } + .nav-buttons .button + * { + margin-left: 30px; } + #hamburger { + width: 50px; + height: 50px; } + #mainNav { + padding: 140px 0 30px; } + #mainNav h5 { + margin-bottom: 1em; } + #mainNav h3 { + margin-bottom: 0.6em; } + #mainNav .nav-box { + width: 20%; } + #mainNav .nav-box + .nav-box { + margin-left: calc(20% / 3); } + #mainNav main + main { + margin-top: 60px; } + #mainNav .left .button { + height: 50px; + line-height: 50px; + font-size: 18px; } + .open-nav #tryKubernetes, .y-enough #tryKubernetes { + margin-left: 30px; } + #hero { + padding-top: 80px; } + #docs #hero h1, #docs #hero h5 { + padding-left: 20px; + padding-right: 20px; } + #vendorStrip { + height: 88px; + line-height: 88px; + font-size: 16px; } + p { + font-size: 16px; + line-height: 24px; + letter-spacing: 0.1px; } + h1 { + font-size: 36px; + line-height: 44px; } + h3 { + font-size: 28px; + line-height: 36px; } + h4 { + font-size: 24px; + line-height: 40px; } + #home #viewDocs, #home #tryKubernetes { + display: inline-block; } + #vendorStrip { + display: block; + text-align: center; } + #vendorStrip img { + max-height: 24px; + vertical-align: middle; + margin: 0 30px; } + #docs #vendorStrip li a { + font-size: 1em; + font-weight: normal; } + #docs #vendorStrip li li + li { + margin-left: 60px; } + #oceanNodes h3 { + text-align: left; + margin-bottom: 18px; } + #oceanNodes main { + position: relative; + clear: both; + display: table; + height: 160px; } + #oceanNodes main .content { + display: table-cell; + position: relative; + vertical-align: middle; } + #oceanNodes main .image-wrapper { + position: absolute; + top: 50%; + max-width: 25%; + max-height: 100%; + transform: translateY(-50%); } + #oceanNodes main:nth-child(odd) { + padding-right: 210px; } + #oceanNodes main:nth-child(odd) .image-wrapper { + right: 0; } + #oceanNodes main:nth-child(even) { + padding-left: 210px; } + #oceanNodes main:nth-child(even) .image-wrapper { + left: 0; } + #oceanNodes main:nth-child(1) { + padding-right: 0; } + #oceanNodes main:nth-child(1) h3, #oceanNodes main:nth-child(1) p { + text-align: center; } + #oceanNodes main:nth-child(1) .image-wrapper { + position: relative; + display: block; + float: none; + max-width: 100%; + transform: none; } + #oceanNodes main:nth-child(1) .content { + display: block; } + #oceanNodes main img { + width: 100%; } + #video { + height: 400px; + display: block; } + #video > .light-text { + display: block; } + #mobileShowVideoButton { + display: none; } + #features { + padding-bottom: 60px; } + #features .feature-box { + margin-bottom: 30px; } + #features .feature-box:last-child { + margin-bottom: 0; } + #features h3 { + margin-bottom: 40px; } + #features .feature-box > div { + width: 45%; + margin-bottom: 0; } + #talkToUs #bigSocial div { + width: calc(50% - 15px); } + #talkToUs #bigSocial div + div { + margin-top: 0; } + #talkToUs #bigSocial div:nth-child(2) { + margin-left: 20px; } + #talkToUs #bigSocial div:nth-child(3) { + margin-top: 20px; } + #talkToUs #bigSocial div:nth-child(4) { + margin-top: 20px; + margin-left: 20px; } + #talkToUs #bigSocial a { + display: inline-block; + color: #3371e3; + font-weight: 400; + text-decoration: none; } + footer nav { + text-align: center; } + footer nav a { + width: 30%; + padding: 0 20px; } + footer .social { + text-align: center; } + footer .social div { + display: inline-block; } + footer .social div:last-child { + display: block; + margin: 0; } + footer .social span { + display: inline-block; + margin-right: 10px; } + footer .social input { + text-align: left; } + #home #caseStudiesWrapper div { + width: 48%; } } + +@media screen and (min-width: 1025px) { + #hamburger { + display: none; } + ul.global-nav { + display: inline-block; } + #docs #vendorStrip #searchBox:before { + top: 15px; } + #vendorStrip { + height: 44px; + line-height: 44px; } + #vendorStrip li a.YAH:after { + content: ""; + display: block; + position: absolute; + left: 0; + bottom: 0; + width: 100%; + height: 4px; + background-color: #3371e3; } + #vendorStrip #searchBox { + float: right; } + #home #hero #vendorStrip { + display: block; } + #docs #hero h1, #docs #hero h5 { + text-align: left; } + #docs #hero #vendorStrip ul { + float: left; } + #docs #hero #vendorStrip #searchBox { + float: right; + width: 250px; } + #docs #hero #vendorStrip #search { + vertical-align: middle; } + #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); } + #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; } + #docsContent { + width: calc(100% - 400px); } + #docsContent #editPageButton { + right: -25px; } + section main, header main, footer main { + max-width: 1200px; } + header, #vendorStrip, #encyclopedia, #hero h1, #hero h5, #docs #hero h1, #docs #hero h5, + #community #hero h1, .gridPage #hero h1, #community #hero h5, .gridPage #hero h5 { + padding-left: 100px; + padding-right: 100px; } + #vendorStrip { + padding-right: 10px; } + #home section main, #home header main, #home footer main { + max-width: 1000px; } + #oceanNodes main { + position: relative; + max-width: 830px; } + #oceanNodes main:nth-child(1) { + max-width: 1000px; + padding-right: 475px; } + #oceanNodes main:nth-child(1) h3, #oceanNodes main:nth-child(1) p { + text-align: left; } + #oceanNodes main:nth-child(1) .image-wrapper { + position: absolute; + max-width: 48%; + transform: translateY(-50%); } + #oceanNodes main:nth-child(1) .image-wrapper img { + max-width: 425px; } + #video { + height: 550px; + position: relative; + background-position: center center; + background-size: cover; } + #talkToUs h4 br { + display: block; } + #talkToUs #bigSocial div { + width: calc(25% - 18px); } + #talkToUs #bigSocial div + div { + margin-left: 20px; } + footer { + width: 100%; + background-image: url(../images/texture.png); + background-color: #303030; } + footer main { + padding: 20px 0; } + footer nav { + overflow: hidden; + margin-bottom: 20px; } + footer nav a { + width: 16.65%; + float: left; + font-size: 24px; + font-weight: 300; + white-space: nowrap; } + footer .social { + padding: 0 30px; + max-width: 1200px; } + footer .social div { + float: left; } + footer .social div:last-child { + float: right; } + #search, #wishField { + background-color: transparent; + padding: 10px; + font-size: 16px; + font-weight: 100; + color: white; + border: 1px solid white; + transition: 0.3s; } + #search:focus, #wishField:focus { + background-color: #f7f7f7; + color: #303030; } + .social a { + display: inline-block; + background-image: url(../images/social_sprite.png); + background-repeat: no-repeat; + background-size: auto; + width: 50px; + height: 50px; + border-radius: 5px; + margin-right: 10px; } + .social a:hover { + background-color: #fff; } + .social a span { + position: absolute; + display: block; + height: 0; + overflow: hidden; } + a.twitter { + background-position: 0 0; } + a.twitter:hover { + background-position: 0 100%; } + a.stack-overflow { + background-position: -50px 0; } + a.stack-overflow:hover { + background-position: -50px 100%; } + a.slack { + background-position: -100px 0; } + a.slack:hover { + background-position: -100px 100%; } + a.github { + background-position: -150px 0; } + a.github:hover { + background-position: -150px 100%; } + a.mailing-list { + background-position: -200px 0; } + a.mailing-list:hover { + background-position: -200px 100%; } + a.calendar { + background-position: -250px 0; } + a.calendar:hover { + background-position: -250px 100%; } + #community #hero, .gridPage #hero { + text-align: left; } + #community #hero h1, .gridPage #hero h1 { + padding: 20px 100px; } + #community #tryKubernetes, .gridPage #tryKubernetes { + width: auto; + background-color: #3371e3; + padding: 0 20px; } + #bigSocial div { + width: calc(25% - 18px); } + #home #caseStudiesWrapper div { + width: 24%; + min-height: 260px; } } + +@media screen and (min-width: 1300px) { + #vendorStrip { + padding-right: 100px; } } + +@media screen and (min-width: 456px) { + #vendorStrip li + li { + margin-left: 20px; } } diff --git a/resources/_gen/assets/sass/sass/styles.sass_a6e533854c4de092afe9278041939937.json b/resources/_gen/assets/sass/sass/styles.sass_a6e533854c4de092afe9278041939937.json new file mode 100644 index 0000000000..081a4beb86 --- /dev/null +++ b/resources/_gen/assets/sass/sass/styles.sass_a6e533854c4de092afe9278041939937.json @@ -0,0 +1 @@ +{"Target":"css/styles.css","MediaType":"text/css","Data":{}} \ No newline at end of file diff --git a/resources/_gen/assets/sass/sass/styles.sass_cb957da2191fde4902dd41b139c8069d.content b/resources/_gen/assets/sass/sass/styles.sass_cb957da2191fde4902dd41b139c8069d.content deleted file mode 100644 index a27a534a31..0000000000 --- a/resources/_gen/assets/sass/sass/styles.sass_cb957da2191fde4902dd41b139c8069d.content +++ /dev/null @@ -1 +0,0 @@ -html,body{margin:0;padding:0}input,button{outline:0}button{cursor:pointer}ul,li{list-style:none}ul{margin:0;padding:0}a{text-decoration:none}.clear{display:block;clear:both}.light-text{color:#fff}.right{float:right}.left{float:left}.center{text-align:center}*,.button{box-sizing:border-box;font-family:roboto,sans-serif;background:0 0;margin:0;border:0}body{font-family:roboto,sans-serif}h1,h2,h5,p{font-weight:300}h3,h4{font-weight:400}html,body{margin:0;padding:0}input,button{outline:0}button{cursor:pointer}ul,li{list-style:none}ul{margin:0;padding:0}a{text-decoration:none}.clear{display:block;clear:both}.light-text{color:#fff}.right{float:right}.left{float:left}.center{text-align:center}h1{font-size:32px;line-height:40px}h2{font-size:28px;line-height:60px}h3{font-size:24px;line-height:32px}h4{font-size:20px;line-height:40px}h5{font-size:16px;line-height:36px}p{font-size:14px;line-height:22px}section,header,#vendorStrip{padding-left:20px;padding-right:20px}section main,header main,#vendorStrip main{width:100%;max-width:100%}header{height:80px}.nav-buttons{height:80px;line-height:80px}.nav-buttons .button+*{margin-left:30px}#hamburger{width:50px;height:50px}#mainNav{padding:140px 0 30px}#mainNav h5{margin-bottom:1em}#mainNav h3{margin-bottom:.6em}#mainNav .nav-box{width:20%}#mainNav .nav-box+.nav-box{margin-left:calc(20%/3)}#mainNav main+main{margin-top:60px}#mainNav .left .button{height:50px;line-height:50px;font-size:18px}.open-nav #tryKubernetes,.y-enough #tryKubernetes{margin-left:30px}#hero{padding-top:80px}#docs #hero h1,#docs #hero h5{padding-left:20px;padding-right:20px}#vendorStrip{height:88px;line-height:88px;font-size:16px}body{background-color:#fff}section{position:relative;background-color:#fff}section main,header main,footer main{position:relative;margin:auto}p{font-size:14px;font-weight:400}.button{display:inline-block;border-radius:6px;padding:0 20px;line-height:40px;color:#fff;background-color:#3371e3;text-decoration:none}#cellophane{position:fixed;top:0;left:0;width:100%;height:100%;display:none}header{position:fixed;top:0;left:0;width:100%;z-index:8888;background-color:transparent;box-shadow:0 0 0 transparent;overflow:hidden;transition:.3s;text-align:center}.logo{position:relative;float:left;display:block;width:180px;height:88px;top:0;left:0;transform:none;background-image:url(/images/nav_logo.svg);background-size:contain;background-position:center center;background-repeat:no-repeat}#docs .flyout-button{position:fixed;top:20px;left:20px;width:50px;height:50px;background-image:url(/images/toc_icon.png);background-position:center center;background-repeat:no-repeat;background-size:auto;border-radius:50%;transition:.3s;z-index:99999}#docs.open-nav .flyout-button{display:none}#docs .logo{position:absolute;top:40px;left:50%;transform:translate(-50%,-50%);display:block;width:45px;height:44px;background-image:url(/images/favicon.png)}#docs.flip-nav .flyout-button{background-image:url(/images/toc_icon_grey.png)}.nav-buttons{float:right}#viewDocs,#tryKubernetes{display:none}#viewDocs{border:2px solid #fff;background-color:transparent;transition:.3s}#viewDocs:hover{background-color:#fff;color:#303030}#tryKubernetes{width:0;padding:0;border:1px solid transparent;background-color:transparent;text-align:center;white-space:nowrap;vertical-align:middle;overflow:hidden;transition:.3s}#hamburger{display:inline-block;position:relative;vertical-align:middle;padding:0;border:0;background:0 0}#hamburger div,#hamburger:before,#hamburger:after{position:absolute;left:15%;width:70%;height:2px;background-color:#3371e3;transition:.3s;content:""}#hamburger div{top:calc(50% - 1px)}#hamburger:before{top:24%}#hamburger:after{bottom:24%}#hamburger:hover div,#hamburger:hover:before,#hamburger:hover:after{background-color:#fff}#mainNav h5{color:#3371e3;font-weight:400}#mainNav main{white-space:nowrap;overflow:hidden;clear:both}#mainNav .nav-box{float:left;white-space:normal}#mainNav h3 a{color:#3371e3;text-decoration:none}ul.global-nav{display:none}ul.global-nav li{display:inline-block;margin-right:14px}ul.global-nav li a{color:#fff;font-weight:400;padding:0;position:relative}ul.global-nav li a.active:after{position:absolute;width:100%;height:2px;content:'';bottom:-4px;left:0;background:#fff}ul.global-nav li a .ui-icon{filter:brightness(0) invert(1)}ul.global-nav li ul{display:none;position:fixed;top:40px;text-align:left}ul.global-nav li ul li{display:block;height:28px}ul.global-nav li ul li a{background:#303030;color:#fff;padding:7px}ul.global-nav li ul li:last-child a{border-radius:7px}ul.global-nav li:hover ul{display:block}.flip-nav ul.global-nav li a,.open-nav ul.global-nav li a{color:#303030}.flip-nav ul.global-nav li a .ui-icon{filter:brightness(0)}.flip-nav ul.global-nav li ul li a{background:#fff;color:#303030}.flip-nav ul.global-nav li a.active:after,.flip-nav ul.global-nav li ul li a.active:after,.open-nav ul.global-nav li a.active:after{background:#3371e3}.flip-nav header{background-color:#fff}.open-nav body{overflow:hidden}.open-nav #cellophane{display:block;z-index:9998}.open-nav header{background-color:#e8e8e8;z-index:9999}.open-nav #hamburger div{opacity:0}.open-nav #hamburger:before,.open-nav #hamburger:after{left:12px;transform-origin:0 1px}.open-nav #hamburger:before{transform:rotate(45deg)}.open-nav #hamburger:after{transform:rotate(-45deg)}.open-nav #tryKubernetes,.y-enough #tryKubernetes{width:150px;background-color:#3371e3;border-color:#3371e3}.flip-nav header,.open-nav header{box-shadow:0 1px 2px #4c4c4c}.flip-nav #viewDocs,.open-nav #viewDocs{border-color:#303030;color:#303030}.flip-nav #viewDocs:hover,.open-nav #viewDocs:hover{border-color:#3371e3;background-color:#3371e3;color:#fff}.flip-nav #hamburger:hover div,.flip-nav #hamburger:hover:before,.flip-nav #hamburger:hover:after,.open-nav #hamburger:hover div,.open-nav #hamburger:hover:before,.open-nav #hamburger:hover:after{background-color:#303030}#hero{background-image:url(/images/texture.png);background-color:#303030;text-align:center;padding-left:0;padding-right:0;margin-bottom:0;position:relative}#hero.bot-bar:after{display:block;margin-bottom:-20px;height:8px;width:100%;background-color:rgba(255,255,255,.1);content:''}#hero.no-sub h5{display:none}#hero.no-sub h1{margin-bottom:20px}#home #hero:after{display:none}#vendorStrip{position:relative;background-color:rgba(255,255,255,.1);font-weight:100;white-space:nowrap;text-align:center}#vendorStrip li a{color:rgba(255,255,255,.5)}#vendorStrip li a.YAH{color:#fff;position:relative}footer{width:100%;background-image:url(/images/texture.png);background-color:#303030}footer main{padding:20px 0}footer nav a{width:100%;text-align:center;display:inline-block;margin:10px 0;font-size:24px;font-weight:300;color:#fff;text-decoration:none}footer .social{margin:20px 0}footer .social div{text-align:center;margin-bottom:20px}footer .social div:last-child{margin:30px 0}footer .social span{display:block;margin-bottom:8px}footer .social input{text-align:center}#search,#wishField{background-color:transparent;padding:10px;font-size:16px;font-weight:100;color:#fff;border:1px solid #fff;transition:.3s}#search:focus,#wishField:focus{background-color:#f7f7f7;color:#303030}.social a{display:inline-block;background-image:url(/images/social_sprite.png);background-repeat:no-repeat;background-size:auto;width:50px;height:50px;border-radius:5px;margin-right:10px}.social a:hover{background-color:#fff}.social a span{position:absolute;display:block;height:0;overflow:hidden}.social a.button{background-image:none;width:auto;height:auto}.social a.button:hover{color:#3371e3}a.twitter{background-position:0 0}a.twitter:hover{background-position:0 100%}a.stack-overflow{background-position:-50px 0}a.stack-overflow:hover{background-position:-50px 100%}a.slack{background-position:-100px 0}a.slack:hover{background-position:-100px 100%}a.github{background-position:-150px 0}a.github:hover{background-position:-150px 100%}a.mailing-list{background-position:-200px 0}a.mailing-list:hover{background-position:-200px 100%}a.calendar{background-position:-250px 0}a.calendar:hover{background-position:-250px 100%}#viewDocs{display:none}section{background-color:#fff}#hero{background-color:#303030}#hero h5{margin:20px 0;line-height:28px}#vendorStrip{position:relative}#vendorStrip ul{float:left}#vendorStrip li{display:inline-block;height:100%}#vendorStrip a{display:block;height:100%;color:#fff;font-size:.75em;font-weight:700}#vendorStrip li+li{margin-left:0}#docs #vendorStrip{line-height:44px}#docs #vendorStrip ul{float:none}#docs #vendorStrip #searchBox{float:none;display:block;width:80%;margin:0 auto;height:44px;line-height:44px;position:relative}#docs #vendorStrip #searchBox:before{position:absolute;width:15px;height:15px;content:'';right:8px;top:7px;background-image:url(/images/search-icon.svg);background-repeat:no-repeat;background-size:100% 100%;z-index:1}#docs #vendorStrip #search{width:100%;padding:0 10px;height:30px;line-height:30px;font-size:16px;vertical-align:top;background:#fff;border:0;border-radius:4px;position:relative}#encyclopedia{position:relative;padding:50px 20px 20px;overflow:hidden;font-size:14px}#encyclopedia>div{height:100%}#docsToc{position:fixed;background-color:#fff;top:0;left:0;width:0;height:100vh;overflow:hidden;padding:50px 0;z-index:999999;transition:.3s}#docsToc .yah>.title{background-color:#f7f7f7;border-left:3px solid #3371e3;padding:7.5px 10px 7.5px 18px;margin-left:-3px;color:#3371e3}.open-toc body{overflow:hidden}.open-toc #docsToc{padding:50px 20px;width:400px;max-width:100vw;overflow-y:auto}.pi-accordion>.container:first-child>.item:first-child>.title:first-child{padding-left:0;font-size:1.5em;font-weight:700}.pi-accordion>.container:first-child>.item.yah:first-child>.title:first-child{margin-left:-20px!important}.pi-accordion .item{overflow:hidden}.pi-accordion .title{color:#303030;position:relative;padding:7.5px 10px 7.5px 18px;cursor:pointer;transition:.3s}.pi-accordion .title:hover{color:#3371e3}.pi-accordion a.item>.title{color:#000}.pi-accordion a.item>.title:hover{color:#3371e3}.pi-accordion div.item>.title:before{content:"";position:absolute;top:12px;left:2px;border-style:solid;border-width:5px 0 5px 8px;border-color:transparent transparent transparent #3371e3;transform:rotate(0deg);transition:.3s}.pi-accordion .wrapper{position:relative;width:100%;transition:height .3s}.pi-accordion .content{padding-left:20px;opacity:0;transition:.3s}.pi-accordion .item.on>.title:before{transform:rotate(90deg)}.pi-accordion .item.on>.wrapper>.content{opacity:1}dt{margin-bottom:8px}dd{margin-bottom:16px}.pi-pushmenu{display:none;position:fixed;top:0;width:100%;height:100%;opacity:0;transition:opacity .3s}.pi-pushmenu.on{opacity:1}.pi-pushmenu .overlay{position:fixed;top:0;left:0;width:100%;height:100%;background-color:rgba(0,0,0,.4)}.pi-pushmenu .sled{position:absolute;top:0;width:0;height:100%;background-color:#fff;overflow:auto;transition:.3s}.pi-pushmenu.on .sled{width:400px;max-width:100vw}.pi-pushmenu .top-bar{height:0;line-height:60px;background-color:#444}.pi-pushmenu ul{margin-top:25px}.pi-pushmenu li{position:relative;display:block;width:100%;min-height:45px;padding:0 60px 0 20px;border-bottom:1px solid #ccc}.pi-pushmenu a{display:inline-block;width:100%;height:45px;line-height:45px;font-family:roboto,sans-serif;font-size:20px;color:#3371e3}.pi-pushmenu .button{background:0 0;padding:0}.pi-pushmenu ul ul{padding:0 20px}.pi-pushmenu ul ul li{min-height:40px}.pi-pushmenu ul ul a{height:40px;line-height:40px;font-size:18px;color:#555}.push-menu-close-button{position:absolute;top:0;right:0;width:50px;height:50px}.push-menu-close-button:before,.push-menu-close-button:after{content:"";position:absolute;top:calc(50% - 1px);left:25%;width:50%;height:2px;background-color:#000}.push-menu-close-button:before{transform:rotate(45deg)}.push-menu-close-button:after{transform:rotate(-45deg)}#docsContent{position:relative;float:right;width:100%}#docsContent *+h2,#docsContent *+h3,#docsContent *+h4,#docsContent *+h5,#docsContent *+h6{margin-top:30px}#docsContent h1,#docsContent h2,#docsContent h3,#docsContent h4,#docsContent h5,#docsContent h6{line-height:normal;font-weight:500;margin-bottom:30px;padding-bottom:10px}#docsContent h1:before,#docsContent h2:before,#docsContent h3:before,#docsContent h4:before,#docsContent h5:before,#docsContent h6:before{display:block;content:" ";margin-top:-100px;height:100px;visibility:hidden}#docsContent h1,#docsContent h2{border-bottom:1px solid #ccc}#docsContent h1{font-size:32px;padding-right:60px}#docsContent h2{font-size:28px}#docsContent h3{font-size:24px;font-weight:300;margin-bottom:5px}#docsContent h4{font-size:20px;margin-bottom:0}#docsContent h5,#docsContent h6{font-size:16px;font-weight:500}#docsContent p{font-size:16px;font-weight:300;line-height:1.75em}#docsContent p+p{margin-top:10px}#docsContent code{display:inline-block;box-sizing:border-box;background-color:#f7f7f7;color:#303030;font-family:roboto mono,monospace;vertical-align:baseline;font-size:14px;font-weight:700;padding:2px 4px}#docsContent a code{color:#3371e3;text-decoration:underline}#docsContent pre .pi,#docsContent pre .s{margin:0;padding:0}#docsContent .highlight code span,#docsContent code,#docsContent pre code{font-family:roboto mono,monospace}#docsContent code,#docsContent pre code{color:#303030}#docsContent pre code{padding:0}#docsContent pre{background-color:#f7f7f7;display:block;margin:20px 0;padding:15px;position:relative;overflow-x:auto}#docsContent h1 code,#docsContent h2 code,#docsContent h3 code,#docsContent h4 code,#docsContent h5 code,#docsContent h6 code{font-size:inherit;background-color:transparent}#docsContent .includecode{table-layout:fixed}#docsContent .includecode,#docsContent .includecode th,#docsContent .includecode td{padding:0!important}#docsContent .includecode th{text-align:right!important;padding:10px!important}#docsContent .includecode th a,#docsContent .includecode th a code{color:#fff!important;background-color:transparent!important}#docsContent .includecode pre{margin:0!important}#docsContent ul li{list-style:disc}#docsContent ol li{list-style:decimal}#docsContent ul,#docsContent ol{margin:20px 0;padding-left:30px;font-weight:300}#docsContent ul ul,#docsContent ol ol,#docsContent ul ol,#docsContent ol ul{margin:.75em 0}#docsContent li{margin-bottom:.75em;font-size:16px;line-height:1.75em}#docsContent table{width:100%;border:1px solid #ccc;border-spacing:0;margin-top:30px;margin-bottom:30px}#docsContent thead,#docsContent tr:nth-child(even){background-color:#f7f7f7}#docsContent thead{background-color:#555;color:#fff}#docsContent th,#docsContent td{padding:8px;text-align:left;margin:0}#docsContent th{font-weight:400}#docsContent td{font-size:.85em}#docsContent #editPageButton{position:absolute;top:-25px;right:5px;width:50px;height:50px;line-height:50px;border-radius:50%;white-space:nowrap;text-indent:50px;overflow:hidden;background:#3371e3 url(/images/icon-pencil.svg) no-repeat;background-position:12px 10px;background-size:29px 29px}#docsContent #markdown-toc,#docsContent #TableOfContents{margin-bottom:20px}#docsContent #markdown-toc ul,#docsContent #markdown-toc li,#docsContent #TableOfContents ul,#docsContent #TableOfContents li{list-style:disc;color:#3371e3}#docsContent #markdown-toc ul,#docsContent #TableOfContents ul{padding:0 15px;margin:0}#docsContent #markdown-toc li,#docsContent #TableOfContents li{padding:0;line-height:1.5em;margin-bottom:0}#docsContent #markdown-toc a,#docsContent #TableOfContents a{position:relative;color:#3371e3;font-weight:700}#docsContent img{max-width:100%}#docsContent #TableOfContents>ul>li{list-style:none}#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}html.search #docsContent{position:relative;float:none;width:90%;max-width:850px;margin:0 auto}html.search #docsContent #editPageButton{display:none}html.search #docsContent table{border:0;margin-bottom:0}html.search #docsContent td{padding:0}html.search #docsContent h1{margin-bottom:0;border-bottom:0;padding-bottom:0;padding-left:8px}#home.flip-nav .logo,#home.open-nav .logo{background-image:url(/images/nav_logo2.svg)}#home #hero{margin-bottom:0;padding-bottom:1px}#home #hero main{padding:0 10px;margin-bottom:30px}#home #hero #vendorStrip{display:none}#oceanNodes{padding-top:60px;padding-bottom:60px}#oceanNodes a{color:#3371e3}#oceanNodes main{margin-bottom:60px;min-height:160px}#oceanNodes .image-wrapper{max-width:75%;margin:0 auto 20px;text-align:center}#oceanNodes .image-wrapper img{width:100%;max-width:160px}#oceanNodes main:first-child .image-wrapper{max-width:100%}#oceanNodes main:first-child .image-wrapper img{max-width:491px}#oceanNodes h3{margin-bottom:30px}#video{height:200px}#video{width:100%;position:relative;background-position:center center;background-size:cover}#video>.light-text{display:none;position:absolute;top:50%;left:75%;width:525px;padding-right:80px;transform:translate(-50%,-50%);color:#fff}#video h2{font-size:32px;line-height:44px;margin-bottom:20px}#video p{margin-bottom:20px}#video #desktopKCButton{position:relative;font-size:18px;background-color:#303030;border-radius:8px;color:#fff;padding:20px 10px}#video #desktopShowVideoButton{position:relative;font-size:24px;background-color:#fff;border-radius:8px;color:#3371e3;padding:15px 30px 15px 80px;margin-bottom:15px}#video #desktopShowVideoButton:before{content:"";position:absolute;position:absolute;top:50%;left:40px;transform:translate(-50%,-50%);width:0;height:0;border-style:solid;border-width:10px 0 10px 20px;border-color:transparent transparent transparent #3371e3}#video #mobileShowVideoButton{position:absolute;top:50%;left:50%;transform:translate(-50%,-50%);width:80px;height:80px;border-radius:50%;background-color:transparent;border:5px solid rgba(255,255,255,.2);overflow:visible}#video #mobileShowVideoButton:after{position:absolute;top:50%;left:50%;transform:translate(-50%,-50%);left:40px;content:"";width:0;height:0;border-style:solid;border-width:20px 0 20px 30px;border-color:transparent transparent transparent #fff}#videoPlayer{position:fixed;top:0;left:0;width:100vw;height:100vh;background-color:rgba(0,0,0,.9);display:none}#videoPlayer iframe{position:absolute;top:50%;left:50%;transform:translate(-50%,-50%);width:80vw;height:45vw;max-width:142.22222222vh;max-height:80vh}#videoPlayer #closeButton{position:absolute;top:20px;right:20px;width:50px;height:50px;border:2px solid transparent;transition:.3s}#videoPlayer #closeButton:before,#videoPlayer #closeButton:after{content:"";position:absolute;top:calc(50% - 1px);left:10%;width:80%;height:2px;background-color:#fff}#videoPlayer #closeButton:before{transform:rotate(45deg)}#videoPlayer #closeButton:after{transform:rotate(-45deg)}#videoPlayer #closeButton:hover{border-color:#fff}#cncf{padding-top:60px;padding-bottom:140px;background-color:#f7f7f7;background-image:url(/images/cncf-color.png);background-position:center 100px;background-repeat:no-repeat;background-size:300px}#features{padding-top:140px;background-color:#f7f7f7;background-image:url(/images/wheel.png);background-position:center 60px;background-repeat:no-repeat;background-size:auto}.feature-box{width:100%;overflow:hidden;clear:both}.feature-box h4{line-height:normal;margin-bottom:15px}.feature-box>div:first-child{float:left}.feature-box>div:last-child{float:right}#features h3{margin-bottom:20px}#features .feature-box{margin-bottom:0}#features .feature-box>div{width:100%;margin-bottom:40px}#community.open-nav .logo,#community.flip-nav .logo,.gridPage.open-nav .logo,.gridPage.flip-nav .logo{background-image:url(/images/nav_logo2.svg)}#community #hero,.gridPage #hero{padding-bottom:20px}#community #mainContent,.gridPage #mainContent{padding:20px 0}#community #mainContent main,.gridPage #mainContent main{max-width:none}#community #mainContent a,.gridPage #mainContent a{color:#3371e3}#community #mainContent .content,.gridPage #mainContent .content{margin-bottom:30px;padding:30px 0}#community #mainContent .content h1,#community #mainContent .content h2,#community #mainContent .content h3,#community #mainContent .content h4,#community #mainContent .content h5,#community #mainContent .content h6,#community #mainContent .content p,.gridPage #mainContent .content h1,.gridPage #mainContent .content h2,.gridPage #mainContent .content h3,.gridPage #mainContent .content h4,.gridPage #mainContent .content h5,.gridPage #mainContent .content h6,.gridPage #mainContent .content p{line-height:normal;max-width:1200px;padding:0 20px;margin:0 auto 20px}#community #mainContent .content:nth-child(even),.gridPage #mainContent .content:nth-child(even){background-color:#f7f7f7}#community #mainContent .company-logos,.gridPage #mainContent .company-logos{text-align:center;max-width:1200px;margin:0 auto}#community #mainContent .company-logos img,.gridPage #mainContent .company-logos img{width:auto;margin:10px;background-color:#f7f7f7}#community #mainContent .partner-logos,.gridPage #mainContent .partner-logos{text-align:center;max-width:1200px;margin:0 auto}#community #mainContent .partner-logos img,.gridPage #mainContent .partner-logos img{width:auto;margin:10px;background-color:#fff;box-shadow:0 5px 5px rgba(0,0,0,.24),0 0 5px rgba(0,0,0,.12)}#community #mainContent #calendarMeetings,.gridPage #mainContent #calendarMeetings{position:relative;width:80vw;height:60vw;max-width:1200px;max-height:900px;margin:20px auto}#community #mainContent #calendarEvents,.gridPage #mainContent #calendarEvents{position:relative;width:80vw;height:30vw;max-width:1200px;max-height:450px;margin:20px auto}#community #mainContent iframe,.gridPage #mainContent iframe{position:absolute;border:0;width:100%;height:100%}.ui-icon{display:inline-block!important}#feature-state-dialog-link{text-decoration:none!important;padding:5px!important}#feature-state-dialog-link a:visited{color:#454545!important}#feature-state-dialog-link a code{display:inline-block!important;box-sizing:border-box!important;background-color:#f7f7f7!important;color:#303030!important;font-family:roboto mono,monospace!important;vertical-align:baseline!important;font-size:14px!important;font-weight:700!important;padding:0 4px!important}#feature-state-dialog{background:#fff!important;border:1px solid #ddd!important;padding:.5em 1em!important}#feature-state-dialog ul,#feature-state-dialog li{list-style:disc!important;margin:4px 12px!important}#feature-state-dialog p{margin:8px 0!important}#feature-state-dialog code{display:inline-block!important;box-sizing:border-box!important;background-color:#f7f7f7!important;color:#303030!important;font-family:roboto mono,monospace!important;vertical-align:baseline!important;font-size:14px!important;font-weight:700!important;padding:0 4px!important}.ui-dialog{background:#f7f7f7!important;padding:.5em}.ui-dialog-content{position:relative;float:right;width:100%}.ui-dialog-content *+h2,.ui-dialog-content *+h3,.ui-dialog-content *+h4,.ui-dialog-content *+h5,.ui-dialog-content *+h6{margin-top:30px}.ui-dialog-content h1,.ui-dialog-content h2,.ui-dialog-content h3,.ui-dialog-content h4,.ui-dialog-content h5,.ui-dialog-content h6{line-height:normal;font-weight:500;margin-bottom:30px;padding-bottom:10px}.ui-dialog-content h1:before,.ui-dialog-content h2:before,.ui-dialog-content h3:before,.ui-dialog-content h4:before,.ui-dialog-content h5:before,.ui-dialog-content h6:before{display:block;content:" ";margin-top:-100px;height:100px;visibility:hidden}.ui-dialog-content h1,.ui-dialog-content h2{border-bottom:1px solid #ccc}.ui-dialog-content h1{font-size:32px;padding-right:60px}.ui-dialog-content h2{font-size:28px}.ui-dialog-content h3{font-size:24px;font-weight:300;margin-bottom:5px}.ui-dialog-content h4{font-size:20px;margin-bottom:0}.ui-dialog-content h5,.ui-dialog-content h6{font-size:16px;font-weight:500}.ui-dialog-content p{font-size:16px;font-weight:300;line-height:1.75em}.ui-dialog-content p+p{margin-top:10px}.ui-dialog-content code{display:inline-block;box-sizing:border-box;background-color:#f7f7f7;color:#303030;font-family:roboto mono,monospace;vertical-align:baseline;font-size:14px;font-weight:700;padding:2px 4px}.ui-dialog-content a code{color:#3371e3;text-decoration:underline}.ui-dialog-content pre .pi,.ui-dialog-content pre .s{margin:0;padding:0}.ui-dialog-content .highlight code span,.ui-dialog-content code,.ui-dialog-content pre code{font-family:roboto mono,monospace}.ui-dialog-content code,.ui-dialog-content pre code{color:#303030}.ui-dialog-content pre code{padding:0}.ui-dialog-content pre{background-color:#f7f7f7;display:block;margin:20px 0;padding:15px;position:relative;overflow-x:auto}.ui-dialog-content h1 code,.ui-dialog-content h2 code,.ui-dialog-content h3 code,.ui-dialog-content h4 code,.ui-dialog-content h5 code,.ui-dialog-content h6 code{font-family:inherit;font-size:inherit;background-color:transparent}.ui-dialog-content .includecode{table-layout:fixed}.ui-dialog-content .includecode,.ui-dialog-content .includecode th,.ui-dialog-content .includecode td{padding:0!important}.ui-dialog-content .includecode th{text-align:right!important;padding:10px!important}.ui-dialog-content .includecode th a,.ui-dialog-content .includecode th a code{color:#fff!important;background-color:transparent!important}.ui-dialog-content .includecode pre{margin:0!important}.ui-dialog-content ul li{list-style:disc}.ui-dialog-content ol li{list-style:decimal}.ui-dialog-content ul,.ui-dialog-content ol{margin:20px 0;padding-left:30px;font-weight:300}.ui-dialog-content ul ul,.ui-dialog-content ol ol,.ui-dialog-content ul ol,.ui-dialog-content ol ul{margin:.75em 0}.ui-dialog-content li{margin-bottom:.75em;font-size:16px;line-height:1.75em}.ui-dialog-content table{width:100%;border:1px solid #ccc;border-spacing:0;margin-top:30px;margin-bottom:30px}.ui-dialog-content thead,.ui-dialog-content tr:nth-child(even){background-color:#f7f7f7}.ui-dialog-content thead{background-color:#555;color:#fff}.ui-dialog-content th,.ui-dialog-content td{padding:8px;text-align:left;margin:0}.ui-dialog-content th{font-weight:400}.ui-dialog-content td{font-size:.85em}.ui-dialog-content #editPageButton{position:absolute;top:-25px;right:5px;width:50px;height:50px;line-height:50px;border-radius:50%;white-space:nowrap;text-indent:50px;overflow:hidden;background:#3371e3 url(/images/icon-pencil.svg) no-repeat;background-position:12px 10px;background-size:29px 29px}.ui-dialog-content #markdown-toc{margin-bottom:20px}.ui-dialog-content #markdown-toc ul,.ui-dialog-content #markdown-toc li{list-style:disc;color:#3371e3}.ui-dialog-content #markdown-toc ul{padding:0 15px;margin:0}.ui-dialog-content #markdown-toc li{padding:0;line-height:1.5em;margin-bottom:0}.ui-dialog-content #markdown-toc a{position:relative;color:#3371e3;font-weight:700}.ui-dialog-content img{max-width:100%}.ui-dialog-content a{text-decoration:underline}.ui-dialog-buttonpane{background:#f7f7f7!important}.ui-widget-header{background:0 0!important;background-color:transparent!important;border:0!important}.ui-tabs ul,.ui-tabs ol,.ui-tabs li{padding:0!important;list-style:none!important;margin-bottom:0!important;margin-left:4px!important}.ui-tabs-panel ul li{list-style:disc!important}.ui-tabs-panel ol li{list-style:decimal!important}.ui-widget-content{border:0!important}.ui-widget-content table{margin:0!important}.ui-tabs .ui-tabs-panel{border:1px solid #ccc!important}.ui-tabs-anchor{text-decoration:none!important}#talkToUs h3,#talkToUs h4{text-align:center}#talkToUs h3{margin-bottom:15px}#talkToUs h4{line-height:normal;margin-bottom:50px}#talkToUs h4 br{display:none}#talkToUs #bigSocial{overflow:hidden}#talkToUs #bigSocial div{width:100%;float:left;padding:30px;padding-top:110px;background-position:center top;background-size:auto;background-repeat:no-repeat}#talkToUs #bigSocial div:nth-child(1){background-image:url(/images/twitter_icon.png)}#talkToUs #bigSocial div:nth-child(2){background-image:url(/images/github_icon.png)}#talkToUs #bigSocial div:nth-child(3){background-image:url(/images/slack_icon.png)}#talkToUs #bigSocial div:nth-child(4){background-image:url(/images/stackoverflow_icon.png)}#talkToUs #bigSocial div+div{margin-top:20px;margin-left:0}#talkToUs #bigSocial a{display:inline-block;color:#3371e3;font-size:24px;font-weight:400;text-decoration:none;margin-bottom:15px}#talkToUs #bigSocial a,#talkToUs #bigSocial p{text-align:center;width:100%}#home #talkToUs main{padding:30px 0}#home #talkToUs h5{font-size:20px}#home #caseStudiesWrapper{position:relative;text-align:center;margin-bottom:30px}#home #caseStudiesWrapper img{padding-bottom:1rem}#home #caseStudiesWrapper div{position:relative;display:inline-block;vertical-align:top;width:100%;min-height:230px;margin-bottom:60px;padding-right:1rem;background-position:top center}#home #caseStudiesWrapper p{font-size:20px}#home #caseStudiesWrapper a{position:absolute;bottom:-30px;left:50%;transform:translateX(-50%);color:#3371e3;font-weight:400}.cse .gsc-control-cse,.gsc-control-cse{padding:0}.gsc-control-cse table,.gsc-control-cse-en table{margin:0!important}.gsc-above-wrapper-area{border-bottom:0}#bing-results-container{margin-top:30px;margin-left:20px}.bing-result{margin-bottom:20px}.bing-result-name a{font-size:16px;color:#00c}.bing-result-url{color:green;font-size:13px}.bing-result-snippet{color:#000;font-size:11px}#bing-pagination-container{margin:10px;margin-left:20px}.bing-page-anchor{text-decoration:none!important;cursor:pointer;color:#00c;margin-right:8px}@media screen and (min-width:750px){h1{font-size:32px;line-height:40px}h2{font-size:28px;line-height:60px}h3{font-size:24px;line-height:32px}h4{font-size:20px;line-height:40px}h5{font-size:16px;line-height:36px}p{font-size:14px;line-height:22px}section,header,#vendorStrip{padding-left:20px;padding-right:20px}section main,header main,#vendorStrip main{width:100%;max-width:100%}header{height:80px}.nav-buttons{height:80px;line-height:80px}.nav-buttons .button+*{margin-left:30px}#hamburger{width:50px;height:50px}#mainNav{padding:140px 0 30px}#mainNav h5{margin-bottom:1em}#mainNav h3{margin-bottom:.6em}#mainNav .nav-box{width:20%}#mainNav .nav-box+.nav-box{margin-left:calc(20%/3)}#mainNav main+main{margin-top:60px}#mainNav .left .button{height:50px;line-height:50px;font-size:18px}.open-nav #tryKubernetes,.y-enough #tryKubernetes{margin-left:30px}#hero{padding-top:80px}#docs #hero h1,#docs #hero h5{padding-left:20px;padding-right:20px}#vendorStrip{height:88px;line-height:88px;font-size:16px}p{font-size:16px;line-height:24px;letter-spacing:.1px}h1{font-size:36px;line-height:44px}h3{font-size:28px;line-height:36px}h4{font-size:24px;line-height:40px}#home #viewDocs,#home #tryKubernetes{display:inline-block}#vendorStrip{display:block;text-align:center}#vendorStrip img{max-height:24px;vertical-align:middle;margin:0 30px}#docs #vendorStrip li a{font-size:1em;font-weight:400}#docs #vendorStrip li li+li{margin-left:60px}#oceanNodes h3{text-align:left;margin-bottom:18px}#oceanNodes main{position:relative;clear:both;display:table}#oceanNodes main .content{display:table-cell;position:relative;vertical-align:middle}#oceanNodes main .image-wrapper{position:absolute;top:50%;max-width:25%;max-height:100%;transform:translateY(-50%)}#oceanNodes main:nth-child(odd){padding-right:210px}#oceanNodes main:nth-child(odd) .image-wrapper{right:0}#oceanNodes main:nth-child(even){padding-left:210px}#oceanNodes main:nth-child(even) .image-wrapper{left:0}#oceanNodes main:nth-child(1){padding-right:0}#oceanNodes main:nth-child(1) h3,#oceanNodes main:nth-child(1) p{text-align:center}#oceanNodes main:nth-child(1) .image-wrapper{position:relative;display:block;float:none;max-width:100%;transform:none}#oceanNodes main:nth-child(1) .content{display:block}#oceanNodes main img{width:100%}#video{height:400px;display:block}#video>.light-text{display:block}#mobileShowVideoButton{display:none}#features{padding-bottom:60px}#features .feature-box{margin-bottom:30px}#features .feature-box:last-child{margin-bottom:0}#features h3{margin-bottom:40px}#features .feature-box>div{width:45%;margin-bottom:0}#talkToUs #bigSocial div{width:calc(50% - 15px)}#talkToUs #bigSocial div+div{margin-top:0}#talkToUs #bigSocial div:nth-child(2){margin-left:20px}#talkToUs #bigSocial div:nth-child(3){margin-top:20px}#talkToUs #bigSocial div:nth-child(4){margin-top:20px;margin-left:20px}#talkToUs #bigSocial a{display:inline-block;color:#3371e3;font-weight:400;text-decoration:none}footer nav{text-align:center}footer nav a{width:30%;padding:0 20px}footer .social{text-align:center}footer .social div{display:inline-block}footer .social div:last-child{display:block;margin:0}footer .social span{display:inline-block;margin-right:10px}footer .social input{text-align:left}#home #caseStudiesWrapper div{width:48%}}@media screen and (min-width:1025px){#hamburger{display:none}ul.global-nav{display:inline-block}#docs #vendorStrip #searchBox:before{top:15px}#vendorStrip{height:44px;line-height:44px}#vendorStrip li a.YAH:after{content:"";display:block;position:absolute;left:0;bottom:0;width:100%;height:4px;background-color:#3371e3}#vendorStrip #searchBox{float:right}#home #hero #vendorStrip{display:block}#docs #hero h1,#docs #hero h5{text-align:left}#docs #hero #vendorStrip ul{float:left}#docs #hero #vendorStrip #searchBox{float:right;width:250px}#docs #hero #vendorStrip #search{vertical-align:middle}#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)}#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}#docsContent{width:calc(100% - 400px)}#docsContent #editPageButton{right:-25px}section main,header main,footer main{max-width:1200px}header,#vendorStrip,#encyclopedia,#hero h1,#hero h5,#docs #hero h1,#docs #hero h5,#community #hero h1,.gridPage #hero h1,#community #hero h5,.gridPage #hero h5{padding-left:100px;padding-right:100px}#vendorStrip{padding-right:10px}#home section main,#home header main,#home footer main{max-width:1e3px}#oceanNodes main{position:relative;max-width:830px}#oceanNodes main:nth-child(1){max-width:1e3px;padding-right:475px}#oceanNodes main:nth-child(1) h3,#oceanNodes main:nth-child(1) p{text-align:left}#oceanNodes main:nth-child(1) .image-wrapper{position:absolute;max-width:48%;transform:translateY(-50%)}#oceanNodes main:nth-child(1) .image-wrapper img{max-width:425px}#video{height:550px;position:relative;background-position:center center;background-size:cover}#talkToUs h4 br{display:block}#talkToUs #bigSocial div{width:calc(25% - 18px)}#talkToUs #bigSocial div+div{margin-left:20px}footer{width:100%;background-image:url(../images/texture.png);background-color:#303030}footer main{padding:20px 0}footer nav{overflow:hidden;margin-bottom:20px}footer nav a{width:16.65%;float:left;font-size:24px;font-weight:300;white-space:nowrap}footer .social{padding:0 30px;max-width:1200px}footer .social div{float:left}footer .social div:last-child{float:right}#search,#wishField{background-color:transparent;padding:10px;font-size:16px;font-weight:100;color:#fff;border:1px solid #fff;transition:.3s}#search:focus,#wishField:focus{background-color:#f7f7f7;color:#303030}.social a{display:inline-block;background-image:url(../images/social_sprite.png);background-repeat:no-repeat;background-size:auto;width:50px;height:50px;border-radius:5px;margin-right:10px}.social a:hover{background-color:#fff}.social a span{position:absolute;display:block;height:0;overflow:hidden}a.twitter{background-position:0 0}a.twitter:hover{background-position:0 100%}a.stack-overflow{background-position:-50px 0}a.stack-overflow:hover{background-position:-50px 100%}a.slack{background-position:-100px 0}a.slack:hover{background-position:-100px 100%}a.github{background-position:-150px 0}a.github:hover{background-position:-150px 100%}a.mailing-list{background-position:-200px 0}a.mailing-list:hover{background-position:-200px 100%}a.calendar{background-position:-250px 0}a.calendar:hover{background-position:-250px 100%}#community #hero,.gridPage #hero{text-align:left}#community #hero h1,.gridPage #hero h1{padding:20px 100px}#community #tryKubernetes,.gridPage #tryKubernetes{width:auto;background-color:#3371e3;padding:0 20px}#bigSocial div{width:calc(25% - 18px)}#home #caseStudiesWrapper div{width:24%;min-height:260px}}@media screen and (min-width:1300px){#vendorStrip{padding-right:100px}}@media screen and (min-width:456px){#vendorStrip li+li{margin-left:20px}} \ No newline at end of file diff --git a/resources/_gen/assets/sass/sass/styles.sass_cb957da2191fde4902dd41b139c8069d.json b/resources/_gen/assets/sass/sass/styles.sass_cb957da2191fde4902dd41b139c8069d.json deleted file mode 100644 index c31c6c93a3..0000000000 --- a/resources/_gen/assets/sass/sass/styles.sass_cb957da2191fde4902dd41b139c8069d.json +++ /dev/null @@ -1 +0,0 @@ -{"Target":"css/styles.min.a848f9c131ff992de25c86ec3a2fc944e86d48666bcd5f060f881576a04b3754.css","MediaType":"text/css","Data":{"Integrity":"sha256-qEj5wTH/mS3iXIbsOi/JROhtSGZrzV8GD4gVdqBLN1Q="}} \ No newline at end of file diff --git a/sass/OWNERS b/sass/OWNERS new file mode 100644 index 0000000000..87ee22388b --- /dev/null +++ b/sass/OWNERS @@ -0,0 +1,8 @@ +# Allow CSS/SASS updates from blog and case studies owners +options: + no_parent_owners: false +reviewers: + - alexcontini +approvers: + - alexcontini + \ No newline at end of file diff --git a/assets/sass/_base.sass b/sass/_base.sass similarity index 96% rename from assets/sass/_base.sass rename to sass/_base.sass index c0516925ee..b078336a96 100644 --- a/assets/sass/_base.sass +++ b/sass/_base.sass @@ -285,22 +285,18 @@ ul.global-nav display: block -.flip-nav ul.global-nav li a, -.open-nav ul.global-nav li a, - color: $dark-grey +.flip-nav, .open-nav + ul.global-nav li a + color: $dark-grey -.flip-nav ul.global-nav li a .ui-icon - filter: brightness(0) + .ui-icon + filter: brightness(0) - -.flip-nav ul.global-nav li ul li a, +.flip-nav ul.global-nav li ul li a background: #fff color: $dark-grey -.flip-nav ul.global-nav li a.active:after, -.flip-nav ul.global-nav li ul li a.active:after, -.open-nav ul.global-nav li a.active:after, - +.flip-nav ul.global-nav li a.active:after, .flip-nav ul.global-nav li ul li a.active:after, .open-nav ul.global-nav li a.active:after background: $blue // FLIP NAV @@ -338,7 +334,8 @@ ul.global-nav .open-nav, .y-enough #tryKubernetes - width: 150px + width: auto + padding: 0 20px background-color: $blue border-color: $blue @@ -560,6 +557,8 @@ section #docs #vendorStrip line-height: 44px + max-width: 100% + overflow-x: scroll ul float: none @@ -996,8 +995,10 @@ dd img max-width: 100% - #TableOfContents > ul > li { list-style: none; } #TableOfContents + & > ul > li + list-style: none + ul, li list-style: disk @@ -1234,12 +1235,33 @@ $feature-box-div-margin-bottom: 40px #cncf padding-top: 60px padding-bottom: 140px - background-color: $light-grey background-image: url(/images/cncf-color.png) background-position: center 100px background-repeat: no-repeat background-size: 300px +// KubeWeekly +#kubeweekly + background-color: $light-grey + padding-top: 60px + padding-bottom: 140px + background-size: auto + font-family: "Roboto Mono", monospace !important + font-size: 24px + font-weight: bold + + h5 + font-size: 20px + +.subscribe-button + border-radius: 6px + padding: 0 20px + line-height: 31px + color: white + background-color: blue + text-decoration: none + font-size: 14px + // Features #features padding-top: 140px @@ -1721,7 +1743,7 @@ $feature-box-div-margin-bottom: 40px margin-bottom: 30px img - padding-bottom: 1rem; + padding-bottom: 1rem div position: relative @@ -1730,15 +1752,15 @@ $feature-box-div-margin-bottom: 40px width: 100% min-height: 230px margin-bottom: 60px - padding-right: 1rem; + padding-right: 1rem background-position: top center - + p font-size: 20px a position: absolute - bottom: -30px; + bottom: -30px left: 50% transform: translateX(-50%) color: $blue @@ -1748,46 +1770,44 @@ $feature-box-div-margin-bottom: 40px /* Google Search */ .cse .gsc-control-cse, .gsc-control-cse - padding: 0; + padding: 0 .gsc-control-cse table, .gsc-control-cse-en table - margin: 0px !important; + margin: 0px !important .gsc-above-wrapper-area - border-bottom: 0; - + border-bottom: 0 /* Bing Search */ #bing-results-container - margin-top: 30px - margin-left: 20px + margin-top: 30px + margin-left: 20px .bing-result - margin-bottom: 20px + margin-bottom: 20px .bing-result-name a - font-size: 16px - color: #0000CC + font-size: 16px + color: #0000CC .bing-result-url - color: #008000 - font-size: 13px + color: #008000 + font-size: 13px .bing-result-snippet - color: #000 - font-size: 11px + color: #000 + font-size: 11px #bing-pagination-container margin: 10px margin-left: 20px .bing-page-anchor - text-decoration: none!important - cursor: pointer - color: #0000CC - margin-right: 8px - + text-decoration: none!important + cursor: pointer + color: #0000CC + margin-right: 8px diff --git a/assets/sass/_case-studies.sass b/sass/_case-studies.sass similarity index 100% rename from assets/sass/_case-studies.sass rename to sass/_case-studies.sass diff --git a/assets/sass/_desktop.sass b/sass/_desktop.sass similarity index 100% rename from assets/sass/_desktop.sass rename to sass/_desktop.sass diff --git a/assets/sass/_reset.sass b/sass/_reset.sass similarity index 100% rename from assets/sass/_reset.sass rename to sass/_reset.sass diff --git a/assets/sass/_size.sass b/sass/_size.sass similarity index 100% rename from assets/sass/_size.sass rename to sass/_size.sass diff --git a/assets/sass/_skin.sass b/sass/_skin.sass similarity index 100% rename from assets/sass/_skin.sass rename to sass/_skin.sass diff --git a/assets/sass/_tablet.sass b/sass/_tablet.sass similarity index 99% rename from assets/sass/_tablet.sass rename to sass/_tablet.sass index 15d5b496f4..2703f5c4d7 100644 --- a/assets/sass/_tablet.sass +++ b/sass/_tablet.sass @@ -120,6 +120,7 @@ $feature-box-div-width: 45% position: relative clear: both display: table + height: 160px .content display: table-cell diff --git a/assets/sass/case_study_styles.sass b/sass/case-study-styles.sass similarity index 100% rename from assets/sass/case_study_styles.sass rename to sass/case-study-styles.sass diff --git a/assets/sass/styles.sass b/sass/styles.sass similarity index 100% rename from assets/sass/styles.sass rename to sass/styles.sass diff --git a/scripts/sass.sh b/scripts/sass.sh new file mode 100755 index 0000000000..b6325d7b01 --- /dev/null +++ b/scripts/sass.sh @@ -0,0 +1,38 @@ +#!/bin/bash + +if [[ $# -eq 0 ]] ; then + echo "You must specify a command from the following: build, develop" + exit 0 +fi + +__build() { + echo "Building Kubernetes website CSS from Sass sources..." + + for filename in case-study-styles styles; do + echo $filename + sass \ + --style=compressed \ + sass/$filename.sass static/css/$filename.css + done + + echo "Done building CSS!" +} + +__develop() { + echo "Watching Sass sources for changes..." + + sass \ + --watch \ + sass/styles.sass:static/css/styles.css \ + sass/case-study-styles.sass:static/css/case-study-styles.css +} + +case $1 in + build) + __build + ;; + + develop) + __develop + ;; +esac diff --git a/static/_redirects b/static/_redirects index f7e1e9accd..ca52e79e85 100644 --- a/static/_redirects +++ b/static/_redirects @@ -33,6 +33,7 @@ /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/kubelet-tls-bootstrapping/ /docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping/ 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 @@ -263,7 +264,7 @@ /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 /docs/tasks/administer-cluster/calico-network-policy/ /docs/tasks/administer-cluster/network-policy-provider/calico-network-policy/ 301 -/docs/tasks/administer-cluster/certificate-rotation/ /docs/admin/kubelet-tls-bootstrapping/ 301 +/docs/tasks/administer-cluster/certificate-rotation/ /docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping/ 301 /docs/tasks/administer-cluster/cilium-network-policy/ /docs/tasks/administer-cluster/network-policy-provider/cilium-network-policy/ 301 /docs/tasks/administer-cluster/configure-namespace-isolation/ /docs/concepts/services-networking/network-policies/ 301 /docs/tasks/administer-cluster/configure-pod-disruption-budget/ /docs/tasks/run-application/configure-pdb/ 301 diff --git a/static/css/blog.css b/static/css/blog.css index 1c824d19cd..4f906fd81c 100644 --- a/static/css/blog.css +++ b/static/css/blog.css @@ -179,7 +179,7 @@ div.header-try a { div.widget > h2, div.widget h2.title { margin: 0 0 1em 0; - font: normal bold 11px 'Roboto',,sans-serif; + font: normal bold 11px 'Roboto',sans-serif; color: #000000; } diff --git a/static/css/case-study-styles.css b/static/css/case-study-styles.css new file mode 100644 index 0000000000..5ceb84710c --- /dev/null +++ b/static/css/case-study-styles.css @@ -0,0 +1,2 @@ +html,body{margin:0;padding:0}input,button{outline:none}button{cursor:pointer}ul,li{list-style:none}ul{margin:0;padding:0}a{text-decoration:none}.clear{display:block;clear:both}.light-text{color:#fff}.right{float:right}.left{float:left}.center{text-align:center}*,.button{box-sizing:border-box;font-family:"Roboto",sans-serif;background:none;margin:0;border:0}body{font-family:"Roboto",sans-serif}h1,h2,h5,p{font-weight:300}h3,h4{font-weight:400}html,body{margin:0;padding:0}input,button{outline:none}button{cursor:pointer}ul,li{list-style:none}ul{margin:0;padding:0}a{text-decoration:none}.clear{display:block;clear:both}.light-text{color:#fff}.right{float:right}.left{float:left}.center{text-align:center}h1{font-size:32px;line-height:40px}h2{font-size:28px;line-height:60px}h3{font-size:24px;line-height:32px}h4{font-size:20px;line-height:40px}h5{font-size:16px;line-height:36px}p{font-size:14px;line-height:22px}section,header,#vendorStrip{padding-left:20px;padding-right:20px}section main,header main,#vendorStrip main{width:100%;max-width:100%}header{height:80px}.nav-buttons{height:80px;line-height:80px}.nav-buttons .button+*{margin-left:30px}#hamburger{width:50px;height:50px}#mainNav{padding:140px 0 30px}#mainNav h5{margin-bottom:1em}#mainNav h3{margin-bottom:.6em}#mainNav .nav-box{width:20%}#mainNav .nav-box+.nav-box{margin-left:calc(20% / 3)}#mainNav main+main{margin-top:60px}#mainNav .left .button{height:50px;line-height:50px;font-size:18px}.open-nav #tryKubernetes,.y-enough #tryKubernetes{margin-left:30px}#hero{padding-top:80px}#docs #hero h1,#docs #hero h5{padding-left:20px;padding-right:20px}#vendorStrip{height:88px;line-height:88px;font-size:16px}body{background-color:#fff}section{position:relative;background-color:#fff}section main,header main,footer main{position:relative;margin:auto}p{font-size:14px;font-weight:400}.button{display:inline-block;border-radius:6px;padding:0 20px;line-height:40px;color:#fff;background-color:#3371e3;text-decoration:none}#cellophane{position:fixed;top:0;left:0;width:100%;height:100%;display:none}header{position:fixed;top:0;left:0;width:100%;z-index:8888;background-color:transparent;box-shadow:0 0 0 transparent;overflow:hidden;transition:.3s;text-align:center}.logo{position:relative;float:left;display:block;width:180px;height:88px;top:0;left:0;transform:none;background-image:url(/images/nav_logo.svg);background-size:contain;background-position:center center;background-repeat:no-repeat}#docs .flyout-button{position:fixed;top:20px;left:20px;width:50px;height:50px;background-image:url(/images/toc_icon.png);background-position:center center;background-repeat:no-repeat;background-size:auto;border-radius:50%;transition:.3s;z-index:99999}#docs.open-nav .flyout-button{display:none}#docs .logo{position:absolute;top:40px;left:50%;transform:translate(-50%, -50%);display:block;width:45px;height:44px;background-image:url(/images/favicon.png)}#docs.flip-nav .flyout-button{background-image:url(/images/toc_icon_grey.png)}.nav-buttons{float:right}#viewDocs,#tryKubernetes{display:none}#viewDocs{border:2px solid #fff;background-color:transparent;transition:.3s}#viewDocs:hover{background-color:#fff;color:#303030}#tryKubernetes{width:0;padding:0 0;border:1px solid transparent;background-color:transparent;text-align:center;white-space:nowrap;vertical-align:middle;overflow:hidden;transition:.3s}#hamburger{display:inline-block;position:relative;vertical-align:middle;padding:0;border:0;background:none}#hamburger div,#hamburger:before,#hamburger:after{position:absolute;left:15%;width:70%;height:2px;background-color:#3371e3;transition:.3s;content:""}#hamburger div{top:calc(50% - 1px)}#hamburger:before{top:24%}#hamburger:after{bottom:24%}#hamburger:hover div,#hamburger:hover:before,#hamburger:hover:after{background-color:#fff}#mainNav h5{color:#3371e3;font-weight:normal}#mainNav main{white-space:nowrap;overflow:hidden;clear:both}#mainNav .nav-box{float:left;white-space:normal}#mainNav h3 a{color:#3371e3;text-decoration:none}ul.global-nav{display:none}ul.global-nav li{display:inline-block;margin-right:14px}ul.global-nav li a{color:#fff;font-weight:400;padding:0;position:relative}ul.global-nav li a.active:after{position:absolute;width:100%;height:2px;content:"";bottom:-4px;left:0;background:#fff}ul.global-nav li a .ui-icon{filter:brightness(0) invert(1)}ul.global-nav li ul{display:none;position:fixed;top:40px;text-align:left}ul.global-nav li ul li{display:block;height:28px}ul.global-nav li ul li a{background:#303030;color:#fff;padding:7px}ul.global-nav li ul li:last-child a{border-radius:7px}ul.global-nav li:hover ul{display:block}.flip-nav ul.global-nav li a,.open-nav ul.global-nav li a{color:#303030}.flip-nav ul.global-nav li a .ui-icon,.open-nav ul.global-nav li a .ui-icon{filter:brightness(0)}.flip-nav ul.global-nav li ul li a{background:#fff;color:#303030}.flip-nav ul.global-nav li a.active:after,.flip-nav ul.global-nav li ul li a.active:after,.open-nav ul.global-nav li a.active:after{background:#3371e3}.flip-nav header{background-color:#fff}.open-nav body{overflow:hidden}.open-nav #cellophane{display:block;z-index:9998}.open-nav header{background-color:#e8e8e8;z-index:9999}.open-nav #hamburger div{opacity:0}.open-nav #hamburger:before,.open-nav #hamburger:after{left:12px;transform-origin:0 1px}.open-nav #hamburger:before{transform:rotate(45deg)}.open-nav #hamburger:after{transform:rotate(-45deg)}.open-nav #tryKubernetes,.y-enough #tryKubernetes{width:auto;padding:0 20px;background-color:#3371e3;border-color:#3371e3}.flip-nav header,.open-nav header{box-shadow:0 1px 2px #4c4c4c}.flip-nav #viewDocs,.open-nav #viewDocs{border-color:#303030;color:#303030}.flip-nav #viewDocs:hover,.open-nav #viewDocs:hover{border-color:#3371e3;background-color:#3371e3;color:#fff}.flip-nav #hamburger:hover div,.flip-nav #hamburger:hover:before,.flip-nav #hamburger:hover:after,.open-nav #hamburger:hover div,.open-nav #hamburger:hover:before,.open-nav #hamburger:hover:after{background-color:#303030}#hero{background-image:url(/images/texture.png);background-color:#303030;text-align:center;padding-left:0;padding-right:0;margin-bottom:0;position:relative}#hero.bot-bar:after{display:block;margin-bottom:-20px;height:8px;width:100%;background-color:rgba(255,255,255,0.1);content:""}#hero.no-sub h5{display:none}#hero.no-sub h1{margin-bottom:20px}#home #hero:after{display:none}#vendorStrip{position:relative;background-color:rgba(255,255,255,0.1);font-weight:100;white-space:nowrap;text-align:center}#vendorStrip li a{color:rgba(255,255,255,0.5)}#vendorStrip li a.YAH{color:#fff;position:relative}footer{width:100%;background-image:url(/images/texture.png);background-color:#303030}footer main{padding:20px 0}footer nav a{width:100%;text-align:center;display:inline-block;margin:10px 0;font-size:24px;font-weight:300;color:#fff;text-decoration:none}footer .social{margin:20px 0}footer .social div{text-align:center;margin-bottom:20px}footer .social div:last-child{margin:30px 0}footer .social span{display:block;margin-bottom:8px}footer .social input{text-align:center}#search,#wishField{background-color:transparent;padding:10px;font-size:16px;font-weight:100;color:#fff;border:1px solid #fff;transition:.3s}#search:focus,#wishField:focus{background-color:#f7f7f7;color:#303030}.social a{display:inline-block;background-image:url(/images/social_sprite.png);background-repeat:no-repeat;background-size:auto;width:50px;height:50px;border-radius:5px;margin-right:10px}.social a:hover{background-color:#fff}.social a span{position:absolute;display:block;height:0;overflow:hidden}.social a.button{background-image:none;width:auto;height:auto}.social a.button:hover{color:#3371e3}a.twitter{background-position:0 0}a.twitter:hover{background-position:0 100%}a.stack-overflow{background-position:-50px 0}a.stack-overflow:hover{background-position:-50px 100%}a.slack{background-position:-100px 0}a.slack:hover{background-position:-100px 100%}a.github{background-position:-150px 0}a.github:hover{background-position:-150px 100%}a.mailing-list{background-position:-200px 0}a.mailing-list:hover{background-position:-200px 100%}a.calendar{background-position:-250px 0}a.calendar:hover{background-position:-250px 100%}#viewDocs{display:none}section{background-color:#fff}#hero{background-color:#303030}#hero h5{margin:20px 0;line-height:28px}#vendorStrip{position:relative}#vendorStrip ul{float:left}#vendorStrip li{display:inline-block;height:100%}#vendorStrip a{display:block;height:100%;color:#fff;font-size:.75em;font-weight:bold}#vendorStrip li+li{margin-left:0}#docs #vendorStrip{line-height:44px;max-width:100%;overflow-x:scroll}#docs #vendorStrip ul{float:none}#docs #vendorStrip #searchBox{float:none;display:block;width:80%;margin:0 auto;height:44px;line-height:44px;position:relative}#docs #vendorStrip #searchBox:before{position:absolute;width:15px;height:15px;content:"";right:8px;top:7px;background-image:url(/images/search-icon.svg);background-repeat:no-repeat;background-size:100% 100%;z-index:1}#docs #vendorStrip #search{width:100%;padding:0 10px;height:30px;line-height:30px;font-size:16px;vertical-align:top;background:#fff;border:none;border-radius:4px;position:relative}#encyclopedia{position:relative;padding:50px 20px 20px 20px;overflow:hidden;font-size:14px}#encyclopedia>div{height:100%}#docsToc{position:fixed;background-color:#fff;top:0;left:0;width:0;height:100vh;overflow:hidden;padding:50px 0;z-index:999999;transition:.3s}#docsToc .yah>.title{background-color:#f7f7f7;border-left:3px solid #3371e3;padding:7.5px 10px 7.5px 18px;margin-left:-3px;color:#3371e3}.open-toc body{overflow:hidden}.open-toc #docsToc{padding:50px 20px;width:400px;max-width:100vw;overflow-y:auto}.pi-accordion>.container:first-child>.item:first-child>.title:first-child{padding-left:0;font-size:1.5em;font-weight:700}.pi-accordion>.container:first-child>.item.yah:first-child>.title:first-child{margin-left:-20px !important}.pi-accordion .item{overflow:hidden}.pi-accordion .title{color:#303030;position:relative;padding:7.5px 10px 7.5px 18px;cursor:pointer;transition:.3s}.pi-accordion .title:hover{color:#3371e3}.pi-accordion a.item>.title{color:#000}.pi-accordion a.item>.title:hover{color:#3371e3}.pi-accordion div.item>.title:before{content:"";position:absolute;top:12px;left:2px;border-style:solid;border-width:5px 0 5px 8px;border-color:transparent transparent transparent #3371e3;transform:rotate(0deg);transition:.3s}.pi-accordion .wrapper{position:relative;width:100%;transition:height .3s}.pi-accordion .content{padding-left:20px;opacity:0;transition:.3s}.pi-accordion .item.on>.title:before{transform:rotate(90deg)}.pi-accordion .item.on>.wrapper>.content{opacity:1}dt{margin-bottom:8px}dd{margin-bottom:16px}.pi-pushmenu{display:none;position:fixed;top:0;width:100%;height:100%;opacity:0;transition:opacity .3s}.pi-pushmenu.on{opacity:1}.pi-pushmenu .overlay{position:fixed;top:0;left:0;width:100%;height:100%;background-color:rgba(0,0,0,0.4)}.pi-pushmenu .sled{position:absolute;top:0;width:0;height:100%;background-color:#fff;overflow:auto;transition:.3s}.pi-pushmenu.on .sled{width:400px;max-width:100vw}.pi-pushmenu .top-bar{height:0;line-height:60px;background-color:#444}.pi-pushmenu ul{margin-top:25px}.pi-pushmenu li{position:relative;display:block;width:100%;min-height:45px;padding:0 60px 0 20px;border-bottom:1px solid #ccc}.pi-pushmenu a{display:inline-block;width:100%;height:45px;line-height:45px;font-family:"Roboto",sans-serif;font-size:20px;color:#3371e3}.pi-pushmenu .button{background:none;padding:0}.pi-pushmenu ul ul{padding:0 20px}.pi-pushmenu ul ul li{min-height:40px}.pi-pushmenu ul ul a{height:40px;line-height:40px;font-size:18px;color:#555}.push-menu-close-button{position:absolute;top:0;right:0;width:50px;height:50px}.push-menu-close-button:before,.push-menu-close-button:after{content:"";position:absolute;top:calc(50% - 1px);left:25%;width:50%;height:2px;background-color:#000}.push-menu-close-button:before{transform:rotate(45deg)}.push-menu-close-button:after{transform:rotate(-45deg)}#docsContent{position:relative;float:right;width:100%}#docsContent *+h2,#docsContent *+h3,#docsContent *+h4,#docsContent *+h5,#docsContent *+h6{margin-top:30px}#docsContent h1,#docsContent h2,#docsContent h3,#docsContent h4,#docsContent h5,#docsContent h6{line-height:normal;font-weight:500;margin-bottom:30px;padding-bottom:10px}#docsContent h1:before,#docsContent h2:before,#docsContent h3:before,#docsContent h4:before,#docsContent h5:before,#docsContent h6:before{display:block;content:" ";margin-top:-100px;height:100px;visibility:hidden}#docsContent h1,#docsContent h2{border-bottom:1px solid #ccc}#docsContent h1{font-size:32px;padding-right:60px}#docsContent h2{font-size:28px}#docsContent h3{font-size:24px;font-weight:300;margin-bottom:5px}#docsContent h4{font-size:20px;margin-bottom:0px}#docsContent h5,#docsContent h6{font-size:16px;font-weight:500}#docsContent p{font-size:16px;font-weight:300;line-height:1.75em}#docsContent p+p{margin-top:10px}#docsContent code{display:inline-block;box-sizing:border-box;background-color:#f7f7f7;color:#303030;font-family:"Roboto Mono",monospace;vertical-align:baseline;font-size:14px;font-weight:bold;padding:2px 4px}#docsContent a code{color:#3371e3;text-decoration:underline}#docsContent pre .pi,#docsContent pre .s{margin:0;padding:0}#docsContent .highlight code span,#docsContent code,#docsContent pre code{font-family:"Roboto Mono",monospace}#docsContent code,#docsContent pre code{color:#303030}#docsContent pre code{padding:0}#docsContent pre{background-color:#f7f7f7;display:block;margin:20px 0;padding:15px;position:relative;overflow-x:auto}#docsContent h1 code,#docsContent h2 code,#docsContent h3 code,#docsContent h4 code,#docsContent h5 code,#docsContent h6 code{font-size:inherit;background-color:transparent}#docsContent .includecode{table-layout:fixed}#docsContent .includecode,#docsContent .includecode th,#docsContent .includecode td{padding:0 !important}#docsContent .includecode th{text-align:right !important;padding:10px !important}#docsContent .includecode th a,#docsContent .includecode th a code{color:#fff !important;background-color:transparent !important}#docsContent .includecode pre{margin:0 !important}#docsContent ul li{list-style:disc}#docsContent ol li{list-style:decimal}#docsContent ul,#docsContent ol{margin:20px 0;padding-left:30px;font-weight:300}#docsContent ul ul,#docsContent ol ol,#docsContent ul ol,#docsContent ol ul{margin:.75em 0}#docsContent li{margin-bottom:.75em;font-size:16px;line-height:1.75em}#docsContent table{width:100%;border:1px solid #ccc;border-spacing:0;margin-top:30px;margin-bottom:30px}#docsContent thead,#docsContent tr:nth-child(even){background-color:#f7f7f7}#docsContent thead{background-color:#555;color:#fff}#docsContent th,#docsContent td{padding:8px;text-align:left;margin:0}#docsContent th{font-weight:normal}#docsContent td{font-size:.85em}#docsContent #editPageButton{position:absolute;top:-25px;right:5px;width:50px;height:50px;line-height:50px;border-radius:50%;white-space:nowrap;text-indent:50px;overflow:hidden;background:#3371e3 url(/images/icon-pencil.svg) no-repeat;background-position:12px 10px;background-size:29px 29px}#docsContent #markdown-toc,#docsContent #TableOfContents{margin-bottom:20px}#docsContent #markdown-toc ul,#docsContent #markdown-toc li,#docsContent #TableOfContents ul,#docsContent #TableOfContents li{list-style:disc;color:#3371e3}#docsContent #markdown-toc ul,#docsContent #TableOfContents ul{padding:0 15px;margin:0}#docsContent #markdown-toc li,#docsContent #TableOfContents li{padding:0;line-height:1.5em;margin-bottom:0}#docsContent #markdown-toc a,#docsContent #TableOfContents a{position:relative;color:#3371e3;font-weight:700}#docsContent img{max-width:100%}#docsContent #TableOfContents>ul>li{list-style:none}#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}html.search #docsContent{position:relative;float:none;width:90%;max-width:850px;margin:0 auto}html.search #docsContent #editPageButton{display:none}html.search #docsContent table{border:0;margin-bottom:0}html.search #docsContent td{padding:0}html.search #docsContent h1{margin-bottom:0;border-bottom:0;padding-bottom:0;padding-left:8px}#home.flip-nav .logo,#home.open-nav .logo{background-image:url(/images/nav_logo2.svg)}#home #hero{margin-bottom:0;padding-bottom:1px}#home #hero main{padding:0 10px;margin-bottom:30px}#home #hero #vendorStrip{display:none}#oceanNodes{padding-top:60px;padding-bottom:60px}#oceanNodes a{color:#3371e3}#oceanNodes main{margin-bottom:60px;min-height:160px}#oceanNodes .image-wrapper{max-width:75%;margin:0 auto 20px;text-align:center}#oceanNodes .image-wrapper img{width:100%;max-width:160px}#oceanNodes main:first-child .image-wrapper{max-width:100%}#oceanNodes main:first-child .image-wrapper img{max-width:491px}#oceanNodes h3{margin-bottom:30px}#video{height:200px}#video{width:100%;position:relative;background-position:center center;background-size:cover}#video>.light-text{display:none;position:absolute;top:50%;left:75%;width:525px;padding-right:80px;transform:translate(-50%, -50%);color:#fff}#video h2{font-size:32px;line-height:44px;margin-bottom:20px}#video p{margin-bottom:20px}#video #desktopKCButton{position:relative;font-size:18px;background-color:#303030;border-radius:8px;color:#fff;padding:20px 10px 20px 10px}#video #desktopShowVideoButton{position:relative;font-size:24px;background-color:#fff;border-radius:8px;color:#3371e3;padding:15px 30px 15px 80px;margin-bottom:15px}#video #desktopShowVideoButton:before{content:"";position:absolute;position:absolute;top:50%;left:40px;transform:translate(-50%, -50%);width:0;height:0;border-style:solid;border-width:10px 0 10px 20px;border-color:transparent transparent transparent #3371e3}#video #mobileShowVideoButton{position:absolute;top:50%;left:50%;transform:translate(-50%, -50%);width:80px;height:80px;border-radius:50%;background-color:transparent;border:5px solid rgba(255,255,255,0.2);overflow:visible}#video #mobileShowVideoButton:after{position:absolute;top:50%;left:50%;transform:translate(-50%, -50%);left:40px;content:"";width:0;height:0;border-style:solid;border-width:20px 0 20px 30px;border-color:transparent transparent transparent #fff}#videoPlayer{position:fixed;top:0;left:0;width:100vw;height:100vh;background-color:rgba(0,0,0,0.9);display:none}#videoPlayer iframe{position:absolute;top:50%;left:50%;transform:translate(-50%, -50%);width:80vw;height:45vw;max-width:142.2222222222vh;max-height:80vh}#videoPlayer #closeButton{position:absolute;top:20px;right:20px;width:50px;height:50px;border:2px solid transparent;transition:.3s}#videoPlayer #closeButton:before,#videoPlayer #closeButton:after{content:"";position:absolute;top:calc(50% - 1px);left:10%;width:80%;height:2px;background-color:#fff}#videoPlayer #closeButton:before{transform:rotate(45deg)}#videoPlayer #closeButton:after{transform:rotate(-45deg)}#videoPlayer #closeButton:hover{border-color:#fff}#cncf{padding-top:60px;padding-bottom:140px;background-image:url(/images/cncf-color.png);background-position:center 100px;background-repeat:no-repeat;background-size:300px}#kubeweekly{background-color:#f7f7f7;padding-top:60px;padding-bottom:140px;background-size:auto;font-family:"Roboto Mono",monospace !important;font-size:24px;font-weight:bold}#kubeweekly h5{font-size:20px}.subscribe-button{border-radius:6px;padding:0 20px;line-height:31px;color:#fff;background-color:blue;text-decoration:none;font-size:14px}#features{padding-top:140px;background-color:#f7f7f7;background-image:url(/images/wheel.png);background-position:center 60px;background-repeat:no-repeat;background-size:auto}.feature-box{width:100%;overflow:hidden;clear:both}.feature-box h4{line-height:normal;margin-bottom:15px}.feature-box>div:first-child{float:left}.feature-box>div:last-child{float:right}#features h3{margin-bottom:20px}#features .feature-box{margin-bottom:0}#features .feature-box>div{width:100%;margin-bottom:40px}#community.open-nav .logo,#community.flip-nav .logo,.gridPage.open-nav .logo,.gridPage.flip-nav .logo{background-image:url(/images/nav_logo2.svg)}#community #hero,.gridPage #hero{padding-bottom:20px}#community #mainContent,.gridPage #mainContent{padding:20px 0}#community #mainContent main,.gridPage #mainContent main{max-width:none}#community #mainContent a,.gridPage #mainContent a{color:#3371e3}#community #mainContent .content,.gridPage #mainContent .content{margin-bottom:30px;padding:30px 0}#community #mainContent .content h1,#community #mainContent .content h2,#community #mainContent .content h3,#community #mainContent .content h4,#community #mainContent .content h5,#community #mainContent .content h6,#community #mainContent .content p,.gridPage #mainContent .content h1,.gridPage #mainContent .content h2,.gridPage #mainContent .content h3,.gridPage #mainContent .content h4,.gridPage #mainContent .content h5,.gridPage #mainContent .content h6,.gridPage #mainContent .content p{line-height:normal;max-width:1200px;padding:0 20px;margin:0 auto 20px}#community #mainContent .content:nth-child(even),.gridPage #mainContent .content:nth-child(even){background-color:#f7f7f7}#community #mainContent .company-logos,.gridPage #mainContent .company-logos{text-align:center;max-width:1200px;margin:0 auto}#community #mainContent .company-logos img,.gridPage #mainContent .company-logos img{width:auto;margin:10px;background-color:#f7f7f7}#community #mainContent .partner-logos,.gridPage #mainContent .partner-logos{text-align:center;max-width:1200px;margin:0 auto}#community #mainContent .partner-logos img,.gridPage #mainContent .partner-logos img{width:auto;margin:10px;background-color:#fff;box-shadow:0 5px 5px rgba(0,0,0,0.24),0 0 5px rgba(0,0,0,0.12)}#community #mainContent #calendarMeetings,.gridPage #mainContent #calendarMeetings{position:relative;width:80vw;height:60vw;max-width:1200px;max-height:900px;margin:20px auto}#community #mainContent #calendarEvents,.gridPage #mainContent #calendarEvents{position:relative;width:80vw;height:30vw;max-width:1200px;max-height:450px;margin:20px auto}#community #mainContent iframe,.gridPage #mainContent iframe{position:absolute;border:0;width:100%;height:100%}.ui-icon{display:inline-block !important}#feature-state-dialog-link{text-decoration:none !important;padding:5px !important}#feature-state-dialog-link a:visited{color:#454545 !important}#feature-state-dialog-link a code{display:inline-block !important;box-sizing:border-box !important;background-color:#f7f7f7 !important;color:#303030 !important;font-family:"Roboto Mono",monospace !important;vertical-align:baseline !important;font-size:14px !important;font-weight:bold !important;padding:0px 4px !important}#feature-state-dialog{background:#fff !important;border:1px solid #ddd !important;padding:.5em 1em !important}#feature-state-dialog ul,#feature-state-dialog li{list-style:disc !important;margin:4px 12px !important}#feature-state-dialog p{margin:8px 0px !important}#feature-state-dialog code{display:inline-block !important;box-sizing:border-box !important;background-color:#f7f7f7 !important;color:#303030 !important;font-family:"Roboto Mono",monospace !important;vertical-align:baseline !important;font-size:14px !important;font-weight:bold !important;padding:0px 4px !important}.ui-dialog{background:#f7f7f7 !important;padding:.5em}.ui-dialog-content{position:relative;float:right;width:100%}.ui-dialog-content *+h2,.ui-dialog-content *+h3,.ui-dialog-content *+h4,.ui-dialog-content *+h5,.ui-dialog-content *+h6{margin-top:30px}.ui-dialog-content h1,.ui-dialog-content h2,.ui-dialog-content h3,.ui-dialog-content h4,.ui-dialog-content h5,.ui-dialog-content h6{line-height:normal;font-weight:500;margin-bottom:30px;padding-bottom:10px}.ui-dialog-content h1:before,.ui-dialog-content h2:before,.ui-dialog-content h3:before,.ui-dialog-content h4:before,.ui-dialog-content h5:before,.ui-dialog-content h6:before{display:block;content:" ";margin-top:-100px;height:100px;visibility:hidden}.ui-dialog-content h1,.ui-dialog-content h2{border-bottom:1px solid #ccc}.ui-dialog-content h1{font-size:32px;padding-right:60px}.ui-dialog-content h2{font-size:28px}.ui-dialog-content h3{font-size:24px;font-weight:300;margin-bottom:5px}.ui-dialog-content h4{font-size:20px;margin-bottom:0px}.ui-dialog-content h5,.ui-dialog-content h6{font-size:16px;font-weight:500}.ui-dialog-content p{font-size:16px;font-weight:300;line-height:1.75em}.ui-dialog-content p+p{margin-top:10px}.ui-dialog-content code{display:inline-block;box-sizing:border-box;background-color:#f7f7f7;color:#303030;font-family:"Roboto Mono",monospace;vertical-align:baseline;font-size:14px;font-weight:bold;padding:2px 4px}.ui-dialog-content a code{color:#3371e3;text-decoration:underline}.ui-dialog-content pre .pi,.ui-dialog-content pre .s{margin:0;padding:0}.ui-dialog-content .highlight code span,.ui-dialog-content code,.ui-dialog-content pre code{font-family:"Roboto Mono",monospace}.ui-dialog-content code,.ui-dialog-content pre code{color:#303030}.ui-dialog-content pre code{padding:0}.ui-dialog-content pre{background-color:#f7f7f7;display:block;margin:20px 0;padding:15px;position:relative;overflow-x:auto}.ui-dialog-content h1 code,.ui-dialog-content h2 code,.ui-dialog-content h3 code,.ui-dialog-content h4 code,.ui-dialog-content h5 code,.ui-dialog-content h6 code{font-family:inherit;font-size:inherit;background-color:transparent}.ui-dialog-content .includecode{table-layout:fixed}.ui-dialog-content .includecode,.ui-dialog-content .includecode th,.ui-dialog-content .includecode td{padding:0 !important}.ui-dialog-content .includecode th{text-align:right !important;padding:10px !important}.ui-dialog-content .includecode th a,.ui-dialog-content .includecode th a code{color:#fff !important;background-color:transparent !important}.ui-dialog-content .includecode pre{margin:0 !important}.ui-dialog-content ul li{list-style:disc}.ui-dialog-content ol li{list-style:decimal}.ui-dialog-content ul,.ui-dialog-content ol{margin:20px 0;padding-left:30px;font-weight:300}.ui-dialog-content ul ul,.ui-dialog-content ol ol,.ui-dialog-content ul ol,.ui-dialog-content ol ul{margin:.75em 0}.ui-dialog-content li{margin-bottom:.75em;font-size:16px;line-height:1.75em}.ui-dialog-content table{width:100%;border:1px solid #ccc;border-spacing:0;margin-top:30px;margin-bottom:30px}.ui-dialog-content thead,.ui-dialog-content tr:nth-child(even){background-color:#f7f7f7}.ui-dialog-content thead{background-color:#555;color:#fff}.ui-dialog-content th,.ui-dialog-content td{padding:8px;text-align:left;margin:0}.ui-dialog-content th{font-weight:normal}.ui-dialog-content td{font-size:.85em}.ui-dialog-content #editPageButton{position:absolute;top:-25px;right:5px;width:50px;height:50px;line-height:50px;border-radius:50%;white-space:nowrap;text-indent:50px;overflow:hidden;background:#3371e3 url(/images/icon-pencil.svg) no-repeat;background-position:12px 10px;background-size:29px 29px}.ui-dialog-content #markdown-toc{margin-bottom:20px}.ui-dialog-content #markdown-toc ul,.ui-dialog-content #markdown-toc li{list-style:disc;color:#3371e3}.ui-dialog-content #markdown-toc ul{padding:0 15px;margin:0}.ui-dialog-content #markdown-toc li{padding:0;line-height:1.5em;margin-bottom:0}.ui-dialog-content #markdown-toc a{position:relative;color:#3371e3;font-weight:700}.ui-dialog-content img{max-width:100%}.ui-dialog-content a{text-decoration:underline}.ui-dialog-buttonpane{background:#f7f7f7 !important}.ui-widget-header{background:transparent !important;background-color:transparent !important;border:0px !important}.ui-tabs ul,.ui-tabs ol,.ui-tabs li{padding:0px !important;list-style:none !important;margin-bottom:0px !important;margin-left:4px !important}.ui-tabs-panel ul li{list-style:disc !important}.ui-tabs-panel ol li{list-style:decimal !important}.ui-widget-content{border:0px !important}.ui-widget-content table{margin:0px !important}.ui-tabs .ui-tabs-panel{border:1px solid #ccc !important}.ui-tabs-anchor{text-decoration:none !important}#talkToUs h3,#talkToUs h4{text-align:center}#talkToUs h3{margin-bottom:15px}#talkToUs h4{line-height:normal;margin-bottom:50px}#talkToUs h4 br{display:none}#talkToUs #bigSocial{overflow:hidden}#talkToUs #bigSocial div{width:100%;float:left;padding:30px;padding-top:110px;background-position:center top;background-size:auto;background-repeat:no-repeat}#talkToUs #bigSocial div:nth-child(1){background-image:url(/images/twitter_icon.png)}#talkToUs #bigSocial div:nth-child(2){background-image:url(/images/github_icon.png)}#talkToUs #bigSocial div:nth-child(3){background-image:url(/images/slack_icon.png)}#talkToUs #bigSocial div:nth-child(4){background-image:url(/images/stackoverflow_icon.png)}#talkToUs #bigSocial div+div{margin-top:20px;margin-left:0}#talkToUs #bigSocial a{display:inline-block;color:#3371e3;font-size:24px;font-weight:400;text-decoration:none;margin-bottom:15px}#talkToUs #bigSocial a,#talkToUs #bigSocial p{text-align:center;width:100%}#home #talkToUs main{padding:30px 0}#home #talkToUs h5{font-size:20px}#home #caseStudiesWrapper{position:relative;text-align:center;margin-bottom:30px}#home #caseStudiesWrapper img{padding-bottom:1rem}#home #caseStudiesWrapper div{position:relative;display:inline-block;vertical-align:top;width:100%;min-height:230px;margin-bottom:60px;padding-right:1rem;background-position:top center}#home #caseStudiesWrapper p{font-size:20px}#home #caseStudiesWrapper a{position:absolute;bottom:-30px;left:50%;transform:translateX(-50%);color:#3371e3;font-weight:400}.cse .gsc-control-cse,.gsc-control-cse{padding:0}.gsc-control-cse table,.gsc-control-cse-en table{margin:0px !important}.gsc-above-wrapper-area{border-bottom:0}#bing-results-container{margin-top:30px;margin-left:20px}.bing-result{margin-bottom:20px}.bing-result-name a{font-size:16px;color:#00c}.bing-result-url{color:green;font-size:13px}.bing-result-snippet{color:#000;font-size:11px}#bing-pagination-container{margin:10px;margin-left:20px}.bing-page-anchor{text-decoration:none !important;cursor:pointer;color:#00c;margin-right:8px}hr{background-color:#999}h2{margin-bottom:15px !important}.subhead{padding-bottom:2% !important;padding-top:0% !important}.details{margin-left:1.9%;padding-right:5%;font-size:16px !important;padding-bottom:2% !important}.section1{margin-bottom:3%}.section1 .cols{width:80% !important;margin-left:6.8%;padding-top:1.5%}.section1 .cols .col1{width:52% !important;font-weight:300 !important}.section1 .cols .col2{width:46% !important}.banner2text{width:63%;padding-top:10%;padding-left:0% !important;float:initial !important;text-align:center;margin:0 auto;position:relative}.banner3text,.banner4text,.banner5text{width:63%;padding-left:0% !important;float:initial !important;text-align:center;margin:0 auto;position:relative}.fullcol{float:initial !important}body footer{background-color:#585858 !important}.section1{float:left !important}.banner1{padding-left:11.9% !important}.banner2{float:initial !important;padding-bottom:2% !important}footer{padding:0% 7%}.banner4,.banner3,.banner5{float:initial !important}@media screen and (max-width: 910px){.banner2text{width:47%;padding-top:45%}.details{margin-left:0%;margin-bottom:3%}.subhead{padding-bottom:0% !important;padding-top:0% !important}.banner3{width:100% !important}}@media screen and (max-width: 780px){.section1 .cols{width:100% !important;margin-left:0%;padding-top:5%}.section1 .cols .col1,.section1 .cols .col2{width:100% !important;margin-left:0% !important}.fullcol{width:90% !important;margin-left:5% !important}.banner1{padding-left:10% !important;margin-bottom:6% !important}.banner2text{padding-top:60% !important;padding-bottom:2% !important}}@media screen and (min-width: 750px){h1{font-size:32px;line-height:40px}h2{font-size:28px;line-height:60px}h3{font-size:24px;line-height:32px}h4{font-size:20px;line-height:40px}h5{font-size:16px;line-height:36px}p{font-size:14px;line-height:22px}section,header,#vendorStrip{padding-left:20px;padding-right:20px}section main,header main,#vendorStrip main{width:100%;max-width:100%}header{height:80px}.nav-buttons{height:80px;line-height:80px}.nav-buttons .button+*{margin-left:30px}#hamburger{width:50px;height:50px}#mainNav{padding:140px 0 30px}#mainNav h5{margin-bottom:1em}#mainNav h3{margin-bottom:.6em}#mainNav .nav-box{width:20%}#mainNav .nav-box+.nav-box{margin-left:calc(20% / 3)}#mainNav main+main{margin-top:60px}#mainNav .left .button{height:50px;line-height:50px;font-size:18px}.open-nav #tryKubernetes,.y-enough #tryKubernetes{margin-left:30px}#hero{padding-top:80px}#docs #hero h1,#docs #hero h5{padding-left:20px;padding-right:20px}#vendorStrip{height:88px;line-height:88px;font-size:16px}p{font-size:16px;line-height:24px;letter-spacing:.1px}h1{font-size:36px;line-height:44px}h3{font-size:28px;line-height:36px}h4{font-size:24px;line-height:40px}#home #viewDocs,#home #tryKubernetes{display:inline-block}#vendorStrip{display:block;text-align:center}#vendorStrip img{max-height:24px;vertical-align:middle;margin:0 30px}#docs #vendorStrip li a{font-size:1em;font-weight:normal}#docs #vendorStrip li li+li{margin-left:60px}#oceanNodes h3{text-align:left;margin-bottom:18px}#oceanNodes main{position:relative;clear:both;display:table;height:160px}#oceanNodes main .content{display:table-cell;position:relative;vertical-align:middle}#oceanNodes main .image-wrapper{position:absolute;top:50%;max-width:25%;max-height:100%;transform:translateY(-50%)}#oceanNodes main:nth-child(odd){padding-right:210px}#oceanNodes main:nth-child(odd) .image-wrapper{right:0}#oceanNodes main:nth-child(even){padding-left:210px}#oceanNodes main:nth-child(even) .image-wrapper{left:0}#oceanNodes main:nth-child(1){padding-right:0}#oceanNodes main:nth-child(1) h3,#oceanNodes main:nth-child(1) p{text-align:center}#oceanNodes main:nth-child(1) .image-wrapper{position:relative;display:block;float:none;max-width:100%;transform:none}#oceanNodes main:nth-child(1) .content{display:block}#oceanNodes main img{width:100%}#video{height:400px;display:block}#video>.light-text{display:block}#mobileShowVideoButton{display:none}#features{padding-bottom:60px}#features .feature-box{margin-bottom:30px}#features .feature-box:last-child{margin-bottom:0}#features h3{margin-bottom:40px}#features .feature-box>div{width:45%;margin-bottom:0}#talkToUs #bigSocial div{width:calc(50% - 15px)}#talkToUs #bigSocial div+div{margin-top:0}#talkToUs #bigSocial div:nth-child(2){margin-left:20px}#talkToUs #bigSocial div:nth-child(3){margin-top:20px}#talkToUs #bigSocial div:nth-child(4){margin-top:20px;margin-left:20px}#talkToUs #bigSocial a{display:inline-block;color:#3371e3;font-weight:400;text-decoration:none}footer nav{text-align:center}footer nav a{width:30%;padding:0 20px}footer .social{text-align:center}footer .social div{display:inline-block}footer .social div:last-child{display:block;margin:0}footer .social span{display:inline-block;margin-right:10px}footer .social input{text-align:left}#home #caseStudiesWrapper div{width:48%}}@media screen and (min-width: 1025px){#hamburger{display:none}ul.global-nav{display:inline-block}#docs #vendorStrip #searchBox:before{top:15px}#vendorStrip{height:44px;line-height:44px}#vendorStrip li a.YAH:after{content:"";display:block;position:absolute;left:0;bottom:0;width:100%;height:4px;background-color:#3371e3}#vendorStrip #searchBox{float:right}#home #hero #vendorStrip{display:block}#docs #hero h1,#docs #hero h5{text-align:left}#docs #hero #vendorStrip ul{float:left}#docs #hero #vendorStrip #searchBox{float:right;width:250px}#docs #hero #vendorStrip #search{vertical-align:middle}#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)}#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}#docsContent{width:calc(100% - 400px)}#docsContent #editPageButton{right:-25px}section main,header main,footer main{max-width:1200px}header,#vendorStrip,#encyclopedia,#hero h1,#hero h5,#docs #hero h1,#docs #hero h5,#community #hero h1,.gridPage #hero h1,#community #hero h5,.gridPage #hero h5{padding-left:100px;padding-right:100px}#vendorStrip{padding-right:10px}#home section main,#home header main,#home footer main{max-width:1000px}#oceanNodes main{position:relative;max-width:830px}#oceanNodes main:nth-child(1){max-width:1000px;padding-right:475px}#oceanNodes main:nth-child(1) h3,#oceanNodes main:nth-child(1) p{text-align:left}#oceanNodes main:nth-child(1) .image-wrapper{position:absolute;max-width:48%;transform:translateY(-50%)}#oceanNodes main:nth-child(1) .image-wrapper img{max-width:425px}#video{height:550px;position:relative;background-position:center center;background-size:cover}#talkToUs h4 br{display:block}#talkToUs #bigSocial div{width:calc(25% - 18px)}#talkToUs #bigSocial div+div{margin-left:20px}footer{width:100%;background-image:url(../images/texture.png);background-color:#303030}footer main{padding:20px 0}footer nav{overflow:hidden;margin-bottom:20px}footer nav a{width:16.65%;float:left;font-size:24px;font-weight:300;white-space:nowrap}footer .social{padding:0 30px;max-width:1200px}footer .social div{float:left}footer .social div:last-child{float:right}#search,#wishField{background-color:transparent;padding:10px;font-size:16px;font-weight:100;color:#fff;border:1px solid #fff;transition:.3s}#search:focus,#wishField:focus{background-color:#f7f7f7;color:#303030}.social a{display:inline-block;background-image:url(../images/social_sprite.png);background-repeat:no-repeat;background-size:auto;width:50px;height:50px;border-radius:5px;margin-right:10px}.social a:hover{background-color:#fff}.social a span{position:absolute;display:block;height:0;overflow:hidden}a.twitter{background-position:0 0}a.twitter:hover{background-position:0 100%}a.stack-overflow{background-position:-50px 0}a.stack-overflow:hover{background-position:-50px 100%}a.slack{background-position:-100px 0}a.slack:hover{background-position:-100px 100%}a.github{background-position:-150px 0}a.github:hover{background-position:-150px 100%}a.mailing-list{background-position:-200px 0}a.mailing-list:hover{background-position:-200px 100%}a.calendar{background-position:-250px 0}a.calendar:hover{background-position:-250px 100%}#community #hero,.gridPage #hero{text-align:left}#community #hero h1,.gridPage #hero h1{padding:20px 100px}#community #tryKubernetes,.gridPage #tryKubernetes{width:auto;background-color:#3371e3;padding:0 20px}#bigSocial div{width:calc(25% - 18px)}#home #caseStudiesWrapper div{width:24%;min-height:260px}}@media screen and (min-width: 1300px){#vendorStrip{padding-right:100px}}@media screen and (min-width: 456px){#vendorStrip li+li{margin-left:20px}} +/*# sourceMappingURL=case-study-styles.css.map */ diff --git a/static/css/case-study-styles.css.map b/static/css/case-study-styles.css.map new file mode 100644 index 0000000000..a4a6e24a6e --- /dev/null +++ b/static/css/case-study-styles.css.map @@ -0,0 +1,7 @@ +{ +"version": 3, +"mappings": "AAAA,SAAU,CACT,MAAM,CAAE,CAAC,CACT,OAAO,CAAE,CAAC,CAGX,YAAa,CACZ,OAAO,CAAE,IAAI,CAEd,MAAM,CACL,MAAM,CAAE,OAAO,CAEhB,KAAM,CACL,UAAU,CAAE,IAAI,CAEjB,EAAE,CACD,MAAM,CAAE,CAAC,CACT,OAAO,CAAE,CAAC,CAEX,CAAC,CACA,eAAe,CAAE,IAAI,CAGtB,MAAM,CACL,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,IAAI,CAEZ,WAAW,CACV,KAAK,CAAE,IAAK,CAEb,MAAM,CACL,KAAK,CAAE,KAAK,CAEb,KAAK,CACJ,KAAK,CAAE,IAAI,CAEZ,OAAO,CACN,UAAU,CAAE,MAAM,CC1BnB,SAAU,CACT,UAAU,CAAE,UAAU,CACtB,WAAW,CANA,mBAAoB,CAO/B,UAAU,CAAE,IAAI,CAChB,MAAM,CAAE,CAAC,CACT,MAAM,CAAE,CAAC,CAEV,IAAI,CACH,WAAW,CAZA,mBAAoB,CAchC,UAAa,CACZ,WAAW,CAAE,GAAG,CAEjB,KAAM,CACL,WAAW,CAAE,GAAG,CDxBjB,SAAU,CACT,MAAM,CAAE,CAAC,CACT,OAAO,CAAE,CAAC,CAGX,YAAa,CACZ,OAAO,CAAE,IAAI,CAEd,MAAM,CACL,MAAM,CAAE,OAAO,CAEhB,KAAM,CACL,UAAU,CAAE,IAAI,CAEjB,EAAE,CACD,MAAM,CAAE,CAAC,CACT,OAAO,CAAE,CAAC,CAEX,CAAC,CACA,eAAe,CAAE,IAAI,CAGtB,MAAM,CACL,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,IAAI,CAEZ,WAAW,CACV,KAAK,CAAE,IAAK,CAEb,MAAM,CACL,KAAK,CAAE,KAAK,CAEb,KAAK,CACJ,KAAK,CAAE,IAAI,CAEZ,OAAO,CACN,UAAU,CAAE,MAAM,CEpCnB,EAAE,CACD,SAAS,CCEK,IAAI,CDDlB,WAAW,CCEK,IAAI,CDArB,EAAE,CACD,SAAS,CCCK,IAAI,CDAlB,WAAW,CCCK,IAAI,CDCrB,EAAE,CACD,SAAS,CCAK,IAAI,CDClB,WAAW,CCAK,IAAI,CDErB,EAAE,CACD,SAAS,CCDK,IAAI,CDElB,WAAW,CCDK,IAAI,CDGrB,EAAE,CACD,SAAS,CCFK,IAAI,CDGlB,WAAW,CCFK,IAAI,CDIrB,CAAC,CACA,SAAS,CCHI,IAAI,CDIjB,WAAW,CCHI,IAAI,CDKpB,2BAA6B,CAC5B,YAAY,CCFS,IAAI,CDGzB,aAAa,CCHQ,IAAI,CDKzB,0CAAI,CACH,KAAK,CCJM,IAAI,CDKf,SAAS,CCJM,IAAI,CDMrB,MAAM,CACL,MAAM,CCLS,IAAI,CDOpB,YAAY,CACX,MAAM,CCRS,IAAI,CDSnB,WAAW,CCTI,IAAI,CDWnB,sBAAW,CACV,WAAW,CCRa,IAAI,CDU9B,UAAU,CACT,KAAK,CCTW,IAAI,CDUpB,MAAM,CCVU,IAAI,CDYrB,QAAQ,CACP,OAAO,CCTW,YAAY,CDW9B,WAAE,CACD,aAAa,CCXa,GAAG,CDa9B,WAAE,CACD,aAAa,CCba,IAAK,CDehC,iBAAQ,CACP,KAAK,CCfS,GAAG,CDiBlB,0BAAmB,CAClB,WAAW,CCjBiB,aAAa,CDmB1C,kBAAW,CACV,UAAU,CCnBuB,IAAI,CDqBtC,sBAAa,CACZ,MAAM,CCrBoB,IAAI,CDsB9B,WAAW,CCtBe,IAAI,CDuB9B,SAAS,CCtBsB,IAAI,CDyBpC,iDAAc,CACb,WAAW,CCvCa,IAAI,CDyC9B,KAAK,CACJ,WAAW,CCzBO,IAAI,CD6BrB,6BAAM,CACL,YAAY,CCxDO,IAAI,CDyDvB,aAAa,CCzDM,IAAI,CD2D1B,YAAY,CACX,MAAM,CC/Be,IAAI,CDgCzB,WAAW,CChCU,IAAI,CDiCzB,SAAS,CChCe,IAAI,CAW7B,IAAI,CACH,gBAAgB,CAAE,IAAK,CAExB,OAAO,CACN,QAAQ,CAAE,QAAQ,CAClB,gBAAgB,CAAE,IAAK,CAGvB,oCAAI,CACH,QAAQ,CAAE,QAAQ,CAClB,MAAM,CAAE,IAAI,CAEd,CAAC,CACA,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAGjB,OAAO,CACN,OAAO,CAAE,YAAY,CACrB,aAAa,CAAE,GAAG,CAClB,OAAO,CAAE,MAAM,CACf,WAAW,CAAE,IAAI,CACjB,KAAK,CAAE,IAAK,CACZ,gBAAgB,CFvFV,OAAO,CEwFb,eAAe,CAAE,IAAI,CAEtB,WAAW,CACV,QAAQ,CAAE,KAAK,CACf,GAAG,CAAE,CAAC,CACN,IAAI,CAAE,CAAC,CACP,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,OAAO,CAAE,IAAI,CAId,MAAM,CACL,QAAQ,CAAE,KAAK,CACf,GAAG,CAAE,CAAC,CACN,IAAI,CAAE,CAAC,CACP,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,IAAI,CACb,gBAAgB,CAAE,WAAW,CAC7B,UAAU,CAAE,iBAAiB,CAC7B,QAAQ,CAAE,MAAM,CAChB,UAAU,CAAE,GAAI,CAChB,UAAU,CAAE,MAAM,CAGnB,KAAK,CACJ,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,KAAK,CACZ,MAAM,CAAE,IAAI,CACZ,GAAG,CAAE,CAAC,CACN,IAAI,CAAE,CAAC,CACP,SAAS,CAAE,IAAI,CACf,gBAAgB,CAAE,yBAAyB,CAC3C,eAAe,CAAE,OAAO,CACxB,mBAAmB,CAAE,aAAa,CAClC,iBAAiB,CAAE,SAAS,CAI5B,oBAAc,CACb,QAAQ,CAAE,KAAK,CACf,GAAG,CAAE,IAAI,CACT,IAAI,CAAE,IAAI,CACV,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,gBAAgB,CAAE,yBAAyB,CAC3C,mBAAmB,CAAE,aAAa,CAClC,iBAAiB,CAAE,SAAS,CAC5B,eAAe,CAAE,IAAI,CACrB,aAAa,CAAE,GAAG,CAClB,UAAU,CAAE,GAAI,CAChB,OAAO,CAAE,KAAK,CAEf,6BAAyB,CACxB,OAAO,CAAE,IAAI,CAEd,WAAK,CACJ,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,IAAI,CACT,IAAI,CAAE,GAAG,CACT,SAAS,CAAE,qBAAqB,CAChC,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,gBAAgB,CAAE,wBAAwB,CAG3C,6BAAyB,CACxB,gBAAgB,CAAE,8BAA8B,CAGlD,YAAY,CACX,KAAK,CAAE,KAAK,CAEb,wBAAyB,CACxB,OAAO,CAAE,IAAI,CAEd,SAAS,CACR,MAAM,CAAE,cAAe,CACvB,gBAAgB,CAAE,WAAW,CAC7B,UAAU,CAAE,GAAI,CAEhB,eAAO,CACN,gBAAgB,CAAE,IAAK,CACvB,KAAK,CF5KK,OAAO,CE8KnB,cAAc,CACb,KAAK,CAAE,CAAC,CACR,OAAO,CAAE,GAAG,CACZ,MAAM,CAAE,qBAAqB,CAC7B,gBAAgB,CAAE,WAAW,CAC7B,UAAU,CAAE,MAAM,CAClB,WAAW,CAAE,MAAM,CACnB,cAAc,CAAE,MAAM,CACtB,QAAQ,CAAE,MAAM,CAChB,UAAU,CAAE,GAAI,CAEjB,UAAU,CACT,OAAO,CAAE,YAAY,CACrB,QAAQ,CAAE,QAAQ,CAClB,cAAc,CAAE,MAAM,CACtB,OAAO,CAAE,CAAC,CACV,MAAM,CAAE,CAAC,CACT,UAAU,CAAE,IAAI,CAEhB,iDAAsB,CACrB,QAAQ,CAAE,QAAQ,CAClB,IAAI,CAAE,GAAG,CACT,KAAK,CAAE,GAAG,CACV,MAAM,CAAE,GAAG,CACX,gBAAgB,CFxMX,OAAO,CEyMZ,UAAU,CAAE,GAAI,CAChB,OAAO,CAAE,EAAE,CAEZ,cAAG,CACF,GAAG,CAAE,eAAe,CAErB,iBAAQ,CACP,GAAG,CAAE,GAAG,CAET,gBAAO,CACN,MAAM,CAAE,GAAG,CAGX,mEAAsB,CACrB,gBAAgB,CAAE,IAAK,CAGzB,WAAE,CACD,KAAK,CF3NA,OAAO,CE4NZ,WAAW,CAAE,MAAM,CAEpB,aAAI,CACH,WAAW,CAAE,MAAM,CACnB,QAAQ,CAAE,MAAM,CAChB,KAAK,CAAE,IAAI,CAEZ,iBAAQ,CACP,KAAK,CAAE,IAAI,CACX,WAAW,CAAE,MAAM,CAGnB,aAAC,CACA,KAAK,CFzOD,OAAO,CE0OX,eAAe,CAAE,IAAI,CAIxB,aAAa,CACZ,OAAO,CAAE,IAAI,CAEb,gBAAE,CACD,OAAO,CAAE,YAAY,CACrB,YAAY,CAAE,IAAI,CAElB,kBAAC,CACA,KAAK,CAAE,IAAI,CACX,WAAW,CAAE,GAAG,CAChB,OAAO,CAAE,CAAC,CACV,QAAQ,CAAE,QAAQ,CAElB,+BAAc,CACb,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,GAAG,CACX,OAAO,CAAE,EAAE,CACX,MAAM,CAAE,IAAI,CACZ,IAAI,CAAE,CAAC,CACP,UAAU,CAAE,IAAI,CAEjB,2BAAQ,CACP,MAAM,CAAE,uBAAuB,CAEjC,mBAAE,CACD,OAAO,CAAE,IAAI,CACb,QAAQ,CAAE,KAAK,CACf,GAAG,CAAE,IAAI,CACT,UAAU,CAAE,IAAI,CAEhB,sBAAE,CACD,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,IAAI,CAEZ,wBAAC,CACA,UAAU,CFhRH,OAAO,CEiRd,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,GAAG,CAGb,mCAAC,CACA,aAAa,CAAE,GAAG,CAGrB,yBAAE,CACD,OAAO,CAAE,KAAK,CAIhB,yDAAkB,CACjB,KAAK,CF/RK,OAAO,CEiSjB,2EAAQ,CACP,MAAM,CAAE,aAAa,CAExB,kCAAkC,CACjC,UAAU,CAAE,IAAI,CAChB,KAAK,CFtSM,OAAO,CEwSnB,mIAAqI,CACpI,UAAU,CF3SJ,OAAO,CE+Sb,gBAAM,CACL,gBAAgB,CAAE,IAAK,CAKxB,cAAI,CACH,QAAQ,CAAE,MAAM,CAEjB,qBAAW,CACV,OAAO,CAAE,KAAK,CACd,OAAO,CAAE,IAAI,CAEd,gBAAM,CACL,gBAAgB,CAAE,OAAO,CACzB,OAAO,CAAE,IAAI,CAGb,wBAAG,CACF,OAAO,CAAE,CAAC,CAEX,sDAAiB,CAChB,IAAI,CAAE,IAAI,CACV,gBAAgB,CAAE,KAAK,CAExB,2BAAQ,CACP,SAAS,CAAE,aAAa,CAEzB,0BAAO,CACN,SAAS,CAAE,cAAc,CAG3B,iDAAc,CACb,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,MAAM,CACf,gBAAgB,CFlVX,OAAO,CEmVZ,YAAY,CFnVP,OAAO,CEuVb,iCAAM,CACL,UAAU,CAAE,iBAAsB,CAEnC,uCAAS,CACR,YAAY,CFzVF,OAAO,CE0VjB,KAAK,CF1VK,OAAO,CE4VjB,mDAAO,CACN,YAAY,CF/VR,OAAO,CEgWX,gBAAgB,CFhWZ,OAAO,CEiWX,KAAK,CAAE,IAAK,CAGb,mMAAsB,CACrB,gBAAgB,CFnWP,OAAO,CEwWnB,KAAK,CACJ,gBAAgB,CAAE,wBAAwB,CAC1C,gBAAgB,CF1WL,OAAO,CE2WlB,UAAU,CAAE,MAAM,CAClB,YAAY,CAAE,CAAC,CACf,aAAa,CAAE,CAAC,CAChB,aAAa,CAAE,CAAC,CAChB,QAAQ,CAAE,QAAQ,CAElB,mBAAe,CACd,OAAO,CAAE,KAAK,CACd,aAAa,CAAE,KAAK,CACpB,MAAM,CAAE,GAAG,CACX,KAAK,CAAE,IAAI,CACX,gBAAgB,CAAE,qBAA0B,CAC5C,OAAO,CAAE,EAAE,CAIX,eAAE,CACD,OAAO,CAAE,IAAI,CAEd,eAAE,CACD,aAAa,CAAE,IAAI,CAEtB,iBAAiB,CAChB,OAAO,CAAE,IAAI,CAGd,YAAY,CACX,QAAQ,CAAE,QAAQ,CAClB,gBAAgB,CAAE,qBAA0B,CAC5C,WAAW,CAAE,GAAG,CAChB,WAAW,CAAE,MAAM,CACnB,UAAU,CAAE,MAAM,CAElB,iBAAI,CACH,KAAK,CAAE,qBAA0B,CAEjC,qBAAK,CACJ,KAAK,CAAE,IAAK,CACZ,QAAQ,CAAE,QAAQ,CAIrB,MAAM,CACL,KAAK,CAAE,IAAI,CACX,gBAAgB,CAAE,wBAAwB,CAC1C,gBAAgB,CFxZL,OAAO,CE0ZlB,WAAI,CACH,OAAO,CAAE,MAAM,CAGf,YAAC,CACA,KAAK,CAAE,IAAI,CACX,UAAU,CAAE,MAAM,CAClB,OAAO,CAAE,YAAY,CACrB,MAAM,CAAE,MAAM,CACd,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAChB,KAAK,CAAE,IAAK,CACZ,eAAe,CAAE,IAAI,CAGvB,cAAO,CACN,MAAM,CAAE,MAAM,CAEd,kBAAG,CACF,UAAU,CAAE,MAAM,CAClB,aAAa,CAAE,IAAI,CAEpB,6BAAc,CACb,MAAM,CAAE,MAAM,CAEf,mBAAI,CACH,OAAO,CAAE,KAAK,CACd,aAAa,CAAE,GAAG,CAEnB,oBAAK,CACJ,UAAU,CAAE,MAAM,CAIrB,kBAAmB,CAClB,gBAAgB,CAAE,WAAW,CAC7B,OAAO,CAAE,IAAI,CACb,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAChB,KAAK,CAAE,IAAK,CACZ,MAAM,CAAE,cAAe,CACvB,UAAU,CAAE,GAAI,CAEhB,8BAAO,CACN,gBAAgB,CFvcL,OAAO,CEwclB,KAAK,CFvcK,OAAO,CEycnB,SAAS,CACR,OAAO,CAAE,YAAY,CACrB,gBAAgB,CAAE,8BAA8B,CAChD,iBAAiB,CAAE,SAAS,CAC5B,eAAe,CAAE,IAAI,CACrB,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,aAAa,CAAE,GAAG,CAClB,YAAY,CAAE,IAAI,CAElB,eAAO,CACN,gBAAgB,CAAE,IAAI,CAEvB,cAAI,CACH,QAAQ,CAAE,QAAQ,CAClB,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,CAAC,CACT,QAAQ,CAAE,MAAM,CAEjB,gBAAQ,CACP,gBAAgB,CAAE,IAAI,CACtB,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CAEZ,sBAAO,CACN,KAAK,CFpeD,OAAO,CEsed,SAAS,CACR,mBAAmB,CAAE,GAAG,CAExB,eAAO,CACN,mBAAmB,CAAE,MAAM,CAE7B,gBAAgB,CACf,mBAAmB,CAAE,OAAO,CAE5B,sBAAO,CACN,mBAAmB,CAAE,UAAU,CAEjC,OAAO,CACN,mBAAmB,CAAE,QAAQ,CAE7B,aAAO,CACN,mBAAmB,CAAE,WAAW,CAElC,QAAQ,CACP,mBAAmB,CAAE,QAAQ,CAE7B,cAAO,CACN,mBAAmB,CAAE,WAAW,CAElC,cAAc,CACb,mBAAmB,CAAE,QAAQ,CAE7B,oBAAO,CACN,mBAAmB,CAAE,WAAW,CAElC,UAAU,CACT,mBAAmB,CAAE,QAAQ,CAE7B,gBAAO,CACN,mBAAmB,CAAE,WAAW,CAElC,SAAS,CACR,OAAO,CAAE,IAAI,CAEd,OAAO,CACN,gBAAgB,CAAE,IAAK,CAExB,KAAK,CACJ,gBAAgB,CF/gBL,OAAO,CEihBlB,QAAE,CACD,MAAM,CAAE,MAAM,CACd,WAAW,CAAE,IAAI,CAEnB,YAAY,CACX,QAAQ,CAAE,QAAQ,CAElB,eAAE,CACD,KAAK,CAAE,IAAI,CAEZ,eAAE,CACD,OAAO,CAAE,YAAY,CACrB,MAAM,CAAE,IAAI,CAEb,cAAC,CACA,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,IAAI,CACZ,KAAK,CAAE,IAAK,CACZ,SAAS,CAAE,KAAM,CACjB,WAAW,CAAE,IAAI,CAElB,kBAAO,CACN,WAAW,CAAE,CAAC,CAIf,kBAAY,CACX,WAAW,CAAE,IAAI,CACjB,SAAS,CAAE,IAAI,CACf,UAAU,CAAE,MAAM,CAElB,qBAAE,CACD,KAAK,CAAE,IAAI,CAEZ,6BAAU,CACT,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,GAAG,CACV,MAAM,CAAE,MAAM,CACd,MAAM,CAAE,IAAI,CACZ,WAAW,CAAE,IAAI,CACjB,QAAQ,CAAE,QAAQ,CAElB,oCAAQ,CACP,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,OAAO,CAAE,EAAE,CACX,KAAK,CAAE,GAAG,CACV,GAAG,CAAE,GAAG,CACR,gBAAgB,CAAE,4BAA4B,CAC9C,iBAAiB,CAAE,SAAS,CAC5B,eAAe,CAAE,SAAS,CAC1B,OAAO,CAAE,CAAC,CAEZ,0BAAO,CACN,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,MAAM,CACf,MAAM,CAAE,IAAI,CACZ,WAAW,CAAE,IAAI,CACjB,SAAS,CAAE,IAAI,CACf,cAAc,CAAE,GAAG,CACnB,UAAU,CAAE,IAAI,CAChB,MAAM,CAAE,IAAI,CACZ,aAAa,CAAE,GAAG,CAClB,QAAQ,CAAE,QAAQ,CAGrB,aAAa,CACZ,QAAQ,CAAE,QAAQ,CAClB,OAAO,CAAE,mBAAmB,CAC5B,QAAQ,CAAE,MAAM,CAChB,SAAS,CAAE,IAAI,CAGf,iBAAO,CACN,MAAM,CAAE,IAAI,CAEd,QAAQ,CACP,QAAQ,CAAE,KAAK,CACf,gBAAgB,CAAE,IAAK,CACvB,GAAG,CAAE,CAAC,CACN,IAAI,CAAE,CAAC,CACP,KAAK,CAAE,CAAC,CACR,MAAM,CAAE,KAAK,CACb,QAAQ,CAAE,MAAM,CAChB,OAAO,CAAE,MAAM,CACf,OAAO,CAAE,MAAM,CACf,UAAU,CAAE,GAAI,CAIf,oBAAU,CACT,gBAAgB,CF/mBN,OAAO,CEgnBjB,WAAW,CAAE,iBAAe,CAC5B,OAAO,CAAE,qBAAqB,CAC9B,WAAW,CAAE,IAAI,CACjB,KAAK,CFpnBD,OAAO,CEunBb,cAAI,CACH,QAAQ,CAAE,MAAM,CAEjB,kBAAQ,CACP,OAAO,CAAE,SAAS,CAClB,KAAK,CAAE,KAAK,CACZ,SAAS,CAAE,KAAK,CAChB,UAAU,CAAE,IAAI,CAGjB,yEAAmE,CAClE,YAAY,CAAE,CAAC,CACf,SAAS,CAAE,KAAK,CAChB,WAAW,CAAE,GAAG,CAEjB,6EAAuE,CACtE,WAAW,CAAE,gBAAgB,CAE9B,mBAAK,CACJ,QAAQ,CAAE,MAAM,CAEjB,oBAAM,CACL,KAAK,CF3oBK,OAAO,CE4oBjB,QAAQ,CAAE,QAAQ,CAClB,OAAO,CAAE,qBAAqB,CAC9B,MAAM,CAAE,OAAO,CACf,UAAU,CAAE,GAAI,CAEhB,0BAAO,CACN,KAAK,CFppBD,OAAO,CEspBb,2BAAe,CACd,KAAK,CAAE,IAAK,CAEZ,iCAAO,CACN,KAAK,CF1pBD,OAAO,CE6pBZ,oCAAQ,CACP,OAAO,CAAE,EAAE,CACX,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,IAAI,CACT,IAAI,CAAE,GAAG,CACT,YAAY,CAAE,KAAK,CACnB,YAAY,CAAE,aAAa,CAC3B,YAAY,CAAE,2CAAyC,CACvD,SAAS,CAAE,YAAY,CACvB,UAAU,CAAE,GAAI,CAElB,sBAAQ,CACP,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,IAAI,CACX,UAAU,CAAE,UAAW,CAExB,sBAAQ,CACP,YAAY,CAAE,IAAI,CAClB,OAAO,CAAE,CAAC,CACV,UAAU,CAAE,GAAI,CAGhB,oCAAiB,CAChB,SAAS,CAAE,aAAa,CAEzB,wCAAuB,CACtB,OAAO,CAAE,CAAC,CAGb,EAAE,CACD,aAAa,CAAE,GAAG,CAEnB,EAAE,CACD,aAAa,CAAE,IAAI,CAEpB,YAAY,CACX,OAAO,CAAE,IAAI,CACb,QAAQ,CAAE,KAAK,CACf,GAAG,CAAE,CAAC,CACN,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,OAAO,CAAE,CAAC,CACV,UAAU,CAAE,WAAY,CAExB,eAAI,CACH,OAAO,CAAE,CAAC,CAEX,qBAAQ,CACP,QAAQ,CAAE,KAAK,CACf,GAAG,CAAE,CAAC,CACN,IAAI,CAAE,CAAC,CACP,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,gBAAgB,CAAE,eAAkB,CAErC,kBAAK,CACJ,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,CAAC,CACN,KAAK,CAAE,CAAC,CACR,MAAM,CAAE,IAAI,CACZ,gBAAgB,CAAE,IAAK,CACvB,QAAQ,CAAE,IAAI,CACd,UAAU,CAAE,GAAI,CAEjB,qBAAU,CACT,KAAK,CAAE,KAAK,CACZ,SAAS,CAAE,KAAK,CAEjB,qBAAQ,CACP,MAAM,CAAE,CAAC,CACT,WAAW,CAAE,IAAI,CACjB,gBAAgB,CAAE,IAAI,CAEvB,eAAE,CACD,UAAU,CAAE,IAAI,CAEjB,eAAE,CACD,QAAQ,CAAE,QAAQ,CAClB,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,IAAI,CACX,UAAU,CAAE,IAAI,CAChB,OAAO,CAAE,aAAa,CACtB,aAAa,CAAE,cAAiB,CAEjC,cAAC,CACA,OAAO,CAAE,YAAY,CACrB,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,WAAW,CAAE,IAAI,CACjB,WAAW,CAAE,mBAAoB,CACjC,SAAS,CAAE,IAAI,CACf,KAAK,CFxvBA,OAAO,CE0vBb,oBAAO,CACN,UAAU,CAAE,IAAI,CAChB,OAAO,CAAE,CAAC,CAEX,kBAAK,CACJ,OAAO,CAAE,MAAM,CAEf,qBAAE,CACD,UAAU,CAAE,IAAI,CAEjB,oBAAC,CACA,MAAM,CAAE,IAAI,CACZ,WAAW,CAAE,IAAI,CACjB,SAAS,CAAE,IAAI,CACf,KAAK,CAAE,IAAqB,CAG/B,uBAAuB,CACtB,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,CAAC,CACN,KAAK,CAAE,CAAC,CACR,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CAEZ,4DAAiB,CAChB,OAAO,CAAE,EAAE,CACX,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,eAAe,CACpB,IAAI,CAAE,GAAG,CACT,KAAK,CAAE,GAAG,CACV,MAAM,CAAE,GAAG,CACX,gBAAgB,CAAE,IAAK,CAExB,8BAAQ,CACP,SAAS,CAAE,aAAa,CAEzB,6BAAO,CACN,SAAS,CAAE,cAAc,CAE3B,YAAY,CACX,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,KAAK,CACZ,KAAK,CAAE,IAAI,CAKX,yFAAsC,CACrC,UAAU,CAAE,IAAI,CAEjB,+FAAsB,CACrB,WAAW,CAAE,MAAM,CACnB,WAAW,CAAE,GAAG,CAChB,aAAa,CAAE,IAAI,CACnB,cAAc,CAAE,IAAI,CAGpB,yIAAQ,CACP,OAAO,CAAE,KAAK,CACd,OAAO,CAAE,GAAG,CACZ,UAAU,CAAE,MAAkB,CAC9B,MAAM,CAhBW,KAAqB,CAiBtC,UAAU,CAAE,MAAM,CAEpB,+BAAK,CACJ,aAAa,CAAE,cAAiB,CAEjC,eAAE,CACD,SAAS,CAAE,IAAI,CACf,aAAa,CAAE,IAAI,CAEpB,eAAE,CACD,SAAS,CAAE,IAAI,CAEhB,eAAE,CACD,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAChB,aAAa,CAAE,GAAG,CAEnB,eAAE,CACD,SAAS,CAAE,IAAI,CACf,aAAa,CAAE,GAAG,CAEnB,+BAAM,CACL,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAEjB,cAAC,CACA,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAChB,WAAW,CAAE,MAAM,CAEpB,gBAAK,CACJ,UAAU,CAAE,IAAI,CAEjB,iBAAI,CACH,OAAO,CAAE,YAAY,CACrB,UAAU,CAAE,UAAU,CACtB,gBAAgB,CF31BL,OAAO,CE41BlB,KAAK,CF31BK,OAAO,CE41BjB,WAAW,CFv1BD,uBAAwB,CEw1BlC,cAAc,CAAE,QAAQ,CACxB,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,IAAI,CACjB,OAAO,CAAE,OAAO,CAEjB,mBAAM,CACL,KAAK,CFr2BA,OAAO,CEs2BZ,eAAe,CAAE,SAAS,CAE3B,wCAAe,CACd,MAAM,CAAE,CAAC,CACT,OAAO,CAAE,CAAC,CAEX,yEAAoC,CACnC,WAAW,CAAE,uBAAwB,CAEtC,uCAAc,CACb,KAAK,CAAE,OAAO,CAEf,qBAAQ,CACP,OAAO,CAAE,CAAC,CAEX,gBAAG,CACF,gBAAgB,CAAE,OAAO,CACzB,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,MAAM,CACd,OAAO,CAAE,IAAI,CACb,QAAQ,CAAE,QAAQ,CAClB,UAAU,CAAE,IAAI,CAEjB,6HAAoD,CACnD,SAAS,CAAE,OAAO,CAClB,gBAAgB,CAAE,WAAW,CAE9B,yBAAY,CACX,YAAY,CAAE,KAAK,CAEpB,mFAA8C,CAC7C,OAAO,CAAE,YAAY,CAEtB,4BAAe,CACd,UAAU,CAAE,gBAAgB,CAC5B,OAAO,CAAE,eAAe,CAEzB,kEAAyC,CACxC,KAAK,CAAE,eAAgB,CACvB,gBAAgB,CAAE,sBAAsB,CAEzC,6BAAgB,CACf,MAAM,CAAE,YAAY,CAErB,kBAAK,CACJ,UAAU,CAAE,IAAI,CAEjB,kBAAK,CACJ,UAAU,CAAE,OAAO,CAEpB,+BAAM,CACL,MAAM,CAAE,MAAM,CACd,YAAY,CAAE,IAAI,CAClB,WAAW,CAAE,GAAG,CAEjB,2EAA0B,CACzB,MAAM,CAAE,OAAQ,CAEjB,eAAE,CACD,aAAa,CAAE,KAAM,CACrB,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,MAAM,CAEpB,kBAAK,CACJ,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,cAAc,CACtB,cAAc,CAAE,CAAC,CACjB,UAAU,CAAE,IAAI,CAChB,aAAa,CAAE,IAAI,CAEpB,kDAAyB,CACxB,gBAAgB,CF56BL,OAAO,CE86BnB,kBAAK,CACJ,gBAAgB,CAAE,IAAI,CACtB,KAAK,CAAE,IAAK,CAEb,+BAAM,CACL,OAAO,CAAE,GAAG,CACZ,UAAU,CAAE,IAAI,CAChB,MAAM,CAAE,CAAC,CAEV,eAAE,CACD,WAAW,CAAE,MAAM,CAEpB,eAAE,CACD,SAAS,CAAE,KAAM,CAElB,4BAAe,CACd,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,KAAK,CACV,KAAK,CAAE,GAAG,CACV,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,WAAW,CAAE,IAAI,CACjB,aAAa,CAAE,GAAG,CAClB,WAAW,CAAE,MAAM,CACnB,WAAW,CAAE,IAAI,CACjB,QAAQ,CAAE,MAAM,CAChB,UAAU,CAAE,8CAA4C,CACxD,mBAAmB,CAAE,SAAS,CAC9B,eAAe,CAAE,SAAS,CAE3B,wDAA+B,CAC9B,aAAa,CAAE,IAAI,CAEnB,6HAAM,CACL,UAAU,CAAE,IAAI,CAChB,KAAK,CFl9BD,OAAO,CEo9BZ,8DAAE,CACD,OAAO,CAAE,MAAM,CACf,MAAM,CAAE,CAAC,CAEV,8DAAE,CACD,OAAO,CAAE,CAAC,CACV,WAAW,CAAE,KAAK,CAClB,aAAa,CAAE,CAAC,CAEjB,4DAAC,CACA,QAAQ,CAAE,QAAQ,CAClB,KAAK,CF/9BD,OAAO,CEg+BX,WAAW,CAAE,GAAG,CAElB,gBAAG,CACF,SAAS,CAAE,IAAI,CAGf,mCAAW,CACV,UAAU,CAAE,IAAI,CAEjB,iEAAM,CACL,UAAU,CAAE,IAAI,CAenB,aAAa,CACZ,QAAQ,CAAE,KAAK,CACf,MAAM,CAAE,CAAC,CAEV,SAAS,CACR,KAAK,CAAE,IAAI,CACX,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,IAAI,CACjB,KAAK,CAAE,IAAI,CAGZ,wBAAwB,CACvB,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,IAAI,CACX,KAAK,CAAE,GAAG,CACV,SAAS,CAAE,KAAK,CAChB,MAAM,CAAE,MAAM,CAEd,wCAAe,CACd,OAAO,CAAE,IAAI,CAEd,8BAAK,CACJ,MAAM,CAAE,CAAC,CACT,aAAa,CAAE,CAAC,CAEjB,2BAAE,CACD,OAAO,CAAE,CAAC,CAEX,2BAAE,CACD,aAAa,CAAE,CAAC,CAChB,aAAa,CAAE,CAAC,CAChB,cAAc,CAAE,CAAC,CACjB,YAAY,CAAE,GAAG,CA0BjB,yCAAK,CACJ,gBAAgB,CAAE,0BAA0B,CAE9C,WAAK,CACJ,aAAa,CAAE,CAAC,CAChB,cAAc,CAAE,GAAG,CAEnB,gBAAI,CACH,OAAO,CAAE,MAAM,CACf,aAAa,CAAE,IAAI,CAEpB,wBAAY,CACX,OAAO,CAAE,IAAI,CAIhB,WAAW,CACV,WAAW,CAnCY,IAAI,CAoC3B,cAAc,CApCS,IAAI,CAsC3B,aAAC,CACA,KAAK,CFxkCA,OAAO,CE0kCb,gBAAI,CACH,aAAa,CA1CS,IAAI,CA2C1B,UAAU,CAAE,KAAK,CAElB,0BAAc,CACb,SAAS,CAAE,GAAG,CACd,MAAM,CAAE,WAAW,CACnB,UAAU,CAAE,MAAM,CAElB,8BAAG,CACF,KAAK,CAAE,IAAI,CACX,SAAS,CAAE,KAAK,CAGjB,2CAAc,CACb,SAAS,CAAE,IAAI,CAEf,+CAAG,CACF,SAAS,CAAE,KAAK,CAEnB,cAAE,CACD,aAAa,CA5DgB,IAAI,CAgEnC,MAAM,CACL,MAAM,CA9DgB,KAAK,CAgE5B,MAAM,CACL,KAAK,CAAE,IAAI,CACX,QAAQ,CAAE,QAAQ,CAClB,mBAAmB,CAAE,aAAa,CAClC,eAAe,CAAE,KAAK,CAGtB,kBAAe,CACd,OAAO,CAAE,IAAI,CACb,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,GAAG,CACR,IAAI,CAAE,GAAG,CACT,KAAK,CAAE,KAAK,CACZ,aAAa,CAAE,IAAI,CACnB,SAAS,CAAE,qBAAqB,CAChC,KAAK,CAAE,IAAK,CAEb,SAAE,CACD,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,IAAI,CACjB,aAAa,CAAE,IAAI,CAEpB,QAAC,CACA,aAAa,CAAE,IAAI,CAEpB,uBAAgB,CACf,QAAQ,CAAE,QAAQ,CAClB,SAAS,CAAE,IAAI,CACf,gBAAgB,CFhoCN,OAAO,CEioCjB,aAAa,CAAE,GAAG,CAClB,KAAK,CFhoCC,IAAO,CEioCb,OAAO,CAAE,mBAAmB,CAE7B,8BAAuB,CACtB,QAAQ,CAAE,QAAQ,CAClB,SAAS,CAAE,IAAI,CACf,gBAAgB,CAAE,IAAK,CACvB,aAAa,CAAE,GAAG,CAClB,KAAK,CF5oCA,OAAO,CE6oCZ,OAAO,CAAE,mBAAmB,CAC5B,aAAa,CAAE,IAAI,CAEnB,qCAAQ,CACP,OAAO,CAAE,EAAE,CACX,QAAQ,CAAE,QAAQ,CHjmCpB,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAFgC,GAAG,CAGtC,IAAI,CGgmCkB,IAAI,CH/lC1B,SAAS,CAAE,qBAAqB,CGgmC9B,KAAK,CAAE,CAAC,CACR,MAAM,CAAE,CAAC,CACT,YAAY,CAAE,KAAK,CACnB,YAAY,CAAE,gBAAgB,CAC9B,YAAY,CAAE,2CAAyC,CAEzD,6BAAsB,CHzmCtB,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAFgC,GAAG,CAGtC,IAAI,CAHoB,GAAG,CAI3B,SAAS,CAAE,qBAAqB,CGwmC/B,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,aAAa,CAAE,GAAG,CAClB,gBAAgB,CAAE,WAAW,CAC7B,MAAM,CAAE,+BAAkC,CAC1C,QAAQ,CAAE,OAAO,CAEjB,mCAAO,CHlnCR,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAFgC,GAAG,CAGtC,IAAI,CAHoB,GAAG,CAI3B,SAAS,CAAE,qBAAqB,CGinC9B,IAAI,CAAE,IAAI,CACV,OAAO,CAAE,EAAE,CACX,KAAK,CAAE,CAAC,CACR,MAAM,CAAE,CAAC,CACT,YAAY,CAAE,KAAK,CACnB,YAAY,CAAE,gBAAgB,CAC9B,YAAY,CAAE,wCAA2C,CAE5D,YAAY,CHpoCX,QAAQ,CAAE,KAAK,CACf,GAAG,CAAE,CAAC,CACN,IAAI,CAAE,CAAC,CACP,KAAK,CAAE,KAAK,CACZ,MAAM,CAAE,KAAK,CGkoCb,gBAAgB,CAAE,eAAkB,CACpC,OAAO,CAAE,IAAI,CAEb,mBAAM,CHjoCN,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAFgC,GAAG,CAGtC,IAAI,CAHoB,GAAG,CAI3B,SAAS,CAAE,qBAAqB,CAIhC,KAAK,CAD4E,IAAI,CAErF,MAAM,CAAE,IAAgD,CACxD,SAAS,CAAE,gBAAiD,CAC5D,UAAU,CAJ6F,IAAI,CG+nC3G,yBAAY,CACX,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,IAAI,CACT,KAAK,CAAE,IAAI,CACX,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,MAAM,CAAE,qBAAqB,CAC7B,UAAU,CAAE,GAAI,CAEhB,gEAAiB,CAChB,OAAO,CAAE,EAAE,CACX,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,eAAe,CACpB,IAAI,CAAE,GAAG,CACT,KAAK,CAAE,GAAG,CACV,MAAM,CAAE,GAAG,CACX,gBAAgB,CAAE,IAAK,CAExB,gCAAQ,CACP,SAAS,CAAE,aAAa,CAEzB,+BAAO,CACN,SAAS,CAAE,cAAc,CAE1B,+BAAO,CACN,YAAY,CAAE,IAAK,CAGtB,KAAK,CACJ,WAAW,CAAE,IAAI,CACjB,cAAc,CAAE,KAAK,CACrB,gBAAgB,CAAE,2BAA2B,CAC7C,mBAAmB,CAAE,YAAY,CACjC,iBAAiB,CAAE,SAAS,CAC5B,eAAe,CAAE,KAAK,CAGvB,WAAW,CACV,gBAAgB,CF3tCJ,OAAO,CE4tCnB,WAAW,CAAE,IAAI,CACjB,cAAc,CAAE,KAAK,CACrB,eAAe,CAAE,IAAI,CACrB,WAAW,CAAE,kCAAmC,CAChD,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,IAAI,CAEjB,cAAE,CACD,SAAS,CAAE,IAAI,CAEjB,iBAAiB,CAChB,aAAa,CAAE,GAAG,CAClB,OAAO,CAAE,MAAM,CACf,WAAW,CAAE,IAAI,CACjB,KAAK,CAAE,IAAK,CACZ,gBAAgB,CAAE,IAAI,CACtB,eAAe,CAAE,IAAI,CACrB,SAAS,CAAE,IAAI,CAGhB,SAAS,CACR,WAAW,CAAE,KAAK,CAClB,gBAAgB,CFlvCJ,OAAO,CEmvCnB,gBAAgB,CAAE,sBAAsB,CACxC,mBAAmB,CAAE,WAAW,CAChC,iBAAiB,CAAE,SAAS,CAC5B,eAAe,CAAE,IAAI,CAEtB,YAAY,CAEX,KAAK,CAAE,IAAI,CACX,QAAQ,CAAE,MAAM,CAChB,KAAK,CAAE,IAAI,CAEX,eAAE,CACD,WAAW,CAAE,MAAM,CACnB,aAAa,CAAE,IAAI,CAEpB,4BAAmB,CAClB,KAAK,CAAE,IAAI,CAEZ,2BAAkB,CACjB,KAAK,CAAE,KAAK,CAGb,YAAE,CACD,aAAa,CAlOa,IAAI,CAoO/B,sBAAY,CACX,aAAa,CAnOa,CAAC,CAqO3B,0BAAO,CACN,KAAK,CAvOgB,IAAI,CAwOzB,aAAa,CAtOgB,IAAI,CA+OlC,qGAAK,CACJ,gBAAgB,CAAE,0BAA0B,CAE9C,gCAAK,CACJ,cAAc,CAAE,IAAI,CAErB,8CAAY,CACX,OAAO,CAAE,MAAM,CAEf,wDAAI,CACH,SAAS,CAAE,IAAI,CAEhB,kDAAC,CACA,KAAK,CFxyCD,OAAO,CE0yCZ,gEAAQ,CACP,aAAa,CAAE,IAAI,CACnB,OAAO,CAAE,MAAM,CAEf,8eAAyB,CACxB,WAAW,CAAE,MAAM,CACnB,SAAS,CAAE,MAAM,CACjB,OAAO,CAAE,MAAM,CACf,MAAM,CAAE,WAAW,CAEpB,gGAAiB,CAChB,gBAAgB,CFpzCP,OAAO,CEszClB,4EAAc,CACb,UAAU,CAAE,MAAM,CAClB,SAAS,CAAE,MAAM,CACjB,MAAM,CAAE,MAAM,CAEd,oFAAG,CACF,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,gBAAgB,CF9zCP,OAAO,CEg0ClB,4EAAc,CACb,UAAU,CAAE,MAAM,CAClB,SAAS,CAAE,MAAM,CACjB,MAAM,CAAE,MAAM,CAEd,oFAAG,CACF,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,gBAAgB,CFr0CZ,IAAO,CEs0CX,UAAU,CAAE,mDAAiD,CAE/D,kFAAiB,CAChB,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,SAAS,CAAE,MAAM,CACjB,UAAU,CAAE,KAAK,CACjB,MAAM,CAAE,SAAS,CAElB,8EAAe,CACd,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,SAAS,CAAE,MAAM,CACjB,UAAU,CAAE,KAAK,CACjB,MAAM,CAAE,SAAS,CAElB,4DAAM,CACL,QAAQ,CAAE,QAAQ,CAClB,MAAM,CAAE,CAAC,CACT,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CAGf,QAAQ,CACP,OAAO,CAAE,uBAAuB,CAEjC,0BAA0B,CACzB,eAAe,CAAE,eAAe,CAChC,OAAO,CAAE,cAAc,CACvB,oCAAS,CACR,KAAK,CAAE,kBAAkB,CAC1B,iCAAM,CACL,OAAO,CAAE,uBAAuB,CAChC,UAAU,CAAE,qBAAqB,CACjC,gBAAgB,CAAE,kBAAkB,CACpC,KAAK,CAAE,kBAAkB,CACzB,WAAW,CAAE,kCAAmC,CAChD,cAAc,CAAE,mBAAmB,CACnC,SAAS,CAAE,eAAe,CAC1B,WAAW,CAAE,eAAe,CAC5B,OAAO,CAAE,kBAAkB,CAE7B,qBAAqB,CACpB,UAAU,CAAE,eAAe,CAC3B,MAAM,CAAE,yBAAyB,CACjC,OAAO,CAAE,mBAAoB,CAE7B,iDAAM,CACL,UAAU,CAAE,eAAe,CAC3B,MAAM,CAAE,mBAAmB,CAE5B,uBAAC,CACA,MAAM,CAAE,kBAAkB,CAE3B,0BAAI,CACH,OAAO,CAAE,uBAAuB,CAChC,UAAU,CAAE,qBAAqB,CACjC,gBAAgB,CAAE,kBAAkB,CACpC,KAAK,CAAE,kBAAkB,CACzB,WAAW,CAAE,kCAAmC,CAChD,cAAc,CAAE,mBAAmB,CACnC,SAAS,CAAE,eAAe,CAC1B,WAAW,CAAE,eAAe,CAC5B,OAAO,CAAE,kBAAkB,CAE7B,UAAU,CACT,UAAU,CAAE,kBAAkB,CAC9B,OAAO,CAAE,IAAK,CAEf,kBAAkB,CACjB,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,KAAK,CACZ,KAAK,CAAE,IAAI,CAKX,uHAAsC,CACrC,UAAU,CAAE,IAAI,CAEjB,mIAAsB,CACrB,WAAW,CAAE,MAAM,CACnB,WAAW,CAAE,GAAG,CAChB,aAAa,CAAE,IAAI,CACnB,cAAc,CAAE,IAAI,CAGpB,6KAAQ,CACP,OAAO,CAAE,KAAK,CACd,OAAO,CAAE,GAAG,CACZ,UAAU,CAAE,MAAkB,CAC9B,MAAM,CAhBW,KAAqB,CAiBtC,UAAU,CAAE,MAAM,CAEpB,2CAAK,CACJ,aAAa,CAAE,cAAiB,CAEjC,qBAAE,CACD,SAAS,CAAE,IAAI,CACf,aAAa,CAAE,IAAI,CAEpB,qBAAE,CACD,SAAS,CAAE,IAAI,CAEhB,qBAAE,CACD,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAChB,aAAa,CAAE,GAAG,CAEnB,qBAAE,CACD,SAAS,CAAE,IAAI,CACf,aAAa,CAAE,GAAG,CAEnB,2CAAM,CACL,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAEjB,oBAAC,CACA,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAChB,WAAW,CAAE,MAAM,CAEpB,sBAAK,CACJ,UAAU,CAAE,IAAI,CAEjB,uBAAI,CACH,OAAO,CAAE,YAAY,CACrB,UAAU,CAAE,UAAU,CACtB,gBAAgB,CF38CL,OAAO,CE48ClB,KAAK,CF38CK,OAAO,CE48CjB,WAAW,CFv8CD,uBAAwB,CEw8ClC,cAAc,CAAE,QAAQ,CACxB,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,IAAI,CACjB,OAAO,CAAE,OAAO,CAEjB,yBAAM,CACL,KAAK,CFr9CA,OAAO,CEs9CZ,eAAe,CAAE,SAAS,CAE3B,oDAAe,CACd,MAAM,CAAE,CAAC,CACT,OAAO,CAAE,CAAC,CAEX,2FAAoC,CACnC,WAAW,CAAE,uBAAwB,CAEtC,mDAAc,CACb,KAAK,CAAE,OAAO,CAEf,2BAAQ,CACP,OAAO,CAAE,CAAC,CAEX,sBAAG,CACF,gBAAgB,CAAE,OAAO,CACzB,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,MAAM,CACd,OAAO,CAAE,IAAI,CACb,QAAQ,CAAE,QAAQ,CAClB,UAAU,CAAE,IAAI,CAEjB,iKAAoD,CACnD,WAAW,CAAE,OAAO,CACpB,SAAS,CAAE,OAAO,CAClB,gBAAgB,CAAE,WAAW,CAE9B,+BAAY,CACX,YAAY,CAAE,KAAK,CAEpB,qGAA8C,CAC7C,OAAO,CAAE,YAAY,CAEtB,kCAAe,CACd,UAAU,CAAE,gBAAgB,CAC5B,OAAO,CAAE,eAAe,CAEzB,8EAAyC,CACxC,KAAK,CAAE,eAAgB,CACvB,gBAAgB,CAAE,sBAAsB,CAEzC,mCAAgB,CACf,MAAM,CAAE,YAAY,CAErB,wBAAK,CACJ,UAAU,CAAE,IAAI,CAEjB,wBAAK,CACJ,UAAU,CAAE,OAAO,CAEpB,2CAAM,CACL,MAAM,CAAE,MAAM,CACd,YAAY,CAAE,IAAI,CAClB,WAAW,CAAE,GAAG,CAEjB,mGAA0B,CACzB,MAAM,CAAE,OAAQ,CAEjB,qBAAE,CACD,aAAa,CAAE,KAAM,CACrB,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,MAAM,CAEpB,wBAAK,CACJ,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,cAAc,CACtB,cAAc,CAAE,CAAC,CACjB,UAAU,CAAE,IAAI,CAChB,aAAa,CAAE,IAAI,CAEpB,8DAAyB,CACxB,gBAAgB,CF7hDL,OAAO,CE+hDnB,wBAAK,CACJ,gBAAgB,CAAE,IAAI,CACtB,KAAK,CAAE,IAAK,CAEb,2CAAM,CACL,OAAO,CAAE,GAAG,CACZ,UAAU,CAAE,IAAI,CAChB,MAAM,CAAE,CAAC,CAEV,qBAAE,CACD,WAAW,CAAE,MAAM,CAEpB,qBAAE,CACD,SAAS,CAAE,KAAM,CAElB,kCAAe,CACd,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,KAAK,CACV,KAAK,CAAE,GAAG,CACV,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,WAAW,CAAE,IAAI,CACjB,aAAa,CAAE,GAAG,CAClB,WAAW,CAAE,MAAM,CACnB,WAAW,CAAE,IAAI,CACjB,QAAQ,CAAE,MAAM,CAChB,UAAU,CAAE,8CAA4C,CACxD,mBAAmB,CAAE,SAAS,CAC9B,eAAe,CAAE,SAAS,CAE3B,gCAAa,CACZ,aAAa,CAAE,IAAI,CAEnB,uEAAM,CACL,UAAU,CAAE,IAAI,CAChB,KAAK,CFnkDD,OAAO,CEqkDZ,mCAAE,CACD,OAAO,CAAE,MAAM,CACf,MAAM,CAAE,CAAC,CAEV,mCAAE,CACD,OAAO,CAAE,CAAC,CACV,WAAW,CAAE,KAAK,CAClB,aAAa,CAAE,CAAC,CAEjB,kCAAC,CACA,QAAQ,CAAE,QAAQ,CAClB,KAAK,CFhlDD,OAAO,CEilDX,WAAW,CAAE,GAAG,CAElB,sBAAG,CACF,SAAS,CAAE,IAAI,CAEhB,oBAAC,CAEA,eAAe,CAAE,SAAS,CAe5B,qBAAqB,CACpB,UAAU,CAAE,kBAAkB,CAG/B,iBAAiB,CAChB,UAAU,CAAE,sBAAsB,CAClC,gBAAgB,CAAE,sBAAsB,CACxC,MAAM,CAAE,cAAc,CAGtB,mCAAU,CACT,OAAO,CAAE,cAAc,CACvB,UAAU,CAAE,eAAe,CAC3B,aAAa,CAAE,cAAc,CAC7B,WAAW,CAAE,cAAc,CAG5B,oBAAK,CACJ,UAAU,CAAE,eAAe,CAE5B,oBAAK,CACJ,UAAU,CAAE,kBAAkB,CAEhC,kBAAkB,CACjB,MAAM,CAAE,cAAc,CAEtB,wBAAK,CACJ,MAAM,CAAE,cAAc,CAExB,uBAAuB,CACtB,MAAM,CAAE,yBAAyB,CAElC,eAAe,CACd,eAAe,CAAE,eAAe,CAIhC,yBAAM,CACL,UAAU,CAAE,MAAM,CAEnB,YAAE,CACD,aAAa,CAAE,IAAI,CAEpB,YAAE,CACD,WAAW,CAAE,MAAM,CACnB,aAAa,CAAE,IAAI,CAEnB,eAAE,CACD,OAAO,CAAE,IAAI,CAEf,oBAAU,CACT,QAAQ,CAAE,MAAM,CAEhB,wBAAG,CACF,KAAK,CAAE,IAAI,CACX,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,IAAI,CACb,WAAW,CAAE,KAAK,CAClB,mBAAmB,CAAE,UAAU,CAC/B,eAAe,CAAE,IAAI,CACrB,iBAAiB,CAAE,SAAS,CAE7B,qCAAgB,CACf,gBAAgB,CAAE,6BAA6B,CAEhD,qCAAgB,CACf,gBAAgB,CAAE,4BAA4B,CAE/C,qCAAgB,CACf,gBAAgB,CAAE,2BAA2B,CAE9C,qCAAgB,CACf,gBAAgB,CAAE,mCAAmC,CAEtD,4BAAS,CACR,UAAU,CAAE,IAAI,CAChB,WAAW,CAAE,CAAC,CAEf,sBAAC,CACA,OAAO,CAAE,YAAY,CACrB,KAAK,CFvrDD,OAAO,CEwrDX,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAChB,eAAe,CAAE,IAAI,CACrB,aAAa,CAAE,IAAI,CAEpB,6CAAI,CACH,UAAU,CAAE,MAAM,CAClB,KAAK,CAAE,IAAI,CAKZ,oBAAI,CACH,OAAO,CAAE,MAAM,CAEhB,kBAAE,CACD,SAAS,CAAE,IAAI,CAGjB,yBAAmB,CAClB,QAAQ,CAAE,QAAQ,CAClB,UAAU,CAAE,MAAM,CAClB,aAAa,CAAE,IAAI,CAEnB,6BAAG,CACF,cAAc,CAAE,IAAI,CAErB,6BAAG,CACF,QAAQ,CAAE,QAAQ,CAClB,OAAO,CAAE,YAAY,CACrB,cAAc,CAAE,GAAG,CACnB,KAAK,CAAE,IAAI,CACX,UAAU,CAAE,KAAK,CACjB,aAAa,CAAE,IAAI,CACnB,aAAa,CAAE,IAAI,CACnB,mBAAmB,CAAE,UAAU,CAEhC,2BAAC,CACA,SAAS,CAAE,IAAI,CAEhB,2BAAC,CACA,QAAQ,CAAE,QAAQ,CAClB,MAAM,CAAE,KAAK,CACb,IAAI,CAAE,GAAG,CACT,SAAS,CAAE,gBAAgB,CAC3B,KAAK,CFruDD,OAAO,CEsuDX,WAAW,CAAE,GAAG,CAKnB,sCAAuC,CACtC,OAAO,CAAE,CAAC,CAGX,gDAAiD,CAChD,MAAM,CAAE,cAAc,CAGvB,uBAAuB,CACtB,aAAa,CAAE,CAAC,CAIjB,uBAAuB,CACtB,UAAU,CAAE,IAAI,CAChB,WAAW,CAAE,IAAI,CAElB,YAAY,CACX,aAAa,CAAE,IAAI,CAEpB,mBAAmB,CAClB,SAAS,CAAE,IAAI,CACf,KAAK,CAAE,IAAO,CAGf,gBAAgB,CACf,KAAK,CAAE,KAAO,CACd,SAAS,CAAE,IAAI,CAEhB,oBAAoB,CACnB,KAAK,CAAE,IAAI,CACX,SAAS,CAAE,IAAI,CAEhB,0BAA0B,CACzB,MAAM,CAAE,IAAI,CACZ,WAAW,CAAE,IAAI,CAElB,iBAAiB,CAChB,eAAe,CAAE,eAAc,CAC/B,MAAM,CAAE,OAAO,CACf,KAAK,CAAE,IAAO,CACd,YAAY,CAAE,GAAG,CClxDlB,EAAE,CACA,gBAAgB,CAAE,IAAO,CAE3B,EAAE,CACA,aAAa,CAAE,eAAe,CAEhC,QAAQ,CACN,cAAc,CAAE,aAAa,CAC7B,WAAW,CAAE,aAAa,CAE5B,QAAQ,CACN,WAAW,CAAE,IAAI,CACjB,aAAa,CAAE,EAAE,CACjB,SAAS,CAAE,eAAe,CAC1B,cAAc,CAAE,aAAa,CAE/B,SAAS,CACP,aAAa,CAAE,EAAE,CACjB,eAAK,CACH,KAAK,CAAE,cAAc,CACrB,WAAW,CAAE,IAAI,CACjB,WAAW,CAAE,IAAI,CACjB,qBAAK,CACH,KAAK,CAAE,cAAc,CACrB,WAAW,CAAE,cAAc,CAC7B,qBAAK,CACH,KAAK,CAAE,cAAc,CAE3B,YAAY,CACV,KAAK,CAAE,GAAG,CACV,WAAW,CAAE,GAAG,CAChB,YAAY,CAAE,aAAa,CAC3B,KAAK,CAAE,kBAAkB,CACzB,UAAU,CAAE,MAAM,CAClB,MAAM,CAAE,MAAM,CACd,QAAQ,CAAE,QAAQ,CAEpB,sCAAwC,CACtC,KAAK,CAAE,GAAG,CACV,YAAY,CAAE,aAAa,CAC3B,KAAK,CAAE,kBAAkB,CACzB,UAAU,CAAE,MAAM,CAClB,MAAM,CAAE,MAAM,CACd,QAAQ,CAAE,QAAQ,CAEpB,QAAQ,CACN,KAAK,CAAE,kBAAkB,CAE3B,WAAW,CACT,gBAAgB,CAAE,kBAAkB,CAEtC,SAAS,CACP,KAAK,CAAE,eAAe,CAExB,QAAQ,CACN,YAAY,CAAE,gBAAgB,CAEhC,QAAQ,CACN,KAAK,CAAE,kBAAkB,CACzB,cAAc,CAAE,aAAa,CAE/B,MAAM,CACJ,OAAO,CAAE,KAAK,CAEhB,0BAA4B,CAC1B,KAAK,CAAE,kBAAkB,CAE3B,oCAAoC,CAClC,YAAY,CACV,KAAK,CAAE,GAAG,CACV,WAAW,CAAE,GAAG,CAClB,QAAQ,CACN,WAAW,CAAE,EAAE,CACf,aAAa,CAAE,EAAE,CACnB,QAAQ,CACN,cAAc,CAAE,aAAa,CAC7B,WAAW,CAAE,aAAa,CAC5B,QAAQ,CACN,KAAK,CAAE,eAAe,EAE1B,oCAAoC,CAClC,eAAe,CACb,KAAK,CAAE,eAAe,CACtB,WAAW,CAAE,EAAE,CACf,WAAW,CAAE,EAAE,CACf,2CAAY,CACV,KAAK,CAAE,eAAe,CACtB,WAAW,CAAE,aAAa,CAC9B,QAAQ,CACN,KAAK,CAAE,cAAc,CACrB,WAAW,CAAE,aAAa,CAC5B,QAAQ,CACN,YAAY,CAAE,cAAc,CAC5B,aAAa,CAAE,aAAa,CAC9B,YAAY,CACV,WAAW,CAAE,cAAc,CAC3B,cAAc,CAAE,aAAa,EC/BjC,oCAAoC,CHnEpC,EAAE,CACD,SAAS,CCEK,IAAI,CDDlB,WAAW,CCEK,IAAI,CDArB,EAAE,CACD,SAAS,CCCK,IAAI,CDAlB,WAAW,CCCK,IAAI,CDCrB,EAAE,CACD,SAAS,CCAK,IAAI,CDClB,WAAW,CCAK,IAAI,CDErB,EAAE,CACD,SAAS,CCDK,IAAI,CDElB,WAAW,CCDK,IAAI,CDGrB,EAAE,CACD,SAAS,CCFK,IAAI,CDGlB,WAAW,CCFK,IAAI,CDIrB,CAAC,CACA,SAAS,CCHI,IAAI,CDIjB,WAAW,CCHI,IAAI,CDKpB,2BAA6B,CAC5B,YAAY,CGJS,IAAI,CHKzB,aAAa,CGLQ,IAAI,CHOzB,0CAAI,CACH,KAAK,CGNM,IAAI,CHOf,SAAS,CGNM,IAAI,CHQrB,MAAM,CACL,MAAM,CGPS,IAAI,CHSpB,YAAY,CACX,MAAM,CGVS,IAAI,CHWnB,WAAW,CGXI,IAAI,CHanB,sBAAW,CACV,WAAW,CGVa,IAAI,CHY9B,UAAU,CACT,KAAK,CGXW,IAAI,CHYpB,MAAM,CGZU,IAAI,CHcrB,QAAQ,CACP,OAAO,CGXW,YAAY,CHa9B,WAAE,CACD,aAAa,CGba,GAAG,CHe9B,WAAE,CACD,aAAa,CGfa,IAAK,CHiBhC,iBAAQ,CACP,KAAK,CGjBS,GAAG,CHmBlB,0BAAmB,CAClB,WAAW,CGnBiB,aAAa,CHqB1C,kBAAW,CACV,UAAU,CGrBuB,IAAI,CHuBtC,sBAAa,CACZ,MAAM,CGvBoB,IAAI,CHwB9B,WAAW,CGxBe,IAAI,CHyB9B,SAAS,CGxBsB,IAAI,CH2BpC,iDAAc,CACb,WAAW,CGzCa,IAAI,CH2C9B,KAAK,CACJ,WAAW,CG3BO,IAAI,CH+BrB,6BAAM,CACL,YAAY,CG1DO,IAAI,CH2DvB,aAAa,CG3DM,IAAI,CH6D1B,YAAY,CACX,MAAM,CC/Be,IAAI,CDgCzB,WAAW,CChCU,IAAI,CDiCzB,SAAS,CGnCe,IAAI,CAoB5B,CAAC,CACA,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,IAAI,CACjB,cAAc,CAAE,IAAK,CAEtB,EAAE,CACD,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,IAAI,CAElB,EAAE,CACD,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,IAAI,CAElB,EAAE,CACD,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,IAAI,CAKjB,oCAAyB,CACxB,OAAO,CAAE,YAAY,CAEvB,YAAY,CACX,OAAO,CAAE,KAAK,CACd,UAAU,CAAE,MAAM,CAElB,gBAAG,CACF,UAAU,CAAE,IAAI,CAChB,cAAc,CAAE,MAAM,CACtB,MAAM,CAAE,MAAM,CAKb,uBAAC,CACA,SAAS,CAAE,GAAG,CACd,WAAW,CAAE,MAAM,CAEpB,2BAAO,CACN,WAAW,CAAE,IAAI,CAIpB,cAAE,CACD,UAAU,CAAE,IAAI,CAChB,aAAa,CAAE,IAAI,CAEpB,gBAAI,CACH,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,KAAK,CAEb,yBAAQ,CACP,OAAO,CAAE,UAAU,CACnB,QAAQ,CAAE,QAAQ,CAClB,cAAc,CAAE,MAAM,CAEvB,+BAAc,CACb,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,GAAG,CACR,SAAS,CAAE,GAAG,CACd,UAAU,CAAE,IAAI,CAChB,SAAS,CAAE,gBAAgB,CAE5B,+BAAgB,CACf,aAAa,CAAE,KAAK,CAEpB,8CAAc,CACb,KAAK,CAAE,CAAC,CAEV,gCAAiB,CAChB,YAAY,CAAE,KAAK,CAEnB,+CAAc,CACb,IAAI,CAAE,CAAC,CAET,6BAAc,CACb,aAAa,CAAE,CAAC,CAEhB,gEAAK,CACJ,UAAU,CAAE,MAAM,CAEnB,4CAAc,CACb,QAAQ,CAAE,QAAQ,CAClB,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,IAAI,CACX,SAAS,CAAE,IAAI,CACf,SAAS,CAAE,IAAI,CAEhB,sCAAQ,CACP,OAAO,CAAE,KAAK,CAEhB,oBAAG,CACF,KAAK,CAAE,IAAI,CAGd,MAAM,CACL,MAAM,CApHe,KAAK,CAqH1B,OAAO,CAAE,KAAK,CAEd,kBAAe,CACd,OAAO,CAAE,KAAK,CAEhB,sBAAsB,CACrB,OAAO,CAAE,IAAI,CAEd,SAAS,CACR,cAAc,CAAE,IAAI,CAEpB,sBAAY,CACX,aAAa,CAAE,IAAI,CAEnB,iCAAY,CACX,aAAa,CAAE,CAAC,CAElB,YAAE,CACD,aAAa,CApIY,IAAI,CAuI7B,0BAAO,CACN,KAAK,CArIe,GAAG,CAsIvB,aAAa,CAvIe,CAAC,CA2I9B,wBAAG,CACF,KAAK,CAAE,gBAAgB,CAExB,4BAAS,CACR,UAAU,CAAE,CAAC,CAEd,qCAAgB,CACf,WAAW,CAAE,IAAI,CAElB,qCAAgB,CACf,UAAU,CAAE,IAAI,CAEjB,qCAAgB,CACf,UAAU,CAAE,IAAI,CAChB,WAAW,CAAE,IAAI,CAElB,sBAAC,CACA,OAAO,CAAE,YAAY,CACrB,KAAK,CJvNF,OAAO,CIwNV,WAAW,CAAE,GAAG,CAChB,eAAe,CAAE,IAAI,CAIvB,UAAG,CACF,UAAU,CAAE,MAAM,CAElB,YAAC,CACA,KAAK,CAAE,GAAG,CACV,OAAO,CAAE,MAAM,CAEjB,cAAO,CACN,UAAU,CAAE,MAAM,CAElB,kBAAG,CACF,OAAO,CAAE,YAAY,CAEtB,6BAAc,CACb,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,CAAC,CAEV,mBAAI,CACH,OAAO,CAAE,YAAY,CACrB,YAAY,CAAE,IAAI,CAEnB,oBAAK,CACJ,UAAU,CAAE,IAAI,CAKlB,6BAAG,CACF,KAAK,CAAE,GAAG,ECrPb,qCAAqC,CACpC,UAAU,CACT,OAAO,CAAE,IAAI,CAEd,aAAa,CACZ,OAAO,CAAE,YAAY,CAEtB,oCAAoC,CACnC,GAAG,CAAE,IAAI,CAEV,YAAY,CACX,MAAM,CAdc,IAAI,CAexB,WAAW,CAfS,IAAI,CAmBtB,2BAAO,CACN,OAAO,CAAE,EAAE,CACX,OAAO,CAAE,KAAK,CACd,QAAQ,CAAE,QAAQ,CAClB,IAAI,CAAE,CAAC,CACP,MAAM,CAAE,CAAC,CACT,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,GAAG,CACX,gBAAgB,CL5Bd,OAAO,CK+BZ,uBAAU,CACT,KAAK,CAAE,KAAK,CAKZ,wBAAY,CACX,OAAO,CAAE,KAAK,CAIf,6BAAM,CACL,UAAU,CAAE,IAAI,CAGhB,2BAAE,CACD,KAAK,CAAE,IAAI,CAEZ,mCAAU,CACT,KAAK,CAAE,KAAK,CACZ,KAAK,CAAE,KAAK,CAEb,gCAAO,CACN,cAAc,CAAE,MAAM,CAEzB,oBAAc,CACb,OAAO,CAAE,IAAI,CAEd,WAAK,CACJ,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,KAAK,CACZ,MAAM,CAAE,IAAI,CACZ,GAAG,CAAE,CAAC,CACN,IAAI,CAAE,CAAC,CACP,SAAS,CAAE,IAAI,CACf,gBAAgB,CAAE,2BAA2B,CAG7C,yCAAK,CACJ,gBAAgB,CAAE,4BAA4B,CAGjD,aAAa,CACZ,OAAO,CAAE,qBAAqB,CAC9B,KAAK,CAAE,IAAI,CAEZ,QAAQ,CACP,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,MAAM,CACf,IAAI,CAAE,CAAC,CACP,KAAK,CAAE,KAAK,CACZ,OAAO,CAAE,IAAI,CAEb,gCAAuB,CACtB,OAAO,CAAE,IAAI,CAEf,YAAY,CACX,KAAK,CAAE,kBAAkB,CAEzB,4BAAe,CACd,KAAK,CAAE,KAAK,CAGb,oCAAI,CACH,SAAS,CAlGK,MAAM,CAoGtB,+JAAwF,CAEvF,YAAY,CAAE,KAAK,CACnB,aAAa,CAAE,KAAK,CAErB,YAAY,CACX,aAAa,CAAE,IAAI,CAIlB,sDAAI,CACH,SAAS,CAAE,MAAM,CAGnB,gBAAI,CACH,QAAQ,CAAE,QAAQ,CAClB,SAAS,CAAE,KAAK,CAEhB,6BAAc,CACb,SAAS,CAAE,MAAM,CACjB,aAAa,CAAE,KAAK,CAEpB,gEAAK,CACJ,UAAU,CAAE,IAAI,CAEjB,4CAAc,CACb,QAAQ,CAAE,QAAQ,CAClB,SAAS,CAAE,GAAG,CACd,SAAS,CAAE,gBAAgB,CAE3B,gDAAG,CACF,SAAS,CAAE,KAAK,CAMrB,MAAM,CACL,MAAM,CAxIe,KAAK,CAyI1B,QAAQ,CAAE,QAAQ,CAClB,mBAAmB,CAAE,aAAa,CAClC,eAAe,CAAE,KAAK,CAMrB,eAAE,CACD,OAAO,CAAE,KAAK,CAGf,wBAAG,CACF,KAAK,CAAE,gBAAgB,CAExB,4BAAS,CACR,WAAW,CAAE,IAAI,CAcpB,MAAM,CACL,KAAK,CAAE,IAAI,CACX,gBAAgB,CAAE,0BAA0B,CAC5C,gBAAgB,CL1KN,OAAO,CK4KjB,WAAI,CACH,OAAO,CAAE,MAAM,CAEhB,UAAG,CACF,QAAQ,CAAE,MAAM,CAChB,aAAa,CAAE,IAAI,CAEnB,YAAC,CACA,KAAK,CAAE,MAAM,CACb,KAAK,CAAE,IAAI,CACX,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAChB,WAAW,CAAE,MAAM,CAErB,cAAO,CACN,OAAO,CAAE,MAAM,CACf,SAAS,CAAE,MAAM,CAEjB,kBAAG,CACF,KAAK,CAAE,IAAI,CAEZ,6BAAc,CACb,KAAK,CAAE,KAAK,CAEf,kBAAmB,CAClB,gBAAgB,CAAE,WAAW,CAC7B,OAAO,CAAE,IAAI,CACb,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAChB,KAAK,CAAE,IAAK,CACZ,MAAM,CAAE,cAAe,CACvB,UAAU,CAAE,GAAI,CAEhB,8BAAO,CACN,gBAAgB,CL/MN,OAAO,CKgNjB,KAAK,CL/MI,OAAO,CKiNlB,SAAS,CACR,OAAO,CAAE,YAAY,CACrB,gBAAgB,CAAE,gCAAgC,CAClD,iBAAiB,CAAE,SAAS,CAC5B,eAAe,CAAE,IAAI,CACrB,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,aAAa,CAAE,GAAG,CAClB,YAAY,CAAE,IAAI,CAElB,eAAO,CACN,gBAAgB,CAAE,IAAI,CAEvB,cAAI,CACH,QAAQ,CAAE,QAAQ,CAClB,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,CAAC,CACT,QAAQ,CAAE,MAAM,CAElB,SAAS,CACR,mBAAmB,CAAE,GAAG,CAExB,eAAO,CACN,mBAAmB,CAAE,MAAM,CAE7B,gBAAgB,CACf,mBAAmB,CAAE,OAAO,CAE5B,sBAAO,CACN,mBAAmB,CAAE,UAAU,CAEjC,OAAO,CACN,mBAAmB,CAAE,QAAQ,CAE7B,aAAO,CACN,mBAAmB,CAAE,WAAW,CAElC,QAAQ,CACP,mBAAmB,CAAE,QAAQ,CAE7B,cAAO,CACN,mBAAmB,CAAE,WAAW,CAElC,cAAc,CACb,mBAAmB,CAAE,QAAQ,CAE7B,oBAAO,CACN,mBAAmB,CAAE,WAAW,CAElC,UAAU,CACT,mBAAmB,CAAE,QAAQ,CAE7B,gBAAO,CACN,mBAAmB,CAAE,WAAW,CA0BjC,gCAAK,CACJ,UAAU,CAAE,IAAI,CAEhB,sCAAE,CACD,OAAO,CAAE,UAAU,CAErB,kDAAc,CACb,KAAK,CAAE,IAAI,CACX,gBAAgB,CL1SZ,OAAO,CK2SX,OAAO,CAAE,MAAM,CAMhB,cAAG,CACF,KAAK,CAAE,gBAAgB,CAIxB,6BAAG,CACF,KAAK,CAAE,GAAG,CACV,UAAU,CAAE,KAAK,EAEpB,qCAAqC,CACpC,YAAY,CACX,aAAa,CAAE,KAAK,EAEtB,oCAAoC,CAElC,kBAAO,CACN,WAAW,CAAE,IAAI", +"sources": ["../../sass/_reset.sass","../../sass/_skin.sass","../../sass/_size.sass","../../sass/_base.sass","../../sass/_case-studies.sass","../../sass/_tablet.sass","../../sass/_desktop.sass"], +"names": [], +"file": "case-study-styles.css" +} diff --git a/static/css/case_study_styles.css b/static/css/case_study_styles.css deleted file mode 100644 index c4aeccd8df..0000000000 --- a/static/css/case_study_styles.css +++ /dev/null @@ -1,943 +0,0 @@ -html, body { margin: 0; padding: 0; } - -input, button { outline: none; } - -button { cursor: pointer; } - -ul, li { list-style: none; } - -ul { margin: 0; padding: 0; } - -a { text-decoration: none; } - -.clear { display: block; clear: both; } - -.light-text { color: white; } - -.right { float: right; } - -.left { float: left; } - -.center { text-align: center; } - -*, .button { box-sizing: border-box; font-family: "Roboto", sans-serif; background: none; margin: 0; border: 0; } - -body { font-family: "Roboto", sans-serif; } - -h1, h2, h5, p { font-weight: 300; } - -h3, h4 { font-weight: 400; } - -html, body { margin: 0; padding: 0; } - -input, button { outline: none; } - -button { cursor: pointer; } - -ul, li { list-style: none; } - -ul { margin: 0; padding: 0; } - -a { text-decoration: none; } - -.clear { display: block; clear: both; } - -.light-text { color: white; } - -.right { float: right; } - -.left { float: left; } - -.center { text-align: center; } - -h1 { font-size: 32px; line-height: 40px; } - -h2 { font-size: 28px; line-height: 60px; } - -h3 { font-size: 24px; line-height: 32px; } - -h4 { font-size: 20px; line-height: 40px; } - -h5 { font-size: 16px; line-height: 36px; } - -p { font-size: 14px; line-height: 22px; } - -section, header, #vendorStrip { padding-left: 20px; padding-right: 20px; } - -section main, header main, #vendorStrip main { width: 100%; max-width: 100%; } - -header { height: 80px; } - -.nav-buttons { height: 80px; line-height: 80px; } - -.nav-buttons .button + * { margin-left: 30px; } - -#hamburger { width: 50px; height: 50px; } - -#mainNav { padding: 140px 0 30px; } - -#mainNav h5 { margin-bottom: 1em; } - -#mainNav h3 { margin-bottom: 0.6em; } - -#mainNav .nav-box { width: 20%; } - -#mainNav .nav-box + .nav-box { margin-left: calc(20% / 3); } - -#mainNav main + main { margin-top: 60px; } - -#mainNav .left .button { height: 50px; line-height: 50px; font-size: 18px; } - -.open-nav #tryKubernetes, .y-enough #tryKubernetes { margin-left: 30px; } - -#hero { padding-top: 80px; } - -#docs #hero h1, #docs #hero h5 { padding-left: 20px; padding-right: 20px; } - -#vendorStrip { height: 88px; line-height: 88px; font-size: 16px; } - -body { background-color: white; } - -section { position: relative; background-color: white; } - -section main, header main, footer main { position: relative; margin: auto; } - -p { font-size: 14px; font-weight: 400; } - -.button { display: inline-block; border-radius: 6px; padding: 0 20px; line-height: 40px; color: white; background-color: #3371e3; text-decoration: none; } - -#cellophane { position: fixed; top: 0; left: 0; width: 100%; height: 100%; display: none; } - -header { position: fixed; top: 0; left: 0; width: 100%; z-index: 8888; background-color: transparent; box-shadow: 0 0 0 transparent; overflow: hidden; transition: 0.3s; text-align: center; } - -.logo { position: relative; float: left; display: block; width: 180px; height: 88px; top: 0; left: 0; transform: none; background-image: url(/images/nav_logo.svg); background-size: contain; background-position: center center; background-repeat: no-repeat; } - -#docs .flyout-button { position: fixed; top: 20px; left: 20px; width: 50px; height: 50px; background-image: url(/images/toc_icon.png); background-position: center center; background-repeat: no-repeat; background-size: auto; border-radius: 50%; transition: 0.3s; z-index: 99999; } - -#docs.open-nav .flyout-button { display: none; } - -#docs .logo { position: absolute; top: 40px; left: 50%; transform: translate(-50%, -50%); display: block; width: 45px; height: 44px; background-image: url(/images/favicon.png); } - -#docs.flip-nav .flyout-button { background-image: url(/images/toc_icon_grey.png); } - -.nav-buttons { float: right; } - -#viewDocs, #tryKubernetes { display: none; } - -#viewDocs { border: 2px solid white; background-color: transparent; transition: 0.3s; } - -#viewDocs:hover { background-color: white; color: #303030; } - -#tryKubernetes { width: 0; padding: 0 0; border: 1px solid transparent; background-color: transparent; text-align: center; white-space: nowrap; vertical-align: middle; overflow: hidden; transition: 0.3s; } - -#hamburger { display: inline-block; position: relative; vertical-align: middle; padding: 0; border: 0; background: none; } - -#hamburger div, #hamburger:before, #hamburger:after { position: absolute; left: 15%; width: 70%; height: 2px; background-color: #3371e3; transition: 0.3s; content: ""; } - -#hamburger div { top: calc(50% - 1px); } - -#hamburger:before { top: 24%; } - -#hamburger:after { bottom: 24%; } - -#hamburger:hover div, #hamburger:hover:before, #hamburger:hover:after { background-color: white; } - -#mainNav h5 { color: #3371e3; font-weight: normal; } - -#mainNav main { white-space: nowrap; overflow: hidden; clear: both; } - -#mainNav .nav-box { float: left; white-space: normal; } - -#mainNav h3 a { color: #3371e3; text-decoration: none; } - -ul.global-nav { display: none; } - -ul.global-nav li { display: inline-block; margin-right: 14px; } - -ul.global-nav li a { color: #fff; font-weight: 400; padding: 0; position: relative; } - -ul.global-nav li a.active:after { position: absolute; width: 100%; height: 2px; content: ''; bottom: -4px; left: 0; background: #fff; } - -ul.global-nav li a .ui-icon { filter: brightness(0) invert(1); } - -ul.global-nav li ul { display: none; position: fixed; top: 40px; text-align: left; } - -ul.global-nav li ul li { display: block; height: 28px; } - -ul.global-nav li ul li a { background: #303030; color: #fff; padding: 7px; } - -ul.global-nav li ul li:last-child a { border-radius: 7px; } - -ul.global-nav li:hover ul { display: block; } - -.flip-nav ul.global-nav li a, .open-nav ul.global-nav li a { color: #303030; } - -.flip-nav ul.global-nav li a .ui-icon { filter: brightness(0); } - -.flip-nav ul.global-nav li ul li a { background: #fff; color: #303030; } - -.flip-nav ul.global-nav li a.active:after, .flip-nav ul.global-nav li ul li a.active:after, .open-nav ul.global-nav li a.active:after { background: #3371e3; } - -.flip-nav header { background-color: white; } - -.open-nav body { overflow: hidden; } - -.open-nav #cellophane { display: block; z-index: 9998; } - -.open-nav header { background-color: #e8e8e8; z-index: 9999; } - -.open-nav #hamburger div { opacity: 0; } - -.open-nav #hamburger:before, .open-nav #hamburger:after { left: 12px; transform-origin: 0 1px; } - -.open-nav #hamburger:before { transform: rotate(45deg); } - -.open-nav #hamburger:after { transform: rotate(-45deg); } - -.open-nav #tryKubernetes, .y-enough #tryKubernetes { width: 150px; background-color: #3371e3; border-color: #3371e3; } - -.flip-nav header, .open-nav header { box-shadow: 0 1px 2px #4c4c4c; } - -.flip-nav #viewDocs, .open-nav #viewDocs { border-color: #303030; color: #303030; } - -.flip-nav #viewDocs:hover, .open-nav #viewDocs:hover { border-color: #3371e3; background-color: #3371e3; color: white; } - -.flip-nav #hamburger:hover div, .flip-nav #hamburger:hover:before, .flip-nav #hamburger:hover:after, .open-nav #hamburger:hover div, .open-nav #hamburger:hover:before, .open-nav #hamburger:hover:after { background-color: #303030; } - -#hero { background-image: url(/images/texture.png); background-color: #303030; text-align: center; padding-left: 0; padding-right: 0; margin-bottom: 0; position: relative; } - -#hero.bot-bar:after { display: block; margin-bottom: -20px; height: 8px; width: 100%; background-color: rgba(255, 255, 255, 0.1); content: ''; } - -#hero.no-sub h5 { display: none; } - -#hero.no-sub h1 { margin-bottom: 20px; } - -#home #hero:after { display: none; } - -#vendorStrip { position: relative; background-color: rgba(255, 255, 255, 0.1); font-weight: 100; white-space: nowrap; text-align: center; } - -#vendorStrip li a { color: rgba(255, 255, 255, 0.5); } - -#vendorStrip li a.YAH { color: white; position: relative; } - -footer { width: 100%; background-image: url(/images/texture.png); background-color: #303030; } - -footer main { padding: 20px 0; } - -footer nav a { width: 100%; text-align: center; display: inline-block; margin: 10px 0; font-size: 24px; font-weight: 300; color: white; text-decoration: none; } - -footer .social { margin: 20px 0; } - -footer .social div { text-align: center; margin-bottom: 20px; } - -footer .social div:last-child { margin: 30px 0; } - -footer .social span { display: block; margin-bottom: 8px; } - -footer .social input { text-align: center; } - -#search, #wishField { background-color: transparent; padding: 10px; font-size: 16px; font-weight: 100; color: white; border: 1px solid white; transition: 0.3s; } - -#search:focus, #wishField:focus { background-color: #f7f7f7; color: #303030; } - -.social a { display: inline-block; background-image: url(/images/social_sprite.png); background-repeat: no-repeat; background-size: auto; width: 50px; height: 50px; border-radius: 5px; margin-right: 10px; } - -.social a:hover { background-color: #fff; } - -.social a span { position: absolute; display: block; height: 0; overflow: hidden; } - -.social a.button { background-image: none; width: auto; height: auto; } - -.social a.button:hover { color: #3371e3; } - -a.twitter { background-position: 0 0; } - -a.twitter:hover { background-position: 0 100%; } - -a.stack-overflow { background-position: -50px 0; } - -a.stack-overflow:hover { background-position: -50px 100%; } - -a.slack { background-position: -100px 0; } - -a.slack:hover { background-position: -100px 100%; } - -a.github { background-position: -150px 0; } - -a.github:hover { background-position: -150px 100%; } - -a.mailing-list { background-position: -200px 0; } - -a.mailing-list:hover { background-position: -200px 100%; } - -a.calendar { background-position: -250px 0; } - -a.calendar:hover { background-position: -250px 100%; } - -#viewDocs { display: none; } - -section { background-color: white; } - -#hero { background-color: #303030; } - -#hero h5 { margin: 20px 0; line-height: 28px; } - -#vendorStrip { position: relative; } - -#vendorStrip ul { float: left; } - -#vendorStrip li { display: inline-block; height: 100%; } - -#vendorStrip a { display: block; height: 100%; color: white; font-size: 0.75em; font-weight: bold; } - -#vendorStrip li + li { margin-left: 0; } - -#docs #vendorStrip { line-height: 44px; } - -#docs #vendorStrip ul { float: none; } - -#docs #vendorStrip #searchBox { float: none; display: block; width: 80%; margin: 0 auto; height: 44px; line-height: 44px; position: relative; } - -#docs #vendorStrip #searchBox:before { position: absolute; width: 15px; height: 15px; content: ''; right: 8px; top: 7px; background-image: url(/images/search-icon.svg); background-repeat: no-repeat; background-size: 100% 100%; z-index: 1; } - -#docs #vendorStrip #search { width: 100%; padding: 0 10px; height: 30px; line-height: 30px; font-size: 16px; vertical-align: top; background: #fff; border: none; border-radius: 4px; position: relative; } - -#encyclopedia { position: relative; padding: 50px 20px 20px 20px; overflow: hidden; font-size: 14px; } - -#encyclopedia > div { height: 100%; } - -#docsToc { position: fixed; background-color: white; top: 0; left: 0; width: 0; height: 100vh; overflow: hidden; padding: 50px 0; z-index: 999999; transition: 0.3s; } - -#docsToc .yah > .title { background-color: #f7f7f7; border-left: 3px solid #3371e3; padding: 7.5px 10px 7.5px 18px; margin-left: -3px; color: #3371e3; } - -.open-toc body { overflow: hidden; } - -.open-toc #docsToc { padding: 50px 20px; width: 400px; max-width: 100vw; overflow-y: auto; } - -.pi-accordion > .container:first-child > .item:first-child > .title:first-child { padding-left: 0; font-size: 1.5em; font-weight: 700; } - -.pi-accordion > .container:first-child > .item.yah:first-child > .title:first-child { margin-left: -20px !important; } - -.pi-accordion .item { overflow: hidden; } - -.pi-accordion .title { color: #303030; position: relative; padding: 7.5px 10px 7.5px 18px; cursor: pointer; transition: 0.3s; } - -.pi-accordion .title:hover { color: #3371e3; } - -.pi-accordion a.item > .title { color: black; } - -.pi-accordion a.item > .title:hover { color: #3371e3; } - -.pi-accordion div.item > .title:before { content: ""; position: absolute; top: 12px; left: 2px; border-style: solid; border-width: 5px 0 5px 8px; border-color: transparent transparent transparent #3371e3; transform: rotate(0deg); transition: 0.3s; } - -.pi-accordion .wrapper { position: relative; width: 100%; transition: height 0.3s; } - -.pi-accordion .content { padding-left: 20px; opacity: 0; transition: 0.3s; } - -.pi-accordion .item.on > .title:before { transform: rotate(90deg); } - -.pi-accordion .item.on > .wrapper > .content { opacity: 1; } - -dt { margin-bottom: 8px; } - -dd { margin-bottom: 16px; } - -.pi-pushmenu { display: none; position: fixed; top: 0; width: 100%; height: 100%; opacity: 0; transition: opacity 0.3s; } - -.pi-pushmenu.on { opacity: 1; } - -.pi-pushmenu .overlay { position: fixed; top: 0; left: 0; width: 100%; height: 100%; background-color: rgba(0, 0, 0, 0.4); } - -.pi-pushmenu .sled { position: absolute; top: 0; width: 0; height: 100%; background-color: white; overflow: auto; transition: 0.3s; } - -.pi-pushmenu.on .sled { width: 400px; max-width: 100vw; } - -.pi-pushmenu .top-bar { height: 0; line-height: 60px; background-color: #444; } - -.pi-pushmenu ul { margin-top: 25px; } - -.pi-pushmenu li { position: relative; display: block; width: 100%; min-height: 45px; padding: 0 60px 0 20px; border-bottom: 1px solid #cccccc; } - -.pi-pushmenu a { display: inline-block; width: 100%; height: 45px; line-height: 45px; font-family: "Roboto", sans-serif; font-size: 20px; color: #3371e3; } - -.pi-pushmenu .button { background: none; padding: 0; } - -.pi-pushmenu ul ul { padding: 0 20px; } - -.pi-pushmenu ul ul li { min-height: 40px; } - -.pi-pushmenu ul ul a { height: 40px; line-height: 40px; font-size: 18px; color: #555555; } - -.push-menu-close-button { position: absolute; top: 0; right: 0; width: 50px; height: 50px; } - -.push-menu-close-button:before, .push-menu-close-button:after { content: ""; position: absolute; top: calc(50% - 1px); left: 25%; width: 50%; height: 2px; background-color: black; } - -.push-menu-close-button:before { transform: rotate(45deg); } - -.push-menu-close-button:after { transform: rotate(-45deg); } - -#docsContent { position: relative; float: right; width: 100%; } - -#docsContent * + h2, #docsContent * + h3, #docsContent * + h4, #docsContent * + h5, #docsContent * + h6 { margin-top: 30px; } - -#docsContent h1, #docsContent h2, #docsContent h3, #docsContent h4, #docsContent h5, #docsContent h6 { line-height: normal; font-weight: 500; margin-bottom: 30px; padding-bottom: 10px; } - -#docsContent h1:before, #docsContent h2:before, #docsContent h3:before, #docsContent h4:before, #docsContent h5:before, #docsContent h6:before { display: block; content: " "; margin-top: -100px; height: 100px; visibility: hidden; } - -#docsContent h1, #docsContent h2 { border-bottom: 1px solid #cccccc; } - -#docsContent h1 { font-size: 32px; padding-right: 60px; } - -#docsContent h2 { font-size: 28px; } - -#docsContent h3 { font-size: 24px; font-weight: 300; margin-bottom: 5px; } - -#docsContent h4 { font-size: 20px; margin-bottom: 0px; } - -#docsContent h5, #docsContent h6 { font-size: 16px; font-weight: 500; } - -#docsContent p { font-size: 16px; font-weight: 300; line-height: 1.75em; } - -#docsContent p + p { margin-top: 10px; } - -#docsContent code { display: inline-block; box-sizing: border-box; background-color: #f7f7f7; color: #303030; font-family: "Roboto Mono", monospace; vertical-align: baseline; font-size: 14px; font-weight: bold; padding: 2px 4px; } - -#docsContent a code { color: #3371e3; text-decoration: underline; } - -#docsContent pre .pi, #docsContent pre .s { margin: 0; padding: 0; } - -#docsContent .highlight code span, #docsContent code, #docsContent pre code { font-family: "Roboto Mono", monospace; } - -#docsContent code, #docsContent pre code { color: #303030; } - -#docsContent pre code { padding: 0; } - -#docsContent pre { background-color: #f7f7f7; display: block; margin: 20px 0; padding: 15px; position: relative; overflow-x: auto; } - -#docsContent h1 code, #docsContent h2 code, #docsContent h3 code, #docsContent h4 code, #docsContent h5 code, #docsContent h6 code { font-family: inherit; font-size: inherit; background-color: transparent; } - -#docsContent .includecode { table-layout: fixed; } - -#docsContent .includecode, #docsContent .includecode th, #docsContent .includecode td { padding: 0 !important; } - -#docsContent .includecode th { text-align: right !important; padding: 10px !important; } - -#docsContent .includecode th a, #docsContent .includecode th a code { color: white !important; background-color: transparent !important; } - -#docsContent .includecode pre { margin: 0 !important; } - -#docsContent ul li { list-style: disc; } - -#docsContent ol li { list-style: decimal; } - -#docsContent ul, #docsContent ol { margin: 20px 0; padding-left: 30px; font-weight: 300; } - -#docsContent ul ul, #docsContent ol ol, #docsContent ul ol, #docsContent ol ul { margin: 0.75em 0; } - -#docsContent li { margin-bottom: 0.75em; font-size: 16px; line-height: 1.75em; } - -#docsContent table { width: 100%; border: 1px solid #ccc; border-spacing: 0; margin-top: 30px; margin-bottom: 30px; } - -#docsContent thead, #docsContent tr:nth-child(even) { background-color: #f7f7f7; } - -#docsContent thead { background-color: #555; color: white; } - -#docsContent th, #docsContent td { padding: 8px; text-align: left; margin: 0; } - -#docsContent th { font-weight: normal; } - -#docsContent td { font-size: 0.85em; } - -#docsContent #editPageButton { position: absolute; top: -25px; right: 5px; width: 50px; height: 50px; line-height: 50px; border-radius: 50%; white-space: nowrap; text-indent: 50px; overflow: hidden; background: #3371e3 url(/images/icon-pencil.svg) no-repeat; background-position: 12px 10px; background-size: 29px 29px; } - -#docsContent #markdown-toc, #docsContent #TableOfContents { margin-bottom: 20px; } - -#docsContent #markdown-toc ul, #docsContent #markdown-toc li, #docsContent #TableOfContents ul, #docsContent #TableOfContents li { list-style: disc; color: #3371e3; } - -#docsContent #markdown-toc ul, #docsContent #TableOfContents ul { padding: 0 15px; margin: 0; } - -#docsContent #markdown-toc li, #docsContent #TableOfContents li { padding: 0; line-height: 1.5em; margin-bottom: 0; } - -#docsContent #markdown-toc a, #docsContent #TableOfContents a { position: relative; color: #3371e3; font-weight: 700; } - -#docsContent img { max-width: 100%; } - -#docsContent a { text-decoration: underline; } - -#docsContent #TableOfContents > ul > li { list-style: none; } - -#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; } - -html.search #docsContent { position: relative; float: none; width: 90%; max-width: 850px; margin: 0 auto; } - -html.search #docsContent #editPageButton { display: none; } - -html.search #docsContent table { border: 0; margin-bottom: 0; } - -html.search #docsContent td { padding: 0; } - -html.search #docsContent h1 { margin-bottom: 0; border-bottom: 0; padding-bottom: 0; padding-left: 8px; } - -#home.flip-nav .logo, #home.open-nav .logo { background-image: url(/images/nav_logo2.svg); } - -#home #hero { margin-bottom: 0; padding-bottom: 1px; } - -#home #hero main { padding: 0 10px; margin-bottom: 30px; } - -#home #hero #vendorStrip { display: none; } - -#oceanNodes { padding-top: 60px; padding-bottom: 60px; } - -#oceanNodes a { color: #3371e3; } - -#oceanNodes main { margin-bottom: 60px; min-height: 160px; } - -#oceanNodes .image-wrapper { max-width: 75%; margin: 0 auto 20px; text-align: center; } - -#oceanNodes .image-wrapper img { width: 100%; max-width: 160px; } - -#oceanNodes main:first-child .image-wrapper { max-width: 100%; } - -#oceanNodes main:first-child .image-wrapper img { max-width: 491px; } - -#oceanNodes h3 { margin-bottom: 30px; } - -#video { height: 200px; } - -#video { width: 100%; position: relative; background-image: url(/images/kub_video_banner_box.jpg); background-position: center center; background-size: cover; } - -#video > .light-text { display: none; position: absolute; top: 50%; left: 75%; width: 525px; padding-right: 80px; transform: translate(-50%, -50%); color: white; } - -#video h2 { font-size: 32px; line-height: 44px; margin-bottom: 20px; } - -#video p { margin-bottom: 20px; } - -#video #desktopKCButton { position: relative; font-size: 18px; background-color: #303030; border-radius: 8px; color: #ffffff; padding: 20px 10px 20px 10px; } - -#video #desktopShowVideoButton { position: relative; font-size: 24px; background-color: white; border-radius: 8px; color: #3371e3; padding: 15px 30px 15px 80px; margin-bottom: 15px; } - -#video #desktopShowVideoButton:before { content: ""; position: absolute; position: absolute; top: 50%; left: 40px; transform: translate(-50%, -50%); width: 0; height: 0; border-style: solid; border-width: 10px 0 10px 20px; border-color: transparent transparent transparent #3371e3; } - -#video #mobileShowVideoButton { position: absolute; top: 50%; left: 50%; transform: translate(-50%, -50%); width: 80px; height: 80px; border-radius: 50%; background-color: transparent; border: 5px solid rgba(255, 255, 255, 0.2); overflow: visible; } - -#video #mobileShowVideoButton:after { position: absolute; top: 50%; left: 50%; transform: translate(-50%, -50%); left: 40px; content: ""; width: 0; height: 0; border-style: solid; border-width: 20px 0 20px 30px; border-color: transparent transparent transparent #ffffff; } - -#videoPlayer { position: fixed; top: 0; left: 0; width: 100vw; height: 100vh; background-color: rgba(0, 0, 0, 0.9); display: none; } - -#videoPlayer iframe { position: absolute; top: 50%; left: 50%; transform: translate(-50%, -50%); width: 80vw; height: 45vw; max-width: 142.22222vh; max-height: 80vh; } - -#videoPlayer #closeButton { position: absolute; top: 20px; right: 20px; width: 50px; height: 50px; border: 2px solid transparent; transition: 0.3s; } - -#videoPlayer #closeButton:before, #videoPlayer #closeButton:after { content: ""; position: absolute; top: calc(50% - 1px); left: 10%; width: 80%; height: 2px; background-color: white; } - -#videoPlayer #closeButton:before { transform: rotate(45deg); } - -#videoPlayer #closeButton:after { transform: rotate(-45deg); } - -#videoPlayer #closeButton:hover { border-color: white; } - -#features { padding-top: 140px; background-color: #f7f7f7; background-image: url(/images/wheel.png); background-position: center 60px; background-repeat: no-repeat; background-size: auto; } - -.feature-box { width: 100%; overflow: hidden; clear: both; } - -.feature-box h4 { line-height: normal; margin-bottom: 15px; } - -.feature-box > div:first-child { float: left; } - -.feature-box > div:last-child { float: right; } - -#features h3 { margin-bottom: 20px; } - -#features .feature-box { margin-bottom: 0; } - -#features .feature-box > div { width: 100%; margin-bottom: 40px; } - -#community.open-nav .logo, #community.flip-nav .logo, .gridPage.open-nav .logo, .gridPage.flip-nav .logo { background-image: url(/images/nav_logo2.svg); } - -#community #hero, .gridPage #hero { padding-bottom: 20px; } - -#community #mainContent, .gridPage #mainContent { padding: 20px 0; } - -#community #mainContent main, .gridPage #mainContent main { max-width: none; } - -#community #mainContent a, .gridPage #mainContent a { color: #3371e3; } - -#community #mainContent .content, .gridPage #mainContent .content { margin-bottom: 30px; padding: 30px 0; } - -#community #mainContent .content h1, #community #mainContent .content h2, #community #mainContent .content h3, #community #mainContent .content h4, #community #mainContent .content h5, #community #mainContent .content h6, #community #mainContent .content p, .gridPage #mainContent .content h1, .gridPage #mainContent .content h2, .gridPage #mainContent .content h3, .gridPage #mainContent .content h4, .gridPage #mainContent .content h5, .gridPage #mainContent .content h6, .gridPage #mainContent .content p { line-height: normal; max-width: 1200px; padding: 0 20px; margin: 0 auto 20px; } - -#community #mainContent .content:nth-child(even), .gridPage #mainContent .content:nth-child(even) { background-color: #f7f7f7; } - -#community #mainContent .company-logos, .gridPage #mainContent .company-logos { text-align: center; max-width: 1200px; margin: 0 auto; } - -#community #mainContent .company-logos img, .gridPage #mainContent .company-logos img { width: auto; margin: 10px; background-color: #f7f7f7; } - -#community #mainContent .partner-logos, .gridPage #mainContent .partner-logos { text-align: center; max-width: 1200px; margin: 0 auto; } - -#community #mainContent .partner-logos img, .gridPage #mainContent .partner-logos img { width: auto; margin: 10px; background-color: #ffffff; box-shadow: 0 5px 5px rgba(0, 0, 0, 0.24), 0 0 5px rgba(0, 0, 0, 0.12); } - -#community #mainContent #calendarMeetings, .gridPage #mainContent #calendarMeetings { position: relative; width: 80vw; height: 60vw; max-width: 1200px; max-height: 900px; margin: 20px auto; } - -#community #mainContent #calendarEvents, .gridPage #mainContent #calendarEvents { position: relative; width: 80vw; height: 30vw; max-width: 1200px; max-height: 450px; margin: 20px auto; } - -#community #mainContent iframe, .gridPage #mainContent iframe { position: absolute; border: 0; width: 100%; height: 100%; } - -.ui-icon { display: inline-block !important; } - -#feature-state-dialog-link { text-decoration: none !important; padding: 5px !important; } - -#feature-state-dialog-link a:visited { color: #454545 !important; } - -#feature-state-dialog-link a code { display: inline-block !important; box-sizing: border-box !important; background-color: #f7f7f7 !important; color: #303030 !important; font-family: "Roboto Mono", monospace !important; vertical-align: baseline !important; font-size: 14px !important; font-weight: bold !important; padding: 0px 4px !important; } - -#feature-state-dialog { background: #fff !important; border: 1px solid #ddd !important; padding: 0.5em 1em !important; } - -#feature-state-dialog ul, #feature-state-dialog li { list-style: disc !important; margin: 4px 12px !important; } - -#feature-state-dialog p { margin: 8px 0px !important; } - -#feature-state-dialog code { display: inline-block !important; box-sizing: border-box !important; background-color: #f7f7f7 !important; color: #303030 !important; font-family: "Roboto Mono", monospace !important; vertical-align: baseline !important; font-size: 14px !important; font-weight: bold !important; padding: 0px 4px !important; } - -.ui-dialog { background: #f7f7f7 !important; padding: 0.5em; } - -.ui-dialog-content { position: relative; float: right; width: 100%; } - -.ui-dialog-content * + h2, .ui-dialog-content * + h3, .ui-dialog-content * + h4, .ui-dialog-content * + h5, .ui-dialog-content * + h6 { margin-top: 30px; } - -.ui-dialog-content h1, .ui-dialog-content h2, .ui-dialog-content h3, .ui-dialog-content h4, .ui-dialog-content h5, .ui-dialog-content h6 { line-height: normal; font-weight: 500; margin-bottom: 30px; padding-bottom: 10px; } - -.ui-dialog-content h1:before, .ui-dialog-content h2:before, .ui-dialog-content h3:before, .ui-dialog-content h4:before, .ui-dialog-content h5:before, .ui-dialog-content h6:before { display: block; content: " "; margin-top: -100px; height: 100px; visibility: hidden; } - -.ui-dialog-content h1, .ui-dialog-content h2 { border-bottom: 1px solid #cccccc; } - -.ui-dialog-content h1 { font-size: 32px; padding-right: 60px; } - -.ui-dialog-content h2 { font-size: 28px; } - -.ui-dialog-content h3 { font-size: 24px; font-weight: 300; margin-bottom: 5px; } - -.ui-dialog-content h4 { font-size: 20px; margin-bottom: 0px; } - -.ui-dialog-content h5, .ui-dialog-content h6 { font-size: 16px; font-weight: 500; } - -.ui-dialog-content p { font-size: 16px; font-weight: 300; line-height: 1.75em; } - -.ui-dialog-content p + p { margin-top: 10px; } - -.ui-dialog-content code { display: inline-block; box-sizing: border-box; background-color: #f7f7f7; color: #303030; font-family: "Roboto Mono", monospace; vertical-align: baseline; font-size: 14px; font-weight: bold; padding: 2px 4px; } - -.ui-dialog-content a code { color: #3371e3; text-decoration: underline; } - -.ui-dialog-content pre .pi, .ui-dialog-content pre .s { margin: 0; padding: 0; } - -.ui-dialog-content .highlight code span, .ui-dialog-content code, .ui-dialog-content pre code { font-family: "Roboto Mono", monospace; } - -.ui-dialog-content code, .ui-dialog-content pre code { color: #303030; } - -.ui-dialog-content pre code { padding: 0; } - -.ui-dialog-content pre { background-color: #f7f7f7; display: block; margin: 20px 0; padding: 15px; position: relative; overflow-x: auto; } - -.ui-dialog-content h1 code, .ui-dialog-content h2 code, .ui-dialog-content h3 code, .ui-dialog-content h4 code, .ui-dialog-content h5 code, .ui-dialog-content h6 code { font-family: inherit; font-size: inherit; background-color: transparent; } - -.ui-dialog-content .includecode { table-layout: fixed; } - -.ui-dialog-content .includecode, .ui-dialog-content .includecode th, .ui-dialog-content .includecode td { padding: 0 !important; } - -.ui-dialog-content .includecode th { text-align: right !important; padding: 10px !important; } - -.ui-dialog-content .includecode th a, .ui-dialog-content .includecode th a code { color: white !important; background-color: transparent !important; } - -.ui-dialog-content .includecode pre { margin: 0 !important; } - -.ui-dialog-content ul li { list-style: disc; } - -.ui-dialog-content ol li { list-style: decimal; } - -.ui-dialog-content ul, .ui-dialog-content ol { margin: 20px 0; padding-left: 30px; font-weight: 300; } - -.ui-dialog-content ul ul, .ui-dialog-content ol ol, .ui-dialog-content ul ol, .ui-dialog-content ol ul { margin: 0.75em 0; } - -.ui-dialog-content li { margin-bottom: 0.75em; font-size: 16px; line-height: 1.75em; } - -.ui-dialog-content table { width: 100%; border: 1px solid #ccc; border-spacing: 0; margin-top: 30px; margin-bottom: 30px; } - -.ui-dialog-content thead, .ui-dialog-content tr:nth-child(even) { background-color: #f7f7f7; } - -.ui-dialog-content thead { background-color: #555; color: white; } - -.ui-dialog-content th, .ui-dialog-content td { padding: 8px; text-align: left; margin: 0; } - -.ui-dialog-content th { font-weight: normal; } - -.ui-dialog-content td { font-size: 0.85em; } - -.ui-dialog-content #editPageButton { position: absolute; top: -25px; right: 5px; width: 50px; height: 50px; line-height: 50px; border-radius: 50%; white-space: nowrap; text-indent: 50px; overflow: hidden; background: #3371e3 url(/images/icon-pencil.svg) no-repeat; background-position: 12px 10px; background-size: 29px 29px; } - -.ui-dialog-content #markdown-toc { margin-bottom: 20px; } - -.ui-dialog-content #markdown-toc ul, .ui-dialog-content #markdown-toc li { list-style: disc; color: #3371e3; } - -.ui-dialog-content #markdown-toc ul { padding: 0 15px; margin: 0; } - -.ui-dialog-content #markdown-toc li { padding: 0; line-height: 1.5em; margin-bottom: 0; } - -.ui-dialog-content #markdown-toc a { position: relative; color: #3371e3; font-weight: 700; } - -.ui-dialog-content img { max-width: 100%; } - -.ui-dialog-content a { text-decoration: underline; } - -.ui-dialog-buttonpane { background: #f7f7f7 !important; } - -.ui-widget-header { background: transparent !important; background-color: transparent !important; border: 0px !important; } - -.ui-tabs ul, .ui-tabs ol, .ui-tabs li { padding: 0px !important; list-style: none !important; margin-bottom: 0px !important; margin-left: 4px !important; } - -.ui-tabs-panel ul li { list-style: disc !important; } - -.ui-tabs-panel ol li { list-style: decimal !important; } - -.ui-widget-content { border: 0px !important; } - -.ui-widget-content table { margin: 0px !important; } - -.ui-tabs .ui-tabs-panel { border: 1px solid #ccc !important; } - -.ui-tabs-anchor { text-decoration: none !important; } - -#talkToUs h3, #talkToUs h4 { text-align: center; } - -#talkToUs h3 { margin-bottom: 15px; } - -#talkToUs h4 { line-height: normal; margin-bottom: 50px; } - -#talkToUs h4 br { display: none; } - -#talkToUs #bigSocial { overflow: hidden; } - -#talkToUs #bigSocial div { width: 100%; float: left; padding: 30px; padding-top: 110px; background-position: center top; background-size: auto; background-repeat: no-repeat; } - -#talkToUs #bigSocial div:nth-child(1) { background-image: url(/images/twitter_icon.png); } - -#talkToUs #bigSocial div:nth-child(2) { background-image: url(/images/github_icon.png); } - -#talkToUs #bigSocial div:nth-child(3) { background-image: url(/images/slack_icon.png); } - -#talkToUs #bigSocial div:nth-child(4) { background-image: url(/images/stackoverflow_icon.png); } - -#talkToUs #bigSocial div + div { margin-top: 20px; margin-left: 0; } - -#talkToUs #bigSocial a { display: inline-block; color: #3371e3; font-size: 24px; font-weight: 400; text-decoration: none; margin-bottom: 15px; } - -#talkToUs #bigSocial a, #talkToUs #bigSocial p { text-align: center; width: 100%; } - -#home #talkToUs main { padding: 30px 0; } - -#home #talkToUs h5 { font-size: 20px; } - -#home #caseStudiesWrapper { position: relative; text-align: center; margin-bottom: 30px; } - -#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/slingtv_logo.png); } - -#home #caseStudiesWrapper div:nth-child(2) { background-image: url(/images/community_logos/workiva_logo.png); } - -#home #caseStudiesWrapper div:nth-child(3) { background-image: url(/images/community_logos/pinterest_logo.png); } - -#home #caseStudiesWrapper div:nth-child(4) { background-image: url(/images/community_logos/pearson_logo.png); } - -#home #caseStudiesWrapper p { font-size: 20px; } - -#home #caseStudiesWrapper a { position: absolute; bottom: 0; left: 50%; transform: translateX(-50%); color: #3371e3; font-weight: 400; } - -/* Google Search */ -.cse .gsc-control-cse, .gsc-control-cse { padding: 0; } - -.gsc-control-cse table, .gsc-control-cse-en table { margin: 0px !important; } - -.gsc-above-wrapper-area { border-bottom: 0; } - -hr { background-color: #999999; } - -h2 { margin-bottom: 15px !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; } - -.section1 { margin-bottom: 3%; } - -.section1 .cols { width: 80% !important; margin-left: 6.8%; padding-top: 1.5%; } - -.section1 .cols .col1 { width: 52% !important; font-weight: 300 !important; } - -.section1 .cols .col2 { width: 46% !important; } - -.banner2text { width: 63%; padding-top: 10%; padding-left: 0% !important; float: initial !important; text-align: center; margin: 0 auto; position: relative; } - -.banner3text, .banner4text, .banner5text { width: 63%; padding-left: 0% !important; float: initial !important; text-align: center; margin: 0 auto; position: relative; } - -.fullcol { float: initial !important; } - -body footer { background-color: #585858 !important; } - -.section1 { float: left !important; } - -.banner1 { padding-left: 11.9% !important; } - -.banner2 { float: initial !important; padding-bottom: 2% !important; } - -footer { padding: 0% 7%; } - -.banner4, .banner3, .banner5 { float: initial !important; } - -@media screen and (max-width: 910px) { .banner2text { width: 47%; padding-top: 45%; } - .details { margin-left: 0%; margin-bottom: 3%; } - .subhead { padding-bottom: 0% !important; padding-top: 0% !important; } - .banner3 { width: 100% !important; } } - -@media screen and (max-width: 780px) { .section1 .cols { width: 100% !important; margin-left: 0%; padding-top: 5%; } - .section1 .cols .col1, .section1 .cols .col2 { width: 100% !important; margin-left: 0% !important; } - .fullcol { width: 90% !important; margin-left: 5% !important; } - .banner1 { padding-left: 10% !important; margin-bottom: 6% !important; } - .banner2text { padding-top: 60% !important; padding-bottom: 2% !important; } } - -@media screen and (min-width: 750px) { h1 { font-size: 32px; line-height: 40px; } - h2 { font-size: 28px; line-height: 60px; } - h3 { font-size: 24px; line-height: 32px; } - h4 { font-size: 20px; line-height: 40px; } - h5 { font-size: 16px; line-height: 36px; } - p { font-size: 14px; line-height: 22px; } - section, header, #vendorStrip { padding-left: 20px; padding-right: 20px; } - section main, header main, #vendorStrip main { width: 100%; max-width: 100%; } - header { height: 80px; } - .nav-buttons { height: 80px; line-height: 80px; } - .nav-buttons .button + * { margin-left: 30px; } - #hamburger { width: 50px; height: 50px; } - #mainNav { padding: 140px 0 30px; } - #mainNav h5 { margin-bottom: 1em; } - #mainNav h3 { margin-bottom: 0.6em; } - #mainNav .nav-box { width: 20%; } - #mainNav .nav-box + .nav-box { margin-left: calc(20% / 3); } - #mainNav main + main { margin-top: 60px; } - #mainNav .left .button { height: 50px; line-height: 50px; font-size: 18px; } - .open-nav #tryKubernetes, .y-enough #tryKubernetes { margin-left: 30px; } - #hero { padding-top: 80px; } - #docs #hero h1, #docs #hero h5 { padding-left: 20px; padding-right: 20px; } - #vendorStrip { height: 88px; line-height: 88px; font-size: 16px; } - p { font-size: 16px; line-height: 24px; letter-spacing: 0.1px; } - h1 { font-size: 36px; line-height: 44px; } - h3 { font-size: 28px; line-height: 36px; } - h4 { font-size: 24px; line-height: 40px; } - #home #viewDocs, #home #tryKubernetes { display: inline-block; } - #vendorStrip { display: block; text-align: center; } - #vendorStrip img { max-height: 24px; vertical-align: middle; margin: 0 30px; } - #docs #vendorStrip li a { font-size: 1em; font-weight: normal; } - #docs #vendorStrip li li + li { margin-left: 60px; } - #oceanNodes h3 { text-align: left; margin-bottom: 18px; } - #oceanNodes main { position: relative; clear: both; display: table; } - #oceanNodes main .content { display: table-cell; position: relative; vertical-align: middle; } - #oceanNodes main .image-wrapper { position: absolute; top: 50%; max-width: 25%; max-height: 100%; transform: translateY(-50%); } - #oceanNodes main:nth-child(odd) { padding-right: 210px; } - #oceanNodes main:nth-child(odd) .image-wrapper { right: 0; } - #oceanNodes main:nth-child(even) { padding-left: 210px; } - #oceanNodes main:nth-child(even) .image-wrapper { left: 0; } - #oceanNodes main:nth-child(1) { padding-right: 0; } - #oceanNodes main:nth-child(1) h3, #oceanNodes main:nth-child(1) p { text-align: center; } - #oceanNodes main:nth-child(1) .image-wrapper { position: relative; display: block; float: none; max-width: 100%; transform: none; } - #oceanNodes main:nth-child(1) .content { display: block; } - #oceanNodes main img { width: 100%; } - #video { height: 400px; display: block; } - #video > .light-text { display: block; } - #mobileShowVideoButton { display: none; } - #features { padding-bottom: 60px; } - #features .feature-box { margin-bottom: 30px; } - #features .feature-box:last-child { margin-bottom: 0; } - #features h3 { margin-bottom: 40px; } - #features .feature-box > div { width: 45%; margin-bottom: 0; } - #talkToUs #bigSocial div { width: calc(50% - 15px); } - #talkToUs #bigSocial div + div { margin-top: 0; } - #talkToUs #bigSocial div:nth-child(2) { margin-left: 20px; } - #talkToUs #bigSocial div:nth-child(3) { margin-top: 20px; } - #talkToUs #bigSocial div:nth-child(4) { margin-top: 20px; margin-left: 20px; } - #talkToUs #bigSocial a { display: inline-block; color: #3371e3; font-weight: 400; text-decoration: none; } - footer nav { text-align: center; } - footer nav a { width: 30%; padding: 0 20px; } - footer .social { text-align: center; } - footer .social div { display: inline-block; } - footer .social div:last-child { display: block; margin: 0; } - footer .social span { display: inline-block; margin-right: 10px; } - footer .social input { text-align: left; } - #home #caseStudiesWrapper div { width: 48%; } } - -@media screen and (min-width: 1025px) { #hamburger { display: none; } - ul.global-nav { display: inline-block; } - #docs #vendorStrip #searchBox:before { top: 15px; } - #vendorStrip { height: 44px; line-height: 44px; } - #vendorStrip li a.YAH:after { content: ""; display: block; position: absolute; left: 0; bottom: 0; width: 100%; height: 4px; background-color: #3371e3; } - #vendorStrip #searchBox { float: right; } - #home #hero #vendorStrip { display: block; } - #docs #hero h1, #docs #hero h5 { text-align: left; } - #docs #hero #vendorStrip ul { float: left; } - #docs #hero #vendorStrip #searchBox { float: right; width: 250px; } - #docs #hero #vendorStrip #search { vertical-align: middle; } - #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); } - #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; } - #docsContent { width: calc(100% - 400px); } - #docsContent #editPageButton { right: -25px; } - section main, header main, footer main { max-width: 1200px; } - header, #vendorStrip, #encyclopedia, #hero h1, #hero h5, #docs #hero h1, #docs #hero h5, #community #hero h1, .gridPage #hero h1, #community #hero h5, .gridPage #hero h5 { padding-left: 100px; padding-right: 100px; } - #vendorStrip { padding-right: 10px; } - #home section main, #home header main, #home footer main { max-width: 1000px; } - #oceanNodes main { position: relative; max-width: 830px; } - #oceanNodes main:nth-child(1) { max-width: 1000px; padding-right: 475px; } - #oceanNodes main:nth-child(1) h3, #oceanNodes main:nth-child(1) p { text-align: left; } - #oceanNodes main:nth-child(1) .image-wrapper { position: absolute; max-width: 48%; transform: translateY(-50%); } - #oceanNodes main:nth-child(1) .image-wrapper img { max-width: 425px; } - #video { height: 550px; position: relative; background-image: url(../images/kub_video_banner_box.jpg); background-position: center center; background-size: cover; } - #talkToUs h4 br { display: block; } - #talkToUs #bigSocial div { width: calc(25% - 18px); } - #talkToUs #bigSocial div + div { margin-left: 20px; } - footer { width: 100%; background-image: url(../images/texture.png); background-color: #303030; } - footer main { padding: 20px 0; } - footer nav { overflow: hidden; margin-bottom: 20px; } - footer nav a { width: 16.65%; float: left; font-size: 24px; font-weight: 300; white-space: nowrap; } - footer .social { padding: 0 30px; max-width: 1200px; } - footer .social div { float: left; } - footer .social div:last-child { float: right; } - #search, #wishField { background-color: transparent; padding: 10px; font-size: 16px; font-weight: 100; color: white; border: 1px solid white; transition: 0.3s; } - #search:focus, #wishField:focus { background-color: #f7f7f7; color: #303030; } - .social a { display: inline-block; background-image: url(../images/social_sprite.png); background-repeat: no-repeat; background-size: auto; width: 50px; height: 50px; border-radius: 5px; margin-right: 10px; } - .social a:hover { background-color: #fff; } - .social a span { position: absolute; display: block; height: 0; overflow: hidden; } - a.twitter { background-position: 0 0; } - a.twitter:hover { background-position: 0 100%; } - a.stack-overflow { background-position: -50px 0; } - a.stack-overflow:hover { background-position: -50px 100%; } - a.slack { background-position: -100px 0; } - a.slack:hover { background-position: -100px 100%; } - a.github { background-position: -150px 0; } - a.github:hover { background-position: -150px 100%; } - a.mailing-list { background-position: -200px 0; } - a.mailing-list:hover { background-position: -200px 100%; } - a.calendar { background-position: -250px 0; } - a.calendar:hover { background-position: -250px 100%; } - #community #hero, .gridPage #hero { text-align: left; } - #community #hero h1, .gridPage #hero h1 { padding: 20px 100px; } - #community #tryKubernetes, .gridPage #tryKubernetes { width: auto; background-color: #3371e3; padding: 0 20px; } - #bigSocial div { width: calc(25% - 18px); } - #home #caseStudiesWrapper div { width: 24%; min-height: 260px; } } - -@media screen and (min-width: 1300px) { #vendorStrip { padding-right: 100px; } } - -@media screen and (min-width: 456px) { #vendorStrip li + li { margin-left: 20px; } } diff --git a/static/css/case_study_styles.sass b/static/css/case_study_styles.sass deleted file mode 100644 index beb0d33d49..0000000000 --- a/static/css/case_study_styles.sass +++ /dev/null @@ -1,12 +0,0 @@ ---- ---- - -@import "../_sass/reset" -@import "../_sass/skin" -@import "../_sass/code-styles" - -// media queries -@import "../_sass/base" -@import "../_sass/case-studies" -@import "../_sass/tablet" -@import "../_sass/desktop" diff --git a/static/css/style_case_studies.css b/static/css/style_case_studies.css index 815e1da7d2..6e17b74748 100644 --- a/static/css/style_case_studies.css +++ b/static/css/style_case_studies.css @@ -64,7 +64,6 @@ h1 { font-size:24px; letter-spacing:0.03em; line-height:34px; - float:left; background-size:100% auto; background-color:#666666; background-repeat:repeat; @@ -82,7 +81,6 @@ h1 { font-size:24px; letter-spacing:0.03em; line-height:34px; - float:left; background-size:100% auto; } @@ -95,7 +93,6 @@ h1 { font-size:24px; letter-spacing:0.03em; line-height:34px; - float:left; background-size:100% auto; } @@ -108,7 +105,6 @@ h1 { font-size:24px; letter-spacing:0.03em; line-height:35px; - float:left; width:100%; background-size:100% auto; background-color:#666666; @@ -120,9 +116,8 @@ h1 { font-weight:300; color:#ffffff; width:70%; - padding-left:15%; - float:left; text-align:center; + margin:0 auto; } .banner3text { @@ -130,8 +125,8 @@ h1 { font-weight:300; color:#ffffff; width:75%; - padding-left:13%; text-align:center; + margin:0 auto; } .banner4text { @@ -139,8 +134,8 @@ h1 { font-weight:300; color:#ffffff; width:65%; - padding-left:17%; text-align:center; + margin:0 auto; } .banner5text { @@ -148,9 +143,8 @@ h1 { font-weight:300; color:#ffffff; width:68%; - padding-left:16%; - float:left; text-align:center; + margin:0 auto; } @@ -186,14 +180,11 @@ hr { border-bottom:0px solid; width:100%; opacity:0.5; - color:#aaaaaa; + background-color:#999999; height:1px; } .col1 { - width: 42%; - padding-right:8%; - float:left; font-family:"Roboto", sans-serif; font-weight:100; color:#606060; @@ -204,10 +195,8 @@ hr { } .col2 { - width: 45%; font-family:"Roboto", sans-serif; font-weight:300; - float:left; line-height:20px; color:#606060; letter-spacing:0.03em; @@ -223,7 +212,6 @@ hr { margin-bottom:4%; font-family:"Roboto", sans-serif; font-weight:300; - float:left; line-height:22px; color:#606060; letter-spacing:0.03em; @@ -237,8 +225,6 @@ hr { margin-bottom:4%; font-family:"Roboto", sans-serif; font-weight:300; - float:left; - } h4 { @@ -287,7 +273,7 @@ h4 { letter-spacing: 0.03em; padding-bottom: 2%; line-height: 28px; - padding-top: 4%; + padding-top: 1em; padding-left: 10%; } @@ -297,8 +283,6 @@ h4 { .col1 { width: 95%; - padding-right: 8%; - float: left; font-family: "Roboto", sans-serif; font-weight: 300; color: #606060; @@ -313,7 +297,6 @@ h4 { padding-bottom: 5%; font-family: "Roboto", sans-serif; font-weight: 300; - float: left; line-height: 20px; color: #606060; letter-spacing: 0.03em; @@ -341,7 +324,6 @@ h4 { letter-spacing: 0.03em; line-height: 24px; width: 100%; - float: left; background: none; background-color: #666666; } @@ -356,7 +338,6 @@ h4 { letter-spacing: 0.03em; line-height: 23px; width: 90%; - float: left; } .banner4 { @@ -369,7 +350,6 @@ h4 { letter-spacing: 0.03em; line-height: 24px; width: 100%; - float: left; } .banner5 { @@ -382,7 +362,6 @@ h4 { letter-spacing: 0.03em; line-height: 23px; width: 100%; - float: left; background: none; background-color: #666666; } @@ -395,7 +374,6 @@ h4 { padding-left: 5%; padding-bottom: 1%; padding-top: 1%; - float: left; text-align: center; color: #ffffff; } diff --git a/static/css/styles.css b/static/css/styles.css new file mode 100644 index 0000000000..22c3a6702a --- /dev/null +++ b/static/css/styles.css @@ -0,0 +1,2 @@ +html,body{margin:0;padding:0}input,button{outline:none}button{cursor:pointer}ul,li{list-style:none}ul{margin:0;padding:0}a{text-decoration:none}.clear{display:block;clear:both}.light-text{color:#fff}.right{float:right}.left{float:left}.center{text-align:center}*,.button{box-sizing:border-box;font-family:"Roboto",sans-serif;background:none;margin:0;border:0}body{font-family:"Roboto",sans-serif}h1,h2,h5,p{font-weight:300}h3,h4{font-weight:400}html,body{margin:0;padding:0}input,button{outline:none}button{cursor:pointer}ul,li{list-style:none}ul{margin:0;padding:0}a{text-decoration:none}.clear{display:block;clear:both}.light-text{color:#fff}.right{float:right}.left{float:left}.center{text-align:center}h1{font-size:32px;line-height:40px}h2{font-size:28px;line-height:60px}h3{font-size:24px;line-height:32px}h4{font-size:20px;line-height:40px}h5{font-size:16px;line-height:36px}p{font-size:14px;line-height:22px}section,header,#vendorStrip{padding-left:20px;padding-right:20px}section main,header main,#vendorStrip main{width:100%;max-width:100%}header{height:80px}.nav-buttons{height:80px;line-height:80px}.nav-buttons .button+*{margin-left:30px}#hamburger{width:50px;height:50px}#mainNav{padding:140px 0 30px}#mainNav h5{margin-bottom:1em}#mainNav h3{margin-bottom:.6em}#mainNav .nav-box{width:20%}#mainNav .nav-box+.nav-box{margin-left:calc(20% / 3)}#mainNav main+main{margin-top:60px}#mainNav .left .button{height:50px;line-height:50px;font-size:18px}.open-nav #tryKubernetes,.y-enough #tryKubernetes{margin-left:30px}#hero{padding-top:80px}#docs #hero h1,#docs #hero h5{padding-left:20px;padding-right:20px}#vendorStrip{height:88px;line-height:88px;font-size:16px}body{background-color:#fff}section{position:relative;background-color:#fff}section main,header main,footer main{position:relative;margin:auto}p{font-size:14px;font-weight:400}.button{display:inline-block;border-radius:6px;padding:0 20px;line-height:40px;color:#fff;background-color:#3371e3;text-decoration:none}#cellophane{position:fixed;top:0;left:0;width:100%;height:100%;display:none}header{position:fixed;top:0;left:0;width:100%;z-index:8888;background-color:transparent;box-shadow:0 0 0 transparent;overflow:hidden;transition:.3s;text-align:center}.logo{position:relative;float:left;display:block;width:180px;height:88px;top:0;left:0;transform:none;background-image:url(/images/nav_logo.svg);background-size:contain;background-position:center center;background-repeat:no-repeat}#docs .flyout-button{position:fixed;top:20px;left:20px;width:50px;height:50px;background-image:url(/images/toc_icon.png);background-position:center center;background-repeat:no-repeat;background-size:auto;border-radius:50%;transition:.3s;z-index:99999}#docs.open-nav .flyout-button{display:none}#docs .logo{position:absolute;top:40px;left:50%;transform:translate(-50%, -50%);display:block;width:45px;height:44px;background-image:url(/images/favicon.png)}#docs.flip-nav .flyout-button{background-image:url(/images/toc_icon_grey.png)}.nav-buttons{float:right}#viewDocs,#tryKubernetes{display:none}#viewDocs{border:2px solid #fff;background-color:transparent;transition:.3s}#viewDocs:hover{background-color:#fff;color:#303030}#tryKubernetes{width:0;padding:0 0;border:1px solid transparent;background-color:transparent;text-align:center;white-space:nowrap;vertical-align:middle;overflow:hidden;transition:.3s}#hamburger{display:inline-block;position:relative;vertical-align:middle;padding:0;border:0;background:none}#hamburger div,#hamburger:before,#hamburger:after{position:absolute;left:15%;width:70%;height:2px;background-color:#3371e3;transition:.3s;content:""}#hamburger div{top:calc(50% - 1px)}#hamburger:before{top:24%}#hamburger:after{bottom:24%}#hamburger:hover div,#hamburger:hover:before,#hamburger:hover:after{background-color:#fff}#mainNav h5{color:#3371e3;font-weight:normal}#mainNav main{white-space:nowrap;overflow:hidden;clear:both}#mainNav .nav-box{float:left;white-space:normal}#mainNav h3 a{color:#3371e3;text-decoration:none}ul.global-nav{display:none}ul.global-nav li{display:inline-block;margin-right:14px}ul.global-nav li a{color:#fff;font-weight:400;padding:0;position:relative}ul.global-nav li a.active:after{position:absolute;width:100%;height:2px;content:"";bottom:-4px;left:0;background:#fff}ul.global-nav li a .ui-icon{filter:brightness(0) invert(1)}ul.global-nav li ul{display:none;position:fixed;top:40px;text-align:left}ul.global-nav li ul li{display:block;height:28px}ul.global-nav li ul li a{background:#303030;color:#fff;padding:7px}ul.global-nav li ul li:last-child a{border-radius:7px}ul.global-nav li:hover ul{display:block}.flip-nav ul.global-nav li a,.open-nav ul.global-nav li a{color:#303030}.flip-nav ul.global-nav li a .ui-icon,.open-nav ul.global-nav li a .ui-icon{filter:brightness(0)}.flip-nav ul.global-nav li ul li a{background:#fff;color:#303030}.flip-nav ul.global-nav li a.active:after,.flip-nav ul.global-nav li ul li a.active:after,.open-nav ul.global-nav li a.active:after{background:#3371e3}.flip-nav header{background-color:#fff}.open-nav body{overflow:hidden}.open-nav #cellophane{display:block;z-index:9998}.open-nav header{background-color:#e8e8e8;z-index:9999}.open-nav #hamburger div{opacity:0}.open-nav #hamburger:before,.open-nav #hamburger:after{left:12px;transform-origin:0 1px}.open-nav #hamburger:before{transform:rotate(45deg)}.open-nav #hamburger:after{transform:rotate(-45deg)}.open-nav #tryKubernetes,.y-enough #tryKubernetes{width:auto;padding:0 20px;background-color:#3371e3;border-color:#3371e3}.flip-nav header,.open-nav header{box-shadow:0 1px 2px #4c4c4c}.flip-nav #viewDocs,.open-nav #viewDocs{border-color:#303030;color:#303030}.flip-nav #viewDocs:hover,.open-nav #viewDocs:hover{border-color:#3371e3;background-color:#3371e3;color:#fff}.flip-nav #hamburger:hover div,.flip-nav #hamburger:hover:before,.flip-nav #hamburger:hover:after,.open-nav #hamburger:hover div,.open-nav #hamburger:hover:before,.open-nav #hamburger:hover:after{background-color:#303030}#hero{background-image:url(/images/texture.png);background-color:#303030;text-align:center;padding-left:0;padding-right:0;margin-bottom:0;position:relative}#hero.bot-bar:after{display:block;margin-bottom:-20px;height:8px;width:100%;background-color:rgba(255,255,255,0.1);content:""}#hero.no-sub h5{display:none}#hero.no-sub h1{margin-bottom:20px}#home #hero:after{display:none}#vendorStrip{position:relative;background-color:rgba(255,255,255,0.1);font-weight:100;white-space:nowrap;text-align:center}#vendorStrip li a{color:rgba(255,255,255,0.5)}#vendorStrip li a.YAH{color:#fff;position:relative}footer{width:100%;background-image:url(/images/texture.png);background-color:#303030}footer main{padding:20px 0}footer nav a{width:100%;text-align:center;display:inline-block;margin:10px 0;font-size:24px;font-weight:300;color:#fff;text-decoration:none}footer .social{margin:20px 0}footer .social div{text-align:center;margin-bottom:20px}footer .social div:last-child{margin:30px 0}footer .social span{display:block;margin-bottom:8px}footer .social input{text-align:center}#search,#wishField{background-color:transparent;padding:10px;font-size:16px;font-weight:100;color:#fff;border:1px solid #fff;transition:.3s}#search:focus,#wishField:focus{background-color:#f7f7f7;color:#303030}.social a{display:inline-block;background-image:url(/images/social_sprite.png);background-repeat:no-repeat;background-size:auto;width:50px;height:50px;border-radius:5px;margin-right:10px}.social a:hover{background-color:#fff}.social a span{position:absolute;display:block;height:0;overflow:hidden}.social a.button{background-image:none;width:auto;height:auto}.social a.button:hover{color:#3371e3}a.twitter{background-position:0 0}a.twitter:hover{background-position:0 100%}a.stack-overflow{background-position:-50px 0}a.stack-overflow:hover{background-position:-50px 100%}a.slack{background-position:-100px 0}a.slack:hover{background-position:-100px 100%}a.github{background-position:-150px 0}a.github:hover{background-position:-150px 100%}a.mailing-list{background-position:-200px 0}a.mailing-list:hover{background-position:-200px 100%}a.calendar{background-position:-250px 0}a.calendar:hover{background-position:-250px 100%}#viewDocs{display:none}section{background-color:#fff}#hero{background-color:#303030}#hero h5{margin:20px 0;line-height:28px}#vendorStrip{position:relative}#vendorStrip ul{float:left}#vendorStrip li{display:inline-block;height:100%}#vendorStrip a{display:block;height:100%;color:#fff;font-size:.75em;font-weight:bold}#vendorStrip li+li{margin-left:0}#docs #vendorStrip{line-height:44px;max-width:100%;overflow-x:scroll}#docs #vendorStrip ul{float:none}#docs #vendorStrip #searchBox{float:none;display:block;width:80%;margin:0 auto;height:44px;line-height:44px;position:relative}#docs #vendorStrip #searchBox:before{position:absolute;width:15px;height:15px;content:"";right:8px;top:7px;background-image:url(/images/search-icon.svg);background-repeat:no-repeat;background-size:100% 100%;z-index:1}#docs #vendorStrip #search{width:100%;padding:0 10px;height:30px;line-height:30px;font-size:16px;vertical-align:top;background:#fff;border:none;border-radius:4px;position:relative}#encyclopedia{position:relative;padding:50px 20px 20px 20px;overflow:hidden;font-size:14px}#encyclopedia>div{height:100%}#docsToc{position:fixed;background-color:#fff;top:0;left:0;width:0;height:100vh;overflow:hidden;padding:50px 0;z-index:999999;transition:.3s}#docsToc .yah>.title{background-color:#f7f7f7;border-left:3px solid #3371e3;padding:7.5px 10px 7.5px 18px;margin-left:-3px;color:#3371e3}.open-toc body{overflow:hidden}.open-toc #docsToc{padding:50px 20px;width:400px;max-width:100vw;overflow-y:auto}.pi-accordion>.container:first-child>.item:first-child>.title:first-child{padding-left:0;font-size:1.5em;font-weight:700}.pi-accordion>.container:first-child>.item.yah:first-child>.title:first-child{margin-left:-20px !important}.pi-accordion .item{overflow:hidden}.pi-accordion .title{color:#303030;position:relative;padding:7.5px 10px 7.5px 18px;cursor:pointer;transition:.3s}.pi-accordion .title:hover{color:#3371e3}.pi-accordion a.item>.title{color:#000}.pi-accordion a.item>.title:hover{color:#3371e3}.pi-accordion div.item>.title:before{content:"";position:absolute;top:12px;left:2px;border-style:solid;border-width:5px 0 5px 8px;border-color:transparent transparent transparent #3371e3;transform:rotate(0deg);transition:.3s}.pi-accordion .wrapper{position:relative;width:100%;transition:height .3s}.pi-accordion .content{padding-left:20px;opacity:0;transition:.3s}.pi-accordion .item.on>.title:before{transform:rotate(90deg)}.pi-accordion .item.on>.wrapper>.content{opacity:1}dt{margin-bottom:8px}dd{margin-bottom:16px}.pi-pushmenu{display:none;position:fixed;top:0;width:100%;height:100%;opacity:0;transition:opacity .3s}.pi-pushmenu.on{opacity:1}.pi-pushmenu .overlay{position:fixed;top:0;left:0;width:100%;height:100%;background-color:rgba(0,0,0,0.4)}.pi-pushmenu .sled{position:absolute;top:0;width:0;height:100%;background-color:#fff;overflow:auto;transition:.3s}.pi-pushmenu.on .sled{width:400px;max-width:100vw}.pi-pushmenu .top-bar{height:0;line-height:60px;background-color:#444}.pi-pushmenu ul{margin-top:25px}.pi-pushmenu li{position:relative;display:block;width:100%;min-height:45px;padding:0 60px 0 20px;border-bottom:1px solid #ccc}.pi-pushmenu a{display:inline-block;width:100%;height:45px;line-height:45px;font-family:"Roboto",sans-serif;font-size:20px;color:#3371e3}.pi-pushmenu .button{background:none;padding:0}.pi-pushmenu ul ul{padding:0 20px}.pi-pushmenu ul ul li{min-height:40px}.pi-pushmenu ul ul a{height:40px;line-height:40px;font-size:18px;color:#555}.push-menu-close-button{position:absolute;top:0;right:0;width:50px;height:50px}.push-menu-close-button:before,.push-menu-close-button:after{content:"";position:absolute;top:calc(50% - 1px);left:25%;width:50%;height:2px;background-color:#000}.push-menu-close-button:before{transform:rotate(45deg)}.push-menu-close-button:after{transform:rotate(-45deg)}#docsContent{position:relative;float:right;width:100%}#docsContent *+h2,#docsContent *+h3,#docsContent *+h4,#docsContent *+h5,#docsContent *+h6{margin-top:30px}#docsContent h1,#docsContent h2,#docsContent h3,#docsContent h4,#docsContent h5,#docsContent h6{line-height:normal;font-weight:500;margin-bottom:30px;padding-bottom:10px}#docsContent h1:before,#docsContent h2:before,#docsContent h3:before,#docsContent h4:before,#docsContent h5:before,#docsContent h6:before{display:block;content:" ";margin-top:-100px;height:100px;visibility:hidden}#docsContent h1,#docsContent h2{border-bottom:1px solid #ccc}#docsContent h1{font-size:32px;padding-right:60px}#docsContent h2{font-size:28px}#docsContent h3{font-size:24px;font-weight:300;margin-bottom:5px}#docsContent h4{font-size:20px;margin-bottom:0px}#docsContent h5,#docsContent h6{font-size:16px;font-weight:500}#docsContent p{font-size:16px;font-weight:300;line-height:1.75em}#docsContent p+p{margin-top:10px}#docsContent code{display:inline-block;box-sizing:border-box;background-color:#f7f7f7;color:#303030;font-family:"Roboto Mono",monospace;vertical-align:baseline;font-size:14px;font-weight:bold;padding:2px 4px}#docsContent a code{color:#3371e3;text-decoration:underline}#docsContent pre .pi,#docsContent pre .s{margin:0;padding:0}#docsContent .highlight code span,#docsContent code,#docsContent pre code{font-family:"Roboto Mono",monospace}#docsContent code,#docsContent pre code{color:#303030}#docsContent pre code{padding:0}#docsContent pre{background-color:#f7f7f7;display:block;margin:20px 0;padding:15px;position:relative;overflow-x:auto}#docsContent h1 code,#docsContent h2 code,#docsContent h3 code,#docsContent h4 code,#docsContent h5 code,#docsContent h6 code{font-size:inherit;background-color:transparent}#docsContent .includecode{table-layout:fixed}#docsContent .includecode,#docsContent .includecode th,#docsContent .includecode td{padding:0 !important}#docsContent .includecode th{text-align:right !important;padding:10px !important}#docsContent .includecode th a,#docsContent .includecode th a code{color:#fff !important;background-color:transparent !important}#docsContent .includecode pre{margin:0 !important}#docsContent ul li{list-style:disc}#docsContent ol li{list-style:decimal}#docsContent ul,#docsContent ol{margin:20px 0;padding-left:30px;font-weight:300}#docsContent ul ul,#docsContent ol ol,#docsContent ul ol,#docsContent ol ul{margin:.75em 0}#docsContent li{margin-bottom:.75em;font-size:16px;line-height:1.75em}#docsContent table{width:100%;border:1px solid #ccc;border-spacing:0;margin-top:30px;margin-bottom:30px}#docsContent thead,#docsContent tr:nth-child(even){background-color:#f7f7f7}#docsContent thead{background-color:#555;color:#fff}#docsContent th,#docsContent td{padding:8px;text-align:left;margin:0}#docsContent th{font-weight:normal}#docsContent td{font-size:.85em}#docsContent #editPageButton{position:absolute;top:-25px;right:5px;width:50px;height:50px;line-height:50px;border-radius:50%;white-space:nowrap;text-indent:50px;overflow:hidden;background:#3371e3 url(/images/icon-pencil.svg) no-repeat;background-position:12px 10px;background-size:29px 29px}#docsContent #markdown-toc,#docsContent #TableOfContents{margin-bottom:20px}#docsContent #markdown-toc ul,#docsContent #markdown-toc li,#docsContent #TableOfContents ul,#docsContent #TableOfContents li{list-style:disc;color:#3371e3}#docsContent #markdown-toc ul,#docsContent #TableOfContents ul{padding:0 15px;margin:0}#docsContent #markdown-toc li,#docsContent #TableOfContents li{padding:0;line-height:1.5em;margin-bottom:0}#docsContent #markdown-toc a,#docsContent #TableOfContents a{position:relative;color:#3371e3;font-weight:700}#docsContent img{max-width:100%}#docsContent #TableOfContents>ul>li{list-style:none}#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}html.search #docsContent{position:relative;float:none;width:90%;max-width:850px;margin:0 auto}html.search #docsContent #editPageButton{display:none}html.search #docsContent table{border:0;margin-bottom:0}html.search #docsContent td{padding:0}html.search #docsContent h1{margin-bottom:0;border-bottom:0;padding-bottom:0;padding-left:8px}#home.flip-nav .logo,#home.open-nav .logo{background-image:url(/images/nav_logo2.svg)}#home #hero{margin-bottom:0;padding-bottom:1px}#home #hero main{padding:0 10px;margin-bottom:30px}#home #hero #vendorStrip{display:none}#oceanNodes{padding-top:60px;padding-bottom:60px}#oceanNodes a{color:#3371e3}#oceanNodes main{margin-bottom:60px;min-height:160px}#oceanNodes .image-wrapper{max-width:75%;margin:0 auto 20px;text-align:center}#oceanNodes .image-wrapper img{width:100%;max-width:160px}#oceanNodes main:first-child .image-wrapper{max-width:100%}#oceanNodes main:first-child .image-wrapper img{max-width:491px}#oceanNodes h3{margin-bottom:30px}#video{height:200px}#video{width:100%;position:relative;background-position:center center;background-size:cover}#video>.light-text{display:none;position:absolute;top:50%;left:75%;width:525px;padding-right:80px;transform:translate(-50%, -50%);color:#fff}#video h2{font-size:32px;line-height:44px;margin-bottom:20px}#video p{margin-bottom:20px}#video #desktopKCButton{position:relative;font-size:18px;background-color:#303030;border-radius:8px;color:#fff;padding:20px 10px 20px 10px}#video #desktopShowVideoButton{position:relative;font-size:24px;background-color:#fff;border-radius:8px;color:#3371e3;padding:15px 30px 15px 80px;margin-bottom:15px}#video #desktopShowVideoButton:before{content:"";position:absolute;position:absolute;top:50%;left:40px;transform:translate(-50%, -50%);width:0;height:0;border-style:solid;border-width:10px 0 10px 20px;border-color:transparent transparent transparent #3371e3}#video #mobileShowVideoButton{position:absolute;top:50%;left:50%;transform:translate(-50%, -50%);width:80px;height:80px;border-radius:50%;background-color:transparent;border:5px solid rgba(255,255,255,0.2);overflow:visible}#video #mobileShowVideoButton:after{position:absolute;top:50%;left:50%;transform:translate(-50%, -50%);left:40px;content:"";width:0;height:0;border-style:solid;border-width:20px 0 20px 30px;border-color:transparent transparent transparent #fff}#videoPlayer{position:fixed;top:0;left:0;width:100vw;height:100vh;background-color:rgba(0,0,0,0.9);display:none}#videoPlayer iframe{position:absolute;top:50%;left:50%;transform:translate(-50%, -50%);width:80vw;height:45vw;max-width:142.2222222222vh;max-height:80vh}#videoPlayer #closeButton{position:absolute;top:20px;right:20px;width:50px;height:50px;border:2px solid transparent;transition:.3s}#videoPlayer #closeButton:before,#videoPlayer #closeButton:after{content:"";position:absolute;top:calc(50% - 1px);left:10%;width:80%;height:2px;background-color:#fff}#videoPlayer #closeButton:before{transform:rotate(45deg)}#videoPlayer #closeButton:after{transform:rotate(-45deg)}#videoPlayer #closeButton:hover{border-color:#fff}#cncf{padding-top:60px;padding-bottom:140px;background-image:url(/images/cncf-color.png);background-position:center 100px;background-repeat:no-repeat;background-size:300px}#kubeweekly{background-color:#f7f7f7;padding-top:60px;padding-bottom:140px;background-size:auto;font-family:"Roboto Mono",monospace !important;font-size:24px;font-weight:bold}#kubeweekly h5{font-size:20px}.subscribe-button{border-radius:6px;padding:0 20px;line-height:31px;color:#fff;background-color:blue;text-decoration:none;font-size:14px}#features{padding-top:140px;background-color:#f7f7f7;background-image:url(/images/wheel.png);background-position:center 60px;background-repeat:no-repeat;background-size:auto}.feature-box{width:100%;overflow:hidden;clear:both}.feature-box h4{line-height:normal;margin-bottom:15px}.feature-box>div:first-child{float:left}.feature-box>div:last-child{float:right}#features h3{margin-bottom:20px}#features .feature-box{margin-bottom:0}#features .feature-box>div{width:100%;margin-bottom:40px}#community.open-nav .logo,#community.flip-nav .logo,.gridPage.open-nav .logo,.gridPage.flip-nav .logo{background-image:url(/images/nav_logo2.svg)}#community #hero,.gridPage #hero{padding-bottom:20px}#community #mainContent,.gridPage #mainContent{padding:20px 0}#community #mainContent main,.gridPage #mainContent main{max-width:none}#community #mainContent a,.gridPage #mainContent a{color:#3371e3}#community #mainContent .content,.gridPage #mainContent .content{margin-bottom:30px;padding:30px 0}#community #mainContent .content h1,#community #mainContent .content h2,#community #mainContent .content h3,#community #mainContent .content h4,#community #mainContent .content h5,#community #mainContent .content h6,#community #mainContent .content p,.gridPage #mainContent .content h1,.gridPage #mainContent .content h2,.gridPage #mainContent .content h3,.gridPage #mainContent .content h4,.gridPage #mainContent .content h5,.gridPage #mainContent .content h6,.gridPage #mainContent .content p{line-height:normal;max-width:1200px;padding:0 20px;margin:0 auto 20px}#community #mainContent .content:nth-child(even),.gridPage #mainContent .content:nth-child(even){background-color:#f7f7f7}#community #mainContent .company-logos,.gridPage #mainContent .company-logos{text-align:center;max-width:1200px;margin:0 auto}#community #mainContent .company-logos img,.gridPage #mainContent .company-logos img{width:auto;margin:10px;background-color:#f7f7f7}#community #mainContent .partner-logos,.gridPage #mainContent .partner-logos{text-align:center;max-width:1200px;margin:0 auto}#community #mainContent .partner-logos img,.gridPage #mainContent .partner-logos img{width:auto;margin:10px;background-color:#fff;box-shadow:0 5px 5px rgba(0,0,0,0.24),0 0 5px rgba(0,0,0,0.12)}#community #mainContent #calendarMeetings,.gridPage #mainContent #calendarMeetings{position:relative;width:80vw;height:60vw;max-width:1200px;max-height:900px;margin:20px auto}#community #mainContent #calendarEvents,.gridPage #mainContent #calendarEvents{position:relative;width:80vw;height:30vw;max-width:1200px;max-height:450px;margin:20px auto}#community #mainContent iframe,.gridPage #mainContent iframe{position:absolute;border:0;width:100%;height:100%}.ui-icon{display:inline-block !important}#feature-state-dialog-link{text-decoration:none !important;padding:5px !important}#feature-state-dialog-link a:visited{color:#454545 !important}#feature-state-dialog-link a code{display:inline-block !important;box-sizing:border-box !important;background-color:#f7f7f7 !important;color:#303030 !important;font-family:"Roboto Mono",monospace !important;vertical-align:baseline !important;font-size:14px !important;font-weight:bold !important;padding:0px 4px !important}#feature-state-dialog{background:#fff !important;border:1px solid #ddd !important;padding:.5em 1em !important}#feature-state-dialog ul,#feature-state-dialog li{list-style:disc !important;margin:4px 12px !important}#feature-state-dialog p{margin:8px 0px !important}#feature-state-dialog code{display:inline-block !important;box-sizing:border-box !important;background-color:#f7f7f7 !important;color:#303030 !important;font-family:"Roboto Mono",monospace !important;vertical-align:baseline !important;font-size:14px !important;font-weight:bold !important;padding:0px 4px !important}.ui-dialog{background:#f7f7f7 !important;padding:.5em}.ui-dialog-content{position:relative;float:right;width:100%}.ui-dialog-content *+h2,.ui-dialog-content *+h3,.ui-dialog-content *+h4,.ui-dialog-content *+h5,.ui-dialog-content *+h6{margin-top:30px}.ui-dialog-content h1,.ui-dialog-content h2,.ui-dialog-content h3,.ui-dialog-content h4,.ui-dialog-content h5,.ui-dialog-content h6{line-height:normal;font-weight:500;margin-bottom:30px;padding-bottom:10px}.ui-dialog-content h1:before,.ui-dialog-content h2:before,.ui-dialog-content h3:before,.ui-dialog-content h4:before,.ui-dialog-content h5:before,.ui-dialog-content h6:before{display:block;content:" ";margin-top:-100px;height:100px;visibility:hidden}.ui-dialog-content h1,.ui-dialog-content h2{border-bottom:1px solid #ccc}.ui-dialog-content h1{font-size:32px;padding-right:60px}.ui-dialog-content h2{font-size:28px}.ui-dialog-content h3{font-size:24px;font-weight:300;margin-bottom:5px}.ui-dialog-content h4{font-size:20px;margin-bottom:0px}.ui-dialog-content h5,.ui-dialog-content h6{font-size:16px;font-weight:500}.ui-dialog-content p{font-size:16px;font-weight:300;line-height:1.75em}.ui-dialog-content p+p{margin-top:10px}.ui-dialog-content code{display:inline-block;box-sizing:border-box;background-color:#f7f7f7;color:#303030;font-family:"Roboto Mono",monospace;vertical-align:baseline;font-size:14px;font-weight:bold;padding:2px 4px}.ui-dialog-content a code{color:#3371e3;text-decoration:underline}.ui-dialog-content pre .pi,.ui-dialog-content pre .s{margin:0;padding:0}.ui-dialog-content .highlight code span,.ui-dialog-content code,.ui-dialog-content pre code{font-family:"Roboto Mono",monospace}.ui-dialog-content code,.ui-dialog-content pre code{color:#303030}.ui-dialog-content pre code{padding:0}.ui-dialog-content pre{background-color:#f7f7f7;display:block;margin:20px 0;padding:15px;position:relative;overflow-x:auto}.ui-dialog-content h1 code,.ui-dialog-content h2 code,.ui-dialog-content h3 code,.ui-dialog-content h4 code,.ui-dialog-content h5 code,.ui-dialog-content h6 code{font-family:inherit;font-size:inherit;background-color:transparent}.ui-dialog-content .includecode{table-layout:fixed}.ui-dialog-content .includecode,.ui-dialog-content .includecode th,.ui-dialog-content .includecode td{padding:0 !important}.ui-dialog-content .includecode th{text-align:right !important;padding:10px !important}.ui-dialog-content .includecode th a,.ui-dialog-content .includecode th a code{color:#fff !important;background-color:transparent !important}.ui-dialog-content .includecode pre{margin:0 !important}.ui-dialog-content ul li{list-style:disc}.ui-dialog-content ol li{list-style:decimal}.ui-dialog-content ul,.ui-dialog-content ol{margin:20px 0;padding-left:30px;font-weight:300}.ui-dialog-content ul ul,.ui-dialog-content ol ol,.ui-dialog-content ul ol,.ui-dialog-content ol ul{margin:.75em 0}.ui-dialog-content li{margin-bottom:.75em;font-size:16px;line-height:1.75em}.ui-dialog-content table{width:100%;border:1px solid #ccc;border-spacing:0;margin-top:30px;margin-bottom:30px}.ui-dialog-content thead,.ui-dialog-content tr:nth-child(even){background-color:#f7f7f7}.ui-dialog-content thead{background-color:#555;color:#fff}.ui-dialog-content th,.ui-dialog-content td{padding:8px;text-align:left;margin:0}.ui-dialog-content th{font-weight:normal}.ui-dialog-content td{font-size:.85em}.ui-dialog-content #editPageButton{position:absolute;top:-25px;right:5px;width:50px;height:50px;line-height:50px;border-radius:50%;white-space:nowrap;text-indent:50px;overflow:hidden;background:#3371e3 url(/images/icon-pencil.svg) no-repeat;background-position:12px 10px;background-size:29px 29px}.ui-dialog-content #markdown-toc{margin-bottom:20px}.ui-dialog-content #markdown-toc ul,.ui-dialog-content #markdown-toc li{list-style:disc;color:#3371e3}.ui-dialog-content #markdown-toc ul{padding:0 15px;margin:0}.ui-dialog-content #markdown-toc li{padding:0;line-height:1.5em;margin-bottom:0}.ui-dialog-content #markdown-toc a{position:relative;color:#3371e3;font-weight:700}.ui-dialog-content img{max-width:100%}.ui-dialog-content a{text-decoration:underline}.ui-dialog-buttonpane{background:#f7f7f7 !important}.ui-widget-header{background:transparent !important;background-color:transparent !important;border:0px !important}.ui-tabs ul,.ui-tabs ol,.ui-tabs li{padding:0px !important;list-style:none !important;margin-bottom:0px !important;margin-left:4px !important}.ui-tabs-panel ul li{list-style:disc !important}.ui-tabs-panel ol li{list-style:decimal !important}.ui-widget-content{border:0px !important}.ui-widget-content table{margin:0px !important}.ui-tabs .ui-tabs-panel{border:1px solid #ccc !important}.ui-tabs-anchor{text-decoration:none !important}#talkToUs h3,#talkToUs h4{text-align:center}#talkToUs h3{margin-bottom:15px}#talkToUs h4{line-height:normal;margin-bottom:50px}#talkToUs h4 br{display:none}#talkToUs #bigSocial{overflow:hidden}#talkToUs #bigSocial div{width:100%;float:left;padding:30px;padding-top:110px;background-position:center top;background-size:auto;background-repeat:no-repeat}#talkToUs #bigSocial div:nth-child(1){background-image:url(/images/twitter_icon.png)}#talkToUs #bigSocial div:nth-child(2){background-image:url(/images/github_icon.png)}#talkToUs #bigSocial div:nth-child(3){background-image:url(/images/slack_icon.png)}#talkToUs #bigSocial div:nth-child(4){background-image:url(/images/stackoverflow_icon.png)}#talkToUs #bigSocial div+div{margin-top:20px;margin-left:0}#talkToUs #bigSocial a{display:inline-block;color:#3371e3;font-size:24px;font-weight:400;text-decoration:none;margin-bottom:15px}#talkToUs #bigSocial a,#talkToUs #bigSocial p{text-align:center;width:100%}#home #talkToUs main{padding:30px 0}#home #talkToUs h5{font-size:20px}#home #caseStudiesWrapper{position:relative;text-align:center;margin-bottom:30px}#home #caseStudiesWrapper img{padding-bottom:1rem}#home #caseStudiesWrapper div{position:relative;display:inline-block;vertical-align:top;width:100%;min-height:230px;margin-bottom:60px;padding-right:1rem;background-position:top center}#home #caseStudiesWrapper p{font-size:20px}#home #caseStudiesWrapper a{position:absolute;bottom:-30px;left:50%;transform:translateX(-50%);color:#3371e3;font-weight:400}.cse .gsc-control-cse,.gsc-control-cse{padding:0}.gsc-control-cse table,.gsc-control-cse-en table{margin:0px !important}.gsc-above-wrapper-area{border-bottom:0}#bing-results-container{margin-top:30px;margin-left:20px}.bing-result{margin-bottom:20px}.bing-result-name a{font-size:16px;color:#00c}.bing-result-url{color:green;font-size:13px}.bing-result-snippet{color:#000;font-size:11px}#bing-pagination-container{margin:10px;margin-left:20px}.bing-page-anchor{text-decoration:none !important;cursor:pointer;color:#00c;margin-right:8px}@media screen and (min-width: 750px){h1{font-size:32px;line-height:40px}h2{font-size:28px;line-height:60px}h3{font-size:24px;line-height:32px}h4{font-size:20px;line-height:40px}h5{font-size:16px;line-height:36px}p{font-size:14px;line-height:22px}section,header,#vendorStrip{padding-left:20px;padding-right:20px}section main,header main,#vendorStrip main{width:100%;max-width:100%}header{height:80px}.nav-buttons{height:80px;line-height:80px}.nav-buttons .button+*{margin-left:30px}#hamburger{width:50px;height:50px}#mainNav{padding:140px 0 30px}#mainNav h5{margin-bottom:1em}#mainNav h3{margin-bottom:.6em}#mainNav .nav-box{width:20%}#mainNav .nav-box+.nav-box{margin-left:calc(20% / 3)}#mainNav main+main{margin-top:60px}#mainNav .left .button{height:50px;line-height:50px;font-size:18px}.open-nav #tryKubernetes,.y-enough #tryKubernetes{margin-left:30px}#hero{padding-top:80px}#docs #hero h1,#docs #hero h5{padding-left:20px;padding-right:20px}#vendorStrip{height:88px;line-height:88px;font-size:16px}p{font-size:16px;line-height:24px;letter-spacing:.1px}h1{font-size:36px;line-height:44px}h3{font-size:28px;line-height:36px}h4{font-size:24px;line-height:40px}#home #viewDocs,#home #tryKubernetes{display:inline-block}#vendorStrip{display:block;text-align:center}#vendorStrip img{max-height:24px;vertical-align:middle;margin:0 30px}#docs #vendorStrip li a{font-size:1em;font-weight:normal}#docs #vendorStrip li li+li{margin-left:60px}#oceanNodes h3{text-align:left;margin-bottom:18px}#oceanNodes main{position:relative;clear:both;display:table;height:160px}#oceanNodes main .content{display:table-cell;position:relative;vertical-align:middle}#oceanNodes main .image-wrapper{position:absolute;top:50%;max-width:25%;max-height:100%;transform:translateY(-50%)}#oceanNodes main:nth-child(odd){padding-right:210px}#oceanNodes main:nth-child(odd) .image-wrapper{right:0}#oceanNodes main:nth-child(even){padding-left:210px}#oceanNodes main:nth-child(even) .image-wrapper{left:0}#oceanNodes main:nth-child(1){padding-right:0}#oceanNodes main:nth-child(1) h3,#oceanNodes main:nth-child(1) p{text-align:center}#oceanNodes main:nth-child(1) .image-wrapper{position:relative;display:block;float:none;max-width:100%;transform:none}#oceanNodes main:nth-child(1) .content{display:block}#oceanNodes main img{width:100%}#video{height:400px;display:block}#video>.light-text{display:block}#mobileShowVideoButton{display:none}#features{padding-bottom:60px}#features .feature-box{margin-bottom:30px}#features .feature-box:last-child{margin-bottom:0}#features h3{margin-bottom:40px}#features .feature-box>div{width:45%;margin-bottom:0}#talkToUs #bigSocial div{width:calc(50% - 15px)}#talkToUs #bigSocial div+div{margin-top:0}#talkToUs #bigSocial div:nth-child(2){margin-left:20px}#talkToUs #bigSocial div:nth-child(3){margin-top:20px}#talkToUs #bigSocial div:nth-child(4){margin-top:20px;margin-left:20px}#talkToUs #bigSocial a{display:inline-block;color:#3371e3;font-weight:400;text-decoration:none}footer nav{text-align:center}footer nav a{width:30%;padding:0 20px}footer .social{text-align:center}footer .social div{display:inline-block}footer .social div:last-child{display:block;margin:0}footer .social span{display:inline-block;margin-right:10px}footer .social input{text-align:left}#home #caseStudiesWrapper div{width:48%}}@media screen and (min-width: 1025px){#hamburger{display:none}ul.global-nav{display:inline-block}#docs #vendorStrip #searchBox:before{top:15px}#vendorStrip{height:44px;line-height:44px}#vendorStrip li a.YAH:after{content:"";display:block;position:absolute;left:0;bottom:0;width:100%;height:4px;background-color:#3371e3}#vendorStrip #searchBox{float:right}#home #hero #vendorStrip{display:block}#docs #hero h1,#docs #hero h5{text-align:left}#docs #hero #vendorStrip ul{float:left}#docs #hero #vendorStrip #searchBox{float:right;width:250px}#docs #hero #vendorStrip #search{vertical-align:middle}#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)}#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}#docsContent{width:calc(100% - 400px)}#docsContent #editPageButton{right:-25px}section main,header main,footer main{max-width:1200px}header,#vendorStrip,#encyclopedia,#hero h1,#hero h5,#docs #hero h1,#docs #hero h5,#community #hero h1,.gridPage #hero h1,#community #hero h5,.gridPage #hero h5{padding-left:100px;padding-right:100px}#vendorStrip{padding-right:10px}#home section main,#home header main,#home footer main{max-width:1000px}#oceanNodes main{position:relative;max-width:830px}#oceanNodes main:nth-child(1){max-width:1000px;padding-right:475px}#oceanNodes main:nth-child(1) h3,#oceanNodes main:nth-child(1) p{text-align:left}#oceanNodes main:nth-child(1) .image-wrapper{position:absolute;max-width:48%;transform:translateY(-50%)}#oceanNodes main:nth-child(1) .image-wrapper img{max-width:425px}#video{height:550px;position:relative;background-position:center center;background-size:cover}#talkToUs h4 br{display:block}#talkToUs #bigSocial div{width:calc(25% - 18px)}#talkToUs #bigSocial div+div{margin-left:20px}footer{width:100%;background-image:url(../images/texture.png);background-color:#303030}footer main{padding:20px 0}footer nav{overflow:hidden;margin-bottom:20px}footer nav a{width:16.65%;float:left;font-size:24px;font-weight:300;white-space:nowrap}footer .social{padding:0 30px;max-width:1200px}footer .social div{float:left}footer .social div:last-child{float:right}#search,#wishField{background-color:transparent;padding:10px;font-size:16px;font-weight:100;color:#fff;border:1px solid #fff;transition:.3s}#search:focus,#wishField:focus{background-color:#f7f7f7;color:#303030}.social a{display:inline-block;background-image:url(../images/social_sprite.png);background-repeat:no-repeat;background-size:auto;width:50px;height:50px;border-radius:5px;margin-right:10px}.social a:hover{background-color:#fff}.social a span{position:absolute;display:block;height:0;overflow:hidden}a.twitter{background-position:0 0}a.twitter:hover{background-position:0 100%}a.stack-overflow{background-position:-50px 0}a.stack-overflow:hover{background-position:-50px 100%}a.slack{background-position:-100px 0}a.slack:hover{background-position:-100px 100%}a.github{background-position:-150px 0}a.github:hover{background-position:-150px 100%}a.mailing-list{background-position:-200px 0}a.mailing-list:hover{background-position:-200px 100%}a.calendar{background-position:-250px 0}a.calendar:hover{background-position:-250px 100%}#community #hero,.gridPage #hero{text-align:left}#community #hero h1,.gridPage #hero h1{padding:20px 100px}#community #tryKubernetes,.gridPage #tryKubernetes{width:auto;background-color:#3371e3;padding:0 20px}#bigSocial div{width:calc(25% - 18px)}#home #caseStudiesWrapper div{width:24%;min-height:260px}}@media screen and (min-width: 1300px){#vendorStrip{padding-right:100px}}@media screen and (min-width: 456px){#vendorStrip li+li{margin-left:20px}} +/*# sourceMappingURL=styles.css.map */ diff --git a/static/css/styles.css.map b/static/css/styles.css.map new file mode 100644 index 0000000000..7706f071e3 --- /dev/null +++ b/static/css/styles.css.map @@ -0,0 +1,7 @@ +{ +"version": 3, +"mappings": "AAAA,SAAU,CACT,MAAM,CAAE,CAAC,CACT,OAAO,CAAE,CAAC,CAGX,YAAa,CACZ,OAAO,CAAE,IAAI,CAEd,MAAM,CACL,MAAM,CAAE,OAAO,CAEhB,KAAM,CACL,UAAU,CAAE,IAAI,CAEjB,EAAE,CACD,MAAM,CAAE,CAAC,CACT,OAAO,CAAE,CAAC,CAEX,CAAC,CACA,eAAe,CAAE,IAAI,CAGtB,MAAM,CACL,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,IAAI,CAEZ,WAAW,CACV,KAAK,CAAE,IAAK,CAEb,MAAM,CACL,KAAK,CAAE,KAAK,CAEb,KAAK,CACJ,KAAK,CAAE,IAAI,CAEZ,OAAO,CACN,UAAU,CAAE,MAAM,CC1BnB,SAAU,CACT,UAAU,CAAE,UAAU,CACtB,WAAW,CANA,mBAAoB,CAO/B,UAAU,CAAE,IAAI,CAChB,MAAM,CAAE,CAAC,CACT,MAAM,CAAE,CAAC,CAEV,IAAI,CACH,WAAW,CAZA,mBAAoB,CAchC,UAAa,CACZ,WAAW,CAAE,GAAG,CAEjB,KAAM,CACL,WAAW,CAAE,GAAG,CDxBjB,SAAU,CACT,MAAM,CAAE,CAAC,CACT,OAAO,CAAE,CAAC,CAGX,YAAa,CACZ,OAAO,CAAE,IAAI,CAEd,MAAM,CACL,MAAM,CAAE,OAAO,CAEhB,KAAM,CACL,UAAU,CAAE,IAAI,CAEjB,EAAE,CACD,MAAM,CAAE,CAAC,CACT,OAAO,CAAE,CAAC,CAEX,CAAC,CACA,eAAe,CAAE,IAAI,CAGtB,MAAM,CACL,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,IAAI,CAEZ,WAAW,CACV,KAAK,CAAE,IAAK,CAEb,MAAM,CACL,KAAK,CAAE,KAAK,CAEb,KAAK,CACJ,KAAK,CAAE,IAAI,CAEZ,OAAO,CACN,UAAU,CAAE,MAAM,CEpCnB,EAAE,CACD,SAAS,CCEK,IAAI,CDDlB,WAAW,CCEK,IAAI,CDArB,EAAE,CACD,SAAS,CCCK,IAAI,CDAlB,WAAW,CCCK,IAAI,CDCrB,EAAE,CACD,SAAS,CCAK,IAAI,CDClB,WAAW,CCAK,IAAI,CDErB,EAAE,CACD,SAAS,CCDK,IAAI,CDElB,WAAW,CCDK,IAAI,CDGrB,EAAE,CACD,SAAS,CCFK,IAAI,CDGlB,WAAW,CCFK,IAAI,CDIrB,CAAC,CACA,SAAS,CCHI,IAAI,CDIjB,WAAW,CCHI,IAAI,CDKpB,2BAA6B,CAC5B,YAAY,CCFS,IAAI,CDGzB,aAAa,CCHQ,IAAI,CDKzB,0CAAI,CACH,KAAK,CCJM,IAAI,CDKf,SAAS,CCJM,IAAI,CDMrB,MAAM,CACL,MAAM,CCLS,IAAI,CDOpB,YAAY,CACX,MAAM,CCRS,IAAI,CDSnB,WAAW,CCTI,IAAI,CDWnB,sBAAW,CACV,WAAW,CCRa,IAAI,CDU9B,UAAU,CACT,KAAK,CCTW,IAAI,CDUpB,MAAM,CCVU,IAAI,CDYrB,QAAQ,CACP,OAAO,CCTW,YAAY,CDW9B,WAAE,CACD,aAAa,CCXa,GAAG,CDa9B,WAAE,CACD,aAAa,CCba,IAAK,CDehC,iBAAQ,CACP,KAAK,CCfS,GAAG,CDiBlB,0BAAmB,CAClB,WAAW,CCjBiB,aAAa,CDmB1C,kBAAW,CACV,UAAU,CCnBuB,IAAI,CDqBtC,sBAAa,CACZ,MAAM,CCrBoB,IAAI,CDsB9B,WAAW,CCtBe,IAAI,CDuB9B,SAAS,CCtBsB,IAAI,CDyBpC,iDAAc,CACb,WAAW,CCvCa,IAAI,CDyC9B,KAAK,CACJ,WAAW,CCzBO,IAAI,CD6BrB,6BAAM,CACL,YAAY,CCxDO,IAAI,CDyDvB,aAAa,CCzDM,IAAI,CD2D1B,YAAY,CACX,MAAM,CC/Be,IAAI,CDgCzB,WAAW,CChCU,IAAI,CDiCzB,SAAS,CChCe,IAAI,CAW7B,IAAI,CACH,gBAAgB,CAAE,IAAK,CAExB,OAAO,CACN,QAAQ,CAAE,QAAQ,CAClB,gBAAgB,CAAE,IAAK,CAGvB,oCAAI,CACH,QAAQ,CAAE,QAAQ,CAClB,MAAM,CAAE,IAAI,CAEd,CAAC,CACA,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAGjB,OAAO,CACN,OAAO,CAAE,YAAY,CACrB,aAAa,CAAE,GAAG,CAClB,OAAO,CAAE,MAAM,CACf,WAAW,CAAE,IAAI,CACjB,KAAK,CAAE,IAAK,CACZ,gBAAgB,CFvFV,OAAO,CEwFb,eAAe,CAAE,IAAI,CAEtB,WAAW,CACV,QAAQ,CAAE,KAAK,CACf,GAAG,CAAE,CAAC,CACN,IAAI,CAAE,CAAC,CACP,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,OAAO,CAAE,IAAI,CAId,MAAM,CACL,QAAQ,CAAE,KAAK,CACf,GAAG,CAAE,CAAC,CACN,IAAI,CAAE,CAAC,CACP,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,IAAI,CACb,gBAAgB,CAAE,WAAW,CAC7B,UAAU,CAAE,iBAAiB,CAC7B,QAAQ,CAAE,MAAM,CAChB,UAAU,CAAE,GAAI,CAChB,UAAU,CAAE,MAAM,CAGnB,KAAK,CACJ,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,KAAK,CACZ,MAAM,CAAE,IAAI,CACZ,GAAG,CAAE,CAAC,CACN,IAAI,CAAE,CAAC,CACP,SAAS,CAAE,IAAI,CACf,gBAAgB,CAAE,yBAAyB,CAC3C,eAAe,CAAE,OAAO,CACxB,mBAAmB,CAAE,aAAa,CAClC,iBAAiB,CAAE,SAAS,CAI5B,oBAAc,CACb,QAAQ,CAAE,KAAK,CACf,GAAG,CAAE,IAAI,CACT,IAAI,CAAE,IAAI,CACV,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,gBAAgB,CAAE,yBAAyB,CAC3C,mBAAmB,CAAE,aAAa,CAClC,iBAAiB,CAAE,SAAS,CAC5B,eAAe,CAAE,IAAI,CACrB,aAAa,CAAE,GAAG,CAClB,UAAU,CAAE,GAAI,CAChB,OAAO,CAAE,KAAK,CAEf,6BAAyB,CACxB,OAAO,CAAE,IAAI,CAEd,WAAK,CACJ,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,IAAI,CACT,IAAI,CAAE,GAAG,CACT,SAAS,CAAE,qBAAqB,CAChC,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,gBAAgB,CAAE,wBAAwB,CAG3C,6BAAyB,CACxB,gBAAgB,CAAE,8BAA8B,CAGlD,YAAY,CACX,KAAK,CAAE,KAAK,CAEb,wBAAyB,CACxB,OAAO,CAAE,IAAI,CAEd,SAAS,CACR,MAAM,CAAE,cAAe,CACvB,gBAAgB,CAAE,WAAW,CAC7B,UAAU,CAAE,GAAI,CAEhB,eAAO,CACN,gBAAgB,CAAE,IAAK,CACvB,KAAK,CF5KK,OAAO,CE8KnB,cAAc,CACb,KAAK,CAAE,CAAC,CACR,OAAO,CAAE,GAAG,CACZ,MAAM,CAAE,qBAAqB,CAC7B,gBAAgB,CAAE,WAAW,CAC7B,UAAU,CAAE,MAAM,CAClB,WAAW,CAAE,MAAM,CACnB,cAAc,CAAE,MAAM,CACtB,QAAQ,CAAE,MAAM,CAChB,UAAU,CAAE,GAAI,CAEjB,UAAU,CACT,OAAO,CAAE,YAAY,CACrB,QAAQ,CAAE,QAAQ,CAClB,cAAc,CAAE,MAAM,CACtB,OAAO,CAAE,CAAC,CACV,MAAM,CAAE,CAAC,CACT,UAAU,CAAE,IAAI,CAEhB,iDAAsB,CACrB,QAAQ,CAAE,QAAQ,CAClB,IAAI,CAAE,GAAG,CACT,KAAK,CAAE,GAAG,CACV,MAAM,CAAE,GAAG,CACX,gBAAgB,CFxMX,OAAO,CEyMZ,UAAU,CAAE,GAAI,CAChB,OAAO,CAAE,EAAE,CAEZ,cAAG,CACF,GAAG,CAAE,eAAe,CAErB,iBAAQ,CACP,GAAG,CAAE,GAAG,CAET,gBAAO,CACN,MAAM,CAAE,GAAG,CAGX,mEAAsB,CACrB,gBAAgB,CAAE,IAAK,CAGzB,WAAE,CACD,KAAK,CF3NA,OAAO,CE4NZ,WAAW,CAAE,MAAM,CAEpB,aAAI,CACH,WAAW,CAAE,MAAM,CACnB,QAAQ,CAAE,MAAM,CAChB,KAAK,CAAE,IAAI,CAEZ,iBAAQ,CACP,KAAK,CAAE,IAAI,CACX,WAAW,CAAE,MAAM,CAGnB,aAAC,CACA,KAAK,CFzOD,OAAO,CE0OX,eAAe,CAAE,IAAI,CAIxB,aAAa,CACZ,OAAO,CAAE,IAAI,CAEb,gBAAE,CACD,OAAO,CAAE,YAAY,CACrB,YAAY,CAAE,IAAI,CAElB,kBAAC,CACA,KAAK,CAAE,IAAI,CACX,WAAW,CAAE,GAAG,CAChB,OAAO,CAAE,CAAC,CACV,QAAQ,CAAE,QAAQ,CAElB,+BAAc,CACb,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,GAAG,CACX,OAAO,CAAE,EAAE,CACX,MAAM,CAAE,IAAI,CACZ,IAAI,CAAE,CAAC,CACP,UAAU,CAAE,IAAI,CAEjB,2BAAQ,CACP,MAAM,CAAE,uBAAuB,CAEjC,mBAAE,CACD,OAAO,CAAE,IAAI,CACb,QAAQ,CAAE,KAAK,CACf,GAAG,CAAE,IAAI,CACT,UAAU,CAAE,IAAI,CAEhB,sBAAE,CACD,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,IAAI,CAEZ,wBAAC,CACA,UAAU,CFhRH,OAAO,CEiRd,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,GAAG,CAGb,mCAAC,CACA,aAAa,CAAE,GAAG,CAGrB,yBAAE,CACD,OAAO,CAAE,KAAK,CAIhB,yDAAkB,CACjB,KAAK,CF/RK,OAAO,CEiSjB,2EAAQ,CACP,MAAM,CAAE,aAAa,CAExB,kCAAkC,CACjC,UAAU,CAAE,IAAI,CAChB,KAAK,CFtSM,OAAO,CEwSnB,mIAAqI,CACpI,UAAU,CF3SJ,OAAO,CE+Sb,gBAAM,CACL,gBAAgB,CAAE,IAAK,CAKxB,cAAI,CACH,QAAQ,CAAE,MAAM,CAEjB,qBAAW,CACV,OAAO,CAAE,KAAK,CACd,OAAO,CAAE,IAAI,CAEd,gBAAM,CACL,gBAAgB,CAAE,OAAO,CACzB,OAAO,CAAE,IAAI,CAGb,wBAAG,CACF,OAAO,CAAE,CAAC,CAEX,sDAAiB,CAChB,IAAI,CAAE,IAAI,CACV,gBAAgB,CAAE,KAAK,CAExB,2BAAQ,CACP,SAAS,CAAE,aAAa,CAEzB,0BAAO,CACN,SAAS,CAAE,cAAc,CAG3B,iDAAc,CACb,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,MAAM,CACf,gBAAgB,CFlVX,OAAO,CEmVZ,YAAY,CFnVP,OAAO,CEuVb,iCAAM,CACL,UAAU,CAAE,iBAAsB,CAEnC,uCAAS,CACR,YAAY,CFzVF,OAAO,CE0VjB,KAAK,CF1VK,OAAO,CE4VjB,mDAAO,CACN,YAAY,CF/VR,OAAO,CEgWX,gBAAgB,CFhWZ,OAAO,CEiWX,KAAK,CAAE,IAAK,CAGb,mMAAsB,CACrB,gBAAgB,CFnWP,OAAO,CEwWnB,KAAK,CACJ,gBAAgB,CAAE,wBAAwB,CAC1C,gBAAgB,CF1WL,OAAO,CE2WlB,UAAU,CAAE,MAAM,CAClB,YAAY,CAAE,CAAC,CACf,aAAa,CAAE,CAAC,CAChB,aAAa,CAAE,CAAC,CAChB,QAAQ,CAAE,QAAQ,CAElB,mBAAe,CACd,OAAO,CAAE,KAAK,CACd,aAAa,CAAE,KAAK,CACpB,MAAM,CAAE,GAAG,CACX,KAAK,CAAE,IAAI,CACX,gBAAgB,CAAE,qBAA0B,CAC5C,OAAO,CAAE,EAAE,CAIX,eAAE,CACD,OAAO,CAAE,IAAI,CAEd,eAAE,CACD,aAAa,CAAE,IAAI,CAEtB,iBAAiB,CAChB,OAAO,CAAE,IAAI,CAGd,YAAY,CACX,QAAQ,CAAE,QAAQ,CAClB,gBAAgB,CAAE,qBAA0B,CAC5C,WAAW,CAAE,GAAG,CAChB,WAAW,CAAE,MAAM,CACnB,UAAU,CAAE,MAAM,CAElB,iBAAI,CACH,KAAK,CAAE,qBAA0B,CAEjC,qBAAK,CACJ,KAAK,CAAE,IAAK,CACZ,QAAQ,CAAE,QAAQ,CAIrB,MAAM,CACL,KAAK,CAAE,IAAI,CACX,gBAAgB,CAAE,wBAAwB,CAC1C,gBAAgB,CFxZL,OAAO,CE0ZlB,WAAI,CACH,OAAO,CAAE,MAAM,CAGf,YAAC,CACA,KAAK,CAAE,IAAI,CACX,UAAU,CAAE,MAAM,CAClB,OAAO,CAAE,YAAY,CACrB,MAAM,CAAE,MAAM,CACd,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAChB,KAAK,CAAE,IAAK,CACZ,eAAe,CAAE,IAAI,CAGvB,cAAO,CACN,MAAM,CAAE,MAAM,CAEd,kBAAG,CACF,UAAU,CAAE,MAAM,CAClB,aAAa,CAAE,IAAI,CAEpB,6BAAc,CACb,MAAM,CAAE,MAAM,CAEf,mBAAI,CACH,OAAO,CAAE,KAAK,CACd,aAAa,CAAE,GAAG,CAEnB,oBAAK,CACJ,UAAU,CAAE,MAAM,CAIrB,kBAAmB,CAClB,gBAAgB,CAAE,WAAW,CAC7B,OAAO,CAAE,IAAI,CACb,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAChB,KAAK,CAAE,IAAK,CACZ,MAAM,CAAE,cAAe,CACvB,UAAU,CAAE,GAAI,CAEhB,8BAAO,CACN,gBAAgB,CFvcL,OAAO,CEwclB,KAAK,CFvcK,OAAO,CEycnB,SAAS,CACR,OAAO,CAAE,YAAY,CACrB,gBAAgB,CAAE,8BAA8B,CAChD,iBAAiB,CAAE,SAAS,CAC5B,eAAe,CAAE,IAAI,CACrB,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,aAAa,CAAE,GAAG,CAClB,YAAY,CAAE,IAAI,CAElB,eAAO,CACN,gBAAgB,CAAE,IAAI,CAEvB,cAAI,CACH,QAAQ,CAAE,QAAQ,CAClB,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,CAAC,CACT,QAAQ,CAAE,MAAM,CAEjB,gBAAQ,CACP,gBAAgB,CAAE,IAAI,CACtB,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CAEZ,sBAAO,CACN,KAAK,CFpeD,OAAO,CEsed,SAAS,CACR,mBAAmB,CAAE,GAAG,CAExB,eAAO,CACN,mBAAmB,CAAE,MAAM,CAE7B,gBAAgB,CACf,mBAAmB,CAAE,OAAO,CAE5B,sBAAO,CACN,mBAAmB,CAAE,UAAU,CAEjC,OAAO,CACN,mBAAmB,CAAE,QAAQ,CAE7B,aAAO,CACN,mBAAmB,CAAE,WAAW,CAElC,QAAQ,CACP,mBAAmB,CAAE,QAAQ,CAE7B,cAAO,CACN,mBAAmB,CAAE,WAAW,CAElC,cAAc,CACb,mBAAmB,CAAE,QAAQ,CAE7B,oBAAO,CACN,mBAAmB,CAAE,WAAW,CAElC,UAAU,CACT,mBAAmB,CAAE,QAAQ,CAE7B,gBAAO,CACN,mBAAmB,CAAE,WAAW,CAElC,SAAS,CACR,OAAO,CAAE,IAAI,CAEd,OAAO,CACN,gBAAgB,CAAE,IAAK,CAExB,KAAK,CACJ,gBAAgB,CF/gBL,OAAO,CEihBlB,QAAE,CACD,MAAM,CAAE,MAAM,CACd,WAAW,CAAE,IAAI,CAEnB,YAAY,CACX,QAAQ,CAAE,QAAQ,CAElB,eAAE,CACD,KAAK,CAAE,IAAI,CAEZ,eAAE,CACD,OAAO,CAAE,YAAY,CACrB,MAAM,CAAE,IAAI,CAEb,cAAC,CACA,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,IAAI,CACZ,KAAK,CAAE,IAAK,CACZ,SAAS,CAAE,KAAM,CACjB,WAAW,CAAE,IAAI,CAElB,kBAAO,CACN,WAAW,CAAE,CAAC,CAIf,kBAAY,CACX,WAAW,CAAE,IAAI,CACjB,SAAS,CAAE,IAAI,CACf,UAAU,CAAE,MAAM,CAElB,qBAAE,CACD,KAAK,CAAE,IAAI,CAEZ,6BAAU,CACT,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,GAAG,CACV,MAAM,CAAE,MAAM,CACd,MAAM,CAAE,IAAI,CACZ,WAAW,CAAE,IAAI,CACjB,QAAQ,CAAE,QAAQ,CAElB,oCAAQ,CACP,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,OAAO,CAAE,EAAE,CACX,KAAK,CAAE,GAAG,CACV,GAAG,CAAE,GAAG,CACR,gBAAgB,CAAE,4BAA4B,CAC9C,iBAAiB,CAAE,SAAS,CAC5B,eAAe,CAAE,SAAS,CAC1B,OAAO,CAAE,CAAC,CAEZ,0BAAO,CACN,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,MAAM,CACf,MAAM,CAAE,IAAI,CACZ,WAAW,CAAE,IAAI,CACjB,SAAS,CAAE,IAAI,CACf,cAAc,CAAE,GAAG,CACnB,UAAU,CAAE,IAAI,CAChB,MAAM,CAAE,IAAI,CACZ,aAAa,CAAE,GAAG,CAClB,QAAQ,CAAE,QAAQ,CAGrB,aAAa,CACZ,QAAQ,CAAE,QAAQ,CAClB,OAAO,CAAE,mBAAmB,CAC5B,QAAQ,CAAE,MAAM,CAChB,SAAS,CAAE,IAAI,CAGf,iBAAO,CACN,MAAM,CAAE,IAAI,CAEd,QAAQ,CACP,QAAQ,CAAE,KAAK,CACf,gBAAgB,CAAE,IAAK,CACvB,GAAG,CAAE,CAAC,CACN,IAAI,CAAE,CAAC,CACP,KAAK,CAAE,CAAC,CACR,MAAM,CAAE,KAAK,CACb,QAAQ,CAAE,MAAM,CAChB,OAAO,CAAE,MAAM,CACf,OAAO,CAAE,MAAM,CACf,UAAU,CAAE,GAAI,CAIf,oBAAU,CACT,gBAAgB,CF/mBN,OAAO,CEgnBjB,WAAW,CAAE,iBAAe,CAC5B,OAAO,CAAE,qBAAqB,CAC9B,WAAW,CAAE,IAAI,CACjB,KAAK,CFpnBD,OAAO,CEunBb,cAAI,CACH,QAAQ,CAAE,MAAM,CAEjB,kBAAQ,CACP,OAAO,CAAE,SAAS,CAClB,KAAK,CAAE,KAAK,CACZ,SAAS,CAAE,KAAK,CAChB,UAAU,CAAE,IAAI,CAGjB,yEAAmE,CAClE,YAAY,CAAE,CAAC,CACf,SAAS,CAAE,KAAK,CAChB,WAAW,CAAE,GAAG,CAEjB,6EAAuE,CACtE,WAAW,CAAE,gBAAgB,CAE9B,mBAAK,CACJ,QAAQ,CAAE,MAAM,CAEjB,oBAAM,CACL,KAAK,CF3oBK,OAAO,CE4oBjB,QAAQ,CAAE,QAAQ,CAClB,OAAO,CAAE,qBAAqB,CAC9B,MAAM,CAAE,OAAO,CACf,UAAU,CAAE,GAAI,CAEhB,0BAAO,CACN,KAAK,CFppBD,OAAO,CEspBb,2BAAe,CACd,KAAK,CAAE,IAAK,CAEZ,iCAAO,CACN,KAAK,CF1pBD,OAAO,CE6pBZ,oCAAQ,CACP,OAAO,CAAE,EAAE,CACX,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,IAAI,CACT,IAAI,CAAE,GAAG,CACT,YAAY,CAAE,KAAK,CACnB,YAAY,CAAE,aAAa,CAC3B,YAAY,CAAE,2CAAyC,CACvD,SAAS,CAAE,YAAY,CACvB,UAAU,CAAE,GAAI,CAElB,sBAAQ,CACP,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,IAAI,CACX,UAAU,CAAE,UAAW,CAExB,sBAAQ,CACP,YAAY,CAAE,IAAI,CAClB,OAAO,CAAE,CAAC,CACV,UAAU,CAAE,GAAI,CAGhB,oCAAiB,CAChB,SAAS,CAAE,aAAa,CAEzB,wCAAuB,CACtB,OAAO,CAAE,CAAC,CAGb,EAAE,CACD,aAAa,CAAE,GAAG,CAEnB,EAAE,CACD,aAAa,CAAE,IAAI,CAEpB,YAAY,CACX,OAAO,CAAE,IAAI,CACb,QAAQ,CAAE,KAAK,CACf,GAAG,CAAE,CAAC,CACN,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,OAAO,CAAE,CAAC,CACV,UAAU,CAAE,WAAY,CAExB,eAAI,CACH,OAAO,CAAE,CAAC,CAEX,qBAAQ,CACP,QAAQ,CAAE,KAAK,CACf,GAAG,CAAE,CAAC,CACN,IAAI,CAAE,CAAC,CACP,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,gBAAgB,CAAE,eAAkB,CAErC,kBAAK,CACJ,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,CAAC,CACN,KAAK,CAAE,CAAC,CACR,MAAM,CAAE,IAAI,CACZ,gBAAgB,CAAE,IAAK,CACvB,QAAQ,CAAE,IAAI,CACd,UAAU,CAAE,GAAI,CAEjB,qBAAU,CACT,KAAK,CAAE,KAAK,CACZ,SAAS,CAAE,KAAK,CAEjB,qBAAQ,CACP,MAAM,CAAE,CAAC,CACT,WAAW,CAAE,IAAI,CACjB,gBAAgB,CAAE,IAAI,CAEvB,eAAE,CACD,UAAU,CAAE,IAAI,CAEjB,eAAE,CACD,QAAQ,CAAE,QAAQ,CAClB,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,IAAI,CACX,UAAU,CAAE,IAAI,CAChB,OAAO,CAAE,aAAa,CACtB,aAAa,CAAE,cAAiB,CAEjC,cAAC,CACA,OAAO,CAAE,YAAY,CACrB,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,WAAW,CAAE,IAAI,CACjB,WAAW,CAAE,mBAAoB,CACjC,SAAS,CAAE,IAAI,CACf,KAAK,CFxvBA,OAAO,CE0vBb,oBAAO,CACN,UAAU,CAAE,IAAI,CAChB,OAAO,CAAE,CAAC,CAEX,kBAAK,CACJ,OAAO,CAAE,MAAM,CAEf,qBAAE,CACD,UAAU,CAAE,IAAI,CAEjB,oBAAC,CACA,MAAM,CAAE,IAAI,CACZ,WAAW,CAAE,IAAI,CACjB,SAAS,CAAE,IAAI,CACf,KAAK,CAAE,IAAqB,CAG/B,uBAAuB,CACtB,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,CAAC,CACN,KAAK,CAAE,CAAC,CACR,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CAEZ,4DAAiB,CAChB,OAAO,CAAE,EAAE,CACX,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,eAAe,CACpB,IAAI,CAAE,GAAG,CACT,KAAK,CAAE,GAAG,CACV,MAAM,CAAE,GAAG,CACX,gBAAgB,CAAE,IAAK,CAExB,8BAAQ,CACP,SAAS,CAAE,aAAa,CAEzB,6BAAO,CACN,SAAS,CAAE,cAAc,CAE3B,YAAY,CACX,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,KAAK,CACZ,KAAK,CAAE,IAAI,CAKX,yFAAsC,CACrC,UAAU,CAAE,IAAI,CAEjB,+FAAsB,CACrB,WAAW,CAAE,MAAM,CACnB,WAAW,CAAE,GAAG,CAChB,aAAa,CAAE,IAAI,CACnB,cAAc,CAAE,IAAI,CAGpB,yIAAQ,CACP,OAAO,CAAE,KAAK,CACd,OAAO,CAAE,GAAG,CACZ,UAAU,CAAE,MAAkB,CAC9B,MAAM,CAhBW,KAAqB,CAiBtC,UAAU,CAAE,MAAM,CAEpB,+BAAK,CACJ,aAAa,CAAE,cAAiB,CAEjC,eAAE,CACD,SAAS,CAAE,IAAI,CACf,aAAa,CAAE,IAAI,CAEpB,eAAE,CACD,SAAS,CAAE,IAAI,CAEhB,eAAE,CACD,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAChB,aAAa,CAAE,GAAG,CAEnB,eAAE,CACD,SAAS,CAAE,IAAI,CACf,aAAa,CAAE,GAAG,CAEnB,+BAAM,CACL,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAEjB,cAAC,CACA,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAChB,WAAW,CAAE,MAAM,CAEpB,gBAAK,CACJ,UAAU,CAAE,IAAI,CAEjB,iBAAI,CACH,OAAO,CAAE,YAAY,CACrB,UAAU,CAAE,UAAU,CACtB,gBAAgB,CF31BL,OAAO,CE41BlB,KAAK,CF31BK,OAAO,CE41BjB,WAAW,CFv1BD,uBAAwB,CEw1BlC,cAAc,CAAE,QAAQ,CACxB,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,IAAI,CACjB,OAAO,CAAE,OAAO,CAEjB,mBAAM,CACL,KAAK,CFr2BA,OAAO,CEs2BZ,eAAe,CAAE,SAAS,CAE3B,wCAAe,CACd,MAAM,CAAE,CAAC,CACT,OAAO,CAAE,CAAC,CAEX,yEAAoC,CACnC,WAAW,CAAE,uBAAwB,CAEtC,uCAAc,CACb,KAAK,CAAE,OAAO,CAEf,qBAAQ,CACP,OAAO,CAAE,CAAC,CAEX,gBAAG,CACF,gBAAgB,CAAE,OAAO,CACzB,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,MAAM,CACd,OAAO,CAAE,IAAI,CACb,QAAQ,CAAE,QAAQ,CAClB,UAAU,CAAE,IAAI,CAEjB,6HAAoD,CACnD,SAAS,CAAE,OAAO,CAClB,gBAAgB,CAAE,WAAW,CAE9B,yBAAY,CACX,YAAY,CAAE,KAAK,CAEpB,mFAA8C,CAC7C,OAAO,CAAE,YAAY,CAEtB,4BAAe,CACd,UAAU,CAAE,gBAAgB,CAC5B,OAAO,CAAE,eAAe,CAEzB,kEAAyC,CACxC,KAAK,CAAE,eAAgB,CACvB,gBAAgB,CAAE,sBAAsB,CAEzC,6BAAgB,CACf,MAAM,CAAE,YAAY,CAErB,kBAAK,CACJ,UAAU,CAAE,IAAI,CAEjB,kBAAK,CACJ,UAAU,CAAE,OAAO,CAEpB,+BAAM,CACL,MAAM,CAAE,MAAM,CACd,YAAY,CAAE,IAAI,CAClB,WAAW,CAAE,GAAG,CAEjB,2EAA0B,CACzB,MAAM,CAAE,OAAQ,CAEjB,eAAE,CACD,aAAa,CAAE,KAAM,CACrB,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,MAAM,CAEpB,kBAAK,CACJ,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,cAAc,CACtB,cAAc,CAAE,CAAC,CACjB,UAAU,CAAE,IAAI,CAChB,aAAa,CAAE,IAAI,CAEpB,kDAAyB,CACxB,gBAAgB,CF56BL,OAAO,CE86BnB,kBAAK,CACJ,gBAAgB,CAAE,IAAI,CACtB,KAAK,CAAE,IAAK,CAEb,+BAAM,CACL,OAAO,CAAE,GAAG,CACZ,UAAU,CAAE,IAAI,CAChB,MAAM,CAAE,CAAC,CAEV,eAAE,CACD,WAAW,CAAE,MAAM,CAEpB,eAAE,CACD,SAAS,CAAE,KAAM,CAElB,4BAAe,CACd,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,KAAK,CACV,KAAK,CAAE,GAAG,CACV,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,WAAW,CAAE,IAAI,CACjB,aAAa,CAAE,GAAG,CAClB,WAAW,CAAE,MAAM,CACnB,WAAW,CAAE,IAAI,CACjB,QAAQ,CAAE,MAAM,CAChB,UAAU,CAAE,8CAA4C,CACxD,mBAAmB,CAAE,SAAS,CAC9B,eAAe,CAAE,SAAS,CAE3B,wDAA+B,CAC9B,aAAa,CAAE,IAAI,CAEnB,6HAAM,CACL,UAAU,CAAE,IAAI,CAChB,KAAK,CFl9BD,OAAO,CEo9BZ,8DAAE,CACD,OAAO,CAAE,MAAM,CACf,MAAM,CAAE,CAAC,CAEV,8DAAE,CACD,OAAO,CAAE,CAAC,CACV,WAAW,CAAE,KAAK,CAClB,aAAa,CAAE,CAAC,CAEjB,4DAAC,CACA,QAAQ,CAAE,QAAQ,CAClB,KAAK,CF/9BD,OAAO,CEg+BX,WAAW,CAAE,GAAG,CAElB,gBAAG,CACF,SAAS,CAAE,IAAI,CAGf,mCAAW,CACV,UAAU,CAAE,IAAI,CAEjB,iEAAM,CACL,UAAU,CAAE,IAAI,CAenB,aAAa,CACZ,QAAQ,CAAE,KAAK,CACf,MAAM,CAAE,CAAC,CAEV,SAAS,CACR,KAAK,CAAE,IAAI,CACX,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,IAAI,CACjB,KAAK,CAAE,IAAI,CAGZ,wBAAwB,CACvB,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,IAAI,CACX,KAAK,CAAE,GAAG,CACV,SAAS,CAAE,KAAK,CAChB,MAAM,CAAE,MAAM,CAEd,wCAAe,CACd,OAAO,CAAE,IAAI,CAEd,8BAAK,CACJ,MAAM,CAAE,CAAC,CACT,aAAa,CAAE,CAAC,CAEjB,2BAAE,CACD,OAAO,CAAE,CAAC,CAEX,2BAAE,CACD,aAAa,CAAE,CAAC,CAChB,aAAa,CAAE,CAAC,CAChB,cAAc,CAAE,CAAC,CACjB,YAAY,CAAE,GAAG,CA0BjB,yCAAK,CACJ,gBAAgB,CAAE,0BAA0B,CAE9C,WAAK,CACJ,aAAa,CAAE,CAAC,CAChB,cAAc,CAAE,GAAG,CAEnB,gBAAI,CACH,OAAO,CAAE,MAAM,CACf,aAAa,CAAE,IAAI,CAEpB,wBAAY,CACX,OAAO,CAAE,IAAI,CAIhB,WAAW,CACV,WAAW,CAnCY,IAAI,CAoC3B,cAAc,CApCS,IAAI,CAsC3B,aAAC,CACA,KAAK,CFxkCA,OAAO,CE0kCb,gBAAI,CACH,aAAa,CA1CS,IAAI,CA2C1B,UAAU,CAAE,KAAK,CAElB,0BAAc,CACb,SAAS,CAAE,GAAG,CACd,MAAM,CAAE,WAAW,CACnB,UAAU,CAAE,MAAM,CAElB,8BAAG,CACF,KAAK,CAAE,IAAI,CACX,SAAS,CAAE,KAAK,CAGjB,2CAAc,CACb,SAAS,CAAE,IAAI,CAEf,+CAAG,CACF,SAAS,CAAE,KAAK,CAEnB,cAAE,CACD,aAAa,CA5DgB,IAAI,CAgEnC,MAAM,CACL,MAAM,CA9DgB,KAAK,CAgE5B,MAAM,CACL,KAAK,CAAE,IAAI,CACX,QAAQ,CAAE,QAAQ,CAClB,mBAAmB,CAAE,aAAa,CAClC,eAAe,CAAE,KAAK,CAGtB,kBAAe,CACd,OAAO,CAAE,IAAI,CACb,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,GAAG,CACR,IAAI,CAAE,GAAG,CACT,KAAK,CAAE,KAAK,CACZ,aAAa,CAAE,IAAI,CACnB,SAAS,CAAE,qBAAqB,CAChC,KAAK,CAAE,IAAK,CAEb,SAAE,CACD,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,IAAI,CACjB,aAAa,CAAE,IAAI,CAEpB,QAAC,CACA,aAAa,CAAE,IAAI,CAEpB,uBAAgB,CACf,QAAQ,CAAE,QAAQ,CAClB,SAAS,CAAE,IAAI,CACf,gBAAgB,CFhoCN,OAAO,CEioCjB,aAAa,CAAE,GAAG,CAClB,KAAK,CFhoCC,IAAO,CEioCb,OAAO,CAAE,mBAAmB,CAE7B,8BAAuB,CACtB,QAAQ,CAAE,QAAQ,CAClB,SAAS,CAAE,IAAI,CACf,gBAAgB,CAAE,IAAK,CACvB,aAAa,CAAE,GAAG,CAClB,KAAK,CF5oCA,OAAO,CE6oCZ,OAAO,CAAE,mBAAmB,CAC5B,aAAa,CAAE,IAAI,CAEnB,qCAAQ,CACP,OAAO,CAAE,EAAE,CACX,QAAQ,CAAE,QAAQ,CHjmCpB,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAFgC,GAAG,CAGtC,IAAI,CGgmCkB,IAAI,CH/lC1B,SAAS,CAAE,qBAAqB,CGgmC9B,KAAK,CAAE,CAAC,CACR,MAAM,CAAE,CAAC,CACT,YAAY,CAAE,KAAK,CACnB,YAAY,CAAE,gBAAgB,CAC9B,YAAY,CAAE,2CAAyC,CAEzD,6BAAsB,CHzmCtB,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAFgC,GAAG,CAGtC,IAAI,CAHoB,GAAG,CAI3B,SAAS,CAAE,qBAAqB,CGwmC/B,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,aAAa,CAAE,GAAG,CAClB,gBAAgB,CAAE,WAAW,CAC7B,MAAM,CAAE,+BAAkC,CAC1C,QAAQ,CAAE,OAAO,CAEjB,mCAAO,CHlnCR,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAFgC,GAAG,CAGtC,IAAI,CAHoB,GAAG,CAI3B,SAAS,CAAE,qBAAqB,CGinC9B,IAAI,CAAE,IAAI,CACV,OAAO,CAAE,EAAE,CACX,KAAK,CAAE,CAAC,CACR,MAAM,CAAE,CAAC,CACT,YAAY,CAAE,KAAK,CACnB,YAAY,CAAE,gBAAgB,CAC9B,YAAY,CAAE,wCAA2C,CAE5D,YAAY,CHpoCX,QAAQ,CAAE,KAAK,CACf,GAAG,CAAE,CAAC,CACN,IAAI,CAAE,CAAC,CACP,KAAK,CAAE,KAAK,CACZ,MAAM,CAAE,KAAK,CGkoCb,gBAAgB,CAAE,eAAkB,CACpC,OAAO,CAAE,IAAI,CAEb,mBAAM,CHjoCN,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAFgC,GAAG,CAGtC,IAAI,CAHoB,GAAG,CAI3B,SAAS,CAAE,qBAAqB,CAIhC,KAAK,CAD4E,IAAI,CAErF,MAAM,CAAE,IAAgD,CACxD,SAAS,CAAE,gBAAiD,CAC5D,UAAU,CAJ6F,IAAI,CG+nC3G,yBAAY,CACX,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,IAAI,CACT,KAAK,CAAE,IAAI,CACX,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,MAAM,CAAE,qBAAqB,CAC7B,UAAU,CAAE,GAAI,CAEhB,gEAAiB,CAChB,OAAO,CAAE,EAAE,CACX,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,eAAe,CACpB,IAAI,CAAE,GAAG,CACT,KAAK,CAAE,GAAG,CACV,MAAM,CAAE,GAAG,CACX,gBAAgB,CAAE,IAAK,CAExB,gCAAQ,CACP,SAAS,CAAE,aAAa,CAEzB,+BAAO,CACN,SAAS,CAAE,cAAc,CAE1B,+BAAO,CACN,YAAY,CAAE,IAAK,CAGtB,KAAK,CACJ,WAAW,CAAE,IAAI,CACjB,cAAc,CAAE,KAAK,CACrB,gBAAgB,CAAE,2BAA2B,CAC7C,mBAAmB,CAAE,YAAY,CACjC,iBAAiB,CAAE,SAAS,CAC5B,eAAe,CAAE,KAAK,CAGvB,WAAW,CACV,gBAAgB,CF3tCJ,OAAO,CE4tCnB,WAAW,CAAE,IAAI,CACjB,cAAc,CAAE,KAAK,CACrB,eAAe,CAAE,IAAI,CACrB,WAAW,CAAE,kCAAmC,CAChD,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,IAAI,CAEjB,cAAE,CACD,SAAS,CAAE,IAAI,CAEjB,iBAAiB,CAChB,aAAa,CAAE,GAAG,CAClB,OAAO,CAAE,MAAM,CACf,WAAW,CAAE,IAAI,CACjB,KAAK,CAAE,IAAK,CACZ,gBAAgB,CAAE,IAAI,CACtB,eAAe,CAAE,IAAI,CACrB,SAAS,CAAE,IAAI,CAGhB,SAAS,CACR,WAAW,CAAE,KAAK,CAClB,gBAAgB,CFlvCJ,OAAO,CEmvCnB,gBAAgB,CAAE,sBAAsB,CACxC,mBAAmB,CAAE,WAAW,CAChC,iBAAiB,CAAE,SAAS,CAC5B,eAAe,CAAE,IAAI,CAEtB,YAAY,CAEX,KAAK,CAAE,IAAI,CACX,QAAQ,CAAE,MAAM,CAChB,KAAK,CAAE,IAAI,CAEX,eAAE,CACD,WAAW,CAAE,MAAM,CACnB,aAAa,CAAE,IAAI,CAEpB,4BAAmB,CAClB,KAAK,CAAE,IAAI,CAEZ,2BAAkB,CACjB,KAAK,CAAE,KAAK,CAGb,YAAE,CACD,aAAa,CAlOa,IAAI,CAoO/B,sBAAY,CACX,aAAa,CAnOa,CAAC,CAqO3B,0BAAO,CACN,KAAK,CAvOgB,IAAI,CAwOzB,aAAa,CAtOgB,IAAI,CA+OlC,qGAAK,CACJ,gBAAgB,CAAE,0BAA0B,CAE9C,gCAAK,CACJ,cAAc,CAAE,IAAI,CAErB,8CAAY,CACX,OAAO,CAAE,MAAM,CAEf,wDAAI,CACH,SAAS,CAAE,IAAI,CAEhB,kDAAC,CACA,KAAK,CFxyCD,OAAO,CE0yCZ,gEAAQ,CACP,aAAa,CAAE,IAAI,CACnB,OAAO,CAAE,MAAM,CAEf,8eAAyB,CACxB,WAAW,CAAE,MAAM,CACnB,SAAS,CAAE,MAAM,CACjB,OAAO,CAAE,MAAM,CACf,MAAM,CAAE,WAAW,CAEpB,gGAAiB,CAChB,gBAAgB,CFpzCP,OAAO,CEszClB,4EAAc,CACb,UAAU,CAAE,MAAM,CAClB,SAAS,CAAE,MAAM,CACjB,MAAM,CAAE,MAAM,CAEd,oFAAG,CACF,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,gBAAgB,CF9zCP,OAAO,CEg0ClB,4EAAc,CACb,UAAU,CAAE,MAAM,CAClB,SAAS,CAAE,MAAM,CACjB,MAAM,CAAE,MAAM,CAEd,oFAAG,CACF,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,gBAAgB,CFr0CZ,IAAO,CEs0CX,UAAU,CAAE,mDAAiD,CAE/D,kFAAiB,CAChB,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,SAAS,CAAE,MAAM,CACjB,UAAU,CAAE,KAAK,CACjB,MAAM,CAAE,SAAS,CAElB,8EAAe,CACd,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,SAAS,CAAE,MAAM,CACjB,UAAU,CAAE,KAAK,CACjB,MAAM,CAAE,SAAS,CAElB,4DAAM,CACL,QAAQ,CAAE,QAAQ,CAClB,MAAM,CAAE,CAAC,CACT,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CAGf,QAAQ,CACP,OAAO,CAAE,uBAAuB,CAEjC,0BAA0B,CACzB,eAAe,CAAE,eAAe,CAChC,OAAO,CAAE,cAAc,CACvB,oCAAS,CACR,KAAK,CAAE,kBAAkB,CAC1B,iCAAM,CACL,OAAO,CAAE,uBAAuB,CAChC,UAAU,CAAE,qBAAqB,CACjC,gBAAgB,CAAE,kBAAkB,CACpC,KAAK,CAAE,kBAAkB,CACzB,WAAW,CAAE,kCAAmC,CAChD,cAAc,CAAE,mBAAmB,CACnC,SAAS,CAAE,eAAe,CAC1B,WAAW,CAAE,eAAe,CAC5B,OAAO,CAAE,kBAAkB,CAE7B,qBAAqB,CACpB,UAAU,CAAE,eAAe,CAC3B,MAAM,CAAE,yBAAyB,CACjC,OAAO,CAAE,mBAAoB,CAE7B,iDAAM,CACL,UAAU,CAAE,eAAe,CAC3B,MAAM,CAAE,mBAAmB,CAE5B,uBAAC,CACA,MAAM,CAAE,kBAAkB,CAE3B,0BAAI,CACH,OAAO,CAAE,uBAAuB,CAChC,UAAU,CAAE,qBAAqB,CACjC,gBAAgB,CAAE,kBAAkB,CACpC,KAAK,CAAE,kBAAkB,CACzB,WAAW,CAAE,kCAAmC,CAChD,cAAc,CAAE,mBAAmB,CACnC,SAAS,CAAE,eAAe,CAC1B,WAAW,CAAE,eAAe,CAC5B,OAAO,CAAE,kBAAkB,CAE7B,UAAU,CACT,UAAU,CAAE,kBAAkB,CAC9B,OAAO,CAAE,IAAK,CAEf,kBAAkB,CACjB,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,KAAK,CACZ,KAAK,CAAE,IAAI,CAKX,uHAAsC,CACrC,UAAU,CAAE,IAAI,CAEjB,mIAAsB,CACrB,WAAW,CAAE,MAAM,CACnB,WAAW,CAAE,GAAG,CAChB,aAAa,CAAE,IAAI,CACnB,cAAc,CAAE,IAAI,CAGpB,6KAAQ,CACP,OAAO,CAAE,KAAK,CACd,OAAO,CAAE,GAAG,CACZ,UAAU,CAAE,MAAkB,CAC9B,MAAM,CAhBW,KAAqB,CAiBtC,UAAU,CAAE,MAAM,CAEpB,2CAAK,CACJ,aAAa,CAAE,cAAiB,CAEjC,qBAAE,CACD,SAAS,CAAE,IAAI,CACf,aAAa,CAAE,IAAI,CAEpB,qBAAE,CACD,SAAS,CAAE,IAAI,CAEhB,qBAAE,CACD,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAChB,aAAa,CAAE,GAAG,CAEnB,qBAAE,CACD,SAAS,CAAE,IAAI,CACf,aAAa,CAAE,GAAG,CAEnB,2CAAM,CACL,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAEjB,oBAAC,CACA,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAChB,WAAW,CAAE,MAAM,CAEpB,sBAAK,CACJ,UAAU,CAAE,IAAI,CAEjB,uBAAI,CACH,OAAO,CAAE,YAAY,CACrB,UAAU,CAAE,UAAU,CACtB,gBAAgB,CF38CL,OAAO,CE48ClB,KAAK,CF38CK,OAAO,CE48CjB,WAAW,CFv8CD,uBAAwB,CEw8ClC,cAAc,CAAE,QAAQ,CACxB,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,IAAI,CACjB,OAAO,CAAE,OAAO,CAEjB,yBAAM,CACL,KAAK,CFr9CA,OAAO,CEs9CZ,eAAe,CAAE,SAAS,CAE3B,oDAAe,CACd,MAAM,CAAE,CAAC,CACT,OAAO,CAAE,CAAC,CAEX,2FAAoC,CACnC,WAAW,CAAE,uBAAwB,CAEtC,mDAAc,CACb,KAAK,CAAE,OAAO,CAEf,2BAAQ,CACP,OAAO,CAAE,CAAC,CAEX,sBAAG,CACF,gBAAgB,CAAE,OAAO,CACzB,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,MAAM,CACd,OAAO,CAAE,IAAI,CACb,QAAQ,CAAE,QAAQ,CAClB,UAAU,CAAE,IAAI,CAEjB,iKAAoD,CACnD,WAAW,CAAE,OAAO,CACpB,SAAS,CAAE,OAAO,CAClB,gBAAgB,CAAE,WAAW,CAE9B,+BAAY,CACX,YAAY,CAAE,KAAK,CAEpB,qGAA8C,CAC7C,OAAO,CAAE,YAAY,CAEtB,kCAAe,CACd,UAAU,CAAE,gBAAgB,CAC5B,OAAO,CAAE,eAAe,CAEzB,8EAAyC,CACxC,KAAK,CAAE,eAAgB,CACvB,gBAAgB,CAAE,sBAAsB,CAEzC,mCAAgB,CACf,MAAM,CAAE,YAAY,CAErB,wBAAK,CACJ,UAAU,CAAE,IAAI,CAEjB,wBAAK,CACJ,UAAU,CAAE,OAAO,CAEpB,2CAAM,CACL,MAAM,CAAE,MAAM,CACd,YAAY,CAAE,IAAI,CAClB,WAAW,CAAE,GAAG,CAEjB,mGAA0B,CACzB,MAAM,CAAE,OAAQ,CAEjB,qBAAE,CACD,aAAa,CAAE,KAAM,CACrB,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,MAAM,CAEpB,wBAAK,CACJ,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,cAAc,CACtB,cAAc,CAAE,CAAC,CACjB,UAAU,CAAE,IAAI,CAChB,aAAa,CAAE,IAAI,CAEpB,8DAAyB,CACxB,gBAAgB,CF7hDL,OAAO,CE+hDnB,wBAAK,CACJ,gBAAgB,CAAE,IAAI,CACtB,KAAK,CAAE,IAAK,CAEb,2CAAM,CACL,OAAO,CAAE,GAAG,CACZ,UAAU,CAAE,IAAI,CAChB,MAAM,CAAE,CAAC,CAEV,qBAAE,CACD,WAAW,CAAE,MAAM,CAEpB,qBAAE,CACD,SAAS,CAAE,KAAM,CAElB,kCAAe,CACd,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,KAAK,CACV,KAAK,CAAE,GAAG,CACV,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,WAAW,CAAE,IAAI,CACjB,aAAa,CAAE,GAAG,CAClB,WAAW,CAAE,MAAM,CACnB,WAAW,CAAE,IAAI,CACjB,QAAQ,CAAE,MAAM,CAChB,UAAU,CAAE,8CAA4C,CACxD,mBAAmB,CAAE,SAAS,CAC9B,eAAe,CAAE,SAAS,CAE3B,gCAAa,CACZ,aAAa,CAAE,IAAI,CAEnB,uEAAM,CACL,UAAU,CAAE,IAAI,CAChB,KAAK,CFnkDD,OAAO,CEqkDZ,mCAAE,CACD,OAAO,CAAE,MAAM,CACf,MAAM,CAAE,CAAC,CAEV,mCAAE,CACD,OAAO,CAAE,CAAC,CACV,WAAW,CAAE,KAAK,CAClB,aAAa,CAAE,CAAC,CAEjB,kCAAC,CACA,QAAQ,CAAE,QAAQ,CAClB,KAAK,CFhlDD,OAAO,CEilDX,WAAW,CAAE,GAAG,CAElB,sBAAG,CACF,SAAS,CAAE,IAAI,CAEhB,oBAAC,CAEA,eAAe,CAAE,SAAS,CAe5B,qBAAqB,CACpB,UAAU,CAAE,kBAAkB,CAG/B,iBAAiB,CAChB,UAAU,CAAE,sBAAsB,CAClC,gBAAgB,CAAE,sBAAsB,CACxC,MAAM,CAAE,cAAc,CAGtB,mCAAU,CACT,OAAO,CAAE,cAAc,CACvB,UAAU,CAAE,eAAe,CAC3B,aAAa,CAAE,cAAc,CAC7B,WAAW,CAAE,cAAc,CAG5B,oBAAK,CACJ,UAAU,CAAE,eAAe,CAE5B,oBAAK,CACJ,UAAU,CAAE,kBAAkB,CAEhC,kBAAkB,CACjB,MAAM,CAAE,cAAc,CAEtB,wBAAK,CACJ,MAAM,CAAE,cAAc,CAExB,uBAAuB,CACtB,MAAM,CAAE,yBAAyB,CAElC,eAAe,CACd,eAAe,CAAE,eAAe,CAIhC,yBAAM,CACL,UAAU,CAAE,MAAM,CAEnB,YAAE,CACD,aAAa,CAAE,IAAI,CAEpB,YAAE,CACD,WAAW,CAAE,MAAM,CACnB,aAAa,CAAE,IAAI,CAEnB,eAAE,CACD,OAAO,CAAE,IAAI,CAEf,oBAAU,CACT,QAAQ,CAAE,MAAM,CAEhB,wBAAG,CACF,KAAK,CAAE,IAAI,CACX,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,IAAI,CACb,WAAW,CAAE,KAAK,CAClB,mBAAmB,CAAE,UAAU,CAC/B,eAAe,CAAE,IAAI,CACrB,iBAAiB,CAAE,SAAS,CAE7B,qCAAgB,CACf,gBAAgB,CAAE,6BAA6B,CAEhD,qCAAgB,CACf,gBAAgB,CAAE,4BAA4B,CAE/C,qCAAgB,CACf,gBAAgB,CAAE,2BAA2B,CAE9C,qCAAgB,CACf,gBAAgB,CAAE,mCAAmC,CAEtD,4BAAS,CACR,UAAU,CAAE,IAAI,CAChB,WAAW,CAAE,CAAC,CAEf,sBAAC,CACA,OAAO,CAAE,YAAY,CACrB,KAAK,CFvrDD,OAAO,CEwrDX,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAChB,eAAe,CAAE,IAAI,CACrB,aAAa,CAAE,IAAI,CAEpB,6CAAI,CACH,UAAU,CAAE,MAAM,CAClB,KAAK,CAAE,IAAI,CAKZ,oBAAI,CACH,OAAO,CAAE,MAAM,CAEhB,kBAAE,CACD,SAAS,CAAE,IAAI,CAGjB,yBAAmB,CAClB,QAAQ,CAAE,QAAQ,CAClB,UAAU,CAAE,MAAM,CAClB,aAAa,CAAE,IAAI,CAEnB,6BAAG,CACF,cAAc,CAAE,IAAI,CAErB,6BAAG,CACF,QAAQ,CAAE,QAAQ,CAClB,OAAO,CAAE,YAAY,CACrB,cAAc,CAAE,GAAG,CACnB,KAAK,CAAE,IAAI,CACX,UAAU,CAAE,KAAK,CACjB,aAAa,CAAE,IAAI,CACnB,aAAa,CAAE,IAAI,CACnB,mBAAmB,CAAE,UAAU,CAEhC,2BAAC,CACA,SAAS,CAAE,IAAI,CAEhB,2BAAC,CACA,QAAQ,CAAE,QAAQ,CAClB,MAAM,CAAE,KAAK,CACb,IAAI,CAAE,GAAG,CACT,SAAS,CAAE,gBAAgB,CAC3B,KAAK,CFruDD,OAAO,CEsuDX,WAAW,CAAE,GAAG,CAKnB,sCAAuC,CACtC,OAAO,CAAE,CAAC,CAGX,gDAAiD,CAChD,MAAM,CAAE,cAAc,CAGvB,uBAAuB,CACtB,aAAa,CAAE,CAAC,CAIjB,uBAAuB,CACtB,UAAU,CAAE,IAAI,CAChB,WAAW,CAAE,IAAI,CAElB,YAAY,CACX,aAAa,CAAE,IAAI,CAEpB,mBAAmB,CAClB,SAAS,CAAE,IAAI,CACf,KAAK,CAAE,IAAO,CAGf,gBAAgB,CACf,KAAK,CAAE,KAAO,CACd,SAAS,CAAE,IAAI,CAEhB,oBAAoB,CACnB,KAAK,CAAE,IAAI,CACX,SAAS,CAAE,IAAI,CAEhB,0BAA0B,CACzB,MAAM,CAAE,IAAI,CACZ,WAAW,CAAE,IAAI,CAElB,iBAAiB,CAChB,eAAe,CAAE,eAAc,CAC/B,MAAM,CAAE,OAAO,CACf,KAAK,CAAE,IAAO,CACd,YAAY,CAAE,GAAG,CCjtDlB,oCAAoC,CFnEpC,EAAE,CACD,SAAS,CCEK,IAAI,CDDlB,WAAW,CCEK,IAAI,CDArB,EAAE,CACD,SAAS,CCCK,IAAI,CDAlB,WAAW,CCCK,IAAI,CDCrB,EAAE,CACD,SAAS,CCAK,IAAI,CDClB,WAAW,CCAK,IAAI,CDErB,EAAE,CACD,SAAS,CCDK,IAAI,CDElB,WAAW,CCDK,IAAI,CDGrB,EAAE,CACD,SAAS,CCFK,IAAI,CDGlB,WAAW,CCFK,IAAI,CDIrB,CAAC,CACA,SAAS,CCHI,IAAI,CDIjB,WAAW,CCHI,IAAI,CDKpB,2BAA6B,CAC5B,YAAY,CEJS,IAAI,CFKzB,aAAa,CELQ,IAAI,CFOzB,0CAAI,CACH,KAAK,CENM,IAAI,CFOf,SAAS,CENM,IAAI,CFQrB,MAAM,CACL,MAAM,CEPS,IAAI,CFSpB,YAAY,CACX,MAAM,CEVS,IAAI,CFWnB,WAAW,CEXI,IAAI,CFanB,sBAAW,CACV,WAAW,CEVa,IAAI,CFY9B,UAAU,CACT,KAAK,CEXW,IAAI,CFYpB,MAAM,CEZU,IAAI,CFcrB,QAAQ,CACP,OAAO,CEXW,YAAY,CFa9B,WAAE,CACD,aAAa,CEba,GAAG,CFe9B,WAAE,CACD,aAAa,CEfa,IAAK,CFiBhC,iBAAQ,CACP,KAAK,CEjBS,GAAG,CFmBlB,0BAAmB,CAClB,WAAW,CEnBiB,aAAa,CFqB1C,kBAAW,CACV,UAAU,CErBuB,IAAI,CFuBtC,sBAAa,CACZ,MAAM,CEvBoB,IAAI,CFwB9B,WAAW,CExBe,IAAI,CFyB9B,SAAS,CExBsB,IAAI,CF2BpC,iDAAc,CACb,WAAW,CEzCa,IAAI,CF2C9B,KAAK,CACJ,WAAW,CE3BO,IAAI,CF+BrB,6BAAM,CACL,YAAY,CE1DO,IAAI,CF2DvB,aAAa,CE3DM,IAAI,CF6D1B,YAAY,CACX,MAAM,CC/Be,IAAI,CDgCzB,WAAW,CChCU,IAAI,CDiCzB,SAAS,CEnCe,IAAI,CAoB5B,CAAC,CACA,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,IAAI,CACjB,cAAc,CAAE,IAAK,CAEtB,EAAE,CACD,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,IAAI,CAElB,EAAE,CACD,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,IAAI,CAElB,EAAE,CACD,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,IAAI,CAKjB,oCAAyB,CACxB,OAAO,CAAE,YAAY,CAEvB,YAAY,CACX,OAAO,CAAE,KAAK,CACd,UAAU,CAAE,MAAM,CAElB,gBAAG,CACF,UAAU,CAAE,IAAI,CAChB,cAAc,CAAE,MAAM,CACtB,MAAM,CAAE,MAAM,CAKb,uBAAC,CACA,SAAS,CAAE,GAAG,CACd,WAAW,CAAE,MAAM,CAEpB,2BAAO,CACN,WAAW,CAAE,IAAI,CAIpB,cAAE,CACD,UAAU,CAAE,IAAI,CAChB,aAAa,CAAE,IAAI,CAEpB,gBAAI,CACH,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,KAAK,CAEb,yBAAQ,CACP,OAAO,CAAE,UAAU,CACnB,QAAQ,CAAE,QAAQ,CAClB,cAAc,CAAE,MAAM,CAEvB,+BAAc,CACb,QAAQ,CAAE,QAAQ,CAClB,GAAG,CAAE,GAAG,CACR,SAAS,CAAE,GAAG,CACd,UAAU,CAAE,IAAI,CAChB,SAAS,CAAE,gBAAgB,CAE5B,+BAAgB,CACf,aAAa,CAAE,KAAK,CAEpB,8CAAc,CACb,KAAK,CAAE,CAAC,CAEV,gCAAiB,CAChB,YAAY,CAAE,KAAK,CAEnB,+CAAc,CACb,IAAI,CAAE,CAAC,CAET,6BAAc,CACb,aAAa,CAAE,CAAC,CAEhB,gEAAK,CACJ,UAAU,CAAE,MAAM,CAEnB,4CAAc,CACb,QAAQ,CAAE,QAAQ,CAClB,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,IAAI,CACX,SAAS,CAAE,IAAI,CACf,SAAS,CAAE,IAAI,CAEhB,sCAAQ,CACP,OAAO,CAAE,KAAK,CAEhB,oBAAG,CACF,KAAK,CAAE,IAAI,CAGd,MAAM,CACL,MAAM,CApHe,KAAK,CAqH1B,OAAO,CAAE,KAAK,CAEd,kBAAe,CACd,OAAO,CAAE,KAAK,CAEhB,sBAAsB,CACrB,OAAO,CAAE,IAAI,CAEd,SAAS,CACR,cAAc,CAAE,IAAI,CAEpB,sBAAY,CACX,aAAa,CAAE,IAAI,CAEnB,iCAAY,CACX,aAAa,CAAE,CAAC,CAElB,YAAE,CACD,aAAa,CApIY,IAAI,CAuI7B,0BAAO,CACN,KAAK,CArIe,GAAG,CAsIvB,aAAa,CAvIe,CAAC,CA2I9B,wBAAG,CACF,KAAK,CAAE,gBAAgB,CAExB,4BAAS,CACR,UAAU,CAAE,CAAC,CAEd,qCAAgB,CACf,WAAW,CAAE,IAAI,CAElB,qCAAgB,CACf,UAAU,CAAE,IAAI,CAEjB,qCAAgB,CACf,UAAU,CAAE,IAAI,CAChB,WAAW,CAAE,IAAI,CAElB,sBAAC,CACA,OAAO,CAAE,YAAY,CACrB,KAAK,CHvNF,OAAO,CGwNV,WAAW,CAAE,GAAG,CAChB,eAAe,CAAE,IAAI,CAIvB,UAAG,CACF,UAAU,CAAE,MAAM,CAElB,YAAC,CACA,KAAK,CAAE,GAAG,CACV,OAAO,CAAE,MAAM,CAEjB,cAAO,CACN,UAAU,CAAE,MAAM,CAElB,kBAAG,CACF,OAAO,CAAE,YAAY,CAEtB,6BAAc,CACb,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,CAAC,CAEV,mBAAI,CACH,OAAO,CAAE,YAAY,CACrB,YAAY,CAAE,IAAI,CAEnB,oBAAK,CACJ,UAAU,CAAE,IAAI,CAKlB,6BAAG,CACF,KAAK,CAAE,GAAG,ECrPb,qCAAqC,CACpC,UAAU,CACT,OAAO,CAAE,IAAI,CAEd,aAAa,CACZ,OAAO,CAAE,YAAY,CAEtB,oCAAoC,CACnC,GAAG,CAAE,IAAI,CAEV,YAAY,CACX,MAAM,CAdc,IAAI,CAexB,WAAW,CAfS,IAAI,CAmBtB,2BAAO,CACN,OAAO,CAAE,EAAE,CACX,OAAO,CAAE,KAAK,CACd,QAAQ,CAAE,QAAQ,CAClB,IAAI,CAAE,CAAC,CACP,MAAM,CAAE,CAAC,CACT,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,GAAG,CACX,gBAAgB,CJ5Bd,OAAO,CI+BZ,uBAAU,CACT,KAAK,CAAE,KAAK,CAKZ,wBAAY,CACX,OAAO,CAAE,KAAK,CAIf,6BAAM,CACL,UAAU,CAAE,IAAI,CAGhB,2BAAE,CACD,KAAK,CAAE,IAAI,CAEZ,mCAAU,CACT,KAAK,CAAE,KAAK,CACZ,KAAK,CAAE,KAAK,CAEb,gCAAO,CACN,cAAc,CAAE,MAAM,CAEzB,oBAAc,CACb,OAAO,CAAE,IAAI,CAEd,WAAK,CACJ,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,KAAK,CACd,KAAK,CAAE,KAAK,CACZ,MAAM,CAAE,IAAI,CACZ,GAAG,CAAE,CAAC,CACN,IAAI,CAAE,CAAC,CACP,SAAS,CAAE,IAAI,CACf,gBAAgB,CAAE,2BAA2B,CAG7C,yCAAK,CACJ,gBAAgB,CAAE,4BAA4B,CAGjD,aAAa,CACZ,OAAO,CAAE,qBAAqB,CAC9B,KAAK,CAAE,IAAI,CAEZ,QAAQ,CACP,QAAQ,CAAE,QAAQ,CAClB,KAAK,CAAE,IAAI,CACX,OAAO,CAAE,MAAM,CACf,IAAI,CAAE,CAAC,CACP,KAAK,CAAE,KAAK,CACZ,OAAO,CAAE,IAAI,CAEb,gCAAuB,CACtB,OAAO,CAAE,IAAI,CAEf,YAAY,CACX,KAAK,CAAE,kBAAkB,CAEzB,4BAAe,CACd,KAAK,CAAE,KAAK,CAGb,oCAAI,CACH,SAAS,CAlGK,MAAM,CAoGtB,+JAAwF,CAEvF,YAAY,CAAE,KAAK,CACnB,aAAa,CAAE,KAAK,CAErB,YAAY,CACX,aAAa,CAAE,IAAI,CAIlB,sDAAI,CACH,SAAS,CAAE,MAAM,CAGnB,gBAAI,CACH,QAAQ,CAAE,QAAQ,CAClB,SAAS,CAAE,KAAK,CAEhB,6BAAc,CACb,SAAS,CAAE,MAAM,CACjB,aAAa,CAAE,KAAK,CAEpB,gEAAK,CACJ,UAAU,CAAE,IAAI,CAEjB,4CAAc,CACb,QAAQ,CAAE,QAAQ,CAClB,SAAS,CAAE,GAAG,CACd,SAAS,CAAE,gBAAgB,CAE3B,gDAAG,CACF,SAAS,CAAE,KAAK,CAMrB,MAAM,CACL,MAAM,CAxIe,KAAK,CAyI1B,QAAQ,CAAE,QAAQ,CAClB,mBAAmB,CAAE,aAAa,CAClC,eAAe,CAAE,KAAK,CAMrB,eAAE,CACD,OAAO,CAAE,KAAK,CAGf,wBAAG,CACF,KAAK,CAAE,gBAAgB,CAExB,4BAAS,CACR,WAAW,CAAE,IAAI,CAcpB,MAAM,CACL,KAAK,CAAE,IAAI,CACX,gBAAgB,CAAE,0BAA0B,CAC5C,gBAAgB,CJ1KN,OAAO,CI4KjB,WAAI,CACH,OAAO,CAAE,MAAM,CAEhB,UAAG,CACF,QAAQ,CAAE,MAAM,CAChB,aAAa,CAAE,IAAI,CAEnB,YAAC,CACA,KAAK,CAAE,MAAM,CACb,KAAK,CAAE,IAAI,CACX,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAChB,WAAW,CAAE,MAAM,CAErB,cAAO,CACN,OAAO,CAAE,MAAM,CACf,SAAS,CAAE,MAAM,CAEjB,kBAAG,CACF,KAAK,CAAE,IAAI,CAEZ,6BAAc,CACb,KAAK,CAAE,KAAK,CAEf,kBAAmB,CAClB,gBAAgB,CAAE,WAAW,CAC7B,OAAO,CAAE,IAAI,CACb,SAAS,CAAE,IAAI,CACf,WAAW,CAAE,GAAG,CAChB,KAAK,CAAE,IAAK,CACZ,MAAM,CAAE,cAAe,CACvB,UAAU,CAAE,GAAI,CAEhB,8BAAO,CACN,gBAAgB,CJ/MN,OAAO,CIgNjB,KAAK,CJ/MI,OAAO,CIiNlB,SAAS,CACR,OAAO,CAAE,YAAY,CACrB,gBAAgB,CAAE,gCAAgC,CAClD,iBAAiB,CAAE,SAAS,CAC5B,eAAe,CAAE,IAAI,CACrB,KAAK,CAAE,IAAI,CACX,MAAM,CAAE,IAAI,CACZ,aAAa,CAAE,GAAG,CAClB,YAAY,CAAE,IAAI,CAElB,eAAO,CACN,gBAAgB,CAAE,IAAI,CAEvB,cAAI,CACH,QAAQ,CAAE,QAAQ,CAClB,OAAO,CAAE,KAAK,CACd,MAAM,CAAE,CAAC,CACT,QAAQ,CAAE,MAAM,CAElB,SAAS,CACR,mBAAmB,CAAE,GAAG,CAExB,eAAO,CACN,mBAAmB,CAAE,MAAM,CAE7B,gBAAgB,CACf,mBAAmB,CAAE,OAAO,CAE5B,sBAAO,CACN,mBAAmB,CAAE,UAAU,CAEjC,OAAO,CACN,mBAAmB,CAAE,QAAQ,CAE7B,aAAO,CACN,mBAAmB,CAAE,WAAW,CAElC,QAAQ,CACP,mBAAmB,CAAE,QAAQ,CAE7B,cAAO,CACN,mBAAmB,CAAE,WAAW,CAElC,cAAc,CACb,mBAAmB,CAAE,QAAQ,CAE7B,oBAAO,CACN,mBAAmB,CAAE,WAAW,CAElC,UAAU,CACT,mBAAmB,CAAE,QAAQ,CAE7B,gBAAO,CACN,mBAAmB,CAAE,WAAW,CA0BjC,gCAAK,CACJ,UAAU,CAAE,IAAI,CAEhB,sCAAE,CACD,OAAO,CAAE,UAAU,CAErB,kDAAc,CACb,KAAK,CAAE,IAAI,CACX,gBAAgB,CJ1SZ,OAAO,CI2SX,OAAO,CAAE,MAAM,CAMhB,cAAG,CACF,KAAK,CAAE,gBAAgB,CAIxB,6BAAG,CACF,KAAK,CAAE,GAAG,CACV,UAAU,CAAE,KAAK,EAEpB,qCAAqC,CACpC,YAAY,CACX,aAAa,CAAE,KAAK,EAEtB,oCAAoC,CAElC,kBAAO,CACN,WAAW,CAAE,IAAI", +"sources": ["../../sass/_reset.sass","../../sass/_skin.sass","../../sass/_size.sass","../../sass/_base.sass","../../sass/_tablet.sass","../../sass/_desktop.sass"], +"names": [], +"file": "styles.css" +} diff --git a/static/docs/reference/generated/kubectl/diff-kubectl-cmds-1.11-1.12 b/static/docs/reference/generated/kubectl/diff-kubectl-cmds-1.11-1.12 new file mode 100644 index 0000000000..4980730998 --- /dev/null +++ b/static/docs/reference/generated/kubectl/diff-kubectl-cmds-1.11-1.12 @@ -0,0 +1,383 @@ +When you run the generator for the kubectl command ref docs, +you get a set of markdown files in +kubernetes-incubator/reference-docs/gen-kubectldocs/generators/build/documents. + +This file is a diff of the build/documents directory for 1.11 +and the build/documents directory for 1.12. + + +diff -r v1_11/_generated_apply.md v1_12/_generated_apply.md +56c56 +< output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath-file|jsonpath. +--- +> output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. +62a63 +> server-dry-run | | false | If true, request will be sent to server with dry-run flag, which means the modifications won't be persisted. This is an alpha feature and flag. +105a107 +> 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. +108c110 +< output | o | yaml | Output format. One of: yaml|json. +--- +> output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. +110a113 +> 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]. +154c157 +< output | o | | Output format. One of: json|yaml|name|go-template|go-template-file|templatefile|template|jsonpath-file|jsonpath. +--- +> output | o | | Output format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file. + + +diff -r v1_11/_generated_auth.md v1_12/_generated_auth.md +105c105 +< output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|go-template-file|templatefile|template|go-template|jsonpath|jsonpath-file. +106a107,108 +> remove-extra-permissions | | false | If true, removes extra permissions added to roles +> remove-extra-subjects | | false | If true, removes extra subjects added to rolebindings + + +diff -r v1_11/_generated_autoscale.md v1_12/_generated_autoscale.md +41c41 +< output | o | | Output format. One of: json|yaml|name|go-template-file|templatefile|template|go-template|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. + + +diff -r v1_11/_generated_certificate.md v1_12/_generated_certificate.md +70c70 +< output | o | | Output format. One of: json|yaml|name|go-template|go-template-file|templatefile|template|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. + + +diff -r v1_11/_generated_cluster-info.md v1_12/_generated_cluster-info.md +67c67 +< output | o | json | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. +--- +> output | o | json | Output format. One of: json|yaml|name|go-template|go-template-file|templatefile|template|jsonpath-file|jsonpath. + + +diff -r v1_11/_generated_completion.md v1_12/_generated_completion.md +24c24 +< >bdocs-tab:example Installing bash completion on Linux ## Load the kubectl completion code for bash into the current shell +--- +> >bdocs-tab:example Installing bash completion on Linux ## If bash-completion is not installed on Linux, please install the 'bash-completion' package ## via your distribution's package manager. ## Load the kubectl completion code for bash into the current shell + + +diff -r v1_11/_generated_config.md v1_12/_generated_config.md +12,13c12,13 +< 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. 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. +--- +> 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. If $KUBECONFIG environment variable is set, then it is used as 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. +246c246 +< `$ set-context NAME [--cluster=cluster_nickname] [--user=user_nickname] [--namespace=namespace]` +--- +> `$ set-context [NAME | --current] [--cluster=cluster_nickname] [--user=user_nickname] [--namespace=namespace]` +249a250,256 +> ### Flags +> +> Name | Shorthand | Default | Usage +> ---- | --------- | ------- | ----- +> current | | false | Modify the current context +> +> +414c421 +< output | o | yaml | Output format. One of: json|yaml|name|go-template-file|templatefile|template|go-template|jsonpath|jsonpath-file. +--- +> output | o | yaml | Output format. One of: json|yaml|name|go-template|go-template-file|templatefile|template|jsonpath|jsonpath-file. + + +diff -r v1_11/_generated_convert.md v1_12/_generated_convert.md +44,45c44,45 +< output | o | yaml | Output format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file. +< output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1').) +--- +> output | o | yaml | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. +> output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + + +diff -r v1_11/_generated_create.md v1_12/_generated_create.md +111c111 +< output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file. +217c217 +< output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|go-template-file|templatefile|template|go-template|jsonpath|jsonpath-file. +251c251 +< output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file. +261a262,273 +> >bdocs-tab:example Create a job +> +> ```bdocs-tab:example_shell +> kubectl create job my-job --image=busybox +> ``` +> +> >bdocs-tab:example Create a job with command +> +> ```bdocs-tab:example_shell +> kubectl create job my-job --image=busybox -- date +> ``` +> +273c285 +< `$ job NAME [--from=CRONJOB]` +--- +> `$ job NAME [--image=image --from=cronjob/name] -- [COMMAND] [args...]` +283a296 +> image | | | Image name to run. +358c371 +< output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file. +373c386 +< kubectl create priorityclass default-priority --value=1000 --description="high priority" +--- +> kubectl create priorityclass high-priority --value=1000 --description="high priority" +400c413 +< output | o | | Output format. One of: json|yaml|name|go-template-file|templatefile|template|go-template|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file. +441c454 +< output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|go-template-file|templatefile|template|go-template|jsonpath|jsonpath-file. +530c543 +< output | o | | Output format. One of: json|yaml|name|go-template|go-template-file|templatefile|template|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath-file|jsonpath. +664c677 +< output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath-file|jsonpath. +795c808 +< output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath-file|jsonpath. +--- +> output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. +829c842 +< output | o | | Output format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. +864c877 +< output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file. +898c911 +< output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file. + + +diff -r v1_11/_generated_edit.md v1_12/_generated_edit.md +56c56 +< output | o | | Output format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath-file|jsonpath. +--- +> output | o | | Output format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file. + + +diff -r v1_11/_generated_expose.md v1_12/_generated_expose.md +59c59 +< `$ 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]` +--- +> `$ expose (-f FILENAME | TYPE NAME) [--port=port] [--protocol=TCP|UDP|SCTP] [--target-port=number-or-name] [--name=name] [--external-ip=external-ip-of-service] [--type=type]` +77c77 +< output | o | | Output format. One of: json|yaml|name|go-template|go-template-file|templatefile|template|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. + + +diff -r v1_11/_generated_label.md v1_12/_generated_label.md +68c68 +< output | o | | Output format. One of: json|yaml|name|go-template|go-template-file|templatefile|template|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file. + + +diff -r v1_11/_generated_logs.md v1_12/_generated_logs.md +76d75 +< interactive | | false | If true, prompt the user for input when required. + + +diff -r v1_11/_generated_patch.md v1_12/_generated_patch.md +57c57 +< output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath-file|jsonpath. +--- +> output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. + + +diff -r v1_11/_generated_plugin.md v1_12/_generated_plugin.md +8c8 +< Runs a command-line plugin. +--- +> Provides utilities for interacting with plugins. +10c10 +< 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. +--- +> Plugins provide extended functionality that is not part of the major command-line distribution. Please refer to the documentation and examples for more information about how write your own plugins. +14c14,38 +< `$ plugin NAME` +--- +> `$ plugin [flags]` +> +> +> +> ------------ +> +> ## list +> +> +> +> List all available plugin files on a user's PATH. +> +> Available plugin files are those that are: - executable - anywhere on the user's PATH - begin with "kubectl-" +> +> ### Usage +> +> `$ list` +> +> +> +> ### Flags +> +> Name | Shorthand | Default | Usage +> ---- | --------- | ------- | ----- +> name-only | | false | If true, display only the binary name of each plugin, rather than its full path + + +diff -r v1_11/_generated_port-forward.md v1_12/_generated_port-forward.md +17a18,23 +> >bdocs-tab:example Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in a pod selected by the service +> +> ```bdocs-tab:example_shell +> kubectl port-forward service/myservice 5000 6000 +> ``` +> + + +diff -r v1_11/_generated_proxy.md v1_12/_generated_proxy.md +59a60 +> keepalive | | 0s | keepalive specifies the keep-alive period for an active network connection. Set to 0 to disable keepalive. + + +diff -r v1_11/_generated_replace.md v1_12/_generated_replace.md +54c54 +< output | o | | Output format. One of: json|yaml|name|go-template-file|templatefile|template|go-template|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|go-template|go-template-file|templatefile|template|jsonpath|jsonpath-file. + + +diff -r v1_11/_generated_rolling-update.md v1_12/_generated_rolling-update.md +60c60 +< output | o | | Output format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|go-template|go-template-file|templatefile|template|jsonpath|jsonpath-file. + + +diff -r v1_11/_generated_rollout.md v1_12/_generated_rollout.md +61a62 +> 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. +62a64 +> output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. +64a67 +> 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]. +92a96 +> 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. +93a98 +> output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath-file|jsonpath. +94a100 +> 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]. +122a129 +> 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. +123a131 +> output | o | | Output format. One of: json|yaml|name|go-template|go-template-file|templatefile|template|jsonpath|jsonpath-file. +124a133 +> 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]. +155a165 +> timeout | | 0s | The length of time to wait before ending watch, zero means never. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). +194a205 +> 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. +196a208 +> output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. +197a210 +> 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]. + + +diff -r v1_11/_generated_run-container.md v1_12/_generated_run-container.md +27c27 +< kubectl run hazelcast --image=nginx --labels="app=hazelcast,env=prod" +--- +> kubectl run hazelcast --image=hazelcast --labels="app=hazelcast,env=prod" + + +diff -r v1_11/_generated_run.md v1_12/_generated_run.md +27c27 +< kubectl run hazelcast --image=nginx --labels="app=hazelcast,env=prod" +--- +> kubectl run hazelcast --image=hazelcast --labels="app=hazelcast,env=prod" + + +diff -r v1_11/_generated_scale.md v1_12/_generated_scale.md +57c57 +< output | o | | Output format. One of: json|yaml|name|go-template|go-template-file|templatefile|template|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. + + +diff -r v1_11/_generated_set.md v1_12/_generated_set.md +180c180 +< output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|go-template-file|templatefile|template|go-template|jsonpath|jsonpath-file. +241c241 +< output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath-file|jsonpath. +282c282 +< output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath-file|jsonpath. +--- +> output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. +329c329 +< output | o | | Output format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath-file|jsonpath. +--- +> output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. + + +diff -r v1_11/_generated_version.md v1_12/_generated_version.md +25c25 +< client | c | false | Client version only (no server required). +--- +> client | | false | Client version only (no server required). + + +diff -r v1_11/_generated_wait.md v1_12/_generated_wait.md +5a6 +> >bdocs-tab:example Wait for the pod "busybox1" to contain the status condition of type "Ready". +6a8,10 +> ```bdocs-tab:example_shell +> kubectl wait --for=condition=Ready pod/busybox1 +> ``` +7a12 +> >bdocs-tab:example Wait for the pod "busybox1" to be deleted, with a timeout of 60s, after having issued the "delete" command. +8a14,26 +> ```bdocs-tab:example_shell +> kubectl delete pod/busybox1 +> kubectl wait --for=delete pod/busybox1 --timeout=60s +> ``` +> +> +> Experimental: Wait for a specific condition on one or many resources. +> +> The command takes multiple resources and waits until the specified condition is seen in the Status field of every given resource. +> +> Alternatively, the command can wait for the given set of resources to be deleted by providing the "delete" keyword as the value to the --for flag. +> +> A successful message will be printed to stdout indicating when the specified condition has been met. One can use -o option to change to output destination. +24c42 +< output | o | | Output format. One of: json|yaml|name|go-template|go-template-file|templatefile|template|jsonpath|jsonpath-file. +--- +> output | o | | Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. diff --git a/static/docs/reference/generated/kubectl/kubectl-commands.html b/static/docs/reference/generated/kubectl/kubectl-commands.html index c060bb0cef..22b58af1de 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

@@ -84,7 +84,7 @@ inspect them.

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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. raw @@ -120,7 +120,7 @@ inspect them.

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]. +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 @@ -210,7 +210,7 @@ inspect them.

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 format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file. resource @@ -234,7 +234,7 @@ inspect them.

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]. +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 @@ -305,7 +305,7 @@ inspect them.

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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. save-config @@ -323,7 +323,7 @@ inspect them.

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]. +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 @@ -423,7 +423,7 @@ inspect them.

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 format. One of: json|yaml|name|go-template-file|templatefile|template|go-template|jsonpath|jsonpath-file. save-config @@ -435,7 +435,7 @@ inspect them.

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]. +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 @@ -494,7 +494,7 @@ inspect them.

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 format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file. save-config @@ -506,7 +506,7 @@ inspect them.

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]. +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 @@ -519,13 +519,23 @@ inspect them.


job

+

Create a job

+
+
kubectl create job my-job --image=busybox
+
+
+

Create a job with command

+
+
kubectl create job my-job --image=busybox -- date
+
+

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]

+

$ job NAME [--image=image --from=cronjob/name] -- [COMMAND] [args...]

Flags

@@ -556,10 +566,16 @@ inspect them.

+ + + + + + - + @@ -571,7 +587,7 @@ inspect them.

- + @@ -624,7 +640,7 @@ inspect them.

- + @@ -636,7 +652,7 @@ inspect them.

- + @@ -706,7 +722,7 @@ inspect them.

- + @@ -724,7 +740,7 @@ inspect them.

- + @@ -739,7 +755,7 @@ inspect them.

Create a priorityclass named high-priority

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

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

@@ -794,7 +810,7 @@ inspect them.

- + @@ -806,7 +822,7 @@ inspect them.

- + @@ -876,7 +892,7 @@ inspect them.

- + @@ -894,7 +910,7 @@ inspect them.

- + @@ -956,7 +972,7 @@ inspect them.

- + @@ -980,7 +996,7 @@ inspect them.

- + @@ -1051,7 +1067,7 @@ inspect them.

- + @@ -1075,7 +1091,7 @@ inspect them.

- + @@ -1176,7 +1192,7 @@ inspect them.

- + @@ -1188,7 +1204,7 @@ inspect them.

- + @@ -1288,7 +1304,7 @@ inspect them.

- + @@ -1300,7 +1316,7 @@ inspect them.

- + @@ -1378,7 +1394,7 @@ inspect them.

- + @@ -1390,7 +1406,7 @@ inspect them.

- + @@ -1459,7 +1475,7 @@ inspect them.

- + @@ -1477,7 +1493,7 @@ inspect them.

- + @@ -1537,7 +1553,7 @@ inspect them.

- + @@ -1555,7 +1571,7 @@ inspect them.

- + @@ -1608,7 +1624,7 @@ inspect them.

- + @@ -1626,7 +1642,7 @@ inspect them.

- + @@ -1685,7 +1701,7 @@ inspect them.

- + @@ -1703,7 +1719,7 @@ inspect them.

- + @@ -1756,7 +1772,7 @@ inspect them.

- + @@ -1768,7 +1784,7 @@ inspect them.

- + @@ -1907,7 +1923,7 @@ inspect them.

- + @@ -1961,7 +1977,7 @@ inspect them.

- + @@ -2003,7 +2019,7 @@ inspect them.

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"
+
kubectl run hazelcast --image=hazelcast --labels="app=hazelcast,env=prod"
 

Start a replicated instance of nginx.

@@ -2061,6 +2077,12 @@ inspect them.

+ + + + + + @@ -2160,7 +2182,7 @@ inspect them.

- + @@ -2259,6 +2281,12 @@ inspect them.

+ + + + + + @@ -2320,7 +2348,7 @@ inspect them.

Possible resources include (case insensitive):

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

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]

+

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

Flags

The name of the resource to create a Job from (only cronjob is supported).
imageImage name to run.
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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file.
save-config 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]. 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 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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file.
save-config 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]. 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 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 format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file.
save-config 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]. 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 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 format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file.
save-configtemplate 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]. 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].
validateoutput 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 format. One of: json|yaml|name|go-template-file|templatefile|template|go-template|jsonpath|jsonpath-file.
save-configtemplate 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]. 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].
validateoutput 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 format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file.
resourcetemplate 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]. 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].
validateoutput 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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath-file|jsonpath.
roletemplate 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]. 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].
validateoutput 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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file.
save-configtemplate 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]. 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].
validateoutput 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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath-file|jsonpath.
save-configtemplate 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]. 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].
typeoutput 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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file.
save-configtemplate 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]. 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].
validateoutput 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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file.
save-configtemplate 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]. 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].
validateoutput 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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file.
save-configtemplate 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]. 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].
validateoutput 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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file.
save-configtemplate 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]. 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].
validateoutput 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 format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file.
save-configtemplate 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]. 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].
validateoutput 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 format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file.
save-configtemplate 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]. 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].
validateoutput 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 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].
rawtemplate 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]. 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].
use-openapi-print-columns
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.
attach falseoutput 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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file.
overridesKeep stdin open on the container(s) in the pod, even if nothing is attached.
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].
timeout 0s
@@ -2333,6 +2361,12 @@ inspect them.

+ + + + + + @@ -2390,7 +2424,7 @@ inspect them.

- + @@ -2447,6 +2481,12 @@ inspect them.

+ + + + + + @@ -2643,6 +2683,12 @@ viewing your workloads in a Kubernetes cluster.

+ + + + + + @@ -2688,7 +2734,7 @@ viewing your workloads in a Kubernetes cluster.

- + @@ -2706,7 +2752,7 @@ viewing your workloads in a Kubernetes cluster.

- + @@ -2727,6 +2773,18 @@ viewing your workloads in a Kubernetes cluster.

+ + + + + + + + + + + + @@ -2777,6 +2835,12 @@ viewing your workloads in a Kubernetes cluster.

+ + + + + + @@ -2791,8 +2855,8 @@ viewing your workloads in a Kubernetes cluster.

- - + + @@ -2807,6 +2871,12 @@ viewing your workloads in a Kubernetes cluster.

+ + + + + + @@ -2846,6 +2916,12 @@ viewing your workloads in a Kubernetes cluster.

+ + + + + + @@ -2867,7 +2943,13 @@ viewing your workloads in a Kubernetes 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.
cluster-ip 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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file.
overridesName 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].
type 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.
cascade trueoutput 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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file.
overwriteprune-whitelist []Overwrite the default whitelist with for --prune Overwrite the default whitelist with <group/version/kind> for --prune
recordSelector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2)
server-dry-runfalseIf true, request will be sent to server with dry-run flag, which means the modifications won't be persisted. This is an alpha feature and flag.
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].
timeout 0s
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.
filename f []
output oyamlOutput format. One of: yaml|json. Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file.
recordProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
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].
windows-line-endings false
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-annotation falseoutput 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 format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file.
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].
@@ -2986,6 +3068,12 @@ viewing your workloads in a Kubernetes cluster.

Select 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. + + dry-run false @@ -3019,7 +3107,7 @@ viewing your workloads in a Kubernetes cluster.

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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. overwrite @@ -3051,6 +3139,12 @@ viewing your workloads in a Kubernetes cluster.

Selector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). + +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]. +
@@ -3081,6 +3175,12 @@ viewing your workloads in a Kubernetes cluster.

+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. + + cpu-percent -1 @@ -3126,7 +3226,7 @@ viewing your workloads in a Kubernetes cluster.

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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. record @@ -3146,6 +3246,12 @@ viewing your workloads in a Kubernetes cluster.

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. + +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]. +
@@ -3182,6 +3288,12 @@ viewing your workloads in a Kubernetes cluster.

+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. + + filename f [] @@ -3197,13 +3309,13 @@ viewing your workloads in a Kubernetes cluster.

output o yaml -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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. output-version -Output the formatted object with the given group version (for ex: 'extensions/v1beta1').) +Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). recursive @@ -3212,6 +3324,12 @@ viewing your workloads in a Kubernetes cluster.

Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. +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]. + + validate true @@ -3261,6 +3379,12 @@ viewing your workloads in a Kubernetes cluster.

+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. + + filename f [] @@ -3276,7 +3400,7 @@ viewing your workloads in a Kubernetes cluster.

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 format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file. output-patch @@ -3303,6 +3427,12 @@ viewing your workloads in a Kubernetes cluster.

If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. +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]. + + validate true @@ -3375,6 +3505,12 @@ viewing your workloads in a Kubernetes cluster.

Select 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. + + dry-run false @@ -3414,7 +3550,7 @@ viewing your workloads in a Kubernetes cluster.

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 format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file. overwrite @@ -3446,6 +3582,12 @@ viewing your workloads in a Kubernetes cluster.

Selector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). + +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]. +
@@ -3492,6 +3634,12 @@ viewing your workloads in a Kubernetes cluster.

+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-run false @@ -3513,7 +3661,7 @@ viewing your workloads in a Kubernetes cluster.

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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. patch @@ -3534,6 +3682,12 @@ viewing your workloads in a Kubernetes cluster.

Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. +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]. + + type strategic @@ -3581,6 +3735,12 @@ viewing your workloads in a Kubernetes cluster.

+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. + + cascade true @@ -3608,7 +3768,7 @@ viewing your workloads in a Kubernetes cluster.

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 format. One of: json|yaml|name|go-template|go-template-file|templatefile|template|jsonpath|jsonpath-file. recursive @@ -3623,6 +3783,12 @@ viewing your workloads in a Kubernetes cluster.

If true, the configuration of current object will be saved in its annotation. Otherwise, the annotation will be unchanged. This flag is useful when you want to perform kubectl apply on this object in the future. +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]. + + timeout 0s @@ -3690,12 +3856,24 @@ viewing your workloads in a Kubernetes cluster.

+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. + + filename f [] Filename, directory, or URL to files identifying the resource to get from a server. +output +o + +Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. + + recursive R false @@ -3707,6 +3885,12 @@ viewing your workloads in a Kubernetes cluster.

0 See the details, including podTemplate of the revision specified + +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]. +
@@ -3732,17 +3916,35 @@ viewing your workloads in a Kubernetes cluster.

+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. + + filename f [] Filename, directory, or URL to files identifying the resource to get from a server. +output +o + +Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath-file|jsonpath. + + recursive R false Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + +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]. +
@@ -3768,17 +3970,35 @@ viewing your workloads in a Kubernetes cluster.

+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. + + filename f [] Filename, directory, or URL to files identifying the resource to get from a server. +output +o + +Output format. One of: json|yaml|name|go-template|go-template-file|templatefile|template|jsonpath|jsonpath-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. + +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]. +
@@ -3822,6 +4042,12 @@ viewing your workloads in a Kubernetes cluster.

Pin to a specific revision for showing its status. Defaults to 0 (last revision). +timeout + +0s +The length of time to wait before ending watch, zero means never. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). + + watch w true @@ -3861,6 +4087,12 @@ viewing your workloads in a Kubernetes cluster.

+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-run false @@ -3873,12 +4105,24 @@ viewing your workloads in a Kubernetes cluster.

Filename, directory, or URL to files identifying the resource to get from a server. +output +o + +Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-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. +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]. + + to-revision 0 @@ -3936,6 +4180,12 @@ viewing your workloads in a Kubernetes cluster.

Select all resources 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. + + current-replicas -1 @@ -3951,7 +4201,7 @@ viewing your workloads in a Kubernetes cluster.

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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. record @@ -3984,6 +4234,12 @@ viewing your workloads in a Kubernetes cluster.

Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) +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]. + + timeout 0s @@ -4079,6 +4335,12 @@ viewing your workloads in a Kubernetes cluster.

If true, select all resources 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. + + containers c * @@ -4130,7 +4392,7 @@ viewing your workloads in a Kubernetes cluster.

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 format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file. overwrite @@ -4162,6 +4424,12 @@ viewing your workloads in a Kubernetes cluster.

Selector (label query) to filter on + +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]. +
@@ -4209,6 +4477,12 @@ viewing your workloads in a Kubernetes cluster.

Select 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. + + dry-run false @@ -4236,7 +4510,7 @@ viewing your workloads in a Kubernetes cluster.

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 format. One of: json|yaml|name|go-template-file|templatefile|template|go-template|jsonpath|jsonpath-file. record @@ -4256,6 +4530,12 @@ viewing your workloads in a Kubernetes cluster.

Selector (label query) to filter on, not including uninitialized ones, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) + +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]. +
@@ -4303,6 +4583,12 @@ viewing your workloads in a Kubernetes cluster.

Select 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. + + containers c * @@ -4342,7 +4628,7 @@ viewing your workloads in a Kubernetes cluster.

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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath-file|jsonpath. record @@ -4368,6 +4654,12 @@ viewing your workloads in a Kubernetes cluster.

Selector (label query) to filter on, not including uninitialized ones,supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) + +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]. +
@@ -4400,6 +4692,12 @@ viewing your workloads in a Kubernetes cluster.

Select all resources 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. + + dry-run false @@ -4427,7 +4725,7 @@ viewing your workloads in a Kubernetes cluster.

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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. record @@ -4447,6 +4745,12 @@ viewing your workloads in a Kubernetes cluster.

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. + +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]. +
@@ -4484,6 +4788,12 @@ viewing your workloads in a Kubernetes cluster.

Select 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. + + dry-run false @@ -4511,7 +4821,7 @@ viewing your workloads in a Kubernetes cluster.

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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. record @@ -4525,6 +4835,12 @@ viewing your workloads in a Kubernetes cluster.

false Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + +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]. +
@@ -4565,6 +4881,12 @@ viewing your workloads in a Kubernetes cluster.

Select 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. + + dry-run false @@ -4598,7 +4920,7 @@ viewing your workloads in a Kubernetes cluster.

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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. recursive @@ -4618,10 +4940,31 @@ viewing your workloads in a Kubernetes cluster.

[] Service accounts to bind to the role + +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]. +

wait

+
+

Wait for the pod "busybox1" to contain the status condition of type "Ready".

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

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

+
+
kubectl delete pod/busybox1
+kubectl wait --for=delete pod/busybox1 --timeout=60s
+
+

Experimental: Wait for a specific condition on one or many resources.

+

The command takes multiple resources and waits until the specified condition is seen in the Status field of every given resource.

+

Alternatively, the command can wait for the given set of resources to be deleted by providing the "delete" keyword as the value to the --for flag.

+

A successful message will be printed to stdout indicating when the specified condition has been met. One can use -o option to change to output destination.

Usage

$ wait resource.group/name [--for=delete|--for condition=available]

Flags

@@ -4642,6 +4985,12 @@ viewing your workloads in a Kubernetes cluster.

If 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. + + filename f [] @@ -4657,7 +5006,7 @@ viewing your workloads in a Kubernetes cluster.

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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. recursive @@ -4672,6 +5021,12 @@ viewing your workloads in a Kubernetes cluster.

Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) +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]. + + timeout 30s @@ -4844,6 +5199,12 @@ applications.

+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-run false @@ -4859,7 +5220,7 @@ applications.

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 format. One of: json|yaml|name|go-template-file|templatefile|template|go-template|jsonpath|jsonpath-file. recursive @@ -4867,6 +5228,24 @@ applications.

false Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + +remove-extra-permissions + +false +If true, removes extra permissions added to roles + + +remove-extra-subjects + +false +If true, removes extra subjects added to rolebindings + + +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]. +
@@ -5143,12 +5522,6 @@ applications.

Specify if the logs should be streamed. -interactive - -false -If true, prompt the user for input when required. - - limit-bytes 0 @@ -5211,6 +5584,11 @@ applications.

kubectl port-forward deployment/mydeployment 5000 6000
 
+

Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in a pod selected by the service

+
+
kubectl port-forward service/myservice 5000 6000
+
+

Listen on port 8888 locally, forwarding to 5000 in the pod

kubectl port-forward pod/mypod 8888:5000
@@ -5321,6 +5699,12 @@ applications.

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. +keepalive + +0s +keepalive specifies the keep-alive period for an active network connection. Set to 0 to disable keepalive. + + port p 8001 @@ -5541,6 +5925,12 @@ applications.

+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. + + filename f [] @@ -5556,7 +5946,7 @@ applications.

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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. recursive @@ -5564,6 +5954,12 @@ applications.

false Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + +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]. +
@@ -5584,6 +5980,12 @@ applications.

+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. + + filename f [] @@ -5599,7 +6001,7 @@ applications.

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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. recursive @@ -5607,6 +6009,12 @@ applications.

false Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + +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]. +
@@ -5663,12 +6071,24 @@ applications.

If true, dump all namespaces. If true, --namespaces is ignored. +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. + + namespaces [] A comma separated list of namespaces to dump. +output +o +json +Output format. One of: json|yaml|name|go-template|go-template-file|templatefile|template|jsonpath-file|jsonpath. + + output-directory @@ -5680,6 +6100,12 @@ applications.

20s The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running + +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]. +
@@ -5730,7 +6156,7 @@ applications.

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

+

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

@@ -5848,10 +6274,16 @@ applications.

Select all nodes in the cluster +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. + + 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 format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. overwrite @@ -5866,6 +6298,12 @@ applications.

Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2) +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]. + + validate true @@ -6059,7 +6497,7 @@ applications.

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

+

Installing bash completion on Linux ## If bash-completion is not installed on Linux, please install the 'bash-completion' package ## via your distribution's package manager. ## Load the kubectl completion code for bash into the current shell

source <(kubectl completion bash)
 
@@ -6096,8 +6534,8 @@ source $HOME/.bash_profile

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. -
  3. 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.
  4. +
  5. If the --kubeconfig flag is set, then only that file is loaded. The flag may only be set once and no merging takes place.
  6. +
  7. If $KUBECONFIG environment variable is set, then it is used as 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.
  8. Otherwise, ${HOME}/.kube/config is used and no merging takes place.

Usage

@@ -6271,7 +6709,26 @@ source $HOME/.bash_profile

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-context [NAME | --current] [--cluster=cluster_nickname] [--user=user_nickname] [--namespace=namespace]

+

Flags

+ + + + + + + + + + + + + + + + + +
NameShorthandDefaultUsage
currentfalseModify the current context

set-credentials

@@ -6444,7 +6901,7 @@ source $HOME/.bash_profile output o yaml -Output 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]. +Output format. One of: json|yaml|name|go-template|go-template-file|templatefile|template|jsonpath|jsonpath-file. raw @@ -6456,7 +6913,7 @@ source $HOME/.bash_profile 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]. +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]. @@ -6516,10 +6973,35 @@ source $HOME/.bash_profile

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

+

Provides utilities for interacting with plugins.

+

Plugins provide extended functionality that is not part of the major command-line distribution. Please refer to the documentation and examples for more information about how write your own plugins.

Usage

-

$ plugin NAME

+

$ plugin [flags]

+
+

list

+

List all available plugin files on a user's PATH.

+

Available plugin files are those that are: - executable - anywhere on the user's PATH - begin with "kubectl-"

+

Usage

+

$ list

+

Flags

+ + + + + + + + + + + + + + + + + +
NameShorthandDefaultUsage
name-onlyfalseIf true, display only the binary name of each plugin, rather than its full path

version

@@ -6543,7 +7025,7 @@ source $HOME/.bash_profile client -c + false Client version only (no server required). @@ -6606,6 +7088,12 @@ source $HOME/.bash_profile +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. + + container @@ -6645,7 +7133,7 @@ source $HOME/.bash_profile 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 format. One of: json|yaml|name|go-template|go-template-file|templatefile|template|jsonpath|jsonpath-file. poll-interval @@ -6660,6 +7148,12 @@ source $HOME/.bash_profile If 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 +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]. + + timeout 5m0s @@ -6699,7 +7193,7 @@ source $HOME/.bash_profile

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"
+
kubectl run hazelcast --image=hazelcast --labels="app=hazelcast,env=prod"
 

Start a replicated instance of nginx.

@@ -6757,6 +7251,12 @@ source $HOME/.bash_profile +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. + + attach false @@ -6856,7 +7356,7 @@ source $HOME/.bash_profile 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 format. One of: json|yaml|name|templatefile|template|go-template|go-template-file|jsonpath|jsonpath-file. overrides @@ -6955,6 +7455,12 @@ source $HOME/.bash_profile Keep stdin open on the container(s) in the pod, even if nothing is attached. +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]. + + timeout 0s diff --git a/static/docs/reference/generated/kubectl/navData.js b/static/docs/reference/generated/kubectl/navData.js index 4df43b4b82..075b2ca9ec 100644 --- a/static/docs/reference/generated/kubectl/navData.js +++ b/static/docs/reference/generated/kubectl/navData.js @@ -1 +1 @@ -(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 +(function(){navData = {"toc":[{"section":"run-container","subsections":[]},{"section":"rolling-update","subsections":[]},{"section":"-strong-deprecated-commands-strong-","subsections":[]},{"section":"version","subsections":[]},{"section":"plugin","subsections":[{"section":"-em-list-em-"}]},{"section":"options","subsections":[]},{"section":"explain","subsections":[]},{"section":"config","subsections":[{"section":"-em-view-em-"},{"section":"-em-use-context-em-"},{"section":"-em-unset-em-"},{"section":"-em-set-credentials-em-"},{"section":"-em-set-context-em-"},{"section":"-em-set-cluster-em-"},{"section":"-em-set-em-"},{"section":"-em-rename-context-em-"},{"section":"-em-get-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","-em-list-em-","plugin","options","explain","-em-view-em-","-em-use-context-em-","-em-unset-em-","-em-set-credentials-em-","-em-set-context-em-","-em-set-cluster-em-","-em-set-em-","-em-rename-context-em-","-em-get-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/kubernetes-api/v1.12/css/bootstrap.min.css b/static/docs/reference/generated/kubernetes-api/v1.12/css/bootstrap.min.css new file mode 100644 index 0000000000..ed3905e0e0 --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.12/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.12/css/font-awesome.min.css b/static/docs/reference/generated/kubernetes-api/v1.12/css/font-awesome.min.css new file mode 100644 index 0000000000..540440ce89 --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.12/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.12/css/stylesheet.css b/static/docs/reference/generated/kubernetes-api/v1.12/css/stylesheet.css new file mode 100644 index 0000000000..63a34be4b3 --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.12/css/stylesheet.css @@ -0,0 +1,228 @@ +/* +Kubernetes colors + +kubernetes blue - rgb(50, 109, 230) +dark blue - rgb(51, 113, 227) +dark grey - rgb(48, 48, 48) +light grey - rgb(161, 160, 158) +*/ + +/* User agent CSS overrides */ +#sidebar-wrapper ul, #sidebar-wrapper li { + margin-left: 10px; + padding-left: 0; +} + +.body-content hr { + margin: 2em 0; + border-top: 2px solid dimgrey; + border-bottom: 2px solid antiquewhite; +} + +.body-content table { + margin-bottom: 1em; + width: 100%; + overflow: auto; +} + +.body-content table th, .body-content table td { + text-align: left; + vertical-align: top; + line-height: 1.5; +} + +.body-content table th { + padding: 15px 20px; + border-bottom: 1px solid lightsteelblue; + vertical-align: bottom; +} + +.body-content table td { + padding: 10px; +} + +.body-content table tr:last-child { + border-bottom: 1px solid lightsteelblue; +} + +.body-content table tr:nth-child(odd) > td { + background-color: WhiteSmoke; +} + +.body-content table tr:nth-child(even) > td { + background-color: Gainsboro; +} + +.body-content dt { + font-weight: bold; +} + +.body-content dd { + margin-left: 15px; +} + +.body-content p, .body-content li, .body-content dt, .body-content dd { + line-height: 1.6; + margin-top: 0; +} + +/* Brodoc CSS */ + +body > #wrapper { + display: block; + padding-bottom: 500px; +} + +#sidebar-wrapper { + display: block; + height: 100%; + width: 20%; + position: fixed; + z-index: 1; + top: 0; + left: 0; + background-color: whitesmoke; + border-right: 2px solid slategrey; + overflow-x: hidden; + padding-top: 60px; +} + +#sidebar-wrapper a { + text-decoration: none; + white-space: nowrap; + overflow: hidden; + text-overflow: ellipsis; + padding: 0 5px; +} + +#sidebar-wrapper ul { + list-style: none; +} + +#sidebar-wrapper a.selected { + font-style: bold; + color: whitesmoke; + border: 1px solid rgb(161, 160, 158); + background-color: rgb(51, 113, 227); + border-radius: 5px; +} + +#sidebar-wrapper .strong-nav { + font-family: monospace; + font-weight: bold; +} + +#sidebar-wrapper .nav-level-1.strong-nav { + margin-top: 25px; +} + +#sidebar-wrapper .copyright { + padding-left: 10px; + padding-top: 50px; + padding-bottom: 50px; + text-decoration: underline; +} + +#page-content-wrapper { + margin-left: 20%; + padding-top: 60px; +} + +.body-content h1, .body-content h2 { + clear: both; + border-bottom: 3px solid lightslategrey; + padding-top: 20px; +} + +.body-content > h3, .body-content > h4, .body-content > h5, .body-content > h6, .body-content > p, .body-content > aside, .body-content > ul > li, .body-content > ul > li { + padding-top: 20px; +} + +.body-content table tr td:not(:first-child) { + overflow-wrap: break-word; + word-wrap: break-word; +} + +.body-content table tr td a { + word-break: break-word; +} + +.body-content p code { + text-overflow: ellipsis; + color: #802060; + display: inline-block; + font-size: smaller; + word-break: break-word; +} + +.body-content blockquote { + border-left: 0; + border-radius: 5px; +} + +.body-content pre.code-block { + margin-top: 5px; + margin-bottom: 5px; +} + +.body-content blockquote p, .body-content pre { + color: black; + font-size: 13px; +} + +.body-content blockquote.code-block { + background: Wheat; +} + +.body-content pre.code-block code { + word-wrap: normal; + white-space: pre; +} + +.body-content code { + color: Brown !important; +} + +.code-block { + display: none; + width: 60%; + float: left; + clear: right; +} + +.code-block.active { + display: initial; +} + +#code-tabs-wrapper { + width: 55%; + height: 60px; + /* position: fixed; */ + top: 0; + right: 0; +} + +#code-tabs-wrapper .code-tab-list { + float: right; + margin-top: 0; + padding: 0 10px; +} + +#code-tabs-wrapper .code-tab { + color: white; + /* display: inline-block; */ + padding: 0 30px; + background: rgb(48, 48, 48); + border: 1px solid rgb(161, 160, 158); + border-radius: 5px; +} + +#code-tabs-wrapper .tab-selected { + background: rgb(51, 113, 227); + font-style: bold; + border-radius: 5px; +} + +.side-nav a { + color: black; +} diff --git a/static/docs/reference/generated/kubernetes-api/v1.12/fonts/FontAwesome.otf b/static/docs/reference/generated/kubernetes-api/v1.12/fonts/FontAwesome.otf new file mode 100644 index 0000000000..401ec0f36e Binary files /dev/null and b/static/docs/reference/generated/kubernetes-api/v1.12/fonts/FontAwesome.otf differ diff --git a/static/docs/reference/generated/kubernetes-api/v1.12/fonts/fontawesome-webfont.eot b/static/docs/reference/generated/kubernetes-api/v1.12/fonts/fontawesome-webfont.eot new file mode 100644 index 0000000000..e9f60ca953 Binary files /dev/null and b/static/docs/reference/generated/kubernetes-api/v1.12/fonts/fontawesome-webfont.eot differ diff --git a/static/docs/reference/generated/kubernetes-api/v1.12/fonts/fontawesome-webfont.svg b/static/docs/reference/generated/kubernetes-api/v1.12/fonts/fontawesome-webfont.svg new file mode 100644 index 0000000000..855c845e53 --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.12/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.12/fonts/fontawesome-webfont.ttf b/static/docs/reference/generated/kubernetes-api/v1.12/fonts/fontawesome-webfont.ttf new file mode 100644 index 0000000000..35acda2fa1 Binary files /dev/null and b/static/docs/reference/generated/kubernetes-api/v1.12/fonts/fontawesome-webfont.ttf differ diff --git a/static/docs/reference/generated/kubernetes-api/v1.12/fonts/fontawesome-webfont.woff b/static/docs/reference/generated/kubernetes-api/v1.12/fonts/fontawesome-webfont.woff new file mode 100644 index 0000000000..400014a4b0 Binary files /dev/null and b/static/docs/reference/generated/kubernetes-api/v1.12/fonts/fontawesome-webfont.woff differ diff --git a/static/docs/reference/generated/kubernetes-api/v1.12/fonts/fontawesome-webfont.woff2 b/static/docs/reference/generated/kubernetes-api/v1.12/fonts/fontawesome-webfont.woff2 new file mode 100644 index 0000000000..4d13fc6040 Binary files /dev/null and b/static/docs/reference/generated/kubernetes-api/v1.12/fonts/fontawesome-webfont.woff2 differ diff --git a/static/docs/reference/generated/kubernetes-api/v1.12/index.html b/static/docs/reference/generated/kubernetes-api/v1.12/index.html new file mode 100644 index 0000000000..89b731b09e --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.12/index.html @@ -0,0 +1,49755 @@ + + + + +Kubernetes API Reference Docs + + + + + + + +
+
+

API OVERVIEW

+ +

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

+ +

Resource Categories

+ +

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

+

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

+

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

+

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

+

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

+

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

+ +
+ +

Resource Objects

+ +

Resource objects typically have 3 components:

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

Resource Operations

+ +

Most resources provide the following Operations:

+ +

Create

+ +

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

+ +

Update

+ +

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

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

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

Read

+ +

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

+ +

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

Delete

+ +

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

+ +

Additional Operations

+ +

Resources may define additional operations specific to that resource type.

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

Workloads APIs

+

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
+

Warning:

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

+
Appears In: + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
args
string array
Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
command
string array
Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
env
EnvVar array
patch strategy: merge
patch merge key: name
List of environment variables to set in the container. Cannot be updated.
envFrom
EnvFromSource array
List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
image
string
Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
imagePullPolicy
string
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
lifecycle
Lifecycle
Actions that the management system should take in response to container lifecycle events. Cannot be updated.
livenessProbe
Probe
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
name
string
Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
ports
ContainerPort array
patch strategy: merge
patch merge key: containerPort
List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.
readinessProbe
Probe
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
resources
ResourceRequirements
Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
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 strategy: 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 strategy: merge
patch merge key: mountPath
Pod volumes to mount into the container's filesystem. Cannot be updated.
workingDir
string
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
+

ContainerStatus v1 core

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

CronJob v1beta1 batch

+ + + + + +
GroupVersionKind
batchv1beta1CronJob
+
Other API versions of this object exist: +v2alpha1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

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

CronJobStatus v1beta1 batch

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

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

+

Create

+

create a CronJob

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
CronJob
+

Response

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

Patch

+

partially update the specified CronJob

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
CronJob
OK
+

Replace

+

replace the specified CronJob

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
CronJob
+

Response

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

Delete

+

delete a CronJob

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

delete collection of CronJob

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

Read

+

read the specified CronJob

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Query Parameters

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

+

Patch Status

+

partially update status of the specified CronJob

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
CronJob
OK
+

Read Status

+

read status of the specified CronJob

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
CronJob
OK
+

Replace Status

+

replace status of the specified CronJob

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

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
+
Other API versions of this object exist: +v1beta2 +v1beta1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

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

DaemonSetStatus v1 apps

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

DaemonSetList v1 apps

+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

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
200
DaemonSet
OK
201
DaemonSet
Created
202
DaemonSet
Accepted
+

Patch

+

partially update the specified DaemonSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
DaemonSet
OK
+

Replace

+

replace the specified DaemonSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
DaemonSet
+

Response

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

Delete

+ + +
+
+
kubectl command
+
+

+$ kubectl delete daemonset daemonset-example
+
+
+
+
curl command (requires kubectl proxy to be running)
+
+

+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/apps/v1/namespaces/default/daemonsets/daemonset-example'
+
+ + +
+
+
Output
+
+

+daemonset "daemonset-example" deleted
+
+
+
+
Response Body
+
+

+{
+  "kind": "Status",
+  "apiVersion": "v1",
+  "metadata": {},
+  "status": "Success",
+  "code": 200
+}
+
+
+

delete a DaemonSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

delete collection of DaemonSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

Read

+ + +
+
+
kubectl command
+
+

+$ kubectl get daemonset daemonset-example -o json
+
+
+
+
curl command (requires kubectl proxy to be running)
+
+

+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/apis/apps/v1/namespaces/default/daemonsets/daemonset-example
+
+

read the specified DaemonSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Query Parameters

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

+

Patch Status

+

partially update status of the specified DaemonSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
DaemonSet
OK
+

Read Status

+

read status of the specified DaemonSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
DaemonSet
OK
+

Replace Status

+

replace status of the specified DaemonSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

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
+
Other API versions of this object exist: +v1beta2 +v1beta1 +v1beta1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

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

DeploymentStatus v1 apps

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

DeploymentList v1 apps

+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

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

RollingUpdateDeployment v1 apps

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

Write Operations

+

Create

+ + +
+
+
kubectl command
+
+

+$ echo 'apiVersion: apps/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
201
Deployment
Created
202
Deployment
Accepted
200
Deployment
OK
+

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.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

delete collection of Deployment

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Query Parameters

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

+

Patch Status

+

partially update status of the specified Deployment

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
Deployment
OK
+

Read Status

+

read status of the specified Deployment

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
Deployment
OK
+

Replace Status

+

replace status of the specified Deployment

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Deployment
+

Response

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

Misc Operations

+

Read Scale

+

read scale of the specified Deployment

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
Scale
OK
+

Replace Scale

+

replace scale of the specified Deployment

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Scale
+

Response

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

Patch Scale

+

partially update scale of the specified Deployment

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

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
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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/
ttlSecondsAfterFinished
integer
ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature.
+

JobStatus v1 batch

+
Appears In: + +
+ + + + + + + + + + +
FieldDescription
active
integer
The number of actively running pods.
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 strategy: 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

+

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

+

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

+

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
201
Job
Created
200
Job
OK
+

Delete

+ + +
+
+
kubectl command
+
+

+$ kubectl delete job example-job
+
+
+
+
curl command (requires kubectl proxy to be running)
+
+

+$ kubectl proxy
+$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
+gracePeriodSeconds: 0
+orphanDependents: false
+' 'http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs/example-job'
+
+ + +
+
+
Output
+
+

+job "example-job" deleted
+
+
+
+
Response Body
+
+

+{
+  "kind": "Status",
+  "apiVersion": "v1",
+  "metadata": {},
+  "status": "Success",
+  "code": 200
+}
+
+
+

delete a Job

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

delete collection of Job

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Query Parameters

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

+

Patch Status

+

partially update status of the specified Job

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
Job
OK
+

Read Status

+

read status of the specified Job

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
Job
OK
+

Replace Status

+

replace status of the specified Job

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

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
+

Warning:

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

+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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 strategy: merge
patch merge key: name
List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.
dnsConfig
PodDNSConfig
Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.
dnsPolicy
string
Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.
hostAliases
HostAlias array
patch strategy: merge
patch merge key: ip
HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.
hostIPC
boolean
Use the host's ipc namespace. Optional: Default to false.
hostNetwork
boolean
Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.
hostPID
boolean
Use the host's pid namespace. Optional: Default to false.
hostname
string
Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.
imagePullSecrets
LocalObjectReference array
patch strategy: merge
patch merge key: name
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
initContainers
Container array
patch strategy: merge
patch merge key: name
List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, 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
runtimeClassName
string
RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://github.com/kubernetes/community/blob/master/keps/sig-node/0014-runtime-class.md This is an alpha feature and may change in the future.
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 beta-level and may be disabled with 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 strategy: merge,retainKeys
patch merge key: name
List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes
+

PodStatus v1 core

+
Appears In: + +
+ + + + + + + + + + + + + + + +
FieldDescription
conditions
PodCondition array
patch strategy: merge
patch merge key: type
Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
containerStatuses
ContainerStatus array
The list has one entry per container in the manifest. Each entry is currently the output of `docker inspect`. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
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

+

Create

+

create a Pod

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Pod
+

Response

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

Create Eviction

+

create eviction of a Pod

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

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
201
Pod
Created
200
Pod
OK
+

Delete

+

delete a Pod

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

delete collection of Pod

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

Read

+

read the specified Pod

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

+GET /api/v1/watch/pods +

Query Parameters

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

+

Patch Status

+

partially update status of the specified Pod

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
Pod
OK
+

Read Status

+

read status of the specified Pod

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
Pod
OK
+

Replace Status

+

replace status of the specified Pod

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Pod
+

Response

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

Proxy Operations

+

Create Connect Portforward

+

connect POST requests to portforward of Pod

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
string
OK
+

Create Connect Proxy

+

connect POST requests to proxy of Pod

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
string
OK
+

Create Connect Proxy Path

+

connect POST requests to proxy of Pod

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
string
OK
+

Delete Connect Proxy

+

connect DELETE requests to proxy of Pod

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
string
OK
+

Delete Connect Proxy Path

+

connect DELETE requests to proxy of Pod

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
string
OK
+

Get Connect Portforward

+

connect GET requests to portforward of Pod

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
string
OK
+

Get Connect Proxy

+

connect GET requests to proxy of Pod

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
string
OK
+

Get Connect Proxy Path

+

connect GET requests to proxy of Pod

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
string
OK
+

Head Connect Proxy

+

connect HEAD requests to proxy of Pod

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
string
OK
+

Head Connect Proxy Path

+

connect HEAD requests to proxy of Pod

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
string
OK
+

Replace Connect Proxy

+

connect PUT requests to proxy of Pod

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
string
OK
+

Replace Connect Proxy Path

+

connect PUT requests to proxy of Pod

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
string
OK
+

Misc Operations

+

Read Log

+

read log of the specified Pod

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + + + + + + + + +
ParameterDescription
containerThe container for which to stream logs. Defaults to only container if there is one container in the pod.
followFollow the log stream of the pod. Defaults to false.
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
+

Warning:

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

+
Other API versions of this object exist: +v1beta2 +v1beta1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

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

ReplicaSetStatus v1 apps

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

ReplicaSetList v1 apps

+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a ReplicaSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
ReplicaSet
+

Response

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

Patch

+

partially update the specified ReplicaSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
ReplicaSet
OK
+

Replace

+

replace the specified ReplicaSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
ReplicaSet
+

Response

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

Delete

+

delete a ReplicaSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

delete collection of ReplicaSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

Read

+

read the specified ReplicaSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Query Parameters

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

+

Patch Status

+

partially update status of the specified ReplicaSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
ReplicaSet
OK
+

Read Status

+

read status of the specified ReplicaSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
ReplicaSet
OK
+

Replace Status

+

replace status of the specified ReplicaSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
ReplicaSet
+

Response

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

Misc Operations

+

Read Scale

+

read scale of the specified ReplicaSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
Scale
OK
+

Replace Scale

+

replace scale of the specified ReplicaSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Scale
+

Response

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

Patch Scale

+

partially update scale of the specified ReplicaSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

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
+

Warning:

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

+ + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

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

ReplicationControllerStatus v1 core

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

ReplicationControllerList v1 core

+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a ReplicationController

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
ReplicationController
+

Response

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

Patch

+

partially update the specified ReplicationController

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
ReplicationController
OK
+

Replace

+

replace the specified ReplicationController

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
ReplicationController
+

Response

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

Delete

+

delete a ReplicationController

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

delete collection of ReplicationController

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

Read

+

read the specified ReplicationController

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

+GET /api/v1/watch/replicationcontrollers +

Query Parameters

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

+

Patch Status

+

partially update status of the specified ReplicationController

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
ReplicationController
OK
+

Read Status

+

read status of the specified ReplicationController

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
ReplicationController
OK
+

Replace Status

+

replace status of the specified ReplicationController

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
ReplicationController
+

Response

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

Misc Operations

+

Read Scale

+

read scale of the specified ReplicationController

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
Scale
OK
+

Replace Scale

+

replace scale of the specified ReplicationController

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Scale
+

Response

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

Patch Scale

+

partially update scale of the specified ReplicationController

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
Scale
OK
+

StatefulSet v1 apps

+ + + + + +
GroupVersionKind
appsv1StatefulSet
+
Other API versions of this object exist: +v1beta2 +v1beta1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + + + + + + + + +
FieldDescription
podManagementPolicy
string
podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
replicas
integer
replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
revisionHistoryLimit
integer
revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
selector
LabelSelector
selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
serviceName
string
serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
template
PodTemplateSpec
template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
updateStrategy
StatefulSetUpdateStrategy
updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
volumeClaimTemplates
PersistentVolumeClaim array
volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
+

StatefulSetStatus v1 apps

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

StatefulSetList v1 apps

+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a StatefulSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
StatefulSet
+

Response

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

Patch

+

partially update the specified StatefulSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
StatefulSet
OK
+

Replace

+

replace the specified StatefulSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
StatefulSet
+

Response

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

Delete

+

delete a StatefulSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

delete collection of StatefulSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

Read

+

read the specified StatefulSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Query Parameters

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

+

Patch Status

+

partially update status of the specified StatefulSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
StatefulSet
OK
+

Read Status

+

read status of the specified StatefulSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
StatefulSet
OK
+

Replace Status

+

replace status of the specified StatefulSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
StatefulSet
+

Response

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

Misc Operations

+

Read Scale

+

read scale of the specified StatefulSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
Scale
OK
+

Replace Scale

+

replace scale of the specified StatefulSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Scale
+

Response

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

Patch Scale

+

partially update scale of the specified StatefulSet

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
Scale
OK
+

Service APIs

+

Endpoints v1 core

+ + + + + +
GroupVersionKind
corev1Endpoints
+
Appears In: + +
+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create Endpoints

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Endpoints
+

Response

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

Patch

+

partially update the specified Endpoints

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
Endpoints
OK
+

Replace

+

replace the specified Endpoints

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Endpoints
+

Response

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

Delete

+

delete Endpoints

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

delete collection of Endpoints

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

Read

+

read the specified Endpoints

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

+GET /api/v1/watch/endpoints +

Query Parameters

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

+
Appears In: + +
+ + + + + + + +
FieldDescription
backend
IngressBackend
A default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default.
rules
IngressRule array
A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.
tls
IngressTLS array
TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.
+

IngressStatus v1beta1 extensions

+
Appears In: + +
+ + + + + +
FieldDescription
loadBalancer
LoadBalancerStatus
LoadBalancer contains the current status of the load-balancer.
+

IngressList v1beta1 extensions

+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create an Ingress

+

HTTP Request

+POST /apis/extensions/v1beta1/namespaces/{namespace}/ingresses +

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Ingress
+

Response

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

Patch

+

partially update the specified Ingress

+

HTTP Request

+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name} +

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
Ingress
OK
+

Replace

+

replace the specified Ingress

+

HTTP Request

+PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name} +

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Ingress
+

Response

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

Delete

+

delete an Ingress

+

HTTP Request

+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name} +

Path Parameters

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

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

delete collection of Ingress

+

HTTP Request

+DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses +

Path Parameters

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

Query Parameters

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

+

Read

+

read the specified Ingress

+

HTTP Request

+GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name} +

Path Parameters

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

Query Parameters

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

+

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

+

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

+

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

+

HTTP Request

+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses/{name} +

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses +

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

+GET /apis/extensions/v1beta1/watch/ingresses +

Query Parameters

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

+

Patch Status

+

partially update status of the specified Ingress

+

HTTP Request

+PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status +

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
Ingress
OK
+

Read Status

+

read status of the specified Ingress

+

HTTP Request

+GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status +

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
Ingress
OK
+

Replace Status

+

replace status of the specified Ingress

+

HTTP Request

+PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status +

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Ingress
+

Response

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

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
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + + + + + + + + + + + + + +
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 strategy: merge
patch merge key: port
The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
publishNotReadyAddresses
boolean
publishNotReadyAddresses, 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

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

+

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

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.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Read Operations

+

Read

+ + +
+
+
kubectl command
+
+

+$ kubectl get service deployment-example -o json
+
+
+
+
curl command (requires kubectl proxy to be running)
+
+

+$ kubectl proxy
+$ curl -X GET http://127.0.0.1:8001/api/v1/namespaces/default/services/deployment-example
+
+ + +
+
+
Output
+
+

+{
+  "kind": "Service",
+  "apiVersion": "v1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/api/v1/namespaces/default/services/deployment-example",
+    "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+    "resourceVersion": "2205995",
+    "creationTimestamp": "2016-10-28T17:04:24Z"
+  },
+  "spec": {
+    "ports": [
+      {
+        "name": "http",
+        "protocol": "TCP",
+        "port": 80,
+        "targetPort": 8080,
+        "nodePort": 32417
+      }
+    ],
+    "selector": {
+      "app": "nginx"
+    },
+    "clusterIP": "10.183.250.161",
+    "type": "LoadBalancer",
+    "sessionAffinity": "None"
+  },
+  "status": {
+    "loadBalancer": {
+      "ingress": [
+        {
+          "ip": "104.198.186.106"
+        }
+      ]
+    }
+  }
+}
+
+
+
+
Response Body
+
+

+{
+  "kind": "Service",
+  "apiVersion": "v1",
+  "metadata": {
+    "name": "deployment-example",
+    "namespace": "default",
+    "selfLink": "/api/v1/namespaces/default/services/deployment-example",
+    "uid": "93e5c731-9d30-11e6-9c54-42010a800148",
+    "resourceVersion": "2205995",
+    "creationTimestamp": "2016-10-28T17:04:24Z"
+  },
+  "spec": {
+    "ports": [
+      {
+        "name": "http",
+        "protocol": "TCP",
+        "port": 80,
+        "targetPort": 8080,
+        "nodePort": 32417
+      }
+    ],
+    "selector": {
+      "app": "nginx"
+    },
+    "clusterIP": "10.183.250.161",
+    "type": "LoadBalancer",
+    "sessionAffinity": "None"
+  },
+  "status": {
+    "loadBalancer": {
+      "ingress": [
+        {
+          "ip": "104.198.186.106"
+        }
+      ]
+    }
+  }
+}
+
+

read the specified Service

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

+GET /api/v1/watch/services +

Query Parameters

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

+

Patch Status

+

partially update status of the specified Service

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
Service
OK
+

Read Status

+

read status of the specified Service

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
Service
OK
+

Replace Status

+

replace status of the specified Service

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Service
+

Response

+ + + + + + +
CodeDescription
200
Service
OK
201
Service
Created
+

Proxy Operations

+

Create Connect Proxy

+

connect POST requests to proxy of Service

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + +
ParameterDescription
pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
+

Response

+ + + + + +
CodeDescription
200
string
OK
+

Create Connect Proxy Path

+

connect POST requests to proxy of Service

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + +
ParameterDescription
pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
+

Response

+ + + + + +
CodeDescription
200
string
OK
+

Delete Connect Proxy

+

connect DELETE requests to proxy of Service

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + +
ParameterDescription
pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
+

Response

+ + + + + +
CodeDescription
200
string
OK
+

Delete Connect Proxy Path

+

connect DELETE requests to proxy of Service

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + +
ParameterDescription
pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
+

Response

+ + + + + +
CodeDescription
200
string
OK
+

Get Connect Proxy

+

connect GET requests to proxy of Service

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + +
ParameterDescription
pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
+

Response

+ + + + + +
CodeDescription
200
string
OK
+

Get Connect Proxy Path

+

connect GET requests to proxy of Service

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + +
ParameterDescription
pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
+

Response

+ + + + + +
CodeDescription
200
string
OK
+

Head Connect Proxy

+

connect HEAD requests to proxy of Service

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + +
ParameterDescription
pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
+

Response

+ + + + + +
CodeDescription
200
string
OK
+

Head Connect Proxy Path

+

connect HEAD requests to proxy of Service

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + +
ParameterDescription
pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
+

Response

+ + + + + +
CodeDescription
200
string
OK
+

Replace Connect Proxy

+

connect PUT requests to proxy of Service

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + +
ParameterDescription
pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
+

Response

+ + + + + +
CodeDescription
200
string
OK
+

Replace Connect Proxy Path

+

connect PUT requests to proxy of Service

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + +
ParameterDescription
pathPath is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.
+

Response

+ + + + + +
CodeDescription
200
string
OK
+

Config and Storage APIs

+

ConfigMap v1 core

+ + + + + +
GroupVersionKind
corev1ConfigMap
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a ConfigMap

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
ConfigMap
+

Response

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

Patch

+

partially update the specified ConfigMap

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
ConfigMap
OK
+

Replace

+

replace the specified ConfigMap

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
ConfigMap
+

Response

+ + + + + + +
CodeDescription
200
ConfigMap
OK
201
ConfigMap
Created
+

Delete

+

delete a ConfigMap

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

delete collection of ConfigMap

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

Read

+

read the specified ConfigMap

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

+GET /api/v1/watch/configmaps +

Query Parameters

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

+

Create

+

create a Secret

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Secret
+

Response

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

Patch

+

partially update the specified Secret

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
Secret
OK
+

Replace

+

replace the specified Secret

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Secret
+

Response

+ + + + + + +
CodeDescription
200
Secret
OK
201
Secret
Created
+

Delete

+

delete a Secret

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

delete collection of Secret

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

Read

+

read the specified Secret

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

+GET /api/v1/watch/secrets +

Query Parameters

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

+
Appears In: + +
+ + + + + + + + + + + +
FieldDescription
accessModes
string array
AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
dataSource
TypedLocalObjectReference
This field requires the VolumeSnapshotDataSource alpha feature gate to be enabled and currently VolumeSnapshot is the only supported data source. If the provisioner can support VolumeSnapshot data source, it will create a new volume and data will be restored to the volume at the same time. If the provisioner does not support VolumeSnapshot data source, volume will not be created and the failure will be reported as an event. In the future, we plan to support more data source types and the behavior of the provisioner may change.
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

+
Appears In: + +
+ + + + + + + + +
FieldDescription
accessModes
string array
AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
capacity
object
Represents the actual resources of the underlying volume.
conditions
PersistentVolumeClaimCondition array
patch strategy: merge
patch merge key: type
Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.
phase
string
Phase represents the current phase of PersistentVolumeClaim.
+

PersistentVolumeClaimList v1 core

+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a PersistentVolumeClaim

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
PersistentVolumeClaim
+

Response

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

Patch

+

partially update the specified PersistentVolumeClaim

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
PersistentVolumeClaim
OK
+

Replace

+

replace the specified PersistentVolumeClaim

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
PersistentVolumeClaim
+

Response

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

Delete

+

delete a PersistentVolumeClaim

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

delete collection of PersistentVolumeClaim

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

Read

+

read the specified PersistentVolumeClaim

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

+GET /api/v1/watch/persistentvolumeclaims +

Query Parameters

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

+

Patch Status

+

partially update status of the specified PersistentVolumeClaim

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
PersistentVolumeClaim
OK
+

Read Status

+

read status of the specified PersistentVolumeClaim

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
PersistentVolumeClaim
OK
+

Replace Status

+

replace status of the specified PersistentVolumeClaim

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
PersistentVolumeClaim
+

Response

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

StorageClass v1 storage.k8s.io

+ + + + + +
GroupVersionKind
storage.k8s.iov1StorageClass
+
Other API versions of this object exist: +v1beta1 +
+
Appears In: + +
+ + + + + + + + + + + + + + +
FieldDescription
allowVolumeExpansion
boolean
AllowVolumeExpansion shows whether the storage class allow volume expand
allowedTopologies
TopologySelectorTerm array
Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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 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

+

Create

+

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

+

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

+

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

+

delete a StorageClass

+

HTTP Request

+DELETE /apis/storage.k8s.io/v1/storageclasses/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

delete collection of StorageClass

+

HTTP Request

+DELETE /apis/storage.k8s.io/v1/storageclasses +

Query Parameters

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

+

Read

+

read the specified StorageClass

+

HTTP Request

+GET /apis/storage.k8s.io/v1/storageclasses/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

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

+

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

+

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

+

HTTP Request

+GET /apis/storage.k8s.io/v1/watch/storageclasses/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

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

+

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

+

HTTP Request

+GET /apis/storage.k8s.io/v1/watch/storageclasses +

Query Parameters

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

+

Create

+

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

+

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

+

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

+

delete a VolumeAttachment

+

HTTP Request

+DELETE /apis/storage.k8s.io/v1beta1/volumeattachments/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

delete collection of VolumeAttachment

+

HTTP Request

+DELETE /apis/storage.k8s.io/v1beta1/volumeattachments +

Query Parameters

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

+

Read

+

read the specified VolumeAttachment

+

HTTP Request

+GET /apis/storage.k8s.io/v1beta1/volumeattachments/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

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

+

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

+

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

+

HTTP Request

+GET /apis/storage.k8s.io/v1beta1/watch/volumeattachments/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

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

+

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

+

HTTP Request

+GET /apis/storage.k8s.io/v1beta1/watch/volumeattachments +

Query Parameters

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

+

ControllerRevision v1 apps

+ + + + + +
GroupVersionKind
appsv1ControllerRevision
+
Other API versions of this object exist: +v1beta2 +v1beta1 +
+ + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a ControllerRevision

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
ControllerRevision
+

Response

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

Patch

+

partially update the specified ControllerRevision

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
ControllerRevision
OK
+

Replace

+

replace the specified ControllerRevision

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
ControllerRevision
+

Response

+ + + + + + +
CodeDescription
200
ControllerRevision
OK
201
ControllerRevision
Created
+

Delete

+

delete a ControllerRevision

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

delete collection of ControllerRevision

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

Read

+

read the specified ControllerRevision

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

+GET /apis/apps/v1/watch/controllerrevisions +

Query Parameters

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

+

Create

+

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
200
CustomResourceDefinition
OK
201
CustomResourceDefinition
Created
202
CustomResourceDefinition
Accepted
+

Patch

+

partially update the specified CustomResourceDefinition

+

HTTP Request

+PATCH /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
CustomResourceDefinition
OK
+

Replace

+

replace the specified CustomResourceDefinition

+

HTTP Request

+PUT /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
CustomResourceDefinition
+

Response

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

Delete

+

delete a CustomResourceDefinition

+

HTTP Request

+DELETE /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

delete collection of CustomResourceDefinition

+

HTTP Request

+DELETE /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions +

Query Parameters

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

+

Read

+

read the specified CustomResourceDefinition

+

HTTP Request

+GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

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

+

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

+

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

+

HTTP Request

+GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

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

+

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

+

HTTP Request

+GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions +

Query Parameters

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

+

Patch Status

+

partially update status of the specified CustomResourceDefinition

+

HTTP Request

+PATCH /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status +

Path Parameters

+ + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
CustomResourceDefinition
OK
+

Read Status

+

read status of the specified CustomResourceDefinition

+

HTTP Request

+GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status +

Path Parameters

+ + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
CustomResourceDefinition
OK
+

Replace Status

+

replace status of the specified CustomResourceDefinition

+

HTTP Request

+PUT /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status +

Path Parameters

+ + + + + +
ParameterDescription
namename of the CustomResourceDefinition
+

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
CustomResourceDefinition
+

Response

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

Event v1 core

+ + + + + +
GroupVersionKind
corev1Event
+
Other API versions of this object exist: +v1beta1 +
+
Appears In: + +
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
action
string
What action was taken/failed regarding to the Regarding object.
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create an Event

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Event
+

Response

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

Patch

+

partially update the specified Event

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
Event
OK
+

Replace

+

replace the specified Event

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Event
+

Response

+ + + + + + +
CodeDescription
201
Event
Created
200
Event
OK
+

Delete

+

delete an Event

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

delete collection of Event

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

Read

+

read the specified Event

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

+GET /api/v1/watch/events +

Query Parameters

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

+
Appears In: + +
+ + + + + +
FieldDescription
limits
LimitRangeItem array
Limits is the list of LimitRangeItem objects that are enforced.
+

LimitRangeList v1 core

+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a LimitRange

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
LimitRange
+

Response

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

Patch

+

partially update the specified LimitRange

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
LimitRange
OK
+

Replace

+

replace the specified LimitRange

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
LimitRange
+

Response

+ + + + + + +
CodeDescription
200
LimitRange
OK
201
LimitRange
Created
+

Delete

+

delete a LimitRange

+

HTTP Request

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

Path Parameters

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

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

delete collection of LimitRange

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

Read

+

read the specified LimitRange

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

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

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

+GET /api/v1/watch/limitranges +

Query Parameters

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

+

Create

+

create a HorizontalPodAutoscaler

+

HTTP Request

+POST /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers +

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
HorizontalPodAutoscaler
+

Response

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

Patch

+

partially update the specified HorizontalPodAutoscaler

+

HTTP Request

+PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} +

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
HorizontalPodAutoscaler
OK
+

Replace

+

replace the specified HorizontalPodAutoscaler

+

HTTP Request

+PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} +

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
HorizontalPodAutoscaler
+

Response

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

Delete

+

delete a HorizontalPodAutoscaler

+

HTTP Request

+DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} +

Path Parameters

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

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

delete collection of HorizontalPodAutoscaler

+

HTTP Request

+DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers +

Path Parameters

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

Query Parameters

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

+

Read

+

read the specified HorizontalPodAutoscaler

+

HTTP Request

+GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name} +

Path Parameters

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

Query Parameters

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

+

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

+

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

+

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

+

HTTP Request

+GET /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name} +

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

+GET /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers +

Path Parameters

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

Query Parameters

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

+

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

+

HTTP Request

+GET /apis/autoscaling/v1/watch/horizontalpodautoscalers +

Query Parameters

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

+

Patch Status

+

partially update status of the specified HorizontalPodAutoscaler

+

HTTP Request

+PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status +

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
HorizontalPodAutoscaler
OK
+

Read Status

+

read status of the specified HorizontalPodAutoscaler

+

HTTP Request

+GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status +

Path Parameters

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

Query Parameters

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

Response

+ + + + + +
CodeDescription
200
HorizontalPodAutoscaler
OK
+

Replace Status

+

replace status of the specified HorizontalPodAutoscaler

+

HTTP Request

+PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status +

Path Parameters

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

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
HorizontalPodAutoscaler
+

Response

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

InitializerConfiguration v1alpha1 admissionregistration.k8s.io

+ + + + + +
GroupVersionKind
admissionregistration.k8s.iov1alpha1InitializerConfiguration
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. 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 strategy: 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

+

Create

+

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
202
InitializerConfiguration
Accepted
200
InitializerConfiguration
OK
201
InitializerConfiguration
Created
+

Patch

+

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

+

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
200
InitializerConfiguration
OK
201
InitializerConfiguration
Created
+

Delete

+

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.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

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

+

Read

+

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

+

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

+

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

+

HTTP Request

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

+

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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. 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 strategy: merge
patch merge key: name
Webhooks is a list of webhooks and the affected resources and operations.
+

MutatingWebhookConfigurationList v1beta1 admissionregistration

+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

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
201
MutatingWebhookConfiguration
Created
202
MutatingWebhookConfiguration
Accepted
200
MutatingWebhookConfiguration
OK
+

Patch

+

partially update the specified MutatingWebhookConfiguration

+

HTTP Request

+PATCH /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the MutatingWebhookConfiguration
+

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
MutatingWebhookConfiguration
OK
+

Replace

+

replace the specified MutatingWebhookConfiguration

+

HTTP Request

+PUT /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the MutatingWebhookConfiguration
+

Query Parameters

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

Body Parameters

+ + + + + +
ParameterDescription
body
MutatingWebhookConfiguration
+

Response

+ + + + + + +
CodeDescription
201
MutatingWebhookConfiguration
Created
200
MutatingWebhookConfiguration
OK
+

Delete

+

delete a MutatingWebhookConfiguration

+

HTTP Request

+DELETE /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the MutatingWebhookConfiguration
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

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

Delete Collection

+

delete collection of MutatingWebhookConfiguration

+

HTTP Request

+DELETE /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations +

Query Parameters

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

+

Read

+

read the specified MutatingWebhookConfiguration

+

HTTP Request

+GET /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the MutatingWebhookConfiguration
+

Query Parameters

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

+

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

+

watch changes to an object of kind MutatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/admissionregistration.k8s.io/v1beta1/watch/mutatingwebhookconfigurations/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the MutatingWebhookConfiguration
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of MutatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/admissionregistration.k8s.io/v1beta1/watch/mutatingwebhookconfigurations +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. 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 strategy: merge
patch merge key: name
Webhooks is a list of webhooks and the affected resources and operations.
+

ValidatingWebhookConfigurationList v1beta1 admissionregistration

+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

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
202
ValidatingWebhookConfiguration
Accepted
200
ValidatingWebhookConfiguration
OK
201
ValidatingWebhookConfiguration
Created
+

Patch

+

partially update the specified ValidatingWebhookConfiguration

+

HTTP Request

+PATCH /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ValidatingWebhookConfiguration
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
ValidatingWebhookConfiguration
OK
+

Replace

+

replace the specified ValidatingWebhookConfiguration

+

HTTP Request

+PUT /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ValidatingWebhookConfiguration
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
ValidatingWebhookConfiguration
+

Response

+ + + + + + +
CodeDescription
200
ValidatingWebhookConfiguration
OK
201
ValidatingWebhookConfiguration
Created
+

Delete

+

delete a ValidatingWebhookConfiguration

+

HTTP Request

+DELETE /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ValidatingWebhookConfiguration
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of ValidatingWebhookConfiguration

+

HTTP Request

+DELETE /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified ValidatingWebhookConfiguration

+

HTTP Request

+GET /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ValidatingWebhookConfiguration
+

Query Parameters

+ + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

watch changes to an object of kind ValidatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/admissionregistration.k8s.io/v1beta1/watch/validatingwebhookconfigurations/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ValidatingWebhookConfiguration
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of ValidatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/admissionregistration.k8s.io/v1beta1/watch/validatingwebhookconfigurations +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Appears In: + +
+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a PodTemplate

+

HTTP Request

+POST /api/v1/namespaces/{namespace}/podtemplates +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
PodTemplate
+

Response

+ + + + + + + +
CodeDescription
202
PodTemplate
Accepted
200
PodTemplate
OK
201
PodTemplate
Created
+

Patch

+

partially update the specified PodTemplate

+

HTTP Request

+PATCH /api/v1/namespaces/{namespace}/podtemplates/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the PodTemplate
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
PodTemplate
OK
+

Replace

+

replace the specified PodTemplate

+

HTTP Request

+PUT /api/v1/namespaces/{namespace}/podtemplates/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the PodTemplate
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
PodTemplate
+

Response

+ + + + + + +
CodeDescription
200
PodTemplate
OK
201
PodTemplate
Created
+

Delete

+

delete a PodTemplate

+

HTTP Request

+DELETE /api/v1/namespaces/{namespace}/podtemplates/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the PodTemplate
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of PodTemplate

+

HTTP Request

+DELETE /api/v1/namespaces/{namespace}/podtemplates +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified PodTemplate

+

HTTP Request

+GET /api/v1/namespaces/{namespace}/podtemplates/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the PodTemplate
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind PodTemplate. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the PodTemplate
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of PodTemplate. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /api/v1/watch/namespaces/{namespace}/podtemplates +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of PodTemplate. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /api/v1/watch/podtemplates +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+ + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. 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

+

Create

+

create a PodDisruptionBudget

+

HTTP Request

+POST /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
PodDisruptionBudget
+

Response

+ + + + + + + +
CodeDescription
200
PodDisruptionBudget
OK
201
PodDisruptionBudget
Created
202
PodDisruptionBudget
Accepted
+

Patch

+

partially update the specified PodDisruptionBudget

+

HTTP Request

+PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the PodDisruptionBudget
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
PodDisruptionBudget
OK
+

Replace

+

replace the specified PodDisruptionBudget

+

HTTP Request

+PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the PodDisruptionBudget
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
PodDisruptionBudget
+

Response

+ + + + + + +
CodeDescription
200
PodDisruptionBudget
OK
201
PodDisruptionBudget
Created
+

Delete

+

delete a PodDisruptionBudget

+

HTTP Request

+DELETE /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the PodDisruptionBudget
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of PodDisruptionBudget

+

HTTP Request

+DELETE /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified PodDisruptionBudget

+

HTTP Request

+GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the PodDisruptionBudget
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/policy/v1beta1/watch/namespaces/{namespace}/poddisruptionbudgets/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the PodDisruptionBudget
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/policy/v1beta1/watch/namespaces/{namespace}/poddisruptionbudgets +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/policy/v1beta1/watch/poddisruptionbudgets +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

Patch Status

+

partially update status of the specified PodDisruptionBudget

+

HTTP Request

+PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the PodDisruptionBudget
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
PodDisruptionBudget
OK
+

Read Status

+

read status of the specified PodDisruptionBudget

+

HTTP Request

+GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the PodDisruptionBudget
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
PodDisruptionBudget
OK
+

Replace Status

+

replace status of the specified PodDisruptionBudget

+

HTTP Request

+PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the PodDisruptionBudget
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
PodDisruptionBudget
+

Response

+ + + + + + +
CodeDescription
200
PodDisruptionBudget
OK
201
PodDisruptionBudget
Created
+

PriorityClass v1beta1 scheduling.k8s.io

+ + + + + +
GroupVersionKind
scheduling.k8s.iov1beta1PriorityClass
+
Other API versions of this object exist: +v1alpha1 +
+ + + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

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
202
PriorityClass
Accepted
200
PriorityClass
OK
201
PriorityClass
Created
+

Patch

+

partially update the specified PriorityClass

+

HTTP Request

+PATCH /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
PriorityClass
OK
+

Replace

+

replace the specified PriorityClass

+

HTTP Request

+PUT /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
PriorityClass
+

Response

+ + + + + + +
CodeDescription
200
PriorityClass
OK
201
PriorityClass
Created
+

Delete

+

delete a PriorityClass

+

HTTP Request

+DELETE /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of PriorityClass

+

HTTP Request

+DELETE /apis/scheduling.k8s.io/v1beta1/priorityclasses +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified PriorityClass

+

HTTP Request

+GET /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

watch changes to an object of kind PriorityClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/scheduling.k8s.io/v1beta1/watch/priorityclasses/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of PriorityClass. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/scheduling.k8s.io/v1beta1/watch/priorityclasses +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+

Warning:

Alpha objects should not be used in production and may not be compatible with future versions of the resource type.

+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. 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

+
Appears In: + +
+ + + + + + + + + +
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

+

Create

+

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

+

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

+

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

+

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.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
202
Status
Accepted
200
Status
OK
+

Delete Collection

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind PodPreset. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of PodPreset. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of PodPreset. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. 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.
allowedProcMountTypes
string array
AllowedProcMountTypes is a whitelist of allowed ProcMountTypes. Empty or nil indicates that only the DefaultProcMountType may be used. This requires the ProcMountType feature flag to be enabled.
allowedUnsafeSysctls
string array
allowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed. Kubelet has to 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

+

Create

+

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
202
PodSecurityPolicy
Accepted
200
PodSecurityPolicy
OK
201
PodSecurityPolicy
Created
+

Patch

+

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

+

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

+

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.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

watch changes to an object of kind PodSecurityPolicy. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of PodSecurityPolicy. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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 APIs

+

APIService v1 apiregistration.k8s.io

+ + + + + +
GroupVersionKind
apiregistration.k8s.iov1APIService
+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + + + + + + + +
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

+
Appears In: + +
+ + + + + +
FieldDescription
conditions
APIServiceCondition array
patch strategy: merge
patch merge key: type
Current service state of apiService.
+

APIServiceList v1 apiregistration

+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

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

+

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

+

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
201
APIService
Created
200
APIService
OK
+

Delete

+

delete an APIService

+

HTTP Request

+DELETE /apis/apiregistration.k8s.io/v1/apiservices/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of APIService

+

HTTP Request

+DELETE /apis/apiregistration.k8s.io/v1/apiservices +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified APIService

+

HTTP Request

+GET /apis/apiregistration.k8s.io/v1/apiservices/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

watch changes to an object of kind APIService. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/apiregistration.k8s.io/v1/watch/apiservices/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of APIService. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/apiregistration.k8s.io/v1/watch/apiservices +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

Patch Status

+

partially update status of the specified APIService

+

HTTP Request

+PATCH /apis/apiregistration.k8s.io/v1/apiservices/{name}/status +

Path Parameters

+ + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
APIService
OK
+

Read Status

+

read status of the specified APIService

+

HTTP Request

+GET /apis/apiregistration.k8s.io/v1/apiservices/{name}/status +

Path Parameters

+ + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
APIService
OK
+

Replace Status

+

replace status of the specified APIService

+

HTTP Request

+PUT /apis/apiregistration.k8s.io/v1/apiservices/{name}/status +

Path Parameters

+ + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
APIService
+

Response

+ + + + + + +
CodeDescription
200
APIService
OK
201
APIService
Created
+

Binding v1 core

+ + + + + +
GroupVersionKind
corev1Binding
+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a Binding

+

HTTP Request

+POST /api/v1/namespaces/{namespace}/bindings +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
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
+ + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. 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

+

Create

+

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
202
CertificateSigningRequest
Accepted
200
CertificateSigningRequest
OK
201
CertificateSigningRequest
Created
+

Patch

+

partially update the specified CertificateSigningRequest

+

HTTP Request

+PATCH /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
CertificateSigningRequest
OK
+

Replace

+

replace the specified CertificateSigningRequest

+

HTTP Request

+PUT /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
CertificateSigningRequest
+

Response

+ + + + + + +
CodeDescription
200
CertificateSigningRequest
OK
201
CertificateSigningRequest
Created
+

Delete

+

delete a CertificateSigningRequest

+

HTTP Request

+DELETE /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of CertificateSigningRequest

+

HTTP Request

+DELETE /apis/certificates.k8s.io/v1beta1/certificatesigningrequests +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified CertificateSigningRequest

+

HTTP Request

+GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

+ + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

watch changes to an object of kind CertificateSigningRequest. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of CertificateSigningRequest. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

Patch Status

+

partially update status of the specified CertificateSigningRequest

+

HTTP Request

+PATCH /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status +

Path Parameters

+ + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
CertificateSigningRequest
OK
+

Read Status

+

read status of the specified CertificateSigningRequest

+

HTTP Request

+GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status +

Path Parameters

+ + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
CertificateSigningRequest
OK
+

Replace Status

+

replace status of the specified CertificateSigningRequest

+

HTTP Request

+PUT /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status +

Path Parameters

+ + + + + +
ParameterDescription
namename of the CertificateSigningRequest
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
CertificateSigningRequest
+

Response

+ + + + + + +
CodeDescription
200
CertificateSigningRequest
OK
201
CertificateSigningRequest
Created
+

ClusterRole v1 rbac.authorization.k8s.io

+ + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1ClusterRole
+
Other API versions of this object exist: +v1beta1 +v1alpha1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
aggregationRule
AggregationRule
AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a ClusterRole

+

HTTP Request

+POST /apis/rbac.authorization.k8s.io/v1/clusterroles +

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
ClusterRole
+

Response

+ + + + + + + +
CodeDescription
200
ClusterRole
OK
201
ClusterRole
Created
202
ClusterRole
Accepted
+

Patch

+

partially update the specified ClusterRole

+

HTTP Request

+PATCH /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
ClusterRole
OK
+

Replace

+

replace the specified ClusterRole

+

HTTP Request

+PUT /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
ClusterRole
+

Response

+ + + + + + +
CodeDescription
200
ClusterRole
OK
201
ClusterRole
Created
+

Delete

+

delete a ClusterRole

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
202
Status
Accepted
200
Status
OK
+

Delete Collection

+

delete collection of ClusterRole

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified ClusterRole

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
ClusterRole
OK
+

List

+

list or watch objects of kind ClusterRole

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1/clusterroles +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

watch changes to an object of kind ClusterRole. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of ClusterRole. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Other API versions of this object exist: +v1beta1 +v1alpha1 +
+ + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a ClusterRoleBinding

+

HTTP Request

+POST /apis/rbac.authorization.k8s.io/v1/clusterrolebindings +

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
ClusterRoleBinding
+

Response

+ + + + + + + +
CodeDescription
200
ClusterRoleBinding
OK
201
ClusterRoleBinding
Created
202
ClusterRoleBinding
Accepted
+

Patch

+

partially update the specified ClusterRoleBinding

+

HTTP Request

+PATCH /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
ClusterRoleBinding
OK
+

Replace

+

replace the specified ClusterRoleBinding

+

HTTP Request

+PUT /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
ClusterRoleBinding
+

Response

+ + + + + + +
CodeDescription
200
ClusterRoleBinding
OK
201
ClusterRoleBinding
Created
+

Delete

+

delete a ClusterRoleBinding

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of ClusterRoleBinding

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified ClusterRoleBinding

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
ClusterRoleBinding
OK
+

List

+

list or watch objects of kind ClusterRoleBinding

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

watch changes to an object of kind ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Appears In: + +
+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
conditions
ComponentCondition array
patch strategy: merge
patch merge key: type
List of component conditions observed
kind
string
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/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

+

Read

+

read the specified ComponentStatus

+

HTTP Request

+GET /api/v1/componentstatuses/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ComponentStatus
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
ComponentStatus
OK
+

List

+

list objects of kind ComponentStatus

+

HTTP Request

+GET /api/v1/componentstatuses +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a LocalSubjectAccessReview

+

HTTP Request

+POST /apis/authorization.k8s.io/v1/namespaces/{namespace}/localsubjectaccessreviews +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
LocalSubjectAccessReview
+

Response

+ + + + + + + +
CodeDescription
200
LocalSubjectAccessReview
OK
201
LocalSubjectAccessReview
Created
202
LocalSubjectAccessReview
Accepted
+

Namespace v1 core

+ + + + + +
GroupVersionKind
corev1Namespace
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + +
FieldDescription
finalizers
string array
Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
+

NamespaceStatus v1 core

+
Appears In: + +
+ + + + + +
FieldDescription
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

+

Create

+

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
202
Namespace
Accepted
200
Namespace
OK
201
Namespace
Created
+

Patch

+

partially update the specified Namespace

+

HTTP Request

+PATCH /api/v1/namespaces/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the Namespace
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
Namespace
OK
+

Replace

+

replace the specified Namespace

+

HTTP Request

+PUT /api/v1/namespaces/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the Namespace
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Namespace
+

Response

+ + + + + + +
CodeDescription
200
Namespace
OK
201
Namespace
Created
+

Delete

+

delete a Namespace

+

HTTP Request

+DELETE /api/v1/namespaces/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the Namespace
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Read Operations

+

Read

+

read the specified Namespace

+

HTTP Request

+GET /api/v1/namespaces/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the Namespace
+

Query Parameters

+ + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

watch changes to an object of kind Namespace. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /api/v1/watch/namespaces/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the Namespace
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of Namespace. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /api/v1/watch/namespaces +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

Patch Status

+

partially update status of the specified Namespace

+

HTTP Request

+PATCH /api/v1/namespaces/{name}/status +

Path Parameters

+ + + + + +
ParameterDescription
namename of the Namespace
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
Namespace
OK
+

Read Status

+

read status of the specified Namespace

+

HTTP Request

+GET /api/v1/namespaces/{name}/status +

Path Parameters

+ + + + + +
ParameterDescription
namename of the Namespace
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
Namespace
OK
+

Replace Status

+

replace status of the specified Namespace

+

HTTP Request

+PUT /api/v1/namespaces/{name}/status +

Path Parameters

+ + + + + +
ParameterDescription
namename of the Namespace
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Namespace
+

Response

+ + + + + + +
CodeDescription
200
Namespace
OK
201
Namespace
Created
+

Node v1 core

+ + + + + +
GroupVersionKind
corev1Node
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + + + + + + +
FieldDescription
configSource
NodeConfigSource
If specified, the source to get node configuration from The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field
externalID
string
Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966
podCIDR
string
PodCIDR represents the pod IP range assigned to the node.
providerID
string
ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>
taints
Taint array
If specified, the node's taints.
unschedulable
boolean
Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration
+

NodeStatus v1 core

+
Appears In: + +
+ + + + + + + + + + + + + + + +
FieldDescription
addresses
NodeAddress array
patch strategy: merge
patch merge key: type
List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses
allocatable
object
Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.
capacity
object
Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
conditions
NodeCondition array
patch strategy: merge
patch merge key: type
Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition
config
NodeConfigStatus
Status of the config assigned to the node via the dynamic Kubelet config feature.
daemonEndpoints
NodeDaemonEndpoints
Endpoints of daemons running on the Node.
images
ContainerImage array
List of container images on this node
nodeInfo
NodeSystemInfo
Set of ids/uuids to uniquely identify the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#info
phase
string
NodePhase is the recently observed lifecycle phase of the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#phase The field is never populated, and now is deprecated.
volumesAttached
AttachedVolume array
List of volumes that are attached to the node.
volumesInUse
string array
List of attachable volumes in use (mounted) by the node.
+

NodeList v1 core

+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

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

+

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

+

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
200
Node
OK
201
Node
Created
+

Delete

+

delete a Node

+

HTTP Request

+DELETE /api/v1/nodes/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the Node
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
202
Status
Accepted
200
Status
OK
+

Delete Collection

+

delete collection of Node

+

HTTP Request

+DELETE /api/v1/nodes +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified Node

+

HTTP Request

+GET /api/v1/nodes/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the Node
+

Query Parameters

+ + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

watch changes to an object of kind Node. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /api/v1/watch/nodes/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the Node
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of Node. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /api/v1/watch/nodes +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

Patch Status

+

partially update status of the specified Node

+

HTTP Request

+PATCH /api/v1/nodes/{name}/status +

Path Parameters

+ + + + + +
ParameterDescription
namename of the Node
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
Node
OK
+

Read Status

+

read status of the specified Node

+

HTTP Request

+GET /api/v1/nodes/{name}/status +

Path Parameters

+ + + + + +
ParameterDescription
namename of the Node
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
Node
OK
+

Replace Status

+

replace status of the specified Node

+

HTTP Request

+PUT /api/v1/nodes/{name}/status +

Path Parameters

+ + + + + +
ParameterDescription
namename of the Node
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Node
+

Response

+ + + + + + +
CodeDescription
200
Node
OK
201
Node
Created
+

Proxy Operations

+

Create Connect Proxy

+

connect POST requests to proxy of Node

+

HTTP Request

+POST /api/v1/nodes/{name}/proxy +

Path Parameters

+ + + + + +
ParameterDescription
namename of the NodeProxyOptions
+

Query Parameters

+ + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to node.
+

Response

+ + + + + +
CodeDescription
200
string
OK
+

Create Connect Proxy Path

+

connect POST requests to proxy of Node

+

HTTP Request

+POST /api/v1/nodes/{name}/proxy/{path} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the NodeProxyOptions
pathpath to the resource
+

Query Parameters

+ + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to node.
+

Response

+ + + + + +
CodeDescription
200
string
OK
+

Delete Connect Proxy

+

connect DELETE requests to proxy of Node

+

HTTP Request

+DELETE /api/v1/nodes/{name}/proxy +

Path Parameters

+ + + + + +
ParameterDescription
namename of the NodeProxyOptions
+

Query Parameters

+ + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to node.
+

Response

+ + + + + +
CodeDescription
200
string
OK
+

Delete Connect Proxy Path

+

connect DELETE requests to proxy of Node

+

HTTP Request

+DELETE /api/v1/nodes/{name}/proxy/{path} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the NodeProxyOptions
pathpath to the resource
+

Query Parameters

+ + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to node.
+

Response

+ + + + + +
CodeDescription
200
string
OK
+

Get Connect Proxy

+

connect GET requests to proxy of Node

+

HTTP Request

+GET /api/v1/nodes/{name}/proxy +

Path Parameters

+ + + + + +
ParameterDescription
namename of the NodeProxyOptions
+

Query Parameters

+ + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to node.
+

Response

+ + + + + +
CodeDescription
200
string
OK
+

Get Connect Proxy Path

+

connect GET requests to proxy of Node

+

HTTP Request

+GET /api/v1/nodes/{name}/proxy/{path} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the NodeProxyOptions
pathpath to the resource
+

Query Parameters

+ + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to node.
+

Response

+ + + + + +
CodeDescription
200
string
OK
+

Head Connect Proxy

+

connect HEAD requests to proxy of Node

+

HTTP Request

+HEAD /api/v1/nodes/{name}/proxy +

Path Parameters

+ + + + + +
ParameterDescription
namename of the NodeProxyOptions
+

Query Parameters

+ + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to node.
+

Response

+ + + + + +
CodeDescription
200
string
OK
+

Head Connect Proxy Path

+

connect HEAD requests to proxy of Node

+

HTTP Request

+HEAD /api/v1/nodes/{name}/proxy/{path} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the NodeProxyOptions
pathpath to the resource
+

Query Parameters

+ + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to node.
+

Response

+ + + + + +
CodeDescription
200
string
OK
+

Replace Connect Proxy

+

connect PUT requests to proxy of Node

+

HTTP Request

+PUT /api/v1/nodes/{name}/proxy +

Path Parameters

+ + + + + +
ParameterDescription
namename of the NodeProxyOptions
+

Query Parameters

+ + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to node.
+

Response

+ + + + + +
CodeDescription
200
string
OK
+

Replace Connect Proxy Path

+

connect PUT requests to proxy of Node

+

HTTP Request

+PUT /api/v1/nodes/{name}/proxy/{path} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the NodeProxyOptions
pathpath to the resource
+

Query Parameters

+ + + + + +
ParameterDescription
pathPath is the URL path to use for the current proxy request to node.
+

Response

+ + + + + +
CodeDescription
200
string
OK
+

PersistentVolume v1 core

+ + + + + +
GroupVersionKind
corev1PersistentVolume
+
These are assigned to Pods using PersistentVolumeClaims.
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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

+
Appears In: + +
+ + + + + + + +
FieldDescription
message
string
A human-readable message indicating details about why the volume is in this state.
phase
string
Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase
reason
string
Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.
+

PersistentVolumeList v1 core

+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

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

+

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

+

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

+

delete a PersistentVolume

+

HTTP Request

+DELETE /api/v1/persistentvolumes/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the PersistentVolume
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of PersistentVolume

+

HTTP Request

+DELETE /api/v1/persistentvolumes +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified PersistentVolume

+

HTTP Request

+GET /api/v1/persistentvolumes/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the PersistentVolume
+

Query Parameters

+ + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

watch changes to an object of kind PersistentVolume. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /api/v1/watch/persistentvolumes/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the PersistentVolume
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of PersistentVolume. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /api/v1/watch/persistentvolumes +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

Patch Status

+

partially update status of the specified PersistentVolume

+

HTTP Request

+PATCH /api/v1/persistentvolumes/{name}/status +

Path Parameters

+ + + + + +
ParameterDescription
namename of the PersistentVolume
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
PersistentVolume
OK
+

Read Status

+

read status of the specified PersistentVolume

+

HTTP Request

+GET /api/v1/persistentvolumes/{name}/status +

Path Parameters

+ + + + + +
ParameterDescription
namename of the PersistentVolume
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
PersistentVolume
OK
+

Replace Status

+

replace status of the specified PersistentVolume

+

HTTP Request

+PUT /api/v1/persistentvolumes/{name}/status +

Path Parameters

+ + + + + +
ParameterDescription
namename of the PersistentVolume
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
PersistentVolume
+

Response

+ + + + + + +
CodeDescription
200
PersistentVolume
OK
201
PersistentVolume
Created
+

ResourceQuota v1 core

+ + + + + +
GroupVersionKind
corev1ResourceQuota
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + + + +
FieldDescription
hard
object
hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
scopeSelector
ScopeSelector
scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched.
scopes
string array
A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects.
+

ResourceQuotaStatus v1 core

+
Appears In: + +
+ + + + + + +
FieldDescription
hard
object
Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
used
object
Used is the current observed total usage of the resource in the namespace.
+

ResourceQuotaList v1 core

+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a ResourceQuota

+

HTTP Request

+POST /api/v1/namespaces/{namespace}/resourcequotas +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
ResourceQuota
+

Response

+ + + + + + + +
CodeDescription
202
ResourceQuota
Accepted
200
ResourceQuota
OK
201
ResourceQuota
Created
+

Patch

+

partially update the specified ResourceQuota

+

HTTP Request

+PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the ResourceQuota
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
ResourceQuota
OK
+

Replace

+

replace the specified ResourceQuota

+

HTTP Request

+PUT /api/v1/namespaces/{namespace}/resourcequotas/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the ResourceQuota
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
ResourceQuota
+

Response

+ + + + + + +
CodeDescription
200
ResourceQuota
OK
201
ResourceQuota
Created
+

Delete

+

delete a ResourceQuota

+

HTTP Request

+DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the ResourceQuota
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of ResourceQuota

+

HTTP Request

+DELETE /api/v1/namespaces/{namespace}/resourcequotas +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified ResourceQuota

+

HTTP Request

+GET /api/v1/namespaces/{namespace}/resourcequotas/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the ResourceQuota
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the ResourceQuota
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /api/v1/watch/namespaces/{namespace}/resourcequotas +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /api/v1/watch/resourcequotas +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

Patch Status

+

partially update status of the specified ResourceQuota

+

HTTP Request

+PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the ResourceQuota
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
ResourceQuota
OK
+

Read Status

+

read status of the specified ResourceQuota

+

HTTP Request

+GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the ResourceQuota
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
ResourceQuota
OK
+

Replace Status

+

replace status of the specified ResourceQuota

+

HTTP Request

+PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the ResourceQuota
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
ResourceQuota
+

Response

+ + + + + + +
CodeDescription
200
ResourceQuota
OK
201
ResourceQuota
Created
+

Role v1 rbac.authorization.k8s.io

+ + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1Role
+
Other API versions of this object exist: +v1beta1 +v1alpha1 +
+
Appears In: + +
+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a Role

+

HTTP Request

+POST /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Role
+

Response

+ + + + + + + +
CodeDescription
201
Role
Created
202
Role
Accepted
200
Role
OK
+

Patch

+

partially update the specified Role

+

HTTP Request

+PATCH /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
Role
OK
+

Replace

+

replace the specified Role

+

HTTP Request

+PUT /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Role
+

Response

+ + + + + + +
CodeDescription
200
Role
OK
201
Role
Created
+

Delete

+

delete a Role

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of Role

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified Role

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
Role
OK
+

List

+

list or watch objects of kind Role

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind Role. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1/watch/roles +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Other API versions of this object exist: +v1beta1 +v1alpha1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a RoleBinding

+

HTTP Request

+POST /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
RoleBinding
+

Response

+ + + + + + + +
CodeDescription
200
RoleBinding
OK
201
RoleBinding
Created
202
RoleBinding
Accepted
+

Patch

+

partially update the specified RoleBinding

+

HTTP Request

+PATCH /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
RoleBinding
OK
+

Replace

+

replace the specified RoleBinding

+

HTTP Request

+PUT /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
RoleBinding
+

Response

+ + + + + + +
CodeDescription
200
RoleBinding
OK
201
RoleBinding
Created
+

Delete

+

delete a RoleBinding

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of RoleBinding

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified RoleBinding

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
RoleBinding
OK
+

List

+

list or watch objects of kind RoleBinding

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind RoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1/watch/rolebindings +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

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
201
SelfSubjectAccessReview
Created
202
SelfSubjectAccessReview
Accepted
200
SelfSubjectAccessReview
OK
+

SelfSubjectRulesReview v1 authorization.k8s.io

+ + + + + +
GroupVersionKind
authorization.k8s.iov1SelfSubjectRulesReview
+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

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
202
SelfSubjectRulesReview
Accepted
200
SelfSubjectRulesReview
OK
201
SelfSubjectRulesReview
Created
+

ServiceAccount v1 core

+ + + + + +
GroupVersionKind
corev1ServiceAccount
+
Appears In: + +
+ + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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 strategy: merge
patch merge key: name
Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: https://kubernetes.io/docs/concepts/configuration/secret
+

ServiceAccountList v1 core

+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a ServiceAccount

+

HTTP Request

+POST /api/v1/namespaces/{namespace}/serviceaccounts +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
ServiceAccount
+

Response

+ + + + + + + +
CodeDescription
201
ServiceAccount
Created
202
ServiceAccount
Accepted
200
ServiceAccount
OK
+

Patch

+

partially update the specified ServiceAccount

+

HTTP Request

+PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the ServiceAccount
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
ServiceAccount
OK
+

Replace

+

replace the specified ServiceAccount

+

HTTP Request

+PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the ServiceAccount
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
ServiceAccount
+

Response

+ + + + + + +
CodeDescription
200
ServiceAccount
OK
201
ServiceAccount
Created
+

Delete

+

delete a ServiceAccount

+

HTTP Request

+DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the ServiceAccount
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of ServiceAccount

+

HTTP Request

+DELETE /api/v1/namespaces/{namespace}/serviceaccounts +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified ServiceAccount

+

HTTP Request

+GET /api/v1/namespaces/{namespace}/serviceaccounts/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the ServiceAccount
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind ServiceAccount. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the ServiceAccount
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of ServiceAccount. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /api/v1/watch/namespaces/{namespace}/serviceaccounts +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of ServiceAccount. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /api/v1/watch/serviceaccounts +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

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
200
SubjectAccessReview
OK
201
SubjectAccessReview
Created
202
SubjectAccessReview
Accepted
+

TokenReview v1 authentication.k8s.io

+ + + + + +
GroupVersionKind
authentication.k8s.iov1TokenReview
+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + +
FieldDescription
token
string
Token is the opaque bearer token.
+

TokenReviewStatus v1 authentication

+
Appears In: + +
+ + + + + + + +
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

+

Create

+

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
+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + + + + +
FieldDescription
egress
NetworkPolicyEgressRule array
List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8
ingress
NetworkPolicyIngressRule array
List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default)
podSelector
LabelSelector
Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.
policyTypes
string array
List of rule types that the NetworkPolicy relates to. Valid options are Ingress, Egress, or Ingress,Egress. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8
+

NetworkPolicyList v1 networking

+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a NetworkPolicy

+

HTTP Request

+POST /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
NetworkPolicy
+

Response

+ + + + + + + +
CodeDescription
200
NetworkPolicy
OK
201
NetworkPolicy
Created
202
NetworkPolicy
Accepted
+

Patch

+

partially update the specified NetworkPolicy

+

HTTP Request

+PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the NetworkPolicy
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
NetworkPolicy
OK
+

Replace

+

replace the specified NetworkPolicy

+

HTTP Request

+PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the NetworkPolicy
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
NetworkPolicy
+

Response

+ + + + + + +
CodeDescription
200
NetworkPolicy
OK
201
NetworkPolicy
Created
+

Delete

+

delete a NetworkPolicy

+

HTTP Request

+DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the NetworkPolicy
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
202
Status
Accepted
200
Status
OK
+

Delete Collection

+

delete collection of NetworkPolicy

+

HTTP Request

+DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified NetworkPolicy

+

HTTP Request

+GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the NetworkPolicy
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the NetworkPolicy
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/networking.k8s.io/v1/watch/networkpolicies +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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.

+
Appears In: + +
+ + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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.

+
Appears In: + +
+ + + + + + + + + + + + + +
FieldDescription
categories
string array
categories is a list of the grouped resources this resource belongs to (e.g. 'all')
group
string
group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale".
kind
string
kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
name
string
name is the plural name of the resource.
namespaced
boolean
namespaced indicates if a resource is namespaced or not.
shortNames
string array
shortNames is a list of suggested short names of the resource.
singularName
string
singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.
verbs
string array
verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)
version
string
version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)".
+

APIServiceCondition v1 apiregistration.k8s.io

+ + + + + +
GroupVersionKind
apiregistration.k8s.iov1APIServiceCondition
+

+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + + + + +
FieldDescription
lastTransitionTime
Time
Last time the condition transitioned from one status to another.
message
string
Human-readable message indicating details about last transition.
reason
string
Unique, one-word, CamelCase reason for the condition's last transition.
status
string
Status is the status of the condition. Can be True, False, Unknown.
type
string
Type is the type of the condition.
+

APIVersions v1 meta

+ + + + + +
GroupVersionKind
metav1APIVersions
+

APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API.

+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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.

+
Appears In: + +
+ + + + + + + +
FieldDescription
nodeAffinity
NodeAffinity
Describes node affinity scheduling rules for the pod.
podAffinity
PodAffinity
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
podAntiAffinity
PodAntiAffinity
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
+

AggregationRule v1 rbac.authorization.k8s.io

+ + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1AggregationRule
+

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole

+
Other API versions of this object exist: +v1beta1 +v1alpha1 +
+
Appears In: + +
+ + + + + +
FieldDescription
clusterRoleSelectors
LabelSelector array
ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added
+

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

+
Appears In: + +
+ + + + + + +
FieldDescription
devicePath
string
DevicePath represents the device path where the volume should be available
name
string
Name of the attached volume
+

AzureDiskVolumeSource v1 core

+ + + + + +
GroupVersionKind
corev1AzureDiskVolumeSource
+

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

+ + + + + + + + + + + +
FieldDescription
cachingMode
string
Host Caching mode: None, Read Only, Read Write.
diskName
string
The Name of the data disk in the blob storage
diskURI
string
The URI the data disk in the blob storage
fsType
string
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
kind
string
Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
readOnly
boolean
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+

AzureFilePersistentVolumeSource v1 core

+ + + + + +
GroupVersionKind
corev1AzureFilePersistentVolumeSource
+

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

+
Appears In: + +
+ + + + + + + + +
FieldDescription
readOnly
boolean
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretName
string
the name of secret that contains Azure Storage Account Name and Key
secretNamespace
string
the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod
shareName
string
Share Name
+

AzureFileVolumeSource v1 core

+ + + + + +
GroupVersionKind
corev1AzureFileVolumeSource
+

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

+
Appears In: + +
+ + + + + + + +
FieldDescription
readOnly
boolean
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretName
string
the name of secret that contains Azure Storage Account Name and Key
shareName
string
Share Name
+

CSIPersistentVolumeSource v1 core

+ + + + + +
GroupVersionKind
corev1CSIPersistentVolumeSource
+

Represents storage that is managed by an external CSI volume driver (Beta feature)

+
Appears In: + +
+ + + + + + + + + + + + +
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".
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.

+
Appears In: + +
+ + + + + + +
FieldDescription
add
string array
Added capabilities
drop
string array
Removed capabilities
+

CephFSPersistentVolumeSource v1 core

+ + + + + +
GroupVersionKind
corev1CephFSPersistentVolumeSource
+

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

+
Appears In: + +
+ + + + + + + + + + +
FieldDescription
monitors
string array
Required: Monitors is a collection of Ceph monitors More info: https://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.

+
Appears In: + +
+ + + + + + + + + + +
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.k8s.io

+ + + + + +
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.

+
Appears In: + +
+ + + + + + + + +
FieldDescription
fsType
string
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://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.

+
Appears In: + +
+ + + + + + + + +
FieldDescription
fsType
string
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://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.

+
Appears In: + +
+ + + + + +
FieldDescription
timeoutSeconds
integer
timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours).
+

ComponentCondition v1 core

+ + + + + +
GroupVersionKind
corev1ComponentCondition
+

Information about the condition of a component.

+
Appears In: + +
+ + + + + + + + +
FieldDescription
error
string
Condition error code for a component. For example, a health check error code.
message
string
Message about the condition for a component. For example, information about a health check.
status
string
Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".
type
string
Type of condition for a component. Valid value: "Healthy"
+

ConfigMapEnvSource v1 core

+ + + + + +
GroupVersionKind
corev1ConfigMapEnvSource
+

ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.

+
Appears In: + +
+ + + + + + +
FieldDescription
name
string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap must be defined
+

ConfigMapKeySelector v1 core

+ + + + + +
GroupVersionKind
corev1ConfigMapKeySelector
+

Selects a key from a ConfigMap.

+
Appears In: + +
+ + + + + + + +
FieldDescription
key
string
The key to select.
name
string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap or 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.

+
Appears In: + +
+ + + + + + + + + +
FieldDescription
kubeletConfigKey
string
KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
name
string
Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
namespace
string
Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
resourceVersion
string
ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
uid
string
UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
+

ConfigMapProjection v1 core

+ + + + + +
GroupVersionKind
corev1ConfigMapProjection
+

Adapts a ConfigMap into a projected volume. + +The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.

+
Appears In: + +
+ + + + + + + +
FieldDescription
items
KeyToPath array
If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name
string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the ConfigMap or 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.

+
Appears In: + +
+ + + + + + + + +
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

+
Appears In: + +
+ + + + + + +
FieldDescription
names
string array
Names by which this image is known. e.g. ["k8s.gcr.io/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"]
sizeBytes
integer
The size of the image in bytes.
+

ContainerPort v1 core

+ + + + + +
GroupVersionKind
corev1ContainerPort
+

ContainerPort represents a network port in a single container.

+
Appears In: + +
+ + + + + + + + + +
FieldDescription
containerPort
integer
Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
hostIP
string
What host IP to bind the external port to.
hostPort
integer
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
name
string
If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
protocol
string
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
+

ContainerState v1 core

+ + + + + +
GroupVersionKind
corev1ContainerState
+

ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.

+
Appears In: + +
+ + + + + + + +
FieldDescription
running
ContainerStateRunning
Details about a running container
terminated
ContainerStateTerminated
Details about a terminated container
waiting
ContainerStateWaiting
Details about a waiting container
+

ContainerStateRunning v1 core

+ + + + + +
GroupVersionKind
corev1ContainerStateRunning
+

ContainerStateRunning is a running state of a container.

+
Appears In: + +
+ + + + + +
FieldDescription
startedAt
Time
Time at which the container was last (re-)started
+

ContainerStateTerminated v1 core

+ + + + + +
GroupVersionKind
corev1ContainerStateTerminated
+

ContainerStateTerminated is a terminated state of a container.

+
Appears In: + +
+ + + + + + + + + + + +
FieldDescription
containerID
string
Container's ID in the format 'docker://<container_id>'
exitCode
integer
Exit status from the last termination of the container
finishedAt
Time
Time at which the container last terminated
message
string
Message regarding the last termination of the container
reason
string
(brief) reason from the last termination of the container
signal
integer
Signal from the last termination of the container
startedAt
Time
Time at which previous execution of the container started
+

ContainerStateWaiting v1 core

+ + + + + +
GroupVersionKind
corev1ContainerStateWaiting
+

ContainerStateWaiting is a waiting state of a container.

+
Appears In: + +
+ + + + + + +
FieldDescription
message
string
Message regarding why the container is not yet running.
reason
string
(brief) reason the container is not yet running.
+

CrossVersionObjectReference v1 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv1CrossVersionObjectReference
+

CrossVersionObjectReference contains enough information to let you identify the referred resource.

+
Other API versions of this object exist: +v2beta2 +v2beta1 +
+ + + + + + + + +
FieldDescription
apiVersion
string
API version of the referent
kind
string
Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"
name
string
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
+

CustomResourceColumnDefinition v1beta1 apiextensions.k8s.io

+ + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1CustomResourceColumnDefinition
+

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.k8s.io

+ + + + + +
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.k8s.io

+ + + + + +
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.k8s.io

+ + + + + +
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.k8s.io

+ + + + + +
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.k8s.io

+ + + + + +
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.k8s.io

+ + + + + +
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.k8s.io

+ + + + + +
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.

+
Appears In: + +
+ + + + + +
FieldDescription
Port
integer
Port number of the given endpoint.
+

DaemonSetCondition v1 apps

+ + + + + +
GroupVersionKind
appsv1DaemonSetCondition
+

DaemonSetCondition describes the state of a DaemonSet at a certain point.

+
Other API versions of this object exist: +v1beta2 +v1beta1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
lastTransitionTime
Time
Last time the condition transitioned from one status to another.
message
string
A human readable message indicating details about the transition.
reason
string
The reason for the condition's last transition.
status
string
Status of the condition, one of True, False, Unknown.
type
string
Type of DaemonSet condition.
+

DaemonSetUpdateStrategy v1 apps

+ + + + + +
GroupVersionKind
appsv1DaemonSetUpdateStrategy
+

DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.

+
Other API versions of this object exist: +v1beta2 +v1beta1 +
+
Appears In: + +
+ + + + + + +
FieldDescription
rollingUpdate
RollingUpdateDaemonSet
Rolling update config params. Present only if type = "RollingUpdate".
type
string
Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate.
+

DeleteOptions v1 meta

+ + + + + +
GroupVersionKind
metav1DeleteOptions
+

DeleteOptions may be provided when deleting an API object.

+
Appears In: + +
+ + + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
dryRun
string array
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSeconds
integer
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
kind
string
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/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.

+
Other API versions of this object exist: +v1beta2 +v1beta1 +v1beta1 +
+
Appears In: + +
+ + + + + + + + + + +
FieldDescription
lastTransitionTime
Time
Last time the condition transitioned from one status to another.
lastUpdateTime
Time
The last time this condition was updated.
message
string
A human readable message indicating details about the transition.
reason
string
The reason for the condition's last transition.
status
string
Status of the condition, one of True, False, Unknown.
type
string
Type of deployment condition.
+

DownwardAPIProjection v1 core

+ + + + + +
GroupVersionKind
corev1DownwardAPIProjection
+

Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.

+
Appears In: + +
+ + + + + +
FieldDescription
items
DownwardAPIVolumeFile array
Items is a list of DownwardAPIVolume file
+

DownwardAPIVolumeFile v1 core

+ + + + + +
GroupVersionKind
corev1DownwardAPIVolumeFile
+

DownwardAPIVolumeFile represents information to create the file containing the pod field

+ + + + + + + + + +
FieldDescription
fieldRef
ObjectFieldSelector
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
mode
integer
Optional: mode bits 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.

+
Appears In: + +
+ + + + + + +
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.

+
Appears In: + +
+ + + + + + +
FieldDescription
medium
string
What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
sizeLimit
Quantity
Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir
+

EndpointAddress v1 core

+ + + + + +
GroupVersionKind
corev1EndpointAddress
+

EndpointAddress is a tuple that describes single IP address.

+
Appears In: + +
+ + + + + + + + +
FieldDescription
hostname
string
The Hostname of this endpoint
ip
string
The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready.
nodeName
string
Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.
targetRef
ObjectReference
Reference to object providing the endpoint.
+

EndpointPort v1 core

+ + + + + +
GroupVersionKind
corev1EndpointPort
+

EndpointPort is a tuple that describes a single port.

+
Appears In: + +
+ + + + + + + +
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, TCP, or SCTP. 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 ]

+
Appears In: + +
+ + + + + + + +
FieldDescription
addresses
EndpointAddress array
IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize.
notReadyAddresses
EndpointAddress array
IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check.
ports
EndpointPort array
Port numbers available on the related IP addresses.
+

EnvFromSource v1 core

+ + + + + +
GroupVersionKind
corev1EnvFromSource
+

EnvFromSource represents the source of a set of ConfigMaps

+ + + + + + + + +
FieldDescription
configMapRef
ConfigMapEnvSource
The ConfigMap to select from
prefix
string
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
secretRef
SecretEnvSource
The Secret to select from
+

EnvVar v1 core

+ + + + + +
GroupVersionKind
corev1EnvVar
+

EnvVar represents an environment variable present in a Container.

+ + + + + + + + +
FieldDescription
name
string
Name of the environment variable. Must be a C_IDENTIFIER.
value
string
Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".
valueFrom
EnvVarSource
Source for the environment variable's value. Cannot be used if value is not empty.
+

EnvVarSource v1 core

+ + + + + +
GroupVersionKind
corev1EnvVarSource
+

EnvVarSource represents a source for the value of an EnvVar.

+
Appears In: + +
+ + + + + + + + +
FieldDescription
configMapKeyRef
ConfigMapKeySelector
Selects a key of a ConfigMap.
fieldRef
ObjectFieldSelector
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, 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.

+
Other API versions of this object exist: +v1beta1 +
+
Appears In: + +
+ + + + + + + +
FieldDescription
count
integer
Number of occurrences in this series up to the last heartbeat time
lastObservedTime
MicroTime
Time of the last occurrence observed
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.

+
Appears In: + +
+ + + + + +
FieldDescription
command
string array
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+

ExternalDocumentation v1beta1 apiextensions.k8s.io

+ + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1ExternalDocumentation
+

ExternalDocumentation allows referencing an external resource for extended documentation.

+ + + + + + + +
FieldDescription
description
string
url
string
+

ExternalMetricSource v2beta2 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta2ExternalMetricSource
+

ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).

+
Other API versions of this object exist: +v2beta1 +
+ + + + + + + +
FieldDescription
metric
MetricIdentifier
metric identifies the target metric by name and selector
target
MetricTarget
target specifies the target value for the given metric
+

ExternalMetricStatus v2beta2 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta2ExternalMetricStatus
+

ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.

+
Other API versions of this object exist: +v2beta1 +
+ + + + + + + +
FieldDescription
current
MetricValueStatus
current contains the current value for the given metric
metric
MetricIdentifier
metric identifies the target metric by name and selector
+

FCVolumeSource v1 core

+ + + + + +
GroupVersionKind
corev1FCVolumeSource
+

Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.

+ + + + + + + + + + +
FieldDescription
fsType
string
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
lun
integer
Optional: FC target lun number
readOnly
boolean
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
targetWWNs
string array
Optional: FC target worldwide names (WWNs)
wwids
string array
Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
+

FSGroupStrategyOptions v1beta1 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.

+
Appears In: + +
+ + + + + + + + + +
FieldDescription
driver
string
Driver is the name of the driver to use for this volume.
fsType
string
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
options
object
Optional: Extra command options if any.
readOnly
boolean
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef
SecretReference
Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
+

FlexVolumeSource v1 core

+ + + + + +
GroupVersionKind
corev1FlexVolumeSource
+

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

+
Appears In: + +
+ + + + + + + + + +
FieldDescription
driver
string
Driver is the name of the driver to use for this volume.
fsType
string
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
options
object
Optional: Extra command options if any.
readOnly
boolean
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef
LocalObjectReference
Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.
+

FlockerVolumeSource v1 core

+ + + + + +
GroupVersionKind
corev1FlockerVolumeSource
+

Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.

+ + + + + + + +
FieldDescription
datasetName
string
Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
datasetUUID
string
UUID of the dataset. This is unique identifier of a Flocker dataset
+

GCEPersistentDiskVolumeSource v1 core

+ + + + + +
GroupVersionKind
corev1GCEPersistentDiskVolumeSource
+

Represents a Persistent Disk resource in Google Compute Engine. + +A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

+ + + + + + + + + +
FieldDescription
fsType
string
Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
partition
integer
The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
pdName
string
Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
readOnly
boolean
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+

GitRepoVolumeSource v1 core

+ + + + + +
GroupVersionKind
corev1GitRepoVolumeSource
+

Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. + +DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

+
Appears In: + +
+ + + + + + + +
FieldDescription
directory
string
Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
repository
string
Repository URL
revision
string
Commit hash for the specified revision.
+

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.

+
Appears In: + +
+ + + + + + +
FieldDescription
groupVersion
string
groupVersion specifies the API group and version in the form "group/version"
version
string
version specifies the version in the form of "version". This is to save the clients the trouble of splitting the GroupVersion.
+

HTTPGetAction v1 core

+ + + + + +
GroupVersionKind
corev1HTTPGetAction
+

HTTPGetAction describes an action based on HTTP Get requests.

+
Appears In: + +
+ + + + + + + + + +
FieldDescription
host
string
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
httpHeaders
HTTPHeader array
Custom headers to set in the request. HTTP allows repeated headers.
path
string
Path to access on the HTTP server.
portName or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
scheme
string
Scheme to use for connecting to the host. Defaults to HTTP.
+

HTTPHeader v1 core

+ + + + + +
GroupVersionKind
corev1HTTPHeader
+

HTTPHeader describes a custom header to be used in HTTP probes

+
Appears In: + +
+ + + + + + +
FieldDescription
name
string
The header field name
value
string
The header field value
+

HTTPIngressPath 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> -> 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

+
Appears In: + +
+ + + + + + + +
FieldDescription
exec
ExecAction
One and only one of the following should be specified. Exec specifies the action to take.
httpGet
HTTPGetAction
HTTPGet specifies the http request to perform.
tcpSocket
TCPSocketAction
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported
+

HorizontalPodAutoscalerCondition v2beta2 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta2HorizontalPodAutoscalerCondition
+

HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.

+
Other API versions of this object exist: +v2beta1 +
+ + + + + + + + + + +
FieldDescription
lastTransitionTime
Time
lastTransitionTime is the last time the condition transitioned from one status to another
message
string
message is a human-readable explanation containing details about the transition
reason
string
reason is the reason for the condition's last transition.
status
string
status is the status of the condition (True, False, Unknown)
type
string
type describes the current condition
+

HostAlias v1 core

+ + + + + +
GroupVersionKind
corev1HostAlias
+

HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.

+
Appears In: + +
+ + + + + + +
FieldDescription
hostnames
string array
Hostnames for the above IP address.
ip
string
IP address of the host file entry.
+

HostPathVolumeSource v1 core

+ + + + + +
GroupVersionKind
corev1HostPathVolumeSource
+

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

+ + + + + + + +
FieldDescription
path
string
Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
type
string
Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+

HostPortRange v1beta1 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.k8s.io

+ + + + + +
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.

+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + +
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.

+
Appears In: + +
+ + + + + + + + + + + + + + + +
FieldDescription
chapAuthDiscovery
boolean
whether support iSCSI Discovery CHAP authentication
chapAuthSession
boolean
whether support iSCSI Session CHAP authentication
fsType
string
Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
initiatorName
string
Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
iqn
string
Target iSCSI Qualified Name.
iscsiInterface
string
iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
lun
integer
iSCSI Target Lun number.
portals
string array
iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
readOnly
boolean
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
secretRef
SecretReference
CHAP Secret for iSCSI target and initiator authentication
targetPortal
string
iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
+

ISCSIVolumeSource v1 core

+ + + + + +
GroupVersionKind
corev1ISCSIVolumeSource
+

Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

+
Appears In: + +
+ + + + + + + + + + + + + + + +
FieldDescription
chapAuthDiscovery
boolean
whether support iSCSI Discovery CHAP authentication
chapAuthSession
boolean
whether support iSCSI Session CHAP authentication
fsType
string
Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
initiatorName
string
Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
iqn
string
Target iSCSI Qualified Name.
iscsiInterface
string
iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
lun
integer
iSCSI Target Lun number.
portals
string array
iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
readOnly
boolean
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
secretRef
LocalObjectReference
CHAP Secret for iSCSI target and initiator authentication
targetPortal
string
iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
+

IngressBackend 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.

+
Other API versions of this object exist: +v1alpha1 +
+
Appears In: + +
+ + + + + +
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.

+
Appears In: + +
+ + + + + + +
FieldDescription
pending
Initializer array
patch strategy: 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.k8s.io

+ + + + + +
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
+

JSONSchemaProps v1beta1 apiextensions.k8s.io

+ + + + + +
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.k8s.io

+ + + + + +
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
+

JSONSchemaPropsOrBool v1beta1 apiextensions.k8s.io

+ + + + + +
GroupVersionKind
apiextensions.k8s.iov1beta1JSONSchemaPropsOrBool
+

JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.

+ + + + + +
FieldDescription
+

JobCondition v1 batch

+ + + + + +
GroupVersionKind
batchv1JobCondition
+

JobCondition describes current state of a job.

+
Appears In: + +
+ + + + + + + + + + +
FieldDescription
lastProbeTime
Time
Last time the condition was checked.
lastTransitionTime
Time
Last time the condition transit from one status to another.
message
string
Human readable message indicating details about last transition.
reason
string
(brief) reason for the condition's last transition.
status
string
Status of the condition, one of True, False, Unknown.
type
string
Type of job condition, Complete or Failed.
+

JobTemplateSpec v1beta1 batch

+ + + + + +
GroupVersionKind
batchv1beta1JobTemplateSpec
+

JobTemplateSpec describes the data a Job should have when created from a template

+
Other API versions of this object exist: +v2alpha1 +
+
Appears In: + +
+ + + + + + +
FieldDescription
metadata
ObjectMeta
Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/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.

+
Appears In: + +
+ + + + + + + +
FieldDescription
key
string
patch strategy: merge
patch merge key: key
key is the label key that the selector applies to.
operator
string
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values
string array
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
+

Lease v1beta1 coordination.k8s.io

+ + + + + +
GroupVersionKind
coordination.k8s.iov1beta1Lease
+

Lease defines a lease concept.

+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. 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
More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
spec
LeaseSpec
Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
+

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.

+
Appears In: + +
+ + + + + + +
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.

+
Appears In: + +
+ + + + + + + + + + +
FieldDescription
default
object
Default resource requirement limit value by resource name if resource limit is omitted.
defaultRequest
object
DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.
max
object
Max usage constraints on this kind by resource name.
maxLimitRequestRatio
object
MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource.
min
object
Min usage constraints on this kind by resource name.
type
string
Type of resource that this limit applies to.
+

ListMeta v1 meta

+ + + + + +
GroupVersionKind
metav1ListMeta
+

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

+
Appears In: + +
+ + + + + + + +
FieldDescription
continue
string
continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.
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.

+
Appears In: + +
+ + + + + + +
FieldDescription
hostname
string
Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)
ip
string
IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)
+

LoadBalancerStatus v1 core

+ + + + + +
GroupVersionKind
corev1LoadBalancerStatus
+

LoadBalancerStatus represents the status of a load-balancer.

+ + + + + + +
FieldDescription
ingress
LoadBalancerIngress array
Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.
+

LocalObjectReference v1 core

+ + + + + +
GroupVersionKind
corev1LocalObjectReference
+

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

+ + + + + + +
FieldDescription
name
string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+

LocalVolumeSource v1 core

+ + + + + +
GroupVersionKind
corev1LocalVolumeSource
+

Local represents directly-attached storage with node affinity (Beta feature)

+
Appears In: + +
+ + + + + + +
FieldDescription
fsType
string
Filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a fileystem if unspecified.
path
string
The full path to the volume on the node. It can be either a directory or block device (disk, partition, ...).
+

MetricIdentifier v2beta2 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta2MetricIdentifier
+

MetricIdentifier defines the name and optionally selector for a metric

+ + + + + + + +
FieldDescription
name
string
name is the name of the given metric
selector
LabelSelector
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
+

MetricSpec v2beta2 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta2MetricSpec
+

MetricSpec specifies how to scale based on a single metric (only `type` and one other matching field should be set at once).

+
Other API versions of this object exist: +v2beta1 +
+ + + + + + + + + + +
FieldDescription
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 v2beta2 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta2MetricStatus
+

MetricStatus describes the last-read state of a single metric.

+
Other API versions of this object exist: +v2beta1 +
+ + + + + + + + + + +
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.
+

MetricTarget v2beta2 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta2MetricTarget
+

MetricTarget defines the target value, average value, or average utilization of a specific metric

+ + + + + + + + + +
FieldDescription
averageUtilization
integer
averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type
averageValue
Quantity
averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
type
string
type represents whether the metric type is Utilization, Value, or AverageValue
value
Quantity
value is the target value of the metric (as a quantity).
+

MetricValueStatus v2beta2 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta2MetricValueStatus
+

MetricValueStatus holds the current value for a metric

+ + + + + + + + +
FieldDescription
averageUtilization
integer
currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
averageValue
Quantity
averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
value
Quantity
value is the current value of the metric (as a quantity).
+

MicroTime v1 meta

+ + + + + +
GroupVersionKind
metav1MicroTime
+

MicroTime is version of Time with microsecond level precision.

+ + + + + +
FieldDescription
+

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.k8s.io

+ + + + + +
GroupVersionKind
networking.k8s.iov1NetworkPolicyEgressRule
+

NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8

+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + +
FieldDescription
ports
NetworkPolicyPort array
List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.
to
NetworkPolicyPeer array
List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.
+

NetworkPolicyIngressRule v1 networking.k8s.io

+ + + + + +
GroupVersionKind
networking.k8s.iov1NetworkPolicyIngressRule
+

NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.

+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + +
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.k8s.io

+ + + + + +
GroupVersionKind
networking.k8s.iov1NetworkPolicyPeer
+

NetworkPolicyPeer describes a peer to allow traffic from. Only certain combinations of fields are allowed

+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + + +
FieldDescription
ipBlock
IPBlock
IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.
namespaceSelector
LabelSelector
Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces. If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector.
podSelector
LabelSelector
This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods. If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace.
+

NetworkPolicyPort v1 networking.k8s.io

+ + + + + +
GroupVersionKind
networking.k8s.iov1NetworkPolicyPort
+

NetworkPolicyPort describes a port to allow traffic on

+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + +
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, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.
+

NodeAddress v1 core

+ + + + + +
GroupVersionKind
corev1NodeAddress
+

NodeAddress contains information for the node's address.

+
Appears In: + +
+ + + + + + +
FieldDescription
address
string
The node address.
type
string
Node address type, one of Hostname, ExternalIP or InternalIP.
+

NodeAffinity v1 core

+ + + + + +
GroupVersionKind
corev1NodeAffinity
+

Node affinity is a group of node affinity scheduling rules.

+
Appears In: + +
+ + + + + + +
FieldDescription
preferredDuringSchedulingIgnoredDuringExecution
PreferredSchedulingTerm array
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution
NodeSelector
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.
+

NodeCondition v1 core

+ + + + + +
GroupVersionKind
corev1NodeCondition
+

NodeCondition contains condition information for a node.

+
Appears In: + +
+ + + + + + + + + + +
FieldDescription
lastHeartbeatTime
Time
Last time we got an update on a given condition.
lastTransitionTime
Time
Last time the condition transit from one status to another.
message
string
Human readable message indicating details about last transition.
reason
string
(brief) reason for the condition's last transition.
status
string
Status of the condition, one of True, False, Unknown.
type
string
Type of node condition.
+

NodeConfigSource v1 core

+ + + + + +
GroupVersionKind
corev1NodeConfigSource
+

NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil.

+ + + + + + +
FieldDescription
configMap
ConfigMapNodeConfigSource
ConfigMap is a reference to a Node's ConfigMap
+

NodeConfigStatus v1 core

+ + + + + +
GroupVersionKind
corev1NodeConfigStatus
+

NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.

+
Appears In: + +
+ + + + + + + + +
FieldDescription
active
NodeConfigSource
Active reports the checkpointed config the node is actively using. Active will represent either the current version of the Assigned config, or the current LastKnownGood config, depending on whether attempting to use the Assigned config results in an error.
assigned
NodeConfigSource
Assigned reports the checkpointed config the node will try to use. When Node.Spec.ConfigSource is updated, the node checkpoints the associated config payload to local disk, along with a record indicating intended config. The node refers to this record to choose its config checkpoint, and reports this record in Assigned. Assigned only updates in the status after the record has been checkpointed to disk. When the Kubelet is restarted, it tries to make the Assigned config the Active config by loading and validating the checkpointed payload identified by Assigned.
error
string
Error describes any problems reconciling the Spec.ConfigSource to the Active config. Errors may occur, for example, attempting to checkpoint Spec.ConfigSource to the local Assigned record, attempting to checkpoint the payload associated with Spec.ConfigSource, attempting to load or validate the Assigned config, etc. Errors may occur at different points while syncing config. Earlier errors (e.g. download or checkpointing errors) will not result in a rollback to LastKnownGood, and may resolve across Kubelet retries. Later errors (e.g. loading or validating a checkpointed config) will result in a rollback to LastKnownGood. In the latter case, it is usually possible to resolve the error by fixing the config assigned in Spec.ConfigSource. You can find additional information for debugging by searching the error message in the Kubelet log. Error is a human-readable description of the error state; machines can check whether or not Error is empty, but should not rely on the stability of the Error text across Kubelet versions.
lastKnownGood
NodeConfigSource
LastKnownGood reports the checkpointed config the node will fall back to when it encounters an error attempting to use the Assigned config. The Assigned config becomes the LastKnownGood config when the node determines that the Assigned config is stable and correct. This is currently implemented as a 10-minute soak period starting when the local record of Assigned config is updated. If the Assigned config is Active at the end of this period, it becomes the LastKnownGood. Note that if Spec.ConfigSource is reset to nil (use local defaults), the LastKnownGood is also immediately reset to nil, because the local default config is always assumed good. You should not make assumptions about the node's method of determining config stability and correctness, as this may change or become configurable in the future.
+

NodeDaemonEndpoints v1 core

+ + + + + +
GroupVersionKind
corev1NodeDaemonEndpoints
+

NodeDaemonEndpoints lists ports opened by daemons running on the Node.

+
Appears In: + +
+ + + + + +
FieldDescription
kubeletEndpoint
DaemonEndpoint
Endpoint on which Kubelet is listening.
+

NodeSelector v1 core

+ + + + + +
GroupVersionKind
corev1NodeSelector
+

A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.

+ + + + + + +
FieldDescription
nodeSelectorTerms
NodeSelectorTerm array
Required. A list of node selector terms. The terms are ORed.
+

NodeSelectorRequirement v1 core

+ + + + + +
GroupVersionKind
corev1NodeSelectorRequirement
+

A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

+
Appears In: + +
+ + + + + + + +
FieldDescription
key
string
The label key that the selector applies to.
operator
string
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values
string array
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
+

NodeSelectorTerm v1 core

+ + + + + +
GroupVersionKind
corev1NodeSelectorTerm
+

A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

+ + + + + + + +
FieldDescription
matchExpressions
NodeSelectorRequirement array
A list of node selector requirements by node's labels.
matchFields
NodeSelectorRequirement array
A list of node selector requirements by node's fields.
+

NodeSystemInfo v1 core

+ + + + + +
GroupVersionKind
corev1NodeSystemInfo
+

NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

+
Appears In: + +
+ + + + + + + + + + + + + + +
FieldDescription
architecture
string
The Architecture reported by the node
bootID
string
Boot ID reported by the node.
containerRuntimeVersion
string
ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).
kernelVersion
string
Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).
kubeProxyVersion
string
KubeProxy Version reported by the node.
kubeletVersion
string
Kubelet Version reported by the node.
machineID
string
MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html
operatingSystem
string
The Operating System reported by the node
osImage
string
OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).
systemUUID
string
SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/getting-system-uuid.html
+

NonResourceAttributes v1 authorization.k8s.io

+ + + + + +
GroupVersionKind
authorization.k8s.iov1NonResourceAttributes
+

NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface

+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + +
FieldDescription
path
string
Path is the URL path of the request
verb
string
Verb is the standard HTTP verb
+

NonResourceRule v1 authorization.k8s.io

+ + + + + +
GroupVersionKind
authorization.k8s.iov1NonResourceRule
+

NonResourceRule holds information that describes a rule for the non-resource

+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + +
FieldDescription
nonResourceURLs
string array
NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path. "*" means all.
verbs
string array
Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all.
+

ObjectFieldSelector v1 core

+ + + + + +
GroupVersionKind
corev1ObjectFieldSelector
+

ObjectFieldSelector selects an APIVersioned field of an object.

+ + + + + + + +
FieldDescription
apiVersion
string
Version of the schema the FieldPath is written in terms of, defaults to "v1".
fieldPath
string
Path of the field to select in the specified API version.
+

ObjectMeta v1 meta

+ + + + + +
GroupVersionKind
metav1ObjectMeta
+

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

+
Appears In: + +
+ + + + + + + + + + + + + + + + + + + + +
FieldDescription
annotations
object
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
clusterName
string
The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
creationTimestamp
Time
CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/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 strategy: merge
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.
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 strategy: merge
patch merge key: uid
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
resourceVersion
string
An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/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 v2beta2 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta2ObjectMetricSource
+

ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

+
Other API versions of this object exist: +v2beta1 +
+ + + + + + + + +
FieldDescription
describedObject
CrossVersionObjectReference
metric
MetricIdentifier
metric identifies the target metric by name and selector
target
MetricTarget
target specifies the target value for the given metric
+

ObjectMetricStatus v2beta2 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta2ObjectMetricStatus
+

ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

+
Other API versions of this object exist: +v2beta1 +
+ + + + + + + + +
FieldDescription
current
MetricValueStatus
current contains the current value for the given metric
describedObject
CrossVersionObjectReference
metric
MetricIdentifier
metric identifies the target metric by name and selector
+

ObjectReference v1 core

+ + + + + +
GroupVersionKind
corev1ObjectReference
+

ObjectReference contains enough information to let you inspect or modify the referred object.

+ + + + + + + + + + + + +
FieldDescription
apiVersion
string
API version of the referent.
fieldPath
string
If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
kind
string
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/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.

+
Appears In: + +
+ + + + + + + + + + +
FieldDescription
apiVersion
string
API version of the referent.
blockOwnerDeletion
boolean
If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
controller
boolean
If true, this reference points to the managing controller.
kind
string
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/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).

+
Appears In: + +
+ + + + + + +
FieldDescription
claimName
string
ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
readOnly
boolean
Will force the ReadOnly setting in VolumeMounts. Default false.
+

PhotonPersistentDiskVolumeSource v1 core

+ + + + + +
GroupVersionKind
corev1PhotonPersistentDiskVolumeSource
+

Represents a Photon Controller persistent disk resource.

+ + + + + + + +
FieldDescription
fsType
string
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
pdID
string
ID that identifies Photon Controller persistent disk
+

PodAffinity v1 core

+ + + + + +
GroupVersionKind
corev1PodAffinity
+

Pod affinity is a group of inter pod affinity scheduling rules.

+
Appears In: + +
+ + + + + + +
FieldDescription
preferredDuringSchedulingIgnoredDuringExecution
WeightedPodAffinityTerm array
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution
PodAffinityTerm array
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
+

PodAffinityTerm v1 core

+ + + + + +
GroupVersionKind
corev1PodAffinityTerm
+

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

+ + + + + + + + +
FieldDescription
labelSelector
LabelSelector
A label query over a set of resources, in this case pods.
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.

+
Appears In: + +
+ + + + + + +
FieldDescription
preferredDuringSchedulingIgnoredDuringExecution
WeightedPodAffinityTerm array
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.
requiredDuringSchedulingIgnoredDuringExecution
PodAffinityTerm array
If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.
+

PodCondition v1 core

+ + + + + +
GroupVersionKind
corev1PodCondition
+

PodCondition contains details for the current condition of this pod.

+
Appears In: + +
+ + + + + + + + + + +
FieldDescription
lastProbeTime
Time
Last time we probed the condition.
lastTransitionTime
Time
Last time the condition transitioned from one status to another.
message
string
Human-readable message indicating details about last transition.
reason
string
Unique, one-word, CamelCase reason for the condition's last transition.
status
string
Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
type
string
Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
+

PodDNSConfig v1 core

+ + + + + +
GroupVersionKind
corev1PodDNSConfig
+

PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.

+
Appears In: + +
+ + + + + + + +
FieldDescription
nameservers
string array
A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.
options
PodDNSConfigOption array
A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.
searches
string array
A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.
+

PodDNSConfigOption v1 core

+ + + + + +
GroupVersionKind
corev1PodDNSConfigOption
+

PodDNSConfigOption defines DNS resolver options of a pod.

+
Appears In: + +
+ + + + + + +
FieldDescription
name
string
Required.
value
string
+

PodReadinessGate v1 core

+ + + + + +
GroupVersionKind
corev1PodReadinessGate
+

PodReadinessGate contains the reference to a pod condition

+
Appears In: + +
+ + + + + +
FieldDescription
conditionType
string
ConditionType refers to a condition in the pod's condition list with matching type.
+

PodSecurityContext v1 core

+ + + + + +
GroupVersionKind
corev1PodSecurityContext
+

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

+
Appears In: + +
+ + + + + + + + + + + +
FieldDescription
fsGroup
integer
A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume.
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 v2beta2 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta2PodsMetricSource
+

PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.

+
Other API versions of this object exist: +v2beta1 +
+ + + + + + + +
FieldDescription
metric
MetricIdentifier
metric identifies the target metric by name and selector
target
MetricTarget
target specifies the target value for the given metric
+

PodsMetricStatus v2beta2 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta2PodsMetricStatus
+

PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).

+
Other API versions of this object exist: +v2beta1 +
+ + + + + + + +
FieldDescription
current
MetricValueStatus
current contains the current value for the given metric
metric
MetricIdentifier
metric identifies the target metric by name and selector
+

PolicyRule v1 rbac.authorization.k8s.io

+ + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1PolicyRule
+

PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.

+
Other API versions of this object exist: +v1beta1 +v1alpha1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiGroups
string array
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
nonResourceURLs
string array
NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
resourceNames
string array
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
resources
string array
Resources is a list of resources this rule applies to. ResourceAll represents all resources.
verbs
string array
Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
+

PortworxVolumeSource v1 core

+ + + + + +
GroupVersionKind
corev1PortworxVolumeSource
+

PortworxVolumeSource represents a Portworx volume resource.

+ + + + + + + + +
FieldDescription
fsType
string
FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
readOnly
boolean
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
volumeID
string
VolumeID uniquely identifies a Portworx volume
+

Preconditions v1 meta

+ + + + + +
GroupVersionKind
metav1Preconditions
+

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

+
Appears In: + +
+ + + + + +
FieldDescription
uid
string
Specifies the target UID.
+

PreferredSchedulingTerm v1 core

+ + + + + +
GroupVersionKind
corev1PreferredSchedulingTerm
+

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

+
Appears In: + +
+ + + + + + +
FieldDescription
preference
NodeSelectorTerm
A node selector term, associated with the corresponding weight.
weight
integer
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
+

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.

+
Appears In: + +
+ + + + + + + + + + + + +
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

+
Appears In: + +
+ + + + + + +
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
+

Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and Int64() accessors. + +The serialization format is: + +<quantity> ::= <signedNumber><suffix> + (Note that <suffix> may be empty, from the "" case in <decimalSI>.) +<digit> ::= 0 | 1 | ... | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= "+" | "-" <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei + (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) +<decimalSI> ::= m | "" | k | M | G | T | P | E + (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) +<decimalExponent> ::= "e" <signedNumber> | "E" <signedNumber> + +No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. + +When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. + +Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: + a. No precision is lost + b. No fractional digits will be emitted + c. The exponent (or suffix) is as large as possible. +The sign will be omitted unless the number is negative. + +Examples: + 1.5 will be serialized as "1500m" + 1.5Gi will be serialized as "1536Mi" + +Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. + +Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) + +This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.

+ + + + + +
FieldDescription
+

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.

+
Appears In: + +
+ + + + + + + + + + + + +
FieldDescription
fsType
string
Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
image
string
The rados image name. More info: https://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.

+
Appears In: + +
+ + + + + + + + + + + + +
FieldDescription
fsType
string
Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd
image
string
The rados image name. More info: https://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.

+
Other API versions of this object exist: +v1beta2 +v1beta1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
lastTransitionTime
Time
The last time the condition transitioned from one status to another.
message
string
A human readable message indicating details about the transition.
reason
string
The reason for the condition's last transition.
status
string
Status of the condition, one of True, False, Unknown.
type
string
Type of replica set condition.
+

ReplicationControllerCondition v1 core

+ + + + + +
GroupVersionKind
corev1ReplicationControllerCondition
+

ReplicationControllerCondition describes the state of a replication controller at a certain point.

+ + + + + + + + + + +
FieldDescription
lastTransitionTime
Time
The last time the condition transitioned from one status to another.
message
string
A human readable message indicating details about the transition.
reason
string
The reason for the condition's last transition.
status
string
Status of the condition, one of True, False, Unknown.
type
string
Type of replication controller condition.
+

ResourceAttributes v1 authorization.k8s.io

+ + + + + +
GroupVersionKind
authorization.k8s.iov1ResourceAttributes
+

ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface

+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + + + + + + +
FieldDescription
group
string
Group is the API Group of the Resource. "*" means all.
name
string
Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.
namespace
string
Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview
resource
string
Resource is one of the existing resource types. "*" means all.
subresource
string
Subresource is one of the existing resource types. "" means none.
verb
string
Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all.
version
string
Version is the API Version of the Resource. "*" means all.
+

ResourceFieldSelector v1 core

+ + + + + +
GroupVersionKind
corev1ResourceFieldSelector
+

ResourceFieldSelector represents container resources (cpu, memory) and their output format

+ + + + + + + + +
FieldDescription
containerName
string
Container name: required for volumes, optional for env vars
divisor
Quantity
Specifies the output format of the exposed resources, defaults to "1"
resource
string
Required: resource to select
+

ResourceMetricSource v2beta2 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta2ResourceMetricSource
+

ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.

+
Other API versions of this object exist: +v2beta1 +
+ + + + + + + +
FieldDescription
name
string
name is the name of the resource in question.
target
MetricTarget
target specifies the target value for the given metric
+

ResourceMetricStatus v2beta2 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta2ResourceMetricStatus
+

ResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.

+
Other API versions of this object exist: +v2beta1 +
+ + + + + + + +
FieldDescription
current
MetricValueStatus
current contains the current value for the given metric
name
string
Name is the name of the resource in question.
+

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.k8s.io

+ + + + + +
GroupVersionKind
authorization.k8s.iov1ResourceRule
+

ResourceRule is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.

+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + + + +
FieldDescription
apiGroups
string array
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "*" means all.
resourceNames
string array
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all.
resources
string array
Resources is a list of resources this rule applies to. "*" means all in the specified apiGroups. "*/foo" represents the subresource 'foo' for all resources in the specified apiGroups.
verbs
string array
Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all.
+

RoleRef v1 rbac.authorization.k8s.io

+ + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1RoleRef
+

RoleRef contains information that points to the role being used

+
Other API versions of this object exist: +v1beta1 +v1alpha1 +
+ + + + + + + + +
FieldDescription
apiGroup
string
APIGroup is the group for the resource being referenced
kind
string
Kind is the type of resource being referenced
name
string
Name is the name of resource being referenced
+

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.

+
Other API versions of this object exist: +v1beta2 +v1beta1 +
+ + + + + + +
FieldDescription
partition
integer
Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0.
+

Rule v1alpha1 admissionregistration.k8s.io

+ + + + + +
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.k8s.io

+ + + + + +
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.

+
Other API versions of this object exist: +v1beta2 +v1beta1 +v1beta1 +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + + + + + + + + + + +
FieldDescription
fsType
string
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs"
gateway
string
The host address of the ScaleIO API Gateway.
protectionDomain
string
The name of the ScaleIO Protection Domain for the configured storage.
readOnly
boolean
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef
SecretReference
SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
sslEnabled
boolean
Flag to enable/disable SSL communication with Gateway, default false
storageMode
string
Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
storagePool
string
The ScaleIO Storage Pool associated with the protection domain.
system
string
The name of the storage system as configured in ScaleIO.
volumeName
string
The name of a volume already created in the ScaleIO system that is associated with this volume source.
+

ScaleIOVolumeSource v1 core

+ + + + + +
GroupVersionKind
corev1ScaleIOVolumeSource
+

ScaleIOVolumeSource represents a persistent ScaleIO volume

+
Appears In: + +
+ + + + + + + + + + + + + + +
FieldDescription
fsType
string
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
gateway
string
The host address of the ScaleIO API Gateway.
protectionDomain
string
The name of the ScaleIO Protection Domain for the configured storage.
readOnly
boolean
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef
LocalObjectReference
SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.
sslEnabled
boolean
Flag to enable/disable SSL communication with Gateway, default false
storageMode
string
Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
storagePool
string
The ScaleIO Storage Pool associated with the protection domain.
system
string
The name of the storage system as configured in ScaleIO.
volumeName
string
The name of a volume already created in the ScaleIO system that is associated with this volume source.
+

ScopeSelector v1 core

+ + + + + +
GroupVersionKind
corev1ScopeSelector
+

A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements.

+
Appears In: + +
+ + + + + +
FieldDescription
matchExpressions
ScopedResourceSelectorRequirement array
A list of scope selector requirements by scope of the resources.
+

ScopedResourceSelectorRequirement v1 core

+ + + + + +
GroupVersionKind
corev1ScopedResourceSelectorRequirement
+

A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values.

+
Appears In: + +
+ + + + + + + +
FieldDescription
operator
string
Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.
scopeName
string
The name of the scope that the selector applies to.
values
string array
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
+

SecretEnvSource v1 core

+ + + + + +
GroupVersionKind
corev1SecretEnvSource
+

SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables.

+
Appears In: + +
+ + + + + + +
FieldDescription
name
string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret must be defined
+

SecretKeySelector v1 core

+ + + + + +
GroupVersionKind
corev1SecretKeySelector
+

SecretKeySelector selects a key of a Secret.

+
Appears In: + +
+ + + + + + + +
FieldDescription
key
string
The key of the secret to select from. Must be a valid secret key.
name
string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or 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.

+
Appears In: + +
+ + + + + + + +
FieldDescription
items
KeyToPath array
If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
name
string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optional
boolean
Specify whether the Secret or its key must be defined
+

SecretReference v1 core

+ + + + + +
GroupVersionKind
corev1SecretReference
+

SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace

+ + + + + + + +
FieldDescription
name
string
Name is unique within a namespace to reference a secret resource.
namespace
string
Namespace defines the space within which the secret name must be unique.
+

SecretVolumeSource v1 core

+ + + + + +
GroupVersionKind
corev1SecretVolumeSource
+

Adapts a Secret into a volume. + +The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.

+
Appears In: + +
+ + + + + + + + +
FieldDescription
defaultMode
integer
Optional: mode bits 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.

+
Appears In: + +
+ + + + + + + + + + + + + +
FieldDescription
allowPrivilegeEscalation
boolean
AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN
capabilities
Capabilities
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
privileged
boolean
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
procMount
string
procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled.
readOnlyRootFilesystem
boolean
Whether this container has a read-only root filesystem. Default is false.
runAsGroup
integer
The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsNonRoot
boolean
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
runAsUser
integer
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
seLinuxOptions
SELinuxOptions
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+

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).

+
Appears In: + +
+ + + + + + + +
FieldDescription
audience
string
Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.
expirationSeconds
integer
ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.
path
string
Path is the path relative to the mount point of the file to project the token into.
+

ServicePort v1 core

+ + + + + +
GroupVersionKind
corev1ServicePort
+

ServicePort contains information on service's port.

+
Appears In: + +
+ + + + + + + + + +
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", "UDP", and "SCTP". Default is TCP.
targetPortNumber or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
+

ServiceReference v1 apiregistration.k8s.io

+ + + + + +
GroupVersionKind
apiregistration.k8s.iov1ServiceReference
+

ServiceReference holds a reference to Service.legacy.k8s.io

+
Other API versions of this object exist: +v1beta1 +v1beta1 +
+ + + + + + + +
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.

+
Appears In: + +
+ + + + + +
FieldDescription
clientIP
ClientIPConfig
clientIP contains the configurations of Client IP based session affinity.
+

StatefulSetCondition v1 apps

+ + + + + +
GroupVersionKind
appsv1StatefulSetCondition
+

StatefulSetCondition describes the state of a statefulset at a certain point.

+
Other API versions of this object exist: +v1beta2 +v1beta1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
lastTransitionTime
Time
Last time the condition transitioned from one status to another.
message
string
A human readable message indicating details about the transition.
reason
string
The reason for the condition's last transition.
status
string
Status of the condition, one of True, False, Unknown.
type
string
Type of statefulset condition.
+

StatefulSetUpdateStrategy v1 apps

+ + + + + +
GroupVersionKind
appsv1StatefulSetUpdateStrategy
+

StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.

+
Other API versions of this object exist: +v1beta2 +v1beta1 +
+
Appears In: + +
+ + + + + + +
FieldDescription
rollingUpdate
RollingUpdateStatefulSetStrategy
RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
type
string
Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.
+

Status v1 meta

+ + + + + +
GroupVersionKind
metav1Status
+

Status is a return value for calls that don't return other objects.

+
Appears In: + +
+ + + + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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.

+
Appears In: + +
+ + + + + + + +
FieldDescription
field
string
The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"
message
string
A human-readable description of the cause of the error. This field may be presented as-is to a reader.
reason
string
A machine-readable description of the cause of the error. If this value is empty there is no information available.
+

StatusDetails v1 meta

+ + + + + +
GroupVersionKind
metav1StatusDetails
+

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

+
Appears In: + +
+ + + + + + + + + + +
FieldDescription
causes
StatusCause array
The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
group
string
The group attribute of the resource associated with the status StatusReason.
kind
string
The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
name
string
The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
retryAfterSeconds
integer
If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
uid
string
UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids
+

StorageOSPersistentVolumeSource v1 core

+ + + + + +
GroupVersionKind
corev1StorageOSPersistentVolumeSource
+

Represents a StorageOS persistent volume resource.

+
Appears In: + +
+ + + + + + + + + +
FieldDescription
fsType
string
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
readOnly
boolean
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef
ObjectReference
SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
volumeName
string
VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
volumeNamespace
string
VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
+

StorageOSVolumeSource v1 core

+ + + + + +
GroupVersionKind
corev1StorageOSVolumeSource
+

Represents a StorageOS persistent volume resource.

+
Appears In: + +
+ + + + + + + + + +
FieldDescription
fsType
string
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
readOnly
boolean
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
secretRef
LocalObjectReference
SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.
volumeName
string
VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
volumeNamespace
string
VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.
+

Subject v1 rbac.authorization.k8s.io

+ + + + + +
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.

+
Other API versions of this object exist: +v1beta1 +v1alpha1 +
+ + + + + + + + + +
FieldDescription
apiGroup
string
APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
kind
string
Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
name
string
Name of the object being referenced.
namespace
string
Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
+

SubjectRulesReviewStatus v1 authorization.k8s.io

+ + + + + +
GroupVersionKind
authorization.k8s.iov1SubjectRulesReviewStatus
+

SubjectRulesReviewStatus contains the result of a rules check. This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation. Because authorization rules are additive, if a rule appears in a list it's safe to assume the subject has that permission, even if that list is incomplete.

+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + + + +
FieldDescription
evaluationError
string
EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn't support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete.
incomplete
boolean
Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn't support rules evaluation.
nonResourceRules
NonResourceRule array
NonResourceRules is the list of actions the subject is allowed to perform on non-resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
resourceRules
ResourceRule array
ResourceRules is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
+

SupplementalGroupsStrategyOptions v1beta1 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

+
Appears In: + +
+ + + + + + +
FieldDescription
name
string
Name of a property to set
value
string
Value of a property to set
+

TCPSocketAction v1 core

+ + + + + +
GroupVersionKind
corev1TCPSocketAction
+

TCPSocketAction describes an action based on opening a socket

+
Appears In: + +
+ + + + + + +
FieldDescription
host
string
Optional: Host name to connect to, defaults to the pod IP.
portNumber or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
+

Taint v1 core

+ + + + + +
GroupVersionKind
corev1Taint
+

The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.

+
Appears In: + +
+ + + + + + + + +
FieldDescription
effect
string
Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
key
string
Required. The taint key to be applied to a node.
timeAdded
Time
TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.
value
string
Required. The taint value corresponding to the taint key.
+

Time v1 meta

+ + + + + +
GroupVersionKind
metav1Time
+

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+ + + + + +
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>.

+
Appears In: + +
+ + + + + + + + + +
FieldDescription
effect
string
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
key
string
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
operator
string
Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
tolerationSeconds
integer
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
value
string
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
+

TopologySelectorLabelRequirement v1 core

+ + + + + +
GroupVersionKind
corev1TopologySelectorLabelRequirement
+

A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future.

+
Appears In: + +
+ + + + + + +
FieldDescription
key
string
The label key that the selector applies to.
values
string array
An array of string values. One value must match the label to be selected. Each entry in Values is ORed.
+

TopologySelectorTerm v1 core

+ + + + + +
GroupVersionKind
corev1TopologySelectorTerm
+

A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.

+ + + + + + +
FieldDescription
matchLabelExpressions
TopologySelectorLabelRequirement array
A list of topology selector requirements by labels.
+

TypedLocalObjectReference v1 core

+ + + + + +
GroupVersionKind
corev1TypedLocalObjectReference
+

TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.

+ + + + + + + + +
FieldDescription
apiGroup
string
APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
kind
string
Kind is the type of resource being referenced
name
string
Name is the name of resource being referenced
+

UserInfo v1 authentication.k8s.io

+ + + + + +
GroupVersionKind
authentication.k8s.iov1UserInfo
+

UserInfo holds the information about the user needed to implement the user.Info interface.

+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + + + +
FieldDescription
extra
object
Any additional information provided by the authenticator.
groups
string array
The names of groups this user is a part of.
uid
string
A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs.
username
string
The name that uniquely identifies this user among all active users.
+

VolumeAttachmentSource v1beta1 storage.k8s.io

+ + + + + +
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.

+
Other API versions of this object exist: +v1alpha1 +
+ + + + + + +
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.

+
Appears In: + +
+ + + + + + +
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.k8s.io

+ + + + + +
GroupVersionKind
storage.k8s.iov1beta1VolumeError
+

VolumeError captures an error encountered during a volume operation.

+
Other API versions of this object exist: +v1alpha1 +
+ + + + + + + +
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, MountPropagationNone is used. This field is beta in 1.10.
name
string
This must match the Name of a Volume.
readOnly
boolean
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
subPath
string
Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
+

VolumeNodeAffinity v1 core

+ + + + + +
GroupVersionKind
corev1VolumeNodeAffinity
+

VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.

+
Appears In: + +
+ + + + + +
FieldDescription
required
NodeSelector
Required specifies hard node constraints that must be met.
+

VolumeProjection v1 core

+ + + + + +
GroupVersionKind
corev1VolumeProjection
+

Projection that may be projected along with other supported volume types

+
Appears In: + +
+ + + + + + + + +
FieldDescription
configMap
ConfigMapProjection
information about the configMap data to project
downwardAPI
DownwardAPIProjection
information about the downwardAPI data to project
secret
SecretProjection
information about the secret data to project
serviceAccountToken
ServiceAccountTokenProjection
information about the serviceAccountToken data to project
+

VsphereVirtualDiskVolumeSource v1 core

+ + + + + +
GroupVersionKind
corev1VsphereVirtualDiskVolumeSource
+

Represents a vSphere volume resource.

+ + + + + + + + + +
FieldDescription
fsType
string
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
storagePolicyID
string
Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
storagePolicyName
string
Storage Policy Based Management (SPBM) profile name.
volumePath
string
Path that identifies vSphere volume vmdk
+

WatchEvent v1 meta

+ + + + + +
GroupVersionKind
metav1WatchEvent
+

Event represents a single event to a watched resource.

+ + + + + + +
FieldDescription
objectObject is: * If Type is Added or Modified: the new state of the object. * If Type is Deleted: the state of the object immediately before deletion. * If Type is Error: *Status is recommended; other types may make sense depending on context.
type
string
+

Webhook v1beta1 admissionregistration.k8s.io

+ + + + + +
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.
sideEffects
string
SideEffects states whether this webhookk has side effects. Acceptable values are: Unknown, None, Some, NoneOnDryRun Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission change and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. Defaults to Unknown.
+

WebhookClientConfig v1beta1 admissionregistration.k8s.io

+ + + + + +
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://". 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
+
Other API versions of this object exist: +v1 +
+ + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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 strategy: merge
patch merge key: type
Current service state of apiService.
+

APIServiceList v1beta1 apiregistration

+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

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
202
APIService
Accepted
200
APIService
OK
201
APIService
Created
+

Patch

+

partially update the specified APIService

+

HTTP Request

+PATCH /apis/apiregistration.k8s.io/v1beta1/apiservices/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
APIService
OK
+

Replace

+

replace the specified APIService

+

HTTP Request

+PUT /apis/apiregistration.k8s.io/v1beta1/apiservices/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
APIService
+

Response

+ + + + + + +
CodeDescription
201
APIService
Created
200
APIService
OK
+

Delete

+

delete an APIService

+

HTTP Request

+DELETE /apis/apiregistration.k8s.io/v1beta1/apiservices/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
202
Status
Accepted
200
Status
OK
+

Delete Collection

+

delete collection of APIService

+

HTTP Request

+DELETE /apis/apiregistration.k8s.io/v1beta1/apiservices +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified APIService

+

HTTP Request

+GET /apis/apiregistration.k8s.io/v1beta1/apiservices/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

watch changes to an object of kind APIService. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/apiregistration.k8s.io/v1beta1/watch/apiservices/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of APIService. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/apiregistration.k8s.io/v1beta1/watch/apiservices +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

Patch Status

+

partially update status of the specified APIService

+

HTTP Request

+PATCH /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}/status +

Path Parameters

+ + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
APIService
OK
+

Read Status

+

read status of the specified APIService

+

HTTP Request

+GET /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}/status +

Path Parameters

+ + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
APIService
OK
+

Replace Status

+

replace status of the specified APIService

+

HTTP Request

+PUT /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}/status +

Path Parameters

+ + + + + +
ParameterDescription
namename of the APIService
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
APIService
+

Response

+ + + + + + +
CodeDescription
200
APIService
OK
201
APIService
Created
+

APIServiceCondition v1beta1 apiregistration.k8s.io

+ + + + + +
GroupVersionKind
apiregistration.k8s.iov1beta1APIServiceCondition
+
Other API versions of this object exist: +v1 +
+ + + + + + + + + + +
FieldDescription
lastTransitionTime
Time
Last time the condition transitioned from one status to another.
message
string
Human-readable message indicating details about last transition.
reason
string
Unique, one-word, CamelCase reason for the condition's last transition.
status
string
Status is the status of the condition. Can be True, False, Unknown.
type
string
Type is the type of the condition.
+

AggregationRule v1beta1 rbac.authorization.k8s.io

+ + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1beta1AggregationRule
+
Other API versions of this object exist: +v1 +v1alpha1 +
+
Appears In: + +
+ + + + + +
FieldDescription
clusterRoleSelectors
LabelSelector array
ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added
+

AggregationRule v1alpha1 rbac.authorization.k8s.io

+ + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1alpha1AggregationRule
+
Other API versions of this object exist: +v1 +v1beta1 +
+
Appears In: + +
+ + + + + +
FieldDescription
clusterRoleSelectors
LabelSelector array
ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added
+

AllowedFlexVolume v1beta1 policy

+ + + + + +
GroupVersionKind
policyv1beta1AllowedFlexVolume
+ + + + + + +
FieldDescription
driver
string
driver is the name of the Flexvolume driver.
+

AllowedHostPath v1beta1 policy

+ + + + + +
GroupVersionKind
policyv1beta1AllowedHostPath
+ + + + + + + +
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
+
Other API versions of this object exist: +v1 +v1alpha1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
aggregationRule
AggregationRule
AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a ClusterRole

+

HTTP Request

+POST /apis/rbac.authorization.k8s.io/v1beta1/clusterroles +

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
ClusterRole
+

Response

+ + + + + + + +
CodeDescription
200
ClusterRole
OK
201
ClusterRole
Created
202
ClusterRole
Accepted
+

Patch

+

partially update the specified ClusterRole

+

HTTP Request

+PATCH /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
ClusterRole
OK
+

Replace

+

replace the specified ClusterRole

+

HTTP Request

+PUT /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
ClusterRole
+

Response

+ + + + + + +
CodeDescription
201
ClusterRole
Created
200
ClusterRole
OK
+

Delete

+

delete a ClusterRole

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of ClusterRole

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterroles +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified ClusterRole

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
ClusterRole
OK
+

List

+

list or watch objects of kind ClusterRole

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1beta1/clusterroles +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

watch changes to an object of kind ClusterRole. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterroles/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of ClusterRole. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterroles +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Other API versions of this object exist: +v1 +v1beta1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
aggregationRule
AggregationRule
AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a ClusterRole

+

HTTP Request

+POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles +

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
ClusterRole
+

Response

+ + + + + + + +
CodeDescription
200
ClusterRole
OK
201
ClusterRole
Created
202
ClusterRole
Accepted
+

Patch

+

partially update the specified ClusterRole

+

HTTP Request

+PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
ClusterRole
OK
+

Replace

+

replace the specified ClusterRole

+

HTTP Request

+PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
ClusterRole
+

Response

+ + + + + + +
CodeDescription
200
ClusterRole
OK
201
ClusterRole
Created
+

Delete

+

delete a ClusterRole

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of ClusterRole

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified ClusterRole

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
ClusterRole
OK
+

List

+

list or watch objects of kind ClusterRole

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

watch changes to an object of kind ClusterRole. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRole
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of ClusterRole. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Other API versions of this object exist: +v1 +v1alpha1 +
+ + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a ClusterRoleBinding

+

HTTP Request

+POST /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings +

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
ClusterRoleBinding
+

Response

+ + + + + + + +
CodeDescription
200
ClusterRoleBinding
OK
201
ClusterRoleBinding
Created
202
ClusterRoleBinding
Accepted
+

Patch

+

partially update the specified ClusterRoleBinding

+

HTTP Request

+PATCH /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
ClusterRoleBinding
OK
+

Replace

+

replace the specified ClusterRoleBinding

+

HTTP Request

+PUT /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
ClusterRoleBinding
+

Response

+ + + + + + +
CodeDescription
200
ClusterRoleBinding
OK
201
ClusterRoleBinding
Created
+

Delete

+

delete a ClusterRoleBinding

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of ClusterRoleBinding

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified ClusterRoleBinding

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
ClusterRoleBinding
OK
+

List

+

list or watch objects of kind ClusterRoleBinding

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

watch changes to an object of kind ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterrolebindings/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterrolebindings +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Other API versions of this object exist: +v1 +v1beta1 +
+ + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a ClusterRoleBinding

+

HTTP Request

+POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings +

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
ClusterRoleBinding
+

Response

+ + + + + + + +
CodeDescription
200
ClusterRoleBinding
OK
201
ClusterRoleBinding
Created
202
ClusterRoleBinding
Accepted
+

Patch

+

partially update the specified ClusterRoleBinding

+

HTTP Request

+PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
ClusterRoleBinding
OK
+

Replace

+

replace the specified ClusterRoleBinding

+

HTTP Request

+PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
ClusterRoleBinding
+

Response

+ + + + + + +
CodeDescription
200
ClusterRoleBinding
OK
201
ClusterRoleBinding
Created
+

Delete

+

delete a ClusterRoleBinding

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of ClusterRoleBinding

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified ClusterRoleBinding

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
ClusterRoleBinding
OK
+

List

+

list or watch objects of kind ClusterRoleBinding

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

watch changes to an object of kind ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the ClusterRoleBinding
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Other API versions of this object exist: +v1 +v1beta1 +
+ + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

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

+

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

+

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

+

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.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of ControllerRevision

+

HTTP Request

+DELETE /apis/apps/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/apps/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Other API versions of this object exist: +v1 +v1beta2 +
+ + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

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
200
ControllerRevision
OK
201
ControllerRevision
Created
202
ControllerRevision
Accepted
+

Patch

+

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

+

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
201
ControllerRevision
Created
200
ControllerRevision
OK
+

Delete

+

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.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of ControllerRevision

+

HTTP Request

+DELETE /apis/apps/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/apps/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Other API versions of this object exist: +v1beta1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + + + + + + + +
FieldDescription
concurrencyPolicy
string
Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one
failedJobsHistoryLimit
integer
The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.
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

+
Appears In: + +
+ + + + + + +
FieldDescription
active
ObjectReference array
A list of pointers to currently running jobs.
lastScheduleTime
Time
Information when was the last time the job was successfully scheduled.
+

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

+

Create

+

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

+

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

+

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

+

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.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of CronJob

+

HTTP Request

+DELETE /apis/batch/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind CronJob. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/batch/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

Patch Status

+

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

+

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

+

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
201
CronJob
Created
200
CronJob
OK
+

CrossVersionObjectReference v2beta2 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta2CrossVersionObjectReference
+
Other API versions of this object exist: +v1 +v2beta1 +
+ + + + + + + + +
FieldDescription
apiVersion
string
API version of the referent
kind
string
Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"
name
string
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
+

CrossVersionObjectReference v2beta1 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta1CrossVersionObjectReference
+
Other API versions of this object exist: +v1 +v2beta2 +
+ + + + + + + + +
FieldDescription
apiVersion
string
API version of the referent
kind
string
Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"
name
string
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
+

DaemonSet v1beta2 apps

+ + + + + +
GroupVersionKind
appsv1beta2DaemonSet
+
Other API versions of this object exist: +v1 +v1beta1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + + + + + +
FieldDescription
minReadySeconds
integer
The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready).
revisionHistoryLimit
integer
The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
selector
LabelSelector
A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
template
PodTemplateSpec
An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
updateStrategy
DaemonSetUpdateStrategy
An update strategy to replace existing DaemonSet pods with new pods.
+

DaemonSetStatus v1beta2 apps

+
Appears In: + +
+ + + + + + + + + + + + + + +
FieldDescription
collisionCount
integer
Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
conditions
DaemonSetCondition array
patch strategy: merge
patch merge key: type
Represents the latest available observations of a DaemonSet's current state.
currentNumberScheduled
integer
The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
desiredNumberScheduled
integer
The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
numberAvailable
integer
The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds)
numberMisscheduled
integer
The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
numberReady
integer
The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
numberUnavailable
integer
The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds)
observedGeneration
integer
The most recent generation observed by the daemon set controller.
updatedNumberScheduled
integer
The total number of nodes that are running updated daemon pod
+

DaemonSetList 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

+

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
200
DaemonSet
OK
201
DaemonSet
Created
202
DaemonSet
Accepted
+

Patch

+

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

+

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.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of DaemonSet

+

HTTP Request

+DELETE /apis/apps/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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
+
+

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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind DaemonSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/apps/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of DaemonSet. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of DaemonSet. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

Patch Status

+

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

+

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

+

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
+
Other API versions of this object exist: +v1 +v1beta2 +
+ + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + + + + + + +
FieldDescription
minReadySeconds
integer
The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready).
revisionHistoryLimit
integer
The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
selector
LabelSelector
A label query over pods that are managed by the daemon set. Must match in order to be controlled. 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

+
Appears In: + +
+ + + + + + + + + + + + + + +
FieldDescription
collisionCount
integer
Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
conditions
DaemonSetCondition array
patch strategy: merge
patch merge key: type
Represents the latest available observations of a DaemonSet's current state.
currentNumberScheduled
integer
The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
desiredNumberScheduled
integer
The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
numberAvailable
integer
The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds)
numberMisscheduled
integer
The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
numberReady
integer
The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
numberUnavailable
integer
The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds)
observedGeneration
integer
The most recent generation observed by the daemon set controller.
updatedNumberScheduled
integer
The total number of nodes that are running updated daemon pod
+

DaemonSetList 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

+

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

+

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

+

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.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of DaemonSet

+

HTTP Request

+DELETE /apis/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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
+
+

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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind DaemonSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of DaemonSet. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of DaemonSet. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

Patch Status

+

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

+

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

+

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
+
Other API versions of this object exist: +v1 +v1beta1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
lastTransitionTime
Time
Last time the condition transitioned from one status to another.
message
string
A human readable message indicating details about the transition.
reason
string
The reason for the condition's last transition.
status
string
Status of the condition, one of True, False, Unknown.
type
string
Type of DaemonSet condition.
+

DaemonSetCondition v1beta1 extensions

+ + + + + +
GroupVersionKind
extensionsv1beta1DaemonSetCondition
+
Other API versions of this object exist: +v1 +v1beta2 +
+ + + + + + + + + + +
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
+
Other API versions of this object exist: +v1 +v1beta1 +
+
Appears In: + +
+ + + + + + +
FieldDescription
rollingUpdate
RollingUpdateDaemonSet
Rolling update config params. Present only if type = "RollingUpdate".
type
string
Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate.
+

DaemonSetUpdateStrategy v1beta1 extensions

+ + + + + +
GroupVersionKind
extensionsv1beta1DaemonSetUpdateStrategy
+
Other API versions of this object exist: +v1 +v1beta2 +
+ + + + + + + +
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
+
Other API versions of this object exist: +v1 +v1beta1 +v1beta1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + + + + + + + + +
FieldDescription
minReadySeconds
integer
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
paused
boolean
Indicates that the deployment is paused.
progressDeadlineSeconds
integer
The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.
replicas
integer
Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
revisionHistoryLimit
integer
The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
selector
LabelSelector
Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels.
strategy
DeploymentStrategy
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

+
Appears In: + +
+ + + + + + + + + + + + +
FieldDescription
availableReplicas
integer
Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
collisionCount
integer
Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
conditions
DeploymentCondition array
patch strategy: merge
patch merge key: type
Represents the latest available observations of a deployment's current state.
observedGeneration
integer
The generation observed by the deployment controller.
readyReplicas
integer
Total number of ready pods targeted by this deployment.
replicas
integer
Total number of non-terminated pods targeted by this deployment (their labels match the selector).
unavailableReplicas
integer
Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
updatedReplicas
integer
Total number of non-terminated pods targeted by this deployment that have the desired template spec.
+

DeploymentList 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

+
Appears In: + +
+ + + + + + +
FieldDescription
rollingUpdate
RollingUpdateDeployment
Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.
type
string
Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
+

RollingUpdateDeployment 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

+

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
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/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
201
Deployment
Created
200
Deployment
OK
+

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.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of Deployment

+

HTTP Request

+DELETE /apis/apps/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

Patch Status

+

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

+

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

+

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
200
Deployment
OK
201
Deployment
Created
+

Misc Operations

+

Read Scale

+

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

+

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
200
Scale
OK
201
Scale
Created
+

Patch Scale

+

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
+
Other API versions of this object exist: +v1 +v1beta2 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + + + + + + + + + +
FieldDescription
minReadySeconds
integer
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
paused
boolean
Indicates that the deployment is paused.
progressDeadlineSeconds
integer
The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.
replicas
integer
Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
revisionHistoryLimit
integer
The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 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

+
Appears In: + +
+ + + + + + + + + + + + +
FieldDescription
availableReplicas
integer
Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
collisionCount
integer
Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
conditions
DeploymentCondition array
patch strategy: merge
patch merge key: type
Represents the latest available observations of a deployment's current state.
observedGeneration
integer
The generation observed by the deployment controller.
readyReplicas
integer
Total number of ready pods targeted by this deployment.
replicas
integer
Total number of non-terminated pods targeted by this deployment (their labels match the selector).
unavailableReplicas
integer
Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
updatedReplicas
integer
Total number of non-terminated pods targeted by this deployment that have the desired template spec.
+

DeploymentList 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

+
Appears In: + +
+ + + + + + +
FieldDescription
rollingUpdate
RollingUpdateDeployment
Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.
type
string
Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
+

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

+

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
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/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
201
Deployment
Created
200
Deployment
OK
+

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.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of Deployment

+

HTTP Request

+DELETE /apis/apps/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

Patch Status

+

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

+

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

+

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

+

Read Scale

+

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

+

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
200
Scale
OK
201
Scale
Created
+

Patch Scale

+

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

+

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
202
DeploymentStatus
Accepted
200
DeploymentStatus
OK
201
DeploymentStatus
Created
+

Deployment v1beta1 extensions

+ + + + + +
GroupVersionKind
extensionsv1beta1Deployment
+
Other API versions of this object exist: +v1 +v1beta2 +
+ + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + + + + + + + + + +
FieldDescription
minReadySeconds
integer
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
paused
boolean
Indicates that the deployment is paused 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 set to the max value of int32 (i.e. 2147483647) by default, which means "no deadline".
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 strategy: retainKeys
The deployment strategy to use to replace existing pods with new ones.
template
PodTemplateSpec
Template describes the pods that will be created.
+

DeploymentStatus v1beta1 extensions

+
Appears In: + +
+ + + + + + + + + + + + +
FieldDescription
availableReplicas
integer
Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
collisionCount
integer
Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
conditions
DeploymentCondition array
patch strategy: merge
patch merge key: type
Represents the latest available observations of a deployment's current state.
observedGeneration
integer
The generation observed by the deployment controller.
readyReplicas
integer
Total number of ready pods targeted by this deployment.
replicas
integer
Total number of non-terminated pods targeted by this deployment (their labels match the selector).
unavailableReplicas
integer
Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
updatedReplicas
integer
Total number of non-terminated pods targeted by this deployment that have the desired template spec.
+

DeploymentList 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

+

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.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of Deployment

+

HTTP Request

+DELETE /apis/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

Patch Status

+

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

+

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

+

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

+

Read Scale

+

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

+

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

+

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

+

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
200
DeploymentStatus
OK
201
DeploymentStatus
Created
202
DeploymentStatus
Accepted
+

DeploymentCondition v1beta2 apps

+ + + + + +
GroupVersionKind
appsv1beta2DeploymentCondition
+
Other API versions of this object exist: +v1 +v1beta1 +v1beta1 +
+
Appears In: + +
+ + + + + + + + + + +
FieldDescription
lastTransitionTime
Time
Last time the condition transitioned from one status to another.
lastUpdateTime
Time
The last time this condition was updated.
message
string
A human readable message indicating details about the transition.
reason
string
The reason for the condition's last transition.
status
string
Status of the condition, one of True, False, Unknown.
type
string
Type of deployment condition.
+

DeploymentCondition v1beta1 apps

+ + + + + +
GroupVersionKind
appsv1beta1DeploymentCondition
+
Other API versions of this object exist: +v1 +v1beta2 +
+
Appears In: + +
+ + + + + + + + + + +
FieldDescription
lastTransitionTime
Time
Last time the condition transitioned from one status to another.
lastUpdateTime
Time
The last time this condition was updated.
message
string
A human readable message indicating details about the transition.
reason
string
The reason for the condition's last transition.
status
string
Status of the condition, one of True, False, Unknown.
type
string
Type of deployment condition.
+

DeploymentCondition v1beta1 extensions

+ + + + + +
GroupVersionKind
extensionsv1beta1DeploymentCondition
+
Other API versions of this object exist: +v1 +v1beta2 +
+ + + + + + + + + + + +
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
+
Other API versions of this object exist: +v1 +
+
Appears In: + +
+ + + + + + + + + + + + + + + + + + + + + +
FieldDescription
action
string
What action was taken/failed regarding to the regarding object.
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create an Event

+

HTTP Request

+POST /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Event
+

Response

+ + + + + + + +
CodeDescription
200
Event
OK
201
Event
Created
202
Event
Accepted
+

Patch

+

partially update the specified Event

+

HTTP Request

+PATCH /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the Event
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
Event
OK
+

Replace

+

replace the specified Event

+

HTTP Request

+PUT /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the Event
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Event
+

Response

+ + + + + + +
CodeDescription
200
Event
OK
201
Event
Created
+

Delete

+

delete an Event

+

HTTP Request

+DELETE /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the Event
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
202
Status
Accepted
200
Status
OK
+

Delete Collection

+

delete collection of Event

+

HTTP Request

+DELETE /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified Event

+

HTTP Request

+GET /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the Event
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/events.k8s.io/v1beta1/watch/namespaces/{namespace}/events/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the Event
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/events.k8s.io/v1beta1/watch/namespaces/{namespace}/events +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/events.k8s.io/v1beta1/watch/events +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Other API versions of this object exist: +v1 +
+
Appears In: + +
+ + + + + + + +
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.
+

ExternalMetricSource v2beta1 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta1ExternalMetricSource
+
Other API versions of this object exist: +v2beta2 +
+ + + + + + + + + +
FieldDescription
metricName
string
metricName is the name of the metric in question.
metricSelector
LabelSelector
metricSelector is used to identify a specific time series within a given metric.
targetAverageValue
Quantity
targetAverageValue is the target per-pod value of global metric (as a quantity). Mutually exclusive with TargetValue.
targetValue
Quantity
targetValue is the target value of the metric (as a quantity). Mutually exclusive with TargetAverageValue.
+

ExternalMetricStatus v2beta1 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta1ExternalMetricStatus
+
Other API versions of this object exist: +v2beta2 +
+ + + + + + + + + +
FieldDescription
currentAverageValue
Quantity
currentAverageValue is the current value of metric averaged over autoscaled pods.
currentValue
Quantity
currentValue is the current value of the metric (as a quantity)
metricName
string
metricName is the name of a metric used for autoscaling in metric system.
metricSelector
LabelSelector
metricSelector is used to identify a specific time series within a given metric.
+

FSGroupStrategyOptions v1beta1 policy

+ + + + + +
GroupVersionKind
policyv1beta1FSGroupStrategyOptions
+ + + + + + + +
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 v2beta2 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta2HorizontalPodAutoscaler
+
Other API versions of this object exist: +v1 +v2beta1 +
+ + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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 v2beta2 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. If not set, the default metric will be set to 80% average CPU utilization.
minReplicas
integer
minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod.
scaleTargetRef
CrossVersionObjectReference
scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count.
+

HorizontalPodAutoscalerStatus v2beta2 autoscaling

+ + + + + + + + + + + +
FieldDescription
conditions
HorizontalPodAutoscalerCondition array
conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.
currentMetrics
MetricStatus array
currentMetrics is the last read state of the metrics used by this autoscaler.
currentReplicas
integer
currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.
desiredReplicas
integer
desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.
lastScaleTime
Time
lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed.
observedGeneration
integer
observedGeneration is the most recent generation observed by this autoscaler.
+

HorizontalPodAutoscalerList v2beta2 autoscaling

+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a HorizontalPodAutoscaler

+

HTTP Request

+POST /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
HorizontalPodAutoscaler
+

Response

+ + + + + + + +
CodeDescription
200
HorizontalPodAutoscaler
OK
201
HorizontalPodAutoscaler
Created
202
HorizontalPodAutoscaler
Accepted
+

Patch

+

partially update the specified HorizontalPodAutoscaler

+

HTTP Request

+PATCH /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
HorizontalPodAutoscaler
OK
+

Replace

+

replace the specified HorizontalPodAutoscaler

+

HTTP Request

+PUT /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
HorizontalPodAutoscaler
+

Response

+ + + + + + +
CodeDescription
200
HorizontalPodAutoscaler
OK
201
HorizontalPodAutoscaler
Created
+

Delete

+

delete a HorizontalPodAutoscaler

+

HTTP Request

+DELETE /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of HorizontalPodAutoscaler

+

HTTP Request

+DELETE /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified HorizontalPodAutoscaler

+

HTTP Request

+GET /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
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

+

list or watch objects of kind HorizontalPodAutoscaler

+

HTTP Request

+GET /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

list or watch objects of kind HorizontalPodAutoscaler

+

HTTP Request

+GET /apis/autoscaling/v2beta2/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/autoscaling/v2beta2/watch/namespaces/{namespace}/horizontalpodautoscalers/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/autoscaling/v2beta2/watch/namespaces/{namespace}/horizontalpodautoscalers +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/autoscaling/v2beta2/watch/horizontalpodautoscalers +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

Patch Status

+

partially update status of the specified HorizontalPodAutoscaler

+

HTTP Request

+PATCH /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
HorizontalPodAutoscaler
OK
+

Read Status

+

read status of the specified HorizontalPodAutoscaler

+

HTTP Request

+GET /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
HorizontalPodAutoscaler
OK
+

Replace Status

+

replace status of the specified HorizontalPodAutoscaler

+

HTTP Request

+PUT /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
HorizontalPodAutoscaler
+

Response

+ + + + + + +
CodeDescription
201
HorizontalPodAutoscaler
Created
200
HorizontalPodAutoscaler
OK
+

HorizontalPodAutoscaler v2beta1 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta1HorizontalPodAutoscaler
+
Other API versions of this object exist: +v1 +v2beta2 +
+ + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a HorizontalPodAutoscaler

+

HTTP Request

+POST /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
HorizontalPodAutoscaler
+

Response

+ + + + + + + +
CodeDescription
202
HorizontalPodAutoscaler
Accepted
200
HorizontalPodAutoscaler
OK
201
HorizontalPodAutoscaler
Created
+

Patch

+

partially update the specified HorizontalPodAutoscaler

+

HTTP Request

+PATCH /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
HorizontalPodAutoscaler
OK
+

Replace

+

replace the specified HorizontalPodAutoscaler

+

HTTP Request

+PUT /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
HorizontalPodAutoscaler
+

Response

+ + + + + + +
CodeDescription
200
HorizontalPodAutoscaler
OK
201
HorizontalPodAutoscaler
Created
+

Delete

+

delete a HorizontalPodAutoscaler

+

HTTP Request

+DELETE /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of HorizontalPodAutoscaler

+

HTTP Request

+DELETE /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified HorizontalPodAutoscaler

+

HTTP Request

+GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/autoscaling/v2beta1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/autoscaling/v2beta1/watch/namespaces/{namespace}/horizontalpodautoscalers +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/autoscaling/v2beta1/watch/horizontalpodautoscalers +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

Patch Status

+

partially update status of the specified HorizontalPodAutoscaler

+

HTTP Request

+PATCH /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
HorizontalPodAutoscaler
OK
+

Read Status

+

read status of the specified HorizontalPodAutoscaler

+

HTTP Request

+GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
HorizontalPodAutoscaler
OK
+

Replace Status

+

replace status of the specified HorizontalPodAutoscaler

+

HTTP Request

+PUT /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the HorizontalPodAutoscaler
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
HorizontalPodAutoscaler
+

Response

+ + + + + + +
CodeDescription
201
HorizontalPodAutoscaler
Created
200
HorizontalPodAutoscaler
OK
+

HorizontalPodAutoscalerCondition v2beta1 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta1HorizontalPodAutoscalerCondition
+
Other API versions of this object exist: +v2beta2 +
+ + + + + + + + + + +
FieldDescription
lastTransitionTime
Time
lastTransitionTime is the last time the condition transitioned from one status to another
message
string
message is a human-readable explanation containing details about the transition
reason
string
reason is the reason for the condition's last transition.
status
string
status is the status of the condition (True, False, Unknown)
type
string
type describes the current condition
+

HostPortRange v1beta1 policy

+ + + + + +
GroupVersionKind
policyv1beta1HostPortRange
+ + + + + + + +
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
+ + + + + + + +
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
+
Other API versions of this object exist: +v1 +
+ + + + + + + +
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
+
Other API versions of this object exist: +v1 +
+ + + + + + + +
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
+
Other API versions of this object exist: +v1beta1 +
+
Appears In: + +
+ + + + + + +
FieldDescription
metadata
ObjectMeta
Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/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
+
Other API versions of this object exist: +v1 +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a LocalSubjectAccessReview

+

HTTP Request

+POST /apis/authorization.k8s.io/v1beta1/namespaces/{namespace}/localsubjectaccessreviews +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
LocalSubjectAccessReview
+

Response

+ + + + + + + +
CodeDescription
200
LocalSubjectAccessReview
OK
201
LocalSubjectAccessReview
Created
202
LocalSubjectAccessReview
Accepted
+

MetricSpec v2beta1 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta1MetricSpec
+
Other API versions of this object exist: +v2beta2 +
+ + + + + + + + + + +
FieldDescription
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
+
Other API versions of this object exist: +v2beta2 +
+ + + + + + + + + + +
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.
+

NetworkPolicy v1beta1 extensions

+ + + + + +
GroupVersionKind
extensionsv1beta1NetworkPolicy
+
Other API versions of this object exist: +v1 +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

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
202
NetworkPolicy
Accepted
200
NetworkPolicy
OK
201
NetworkPolicy
Created
+

Patch

+

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

+

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

+

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.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
202
Status
Accepted
200
Status
OK
+

Delete Collection

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Other API versions of this object exist: +v1 +
+ + + + + + + +
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
+
Other API versions of this object exist: +v1 +
+ + + + + + + +
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
+
Other API versions of this object exist: +v1 +
+ + + + + + + + +
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
+
Other API versions of this object exist: +v1 +
+ + + + + + + +
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, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.
+

NonResourceAttributes v1beta1 authorization.k8s.io

+ + + + + +
GroupVersionKind
authorization.k8s.iov1beta1NonResourceAttributes
+
Other API versions of this object exist: +v1 +
+ + + + + + + +
FieldDescription
path
string
Path is the URL path of the request
verb
string
Verb is the standard HTTP verb
+

NonResourceRule v1beta1 authorization.k8s.io

+ + + + + +
GroupVersionKind
authorization.k8s.iov1beta1NonResourceRule
+
Other API versions of this object exist: +v1 +
+ + + + + + + +
FieldDescription
nonResourceURLs
string array
NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path. "*" means all.
verbs
string array
Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all.
+

ObjectMetricSource v2beta1 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta1ObjectMetricSource
+
Other API versions of this object exist: +v2beta2 +
+ + + + + + + + + + +
FieldDescription
averageValue
Quantity
averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
metricName
string
metricName is the name of the metric in question.
selector
LabelSelector
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset, just the metricName will be used to gather metrics.
target
CrossVersionObjectReference
target is the described Kubernetes object.
targetValue
Quantity
targetValue is the target value of the metric (as a quantity).
+

ObjectMetricStatus v2beta1 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta1ObjectMetricStatus
+
Other API versions of this object exist: +v2beta2 +
+ + + + + + + + + + +
FieldDescription
averageValue
Quantity
averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
currentValue
Quantity
currentValue is the current value of the metric (as a quantity).
metricName
string
metricName is the name of the metric in question.
selector
LabelSelector
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set in the ObjectMetricSource, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
target
CrossVersionObjectReference
target is the described Kubernetes object.
+

PodSecurityPolicy v1beta1 policy

+ + + + + +
GroupVersionKind
policyv1beta1PodSecurityPolicy
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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.
allowedProcMountTypes
string array
AllowedProcMountTypes is a whitelist of allowed ProcMountTypes. Empty or nil indicates that only the DefaultProcMountType may be used. This requires the ProcMountType feature flag to be enabled.
allowedUnsafeSysctls
string array
allowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed. Kubelet has to 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

+

Create

+

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
200
PodSecurityPolicy
OK
201
PodSecurityPolicy
Created
202
PodSecurityPolicy
Accepted
+

Patch

+

partially update the specified PodSecurityPolicy

+

HTTP Request

+PATCH /apis/policy/v1beta1/podsecuritypolicies/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the PodSecurityPolicy
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
PodSecurityPolicy
OK
+

Replace

+

replace the specified PodSecurityPolicy

+

HTTP Request

+PUT /apis/policy/v1beta1/podsecuritypolicies/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the PodSecurityPolicy
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
PodSecurityPolicy
+

Response

+ + + + + + +
CodeDescription
200
PodSecurityPolicy
OK
201
PodSecurityPolicy
Created
+

Delete

+

delete a PodSecurityPolicy

+

HTTP Request

+DELETE /apis/policy/v1beta1/podsecuritypolicies/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the PodSecurityPolicy
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
202
Status
Accepted
200
Status
OK
+

Delete Collection

+

delete collection of PodSecurityPolicy

+

HTTP Request

+DELETE /apis/policy/v1beta1/podsecuritypolicies +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified PodSecurityPolicy

+

HTTP Request

+GET /apis/policy/v1beta1/podsecuritypolicies/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the PodSecurityPolicy
+

Query Parameters

+ + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

watch changes to an object of kind PodSecurityPolicy. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/policy/v1beta1/watch/podsecuritypolicies/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the PodSecurityPolicy
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of PodSecurityPolicy. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/policy/v1beta1/watch/podsecuritypolicies +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+

PodsMetricSource v2beta1 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta1PodsMetricSource
+
Other API versions of this object exist: +v2beta2 +
+ + + + + + + + +
FieldDescription
metricName
string
metricName is the name of the metric in question
selector
LabelSelector
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset, just the metricName will be used to gather metrics.
targetAverageValue
Quantity
targetAverageValue is the target value of the average of the metric across all relevant pods (as a quantity)
+

PodsMetricStatus v2beta1 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta1PodsMetricStatus
+
Other API versions of this object exist: +v2beta2 +
+ + + + + + + + +
FieldDescription
currentAverageValue
Quantity
currentAverageValue is the current value of the average of the metric across all relevant pods (as a quantity)
metricName
string
metricName is the name of the metric in question
selector
LabelSelector
selector is the string-encoded form of a standard kubernetes label selector for the given metric When set in the PodsMetricSource, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics.
+

PolicyRule v1beta1 rbac.authorization.k8s.io

+ + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1beta1PolicyRule
+
Other API versions of this object exist: +v1 +v1alpha1 +
+ + + + + + + + + + +
FieldDescription
apiGroups
string array
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
nonResourceURLs
string array
NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.
resourceNames
string array
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
resources
string array
Resources is a list of resources this rule applies to. '\*' represents all resources in the specified apiGroups. '\*/foo' represents the subresource 'foo' for all resources in the specified apiGroups.
verbs
string array
Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
+

PolicyRule v1alpha1 rbac.authorization.k8s.io

+ + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1alpha1PolicyRule
+
Other API versions of this object exist: +v1 +v1beta1 +
+ + + + + + + + + + +
FieldDescription
apiGroups
string array
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.
nonResourceURLs
string array
NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path 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
+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

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

+

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

+

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
201
PriorityClass
Created
200
PriorityClass
OK
+

Delete

+

delete a PriorityClass

+

HTTP Request

+DELETE /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of PriorityClass

+

HTTP Request

+DELETE /apis/scheduling.k8s.io/v1alpha1/priorityclasses +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified PriorityClass

+

HTTP Request

+GET /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

watch changes to an object of kind PriorityClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/scheduling.k8s.io/v1alpha1/watch/priorityclasses/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the PriorityClass
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of PriorityClass. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/scheduling.k8s.io/v1alpha1/watch/priorityclasses +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Other API versions of this object exist: +v1 +v1beta1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + + + + +
FieldDescription
minReadySeconds
integer
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
replicas
integer
Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
selector
LabelSelector
Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
template
PodTemplateSpec
Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
+

ReplicaSetStatus v1beta2 apps

+
Appears In: + +
+ + + + + + + + + + +
FieldDescription
availableReplicas
integer
The number of available replicas (ready for at least minReadySeconds) for this replica set.
conditions
ReplicaSetCondition array
patch strategy: merge
patch merge key: type
Represents the latest available observations of a replica set's current state.
fullyLabeledReplicas
integer
The number of pods that have labels matching the labels of the pod template of the replicaset.
observedGeneration
integer
ObservedGeneration reflects the generation of the most recently observed ReplicaSet.
readyReplicas
integer
The number of ready replicas for this replica set.
replicas
integer
Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
+

ReplicaSetList 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

+

Create

+

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

+

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

+

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

+

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.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of ReplicaSet

+

HTTP Request

+DELETE /apis/apps/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/apps/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

Patch Status

+

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

+

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

+

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

+

Read Scale

+

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

+

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
201
Scale
Created
200
Scale
OK
+

Patch Scale

+

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
+
Other API versions of this object exist: +v1 +v1beta2 +
+ + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + + + + +
FieldDescription
minReadySeconds
integer
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)
replicas
integer
Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
selector
LabelSelector
Selector is a label query over pods that should match the replica count. 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

+
Appears In: + +
+ + + + + + + + + + +
FieldDescription
availableReplicas
integer
The number of available replicas (ready for at least minReadySeconds) for this replica set.
conditions
ReplicaSetCondition array
patch strategy: merge
patch merge key: type
Represents the latest available observations of a replica set's current state.
fullyLabeledReplicas
integer
The number of pods that have labels matching the labels of the pod template of the replicaset.
observedGeneration
integer
ObservedGeneration reflects the generation of the most recently observed ReplicaSet.
readyReplicas
integer
The number of ready replicas for this replica set.
replicas
integer
Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
+

ReplicaSetList 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

+

Create

+

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
200
ReplicaSet
OK
201
ReplicaSet
Created
202
ReplicaSet
Accepted
+

Patch

+

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

+

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

+

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.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of ReplicaSet

+

HTTP Request

+DELETE /apis/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

Patch Status

+

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

+

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

+

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

+

Read Scale

+

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

+

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

+

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
+
Other API versions of this object exist: +v1 +v1beta1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
lastTransitionTime
Time
The last time the condition transitioned from one status to another.
message
string
A human readable message indicating details about the transition.
reason
string
The reason for the condition's last transition.
status
string
Status of the condition, one of True, False, Unknown.
type
string
Type of replica set condition.
+

ReplicaSetCondition v1beta1 extensions

+ + + + + +
GroupVersionKind
extensionsv1beta1ReplicaSetCondition
+
Other API versions of this object exist: +v1 +v1beta2 +
+ + + + + + + + + + +
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
+
Other API versions of this object exist: +v1 +
+ + + + + + + + + + + + +
FieldDescription
group
string
Group is the API Group of the Resource. "*" means all.
name
string
Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.
namespace
string
Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview
resource
string
Resource is one of the existing resource types. "*" means all.
subresource
string
Subresource is one of the existing resource types. "" means none.
verb
string
Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all.
version
string
Version is the API Version of the Resource. "*" means all.
+

ResourceMetricSource v2beta1 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta1ResourceMetricSource
+
Other API versions of this object exist: +v2beta2 +
+ + + + + + + + +
FieldDescription
name
string
name is the name of the resource in question.
targetAverageUtilization
integer
targetAverageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
targetAverageValue
Quantity
targetAverageValue is the target value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type.
+

ResourceMetricStatus v2beta1 autoscaling

+ + + + + +
GroupVersionKind
autoscalingv2beta1ResourceMetricStatus
+
Other API versions of this object exist: +v2beta2 +
+ + + + + + + + +
FieldDescription
currentAverageUtilization
integer
currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. It will only be present if `targetAverageValue` was set in the corresponding metric specification.
currentAverageValue
Quantity
currentAverageValue is the current value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. It will always be set, regardless of the corresponding metric specification.
name
string
name is the name of the resource in question.
+

ResourceRule v1beta1 authorization.k8s.io

+ + + + + +
GroupVersionKind
authorization.k8s.iov1beta1ResourceRule
+
Other API versions of this object exist: +v1 +
+ + + + + + + + + +
FieldDescription
apiGroups
string array
APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "*" means all.
resourceNames
string array
ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all.
resources
string array
Resources is a list of resources this rule applies to. "*" means all in the specified apiGroups. "*/foo" represents the subresource 'foo' for all resources in the specified apiGroups.
verbs
string array
Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all.
+

Role v1beta1 rbac.authorization.k8s.io

+ + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1beta1Role
+
Other API versions of this object exist: +v1 +v1alpha1 +
+
Appears In: + +
+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a Role

+

HTTP Request

+POST /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Role
+

Response

+ + + + + + + +
CodeDescription
202
Role
Accepted
200
Role
OK
201
Role
Created
+

Patch

+

partially update the specified Role

+

HTTP Request

+PATCH /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
Role
OK
+

Replace

+

replace the specified Role

+

HTTP Request

+PUT /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Role
+

Response

+ + + + + + +
CodeDescription
200
Role
OK
201
Role
Created
+

Delete

+

delete a Role

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of Role

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified Role

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
Role
OK
+

List

+

list or watch objects of kind Role

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind Role. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/roles/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/roles +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/roles +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Other API versions of this object exist: +v1 +v1beta1 +
+
Appears In: + +
+ + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a Role

+

HTTP Request

+POST /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Role
+

Response

+ + + + + + + +
CodeDescription
200
Role
OK
201
Role
Created
202
Role
Accepted
+

Patch

+

partially update the specified Role

+

HTTP Request

+PATCH /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
Role
OK
+

Replace

+

replace the specified Role

+

HTTP Request

+PUT /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Role
+

Response

+ + + + + + +
CodeDescription
200
Role
OK
201
Role
Created
+

Delete

+

delete a Role

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of Role

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified Role

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
Role
OK
+

List

+

list or watch objects of kind Role

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind Role. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the Role
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/roles +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Other API versions of this object exist: +v1 +v1alpha1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a RoleBinding

+

HTTP Request

+POST /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
RoleBinding
+

Response

+ + + + + + + +
CodeDescription
201
RoleBinding
Created
202
RoleBinding
Accepted
200
RoleBinding
OK
+

Patch

+

partially update the specified RoleBinding

+

HTTP Request

+PATCH /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
RoleBinding
OK
+

Replace

+

replace the specified RoleBinding

+

HTTP Request

+PUT /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
RoleBinding
+

Response

+ + + + + + +
CodeDescription
200
RoleBinding
OK
201
RoleBinding
Created
+

Delete

+

delete a RoleBinding

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
202
Status
Accepted
200
Status
OK
+

Delete Collection

+

delete collection of RoleBinding

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified RoleBinding

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
RoleBinding
OK
+

List

+

list or watch objects of kind RoleBinding

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind RoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1beta1/watch/rolebindings +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Other API versions of this object exist: +v1 +v1beta1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

create a RoleBinding

+

HTTP Request

+POST /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
RoleBinding
+

Response

+ + + + + + + +
CodeDescription
200
RoleBinding
OK
201
RoleBinding
Created
202
RoleBinding
Accepted
+

Patch

+

partially update the specified RoleBinding

+

HTTP Request

+PATCH /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
RoleBinding
OK
+

Replace

+

replace the specified RoleBinding

+

HTTP Request

+PUT /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
RoleBinding
+

Response

+ + + + + + +
CodeDescription
200
RoleBinding
OK
201
RoleBinding
Created
+

Delete

+

delete a RoleBinding

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of RoleBinding

+

HTTP Request

+DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified RoleBinding

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + +
CodeDescription
200
RoleBinding
OK
+

List

+

list or watch objects of kind RoleBinding

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind RoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings/{name} +

Path Parameters

+ + + + + + +
ParameterDescription
namename of the RoleBinding
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings +

Path Parameters

+ + + + + +
ParameterDescription
namespaceobject name and auth scope, such as for teams and projects
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/rolebindings +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Other API versions of this object exist: +v1 +v1alpha1 +
+ + + + + + + + +
FieldDescription
apiGroup
string
APIGroup is the group for the resource being referenced
kind
string
Kind is the type of resource being referenced
name
string
Name is the name of resource being referenced
+

RoleRef v1alpha1 rbac.authorization.k8s.io

+ + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1alpha1RoleRef
+
Other API versions of this object exist: +v1 +v1beta1 +
+ + + + + + + + +
FieldDescription
apiGroup
string
APIGroup is the group for the resource being referenced
kind
string
Kind is the type of resource being referenced
name
string
Name is the name of resource being referenced
+

RollbackConfig v1beta1 extensions

+ + + + + +
GroupVersionKind
extensionsv1beta1RollbackConfig
+ + + + + + +
FieldDescription
revision
integer
The revision to rollback to. If set to 0, rollback to the last revision.
+

RollingUpdateStatefulSetStrategy v1beta2 apps

+ + + + + +
GroupVersionKind
appsv1beta2RollingUpdateStatefulSetStrategy
+
Other API versions of this object exist: +v1 +v1beta1 +
+ + + + + + +
FieldDescription
partition
integer
Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0.
+

RollingUpdateStatefulSetStrategy v1beta1 apps

+ + + + + +
GroupVersionKind
appsv1beta1RollingUpdateStatefulSetStrategy
+
Other API versions of this object exist: +v1 +v1beta2 +
+ + + + + + +
FieldDescription
partition
integer
Partition indicates the ordinal at which the StatefulSet should be partitioned.
+

RunAsUserStrategyOptions v1beta1 policy

+ + + + + +
GroupVersionKind
policyv1beta1RunAsUserStrategyOptions
+ + + + + + + +
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
+ + + + + + + +
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
+
Other API versions of this object exist: +v1 +v1beta1 +v1beta1 +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + +
FieldDescription
replicas
integer
desired number of instances for the scaled object.
+

ScaleStatus v1beta2 apps

+
Appears In: + +
+ + + + + + + +
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
+
Other API versions of this object exist: +v1 +v1beta2 +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + +
FieldDescription
replicas
integer
desired number of instances for the scaled object.
+

ScaleStatus v1beta1 apps

+
Appears In: + +
+ + + + + + + +
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
+
Other API versions of this object exist: +v1 +v1beta2 +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + +
FieldDescription
replicas
integer
desired number of instances for the scaled object.
+

ScaleStatus v1beta1 extensions

+
Appears In: + +
+ + + + + + + +
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
+
Other API versions of this object exist: +v1 +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

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
200
SelfSubjectAccessReview
OK
201
SelfSubjectAccessReview
Created
202
SelfSubjectAccessReview
Accepted
+

SelfSubjectRulesReview v1beta1 authorization.k8s.io

+ + + + + +
GroupVersionKind
authorization.k8s.iov1beta1SelfSubjectRulesReview
+
Other API versions of this object exist: +v1 +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

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
200
SelfSubjectRulesReview
OK
201
SelfSubjectRulesReview
Created
202
SelfSubjectRulesReview
Accepted
+

ServiceReference v1beta1 admissionregistration.k8s.io

+ + + + + +
GroupVersionKind
admissionregistration.k8s.iov1beta1ServiceReference
+
Other API versions of this object exist: +v1 +
+ + + + + + + + +
FieldDescription
name
string
`name` is the name of the service. Required
namespace
string
`namespace` is the namespace of the service. Required
path
string
`path` is an optional URL path which will be sent in any request to this service.
+

ServiceReference v1beta1 apiregistration.k8s.io

+ + + + + +
GroupVersionKind
apiregistration.k8s.iov1beta1ServiceReference
+
Other API versions of this object exist: +v1 +
+ + + + + + + +
FieldDescription
name
string
Name is the name of the service
namespace
string
Namespace is the namespace of the service
+

StatefulSet v1beta2 apps

+ + + + + +
GroupVersionKind
appsv1beta2StatefulSet
+
Other API versions of this object exist: +v1 +v1beta1 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + + + + + + + + +
FieldDescription
podManagementPolicy
string
podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
replicas
integer
replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
revisionHistoryLimit
integer
revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
selector
LabelSelector
selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
serviceName
string
serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
template
PodTemplateSpec
template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
updateStrategy
StatefulSetUpdateStrategy
updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
volumeClaimTemplates
PersistentVolumeClaim array
volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
+

StatefulSetStatus v1beta2 apps

+
Appears In: + +
+ + + + + + + + + + + + + +
FieldDescription
collisionCount
integer
collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
conditions
StatefulSetCondition array
patch strategy: merge
patch merge key: type
Represents the latest available observations of a statefulset's current state.
currentReplicas
integer
currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.
currentRevision
string
currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
observedGeneration
integer
observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server.
readyReplicas
integer
readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
replicas
integer
replicas is the number of Pods created by the StatefulSet controller.
updateRevision
string
updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
updatedReplicas
integer
updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.
+

StatefulSetList 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

+

Create

+

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
201
StatefulSet
Created
202
StatefulSet
Accepted
200
StatefulSet
OK
+

Patch

+

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

+

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

+

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.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of StatefulSet

+

HTTP Request

+DELETE /apis/apps/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind StatefulSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/apps/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of StatefulSet. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of StatefulSet. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

Patch Status

+

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

+

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

+

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

+

Read Scale

+

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

+

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
201
Scale
Created
200
Scale
OK
+

Patch Scale

+

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
+
Other API versions of this object exist: +v1 +v1beta2 +
+
Appears In: + +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+
Appears In: + +
+ + + + + + + + + + + + +
FieldDescription
podManagementPolicy
string
podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
replicas
integer
replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
revisionHistoryLimit
integer
revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
selector
LabelSelector
selector is a label query over pods that should match the replica count. 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

+
Appears In: + +
+ + + + + + + + + + + + + +
FieldDescription
collisionCount
integer
collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
conditions
StatefulSetCondition array
patch strategy: merge
patch merge key: type
Represents the latest available observations of a statefulset's current state.
currentReplicas
integer
currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.
currentRevision
string
currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
observedGeneration
integer
observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server.
readyReplicas
integer
readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition.
replicas
integer
replicas is the number of Pods created by the StatefulSet controller.
updateRevision
string
updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
updatedReplicas
integer
updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.
+

StatefulSetList 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

+

Create

+

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

+

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

+

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

+

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.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of StatefulSet

+

HTTP Request

+DELETE /apis/apps/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch changes to an object of kind StatefulSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/apps/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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of StatefulSet. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of StatefulSet. deprecated: use the 'watch' parameter with a list operation instead.

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

Patch Status

+

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

+

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

+

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

+

Read Scale

+

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

+

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

+

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
+
Other API versions of this object exist: +v1 +v1beta1 +
+ + + + + + + + + + +
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
+
Other API versions of this object exist: +v1 +v1beta2 +
+ + + + + + + + + + +
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
+
Other API versions of this object exist: +v1 +v1beta1 +
+
Appears In: + +
+ + + + + + +
FieldDescription
rollingUpdate
RollingUpdateStatefulSetStrategy
RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.
type
string
Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.
+

StatefulSetUpdateStrategy v1beta1 apps

+ + + + + +
GroupVersionKind
appsv1beta1StatefulSetUpdateStrategy
+
Other API versions of this object exist: +v1 +v1beta2 +
+
Appears In: + +
+ + + + + + +
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
+
Other API versions of this object exist: +v1 +
+ + + + + + + + + + + + + + + +
FieldDescription
allowVolumeExpansion
boolean
AllowVolumeExpansion shows whether the storage class allow volume expand
allowedTopologies
TopologySelectorTerm array
Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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 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

+

Create

+

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
201
StorageClass
Created
202
StorageClass
Accepted
200
StorageClass
OK
+

Patch

+

partially update the specified StorageClass

+

HTTP Request

+PATCH /apis/storage.k8s.io/v1beta1/storageclasses/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
StorageClass
OK
+

Replace

+

replace the specified StorageClass

+

HTTP Request

+PUT /apis/storage.k8s.io/v1beta1/storageclasses/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
StorageClass
+

Response

+ + + + + + +
CodeDescription
200
StorageClass
OK
201
StorageClass
Created
+

Delete

+

delete a StorageClass

+

HTTP Request

+DELETE /apis/storage.k8s.io/v1beta1/storageclasses/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of StorageClass

+

HTTP Request

+DELETE /apis/storage.k8s.io/v1beta1/storageclasses +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified StorageClass

+

HTTP Request

+GET /apis/storage.k8s.io/v1beta1/storageclasses/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

+ + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

watch changes to an object of kind StorageClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/storage.k8s.io/v1beta1/watch/storageclasses/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the StorageClass
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of StorageClass. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/storage.k8s.io/v1beta1/watch/storageclasses +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Other API versions of this object exist: +v1 +v1alpha1 +
+ + + + + + + + + +
FieldDescription
apiGroup
string
APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.
kind
string
Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
name
string
Name of the object being referenced.
namespace
string
Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
+

Subject v1alpha1 rbac.authorization.k8s.io

+ + + + + +
GroupVersionKind
rbac.authorization.k8s.iov1alpha1Subject
+
Other API versions of this object exist: +v1 +v1beta1 +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion holds the API group and version of the referenced subject. Defaults to "v1" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io/v1alpha1" for User and Group subjects.
kind
string
Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.
name
string
Name of the object being referenced.
namespace
string
Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.
+

SubjectAccessReview v1beta1 authorization.k8s.io

+ + + + + +
GroupVersionKind
authorization.k8s.iov1beta1SubjectAccessReview
+
Other API versions of this object exist: +v1 +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

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
201
SubjectAccessReview
Created
202
SubjectAccessReview
Accepted
200
SubjectAccessReview
OK
+

SubjectRulesReviewStatus v1beta1 authorization.k8s.io

+ + + + + +
GroupVersionKind
authorization.k8s.iov1beta1SubjectRulesReviewStatus
+
Other API versions of this object exist: +v1 +
+ + + + + + + + + +
FieldDescription
evaluationError
string
EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn't support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete.
incomplete
boolean
Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn't support rules evaluation.
nonResourceRules
NonResourceRule array
NonResourceRules is the list of actions the subject is allowed to perform on non-resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
resourceRules
ResourceRule array
ResourceRules is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
+

SupplementalGroupsStrategyOptions v1beta1 policy

+ + + + + +
GroupVersionKind
policyv1beta1SupplementalGroupsStrategyOptions
+ + + + + + + +
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
+
Other API versions of this object exist: +v1 +
+ + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

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
+
Other API versions of this object exist: +v1 +
+ + + + + + + + + +
FieldDescription
extra
object
Any additional information provided by the authenticator.
groups
string array
The names of groups this user is a part of.
uid
string
A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs.
username
string
The name that uniquely identifies this user among all active users.
+

VolumeAttachment v1alpha1 storage.k8s.io

+ + + + + +
GroupVersionKind
storage.k8s.iov1alpha1VolumeAttachment
+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + + + + +
FieldDescription
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/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

+

Create

+

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
200
VolumeAttachment
OK
201
VolumeAttachment
Created
202
VolumeAttachment
Accepted
+

Patch

+

partially update the specified VolumeAttachment

+

HTTP Request

+PATCH /apis/storage.k8s.io/v1alpha1/volumeattachments/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + +
CodeDescription
200
VolumeAttachment
OK
+

Replace

+

replace the specified VolumeAttachment

+

HTTP Request

+PUT /apis/storage.k8s.io/v1alpha1/volumeattachments/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
+

Body Parameters

+ + + + + +
ParameterDescription
body
VolumeAttachment
+

Response

+ + + + + + +
CodeDescription
200
VolumeAttachment
OK
201
VolumeAttachment
Created
+

Delete

+

delete a VolumeAttachment

+

HTTP Request

+DELETE /apis/storage.k8s.io/v1alpha1/volumeattachments/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
dryRunWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSecondsThe duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependentsDeprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicyWhether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+

Body Parameters

+ + + + + +
ParameterDescription
body
DeleteOptions
+

Response

+ + + + + + +
CodeDescription
200
Status
OK
202
Status
Accepted
+

Delete Collection

+

delete collection of VolumeAttachment

+

HTTP Request

+DELETE /apis/storage.k8s.io/v1alpha1/volumeattachments +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

Read

+

read the specified VolumeAttachment

+

HTTP Request

+GET /apis/storage.k8s.io/v1alpha1/volumeattachments/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + + + +
ParameterDescription
prettyIf 'true', then the output is pretty printed.
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

+

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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are 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

+

watch changes to an object of kind VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

+

HTTP Request

+GET /apis/storage.k8s.io/v1alpha1/watch/volumeattachments/{name} +

Path Parameters

+ + + + + +
ParameterDescription
namename of the VolumeAttachment
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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

+

watch individual changes to a list of VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead.

+

HTTP Request

+GET /apis/storage.k8s.io/v1alpha1/watch/volumeattachments +

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
continueThe continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
includeUninitializedIf true, partially initialized resources are included in the response.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
limitlimit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of 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
+
Other API versions of this object exist: +v1beta1 +
+ + + + + + +
FieldDescription
persistentVolumeName
string
Name of the persistent volume to attach.
+

VolumeError v1alpha1 storage.k8s.io

+ + + + + +
GroupVersionKind
storage.k8s.iov1alpha1VolumeError
+
Other API versions of this object exist: +v1beta1 +
+ + + + + + + +
FieldDescription
message
string
String detailing the error encountered during Attach or Detach operation. This string maybe logged, so it should not contain sensitive information.
time
Time
Time the error was encountered.
+
+
+ + + + + + + diff --git a/static/docs/reference/generated/kubernetes-api/v1.12/jquery.scrollTo.min.js b/static/docs/reference/generated/kubernetes-api/v1.12/jquery.scrollTo.min.js new file mode 100644 index 0000000000..65a020d92a --- /dev/null +++ b/static/docs/reference/generated/kubernetes-api/v1.12/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= node.offset().top) { + activeElemToken = token; + } + } + if (!prevElemToken) { + getNavElemNode(activeElemToken).addClass('selected'); + prevElemToken = activeElemToken; + return; + } + if (activeElemToken !== prevElemToken) { + getNavElemNode(prevElemToken).removeClass('selected'); + getNavElemNode(activeElemToken).addClass('selected'); + prevElemToken = activeElemToken; + } + return activeElemToken; + } + + function getHeadingNode(token) { + return $('#' + token); + } + + function getNavNode(token) { + return $('#' + token + '-nav'); + } + + function getNavElemNode(token) { + return $('#sidebar-wrapper > ul a[href="#' + token + '"]'); + } + + function checkNodePositions(nodes, flatNodeMap, scrollPosition) { + var activeNode; + for (var i = 0; i < nodes.length; i++) { + var item = nodes[i]; + var node = flatNodeMap[item.section]; + var nodeTop = node.offset().top - 50; + if (scrollPosition >= nodeTop) { + activeNode = {token: item.section, node: node}; + + if (item.subsections) { + activeNode.subsections = item.subsections; + } + break; + } + } + return activeNode; + } + + function scrollToNav(token) { + setTimeout(function() { + var scrollPosition = $(window).scrollTop(); + var activeSectionTokens = scrollActions(scrollPosition); + var activeElemToken = checkActiveElement(flatToc, scrollPosition); + var navNode = $('#sidebar-wrapper > ul a[href="#' + token + '"]'); + $('#sidebar-wrapper').scrollTo(navNode, {duration: 'fast', axis: 'y'}); + }, 200); + } + + $(window).on('hashchange', function(event) { + var scrollPosition = $(window).scrollTop(); + var activeSectionTokens = scrollActions(scrollPosition); + var activeElemToken = checkActiveElement(flatToc, scrollPosition); + var scrollToken = activeSectionTokens.L2 ? activeSectionTokens.L2 : activeSectionTokens.L1; + scrollToNav(scrollToken); + var token = location.hash.slice(1); + }); + + var scrollPosition = $(window).scrollTop(); + scrollActions(scrollPosition); + checkActiveElement(flatToc, scrollPosition); + // 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/images/ancestry_logo.png b/static/images/ancestry_logo.png new file mode 100644 index 0000000000..1200759565 Binary files /dev/null and b/static/images/ancestry_logo.png differ diff --git a/static/images/blog/2018-10-01-network-bootable-farm-with-ltsp/k8s+ltsp.svg b/static/images/blog/2018-10-01-network-bootable-farm-with-ltsp/k8s+ltsp.svg new file mode 100644 index 0000000000..bd700d3a17 --- /dev/null +++ b/static/images/blog/2018-10-01-network-bootable-farm-with-ltsp/k8s+ltsp.svg @@ -0,0 +1,89 @@ + + + + + + + image/svg+xml + + + + + + + + + + + + + + + diff --git a/static/images/blog/2018-10-03-kubedirector/kubedirector.png b/static/images/blog/2018-10-03-kubedirector/kubedirector.png new file mode 100644 index 0000000000..a3283ab8e0 Binary files /dev/null and b/static/images/blog/2018-10-03-kubedirector/kubedirector.png differ diff --git a/static/images/blog/2018-10-08-support-for-azure-vmss/ca-functionality.png b/static/images/blog/2018-10-08-support-for-azure-vmss/ca-functionality.png new file mode 100644 index 0000000000..c6e8a205c1 Binary files /dev/null and b/static/images/blog/2018-10-08-support-for-azure-vmss/ca-functionality.png differ diff --git a/static/images/blog/2018-10-08-support-for-azure-vmss/cloud-provider-components.png b/static/images/blog/2018-10-08-support-for-azure-vmss/cloud-provider-components.png new file mode 100644 index 0000000000..e368ab321d Binary files /dev/null and b/static/images/blog/2018-10-08-support-for-azure-vmss/cloud-provider-components.png differ diff --git a/static/images/blog/2018-10-08-support-for-azure-vmss/cluster-autoscaler.png b/static/images/blog/2018-10-08-support-for-azure-vmss/cluster-autoscaler.png new file mode 100644 index 0000000000..db47b3fa31 Binary files /dev/null and b/static/images/blog/2018-10-08-support-for-azure-vmss/cluster-autoscaler.png differ diff --git a/static/images/blog/2018-10-08-support-for-azure-vmss/sample-azure-cluster.png b/static/images/blog/2018-10-08-support-for-azure-vmss/sample-azure-cluster.png new file mode 100644 index 0000000000..1579589d05 Binary files /dev/null and b/static/images/blog/2018-10-08-support-for-azure-vmss/sample-azure-cluster.png differ diff --git a/static/images/blog/2018-10-09-volume-snapshot-alpha/snapshot.png b/static/images/blog/2018-10-09-volume-snapshot-alpha/snapshot.png new file mode 100644 index 0000000000..78eb0d73ee Binary files /dev/null and b/static/images/blog/2018-10-09-volume-snapshot-alpha/snapshot.png differ diff --git a/static/images/blog/2019-09-30-health-checking-grpc/grpc_health_probe.png b/static/images/blog/2019-09-30-health-checking-grpc/grpc_health_probe.png new file mode 100644 index 0000000000..d781088b93 Binary files /dev/null and b/static/images/blog/2019-09-30-health-checking-grpc/grpc_health_probe.png differ diff --git a/static/images/blog/2019-09-30-health-checking-grpc/options.png b/static/images/blog/2019-09-30-health-checking-grpc/options.png new file mode 100644 index 0000000000..21f609b7e0 Binary files /dev/null and b/static/images/blog/2019-09-30-health-checking-grpc/options.png differ diff --git a/static/images/docs/services-iptables-overview.png b/static/images/docs/services-iptables-overview.png index 6d33ce3a49..7822848976 100644 Binary files a/static/images/docs/services-iptables-overview.png and b/static/images/docs/services-iptables-overview.png differ diff --git a/static/images/docs/services-iptables-overview.svg b/static/images/docs/services-iptables-overview.svg index 9745c4555e..6f014438b3 100644 --- a/static/images/docs/services-iptables-overview.svg +++ b/static/images/docs/services-iptables-overview.svg @@ -117,7 +117,7 @@ c33.5,0,61.4-13.4,66.8-31.1c17-5.3,28.6-15.7,28.6-27.7c0-17.3-24.4-31.4-54.4-31.4c-8.5,0-16.5,1.1-23.6,3.1 c-2-10.5-14.8-18.6-30.3-18.6c-5.8,0-11.2,1.2-15.9,3.1C357.7,209.5,345.9,202,332.5,202L332.5,202z"/> - ServiceIP + clusterIP (iptables) Node diff --git a/static/images/docs/services-ipvs-overview.png b/static/images/docs/services-ipvs-overview.png new file mode 100644 index 0000000000..34025d88f5 Binary files /dev/null and b/static/images/docs/services-ipvs-overview.png differ diff --git a/static/images/docs/services-ipvs-overview.svg b/static/images/docs/services-ipvs-overview.svg index 3c2fbbf59c..de745a7640 100644 --- a/static/images/docs/services-ipvs-overview.svg +++ b/static/images/docs/services-ipvs-overview.svg @@ -112,7 +112,7 @@ c33.5,0,61.4-13.4,66.8-31.1c17-5.3,28.6-15.7,28.6-27.7c0-17.3-24.4-31.4-54.4-31.4c-8.5,0-16.5,1.1-23.6,3.1 c-2-10.5-14.8-18.6-30.3-18.6c-5.8,0-11.2,1.2-15.9,3.1C357.7,209.5,345.9,202,332.5,202L332.5,202z"/> - ServiceIP + clusterIP (Virtual Server) Node diff --git a/static/images/docs/services-userspace-overview.png b/static/images/docs/services-userspace-overview.png index 74a6521fdc..dfd02ca4c6 100644 Binary files a/static/images/docs/services-userspace-overview.png and b/static/images/docs/services-userspace-overview.png differ diff --git a/static/images/docs/services-userspace-overview.svg b/static/images/docs/services-userspace-overview.svg index 011de754bb..85e81b593d 100644 --- a/static/images/docs/services-userspace-overview.svg +++ b/static/images/docs/services-userspace-overview.svg @@ -115,7 +115,7 @@ c33.5,0,61.4-13.4,66.8-31.1c17-5.3,28.6-15.7,28.6-27.7c0-17.3-24.4-31.4-54.4-31.4c-8.5,0-16.5,1.1-23.6,3.1 c-2-10.5-14.8-18.6-30.3-18.6c-5.8,0-11.2,1.2-15.9,3.1C154.8,160.6,143,153.1,129.6,153.1L129.6,153.1z"/> - ServiceIP + clusterIP (iptables) diff --git a/static/images/kubecon_china_ad_2.jpg b/static/images/kubecon_china_ad_2.jpg index caebc40846..9166ea14a7 100644 Binary files a/static/images/kubecon_china_ad_2.jpg and b/static/images/kubecon_china_ad_2.jpg differ diff --git a/static/images/kubernetes-horizontal-color.png b/static/images/kubernetes-horizontal-color.png new file mode 100644 index 0000000000..5cfa9ed29d Binary files /dev/null and b/static/images/kubernetes-horizontal-color.png differ