diff --git a/.gitignore b/.gitignore
index de345e5f59..c54db9289e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,3 +5,4 @@ _site/**
.sass-cache/**
CNAME
.travis.yml
+.idea/
diff --git a/404.md b/404.md
index 3d32e81bcf..8354c87820 100644
--- a/404.md
+++ b/404.md
@@ -3,6 +3,7 @@ layout: docwithnav
title: 404 Error!
permalink: /404.html
no_canonical: true
+sitemap: false
---
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9dd8149a15..934d7947ae 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -33,4 +33,4 @@ Note that code issues should be filed against the main kubernetes repository, wh
### Submitting Documentation Pull Requests
-If you’re fixing an issue in the existing documentation, you should submit a PR against the master branch. Follow [these instructions to create a documentation pull request against the kubernetes.io repository](http://kubernetes.io/docs/contribute/create-pull-request/).
+If you're fixing an issue in the existing documentation, you should submit a PR against the master branch. Follow [these instructions to create a documentation pull request against the kubernetes.io repository](http://kubernetes.io/docs/contribute/create-pull-request/).
diff --git a/Gemfile b/Gemfile
index e29e26cdc8..3828560a73 100644
--- a/Gemfile
+++ b/Gemfile
@@ -1,20 +1,4 @@
source "https://rubygems.org"
-gem "jekyll", "3.2.1"
-gem "jekyll-sass-converter", "1.3.0"
-gem "minima", "1.1.0"
-gem "kramdown", "1.11.1"
-gem "liquid", "3.0.6"
-gem "rouge", "1.11.1"
-gem "jemoji", "0.7.0"
-gem "jekyll-mentions", "1.2.0"
-gem "jekyll-redirect-from", "0.11.0"
-gem "jekyll-sitemap", "0.10.0"
-gem "jekyll-feed", "0.5.1"
-gem "jekyll-gist", "1.4.0"
-gem "jekyll-paginate", "1.1.0"
-gem "jekyll-coffeescript", "1.0.1"
-gem "jekyll-seo-tag", "2.0.0"
-gem "jekyll-github-metadata", "2.0.2"
-gem "listen", "3.0.6"
-gem "activesupport", "4.2.7"
+gem "github-pages", group: :jekyll_plugins
+gem "jekyll-include-cache", "~> 0.1"
diff --git a/Gemfile.lock b/Gemfile.lock
index ee385b958b..1ae07067d8 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -7,23 +7,75 @@ GEM
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
- addressable (2.4.0)
+ addressable (2.5.0)
+ public_suffix (~> 2.0, >= 2.0.2)
coffee-script (2.4.1)
coffee-script-source
execjs
- coffee-script-source (1.10.0)
+ coffee-script-source (1.12.2)
colorator (1.1.0)
+ ethon (0.10.1)
+ ffi (>= 1.3.0)
execjs (2.7.0)
- faraday (0.9.2)
+ faraday (0.10.0)
multipart-post (>= 1.2, < 3)
ffi (1.9.14)
forwardable-extended (2.6.0)
gemoji (2.1.0)
+ github-pages (112)
+ activesupport (= 4.2.7)
+ github-pages-health-check (= 1.3.0)
+ jekyll (= 3.3.1)
+ jekyll-avatar (= 0.4.2)
+ jekyll-coffeescript (= 1.0.1)
+ jekyll-default-layout (= 0.1.4)
+ jekyll-feed (= 0.8.0)
+ jekyll-gist (= 1.4.0)
+ jekyll-github-metadata (= 2.2.0)
+ jekyll-mentions (= 1.2.0)
+ jekyll-optional-front-matter (= 0.1.2)
+ jekyll-paginate (= 1.1.0)
+ jekyll-readme-index (= 0.0.3)
+ jekyll-redirect-from (= 0.11.0)
+ jekyll-relative-links (= 0.2.1)
+ jekyll-sass-converter (= 1.3.0)
+ jekyll-seo-tag (= 2.1.0)
+ jekyll-sitemap (= 0.12.0)
+ jekyll-swiss (= 0.4.0)
+ jekyll-theme-architect (= 0.0.3)
+ jekyll-theme-cayman (= 0.0.3)
+ jekyll-theme-dinky (= 0.0.3)
+ jekyll-theme-hacker (= 0.0.3)
+ jekyll-theme-leap-day (= 0.0.3)
+ jekyll-theme-merlot (= 0.0.3)
+ jekyll-theme-midnight (= 0.0.3)
+ jekyll-theme-minimal (= 0.0.3)
+ jekyll-theme-modernist (= 0.0.3)
+ jekyll-theme-primer (= 0.1.5)
+ jekyll-theme-slate (= 0.0.3)
+ jekyll-theme-tactile (= 0.0.3)
+ jekyll-theme-time-machine (= 0.0.3)
+ jekyll-titles-from-headings (= 0.1.3)
+ jemoji (= 0.7.0)
+ kramdown (= 1.11.1)
+ liquid (= 3.0.6)
+ listen (= 3.0.6)
+ mercenary (~> 0.3)
+ minima (= 2.0.0)
+ rouge (= 1.11.1)
+ terminal-table (~> 1.4)
+ github-pages-health-check (1.3.0)
+ addressable (~> 2.3)
+ net-dns (~> 0.8)
+ octokit (~> 4.0)
+ public_suffix (~> 2.0)
+ typhoeus (~> 0.7)
html-pipeline (2.4.2)
activesupport (>= 2)
nokogiri (>= 1.4)
i18n (0.7.0)
- jekyll (3.2.1)
+ jekyll (3.3.1)
+ addressable (~> 2.4)
colorator (~> 1.0)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 1.1)
@@ -33,26 +85,69 @@ GEM
pathutil (~> 0.9)
rouge (~> 1.7)
safe_yaml (~> 1.0)
+ jekyll-avatar (0.4.2)
+ jekyll (~> 3.0)
jekyll-coffeescript (1.0.1)
coffee-script (~> 2.2)
- jekyll-feed (0.5.1)
+ jekyll-default-layout (0.1.4)
+ jekyll (~> 3.0)
+ jekyll-feed (0.8.0)
+ jekyll (~> 3.3)
jekyll-gist (1.4.0)
octokit (~> 4.2)
- jekyll-github-metadata (2.0.2)
+ jekyll-github-metadata (2.2.0)
jekyll (~> 3.1)
- octokit (~> 4.0)
+ octokit (~> 4.0, != 4.4.0)
+ jekyll-include-cache (0.1.0)
+ jekyll (~> 3.3)
jekyll-mentions (1.2.0)
activesupport (~> 4.0)
html-pipeline (~> 2.3)
jekyll (~> 3.0)
+ jekyll-optional-front-matter (0.1.2)
+ jekyll (~> 3.0)
jekyll-paginate (1.1.0)
+ jekyll-readme-index (0.0.3)
+ jekyll (~> 3.0)
jekyll-redirect-from (0.11.0)
jekyll (>= 2.0)
+ jekyll-relative-links (0.2.1)
+ jekyll (~> 3.3)
jekyll-sass-converter (1.3.0)
sass (~> 3.2)
- jekyll-seo-tag (2.0.0)
- jekyll (~> 3.1)
- jekyll-sitemap (0.10.0)
+ jekyll-seo-tag (2.1.0)
+ jekyll (~> 3.3)
+ jekyll-sitemap (0.12.0)
+ jekyll (~> 3.3)
+ jekyll-swiss (0.4.0)
+ jekyll-theme-architect (0.0.3)
+ jekyll (~> 3.3)
+ jekyll-theme-cayman (0.0.3)
+ jekyll (~> 3.3)
+ jekyll-theme-dinky (0.0.3)
+ jekyll (~> 3.3)
+ jekyll-theme-hacker (0.0.3)
+ jekyll (~> 3.3)
+ jekyll-theme-leap-day (0.0.3)
+ jekyll (~> 3.3)
+ jekyll-theme-merlot (0.0.3)
+ jekyll (~> 3.3)
+ jekyll-theme-midnight (0.0.3)
+ jekyll (~> 3.3)
+ jekyll-theme-minimal (0.0.3)
+ jekyll (~> 3.3)
+ jekyll-theme-modernist (0.0.3)
+ jekyll (~> 3.3)
+ jekyll-theme-primer (0.1.5)
+ jekyll (~> 3.3)
+ jekyll-theme-slate (0.0.3)
+ jekyll (~> 3.3)
+ jekyll-theme-tactile (0.0.3)
+ jekyll (~> 3.3)
+ jekyll-theme-time-machine (0.0.3)
+ jekyll (~> 3.3)
+ jekyll-titles-from-headings (0.1.3)
+ jekyll (~> 3.3)
jekyll-watch (1.5.0)
listen (~> 3.0, < 3.1)
jemoji (0.7.0)
@@ -68,52 +163,41 @@ GEM
rb-inotify (>= 0.9.7)
mercenary (0.3.6)
mini_portile2 (2.1.0)
- minima (1.1.0)
- minitest (5.9.0)
+ minima (2.0.0)
+ minitest (5.10.1)
multipart-post (2.0.0)
- nokogiri (1.6.8)
+ net-dns (0.8.0)
+ nokogiri (1.6.8.1)
mini_portile2 (~> 2.1.0)
- pkg-config (~> 1.1.7)
- octokit (4.3.0)
- sawyer (~> 0.7.0, >= 0.5.3)
+ octokit (4.6.2)
+ sawyer (~> 0.8.0, >= 0.5.3)
pathutil (0.14.0)
forwardable-extended (~> 2.6)
- pkg-config (1.1.7)
- rb-fsevent (0.9.7)
+ public_suffix (2.0.4)
+ rb-fsevent (0.9.8)
rb-inotify (0.9.7)
ffi (>= 0.5.0)
rouge (1.11.1)
safe_yaml (1.0.4)
- sass (3.4.22)
- sawyer (0.7.0)
- addressable (>= 2.3.5, < 2.5)
- faraday (~> 0.8, < 0.10)
+ sass (3.4.23)
+ sawyer (0.8.1)
+ addressable (>= 2.3.5, < 2.6)
+ faraday (~> 0.8, < 1.0)
+ terminal-table (1.7.3)
+ unicode-display_width (~> 1.1.1)
thread_safe (0.3.5)
+ typhoeus (0.8.0)
+ ethon (>= 0.8.0)
tzinfo (1.2.2)
thread_safe (~> 0.1)
+ unicode-display_width (1.1.2)
PLATFORMS
ruby
DEPENDENCIES
- activesupport (= 4.2.7)
- jekyll (= 3.2.1)
- jekyll-coffeescript (= 1.0.1)
- jekyll-feed (= 0.5.1)
- jekyll-gist (= 1.4.0)
- jekyll-github-metadata (= 2.0.2)
- jekyll-mentions (= 1.2.0)
- jekyll-paginate (= 1.1.0)
- jekyll-redirect-from (= 0.11.0)
- jekyll-sass-converter (= 1.3.0)
- jekyll-seo-tag (= 2.0.0)
- jekyll-sitemap (= 0.10.0)
- jemoji (= 0.7.0)
- kramdown (= 1.11.1)
- liquid (= 3.0.6)
- listen (= 3.0.6)
- minima (= 1.1.0)
- rouge (= 1.11.1)
+ github-pages
+ jekyll-include-cache (~> 0.1)
BUNDLED WITH
- 1.11.2
+ 1.13.6
diff --git a/LICENSE b/LICENSE
index 06c608dcf4..b6988e7edc 100644
--- a/LICENSE
+++ b/LICENSE
@@ -378,7 +378,7 @@ Section 8 -- Interpretation.
Creative Commons is not a party to its public
licenses. Notwithstanding, Creative Commons may elect to apply one of
its public licenses to material it publishes and in those instances
-will be considered the “Licensor.” The text of the Creative Commons
+will be considered the "Licensor." The text of the Creative Commons
public licenses is dedicated to the public domain under the CC0 Public
Domain Dedication. Except for the limited purpose of indicating that
material is shared under a Creative Commons public license or as
diff --git a/OWNERS b/OWNERS
index 247d39ea5e..055a328273 100644
--- a/OWNERS
+++ b/OWNERS
@@ -1,5 +1,4 @@
assignees:
-- lavalamp
- smarterclayton
- janetkuo
- pwittrock
diff --git a/README.md b/README.md
index 2801eaead0..264822b1df 100644
--- a/README.md
+++ b/README.md
@@ -1,182 +1,19 @@
-## Instructions for Contributing to the Docs/Website
+## Instructions for Contributing to the Kubernetes Documentation
-Welcome! We are very pleased you want to contribute to the documentation and/or website for Kubernetes.
+Welcome! We are very pleased you want to contribute to the Kubernetes documentation.
-You can click the "Fork" button in the upper-right area of the screen to create a copy of our site on your GitHub account called a "fork." Make any changes you want in your fork, and when you are ready to send those changes to us, go to the index page for your fork and click "New Pull Request" to let us know about it.
+You can click the **Fork** button in the upper-right area of the screen to create a copy of this repository in your GitHub account called a *fork*. Make any changes you want in your fork, and when you are ready to send those changes to us, go to your fork and create a new pull request to let us know about it.
For more information about contributing to the Kubernetes documentation, see:
+* [Contributing to the Kubernetes Documentation](http://kubernetes.io/editdocs/)
* [Creating a Documentation Pull Request](http://kubernetes.io/docs/contribute/create-pull-request/)
* [Writing a New Topic](http://kubernetes.io/docs/contribute/write-new-topic/)
* [Staging Your Documentation Changes](http://kubernetes.io/docs/contribute/stage-documentation-changes/)
* [Using Page Templates](http://kubernetes.io/docs/contribute/page-templates/)
-
-## Automatic Staging for Pull Requests
-
-When you create a pull request (either against master or the upcoming release), your changes are staged in a custom subdomain on Netlify so that you can see your changes in rendered form before the PR is merged. You can use this to verify that everything is correct before the PR gets merged. To view your changes:
-
-- Scroll down to the PR's list of Automated Checks
-- Click "Show All Checks"
-- Look for "deploy/netlify"; you'll see "Deploy Preview Ready!" if staging was successful
-- Click "Details" to bring up the staged site and navigate to your changes
-
-## Branch structure and staging
-
-The current version of the website is served out of the `master` branch. To make changes to the live docs, such as bug fixes, broken links, typos, etc, **target your pull request to the master branch**
-
-The `release-1.x` branch stores changes for **upcoming releases of Kubernetes**. For example, the `release-1.5` branch has changes for the 1.5 release. These changes target branches (and *not* master) to avoid publishing documentation updates prior to the release for which they're relevant. If you have a change for an upcoming release of Kubernetes, **target your pull request to the appropriate release branch**.
-
-The staging site for the next upcoming Kubernetes release is here: [http://kubernetes-io-vnext-staging.netlify.com/](http://kubernetes-io-vnext-staging.netlify.com/). The staging site reflects the current state of what's been merged in the release branch, or in other words, what the docs will look like for the next upcoming release. It's automatically updated as new PRs get merged.
-
-## Staging the site locally (using Docker)
-
-Don't like installing stuff? Download and run a local staging server with a single `docker run` command.
-
- git clone https://github.com/kubernetes/kubernetes.github.io.git
- cd kubernetes.github.io
- docker run -ti --rm -v "$PWD":/k8sdocs -p 4000:4000 gcr.io/google-samples/k8sdocs:1.0
-
-Then visit [http://localhost:4000](http://localhost:4000) to see our site. Any changes you make on your local machine will be automatically staged.
-
-If you're interested you can view [the Dockerfile for this image](https://github.com/kubernetes/kubernetes.github.io/blob/master/staging-container/Dockerfile).
-
-## Staging the site locally (from scratch setup)
-
-The below commands to setup your environment for running GitHub pages locally. Then, any edits you make will be viewable
-on a lightweight webserver that runs on your local machine.
-
-This will typically be the fastest way (by far) to iterate on docs changes and see them staged, once you get this set up, but it does involve several install steps that take awhile to complete, and makes system-wide modifications.
-
-Install Ruby 2.2 or higher. If you're on Linux, run these commands:
-
- apt-get install software-properties-common
- apt-add-repository ppa:brightbox/ruby-ng
- apt-get install ruby2.2
- apt-get install ruby2.2-dev
-
-* If you're on a Mac, follow [these instructions](https://gorails.com/setup/osx/).
-* If you're on a Windows machine you can use the [Ruby Installer](http://rubyinstaller.org/downloads/). During the installation make sure to check the option for *Add Ruby executables to your PATH*.
-
-The remainder of the steps should work the same across operating systems.
-
-To confirm you've installed Ruby correctly, at the command prompt run `gem --version` and you should get a response with your version number. Likewise you can confirm you have Git installed properly by running `git --version`, which will respond with your version of Git.
-
-Install the GitHub Pages package, which includes Jekyll:
-
- gem install github-pages
-
-Clone our site:
-
- git clone https://github.com/kubernetes/kubernetes.github.io.git
-
-Make any changes you want. Then, to see your changes locally:
-
- cd kubernetes.github.io
- jekyll serve
-
-Your copy of the site will then be viewable at: [http://localhost:4000](http://localhost:4000)
-(or wherever Jekyll tells you).
-
-## GitHub help
-
-If you're a bit rusty with git/GitHub, you might want to read
-[this](http://readwrite.com/2013/10/02/github-for-beginners-part-2) for a refresher.
-
-## Common Tasks
-
-### Edit Page Titles or Change the Left Navigation
-
-Edit the yaml files in `/_data/` for the Guides, Reference, Samples, or Support areas.
-
-You may have to exit and `jekyll clean` before restarting the `jekyll serve` to
-get changes to files in `/_data/` to show up.
-
-### Add Images
-
-Put the new image in `/images/docs/` if it's for the documentation, and just `/images/` if it's for the website.
-
-**For diagrams, we greatly prefer SVG files!**
-
-### Include code from another file
-
-To include a file that is hosted on this GitHub repo, insert this code:
-
-
{% include code.html language="<LEXERVALUE>" file="<RELATIVEPATH>" ghlink="<PATHFROMROOT>" %}
-
-* `LEXERVALUE`: The language in which the file was written; must be [a value supported by Rouge](https://github.com/jneen/rouge/wiki/list-of-supported-languages-and-lexers).
-* `RELATIVEPATH`: The path to the file you're including, relative to the current file.
-* `PATHFROMROOT`: The path to the file relative to root, e.g. `/docs/admin/foo.yaml`
-
-To include a file that is hosted in the external, main Kubernetes repo, make sure it's added to [/update-imported-docs.sh](https://github.com/kubernetes/kubernetes.github.io/blob/master/update-imported-docs.sh), and run it so that the file gets downloaded, then enter:
-
-
{% include code.html language="<LEXERVALUE>" file="<RELATIVEPATH>" k8slink="<PATHFROMK8SROOT>" %}
-
-* `PATHFROMK8SROOT`: The path to the file relative to the root of [the Kubernetes repo](https://github.com/kubernetes/kubernetes/tree/release-1.2), e.g. `/examples/rbd/foo.yaml`
-
-## Using tabs for multi-language examples
-
-By specifying some inline CSV in a varable called `tabspec`, you can include a file
-called `tabs.html` that generates tabs showing code examples in multiple langauges.
-
-
-
-In English, this would read: "Create a set of tabs with the alias `servicesample`,
-and have tabs visually labeled "JSON" and "YAML" that use `json` and `yaml` Rouge syntax highlighting, which display the contents of
-`service-sample.{extension}` on the page, and link to the file in GitHub at (full path)."
-
-Example file: [Pods: Multi-Container](http://kubernetes.io/docs/user-guide/pods/multi-container/).
-
-## Use a global variable
-
-The `/_config.yml` file defines some useful variables you can use when editing docs.
-
-* `page.githubbranch`: The name of the GitHub branch on the Kubernetes repo that is associated with this branch of the docs. e.g. `release-1.2`
-* `page.version` The version of Kubernetes associated with this branch of the docs. e.g. `v1.2`
-* `page.docsbranch` The name of the GitHub branch on the Docs/Website repo that you are currently using. e.g. `release-1.1` or `master`
-
-This keeps the docs you're editing aligned with the Kubernetes version you're talking about. For example, if you define a link like so, you'll never have to worry about it going stale in future doc branches:
-
-
View the README [here](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/README.md).
-
-That, of course, will send users to:
-
-[http://releases.k8s.io/release-1.2/cluster/addons/README.md](http://releases.k8s.io/release-1.2/cluster/addons/README.md)
-
-(Or whatever Kubernetes release that docs branch is associated with.)
-
-## Config yaml guidelines
-
-Guidelines for config yamls that are included in the site docs. These
-are the yaml or json files that contain Kubernetes object
-configuration to be used with `kubectl create -f` Config yamls should
-be:
-
-* Separate deployable files, not embedded in the document, unless very
- small variations of a full config.
-* Included in the doc with the include code
- [above.](#include-code-from-another-file)
-* In the same directory as the doc that they are being used in
- * If you are re-using a yaml from another doc, that is OK, just
- leave it there, don't move it up to a higher level directory.
-* Tested in
- [test/examples_test.go](https://github.com/kubernetes/kubernetes.github.io/blob/master/test/examples_test.go)
-* Follows
- [best practices.](http://kubernetes.io/docs/user-guide/config-best-practices/)
-
-Don't assume the reader has this repository checked out, use `kubectl
-create -f https://github...` in example commands. For Docker images
-used in config yamls, try to use an image from an existing Kubernetes
-example. If creating an image for a doc, follow the
-[example guidelines](https://github.com/kubernetes/kubernetes/blob/master/examples/guidelines.md#throughout)
-section on "Docker images" from the Kubernetes repository.
-
-## Partners
-Kubernetes partners refers to the companies who contribute to the Kubernetes core codebase, extend their platform to support Kubernetes or provide managed services to users centered around the Kubernetes platform. Partners can get their services and offerings added to the [partner page](https://k8s.io/partners) by completing and submitting the [partner request form](https://goo.gl/qcSnZF). Once the information and assets are verified, the partner product/services will be listed in the partner page. This would typically take 7-10 days.
+* [Documentation Style Guide](http://kubernetes.io/docs/contribute/style-guide/)
## Thank you!
-Kubernetes thrives on community participation and we really appreciate your
+Kubernetes thrives on community participation, and we really appreciate your
contributions to our site and our documentation!
diff --git a/_config.yml b/_config.yml
index 5b7f442fd8..60e67c9cde 100644
--- a/_config.yml
+++ b/_config.yml
@@ -1,11 +1,12 @@
name: Kubernetes
+title: Kubernetes
+description: Production-Grade Container Orchestration
markdown: kramdown
kramdown:
input: GFM
html_to_native: true
hard_wrap: false
syntax_highlighter: rouge
-baseurl: /
incremental: true
safe: false
@@ -16,7 +17,7 @@ defaults:
scope:
path: ""
values:
- version: "v1.3"
+ version: "v1.5.1"
githubbranch: "master"
docsbranch: "master"
-
@@ -30,3 +31,24 @@ permalink: pretty
gems:
- jekyll-redirect-from
+ - jekyll-feed
+ - jekyll-sitemap
+ - jekyll-seo-tag
+ - jekyll-include-cache
+
+# SEO
+logo: /images/favicon.png
+twitter:
+ username: kubernetesio
+
+# Tables of contents, stored in the _data folder, that control the sidebar nav
+tocs:
+ - docs-home
+ - guides
+ - tutorials
+ - tasks
+ - concepts
+ - reference
+ - tools
+ - samples
+ - support
diff --git a/_data/concepts.yml b/_data/concepts.yml
index 93c790c0ab..a9a7c3eb29 100644
--- a/_data/concepts.yml
+++ b/_data/concepts.yml
@@ -1,13 +1,10 @@
bigheader: "Concepts"
abstract: "Detailed explanations of Kubernetes system concepts and abstractions."
toc:
-- title: Concepts
- path: /docs/concepts/
+- docs/concepts/index.md
- title: Object Metadata
section:
- - title: Annotations
- path: /docs/concepts/object-metadata/annotations/
+ - docs/concepts/object-metadata/annotations.md
- title: Controllers
section:
- - title: StatefulSets
- path: /docs/concepts/abstractions/controllers/statefulsets/
+ - docs/concepts/abstractions/controllers/statefulsets.md
diff --git a/_data/docs-home.yml b/_data/docs-home.yml
index 1cb8c9b05a..b80c025d5e 100644
--- a/_data/docs-home.yml
+++ b/_data/docs-home.yml
@@ -1,5 +1,4 @@
bigheader: "Kubernetes Documentation"
abstract: "Documentation for using and learning about Kubernetes."
toc:
-- title: Kubernetes Documentation
- path: /docs/
+- docs/index.md
diff --git a/_data/guides.yml b/_data/guides.yml
index 583deaeedd..388f77289d 100644
--- a/_data/guides.yml
+++ b/_data/guides.yml
@@ -1,311 +1,190 @@
bigheader: "Guides"
abstract: "How to get started, and accomplish tasks, using Kubernetes."
toc:
-- title: Guides
- path: /docs/user-guide/
+- docs/user-guide/index.md
- title: Getting Started
section:
- - title: What is Kubernetes?
- path: /docs/whatisk8s/
- - title: Installing Kubernetes on Linux with kubeadm
- path: /docs/getting-started-guides/kubeadm/
- - title: Installing Kubernetes on AWS with kops
- path: /docs/getting-started-guides/kops/
- - title: Hello World on Google Container Engine
- path: /docs/hellonode/
- - title: Installing kubectl
- path: /docs/getting-started-guides/kubectl/
- - title: Downloading or Building Kubernetes
- path: /docs/getting-started-guides/binary_release/
+ - docs/whatisk8s.md
+ - docs/getting-started-guides/kubeadm.md
+ - docs/getting-started-guides/kops.md
+ - docs/hellonode.md
+ - docs/getting-started-guides/kubectl.md
+ - docs/getting-started-guides/binary_release.md
- title: Online Training Course
path: https://www.udacity.com/course/scalable-microservices-with-kubernetes--ud615
- title: Accessing the Cluster
section:
- - title: Installing and Setting up kubectl
- path: /docs/user-guide/prereqs/
- - title: Accessing Clusters
- path: /docs/user-guide/accessing-the-cluster/
- - title: Sharing Cluster Access with kubeconfig
- path: /docs/user-guide/sharing-clusters/
- - title: Authenticating Across Clusters with kubeconfig
- path: /docs/user-guide/kubeconfig-file/
+ - docs/user-guide/prereqs.md
+ - docs/user-guide/accessing-the-cluster.md
+ - docs/user-guide/sharing-clusters.md
+ - docs/user-guide/kubeconfig-file.md
-- title: User Guide
- path: /docs/user-guide/
+- docs/user-guide/index.md
-- title: Web UI (Dashboard)
- path: /docs/user-guide/ui/
+- docs/user-guide/ui.md
- title: Workload Deployment and Management
section:
- - title: Launching, Exposing, and Killing Applications
- path: /docs/user-guide/quick-start/
- - title: Deploying Applications
- path: /docs/user-guide/deploying-applications/
- - title: Managing Resources
- path: /docs/user-guide/managing-deployments/
- - title: Replication Controller Operations
- path: /docs/user-guide/replication-controller/operations/
- - title: Resizing a Replication Controller
- path: /docs/user-guide/resizing-a-replication-controller/
- - title: Rolling Updates
- path: /docs/user-guide/rolling-updates/
- - title: Rolling Update Demo
- path: /docs/user-guide/update-demo/
- - title: Secrets Walkthrough
- path: /docs/user-guide/secrets/walkthrough/
- - title: Using ConfigMap
- path: /docs/user-guide/configmap/
- - title: Horizontal Pod Autoscaling
- path: /docs/user-guide/horizontal-pod-autoscaling/walkthrough/
- - title: Best Practices for Configuration
- path: /docs/user-guide/config-best-practices/
- - title: Using kubectl to Manage Resources
- path: /docs/user-guide/working-with-resources/
- - title: Garbage Collection (Beta)
- path: /docs/user-guide/garbage-collection/
+ - docs/user-guide/quick-start.md
+ - docs/user-guide/deploying-applications.md
+ - docs/user-guide/managing-deployments.md
+ - docs/user-guide/replication-controller/operations.md
+ - docs/user-guide/resizing-a-replication-controller.md
+ - docs/user-guide/rolling-updates.md
+ - docs/user-guide/update-demo/index.md
+ - docs/user-guide/secrets/walkthrough.md
+ - docs/user-guide/configmap/index.md
+ - docs/user-guide/horizontal-pod-autoscaling/walkthrough.md
+ - docs/user-guide/config-best-practices.md
+ - docs/user-guide/working-with-resources.md
+ - docs/user-guide/garbage-collection.md
- title: Using NetworkPolicy
section:
- - title: Example Walkthrough
- path: /docs/getting-started-guides/network-policy/walkthrough/
- - title: Using Calico for NetworkPolicy
- path: /docs/getting-started-guides/network-policy/calico/
- - title: Using Romana for NetworkPolicy
- path: /docs/getting-started-guides/network-policy/romana/
+ - docs/getting-started-guides/network-policy/walkthrough.md
+ - docs/getting-started-guides/network-policy/calico.md
+ - docs/getting-started-guides/network-policy/romana.md
- title: Batch Jobs
section:
- - title: Jobs
- path: /docs/user-guide/jobs/
- - title: Parallel Processing using Expansions
- path: /docs/user-guide/jobs/expansions/
- - title: Coarse Parallel Processing using a Work Queue
- path: /docs/user-guide/jobs/work-queue-1/
- - title: Fine Parallel Processing using a Work Queue
- path: /docs/user-guide/jobs/work-queue-2/
- - title: Cron Jobs
- path: /docs/user-guide/cron-jobs/
+ - docs/user-guide/jobs.md
+ - docs/user-guide/jobs/expansions/index.md
+ - docs/user-guide/jobs/work-queue-1/index.md
+ - docs/user-guide/jobs/work-queue-2/index.md
+ - docs/user-guide/cron-jobs.md
- title: Service Discovery and Load Balancing
section:
- - title: Connecting Applications with Services
- path: /docs/user-guide/connecting-applications/
- - title: Service Operations
- path: /docs/user-guide/services/operations/
- - title: Creating an External Load Balancer
- path: /docs/user-guide/load-balancer/
- - title: Configuring Your Cloud Provider's Firewalls
- path: /docs/user-guide/services-firewalls/
- - title: Cross-cluster Service Discovery using Federated Services
- path: /docs/user-guide/federation/federated-services/
+ - docs/user-guide/connecting-applications.md
+ - docs/user-guide/services/operations.md
+ - docs/user-guide/load-balancer.md
+ - docs/user-guide/services-firewalls.md
+ - docs/user-guide/federation/federated-services.md
- title: Containers and Pods
section:
- - title: Running Your First Containers
- path: /docs/user-guide/simple-nginx/
- - title: Creating Single-Container Pods
- path: /docs/user-guide/pods/single-container/
- - title: Creating Multi-Container Pods
- path: /docs/user-guide/pods/multi-container/
- - title: Configuring Containers
- path: /docs/user-guide/configuring-containers/
- - title: Working with Containers in Production
- path: /docs/user-guide/production-pods/
- - title: Commands and Capabilities
- path: /docs/user-guide/containers/
- - title: Using Environment Variables
- path: /docs/user-guide/environment-guide/
- - title: Managing Compute Resources
- path: /docs/user-guide/compute-resources/
- - title: The Lifecycle of a Pod
- path: /docs/user-guide/pod-states/
- - title: Checking Pod Health
- path: /docs/user-guide/liveness/
- - title: Container Lifecycle Hooks
- path: /docs/user-guide/container-environment/
- - title: Assigning Pods to Nodes
- path: /docs/user-guide/node-selection/
- - title: Using the Downward API to Convey Pod Properties
- path: /docs/user-guide/downward-api/
- - title: Downward API Volumes
- path: /docs/user-guide/downward-api/volume
- - title: Persistent Volumes Walkthrough
- path: /docs/user-guide/persistent-volumes/walkthrough/
- - title: Bootstrapping Pet Sets
- path: /docs/user-guide/petset/bootstrapping/
+ - docs/user-guide/simple-nginx.md
+ - docs/user-guide/pods/single-container.md
+ - docs/user-guide/pods/multi-container.md
+ - docs/user-guide/configuring-containers.md
+ - docs/user-guide/production-pods.md
+ - docs/user-guide/containers.md
+ - docs/user-guide/environment-guide/index.md
+ - docs/user-guide/compute-resources.md
+ - docs/user-guide/pod-states.md
+ - docs/user-guide/liveness/index.md
+ - docs/user-guide/container-environment.md
+ - docs/user-guide/node-selection/index.md
+ - docs/user-guide/downward-api/index.md
+ - docs/user-guide/downward-api/volume/index.md
+ - docs/user-guide/persistent-volumes/walkthrough.md
+ - docs/user-guide/petset/bootstrapping/index.md
- title: Monitoring, Logging, and Debugging Containers
section:
- - title: Resource Usage Monitoring
- path: /docs/user-guide/monitoring/
- - title: Logging
- path: /docs/getting-started-guides/logging/
- - title: Logging with Elasticsearch and Kibana
- path: /docs/getting-started-guides/logging-elasticsearch/
- - title: Running Commands in a Container with kubectl exec
- path: /docs/user-guide/getting-into-containers/
- - title: Connect with Proxies
- path: /docs/user-guide/connecting-to-applications-proxy/
- - title: Connect with Port Forwarding
- path: /docs/user-guide/connecting-to-applications-port-forward/
+ - docs/user-guide/monitoring.md
+ - docs/getting-started-guides/logging.md
+ - docs/getting-started-guides/logging-elasticsearch.md
+ - docs/user-guide/getting-into-containers.md
+ - docs/user-guide/connecting-to-applications-proxy.md
+ - docs/user-guide/connecting-to-applications-port-forward.md
- title: Using Explorer to Examine the Runtime Environment
path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/explorer
- title: Creating a Cluster
section:
- - title: Picking the Right Solution
- path: /docs/getting-started-guides/
+ - docs/getting-started-guides/index.md
- title: Running Kubernetes on Your Local Machine
section:
- - title: Running Kubernetes Locally via Minikube
- path: /docs/getting-started-guides/minikube/
- - title: Deprecated Alternatives
- path: /docs/getting-started-guides/alternatives/
+ - docs/getting-started-guides/minikube.md
+ - docs/getting-started-guides/alternatives.md
- title: Running Kubernetes on Turn-key Cloud Solutions
section:
- title: Running Kubernetes on Google Container Engine
path: https://cloud.google.com/container-engine/docs/before-you-begin/
- - title: Running Kubernetes on Google Compute Engine
- path: /docs/getting-started-guides/gce/
- - title: Running Kubernetes on AWS EC2
- path: /docs/getting-started-guides/aws/
- - title: Running Kubernetes on Azure
- path: /docs/getting-started-guides/azure/
- - title: Running Kubernetes on Azure (Weave-based)
- path: /docs/getting-started-guides/coreos/azure/
- - title: Running Kubernetes on CenturyLink Cloud
- path: /docs/getting-started-guides/clc/
+ - docs/getting-started-guides/gce.md
+ - docs/getting-started-guides/aws.md
+ - title: Running Kubernetes on Azure Container Service
+ path: https://docs.microsoft.com/en-us/azure/container-service/container-service-kubernetes-walkthrough
+ - docs/getting-started-guides/azure.md
+ - docs/getting-started-guides/clc.md
- title: Running Kubernetes on IBM SoftLayer
path: https://github.com/patrocinio/kubernetes-softlayer
+ - title: Running Kubernetes on Multiple Clouds with Stackpoint.io
+ path: /docs/getting-started-guides/stackpoint/
- title: Running Kubernetes on Custom Solutions
section:
- - title: Creating a Custom Cluster from Scratch
- path: /docs/getting-started-guides/scratch/
+ - docs/getting-started-guides/scratch.md
- title: Custom Cloud Solutions
section:
- - title: CoreOS on AWS or GCE
- path: /docs/getting-started-guides/coreos/
- - title: Ubuntu on AWS or Joyent
- path: /docs/getting-started-guides/juju/
- - title: CoreOS on Rackspace
- path: /docs/getting-started-guides/rackspace/
+ - docs/getting-started-guides/coreos/index.md
+ - /docs/getting-started-guides/juju/
+ - docs/getting-started-guides/rackspace.md
- title: On-Premise VMs
section:
- - title: CoreOS on Vagrant
- path: /docs/getting-started-guides/coreos/
- - title: Cloudstack
- path: /docs/getting-started-guides/cloudstack/
- - title: VMware vSphere
- path: /docs/getting-started-guides/vsphere/
- - title: VMware Photon Controller
- path: /docs/getting-started-guides/photon-controller/
- - title: Juju
- path: /docs/getting-started-guides/juju/
- - title: DCOS
- path: /docs/getting-started-guides/dcos/
- - title: CoreOS on libvirt
- path: /docs/getting-started-guides/libvirt-coreos/
- - title: oVirt
- path: /docs/getting-started-guides/ovirt/
- - title: OpenStack Heat
- path: /docs/getting-started-guides/openstack-heat/
+ - docs/getting-started-guides/coreos/index.md
+ - docs/getting-started-guides/cloudstack.md
+ - docs/getting-started-guides/vsphere.md
+ - docs/getting-started-guides/photon-controller.md
+ - /docs/getting-started-guides/juju/
+ - docs/getting-started-guides/dcos.md
+ - docs/getting-started-guides/libvirt-coreos.md
+ - docs/getting-started-guides/ovirt.md
+ - docs/getting-started-guides/openstack-heat.md
- title: rkt
section:
- - title: Running Kubernetes with rkt
- path: /docs/getting-started-guides/rkt/
- - title: Known Issues when Using rkt
- path: /docs/getting-started-guides/rkt/notes/
- - title: Kubernetes on Mesos
- path: /docs/getting-started-guides/mesos/
- - title: Kubernetes on Mesos on Docker
- path: /docs/getting-started-guides/mesos-docker/
+ - docs/getting-started-guides/rkt/index.md
+ - docs/getting-started-guides/rkt/notes.md
+ - docs/getting-started-guides/mesos/index.md
+ - docs/getting-started-guides/mesos-docker.md
- title: Bare Metal
section:
- - title: Offline
- path: /docs/getting-started-guides/coreos/bare_metal_offline/
- - title: Fedora via Ansible
- path: /docs/getting-started-guides/fedora/fedora_ansible_config/
- - title: Fedora (Single Node)
- path: /docs/getting-started-guides/fedora/fedora_manual_config/
- - title: Fedora (Multi Node)
- path: /docs/getting-started-guides/fedora/flannel_multi_node_cluster/
- - title: CentOS
- path: /docs/getting-started-guides/centos/centos_manual_config/
- - title: CoreOS
- path: /docs/getting-started-guides/coreos
- - title: Ubuntu
- path: /docs/getting-started-guides/ubuntu/
- - title: Windows Server Containers
- path: /docs/getting-started-guides/windows/
- - title: Validate Node Setup
- path: /docs/admin/node-conformance
- - title: Portable Multi-Node Cluster
- path: /docs/getting-started-guides/docker-multinode/
- - title: Building Large Clusters
- path: /docs/admin/cluster-large/
- - title: Running in Multiple Zones
- path: /docs/admin/multiple-zones/
- - title: Building High-Availability Clusters
- path: /docs/admin/high-availability/
+ - docs/getting-started-guides/coreos/bare_metal_offline.md
+ - docs/getting-started-guides/fedora/fedora_ansible_config.md
+ - docs/getting-started-guides/fedora/fedora_manual_config.md
+ - docs/getting-started-guides/fedora/flannel_multi_node_cluster.md
+ - docs/getting-started-guides/centos/centos_manual_config.md
+ - docs/getting-started-guides/coreos/index.md
+ - /docs/getting-started-guides/ubuntu/
+ - docs/getting-started-guides/windows/index.md
+ - docs/admin/node-conformance.md
+ - docs/getting-started-guides/docker-multinode.md
+ - docs/admin/cluster-large.md
+ - docs/admin/multiple-zones.md
+ - docs/admin/high-availability/index.md
- title: Administering Clusters
section:
- - title: Admin Guide
- path: /docs/admin/
- - title: Cluster Management Guide
- path: /docs/admin/cluster-management/
- - title: kubeadm reference
- path: /docs/admin/kubeadm/
- - title: Installing Addons
- path: /docs/admin/addons/
- - title: Sharing a Cluster with Namespaces
- path: /docs/admin/namespaces/
- - title: Namespaces Walkthrough
- path: /docs/admin/namespaces/walkthrough/
- - title: Setting Pod CPU and Memory Limits
- path: /docs/admin/limitrange/
- - title: Understanding Resource Quotas
- path: /docs/admin/resourcequota/
- - title: Applying Resource Quotas and Limits
- path: /docs/admin/resourcequota/walkthrough/
- - title: Kubernetes Components
- path: /docs/admin/cluster-components/
- - title: Configuring Kubernetes Use of etcd
- path: /docs/admin/etcd/
- - title: Using Multiple Clusters
- path: /docs/admin/multi-cluster/
+ - docs/admin/index.md
+ - docs/admin/cluster-management.md
+ - docs/admin/kubeadm.md
+ - docs/admin/addons.md
+ - docs/admin/namespaces/index.md
+ - docs/admin/namespaces/walkthrough.md
+ - docs/admin/limitrange/index.md
+ - docs/admin/resourcequota/index.md
+ - docs/admin/resourcequota/walkthrough.md
+ - docs/admin/cluster-components.md
+ - docs/admin/etcd.md
+ - docs/admin/multi-cluster.md
- title: Changing Cluster Size
path: https://github.com/kubernetes/kubernetes/wiki/User-FAQ#how-do-i-change-the-size-of-my-cluster/
- - title: Configuring Multiple Schedulers
- path: /docs/admin/multiple-schedulers/
- - title: Networking in Kubernetes
- path: /docs/admin/networking/
- - title: Using DNS Pods and Services
- path: /docs/admin/dns/
+ - docs/admin/multiple-schedulers.md
+ - docs/admin/networking.md
+ - docs/admin/dns.md
- title: Setting Up and Configuring DNS
path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/cluster-dns
- - title: Master <-> Node Communication
- path: /docs/admin/master-node-communication/
- - title: Network Plugins
- path: /docs/admin/network-plugins/
- - title: Static Pods
- path: /docs/admin/static-pods/
- - title: Configuring kubelet Garbage Collection
- path: /docs/admin/garbage-collection/
- - title: Configuring Out Of Resource Handling
- path: /docs/admin/out-of-resource/
- - title: Configuring Kubernetes with Salt
- path: /docs/admin/salt/
- - title: Monitoring Node Health
- path: /docs/admin/node-problem/
- - title: AppArmor
- path: /docs/admin/apparmor/
+ - docs/admin/master-node-communication.md
+ - docs/admin/network-plugins.md
+ - docs/admin/static-pods.md
+ - docs/admin/garbage-collection.md
+ - docs/admin/out-of-resource.md
+ - docs/admin/salt.md
+ - docs/admin/node-problem.md
+ - docs/admin/apparmor/index.md
- title: Administering Federation
section:
- - title: Using `kubefed`
- path: /docs/admin/federation/kubfed/
- - title: Using `federation-up` and `deploy.sh`
- path: /docs/admin/federation/
+ - /docs/admin/federation/kubfed/
+ - docs/admin/federation/index.md
diff --git a/_data/overrides.yml b/_data/overrides.yml
index d38226e61b..31f60a2a8a 100644
--- a/_data/overrides.yml
+++ b/_data/overrides.yml
@@ -8,12 +8,10 @@ overrides:
- path: docs/admin/kube-proxy.md
- path: docs/admin/kube-scheduler.md
- path: docs/admin/kubelet.md
-- changedpath: docs/api-reference/extensions/v1beta1/definitions.html _includes/v1.4/extensions-v1beta1-definitions.html
-- changedpath: docs/api-reference/extensions/v1beta1/operations.html _includes/v1.4/extensions-v1beta1-operations.html
-- changedpath: docs/api-reference/v1/definitions.html _includes/v1.4/v1-definitions.html
-- changedpath: docs/api-reference/v1/operations.html _includes/v1.4/v1-operations.html
+- changedpath: docs/api-reference/extensions/v1beta1/definitions.html _includes/v1.5/extensions-v1beta1-definitions.html
+- changedpath: docs/api-reference/extensions/v1beta1/operations.html _includes/v1.5/extensions-v1beta1-operations.html
+- changedpath: docs/api-reference/v1/definitions.html _includes/v1.5/v1-definitions.html
+- changedpath: docs/api-reference/v1/operations.html _includes/v1.5/v1-operations.html
- copypath: k8s/federation/docs/api-reference/ docs/federation/
- copypath: k8s/cluster/saltbase/salt/fluentd-gcp/fluentd-gcp.yaml docs/getting-started-guides/fluentd-gcp.yaml
-- copypath: k8s/examples/blog-logging/counter-pod.yaml docs/getting-started-guides/counter-pod.yaml
-- copypath: k8s/examples/blog-logging/counter-pod.yaml docs/user-guide/counter-pod.yaml
diff --git a/_data/reference.yml b/_data/reference.yml
index ce0504eed8..475d87d10c 100644
--- a/_data/reference.yml
+++ b/_data/reference.yml
@@ -1,247 +1,173 @@
bigheader: "Reference Documentation"
abstract: "Design docs, concept definitions, and references for APIs and CLIs."
toc:
-- title: Reference Documentation
- path: /docs/reference/
+- docs/reference.md
- title: Kubernetes API
section:
- - title: Kubernetes API Overview
- path: /docs/api/
+ - docs/api.md
- title: Accessing the API
section:
- - title: Overview
- path: /docs/admin/accessing-the-api/
- - title: Authenticating
- path: /docs/admin/authentication/
- - title: Using Authorization Plugins
- path: /docs/admin/authorization/
- - title: Using Admission Controllers
- path: /docs/admin/admission-controllers/
- - title: Managing Service Accounts
- path: /docs/admin/service-accounts-admin/
- - title: Kubernetes API Operations
- path: /docs/api-reference/v1/operations/
- - title: Kubernetes API Definitions
- path: /docs/api-reference/v1/definitions/
- - title: Kubernetes API Swagger Spec
- path: /kubernetes/third_party/swagger-ui/
+ - docs/admin/accessing-the-api.md
+ - docs/admin/authentication.md
+ - docs/admin/authorization.md
+ - docs/admin/admission-controllers.md
+ - docs/admin/service-accounts-admin.md
+ - docs/api-reference/v1/operations.html
+ - docs/api-reference/v1/definitions.html
+ - kubernetes/third_party/swagger-ui/index.md
- title: Autoscaling API
section:
- - title: Autoscaling API Operations
- path: /docs/api-reference/autoscaling/v1/operations/
- - title: Autoscaling API Definitions
- path: /docs/api-reference/autoscaling/v1/definitions/
+ - docs/api-reference/autoscaling/v1/operations.html
+ - docs/api-reference/autoscaling/v1/definitions.html
- title: Batch API
section:
- - title: Batch API Operations
- path: /docs/api-reference/batch/v1/operations/
- - title: Batch API Definitions
- path: /docs/api-reference/batch/v1/definitions/
+ - docs/api-reference/batch/v1/operations.html
+ - docs/api-reference/batch/v1/definitions.html
+
+- title: Apps API
+ section:
+ - title: Apps API Operations
+ path: /docs/api-reference/apps/v1beta1/operations/
+ - title: Apps API Definitions
+ path: /docs/api-reference/apps/v1beta1/definitions/
- title: Extensions API
section:
- - title: Extensions API Operations
- path: /docs/api-reference/extensions/v1beta1/operations/
- - title: Extensions API Definitions
- path: /docs/api-reference/extensions/v1beta1/definitions/
+ - docs/api-reference/extensions/v1beta1/operations.html
+ - docs/api-reference/extensions/v1beta1/definitions.html
- title: kubectl CLI
section:
- - title: kubectl Overview
- path: /docs/user-guide/kubectl-overview/
- - title: kubectl for Docker Users
- path: /docs/user-guide/docker-cli-to-kubectl/
- - title: kubectl Usage Conventions
- path: /docs/user-guide/kubectl-conventions/
- - title: JSONpath Support
- path: /docs/user-guide/jsonpath/
- - title: kubectl Cheat Sheet
- path: /docs/user-guide/kubectl-cheatsheet/
+ - docs/user-guide/kubectl-overview.md
+ - docs/user-guide/docker-cli-to-kubectl.md
+ - docs/user-guide/kubectl-conventions.md
+ - docs/user-guide/jsonpath.md
+ - docs/user-guide/kubectl-cheatsheet.md
- title: kubectl Commands
section:
- - title: kubectl
- path: /docs/user-guide/kubectl/
- - title: kubectl annotate
- path: /docs/user-guide/kubectl/kubectl_annotate/
- - title: kubectl api-versions
- path: /docs/user-guide/kubectl/kubectl_api-versions/
- - title: kubectl apply
- path: /docs/user-guide/kubectl/kubectl_apply/
- - title: kubectl attach
- path: /docs/user-guide/kubectl/kubectl_attach/
- - title: kubectl autoscale
- path: /docs/user-guide/kubectl/kubectl_autoscale/
- - title: kubectl cluster-info
- path: /docs/user-guide/kubectl/kubectl_cluster-info/
- - title: kubectl config
- path: /docs/user-guide/kubectl/kubectl_config/
- - title: kubectl config current-context
- path: /docs/user-guide/kubectl/kubectl_config_current-context/
- - title: kubectl config set-cluster
- path: /docs/user-guide/kubectl/kubectl_config_set-cluster/
- - title: kubectl config set-context
- path: /docs/user-guide/kubectl/kubectl_config_set-context/
- - title: kubectl config set-credentials
- path: /docs/user-guide/kubectl/kubectl_config_set-credentials/
- - title: kubectl config set
- path: /docs/user-guide/kubectl/kubectl_config_set/
- - title: kubectl config unset
- path: /docs/user-guide/kubectl/kubectl_config_unset/
- - title: kubectl config use-context
- path: /docs/user-guide/kubectl/kubectl_config_use-context/
- - title: kubectl config view
- path: /docs/user-guide/kubectl/kubectl_config_view/
- - title: kubectl convert
- path: /docs/user-guide/kubectl/kubectl_convert/
- - title: kubectl cordon
- path: /docs/user-guide/kubectl/kubectl_cordon/
- - title: kubectl create
- path: /docs/user-guide/kubectl/kubectl_create/
- - title: kubectl create configmap
- path: /docs/user-guide/kubectl/kubectl_create_configmap/
- - title: kubectl create namespace
- path: /docs/user-guide/kubectl/kubectl_create_namespace/
- - title: kubectl create secret docker-registry
- path: /docs/user-guide/kubectl/kubectl_create_secret_docker-registry/
- - title: kubectl create secret
- path: /docs/user-guide/kubectl/kubectl_create_secret/
- - title: kubectl create secret generic
- path: /docs/user-guide/kubectl/kubectl_create_secret_generic/
- - title: kubectl create serviceaccount
- path: /docs/user-guide/kubectl/kubectl_create_serviceaccount/
- - title: kubectl delete
- path: /docs/user-guide/kubectl/kubectl_delete/
- - title: kubectl describe
- path: /docs/user-guide/kubectl/kubectl_describe/
- - title: kubectl drain
- path: /docs/user-guide/kubectl/kubectl_drain/
- - title: kubectl edit
- path: /docs/user-guide/kubectl/kubectl_edit/
- - title: kubectl exec
- path: /docs/user-guide/kubectl/kubectl_exec/
- - title: kubectl explain
- path: /docs/user-guide/kubectl/kubectl_explain/
- - title: kubectl expose
- path: /docs/user-guide/kubectl/kubectl_expose/
- - title: kubectl get
- path: /docs/user-guide/kubectl/kubectl_get/
- - title: kubectl label
- path: /docs/user-guide/kubectl/kubectl_label/
- - title: kubectl logs
- path: /docs/user-guide/kubectl/kubectl_logs/
- - title: kubectl patch
- path: /docs/user-guide/kubectl/kubectl_patch/
- - title: kubectl port-forward
- path: /docs/user-guide/kubectl/kubectl_port-forward/
- - title: kubectl proxy
- path: /docs/user-guide/kubectl/kubectl_proxy/
- - title: kubectl replace
- path: /docs/user-guide/kubectl/kubectl_replace/
- - title: kubectl rolling-update
- path: /docs/user-guide/kubectl/kubectl_rolling-update/
- - title: kubectl rollout
- path: /docs/user-guide/kubectl/kubectl_rollout/
- - title: kubectl rollout history
- path: /docs/user-guide/kubectl/kubectl_rollout_history/
- - title: kubectl rollout pause
- path: /docs/user-guide/kubectl/kubectl_rollout_pause/
- - title: kubectl rollout resume
- path: /docs/user-guide/kubectl/kubectl_rollout_resume/
- - title: kubectl rollout undo
- path: /docs/user-guide/kubectl/kubectl_rollout_undo/
- - title: kubectl run
- path: /docs/user-guide/kubectl/kubectl_run/
- - title: kubectl scale
- path: /docs/user-guide/kubectl/kubectl_scale/
- - title: kubectl uncordon
- path: /docs/user-guide/kubectl/kubectl_uncordon/
- - title: kubectl version
- path: /docs/user-guide/kubectl/kubectl_version/
+ - docs/user-guide/kubectl/index.md
+ - docs/user-guide/kubectl/kubectl_annotate.md
+ - docs/user-guide/kubectl/kubectl_api-versions.md
+ - docs/user-guide/kubectl/kubectl_apply.md
+ - docs/user-guide/kubectl/kubectl_attach.md
+ - docs/user-guide/kubectl/kubectl_autoscale.md
+ - docs/user-guide/kubectl/kubectl_certificate.md
+ - docs/user-guide/kubectl/kubectl_certificate_approve.md
+ - docs/user-guide/kubectl/kubectl_certificate_deny.md
+ - docs/user-guide/kubectl/kubectl_cluster-info.md
+ - docs/user-guide/kubectl/kubectl_cluster-info_dump.md
+ - docs/user-guide/kubectl/kubectl_completion.md
+ - docs/user-guide/kubectl/kubectl_config.md
+ - docs/user-guide/kubectl/kubectl_config_current-context.md
+ - docs/user-guide/kubectl/kubectl_config_delete-cluster.md
+ - docs/user-guide/kubectl/kubectl_config_delete-context.md
+ - docs/user-guide/kubectl/kubectl_config_get-clusters.md
+ - docs/user-guide/kubectl/kubectl_config_get-contexts.md
+ - docs/user-guide/kubectl/kubectl_config_set-cluster.md
+ - docs/user-guide/kubectl/kubectl_config_set-context.md
+ - docs/user-guide/kubectl/kubectl_config_set-credentials.md
+ - docs/user-guide/kubectl/kubectl_config_set.md
+ - docs/user-guide/kubectl/kubectl_config_unset.md
+ - docs/user-guide/kubectl/kubectl_config_use-context.md
+ - docs/user-guide/kubectl/kubectl_config_view.md
+ - docs/user-guide/kubectl/kubectl_convert.md
+ - docs/user-guide/kubectl/kubectl_cordon.md
+ - docs/user-guide/kubectl/kubectl_cp.md
+ - docs/user-guide/kubectl/kubectl_create.md
+ - docs/user-guide/kubectl/kubectl_create_configmap.md
+ - docs/user-guide/kubectl/kubectl_create_deployment.md
+ - docs/user-guide/kubectl/kubectl_create_namespace.md
+ - docs/user-guide/kubectl/kubectl_create_quota.md
+ - docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md
+ - docs/user-guide/kubectl/kubectl_create_secret.md
+ - docs/user-guide/kubectl/kubectl_create_secret_generic.md
+ - docs/user-guide/kubectl/kubectl_create_secret_tls.md
+ - docs/user-guide/kubectl/kubectl_create_serviceaccount.md
+ - docs/user-guide/kubectl/kubectl_create_service_clusterip.md
+ - docs/user-guide/kubectl/kubectl_create_service_loadbalancer.md
+ - docs/user-guide/kubectl/kubectl_create_service_nodeport.md
+ - docs/user-guide/kubectl/kubectl_delete.md
+ - docs/user-guide/kubectl/kubectl_describe.md
+ - docs/user-guide/kubectl/kubectl_drain.md
+ - docs/user-guide/kubectl/kubectl_edit.md
+ - docs/user-guide/kubectl/kubectl_exec.md
+ - docs/user-guide/kubectl/kubectl_explain.md
+ - docs/user-guide/kubectl/kubectl_expose.md
+ - docs/user-guide/kubectl/kubectl_get.md
+ - docs/user-guide/kubectl/kubectl_label.md
+ - docs/user-guide/kubectl/kubectl_logs.md
+ - docs/user-guide/kubectl/kubectl_options.md
+ - docs/user-guide/kubectl/kubectl_patch.md
+ - docs/user-guide/kubectl/kubectl_port-forward.md
+ - docs/user-guide/kubectl/kubectl_proxy.md
+ - docs/user-guide/kubectl/kubectl_replace.md
+ - docs/user-guide/kubectl/kubectl_rolling-update.md
+ - docs/user-guide/kubectl/kubectl_rollout.md
+ - docs/user-guide/kubectl/kubectl_rollout_history.md
+ - docs/user-guide/kubectl/kubectl_rollout_pause.md
+ - docs/user-guide/kubectl/kubectl_rollout_resume.md
+ - docs/user-guide/kubectl/kubectl_rollout_status.md
+ - docs/user-guide/kubectl/kubectl_rollout_undo.md
+ - docs/user-guide/kubectl/kubectl_run.md
+ - docs/user-guide/kubectl/kubectl_scale.md
+ - docs/user-guide/kubectl/kubectl_set.md
+ - docs/user-guide/kubectl/kubectl_set_image.md
+ - docs/user-guide/kubectl/kubectl_set_resources.md
+ - docs/user-guide/kubectl/kubectl_taint.md
+ - docs/user-guide/kubectl/kubectl_top.md
+ - docs/user-guide/kubectl/kubectl_top_node.md
+ - docs/user-guide/kubectl/kubectl_top_pod.md
+ - docs/user-guide/kubectl/kubectl_uncordon.md
+ - docs/user-guide/kubectl/kubectl_version.md
- title: Superseded and Deprecated Commands
section:
- - title: kubectl namespace
- path: /docs/user-guide/kubectl/kubectl_namespace/
- - title: kubectl stop
- path: /docs/user-guide/kubectl/kubectl_stop/
+ - /docs/user-guide/kubectl/kubectl_namespace/
+ - docs/user-guide/kubectl/kubectl_stop.md
- title: Kubernetes Components
section:
- - title: kube-apiserver
- path: /docs/admin/kube-apiserver/
- - title: kube-controller-manager
- path: /docs/admin/kube-controller-manager/
- - title: kube-proxy
- path: /docs/admin/kube-proxy/
- - title: kube-scheduler
- path: /docs/admin/kube-scheduler/
+ - docs/admin/kube-apiserver.md
+ - docs/admin/kube-controller-manager.md
+ - docs/admin/kube-proxy.md
+ - docs/admin/kube-scheduler.md
- title: kubelet
section:
- - title: Overview
- path: /docs/admin/kubelet/
- - title: Master-Node communication
- path: /docs/admin/master-node-communication/
- - title: TLS bootstrapping
- path: /docs/admin/kubelet-tls-bootstrapping/
- - title: Kubelet authentication/authorization
- path: /docs/admin/kubelet-authentication-authorization/
+ - docs/admin/kubelet.md
+ - docs/admin/master-node-communication.md
+ - docs/admin/kubelet-tls-bootstrapping.md
+ - docs/admin/kubelet-authentication-authorization.md
- title: Glossary
section:
- - title: Annotations
- path: /docs/user-guide/annotations/
- - title: Daemon Sets
- path: /docs/admin/daemons/
- - title: Deployments
- path: /docs/user-guide/deployments/
- - title: Horizontal Pod Autoscaling
- path: /docs/user-guide/horizontal-pod-autoscaling/
- - title: Images
- path: /docs/user-guide/images/
- - title: Ingress Resources
- path: /docs/user-guide/ingress/
- - title: Jobs
- path: /docs/user-guide/jobs/
- - title: Labels and Selectors
- path: /docs/user-guide/labels/
- - title: Names
- path: /docs/user-guide/identifiers/
- - title: Namespaces
- path: /docs/user-guide/namespaces/
- - title: Network Policies
- path: /docs/user-guide/networkpolicies/
- - title: Nodes
- path: /docs/admin/node/
- - title: Persistent Volumes
- path: /docs/user-guide/persistent-volumes/
- - title: Pet Sets
- path: /docs/user-guide/petset/
- - title: Pods
- path: /docs/user-guide/pods/
- - title: Pod Security Policies
- path: /docs/user-guide/pod-security-policy/
- - title: Replica Sets
- path: /docs/user-guide/replicasets/
- - title: Replication Controller
- path: /docs/user-guide/replication-controller/
- - title: Resource Quotas
- path: /docs/admin/resourcequota/
- - title: Cron Jobs
- path: /docs/user-guide/cron-jobs/
- - title: Secrets
- path: /docs/user-guide/secrets/
- - title: Security Context
- path: /docs/user-guide/security-context/
- - title: Services
- path: /docs/user-guide/services/
- - title: Service Accounts
- path: /docs/user-guide/service-accounts/
- - title: Third Party Resources
- path: /docs/user-guide/thirdpartyresources/
- - title: Volumes
- path: /docs/user-guide/volumes/
+ - docs/user-guide/annotations.md
+ - docs/admin/daemons.md
+ - docs/user-guide/deployments.md
+ - docs/user-guide/horizontal-pod-autoscaling/index.md
+ - docs/user-guide/images.md
+ - docs/user-guide/ingress.md
+ - docs/user-guide/jobs.md
+ - docs/user-guide/labels.md
+ - docs/user-guide/identifiers.md
+ - docs/user-guide/namespaces.md
+ - docs/user-guide/networkpolicies.md
+ - docs/admin/node.md
+ - docs/user-guide/persistent-volumes/index.md
+ - docs/user-guide/petset.md
+ - docs/user-guide/pods/index.md
+ - docs/user-guide/pod-security-policy/index.md
+ - docs/user-guide/replicasets.md
+ - docs/user-guide/replication-controller/index.md
+ - docs/admin/resourcequota/index.md
+ - docs/user-guide/cron-jobs.md
+ - docs/user-guide/secrets/index.md
+ - docs/user-guide/security-context.md
+ - docs/user-guide/services/index.md
+ - docs/user-guide/service-accounts.md
+ - docs/user-guide/thirdpartyresources.md
+ - docs/user-guide/volumes.md
- title: Kubernetes Design Docs
section:
@@ -251,8 +177,7 @@ toc:
path: https://github.com/kubernetes/kubernetes/blob/release-1.3/docs/design/
- title: Kubernetes Identity and Access Management
path: https://github.com/kubernetes/kubernetes/blob/release-1.3/docs/design/access.md
- - title: Kubernetes OpenVSwitch GRE/VxLAN networking
- path: /docs/admin/ovs-networking/
+ - docs/admin/ovs-networking.md
- title: Security Contexts
path: https://github.com/kubernetes/kubernetes/blob/release-1.3/docs/design/security_context.md
- title: Security in Kubernetes
@@ -260,29 +185,18 @@ toc:
- title: Federation
section:
- - title: Federation User Guide
- path: /docs/user-guide/federation/
- - title: Federated ConfigMap
- path: /docs/user-guide/federation/configmap/
- - title: Federated DaemonSet
- path: /docs/user-guide/federation/daemonsets/
- - title: Federated Deployment
- path: /docs/user-guide/federation/deployment/
- - title: Federated Events
- path: /docs/user-guide/federation/events/
- - title: Federated Ingress
- path: /docs/user-guide/federation/federated-ingress/
- - title: Federated Namespaces
- path: /docs/user-guide/federation/namespaces/
- - title: Federated ReplicaSets
- path: /docs/user-guide/federation/replicasets/
- - title: Federated Secrets
- path: /docs/user-guide/federation/secrets/
- - title: Federation API
- path: /docs/federation/api-reference/README/
+ - docs/user-guide/federation/index.md
+ - docs/user-guide/federation/configmap.md
+ - docs/user-guide/federation/daemonsets.md
+ - docs/user-guide/federation/deployment.md
+ - docs/user-guide/federation/events.md
+ - docs/user-guide/federation/federated-ingress.md
+ - docs/user-guide/federation/namespaces.md
+ - docs/user-guide/federation/replicasets.md
+ - docs/user-guide/federation/secrets.md
+ - docs/federation/api-reference/README.md
- title: Federation Components
section:
- - title: federation-apiserver
- path: /docs/admin/federation-apiserver
+ - docs/admin/federation-apiserver.md
- title : federation-controller-mananger
path: /docs/admin/federation-controller-manager
diff --git a/_data/samples.yml b/_data/samples.yml
index 3a9f0bcf28..e94f2b3223 100644
--- a/_data/samples.yml
+++ b/_data/samples.yml
@@ -1,8 +1,7 @@
bigheader: "Samples"
abstract: "A collection of example applications that show how to use Kubernetes."
toc:
-- title: Samples
- path: /docs/samples/
+- docs/samples.md
- title: Storage / Database / KV
section:
@@ -67,8 +66,7 @@ toc:
path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/guestbook-go/
- title: GuestBook - PHP Server
path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/guestbook/
- - title: MEAN stack on Google Cloud Platform
- path: /docs/getting-started-guides/meanstack/
+ - docs/getting-started-guides/meanstack.md
- title: MySQL + Wordpress
path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/mysql-wordpress-pd/
- title: MySQL + Phabricator Server
diff --git a/_data/support.yml b/_data/support.yml
index c019da0ba0..eabd584e33 100644
--- a/_data/support.yml
+++ b/_data/support.yml
@@ -1,38 +1,27 @@
bigheader: "Support"
abstract: "Troubleshooting resources, frequently asked questions, and community support channels."
toc:
-- title: Support
- path: /docs/troubleshooting/
+- docs/troubleshooting.md
- title: Contributing to the Kubernetes Docs
section:
- - title: Creating a Documentation Pull Request
- path: /docs/contribute/create-pull-request/
- - title: Writing a New Topic
- path: /docs/contribute/write-new-topic/
- - title: Staging Your Documentation Changes
- path: /docs/contribute/stage-documentation-changes/
- - title: Using Page Templates
- path: /docs/contribute/page-templates/
- - title: Reviewing Documentation Issues
- path: /docs/contribute/review-issues/
- - title: Documentation Style Guide
- path: /docs/contribute/style-guide/
+ - editdocs.md
+ - docs/contribute/create-pull-request.md
+ - docs/contribute/write-new-topic.md
+ - docs/contribute/stage-documentation-changes.md
+ - docs/contribute/page-templates.md
+ - docs/contribute/review-issues/
+ - docs/contribute/style-guide.md
+
- title: Troubleshooting
section:
- - title: Debugging Pods and Replication Controllers
- path: /docs/user-guide/debugging-pods-and-replication-controllers/
- - title: Application Introspection and Debugging
- path: /docs/user-guide/introspection-and-debugging/
- - title: Retrieving Logs
- path: /docs/user-guide/logging/
- - title: Troubleshooting Applications
- path: /docs/user-guide/application-troubleshooting/
- - title: Troubleshooting Clusters
- path: /docs/admin/cluster-troubleshooting/
- - title: Debugging Services
- path: /docs/user-guide/debugging-services/
+ - docs/user-guide/debugging-pods-and-replication-controllers.md
+ - docs/user-guide/introspection-and-debugging.md
+ - docs/user-guide/logging.md
+ - docs/user-guide/application-troubleshooting.md
+ - docs/admin/cluster-troubleshooting.md
+ - docs/user-guide/debugging-services.md
- title: Frequently Asked Questions
section:
@@ -47,11 +36,11 @@ toc:
section:
- title: Kubernetes Issue Tracker on GitHub
path: https://github.com/kubernetes/kubernetes/issues/
- - title: Report a Security Vulnerability
- path: /docs/reporting-security-issues/
+ - docs/reporting-security-issues.md
- title: Release Notes
path: https://github.com/kubernetes/kubernetes/releases/
- title: Release Roadmap
path: https://github.com/kubernetes/kubernetes/milestones/
- - title: Contributing to Kubernetes Documentation
- path: /editdocs/
+
+- title: Deprecation Policy
+ path: /docs/deprecation-policy.md
diff --git a/_data/tasks.yml b/_data/tasks.yml
index d4f6071bf1..05a880637a 100644
--- a/_data/tasks.yml
+++ b/_data/tasks.yml
@@ -1,56 +1,44 @@
bigheader: "Tasks"
abstract: "Step-by-step instructions for performing operations with Kuberentes."
toc:
-- title: Tasks
- path: /docs/tasks/
+- docs/tasks/index.md
+
- title: Configuring Pods and Containers
section:
- - title: Defining Environment Variables for a Container
- path: /docs/tasks/configure-pod-container/define-environment-variable-container/
- - title: Defining a Command and Arguments for a Container
- path: /docs/tasks/configure-pod-container/define-command-argument-container/
- - title: Assigning CPU and RAM Resources to a Container
- path: /docs/tasks/configure-pod-container/assign-cpu-ram-container/
+ - docs/tasks/configure-pod-container/define-environment-variable-container.md
+ - docs/tasks/configure-pod-container/define-command-argument-container.md
+ - docs/tasks/configure-pod-container/assign-cpu-ram-container.md
+ - docs/tasks/configure-pod-container/configure-volume-storage.md
+ - docs/tasks/configure-pod-container/distribute-credentials-secure.md
+
- title: Accessing Applications in a Cluster
section:
- - title: Using Port Forwarding to Access Applications in a Cluster
- path: /docs/tasks/access-application-cluster/port-forward-access-application-cluster/
-
+ - docs/tasks/access-application-cluster/port-forward-access-application-cluster.md
- title: Debugging Applications in a Cluster
section:
- - title: Determining the Reason for Pod Failure
- path: /docs/tasks/debug-application-cluster/determine-reason-pod-failure/
-
+ - docs/tasks/debug-application-cluster/determine-reason-pod-failure.md
- title: Accessing the Kubernetes API
section:
- - title: Using an HTTP Proxy to Access the Kubernetes API
- path: /docs/tasks/access-kubernetes-api/http-proxy-access-api/
+ - docs/tasks/access-kubernetes-api/http-proxy-access-api.md
- title: Administering a Cluster
section:
- - title: Assigning Pods to Nodes
- path: /docs/tasks/administer-cluster/assign-pods-nodes/
- - title: Autoscaling the DNS Service in a Cluster
- path: /docs/tasks/administer-cluster/dns-horizontal-autoscaling/
- - title: Safely Draining a Node while Respecting Application SLOs
- path: /docs/tasks/administer-cluster/safely-drain-node/
+ - docs/tasks/administer-cluster/assign-pods-nodes.md
+
+ - docs/tasks/administer-cluster/dns-horizontal-autoscaling.md
+ - docs/tasks/administer-cluster/safely-drain-node.md
- title: Managing Stateful Applications
section:
- - title: Upgrading from PetSets to StatefulSets
- path: /docs/tasks/manage-stateful-set/upgrade-pet-set-to-stateful-set/
- - title: Scaling a StatefulSet
- path: /docs/tasks/manage-stateful-set/scale-stateful-set/
- - title: Deleting a Stateful Set
- path: /docs/tasks/manage-stateful-set/deleting-a-statefulset/
- - title: Debugging a StatefulSet
- path: /docs/tasks/manage-stateful-set/debugging-a-statefulset/
- - title: Force Deleting StatefulSet Pods
- path: /docs/tasks/manage-stateful-set/delete-pods/
+ - docs/tasks/manage-stateful-set/upgrade-pet-set-to-stateful-set.md
+ - docs/tasks/manage-stateful-set/scale-stateful-set.md
+ - docs/tasks/manage-stateful-set/deleting-a-statefulset.md
+ - docs/tasks/manage-stateful-set/debugging-a-statefulset.md
+ - docs/tasks/manage-stateful-set/delete-pods.md
- title: Troubleshooting
section:
- - title: Debugging Init Containers
- path: /docs/tasks/troubleshoot/debug-init-containers/
+ - docs/tasks/troubleshoot/debug-init-containers.md
+ - /docs/tasks/administer-cluster/access-control-identity-management/
diff --git a/_data/tools.yml b/_data/tools.yml
index cf2afca34c..31c355e9b0 100644
--- a/_data/tools.yml
+++ b/_data/tools.yml
@@ -1,5 +1,21 @@
bigheader: "Tools"
abstract: "Tools to help you use and enhance Kubernetes."
toc:
-- title: Tools
- path: /docs/tools/
+- docs/tools/index.md
+
+- title: Native Tools
+ section:
+ - title: Kubectl
+ path: /docs/user-guide/kubectl/
+ - title: Kubefed
+ path: /docs/admin/federation/kubefed/
+ - title: Kubernetes Dashboard
+ path: /docs/user-guide/ui/
+
+- title: Third-Party Tools
+ section:
+ - title: Helm
+ path: https://github.com/kubernetes/helm
+ - title: Kompose
+ path: https://github.com/kubernetes-incubator/kompose
+
diff --git a/_data/tutorials.yml b/_data/tutorials.yml
index 41664efa31..08e8b0b46a 100644
--- a/_data/tutorials.yml
+++ b/_data/tutorials.yml
@@ -1,61 +1,43 @@
bigheader: "Tutorials"
abstract: "Detailed walkthroughs of common Kubernetes operations and workflows."
toc:
-- title: Tutorials
- path: /docs/tutorials/
+- docs/tutorials/index.md
- title: Kubernetes Basics
section:
- - title: Overview
- path: /docs/tutorials/kubernetes-basics/
+ - docs/tutorials/kubernetes-basics/index.html
- title: 1. Create a Cluster
section:
- - title: Using Minikube to Create a Cluster
- path: /docs/tutorials/kubernetes-basics/cluster-intro/
- - title: Interactive Tutorial - Creating a Cluster
- path: /docs/tutorials/kubernetes-basics/cluster-interactive/
+ - docs/tutorials/kubernetes-basics/cluster-intro.html
+ - docs/tutorials/kubernetes-basics/cluster-interactive.html
- title: 2. Deploy an App
section:
- - title: Using kubectl to Create a Deployment
- path: /docs/tutorials/kubernetes-basics/deploy-intro/
- - title: Interactive Tutorial - Deploying an App
- path: /docs/tutorials/kubernetes-basics/deploy-interactive/
+ - docs/tutorials/kubernetes-basics/deploy-intro.html
+ - docs/tutorials/kubernetes-basics/deploy-interactive.html
- title: 3. Explore Your App
section:
- - title: Viewing Pods and Nodes
- path: /docs/tutorials/kubernetes-basics/explore-intro/
- - title: Interactive Tutorial - Exploring Your App
- path: /docs/tutorials/kubernetes-basics/explore-interactive/
+ - docs/tutorials/kubernetes-basics/explore-intro.html
+ - docs/tutorials/kubernetes-basics/explore-interactive.html
- title: 4. Expose Your App Publicly
section:
- - title: Using a Service to Expose Your App
- path: /docs/tutorials/kubernetes-basics/expose-intro/
- - title: Interactive Tutorial - Exposing Your App
- path: /docs/tutorials/kubernetes-basics/expose-interactive/
+ - docs/tutorials/kubernetes-basics/expose-intro.html
+ - docs/tutorials/kubernetes-basics/expose-interactive.html
- title: 5. Scale Your App
section:
- - title: Running Multiple Instances of Your App
- path: /docs/tutorials/kubernetes-basics/scale-intro/
- - title: Interactive Tutorial - Scaling Your App
- path: /docs/tutorials/kubernetes-basics/scale-interactive/
+ - docs/tutorials/kubernetes-basics/scale-intro.html
+ - docs/tutorials/kubernetes-basics/scale-interactive.html
- title: 6. Update Your App
section:
- - title: Performing a Rolling Update
- path: /docs/tutorials/kubernetes-basics/update-intro/
- - title: Interactive Tutorial - Updating Your App
- path: /docs/tutorials/kubernetes-basics/update-interactive/
+ - docs/tutorials/kubernetes-basics/update-intro.html
+ - docs/tutorials/kubernetes-basics/update-interactive.html
- title: Stateless Applications
section:
- - title: Running a Stateless Application Using a Deployment
- path: /docs/tutorials/stateless-application/run-stateless-application-deployment/
- - title: Using a Service to Access an Application in a Cluster
- path: /docs/tutorials/stateless-application/expose-external-ip-address-service/
- - title: Exposing an External IP Address to Access an Application in a Cluster
- path: /docs/tutorials/stateless-application/expose-external-ip-address/
+ - docs/tutorials/stateless-application/hello-minikube.md
+ - docs/tutorials/stateless-application/run-stateless-application-deployment.md
+ - docs/tutorials/stateless-application/expose-external-ip-address-service.md
+ - docs/tutorials/stateless-application/expose-external-ip-address.md
- title: Stateful Applications
section:
- - title: StatefulSet Basics
- path: /docs/tutorials/stateful-application/basic-stateful-set/
- - title: Running a Single-Instance Stateful Application
- path: /docs/tutorials/stateful-application/run-stateful-application/
- - title: Running a Replicated Stateful Application
- path: /docs/tutorials/stateful-application/run-replicated-stateful-application/
\ No newline at end of file
+ - docs/tutorials/stateful-application/basic-stateful-set.md
+ - docs/tutorials/stateful-application/run-stateful-application.md
+ - docs/tutorials/stateful-application/run-replicated-stateful-application.md
+ - docs/tutorials/stateful-application/zookeeper.md
diff --git a/_includes/head-header.html b/_includes/head-header.html
index 17a83fa31e..fa859604d2 100644
--- a/_includes/head-header.html
+++ b/_includes/head-header.html
@@ -1,8 +1,6 @@
-{% if page.title %}{% assign title=page.title %}{% endif %}
- {% if !page.no_canonical %}{% endif %}
@@ -14,15 +12,23 @@
- Kubernetes - {{ title }}
+ {% seo %}
+
+ {% else %}
+
+ {% capture whitespace %}
+ {% if item.path %}
+ {% assign path = item.path %}
+ {% assign title = item.title %}
+ {% else %}
+ {% assign found_page = site.pages | where: "path", item | first %}
+ {% assign title = found_page.title %}
+ {% assign path = found_page.url %}
+ {% endif %}
+ {% endcapture %}
+
+ {% if path %}
+
+ {% endif %}
+ {% endif %}
+{% endfor %}
diff --git a/_includes/v1.3/extensions-v1beta1-definitions.html b/_includes/v1.3/extensions-v1beta1-definitions.html
index 7ecddc8d7b..92ce832083 100755
--- a/_includes/v1.3/extensions-v1beta1-definitions.html
+++ b/_includes/v1.3/extensions-v1beta1-definitions.html
@@ -2079,7 +2079,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
v1.FlexVolumeSource
-
FlexVolume represents a generic volume resource that is provisioned/attached using a exec based plugin. This is an alpha feature and may change in future.
+
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.
@@ -2535,7 +2535,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
flexVolume
-
FlexVolume represents a generic volume resource that is provisioned/attached using a exec based plugin. This is an alpha feature and may change in future.
+
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.
@@ -5867,7 +5867,7 @@ Both these may change in the future. Incoming requests are matched against the h
path
-
Path is a 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.
+
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.
diff --git a/_includes/v1.3/v1-definitions.html b/_includes/v1.3/v1-definitions.html
index e833b003ea..693f3ce4c7 100755
--- a/_includes/v1.3/v1-definitions.html
+++ b/_includes/v1.3/v1-definitions.html
@@ -2560,7 +2560,7 @@ The resulting set of endpoints can be viewed as:
v1.FlexVolumeSource
-
FlexVolume represents a generic volume resource that is provisioned/attached using a exec based plugin. This is an alpha feature and may change in future.
+
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.
@@ -3268,7 +3268,7 @@ The resulting set of endpoints can be viewed as:
flexVolume
-
FlexVolume represents a generic volume resource that is provisioned/attached using a exec based plugin. This is an alpha feature and may change in future.
+
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.
@@ -5555,7 +5555,7 @@ The resulting set of endpoints can be viewed as:
flexVolume
-
FlexVolume represents a generic volume resource that is provisioned/attached using a exec based plugin. This is an alpha feature and may change in future.
+
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.
diff --git a/_includes/v1.4/extensions-v1beta1-definitions.html b/_includes/v1.4/extensions-v1beta1-definitions.html
index 62b899b9fd..18bc35fc59 100755
--- a/_includes/v1.4/extensions-v1beta1-definitions.html
+++ b/_includes/v1.4/extensions-v1beta1-definitions.html
@@ -6054,7 +6054,7 @@ Both these may change in the future. Incoming requests are matched against the h
path
-
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.
+
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.
DesiredNumberScheduled is the total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
+
true
+
integer (int32)
+
+
+
+
numberReady
+
NumberReady is the number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
+
true
+
integer (int32)
+
+
+
+
+
+
+
+
v1beta1.Job
+
+
Job represents the configuration of a single job. DEPRECATED: extensions/v1beta1.Job is deprecated, use batch/v1.Job instead.
ObjectFieldSelector selects an APIVersioned field of an object.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
apiVersion
+
Version of the schema the FieldPath is written in terms of, defaults to "v1".
+
false
+
string
+
+
+
+
fieldPath
+
Path of the field to select in the specified API version.
+
true
+
string
+
+
+
+
+
+
+
+
v1.SELinuxOptions
+
+
SELinuxOptions are the labels to be applied to the container
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
user
+
User is a SELinux user label that applies to the container.
+
false
+
string
+
+
+
+
role
+
Role is a SELinux role label that applies to the container.
+
false
+
string
+
+
+
+
type
+
Type is a SELinux type label that applies to the container.
+
false
+
string
+
+
+
+
level
+
Level is SELinux level label that applies to the container.
+
false
+
string
+
+
+
+
+
+
+
+
v1.VolumeMount
+
+
VolumeMount describes a mounting of a Volume within a container.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
name
+
This must match the Name of a Volume.
+
true
+
string
+
+
+
+
readOnly
+
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
+
false
+
boolean
+
false
+
+
+
mountPath
+
Path within the container at which the volume should be mounted. Must not contain :.
+
true
+
string
+
+
+
+
subPath
+
Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).
+
false
+
string
+
+
+
+
+
+
+
+
v1beta1.IngressSpec
+
+
IngressSpec describes the Ingress the user wishes to exist.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
backend
+
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.
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.
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.
+
false
+
integer (int32)
+
+
+
+
+
+
+
+
unversioned.StatusCause
+
+
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
reason
+
A machine-readable description of the cause of the error. If this value is empty there is no information available.
+
false
+
string
+
+
+
+
message
+
A human-readable description of the cause of the error. This field may be presented as-is to a reader.
+
false
+
string
+
+
+
+
field
+
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"
+
false
+
string
+
+
+
+
+
+
+
+
v1beta1.ReplicaSetCondition
+
+
ReplicaSetCondition describes the state of a replica set at a certain point.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
type
+
Type of replica set condition.
+
true
+
string
+
+
+
+
status
+
Status of the condition, one of True, False, Unknown.
+
true
+
string
+
+
+
+
lastTransitionTime
+
The last time the condition transitioned from one status to another.
+
false
+
string (date-time)
+
+
+
+
reason
+
The reason for the condition’s last transition.
+
false
+
string
+
+
+
+
message
+
A human readable message indicating details about the transition.
+
false
+
string
+
+
+
+
+
+
+
+
v1beta1.NetworkPolicyList
+
+
Network Policy List is a list of NetworkPolicy objects.
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.
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: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
+
false
+
string
+
+
+
+
partition
+
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: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
Spec to control the desired behavior of rolling update.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
maxUnavailable
+
The 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 up. 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.
+
false
+
string
+
+
+
+
maxSurge
+
The 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.
+
false
+
string
+
+
+
+
+
+
+
+
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 #.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
paths
+
A collection of paths that map requests to backends.
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.
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. Paths must be relative and may not contain the .. path or start with ...
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.
+
false
+
integer (int32)
+
+
+
+
+
+
+
+
v1.GitRepoVolumeSource
+
+
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.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
repository
+
Repository URL
+
true
+
string
+
+
+
+
revision
+
Commit hash for the specified revision.
+
false
+
string
+
+
+
+
directory
+
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.
StartTime represents time when the job was acknowledged by the Job Manager. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
+
false
+
string (date-time)
+
+
+
+
completionTime
+
CompletionTime 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.
+
false
+
string (date-time)
+
+
+
+
active
+
Active is the number of actively running pods.
+
false
+
integer (int32)
+
+
+
+
succeeded
+
Succeeded is the number of pods which reached Phase Succeeded.
+
false
+
integer (int32)
+
+
+
+
failed
+
Failed is the number of pods which reached Phase Failed.
+
false
+
integer (int32)
+
+
+
+
+
+
+
+
v1.Capabilities
+
+
Adds and removes POSIX capabilities from running containers.
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.
+
false
+
string array
+
+
+
+
+
+
+
v1.ObjectMeta
+
+
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
name
+
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
+
false
+
string
+
+
+
+
generateName
+
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency
+
false
+
string
+
+
+
+
namespace
+
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
+
false
+
string
+
+
+
+
selfLink
+
SelfLink is a URL representing this object. Populated by the system. Read-only.
+
false
+
string
+
+
+
+
uid
+
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
+
false
+
string
+
+
+
+
resourceVersion
+
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency
+
false
+
string
+
+
+
+
generation
+
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
+
false
+
integer (int64)
+
+
+
+
creationTimestamp
+
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
+
false
+
string (date-time)
+
+
+
+
deletionTimestamp
+
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
+
+Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
+
false
+
string (date-time)
+
+
+
+
deletionGracePeriodSeconds
+
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.
+
false
+
integer (int64)
+
+
+
+
labels
+
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
+
false
+
object
+
+
+
+
annotations
+
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
+
false
+
object
+
+
+
+
ownerReferences
+
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.
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.
+
false
+
string array
+
+
+
+
clusterName
+
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.
+
false
+
string
+
+
+
+
+
+
+
+
v1beta1.ReplicaSetSpec
+
+
ReplicaSetSpec is the specification of a ReplicaSet.
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)
+
false
+
integer (int32)
+
+
+
+
selector
+
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: http://kubernetes.io/docs/user-guide/labels#label-selectors
Template is the 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: http://kubernetes.io/docs/user-guide/replication-controller#pod-template
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
secretName
+
the name of secret that contains Azure Storage Account Name and Key
+
true
+
string
+
+
+
+
shareName
+
Share Name
+
true
+
string
+
+
+
+
readOnly
+
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+
false
+
boolean
+
false
+
+
+
+
+
+
+
types.UID
+
+
+
+
v1.ISCSIVolumeSource
+
+
Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
targetPortal
+
iSCSI target portal. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
+
true
+
string
+
+
+
+
iqn
+
Target iSCSI Qualified Name.
+
true
+
string
+
+
+
+
lun
+
iSCSI target lun number.
+
true
+
integer (int32)
+
+
+
+
iscsiInterface
+
Optional: Defaults to default (tcp). iSCSI interface name that uses an iSCSI transport.
+
false
+
string
+
+
+
+
fsType
+
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: http://kubernetes.io/docs/user-guide/volumes#iscsi
+
false
+
string
+
+
+
+
readOnly
+
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
+
false
+
boolean
+
false
+
+
+
+
+
+
+
v1.EmptyDirVolumeSource
+
+
Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
medium
+
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: http://kubernetes.io/docs/user-guide/volumes#emptydir
desired number of instances for the scaled object.
+
false
+
integer (int32)
+
+
+
+
+
+
+
+
unversioned.Patch
+
+
Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.
+
+
+
+
v1.FlockerVolumeSource
+
+
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.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
datasetName
+
Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated
+
false
+
string
+
+
+
+
datasetUUID
+
UUID of the dataset. This is unique identifier of a Flocker dataset
+
false
+
string
+
+
+
+
+
+
+
+
v1.PersistentVolumeClaimVolumeSource
+
+
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).
Will force the ReadOnly setting in VolumeMounts. Default false.
+
false
+
boolean
+
false
+
+
+
+
+
+
+
unversioned.ListMeta
+
+
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
selfLink
+
SelfLink is a URL representing this object. Populated by the system. Read-only.
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.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
matchLabels
+
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.
+
false
+
object
+
+
+
+
matchExpressions
+
matchExpressions is a list of label selector requirements. The requirements are ANDed.
The revision to rollback to. If set to 0, rollbck to the last revision.
+
false
+
integer (int64)
+
+
+
+
+
+
+
+
v1.SecretVolumeSource
+
+
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.
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. Paths must be relative and may not contain the .. path or start with ...
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.
+
false
+
integer (int32)
+
+
+
+
+
+
+
+
v1.EnvVarSource
+
+
EnvVarSource represents a source for the value of an EnvVar.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
fieldRef
+
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
driver
+
Driver is the name of the driver to use for this volume.
+
true
+
string
+
+
+
+
fsType
+
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.
+
false
+
string
+
+
+
+
secretRef
+
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.
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.
+
false
+
string
+
+
+
+
readOnly
+
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+
false
+
boolean
+
false
+
+
+
+
+
+
+
v1.KeyToPath
+
+
Maps a string key to a path within a volume.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
key
+
The key to project.
+
true
+
string
+
+
+
+
path
+
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 ...
+
true
+
string
+
+
+
+
mode
+
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.
+
false
+
integer (int32)
+
+
+
+
+
+
+
+
v1.VsphereVirtualDiskVolumeSource
+
+
Represents a vSphere volume resource.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
volumePath
+
Path that identifies vSphere volume vmdk
+
true
+
string
+
+
+
+
fsType
+
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.
+
false
+
string
+
+
+
+
+
+
+
+
v1.DeleteOptions
+
+
DeleteOptions may be provided when deleting an API object
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.
+
false
+
integer (int64)
+
+
+
+
preconditions
+
Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
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: http://kubernetes.io/docs/user-guide/volumes#hostpath
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+
false
+
integer (int32)
+
+
+
+
successThreshold
+
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.
+
false
+
integer (int32)
+
+
+
+
failureThreshold
+
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+
false
+
integer (int32)
+
+
+
+
+
+
+
+
v1beta1.DeploymentSpec
+
+
DeploymentSpec is the specification of the desired behavior of the Deployment.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
replicas
+
Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
+
false
+
integer (int32)
+
+
+
+
selector
+
Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment.
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)
+
false
+
integer (int32)
+
+
+
+
revisionHistoryLimit
+
The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified.
+
false
+
integer (int32)
+
+
+
+
paused
+
Indicates that the deployment is paused and will not be processed by the deployment controller.
+
false
+
boolean
+
false
+
+
+
rollbackTo
+
The config this deployment is rolling back to. Will be cleared after rollback is done.
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. Once autoRollback is implemented, the deployment controller will automatically rollback failed deployments. Note that progress will not be estimated during the time a deployment is paused. This is not set by default.
+
false
+
integer (int32)
+
+
+
+
+
+
+
+
unversioned.APIResourceList
+
+
APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.
The key of the secret to select from. Must be a valid secret key.
+
true
+
string
+
+
+
+
+
+
+
+
v1.Capability
+
+
+
+
unversioned.APIResource
+
+
APIResource specifies the name of a resource and whether it is namespaced.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
name
+
name is the name of the resource.
+
true
+
string
+
+
+
+
namespaced
+
namespaced indicates if a resource is namespaced or not.
+
true
+
boolean
+
false
+
+
+
kind
+
kind is the kind for the resource (e.g. Foo is the kind for a resource foo)
+
true
+
string
+
+
+
+
+
+
+
+
v1.DownwardAPIVolumeFile
+
+
DownwardAPIVolumeFile represents information to create the file containing the pod field
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
path
+
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 ..
+
true
+
string
+
+
+
+
fieldRef
+
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
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.
+
false
+
integer (int32)
+
+
+
+
+
+
+
+
v1.ContainerPort
+
+
ContainerPort represents a network port in a single container.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
name
+
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.
+
false
+
string
+
+
+
+
hostPort
+
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.
+
false
+
integer (int32)
+
+
+
+
containerPort
+
Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.
+
true
+
integer (int32)
+
+
+
+
protocol
+
Protocol for port. Must be UDP or TCP. Defaults to "TCP".
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. More info: http://kubernetes.io/docs/user-guide/containers
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.
+
false
+
integer (int64)
+
+
+
+
activeDeadlineSeconds
+
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.
+
false
+
integer (int64)
+
+
+
+
dnsPolicy
+
Set DNS policy for containers within the pod. One of ClusterFirst or Default. Defaults to "ClusterFirst".
DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
+
false
+
string
+
+
+
+
nodeName
+
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.
+
false
+
string
+
+
+
+
hostNetwork
+
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.
+
false
+
boolean
+
false
+
+
+
hostPID
+
Use the host’s pid namespace. Optional: Default to false.
+
false
+
boolean
+
false
+
+
+
hostIPC
+
Use the host’s ipc namespace. Optional: Default to false.
+
false
+
boolean
+
false
+
+
+
securityContext
+
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
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: http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.
+
false
+
string
+
+
+
+
subdomain
+
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.
+
false
+
string
+
+
+
+
+
+
+
+
v1.Lifecycle
+
+
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.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
postStart
+
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: http://kubernetes.io/docs/user-guide/container-environment#hook-details
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: http://kubernetes.io/docs/user-guide/container-environment#hook-details
IngressTLS describes the transport layer security associated with an Ingress.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
hosts
+
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.
+
false
+
string array
+
+
+
+
secretName
+
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.
+
false
+
string
+
+
+
+
+
+
+
+
v1beta1.SubresourceReference
+
+
SubresourceReference contains enough information to let you inspect or modify the referred subresource.
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: http://kubernetes.io/docs/user-guide/volumes#rbd
Represents a Photon Controller persistent disk resource.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
pdID
+
ID that identifies Photon Controller persistent disk
+
true
+
string
+
+
+
+
fsType
+
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.
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: http://kubernetes.io/docs/user-guide/labels#label-selectors
+
false
+
string
+
+
+
+
+
+
+
+
v1beta1.NetworkPolicySpec
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
podSelector
+
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.
List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if namespace.networkPolicy.ingress.isolation is undefined and cluster policy allows it, 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 affect ingress isolation. If this field is present and contains at least one rule, this policy allows any traffic which matches at least one of the ingress rules in this list.
HTTPHeader describes a custom header to be used in HTTP probes
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
name
+
The header field name
+
true
+
string
+
+
+
+
value
+
The header field value
+
true
+
string
+
+
+
+
+
+
+
+
v1beta1.HorizontalPodAutoscalerStatus
+
+
current status of a horizontal pod autoscaler
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
observedGeneration
+
most recent generation observed by this autoscaler.
+
false
+
integer (int64)
+
+
+
+
lastScaleTime
+
last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed.
+
false
+
string (date-time)
+
+
+
+
currentReplicas
+
current number of replicas of pods managed by this autoscaler.
+
true
+
integer (int32)
+
+
+
+
desiredReplicas
+
desired number of replicas of pods managed by this autoscaler.
+
true
+
integer (int32)
+
+
+
+
currentCPUUtilizationPercentage
+
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.
+
false
+
integer (int32)
+
+
+
+
+
+
+
+
v1.FCVolumeSource
+
+
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.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
targetWWNs
+
Required: FC target worldwide names (WWNs)
+
true
+
string array
+
+
+
+
lun
+
Required: FC target lun number
+
true
+
integer (int32)
+
+
+
+
fsType
+
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.
+
false
+
string
+
+
+
+
readOnly
+
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+
false
+
boolean
+
false
+
+
+
+
+
+
+
v1beta1.ThirdPartyResource
+
+
A ThirdPartyResource is a generic representation of a resource, it is used by add-ons and plugins to add new resource types to the API. It consists of one or more Versions of the api.
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.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
host
+
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.
This is a label selector which selects Pods in this namespace. This field follows standard label selector semantics. If not provided, this selector selects no pods. If present but empty, this selector selects all pods in this namespace.
Selects Namespaces using cluster scoped-labels. This matches all pods in all namespaces selected by this label selector. This field follows standard label selector semantics. If omitted, this selector selects no namespaces. If present but empty, this selector selects all namespaces.
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.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
name
+
The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
+
false
+
string
+
+
+
+
group
+
The group attribute of the resource associated with the status StatusReason.
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: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
+
false
+
string array
+
+
+
+
args
+
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: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
+
false
+
string array
+
+
+
+
workingDir
+
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.
+
false
+
string
+
+
+
+
ports
+
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.
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. Defaults to /dev/termination-log. Cannot be updated.
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.
+
false
+
boolean
+
false
+
+
+
stdinOnce
+
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
+
false
+
boolean
+
false
+
+
+
tty
+
Whether this container should allocate a TTY for itself, also requires stdin to be true. Default is false.
+
false
+
boolean
+
false
+
+
+
+
+
+
+
v1.PodSecurityContext
+
+
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.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
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.
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.
+
false
+
integer (int64)
+
+
+
+
runAsNonRoot
+
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.
+
false
+
boolean
+
false
+
+
+
supplementalGroups
+
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.
+
false
+
integer (int32) array
+
+
+
+
fsGroup
+
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
+
false
+
integer (int64)
+
+
+
+
+
+
+
+
v1beta1.NetworkPolicyIngressRule
+
+
This NetworkPolicyIngressRule matches traffic if and only if the traffic matches both ports AND from.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
ports
+
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 not provided, this rule matches all ports (traffic not restricted by port). If this field is empty, this rule matches no ports (no traffic matches). 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.
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 not provided, this rule matches all sources (traffic not restricted by source). If this field is empty, this rule matches no sources (no traffic matches). 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.
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.
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.
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.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
capabilities
+
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
+
false
+
boolean
+
false
+
+
+
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.
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.
+
false
+
integer (int64)
+
+
+
+
runAsNonRoot
+
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.
+
false
+
boolean
+
false
+
+
+
readOnlyRootFilesystem
+
Whether this container has a read-only root filesystem. Default is false.
+
false
+
boolean
+
false
+
+
+
+
+
+
+
v1.Protocol
+
+
+
+
v1.AWSElasticBlockStoreVolumeSource
+
+
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.
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: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
+
false
+
string
+
+
+
+
partition
+
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).
reference to Scale subresource; horizontal pod autoscaler will learn the current resource consumption from its status, and will set the desired number of pods by modifying its spec.
lower limit for the number of pods that can be set by the autoscaler, default 1.
+
false
+
integer (int32)
+
+
+
+
maxReplicas
+
upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.
+
true
+
integer (int32)
+
+
+
+
cpuUtilization
+
target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified it defaults to the target CPU utilization at 80% of the requested resources.
Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
registry
+
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
+
true
+
string
+
+
+
+
volume
+
Volume is a string that references an already created Quobyte volume by name.
+
true
+
string
+
+
+
+
readOnly
+
ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
+
false
+
boolean
+
false
+
+
+
user
+
User to map volume access to Defaults to serivceaccount user
+
false
+
string
+
+
+
+
group
+
Group to map volume access to Default is no group
+
false
+
string
+
+
+
+
+
+
+
+
v1.EnvVar
+
+
EnvVar represents an environment variable present in a Container.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
name
+
Name of the environment variable. Must be a C_IDENTIFIER.
+
true
+
string
+
+
+
+
value
+
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 "".
+
false
+
string
+
+
+
+
valueFrom
+
Source for the environment variable’s value. Cannot be used if value is not empty.
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: http://kubernetes.io/docs/user-guide/compute-resources/
+
false
+
object
+
+
+
+
+
+
+
+
v1.PodTemplateSpec
+
+
PodTemplateSpec describes the data a pod should have when created from a template
If 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.
+
false
+
string
+
+
+
+
+
+
+
+
v1beta1.DeploymentCondition
+
+
DeploymentCondition describes the state of a deployment at a certain point.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
type
+
Type of deployment condition.
+
true
+
string
+
+
+
+
status
+
Status of the condition, one of True, False, Unknown.
+
true
+
string
+
+
+
+
lastUpdateTime
+
The last time this condition was updated.
+
false
+
string (date-time)
+
+
+
+
lastTransitionTime
+
Last time the condition transitioned from one status to another.
+
false
+
string (date-time)
+
+
+
+
reason
+
The reason for the condition’s last transition.
+
false
+
string
+
+
+
+
message
+
A human readable message indicating details about the transition.
+
false
+
string
+
+
+
+
+
+
+
+
v1beta1.JobSpec
+
+
JobSpec describes how the job execution will look like.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
parallelism
+
Parallelism 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: http://kubernetes.io/docs/user-guide/jobs
+
false
+
integer (int32)
+
+
+
+
completions
+
Completions 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: http://kubernetes.io/docs/user-guide/jobs
+
false
+
integer (int32)
+
+
+
+
activeDeadlineSeconds
+
Optional 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
AutoSelector controls generation of pod labels and pod selectors. It was not present in the original extensions/v1beta1 Job definition, but exists to allow conversion from batch/v1 Jobs, where it corresponds to, but has the opposite meaning as, ManualSelector. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
key
+
key is the label key that the selector applies to.
+
true
+
string
+
+
+
+
operator
+
operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.
+
true
+
string
+
+
+
+
values
+
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.
+
false
+
string array
+
+
+
+
+
+
+
+
unversioned.Status
+
+
Status is a return value for calls that don’t return other objects.
A human-readable description of the status of this operation.
+
false
+
string
+
+
+
+
reason
+
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.
+
false
+
string
+
+
+
+
details
+
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.
HTTPIngressPath associates a path regex with a backend. Incoming urls matching the path are forwarded to the backend.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
path
+
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.
+
false
+
string
+
+
+
+
backend
+
Backend defines the referenced service endpoint to which the traffic will be forwarded to.
Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
list or watch objects of kind HorizontalPodAutoscaler
+
+
+
GET /apis/extensions/v1beta1/horizontalpodautoscalers
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
list or watch objects of kind HorizontalPodAutoscaler
+
+
+
GET /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /apis/extensions/v1beta1/namespaces/{namespace}/jobs
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
watch individual changes to a list of HorizontalPodAutoscaler
+
+
+
GET /apis/extensions/v1beta1/watch/horizontalpodautoscalers
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/deployments
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/deployments/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
watch individual changes to a list of HorizontalPodAutoscaler
+
+
+
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/horizontalpodautoscalers
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
watch changes to an object of kind HorizontalPodAutoscaler
+
+
+
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/jobs
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/jobs/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
watch individual changes to a list of NetworkPolicy
+
+
+
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
watch individual changes to a list of NetworkPolicy
+
+
+
GET /apis/extensions/v1beta1/watch/networkpolicies
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
watch individual changes to a list of ThirdPartyResource
+
+
+
GET /apis/extensions/v1beta1/watch/thirdpartyresources
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
watch changes to an object of kind ThirdPartyResource
+
+
+
GET /apis/extensions/v1beta1/watch/thirdpartyresources/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
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.
+
false
+
integer (int32)
+
+
+
+
+
+
+
+
unversioned.StatusCause
+
+
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
reason
+
A machine-readable description of the cause of the error. If this value is empty there is no information available.
+
false
+
string
+
+
+
+
message
+
A human-readable description of the cause of the error. This field may be presented as-is to a reader.
+
false
+
string
+
+
+
+
field
+
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"
+
false
+
string
+
+
+
+
+
+
+
+
v1.GCEPersistentDiskVolumeSource
+
+
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.
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: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
+
false
+
string
+
+
+
+
partition
+
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: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
A human-readable message indicating details about why the volume is in this state.
+
false
+
string
+
+
+
+
reason
+
Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.
+
false
+
string
+
+
+
+
+
+
+
+
v1.ConfigMapVolumeSource
+
+
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.
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. Paths must be relative and may not contain the .. path or start with ...
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.
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.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
repository
+
Repository URL
+
true
+
string
+
+
+
+
revision
+
Commit hash for the specified revision.
+
false
+
string
+
+
+
+
directory
+
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.
+
false
+
string
+
+
+
+
+
+
+
+
v1.ReplicationControllerCondition
+
+
ReplicationControllerCondition describes the state of a replication controller at a certain point.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
type
+
Type of replication controller condition.
+
true
+
string
+
+
+
+
status
+
Status of the condition, one of True, False, Unknown.
+
true
+
string
+
+
+
+
lastTransitionTime
+
The last time the condition transitioned from one status to another.
+
false
+
string (date-time)
+
+
+
+
reason
+
The reason for the condition’s last transition.
+
false
+
string
+
+
+
+
message
+
A human readable message indicating details about the transition.
+
false
+
string
+
+
+
+
+
+
+
+
v1.ScaleStatus
+
+
ScaleStatus represents the current status of a scale subresource.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
replicas
+
actual number of observed instances of the scaled object.
+
true
+
integer (int32)
+
+
+
+
selector
+
label query over pods that should match the replicas count. This is same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors
+
false
+
string
+
+
+
+
+
+
+
+
v1.Capabilities
+
+
Adds and removes POSIX capabilities from running containers.
Used is the current observed total usage of the resource in the namespace.
+
false
+
object
+
+
+
+
+
+
+
+
v1.ExecAction
+
+
ExecAction describes a "run in container" action.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
command
+
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.
+
false
+
string array
+
+
+
+
+
+
+
v1.ObjectMeta
+
+
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
name
+
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
+
false
+
string
+
+
+
+
generateName
+
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency
+
false
+
string
+
+
+
+
namespace
+
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
+
false
+
string
+
+
+
+
selfLink
+
SelfLink is a URL representing this object. Populated by the system. Read-only.
+
false
+
string
+
+
+
+
uid
+
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
+
false
+
string
+
+
+
+
resourceVersion
+
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency
+
false
+
string
+
+
+
+
generation
+
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
+
false
+
integer (int64)
+
+
+
+
creationTimestamp
+
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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
+
false
+
string (date-time)
+
+
+
+
deletionTimestamp
+
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
+
+Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
+
false
+
string (date-time)
+
+
+
+
deletionGracePeriodSeconds
+
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.
+
false
+
integer (int64)
+
+
+
+
labels
+
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
+
false
+
object
+
+
+
+
annotations
+
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
+
false
+
object
+
+
+
+
ownerReferences
+
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.
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.
+
false
+
string array
+
+
+
+
clusterName
+
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.
+
false
+
string
+
+
+
+
+
+
+
+
v1.LimitRangeSpec
+
+
LimitRangeSpec defines a min/max usage limit for resources that match on kind.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
limits
+
Limits is the list of LimitRangeItem objects that are enforced.
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
secretName
+
the name of secret that contains Azure Storage Account Name and Key
+
true
+
string
+
+
+
+
shareName
+
Share Name
+
true
+
string
+
+
+
+
readOnly
+
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+
false
+
boolean
+
false
+
+
+
+
+
+
+
v1.ISCSIVolumeSource
+
+
Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
targetPortal
+
iSCSI target portal. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
+
true
+
string
+
+
+
+
iqn
+
Target iSCSI Qualified Name.
+
true
+
string
+
+
+
+
lun
+
iSCSI target lun number.
+
true
+
integer (int32)
+
+
+
+
iscsiInterface
+
Optional: Defaults to default (tcp). iSCSI interface name that uses an iSCSI transport.
+
false
+
string
+
+
+
+
fsType
+
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: http://kubernetes.io/docs/user-guide/volumes#iscsi
+
false
+
string
+
+
+
+
readOnly
+
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
+
false
+
boolean
+
false
+
+
+
+
+
+
+
v1.EmptyDirVolumeSource
+
+
Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
medium
+
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: http://kubernetes.io/docs/user-guide/volumes#emptydir
+
false
+
string
+
+
+
+
+
+
+
+
v1.NodeList
+
+
NodeList is the whole list of all Nodes which have been registered with master.
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.
ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets
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: http://kubernetes.io/docs/user-guide/secrets#manually-specifying-an-imagepullsecret
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.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
datasetName
+
Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated
+
false
+
string
+
+
+
+
datasetUUID
+
UUID of the dataset. This is unique identifier of a Flocker dataset
+
false
+
string
+
+
+
+
+
+
+
+
v1.PersistentVolumeClaimVolumeSource
+
+
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).
Will force the ReadOnly setting in VolumeMounts. Default false.
+
false
+
boolean
+
false
+
+
+
+
+
+
+
unversioned.ListMeta
+
+
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
selfLink
+
SelfLink is a URL representing this object. Populated by the system. Read-only.
Represents the actual resources of the underlying volume.
+
false
+
object
+
+
+
+
+
+
+
+
v1.UniqueVolumeName
+
+
+
+
unversioned.LabelSelector
+
+
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.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
matchLabels
+
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.
+
false
+
object
+
+
+
+
matchExpressions
+
matchExpressions is a list of label selector requirements. The requirements are ANDed.
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 ]
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
addresses
+
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.
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.
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.
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. Paths must be relative and may not contain the .. path or start with ...
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.
+
false
+
integer (int32)
+
+
+
+
+
+
+
+
v1.FlexVolumeSource
+
+
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
driver
+
Driver is the name of the driver to use for this volume.
+
true
+
string
+
+
+
+
fsType
+
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.
+
false
+
string
+
+
+
+
secretRef
+
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.
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+
false
+
boolean
+
false
+
+
+
options
+
Optional: Extra command options if any.
+
false
+
object
+
+
+
+
+
+
+
+
v1.EnvVarSource
+
+
EnvVarSource represents a source for the value of an EnvVar.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
fieldRef
+
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
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.
+
false
+
string
+
+
+
+
readOnly
+
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+
false
+
boolean
+
false
+
+
+
+
+
+
+
v1.KeyToPath
+
+
Maps a string key to a path within a volume.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
key
+
The key to project.
+
true
+
string
+
+
+
+
path
+
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 ...
+
true
+
string
+
+
+
+
mode
+
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.
+
false
+
integer (int32)
+
+
+
+
+
+
+
+
v1.Service
+
+
Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.
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.
+
false
+
string
+
+
+
+
+
+
+
+
v1.ServiceAccountList
+
+
ServiceAccountList is a list of ServiceAccount objects
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.
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.
+
false
+
integer (int64)
+
+
+
+
preconditions
+
Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
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: http://kubernetes.io/docs/user-guide/volumes#hostpath
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
+
false
+
integer (int32)
+
+
+
+
successThreshold
+
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.
+
false
+
integer (int32)
+
+
+
+
failureThreshold
+
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+
false
+
integer (int32)
+
+
+
+
+
+
+
+
unversioned.APIResourceList
+
+
APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.
DownwardAPIVolumeFile represents information to create the file containing the pod field
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
path
+
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 ..
+
true
+
string
+
+
+
+
fieldRef
+
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
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.
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. More info: http://kubernetes.io/docs/user-guide/containers
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.
+
false
+
integer (int64)
+
+
+
+
activeDeadlineSeconds
+
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.
+
false
+
integer (int64)
+
+
+
+
dnsPolicy
+
Set DNS policy for containers within the pod. One of ClusterFirst or Default. Defaults to "ClusterFirst".
DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
+
false
+
string
+
+
+
+
nodeName
+
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.
+
false
+
string
+
+
+
+
hostNetwork
+
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.
+
false
+
boolean
+
false
+
+
+
hostPID
+
Use the host’s pid namespace. Optional: Default to false.
+
false
+
boolean
+
false
+
+
+
hostIPC
+
Use the host’s ipc namespace. Optional: Default to false.
+
false
+
boolean
+
false
+
+
+
securityContext
+
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
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: http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.
+
false
+
string
+
+
+
+
subdomain
+
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.
+
false
+
string
+
+
+
+
+
+
+
+
v1.ContainerPort
+
+
ContainerPort represents a network port in a single container.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
name
+
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.
+
false
+
string
+
+
+
+
hostPort
+
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.
+
false
+
integer (int32)
+
+
+
+
containerPort
+
Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.
+
true
+
integer (int32)
+
+
+
+
protocol
+
Protocol for port. Must be UDP or TCP. Defaults to "TCP".
+
false
+
string
+
+
+
+
hostIP
+
What host IP to bind the external port to.
+
false
+
string
+
+
+
+
+
+
+
+
v1.ResourceQuota
+
+
ResourceQuota sets aggregate quota restrictions enforced per namespace
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.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
postStart
+
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: http://kubernetes.io/docs/user-guide/container-environment#hook-details
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: http://kubernetes.io/docs/user-guide/container-environment#hook-details
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)
+
false
+
integer (int32)
+
+
+
+
selector
+
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: http://kubernetes.io/docs/user-guide/labels#label-selectors
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: http://kubernetes.io/docs/user-guide/volumes#rbd
Represents a Photon Controller persistent disk resource.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
pdID
+
ID that identifies Photon Controller persistent disk
+
true
+
string
+
+
+
+
fsType
+
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.
+
false
+
string
+
+
+
+
+
+
+
+
versioned.Event
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
type
+
+
true
+
string
+
+
+
+
object
+
+
true
+
string
+
+
+
+
+
+
+
+
v1.PodTemplate
+
+
PodTemplate describes a template for creating copies of a predefined pod.
HTTPHeader describes a custom header to be used in HTTP probes
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
name
+
The header field name
+
true
+
string
+
+
+
+
value
+
The header field value
+
true
+
string
+
+
+
+
+
+
+
+
v1.FCVolumeSource
+
+
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.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
targetWWNs
+
Required: FC target worldwide names (WWNs)
+
true
+
string array
+
+
+
+
lun
+
Required: FC target lun number
+
true
+
integer (int32)
+
+
+
+
fsType
+
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.
+
false
+
string
+
+
+
+
readOnly
+
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
+
false
+
boolean
+
false
+
+
+
+
+
+
+
v1.EndpointPort
+
+
EndpointPort is a tuple that describes a single port.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
name
+
The name of this port (corresponds to ServicePort.Name). Must be a DNS_LABEL. Optional only if one port is defined.
+
false
+
string
+
+
+
+
port
+
The port number of the endpoint.
+
true
+
integer (int32)
+
+
+
+
protocol
+
The IP protocol for this port. Must be UDP or TCP. Default is TCP.
+
false
+
string
+
+
+
+
+
+
+
+
v1.TCPSocketAction
+
+
TCPSocketAction describes an action based on opening a socket
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
port
+
Number 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.
+
true
+
string
+
+
+
+
+
+
+
+
unversioned.StatusDetails
+
+
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.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
name
+
The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
+
false
+
string
+
+
+
+
group
+
The group attribute of the resource associated with the status StatusReason.
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: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
+
false
+
string array
+
+
+
+
args
+
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: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
+
false
+
string array
+
+
+
+
workingDir
+
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.
+
false
+
string
+
+
+
+
ports
+
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.
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. Defaults to /dev/termination-log. Cannot be updated.
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.
+
false
+
boolean
+
false
+
+
+
stdinOnce
+
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
+
false
+
boolean
+
false
+
+
+
tty
+
Whether this container should allocate a TTY for itself, also requires stdin to be true. Default is false.
+
false
+
boolean
+
false
+
+
+
+
+
+
+
v1.PodSecurityContext
+
+
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.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
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.
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.
+
false
+
integer (int64)
+
+
+
+
runAsNonRoot
+
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.
+
false
+
boolean
+
false
+
+
+
supplementalGroups
+
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.
+
false
+
integer (int32) array
+
+
+
+
fsGroup
+
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
+
false
+
integer (int64)
+
+
+
+
+
+
+
+
v1.PersistentVolumeSpec
+
+
PersistentVolumeSpec is the specification of a persistent volume.
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: http://kubernetes.io/docs/user-guide/volumes#hostpath
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
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.
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: http://kubernetes.io/docs/user-guide/persistent-volumes#binding
ServicePort contains information on service’s port.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
name
+
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.
+
false
+
string
+
+
+
+
protocol
+
The IP protocol for this port. Supports "TCP" and "UDP". Default is TCP.
+
false
+
string
+
+
+
+
port
+
The port that will be exposed by this service.
+
true
+
integer (int32)
+
+
+
+
targetPort
+
Number 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: http://kubernetes.io/docs/user-guide/services#defining-a-service
+
false
+
string
+
+
+
+
nodePort
+
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: http://kubernetes.io/docs/user-guide/services#type—nodeport
+
false
+
integer (int32)
+
+
+
+
+
+
+
+
v1.ComponentCondition
+
+
Information about the condition of a component.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
type
+
Type of condition for a component. Valid value: "Healthy"
+
true
+
string
+
+
+
+
status
+
Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".
+
true
+
string
+
+
+
+
message
+
Message about the condition for a component. For example, information about a health check.
+
false
+
string
+
+
+
+
error
+
Condition error code for a component. For example, a health check error code.
+
false
+
string
+
+
+
+
+
+
+
+
v1.OwnerReference
+
+
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.
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.
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.
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.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
capabilities
+
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
+
false
+
boolean
+
false
+
+
+
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.
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.
+
false
+
integer (int64)
+
+
+
+
runAsNonRoot
+
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.
+
false
+
boolean
+
false
+
+
+
readOnlyRootFilesystem
+
Whether this container has a read-only root filesystem. Default is false.
+
false
+
boolean
+
false
+
+
+
+
+
+
+
v1.AWSElasticBlockStoreVolumeSource
+
+
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.
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: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
+
false
+
string
+
+
+
+
partition
+
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).
Specifies whether the container has passed its readiness probe.
+
true
+
boolean
+
false
+
+
+
restartCount
+
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.
Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
registry
+
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
+
true
+
string
+
+
+
+
volume
+
Volume is a string that references an already created Quobyte volume by name.
+
true
+
string
+
+
+
+
readOnly
+
ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
+
false
+
boolean
+
false
+
+
+
user
+
User to map volume access to Defaults to serivceaccount user
+
false
+
string
+
+
+
+
group
+
Group to map volume access to Default is no group
+
false
+
string
+
+
+
+
+
+
+
+
v1.ContainerImage
+
+
Describe a container image
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
names
+
Names by which this image is known. e.g. ["gcr.io/google_containers/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"]
+
true
+
string array
+
+
+
+
sizeBytes
+
The size of the image in bytes.
+
false
+
integer (int64)
+
+
+
+
+
+
+
+
v1.ResourceQuotaScope
+
+
+
+
v1.ReplicationControllerList
+
+
ReplicationControllerList is a collection of replication controllers.
Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN or leading dot followed by valid DNS_SUBDOMAIN. 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
+
false
+
object
+
+
+
+
stringData
+
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.
+
false
+
object
+
+
+
+
type
+
Used to facilitate programmatic handling of secret data.
+
false
+
string
+
+
+
+
+
+
+
+
v1.Event
+
+
Event is a report of an event somewhere in the cluster.
The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)
+
false
+
string (date-time)
+
+
+
+
lastTimestamp
+
The time at which the most recent occurrence of this event was recorded.
+
false
+
string (date-time)
+
+
+
+
count
+
The number of times this event has occurred.
+
false
+
integer (int32)
+
+
+
+
type
+
Type of this event (Normal, Warning), new types could be added in the future
+
false
+
string
+
+
+
+
+
+
+
+
v1.EnvVar
+
+
EnvVar represents an environment variable present in a Container.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
name
+
Name of the environment variable. Must be a C_IDENTIFIER.
+
true
+
string
+
+
+
+
value
+
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 "".
+
false
+
string
+
+
+
+
valueFrom
+
Source for the environment variable’s value. Cannot be used if value is not empty.
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: http://kubernetes.io/docs/user-guide/compute-resources/
+
false
+
object
+
+
+
+
+
+
+
+
v1.ComponentStatus
+
+
ComponentStatus (and ComponentStatusList) holds the cluster validation info.
LimitRangeItem defines a min/max usage limit for any resource that matches on kind.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
type
+
Type of resource that this limit applies to.
+
false
+
string
+
+
+
+
max
+
Max usage constraints on this kind by resource name.
+
false
+
object
+
+
+
+
min
+
Min usage constraints on this kind by resource name.
+
false
+
object
+
+
+
+
default
+
Default resource requirement limit value by resource name if resource limit is omitted.
+
false
+
object
+
+
+
+
defaultRequest
+
DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.
+
false
+
object
+
+
+
+
maxLimitRequestRatio
+
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.
+
false
+
object
+
+
+
+
+
+
+
+
v1.PodTemplateSpec
+
+
PodTemplateSpec describes the data a pod should have when created from a template
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.
+
false
+
string
+
+
+
+
+
+
+
+
unversioned.LabelSelectorRequirement
+
+
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
key
+
key is the label key that the selector applies to.
+
true
+
string
+
+
+
+
operator
+
operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.
+
true
+
string
+
+
+
+
values
+
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.
+
false
+
string array
+
+
+
+
+
+
+
+
v1.ContainerStateWaiting
+
+
ContainerStateWaiting is a waiting state of a container.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
reason
+
(brief) reason the container is not yet running.
+
false
+
string
+
+
+
+
message
+
Message regarding why the container is not yet running.
+
false
+
string
+
+
+
+
+
+
+
+
unversioned.Status
+
+
Status is a return value for calls that don’t return other objects.
A human-readable description of the status of this operation.
+
false
+
string
+
+
+
+
reason
+
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.
+
false
+
string
+
+
+
+
details
+
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.
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: http://kubernetes.io/docs/user-guide/services#overview
+
false
+
object
+
+
+
+
clusterIP
+
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: http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies
+
false
+
string
+
+
+
+
type
+
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: http://kubernetes.io/docs/user-guide/services#overview
+
false
+
string
+
+
+
+
externalIPs
+
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. A previous form of this functionality exists as the deprecatedPublicIPs field. When using this field, callers should also clear the deprecatedPublicIPs field.
+
false
+
string array
+
+
+
+
deprecatedPublicIPs
+
deprecatedPublicIPs is deprecated and replaced by the externalIPs field with almost the exact same semantics. This field is retained in the v1 API for compatibility until at least 8/20/2016. It will be removed from any new API revisions. If both deprecatedPublicIPs and externalIPs are set, deprecatedPublicIPs is used.
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.
+
false
+
string
+
+
+
+
loadBalancerSourceRanges
+
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: http://kubernetes.io/docs/user-guide/services-firewalls
+
false
+
string array
+
+
+
+
externalName
+
externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid DNS name and requires Type to be ExternalName.
+
false
+
string
+
+
+
+
+
+
+
+
v1.Pod
+
+
Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.
EndpointAddress is a tuple that describes single IP address.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
ip
+
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.
+
true
+
string
+
+
+
+
hostname
+
The Hostname of this endpoint
+
false
+
string
+
+
+
+
nodeName
+
Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
list or watch objects of kind PersistentVolumeClaim
+
+
+
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /api/v1/namespaces/{namespace}/pods/{name}/attach
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
stdin
+
Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.
+
false
+
boolean
+
+
+
+
QueryParameter
+
stdout
+
Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.
+
false
+
boolean
+
+
+
+
QueryParameter
+
stderr
+
Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.
+
false
+
boolean
+
+
+
+
QueryParameter
+
tty
+
TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.
+
false
+
boolean
+
+
+
+
QueryParameter
+
container
+
The container in which to execute the command. Defaults to only container if there is only one container in the pod.
+
false
+
string
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
+
true
+
string
+
+
+
+
PathParameter
+
name
+
name of the Pod
+
true
+
string
+
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+
HTTP Code
+
Description
+
Schema
+
+
+
+
+
default
+
success
+
string
+
+
+
+
+
+
+
Consumes
+
+
+
+
/
+
+
+
+
+
+
Produces
+
+
+
+
/
+
+
+
+
+
+
Tags
+
+
+
+
apiv1
+
+
+
+
+
+
+
connect POST requests to attach of Pod
+
+
+
POST /api/v1/namespaces/{namespace}/pods/{name}/attach
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
stdin
+
Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.
+
false
+
boolean
+
+
+
+
QueryParameter
+
stdout
+
Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.
+
false
+
boolean
+
+
+
+
QueryParameter
+
stderr
+
Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.
+
false
+
boolean
+
+
+
+
QueryParameter
+
tty
+
TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false.
+
false
+
boolean
+
+
+
+
QueryParameter
+
container
+
The container in which to execute the command. Defaults to only container if there is only one container in the pod.
+
false
+
string
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
+
true
+
string
+
+
+
+
PathParameter
+
name
+
name of the Pod
+
true
+
string
+
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+
HTTP Code
+
Description
+
Schema
+
+
+
+
+
default
+
success
+
string
+
+
+
+
+
+
+
Consumes
+
+
+
+
/
+
+
+
+
+
+
Produces
+
+
+
+
/
+
+
+
+
+
+
Tags
+
+
+
+
apiv1
+
+
+
+
+
+
+
create binding of a Binding
+
+
+
POST /api/v1/namespaces/{namespace}/pods/{name}/binding
GET /api/v1/namespaces/{namespace}/pods/{name}/exec
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
stdin
+
Redirect the standard input stream of the pod for this call. Defaults to false.
+
false
+
boolean
+
+
+
+
QueryParameter
+
stdout
+
Redirect the standard output stream of the pod for this call. Defaults to true.
+
false
+
boolean
+
+
+
+
QueryParameter
+
stderr
+
Redirect the standard error stream of the pod for this call. Defaults to true.
+
false
+
boolean
+
+
+
+
QueryParameter
+
tty
+
TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.
+
false
+
boolean
+
+
+
+
QueryParameter
+
container
+
Container in which to execute the command. Defaults to only container if there is only one container in the pod.
+
false
+
string
+
+
+
+
QueryParameter
+
command
+
Command is the remote command to execute. argv array. Not executed within a shell.
+
false
+
string
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
+
true
+
string
+
+
+
+
PathParameter
+
name
+
name of the Pod
+
true
+
string
+
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+
HTTP Code
+
Description
+
Schema
+
+
+
+
+
default
+
success
+
string
+
+
+
+
+
+
+
Consumes
+
+
+
+
/
+
+
+
+
+
+
Produces
+
+
+
+
/
+
+
+
+
+
+
Tags
+
+
+
+
apiv1
+
+
+
+
+
+
+
connect POST requests to exec of Pod
+
+
+
POST /api/v1/namespaces/{namespace}/pods/{name}/exec
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
stdin
+
Redirect the standard input stream of the pod for this call. Defaults to false.
+
false
+
boolean
+
+
+
+
QueryParameter
+
stdout
+
Redirect the standard output stream of the pod for this call. Defaults to true.
+
false
+
boolean
+
+
+
+
QueryParameter
+
stderr
+
Redirect the standard error stream of the pod for this call. Defaults to true.
+
false
+
boolean
+
+
+
+
QueryParameter
+
tty
+
TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.
+
false
+
boolean
+
+
+
+
QueryParameter
+
container
+
Container in which to execute the command. Defaults to only container if there is only one container in the pod.
+
false
+
string
+
+
+
+
QueryParameter
+
command
+
Command is the remote command to execute. argv array. Not executed within a shell.
+
false
+
string
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
+
true
+
string
+
+
+
+
PathParameter
+
name
+
name of the Pod
+
true
+
string
+
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+
HTTP Code
+
Description
+
Schema
+
+
+
+
+
default
+
success
+
string
+
+
+
+
+
+
+
Consumes
+
+
+
+
/
+
+
+
+
+
+
Produces
+
+
+
+
/
+
+
+
+
+
+
Tags
+
+
+
+
apiv1
+
+
+
+
+
+
+
read log of the specified Pod
+
+
+
GET /api/v1/namespaces/{namespace}/pods/{name}/log
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
container
+
The container for which to stream logs. Defaults to only container if there is one container in the pod.
+
false
+
string
+
+
+
+
QueryParameter
+
follow
+
Follow the log stream of the pod. Defaults to false.
+
false
+
boolean
+
+
+
+
QueryParameter
+
previous
+
Return previous terminated container logs. Defaults to false.
+
false
+
boolean
+
+
+
+
QueryParameter
+
sinceSeconds
+
A 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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
sinceTime
+
An RFC3339 timestamp 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.
+
false
+
string
+
+
+
+
QueryParameter
+
timestamps
+
If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.
+
false
+
boolean
+
+
+
+
QueryParameter
+
tailLines
+
If 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
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
limitBytes
+
If 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.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
+
true
+
string
+
+
+
+
PathParameter
+
name
+
name of the Pod
+
true
+
string
+
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+
HTTP Code
+
Description
+
Schema
+
+
+
+
+
200
+
success
+
string
+
+
+
+
+
+
+
Consumes
+
+
+
+
/
+
+
+
+
+
+
Produces
+
+
+
+
text/plain
+
+
+
application/json
+
+
+
application/yaml
+
+
+
application/vnd.kubernetes.protobuf
+
+
+
+
+
+
Tags
+
+
+
+
apiv1
+
+
+
+
+
+
+
connect GET requests to portforward of Pod
+
+
+
GET /api/v1/namespaces/{namespace}/pods/{name}/portforward
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
+
true
+
string
+
+
+
+
PathParameter
+
name
+
name of the Pod
+
true
+
string
+
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+
HTTP Code
+
Description
+
Schema
+
+
+
+
+
default
+
success
+
string
+
+
+
+
+
+
+
Consumes
+
+
+
+
/
+
+
+
+
+
+
Produces
+
+
+
+
/
+
+
+
+
+
+
Tags
+
+
+
+
apiv1
+
+
+
+
+
+
+
connect POST requests to portforward of Pod
+
+
+
POST /api/v1/namespaces/{namespace}/pods/{name}/portforward
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
+
true
+
string
+
+
+
+
PathParameter
+
name
+
name of the Pod
+
true
+
string
+
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+
HTTP Code
+
Description
+
Schema
+
+
+
+
+
default
+
success
+
string
+
+
+
+
+
+
+
Consumes
+
+
+
+
/
+
+
+
+
+
+
Produces
+
+
+
+
/
+
+
+
+
+
+
Tags
+
+
+
+
apiv1
+
+
+
+
+
+
+
connect GET requests to proxy of Pod
+
+
+
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
path
+
Path is the URL path to use for the current proxy request to pod.
+
false
+
string
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
+
true
+
string
+
+
+
+
PathParameter
+
name
+
name of the Pod
+
true
+
string
+
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+
HTTP Code
+
Description
+
Schema
+
+
+
+
+
default
+
success
+
string
+
+
+
+
+
+
+
Consumes
+
+
+
+
/
+
+
+
+
+
+
Produces
+
+
+
+
/
+
+
+
+
+
+
Tags
+
+
+
+
apiv1
+
+
+
+
+
+
+
connect PUT requests to proxy of Pod
+
+
+
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
path
+
Path is the URL path to use for the current proxy request to pod.
+
false
+
string
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
list or watch objects of kind ReplicationController
+
+
+
GET /api/v1/namespaces/{namespace}/replicationcontrollers
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /api/v1/namespaces/{namespace}/serviceaccounts
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
list or watch objects of kind PersistentVolumeClaim
+
+
+
GET /api/v1/persistentvolumeclaims
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
object name and auth scope, such as for teams and projects
+
true
+
string
+
+
+
+
PathParameter
+
name
+
name of the Service
+
true
+
string
+
+
+
+
PathParameter
+
path
+
path to the resource
+
true
+
string
+
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+
HTTP Code
+
Description
+
Schema
+
+
+
+
+
default
+
success
+
string
+
+
+
+
+
+
+
Consumes
+
+
+
+
/
+
+
+
+
+
+
Produces
+
+
+
+
/
+
+
+
+
+
+
Tags
+
+
+
+
apiv1
+
+
+
+
+
+
+
proxy POST requests to Service
+
+
+
POST /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
+
true
+
string
+
+
+
+
PathParameter
+
name
+
name of the Service
+
true
+
string
+
+
+
+
PathParameter
+
path
+
path to the resource
+
true
+
string
+
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+
HTTP Code
+
Description
+
Schema
+
+
+
+
+
default
+
success
+
string
+
+
+
+
+
+
+
Consumes
+
+
+
+
/
+
+
+
+
+
+
Produces
+
+
+
+
/
+
+
+
+
+
+
Tags
+
+
+
+
apiv1
+
+
+
+
+
+
+
proxy GET requests to Node
+
+
+
GET /api/v1/proxy/nodes/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
PathParameter
+
name
+
name of the Node
+
true
+
string
+
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+
HTTP Code
+
Description
+
Schema
+
+
+
+
+
default
+
success
+
string
+
+
+
+
+
+
+
Consumes
+
+
+
+
/
+
+
+
+
+
+
Produces
+
+
+
+
/
+
+
+
+
+
+
Tags
+
+
+
+
apiv1
+
+
+
+
+
+
+
proxy PUT requests to Node
+
+
+
PUT /api/v1/proxy/nodes/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
PathParameter
+
name
+
name of the Node
+
true
+
string
+
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+
HTTP Code
+
Description
+
Schema
+
+
+
+
+
default
+
success
+
string
+
+
+
+
+
+
+
Consumes
+
+
+
+
/
+
+
+
+
+
+
Produces
+
+
+
+
/
+
+
+
+
+
+
Tags
+
+
+
+
apiv1
+
+
+
+
+
+
+
proxy DELETE requests to Node
+
+
+
DELETE /api/v1/proxy/nodes/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
PathParameter
+
name
+
name of the Node
+
true
+
string
+
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+
HTTP Code
+
Description
+
Schema
+
+
+
+
+
default
+
success
+
string
+
+
+
+
+
+
+
Consumes
+
+
+
+
/
+
+
+
+
+
+
Produces
+
+
+
+
/
+
+
+
+
+
+
Tags
+
+
+
+
apiv1
+
+
+
+
+
+
+
proxy POST requests to Node
+
+
+
POST /api/v1/proxy/nodes/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
PathParameter
+
name
+
name of the Node
+
true
+
string
+
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+
HTTP Code
+
Description
+
Schema
+
+
+
+
+
default
+
success
+
string
+
+
+
+
+
+
+
Consumes
+
+
+
+
/
+
+
+
+
+
+
Produces
+
+
+
+
/
+
+
+
+
+
+
Tags
+
+
+
+
apiv1
+
+
+
+
+
+
+
proxy GET requests to Node
+
+
+
GET /api/v1/proxy/nodes/{name}/{path}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
PathParameter
+
name
+
name of the Node
+
true
+
string
+
+
+
+
PathParameter
+
path
+
path to the resource
+
true
+
string
+
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+
HTTP Code
+
Description
+
Schema
+
+
+
+
+
default
+
success
+
string
+
+
+
+
+
+
+
Consumes
+
+
+
+
/
+
+
+
+
+
+
Produces
+
+
+
+
/
+
+
+
+
+
+
Tags
+
+
+
+
apiv1
+
+
+
+
+
+
+
proxy PUT requests to Node
+
+
+
PUT /api/v1/proxy/nodes/{name}/{path}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
PathParameter
+
name
+
name of the Node
+
true
+
string
+
+
+
+
PathParameter
+
path
+
path to the resource
+
true
+
string
+
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+
HTTP Code
+
Description
+
Schema
+
+
+
+
+
default
+
success
+
string
+
+
+
+
+
+
+
Consumes
+
+
+
+
/
+
+
+
+
+
+
Produces
+
+
+
+
/
+
+
+
+
+
+
Tags
+
+
+
+
apiv1
+
+
+
+
+
+
+
proxy DELETE requests to Node
+
+
+
DELETE /api/v1/proxy/nodes/{name}/{path}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
PathParameter
+
name
+
name of the Node
+
true
+
string
+
+
+
+
PathParameter
+
path
+
path to the resource
+
true
+
string
+
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+
HTTP Code
+
Description
+
Schema
+
+
+
+
+
default
+
success
+
string
+
+
+
+
+
+
+
Consumes
+
+
+
+
/
+
+
+
+
+
+
Produces
+
+
+
+
/
+
+
+
+
+
+
Tags
+
+
+
+
apiv1
+
+
+
+
+
+
+
proxy POST requests to Node
+
+
+
POST /api/v1/proxy/nodes/{name}/{path}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
PathParameter
+
name
+
name of the Node
+
true
+
string
+
+
+
+
PathParameter
+
path
+
path to the resource
+
true
+
string
+
+
+
+
+
+
+
+
Responses
+
+
+
+
+
+
+
+
+
HTTP Code
+
Description
+
Schema
+
+
+
+
+
default
+
success
+
string
+
+
+
+
+
+
+
Consumes
+
+
+
+
/
+
+
+
+
+
+
Produces
+
+
+
+
/
+
+
+
+
+
+
Tags
+
+
+
+
apiv1
+
+
+
+
+
+
+
list or watch objects of kind ReplicationController
+
+
+
GET /api/v1/replicationcontrollers
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
GET /api/v1/watch/namespaces/{namespace}/configmaps
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /api/v1/watch/namespaces/{namespace}/endpoints
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /api/v1/watch/namespaces/{namespace}/events/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /api/v1/watch/namespaces/{namespace}/limitranges
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /api/v1/watch/namespaces/{namespace}/limitranges/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
watch individual changes to a list of PersistentVolumeClaim
+
+
+
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
watch changes to an object of kind PersistentVolumeClaim
+
+
+
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /api/v1/watch/namespaces/{namespace}/pods/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /api/v1/watch/namespaces/{namespace}/podtemplates
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
watch individual changes to a list of ReplicationController
+
+
+
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
watch changes to an object of kind ReplicationController
+
+
+
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
watch individual changes to a list of ResourceQuota
+
+
+
GET /api/v1/watch/namespaces/{namespace}/resourcequotas
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /api/v1/watch/namespaces/{namespace}/secrets/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
watch individual changes to a list of ServiceAccount
+
+
+
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
GET /api/v1/watch/namespaces/{namespace}/services/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
+
false
+
string
+
+
+
+
QueryParameter
+
timeoutSeconds
+
Timeout for the list/watch call.
+
false
+
integer (int32)
+
+
+
+
PathParameter
+
namespace
+
object name and auth scope, such as for teams and projects
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
watch individual changes to a list of PersistentVolumeClaim
+
+
+
GET /api/v1/watch/persistentvolumeclaims
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
watch individual changes to a list of PersistentVolume
+
+
+
GET /api/v1/watch/persistentvolumes
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
watch changes to an object of kind PersistentVolume
+
+
+
GET /api/v1/watch/persistentvolumes/{name}
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
watch individual changes to a list of ReplicationController
+
+
+
GET /api/v1/watch/replicationcontrollers
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
watch individual changes to a list of ResourceQuota
+
+
+
GET /api/v1/watch/resourcequotas
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
watch individual changes to a list of ServiceAccount
+
+
+
GET /api/v1/watch/serviceaccounts
+
+
+
+
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
Type
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
QueryParameter
+
pretty
+
If true, then the output is pretty printed.
+
false
+
string
+
+
+
+
QueryParameter
+
labelSelector
+
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
A selector to restrict the list of returned objects by their labels. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
fieldSelector
+
A selector to restrict the list of returned objects by their fields. Defaults to everything.
+
false
+
string
+
+
+
+
QueryParameter
+
watch
+
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+
false
+
boolean
+
+
+
+
QueryParameter
+
resourceVersion
+
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
@@ -45,7 +45,7 @@ title: Case Studies
-
+
diff --git a/case-studies/pearson.html b/case-studies/pearson.html
index bf871789b9..50f16ce7ae 100644
--- a/case-studies/pearson.html
+++ b/case-studies/pearson.html
@@ -13,13 +13,13 @@ title: Pearson Case Study
-
Using Kubernetes to reinvent the world’s largest educational company
+
Using Kubernetes to reinvent the world's largest educational company
- Pearson, the world’s education company, serving 75 million learners worldwide, set a goal to more than double that number to 200 million by 2025. A key part of this growth is in digital learning experiences, and that requires an infrastructure platform that is able to scale quickly and deliver products to market faster. So Pearson’s Cloud Technology team chose Kubernetes to help build a platform to meet the business requirements.
+ Pearson, the world's education company, serving 75 million learners worldwide, set a goal to more than double that number to 200 million by 2025. A key part of this growth is in digital learning experiences, and that requires an infrastructure platform that is able to scale quickly and deliver products to market faster. So Pearson's Cloud Technology team chose Kubernetes to help build a platform to meet the business requirements.
- “To transform our infrastructure, we had to think beyond simply enabling automated provisioning, we realized we had to build a platform that would allow Pearson developers to build manage and deploy applications in a completely different way. We chose Kubernetes because of its flexibility, ease of management and the way it would improve our engineers’ productivity.”
+ "To transform our infrastructure, we had to think beyond simply enabling automated provisioning, we realized we had to build a platform that would allow Pearson developers to build manage and deploy applications in a completely different way. We chose Kubernetes because of its flexibility, ease of management and the way it would improve our engineers' productivity."
— Chris Jackson, Director for Cloud Product Engineering, Pearson
@@ -38,7 +38,7 @@ title: Pearson Case Study
Why Kubernetes:
-
Kubernetes will allow Pearson’s teams to develop their apps in a consistent manner, saving time and minimizing complexity.
+
Kubernetes will allow Pearson's teams to develop their apps in a consistent manner, saving time and minimizing complexity.
@@ -52,7 +52,7 @@ title: Pearson Case Study
Results:
-
Pearson is building an enterprise-wide platform for delivering innovative, web-based educational content. They expect engineers’ productivity to increase by up to 20 percent.
+
Pearson is building an enterprise-wide platform for delivering innovative, web-based educational content. They expect engineers' productivity to increase by up to 20 percent.
@@ -63,9 +63,9 @@ title: Pearson Case Study
Kubernetes powers a comprehensive developer experience
-
Pearson wanted to use as much open source technology as possible for the platform given that it provides both technical and commercial benefits over the duration of the project. Jackson says, “Building an infrastructure platform based on open source technology in Pearson was a no-brainer, the sharing of technical challenges and advanced use cases in a community of people with talent far beyond what we could hire independently allows us to innovate at a level we could not reach on our own. Our engineers enjoy returning code to the community and participating in talks, blogs and meetings, it’s a great way for us to allow our team to express themselves and share the pride they have in their work.”
-
It also wanted to use a container-focused platform. Pearson has 400 development groups and diverse brands with varying business and technical needs. With containers, each brand could experiment with building new types of content using their preferred technologies, and then deliver it using containers. Pearson chose Kubernetes because it believes that is the best technology for managing containers, has the widest community support and offers the most flexible and powerful tools.“
-
Kubernetes is at the core of the platform we’ve built for developers. After we get our big spike in back-to-school in traffic, much of Pearson’s traffic will interact with Kubernetes. It is proving to be as effective as we had hoped,” Jackson says.
+
Pearson wanted to use as much open source technology as possible for the platform given that it provides both technical and commercial benefits over the duration of the project. Jackson says, "Building an infrastructure platform based on open source technology in Pearson was a no-brainer, the sharing of technical challenges and advanced use cases in a community of people with talent far beyond what we could hire independently allows us to innovate at a level we could not reach on our own. Our engineers enjoy returning code to the community and participating in talks, blogs and meetings, it's a great way for us to allow our team to express themselves and share the pride they have in their work."
+
It also wanted to use a container-focused platform. Pearson has 400 development groups and diverse brands with varying business and technical needs. With containers, each brand could experiment with building new types of content using their preferred technologies, and then deliver it using containers. Pearson chose Kubernetes because it believes that is the best technology for managing containers, has the widest community support and offers the most flexible and powerful tools."
+
Kubernetes is at the core of the platform we've built for developers. After we get our big spike in back-to-school in traffic, much of Pearson's traffic will interact with Kubernetes. It is proving to be as effective as we had hoped," Jackson says.
@@ -74,9 +74,9 @@ title: Pearson Case Study
Encouraging experimentation, saving engineers time
-
With the new platform, Pearson will increase stability and performance, and to bring products to market more quickly. The company says its engineers will also get a productivity boost because they won’t spend time managing infrastructure. Jackson estimates 15 to 20 percent in productivity savings.
+
With the new platform, Pearson will increase stability and performance, and to bring products to market more quickly. The company says its engineers will also get a productivity boost because they won't spend time managing infrastructure. Jackson estimates 15 to 20 percent in productivity savings.
Beyond that, Pearson says the platform will encourage innovation because of the ease with which new applications can be developed, and because applications will be deployed far more quickly than in the past. It expects that will help the company meet its goal of reaching 200 million learners within the next 10 years.
-
“We’re already seeing tremendous benefits with Kubernetes — improved engineering productivity, faster delivery of applications and a simplified infrastructure. But this is just the beginning. Kubernetes will help transform the way that educational content is delivered online,” says Jackson.
+
"We're already seeing tremendous benefits with Kubernetes — improved engineering productivity, faster delivery of applications and a simplified infrastructure. But this is just the beginning. Kubernetes will help transform the way that educational content is delivered online," says Jackson.
diff --git a/case-studies/wikimedia.html b/case-studies/wikimedia.html
index 00eb47e3e0..2d3b686128 100644
--- a/case-studies/wikimedia.html
+++ b/case-studies/wikimedia.html
@@ -20,7 +20,7 @@ title: Wikimedia Case Study
- “Wikimedia Tool Labs is vital for making sure wikis all around the world work as well as they possibly can. Because it’s grown organically for almost 10 years, it has become an extremely challenging environment and difficult to maintain. It’s like a big ball of mud — you really can’t see through it. With Kubernetes, we’re simplifying the environment and making it easier for developers to build the tools that make wikis run better.”
+ "Wikimedia Tool Labs is vital for making sure wikis all around the world work as well as they possibly can. Because it's grown organically for almost 10 years, it has become an extremely challenging environment and difficult to maintain. It's like a big ball of mud — you really can't see through it. With Kubernetes, we're simplifying the environment and making it easier for developers to build the tools that make wikis run better."
— Yuvi Panda, operations engineer at Wikimedia Foundation and Wikimedia Tool Labs
@@ -67,13 +67,13 @@ title: Wikimedia Case Study
Using Kubernetes to provide tools for maintaining wikis
- Wikimedia Tool Labs is run by a staff of four-and-a-half paid employees and two volunteers. The infrastructure didn't make it easy or intuitive for developers to build bots and other tools to make wikis work more easily. Yuvi says, “It’s incredibly chaotic. We have lots of Perl and Bash duct tape on top of it. Everything is super fragile.”
+ Wikimedia Tool Labs is run by a staff of four-and-a-half paid employees and two volunteers. The infrastructure didn't make it easy or intuitive for developers to build bots and other tools to make wikis work more easily. Yuvi says, "It's incredibly chaotic. We have lots of Perl and Bash duct tape on top of it. Everything is super fragile."
To solve the problem, Wikimedia Tool Labs migrated parts of its infrastructure to Kubernetes, in preparation for eventually moving its entire system. Yuvi said Kubernetes greatly simplifies maintenance. The goal is to allow developers creating bots and other tools to use whatever development methods they want, but make it easier for the Wikimedia Tool Labs to maintain the required infrastructure for hosting and sharing them.
- “With Kubernetes, I’ve been able to remove a lot of our custom-made code, which makes everything easier to maintain. Our users’ code also runs in a more stable way than previously,” says Yuvi.
+ "With Kubernetes, I've been able to remove a lot of our custom-made code, which makes everything easier to maintain. Our users' code also runs in a more stable way than previously," says Yuvi.
@@ -84,13 +84,13 @@ title: Wikimedia Case Study
Simplifying infrastructure and keeping wikis running better
- Wikimedia Tool Labs has seen great success with the initial Kubernetes deployment. Old code is being simplified and eliminated, contributing developers don’t have to change the way they write their tools and bots, and those tools and bots run in a more stable fashion than they have in the past. The paid staff and volunteers are able to better keep up with fixing issues.
+ Wikimedia Tool Labs has seen great success with the initial Kubernetes deployment. Old code is being simplified and eliminated, contributing developers don't have to change the way they write their tools and bots, and those tools and bots run in a more stable fashion than they have in the past. The paid staff and volunteers are able to better keep up with fixing issues.
- In the future, with a more complete migration to Kubernetes, Wikimedia Tool Labs expects to make it even easier to host and maintain the bots and tools that help run wikis across the world. The tool labs already host approximately 1,300 tools and bots from 800 volunteers, with many more being submitted every day. Twenty percent of the tool labs’ web tools that account for more than 60 percent of web traffic now run on Kubernetes. The tool labs has a 25-node cluster that keeps up with each new Kubernetes release. Many existing web tools are migrating to Kubernetes.
+ In the future, with a more complete migration to Kubernetes, Wikimedia Tool Labs expects to make it even easier to host and maintain the bots and tools that help run wikis across the world. The tool labs already host approximately 1,300 tools and bots from 800 volunteers, with many more being submitted every day. Twenty percent of the tool labs' web tools that account for more than 60 percent of web traffic now run on Kubernetes. The tool labs has a 25-node cluster that keeps up with each new Kubernetes release. Many existing web tools are migrating to Kubernetes.
- “Our goal is to make sure that people all over the world can share knowledge as easily as possible. Kubernetes helps with that, by making it easier for wikis everywhere to have the tools they need to thrive,” says Yuvi.
+ "Our goal is to make sure that people all over the world can share knowledge as easily as possible. Kubernetes helps with that, by making it easier for wikis everywhere to have the tools they need to thrive," says Yuvi.
diff --git a/community.html b/community.html
index 9ef63c1b66..a10a100375 100644
--- a/community.html
+++ b/community.html
@@ -24,8 +24,8 @@ title: Community
SIGs
Have a special interest in how Kubernetes works with another technology? See our ever growing
lists of SIGs,
- from AWS and Openstack to Big Data and Scalability, there’s a place for you to contribute and instructions
- for forming a new SIG if your special interest isn’t covered (yet).
+ from AWS and Openstack to Big Data and Scalability, there's a place for you to contribute and instructions
+ for forming a new SIG if your special interest isn't covered (yet).
Events
diff --git a/docs/admin/accessing-the-api.md b/docs/admin/accessing-the-api.md
index cb3f3d4ce4..a70f1c0920 100644
--- a/docs/admin/accessing-the-api.md
+++ b/docs/admin/accessing-the-api.md
@@ -3,7 +3,7 @@ assignees:
- bgrant0607
- erictune
- lavalamp
-
+title: Overview
---
This document describes how access to the Kubernetes API is controlled.
@@ -24,7 +24,7 @@ following diagram:
In a typical Kubernetes cluster, the API served on port 443. A TLS connection is
established. The API server presents a certificate. This certificate is
often self-signed, so `$USER/.kube/config` on the user's machine typically
-contains the root certficate for the API server's certificate, which when specified
+contains the root certificate for the API server's certificate, which when specified
is used in place of the system default root certificates. This certificate is typically
automatically written into your `$USER/.kube/config` when you create a cluster yourself
using `kube-up.sh`. If the cluster has multiple users, then the creator needs to share
@@ -86,7 +86,7 @@ For version 1.2, clusters created by `kube-up.sh` are configured so that no auth
required for any request.
As of version 1.3, clusters created by `kube-up.sh` are configured so that the ABAC authorization
-modules is enabled. However, its input file is initially set to allow all users to do all
+modules are enabled. However, its input file is initially set to allow all users to do all
operations. The cluster administrator needs to edit that file, or configure a different authorizer
to restrict what users can do.
@@ -148,7 +148,7 @@ By default the Kubernetes APIserver serves HTTP on 2 ports:
- default IP is first non-localhost network interface, change with `--bind-address` flag.
- request handled by authentication and authorization modules.
- request handled by admission control module(s).
- - authentication and authoriation modules run.
+ - authentication and authorisation modules run.
When the cluster is created by `kube-up.sh`, on Google Compute Engine (GCE),
and on several other cloud providers, the API server serves on port 443. On
diff --git a/docs/admin/addons.md b/docs/admin/addons.md
index 1555f8263c..aeee68cc30 100644
--- a/docs/admin/addons.md
+++ b/docs/admin/addons.md
@@ -1,4 +1,5 @@
---
+title: Installing Addons
---
## Overview
@@ -11,9 +12,9 @@ Add-ons in each section are sorted alphabetically - the ordering does not imply
## Networking and Network Policy
-* [Calico](http://docs.projectcalico.org/v1.6/getting-started/kubernetes/installation/hosted/) is a secure L3 networking and network policy provider.
+* [Calico](http://docs.projectcalico.org/v2.0/getting-started/kubernetes/installation/hosted/) is a secure L3 networking and network policy provider.
* [Canal](https://github.com/tigera/canal/tree/master/k8s-install/kubeadm) unites Flannel and Calico, providing networking and network policy.
-* [Flannel](https://github.com/coreos/flannel/blob/master/Documentation/kube-flannel.yml) is a overlay network provider that can be used with Kubernetes.
+* [Flannel](https://github.com/coreos/flannel/blob/master/Documentation/kube-flannel.yml) is an overlay network provider that can be used with Kubernetes.
* [Romana](http://romana.io) is a Layer 3 networking solution for pod networks that also supports the [NetworkPolicy API](/docs/user-guide/networkpolicies/). Kubeadm add-on installation details available [here](https://github.com/romana/romana/tree/master/containerize).
* [Weave Net](https://www.weave.works/docs/net/latest/kube-addon/) provides networking and network policy, will carry on working on both sides of a network partition, and does not require an external database.
diff --git a/docs/admin/admission-controllers.md b/docs/admin/admission-controllers.md
index 24da796163..089dce2605 100644
--- a/docs/admin/admission-controllers.md
+++ b/docs/admin/admission-controllers.md
@@ -6,7 +6,7 @@ assignees:
- erictune
- janetkuo
- thockin
-
+title: Using Admission Controllers
---
* TOC
@@ -126,7 +126,7 @@ For additional HTTP configuration, refer to the [kubeconfig](/docs/user-guide/ku
When faced with an admission decision, the API Server POSTs a JSON serialized api.imagepolicy.v1alpha1.ImageReview object describing the action. This object contains fields describing the containers being admitted, as well as any pod annotations that match `*.image-policy.k8s.io/*`.
-Note that webhook API objects are subject to the same versioning compatibility rules as other Kubernetes API objects. Implementers should be aware of looser compatibility promises for alpha objects and check the “apiVersion” field of the request to ensure correct deserialization. Additionally, the API Server must enable the imagepolicy.k8s.io/v1alpha1 API extensions group (`--runtime-config=imagepolicy.k8s.io/v1alpha1=true`).
+Note that webhook API objects are subject to the same versioning compatibility rules as other Kubernetes API objects. Implementers should be aware of looser compatibility promises for alpha objects and check the "apiVersion" field of the request to ensure correct deserialization. Additionally, the API Server must enable the imagepolicy.k8s.io/v1alpha1 API extensions group (`--runtime-config=imagepolicy.k8s.io/v1alpha1=true`).
An example request body:
@@ -151,7 +151,7 @@ An example request body:
}
```
-The remote service is expected to fill the ImageReviewStatus field of the request and respond to either allow or disallow access. The response body’s “spec” field is ignored and may be omitted. A permissive response would return:
+The remote service is expected to fill the ImageReviewStatus field of the request and respond to either allow or disallow access. The response body's "spec" field is ignored and may be omitted. A permissive response would return:
```
{
diff --git a/docs/admin/apparmor/index.md b/docs/admin/apparmor/index.md
index 9730c07953..224f0bbdeb 100644
--- a/docs/admin/apparmor/index.md
+++ b/docs/admin/apparmor/index.md
@@ -1,7 +1,7 @@
---
assignees:
- stclair
-
+title: AppArmor
---
AppArmor is a Linux kernel enhancement that can reduce the potential attack surface of an
@@ -384,7 +384,7 @@ Specifying the default profile to apply to containers when none is provided:
- **key**: `apparmor.security.beta.kubernetes.io/defaultProfileName`
- **value**: a profile reference, described above
-Specifying the list of profiles Pod containers are allowed to specify:
+Specifying the list of profiles Pod containers is allowed to specify:
- **key**: `apparmor.security.beta.kubernetes.io/allowedProfileNames`
- **value**: a comma-separated list of profile references (described above)
diff --git a/docs/admin/audit.md b/docs/admin/audit.md
index c3a6fda6da..e195d0909f 100644
--- a/docs/admin/audit.md
+++ b/docs/admin/audit.md
@@ -23,7 +23,7 @@ answer the following questions:
- to where was it going?
NOTE: Currently, Kubernetes provides only basic audit capabilities, there is still a lot
-of work going on to provide fully featured auditing capabilities (see https://github.com/kubernetes/features/issues/22).
+of work going on to provide fully featured auditing capabilities (see [this issue](https://github.com/kubernetes/features/issues/22)).
Kubernetes audit is part of [kube-apiserver](/docs/admin/kube-apiserver) logging all requests
coming to the server. Each audit log contains two entries:
diff --git a/docs/admin/authentication.md b/docs/admin/authentication.md
index 0cb5ea4dbe..4bbd0a4fee 100644
--- a/docs/admin/authentication.md
+++ b/docs/admin/authentication.md
@@ -5,8 +5,9 @@ assignees:
- ericchiang
- deads2k
- liggitt
-
+title: Authenticating
---
+
* TOC
{:toc}
@@ -30,7 +31,7 @@ to talk to the Kubernetes API.
API requests are tied to either a normal user or a service account, or are treated
as anonymous requests. This means every process inside or outside the cluster, from
a human user typing `kubectl` on a workstation, to `kubelets` on nodes, to members
-of the control plane, must authenticate when making requests to the the API server,
+of the control plane, must authenticate when making requests to the API server,
or be treated as an anonymous user.
## Authentication strategies
@@ -443,7 +444,7 @@ The script will generate three files: `ca.crt`, `server.crt`, and `server.key`.
Finally, add the following parameters into API server start parameters:
- `--client-ca-file=/srv/kubernetes/ca.crt`
-- `--tls-cert-file=/srv/kubernetes/server.cert`
+- `--tls-cert-file=/srv/kubernetes/server.crt`
- `--tls-private-key-file=/srv/kubernetes/server.key`
#### easyrsa
@@ -467,7 +468,7 @@ Finally, add the following parameters into API server start parameters:
1. Fill in and add the following parameters into the API server start parameters:
--client-ca-file=/yourdirectory/ca.crt
- --tls-cert-file=/yourdirectory/server.cert
+ --tls-cert-file=/yourdirectory/server.crt
--tls-private-key-file=/yourdirectory/server.key
#### openssl
diff --git a/docs/admin/authorization.md b/docs/admin/authorization.md
index f1f46985b2..caae123f14 100644
--- a/docs/admin/authorization.md
+++ b/docs/admin/authorization.md
@@ -4,7 +4,7 @@ assignees:
- lavalamp
- deads2k
- liggitt
-
+title: Using Authorization Plugins
---
In Kubernetes, authorization happens as a separate step from authentication.
@@ -299,9 +299,8 @@ subjects:
name: jane
roleRef:
kind: Role
- namespace: default
name: pod-reader
- apiVersion: rbac.authorization.k8s.io/v1alpha1
+ apiGroup: rbac.authorization.k8s.io
```
`RoleBindings` may also refer to a `ClusterRole`. However, a `RoleBinding` that
@@ -326,26 +325,26 @@ subjects:
roleRef:
kind: ClusterRole
name: secret-reader
- apiVersion: rbac.authorization.k8s.io/v1alpha1
+ apiGroup: rbac.authorization.k8s.io
```
Finally a `ClusterRoleBinding` may be used to grant permissions in all
namespaces. The following `ClusterRoleBinding` allows any user in the group
-"manager" to read secrets in any namepsace.
+"manager" to read secrets in any namespace.
```yaml
# This cluster role binding allows anyone in the "manager" group to read secrets in any namespace.
kind: ClusterRoleBinding
apiVersion: rbac.authorization.k8s.io/v1alpha1
metadata:
- name: read-secrets
+ name: read-secrets-global
subjects:
- kind: Group # May be "User", "Group" or "ServiceAccount"
name: manager
roleRef:
kind: ClusterRole
- name: secret-reader
- apiVersion: rbac.authorization.k8s.io/v1alpha1
+ name: secret-reader
+ apiGroup: rbac.authorization.k8s.io
```
### Referring to Resources
diff --git a/docs/admin/cluster-components.md b/docs/admin/cluster-components.md
index c1bcae8577..aa79489bbb 100644
--- a/docs/admin/cluster-components.md
+++ b/docs/admin/cluster-components.md
@@ -1,7 +1,7 @@
---
assignees:
- lavalamp
-
+title: Kubernetes Components
---
This document outlines the various binary components that need to run to
@@ -61,12 +61,12 @@ selects a node for them to run on.
### addons
-Addons are pods and services that implement cluster features. They don't run on
-the master VM, but currently the default setup scripts that make the API calls
-to create these pods and services does run on the master VM. See:
-[kube-master-addons](http://releases.k8s.io/HEAD/cluster/saltbase/salt/kube-master-addons/kube-master-addons.sh)
+Addons are pods and services that implement cluster features. The pods may be managed
+by Deployments, ReplicationContollers, etc. Namespaced addon objects are created in
+the "kube-system" namespace.
-Addon objects are created in the "kube-system" namespace.
+Addon manager takes the responsibility for creating and maintaining addon resources.
+See [here](http://releases.k8s.io/HEAD/cluster/addons) for more details.
#### DNS
diff --git a/docs/admin/cluster-large.md b/docs/admin/cluster-large.md
index d2285c3346..f41df12689 100644
--- a/docs/admin/cluster-large.md
+++ b/docs/admin/cluster-large.md
@@ -1,11 +1,10 @@
----
-assignees:
-- davidopp
-- lavalamp
-
----
-
-
+---
+assignees:
+- davidopp
+- lavalamp
+title: Building Large Clusters
+---
+
## Support
At {{page.version}}, Kubernetes supports clusters with up to 1000 nodes. More specifically, we support configurations that meet *all* of the following criteria:
diff --git a/docs/admin/cluster-management.md b/docs/admin/cluster-management.md
index 97362c4bab..5bcdb8b8f3 100644
--- a/docs/admin/cluster-management.md
+++ b/docs/admin/cluster-management.md
@@ -2,7 +2,7 @@
assignees:
- lavalamp
- thockin
-
+title: Cluster Management Guide
---
* TOC
@@ -92,7 +92,7 @@ an extended period of time (10min but it may change in the future).
Cluster autoscaler is configured per instance group (GCE) or node pool (GKE).
If you are using GCE then you can either enable it while creating a cluster with kube-up.sh script.
-To configure cluser autoscaler you have to set 3 environment variables:
+To configure cluster autoscaler you have to set 3 environment variables:
* `KUBE_ENABLE_CLUSTER_AUTOSCALER` - it enables cluster autoscaler if set to true.
* `KUBE_AUTOSCALER_MIN_NODES` - minimum number of nodes in the cluster.
@@ -180,7 +180,7 @@ For the purposes of these flags, _legacy_ APIs are those APIs which have been ex
The objects that are stored to disk for a cluster's internal representation of the Kubernetes resources active in the cluster are written using a particular version of the API.
When the supported API changes, these objects may need to be rewritten in the newer API. Failure to do this will eventually result in resources that are no longer decodable or usable
-by the kubernetes API server.
+by the Kubernetes API server.
`KUBE_API_VERSIONS` environment variable for the `kube-apiserver` binary which controls the API versions that are supported in the cluster. The first version in the list is used as the cluster's storage version. Hence, to set a specific version as the storage version, bring it to the front of list of versions in the value of `KUBE_API_VERSIONS`. You need to restart the `kube-apiserver` binary
for changes to this variable to take effect.
diff --git a/docs/admin/cluster-troubleshooting.md b/docs/admin/cluster-troubleshooting.md
index 8bab089ce6..ff8358a7a9 100644
--- a/docs/admin/cluster-troubleshooting.md
+++ b/docs/admin/cluster-troubleshooting.md
@@ -1,7 +1,7 @@
---
assignees:
- davidopp
-
+title: Troubleshooting Clusters
---
This doc is about cluster troubleshooting; we assume you have already ruled out your application as the root cause of the
@@ -89,7 +89,7 @@ Mitigations:
- Mitigates: Apiserver VM shutdown or apiserver crashing
- Mitigates: Supporting services VM shutdown or crashes
-- Action use IaaS providers reliable storage (e.g GCE PD or AWS EBS volume) for VMs with apiserver+etcd
+- Action use IaaS providers reliable storage (e.g. GCE PD or AWS EBS volume) for VMs with apiserver+etcd
- Mitigates: Apiserver backing storage lost
- Action: Use (experimental) [high-availability](/docs/admin/high-availability) configuration
diff --git a/docs/admin/daemons.md b/docs/admin/daemons.md
index be3137bc93..4682a62b71 100644
--- a/docs/admin/daemons.md
+++ b/docs/admin/daemons.md
@@ -1,26 +1,26 @@
---
assignees:
- erictune
-
+title: Daemon Sets
---
* TOC
{:toc}
-## What is a _Daemon Set_?
+## What is a DaemonSet?
-A _Daemon Set_ ensures that all (or some) nodes run a copy of a pod. As nodes are added to the
+A _DaemonSet_ ensures that all (or some) nodes run a copy of a pod. As nodes are added to the
cluster, pods are added to them. As nodes are removed from the cluster, those pods are garbage
-collected. Deleting a Daemon Set will clean up the pods it created.
+collected. Deleting a DaemonSet will clean up the pods it created.
-Some typical uses of a Daemon Set are:
+Some typical uses of a DaemonSet are:
- running a cluster storage daemon, such as `glusterd`, `ceph`, on each node.
- running a logs collection daemon on every node, such as `fluentd` or `logstash`.
- running a node monitoring daemon on every node, such as [Prometheus Node Exporter](
https://github.com/prometheus/node_exporter), `collectd`, New Relic agent, or Ganglia `gmond`.
-In a simple case, one Daemon Set, covering all nodes, would be used for each type of daemon.
+In a simple case, one DaemonSet, covering all nodes, would be used for each type of daemon.
A more complex setup might use multiple DaemonSets would be used for a single type of daemon,
but with different flags and/or different memory and cpu requests for different hardware types.
@@ -74,7 +74,7 @@ a node for testing.
If you specify a `.spec.template.spec.nodeSelector`, then the DaemonSet controller will
create pods on nodes which match that [node
-selector](https://github.com/kubernetes/kubernetes.github.io/tree/{{page.docsbranch}}/docs/user-guide/node-selection).
+selector](/docs/user-guide/node-selection/).
If you specify a `scheduler.alpha.kubernetes.io/affinity` annotation in `.spec.template.metadata.annotations`,
then DaemonSet controller will create pods on nodes which match that [node affinity](../../user-guide/node-selection/#alpha-feature-in-kubernetes-v12-node-affinity).
@@ -88,18 +88,17 @@ created by the Daemon controller have the machine already selected (`.spec.nodeN
when the pod is created, so it is ignored by the scheduler). Therefore:
- the [`unschedulable`](/docs/admin/node/#manual-node-administration) field of a node is not respected
- by the daemon set controller.
- - daemon set controller can make pods even when the scheduler has not been started, which can help cluster
+ by the DaemonSet controller.
+ - DaemonSet controller can make pods even when the scheduler has not been started, which can help cluster
bootstrap.
## Communicating with DaemonSet Pods
Some possible patterns for communicating with pods in a DaemonSet are:
-- **Push**: Pods in the Daemon Set are configured to send updates to another service, such
+- **Push**: Pods in the DaemonSet are configured to send updates to another service, such
as a stats database. They do not have clients.
-- **NodeIP and Known Port**: Pods in the Daemon Set use a `hostPort`, so that the pods are reachable
- via the node IPs. Clients knows the the list of nodes ips somehow, and know the port by convention.
+- **NodeIP and Known Port**: Pods in the DaemonSet use a `hostPort`, so that the pods are reachable via the node IPs. Clients know the list of nodes ips somehow, and know the port by convention.
- **DNS**: Create a [headless service](/docs/user-guide/services/#headless-services) with the same pod selector,
and then discover DaemonSets using the `endpoints` resource or retrieve multiple A records from
DNS.
@@ -126,11 +125,11 @@ You cannot update a DaemonSet.
Support for updating DaemonSets and controlled updating of nodes is planned.
-## Alternatives to Daemon Set
+## Alternatives to DaemonSet
### Init Scripts
-It is certainly possible to run daemon processes by directly starting them on a node (e.g using
+It is certainly possible to run daemon processes by directly starting them on a node (e.g. using
`init`, `upstartd`, or `systemd`). This is perfectly fine. However, there are several advantages to
running such processes via a DaemonSet:
@@ -145,9 +144,9 @@ running such processes via a DaemonSet:
### Bare Pods
It is possible to create pods directly which specify a particular node to run on. However,
-a Daemon Set replaces pods that are deleted or terminated for any reason, such as in the case of
+a DaemonSet replaces pods that are deleted or terminated for any reason, such as in the case of
node failure or disruptive node maintenance, such as a kernel upgrade. For this reason, you should
-use a Daemon Set rather than creating individual pods.
+use a DaemonSet rather than creating individual pods.
### Static Pods
@@ -159,7 +158,7 @@ in cluster bootstrapping cases. Also, static pods may be deprecated in the futu
### Replication Controller
-Daemon Set are similar to [Replication Controllers](/docs/user-guide/replication-controller) in that
+DaemonSet are similar to [Replication Controllers](/docs/user-guide/replication-controller) in that
they both create pods, and those pods have processes which are not expected to terminate (e.g. web servers,
storage servers).
diff --git a/docs/admin/disruptions.md b/docs/admin/disruptions.md
index df94c58cf2..6c4ee7df4a 100644
--- a/docs/admin/disruptions.md
+++ b/docs/admin/disruptions.md
@@ -1,7 +1,7 @@
---
assignees:
- davidopp
-
+title: Pod Disruption Budget
---
This guide is for anyone wishing to specify safety constraints on pods or anyone
wishing to write software (typically automation software) that respects those
diff --git a/docs/admin/dns.md b/docs/admin/dns.md
index 372d9a026e..0ee1fca395 100644
--- a/docs/admin/dns.md
+++ b/docs/admin/dns.md
@@ -3,7 +3,7 @@ assignees:
- ArtfulCoder
- davidopp
- lavalamp
-
+title: Using DNS Pods and Services
---
## Introduction
@@ -60,7 +60,7 @@ of the form `auto-generated-name.my-svc.my-namespace.svc.cluster.local`.
### Backwards compatibility
-Previous versions of kube-dns made names of the for
+Previous versions of kube-dns made names of the form
`my-svc.my-namespace.cluster.local` (the 'svc' level was added later). This
is no longer supported.
@@ -70,14 +70,14 @@ is no longer supported.
When enabled, pods are assigned a DNS A record in the form of `pod-ip-address.my-namespace.pod.cluster.local`.
-For example, a pod with ip `1.2.3.4` in the namespace `default` with a dns name of `cluster.local` would have an entry: `1-2-3-4.default.pod.cluster.local`.
+For example, a pod with ip `1.2.3.4` in the namespace `default` with a DNS name of `cluster.local` would have an entry: `1-2-3-4.default.pod.cluster.local`.
#### A Records and hostname based on Pod's hostname and subdomain fields
Currently when a pod is created, its hostname is the Pod's `metadata.name` value.
With v1.2, users can specify a Pod annotation, `pod.beta.kubernetes.io/hostname`, to specify what the Pod's hostname should be.
-The Pod annotation, if specified, takes precendence over the Pod's name, to be the hostname of the pod.
+The Pod annotation, if specified, takes precedence over the Pod's name, to be the hostname of the pod.
For example, given a Pod with annotation `pod.beta.kubernetes.io/hostname: my-pod-name`, the Pod will have its hostname set to "my-pod-name".
With v1.3, the PodSpec has a `hostname` field, which can be used to specify the Pod's hostname. This field value takes precedence over the
@@ -94,13 +94,43 @@ Example:
```yaml
apiVersion: v1
+kind: Service
+metadata:
+ name: default-subdomain
+spec:
+ selector:
+ name: busybox
+ clusterIP: None
+ ports:
+ - name: foo # Actually, no port is needed.
+ port: 1234
+ targetPort: 1234
+---
+apiVersion: v1
kind: Pod
metadata:
- name: busybox
- namespace: default
+ name: busybox1
+ labels:
+ name: busybox
spec:
hostname: busybox-1
- subdomain: default
+ subdomain: default-subdomain
+ containers:
+ - image: busybox
+ command:
+ - sleep
+ - "3600"
+ name: busybox
+---
+apiVersion: v1
+kind: Pod
+metadata:
+ name: busybox2
+ labels:
+ name: busybox
+spec:
+ hostname: busybox-2
+ subdomain: default-subdomain
containers:
- image: busybox
command:
@@ -110,11 +140,11 @@ spec:
```
If there exists a headless service in the same namespace as the pod and with the same name as the subdomain, the cluster's KubeDNS Server also returns an A record for the Pod's fully qualified hostname.
-Given a Pod with the hostname set to "foo" and the subdomain set to "bar", and a headless Service named "bar" in the same namespace, the pod will see it's own FQDN as "foo.bar.my-namespace.svc.cluster.local". DNS serves an A record at that name, pointing to the Pod's IP.
+Given a Pod with the hostname set to "busybox-1" and the subdomain set to "default-subdomain", and a headless Service named "default-subdomain" in the same namespace, the pod will see it's own FQDN as "busybox-1.default-subdomain.my-namespace.svc.cluster.local". DNS serves an A record at that name, pointing to the Pod's IP. Both pods "busybox1" and "busybox2" can have their distinct A records.
-With v1.2, the Endpoints object also has a new annotation `endpoints.beta.kubernetes.io/hostnames-map`. Its value is the json representation of map[string(IP)][endpoints.HostRecord], for example: '{"10.245.1.6":{HostName: "my-webserver"}}'.
+As of Kubernetes v1.2, the Endpoints object also has the annotation `endpoints.beta.kubernetes.io/hostnames-map`. Its value is the json representation of map[string(IP)][endpoints.HostRecord], for example: '{"10.245.1.6":{HostName: "my-webserver"}}'.
If the Endpoints are for a headless service, an A record is created with the format ...svc.
-For the example json, if endpoints are for a headless service named "bar", and one of the endpoints has IP "10.245.1.6", an A is created with the name "my-webserver.bar.my-namespace.svc.cluster.local" and the A record lookup would return "10.245.1.6".
+For the example json, if endpoints are for a headless service named "bar", and one of the endpoints has IP "10.245.1.6", an A record is created with the name "my-webserver.bar.my-namespace.svc.cluster.local" and the A record lookup would return "10.245.1.6".
This endpoints annotation generally does not need to be specified by end-users, but can used by the internal service controller to deliver the aforementioned feature.
With v1.3, The Endpoints object can specify the `hostname` for any endpoint, along with its IP. The hostname field takes precedence over the hostname value
@@ -171,7 +201,7 @@ busybox 1/1 Running 0
Once that pod is running, you can exec nslookup in that environment:
```
-kubectl exec busybox -- nslookup kubernetes.default
+kubectl exec -ti busybox -- nslookup kubernetes.default
```
You should see something like:
@@ -194,10 +224,10 @@ If the nslookup command fails, check the following:
Take a look inside the resolv.conf file. (See "Inheriting DNS from the node" and "Known issues" below for more information)
```
-cat /etc/resolv.conf
+kubectl exec busybox cat /etc/resolv.conf
```
-Verify that the search path and name server are set up like the following (note that seach path may vary for different cloud providers):
+Verify that the search path and name server are set up like the following (note that search path may vary for different cloud providers):
```
search default.svc.cluster.local svc.cluster.local cluster.local google.internal c.gce_project_id.internal
@@ -210,7 +240,7 @@ options ndots:5
Errors such as the following indicate a problem with the kube-dns add-on or associated Services:
```
-$ kubectl exec busybox -- nslookup kubernetes.default
+$ kubectl exec -ti busybox -- nslookup kubernetes.default
Server: 10.0.0.10
Address 1: 10.0.0.10
@@ -220,7 +250,7 @@ nslookup: can't resolve 'kubernetes.default'
or
```
-$ kubectl exec busybox -- nslookup kubernetes.default
+$ kubectl exec -ti busybox -- nslookup kubernetes.default
Server: 10.0.0.10
Address 1: 10.0.0.10 kube-dns.kube-system.svc.cluster.local
@@ -244,21 +274,21 @@ kube-dns-v19-ezo1y 3/3 Running 0
...
```
-If you see that no pod is running or that the pod has failed/completed, the dns add-on may not be deployed by default in your current environment and you will have to deploy it manually.
+If you see that no pod is running or that the pod has failed/completed, the DNS add-on may not be deployed by default in your current environment and you will have to deploy it manually.
#### Check for Errors in the DNS pod
Use `kubectl logs` command to see logs for the DNS daemons.
```
-kubectl logs --namespace=kube-system $(kubectl get pods --namespace=kube-system -l k8s-app=kube-dns -o name) -c kubedns
+kubectl logs --namespace=kube-system $(kubectl get pods --namespace=kube-system -l k8s-app=kube-dns -o name) -c kube-dns
kubectl logs --namespace=kube-system $(kubectl get pods --namespace=kube-system -l k8s-app=kube-dns -o name) -c dnsmasq
kubectl logs --namespace=kube-system $(kubectl get pods --namespace=kube-system -l k8s-app=kube-dns -o name) -c healthz
```
See if there is any suspicious log. W, E, F letter at the beginning represent Warning, Error and Failure. Please search for entries that have these as the logging level and use [kubernetes issues](https://github.com/kubernetes/kubernetes/issues) to report unexpected errors.
-#### Is dns service up?
+#### Is DNS service up?
Verify that the DNS service is up by using the `kubectl get service` command.
@@ -277,7 +307,7 @@ kube-dns 10.0.0.10 53/UDP,53/TCP 1h
If you have created the service or in the case it should be created by default but it does not appear, see this [debugging services page](http://kubernetes.io/docs/user-guide/debugging-services/) for more information.
-#### Are dns endpoints exposed?
+#### Are DNS endpoints exposed?
You can verify that dns endpoints are exposed by using the `kubectl get endpoints` command.
@@ -348,13 +378,13 @@ some of those settings will be lost. As a partial workaround, the node can run
`dnsmasq` which will provide more `nameserver` entries, but not more `search`
entries. You can also use kubelet's `--resolv-conf` flag.
-If you are using Alpine version 3.3 or earlier as your base image, dns may not
+If you are using Alpine version 3.3 or earlier as your base image, DNS may not
work properly owing to a known issue with Alpine. Check [here](https://github.com/kubernetes/kubernetes/issues/30215)
for more information.
## References
-- [Docs for the DNS cluster addon](http://releases.k8s.io/{{page.githubbranch}}/build-tools/kube-dns/README.md)
+- [Docs for the DNS cluster addon](http://releases.k8s.io/{{page.githubbranch}}/build/kube-dns/README.md)
## What's next
- [Autoscaling the DNS Service in a Cluster](/docs/tasks/administer-cluster/dns-horizontal-autoscaling/).
diff --git a/docs/admin/etcd.md b/docs/admin/etcd.md
index 14b36a33be..ea4f6b09b3 100644
--- a/docs/admin/etcd.md
+++ b/docs/admin/etcd.md
@@ -1,10 +1,9 @@
---
assignees:
- lavalamp
-
+title: Configuring Kubernetes Use of etcd
---
-
[etcd](https://coreos.com/etcd/docs/2.2.1/) is a highly-available key value
store which Kubernetes uses for persistent storage of all of its REST API
objects.
diff --git a/docs/admin/federation-apiserver.md b/docs/admin/federation-apiserver.md
index 00fb08c1a0..9eb760d087 100644
--- a/docs/admin/federation-apiserver.md
+++ b/docs/admin/federation-apiserver.md
@@ -1,4 +1,6 @@
---
+title: federation-apiserver
+notitle: true
---
## federation-apiserver
@@ -20,10 +22,11 @@ federation-apiserver
### Options
```
- --admission-control string Ordered list of plug-ins to do admission control of resources into cluster. Comma-delimited list of: AlwaysAdmit, AlwaysDeny, NamespaceLifecycle. (default "AlwaysAdmit")
+ --admission-control string Ordered list of plug-ins to do admission control of resources into cluster. Comma-delimited list of: AlwaysAdmit, AlwaysDeny, NamespaceLifecycle, OwnerReferencesPermissionEnforcement. (default "AlwaysAdmit")
--admission-control-config-file string File with admission control configuration.
- --advertise-address value The IP address on which to advertise the apiserver to members of the cluster. This address must be reachable by the rest of the cluster. If blank, the --bind-address will be used. If --bind-address is unspecified, the host's default interface will be used.
- --apiserver-count int The number of apiservers running in the cluster. (default 1)
+ --advertise-address ip The IP address on which to advertise the apiserver to members of the cluster. This address must be reachable by the rest of the cluster. If blank, the --bind-address will be used. If --bind-address is unspecified, the host's default interface will be used.
+ --anonymous-auth Enables anonymous requests to the secure port of the API server. Requests that are not rejected by another authentication method are treated as anonymous requests. Anonymous requests have a username of system:anonymous, and a group name of system:unauthenticated. (default true)
+ --apiserver-count int The number of apiservers running in the cluster. Must be a positive number. (default 1)
--audit-log-maxage int The maximum number of days to retain old audit log files based on the timestamp encoded in their filename.
--audit-log-maxbackup int The maximum number of old audit log files to retain.
--audit-log-maxsize int The maximum size in megabytes of the audit log file before it gets rotated. Defaults to 100MB.
@@ -35,64 +38,71 @@ federation-apiserver
--authorization-webhook-cache-unauthorized-ttl duration The duration to cache 'unauthorized' responses from the webhook authorizer. Default is 30s. (default 30s)
--authorization-webhook-config-file string File with webhook configuration in kubeconfig format, used with --authorization-mode=Webhook. The API server will query the remote service to determine access on the API server's secure port.
--basic-auth-file string If set, the file that will be used to admit requests to the secure port of the API server via http basic authentication.
- --bind-address value The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank, all interfaces will be used (0.0.0.0). (default 0.0.0.0)
+ --bind-address ip The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank, all interfaces will be used (0.0.0.0). (default 0.0.0.0)
--cert-dir string The directory where the TLS certs are located (by default /var/run/kubernetes). If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored. (default "/var/run/kubernetes")
--client-ca-file string If set, any request presenting a client certificate signed by one of the authorities in the client-ca-file is authenticated with an identity corresponding to the CommonName of the client certificate.
--cloud-config string The path to the cloud provider configuration file. Empty string for no configuration file.
--cloud-provider string The provider for cloud services. Empty string for no provider.
- --cors-allowed-origins value List of allowed origins for CORS, comma separated. An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled. (default [])
+ --contention-profiling Enable contention profiling. Requires --profiling to be set to work.
+ --cors-allowed-origins stringSlice List of allowed origins for CORS, comma separated. An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled.
--delete-collection-workers int Number of workers spawned for DeleteCollection call. These are used to speed up namespace cleanup. (default 1)
--deserialization-cache-size int Number of deserialized json objects to cache in memory.
+ --enable-garbage-collector Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-controller-manager. (default true)
--enable-swagger-ui Enables swagger ui on the apiserver at /swagger-ui
--etcd-cafile string SSL Certificate Authority file used to secure etcd communication.
--etcd-certfile string SSL certification file used to secure etcd communication.
--etcd-keyfile string SSL key file used to secure etcd communication.
--etcd-prefix string The prefix for all resource paths in etcd. (default "/registry")
--etcd-quorum-read If true, enable quorum read.
- --etcd-servers value List of etcd servers to connect with (http://ip:port), comma separated. (default [])
- --etcd-servers-overrides value Per-resource etcd servers overrides, comma separated. The individual override format: group/resource#servers, where servers are http://ip:port, semicolon separated. (default [])
+ --etcd-servers stringSlice List of etcd servers to connect with (scheme://ip:port), comma separated.
+ --etcd-servers-overrides stringSlice Per-resource etcd servers overrides, comma separated. The individual override format: group/resource#servers, where servers are http://ip:port, semicolon separated.
--event-ttl duration Amount of time to retain events. Default is 1h. (default 1h0m0s)
+ --experimental-keystone-ca-file string If set, the Keystone server's certificate will be verified by one of the authorities in the experimental-keystone-ca-file, otherwise the host's root CA set will be used.
--experimental-keystone-url string If passed, activates the keystone authentication plugin.
--external-hostname string The hostname to use when generating externalized URLs for this master (e.g. Swagger API Docs).
- --feature-gates value A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
+ --feature-gates mapStringBool A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
AllAlpha=true|false (ALPHA - default=false)
-AllowExtTrafficLocalEndpoints=true|false (ALPHA - default=false)
+AllowExtTrafficLocalEndpoints=true|false (BETA - default=true)
AppArmor=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
DynamicVolumeProvisioning=true|false (ALPHA - default=true)
- --insecure-bind-address value The IP address on which to serve the --insecure-port (set to 0.0.0.0 for all interfaces). Defaults to localhost. (default 127.0.0.1)
+ExperimentalHostUserNamespaceDefaulting=true|false (ALPHA - default=false)
+StreamingProxyRedirects=true|false (ALPHA - default=false)
+ --insecure-allow-any-token username/group1,group2 If set, your server will be INSECURE. Any token will be allowed and user information will be parsed from the token as username/group1,group2
+ --insecure-bind-address ip The IP address on which to serve the --insecure-port (set to 0.0.0.0 for all interfaces). Defaults to localhost. (default 127.0.0.1)
--insecure-port int The port on which to serve unsecured, unauthenticated access. Default 8080. It is assumed that firewall rules are set up such that this port is not reachable from outside of the cluster and that port 443 on the cluster's public address is proxied to this port. This is performed by nginx in the default setup. (default 8080)
--kubernetes-service-node-port int If non-zero, the Kubernetes master service (which apiserver creates/maintains) will be of type NodePort, using this as the value of the port. If zero, the Kubernetes master service will be of type ClusterIP.
--long-running-request-regexp string A regular expression matching long running requests which should be excluded from maximum inflight request handling. (default "(/|^)((watch|proxy)(/|$)|(logs?|portforward|exec|attach)/?$)")
- --master-service-namespace string The namespace from which the kubernetes master services should be injected into pods. (default "default")
+ --master-service-namespace string DEPRECATED: the namespace from which the kubernetes master services should be injected into pods. (default "default")
--max-requests-inflight int The maximum number of requests in flight at a given time. When the server exceeds this, it rejects requests. Zero for no limit. (default 400)
--min-request-timeout int An optional field indicating the minimum number of seconds a handler must keep a request open before timing it out. Currently only honored by the watch request handler, which picks a randomized value above this number as the connection timeout, to spread out load. (default 1800)
--oidc-ca-file string If set, the OpenID server's certificate will be verified by one of the authorities in the oidc-ca-file, otherwise the host's root CA set will be used.
--oidc-client-id string The client ID for the OpenID Connect client, must be set if oidc-issuer-url is set.
- --oidc-groups-claim string If provided, the name of a custom OpenID Connect claim for specifying user groups. The claim value is expected to be an array of strings. This flag is experimental, please see the authentication documentation for further details.
+ --oidc-groups-claim string If provided, the name of a custom OpenID Connect claim for specifying user groups. The claim value is expected to be a string or array of strings. This flag is experimental, please see the authentication documentation for further details.
--oidc-issuer-url string The URL of the OpenID issuer, only HTTPS scheme will be accepted. If set, it will be used to verify the OIDC JSON Web Token (JWT).
--oidc-username-claim string The OpenID claim to use as the user name. Note that claims other than the default ('sub') is not guaranteed to be unique and immutable. This flag is experimental, please see the authentication documentation for further details. (default "sub")
--profiling Enable profiling via web interface host:port/debug/pprof/ (default true)
- --runtime-config value A set of key=value pairs that describe runtime configuration that may be passed to apiserver. apis/ key can be used to turn on/off specific api versions. apis// can be used to turn on/off specific resources. api/all and api/legacy are special keys to control all and legacy api versions respectively.
+ --requestheader-allowed-names stringSlice List of client certificate common names to allow to provide usernames in headers specified by --requestheader-username-headers. If empty, any client certificate validated by the authorities in --requestheader-client-ca-file is allowed.
+ --requestheader-client-ca-file string Root certificate bundle to use to verify client certificates on incoming requests before trusting usernames in headers specified by --requestheader-username-headers
+ --requestheader-username-headers stringSlice List of request headers to inspect for usernames. X-Remote-User is common.
+ --runtime-config mapStringString A set of key=value pairs that describe runtime configuration that may be passed to apiserver. apis/ key can be used to turn on/off specific api versions. apis// can be used to turn on/off specific resources. api/all and api/legacy are special keys to control all and legacy api versions respectively.
--secure-port int The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all. (default 6443)
- --service-cluster-ip-range value A CIDR notation IP range from which to assign service cluster IPs. This must not overlap with any IP ranges assigned to nodes for pods.
- --service-node-port-range value A port range to reserve for services with NodePort visibility. Example: '30000-32767'. Inclusive at both ends of the range. (default 30000-32767)
+ --service-cluster-ip-range ipNet A CIDR notation IP range from which to assign service cluster IPs. This must not overlap with any IP ranges assigned to nodes for pods.
+ --service-node-port-range portRange A port range to reserve for services with NodePort visibility. Example: '30000-32767'. Inclusive at both ends of the range. (default 30000-32767)
--storage-backend string The storage backend for persistence. Options: 'etcd2' (default), 'etcd3'.
--storage-media-type string The media type to use to store objects in storage. Defaults to application/json. Some resources may only support a specific media type and will ignore this setting. (default "application/json")
- --storage-versions string The per-group version to store resources in. Specified in the format "group1/version1,group2/version2,...". In the case where objects are moved from one group to the other, you may specify the format "group1=group2/v1beta1,group3/v1beta1,...". You only need to pass the groups you wish to change from the defaults. It defaults to a list of preferred versions of all registered groups, which is derived from the KUBE_API_VERSIONS environment variable. (default "apps/v1alpha1,authentication.k8s.io/v1beta1,authorization.k8s.io/v1beta1,autoscaling/v1,batch/v1,certificates.k8s.io/v1alpha1,componentconfig/v1alpha1,extensions/v1beta1,federation/v1beta1,policy/v1alpha1,rbac.authorization.k8s.io/v1alpha1,storage.k8s.io/v1beta1,v1")
+ --storage-versions string The per-group version to store resources in. Specified in the format "group1/version1,group2/version2,...". In the case where objects are moved from one group to the other, you may specify the format "group1=group2/v1beta1,group3/v1beta1,...". You only need to pass the groups you wish to change from the defaults. It defaults to a list of preferred versions of all registered groups, which is derived from the KUBE_API_VERSIONS environment variable. (default "apps/v1beta1,authentication.k8s.io/v1beta1,authorization.k8s.io/v1beta1,autoscaling/v1,batch/v1,certificates.k8s.io/v1alpha1,componentconfig/v1alpha1,extensions/v1beta1,federation/v1beta1,policy/v1beta1,rbac.authorization.k8s.io/v1alpha1,storage.k8s.io/v1beta1,v1")
--target-ram-mb int Memory limit for apiserver in MB (used to configure sizes of caches, etc.)
- --tls-cert-file string File containing x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to /var/run/kubernetes.
- --tls-private-key-file string File containing x509 private key matching --tls-cert-file.
+ --tls-ca-file string If set, this certificate authority will used for secure access from Admission Controllers. This must be a valid PEM-encoded CA bundle.
+ --tls-cert-file string File containing the default x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to /var/run/kubernetes.
+ --tls-private-key-file string File containing the default x509 private key matching --tls-cert-file.
+ --tls-sni-cert-key namedCertKey A pair of x509 certificate and private key file paths, optionally suffixed with a list of domain patterns which are fully qualified domain names, possibly with prefixed wildcard segments. If no domain patterns are provided, the names of the certificate are extracted. Non-wildcard matches trump over wildcard matches, explicit domain patterns trump over extracted names. For multiple key/certificate pairs, use the --tls-sni-cert-key multiple times. Examples: "example.key,example.crt" or "*.foo.com,foo.com:foo.key,foo.crt". (default [])
--token-auth-file string If set, the file that will be used to secure the secure port of the API server via token authentication.
--watch-cache Enable watch caching in the apiserver (default true)
- --watch-cache-sizes value List of watch cache sizes for every resource (pods, nodes, etc.), comma separated. The individual override format: resource#size, where size is a number. It takes effect when watch-cache is enabled. (default [])
+ --watch-cache-sizes stringSlice List of watch cache sizes for every resource (pods, nodes, etc.), comma separated. The individual override format: resource#size, where size is a number. It takes effect when watch-cache is enabled.
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
diff --git a/docs/admin/federation-controller-manager.md b/docs/admin/federation-controller-manager.md
index d73dde0b9e..d3dca5bf06 100644
--- a/docs/admin/federation-controller-manager.md
+++ b/docs/admin/federation-controller-manager.md
@@ -1,4 +1,6 @@
---
+title: federation-controller-mananger
+notitle: true
---
## federation-controller-manager
@@ -23,14 +25,14 @@ federation-controller-manager
### Options
```
- --address value The IP address to serve on (set to 0.0.0.0 for all interfaces) (default 0.0.0.0)
+ --address ip The IP address to serve on (set to 0.0.0.0 for all interfaces) (default 0.0.0.0)
--cluster-monitor-period duration The period for syncing ClusterStatus in ClusterController. (default 40s)
--concurrent-replicaset-syncs int The number of ReplicaSets syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load (default 10)
--concurrent-service-syncs int The number of service syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load (default 10)
- --dns-provider string DNS provider. Valid values are: ["aws-route53" "google-clouddns"]
+ --dns-provider string DNS provider. Valid values are: ["google-clouddns" "aws-route53"]
--dns-provider-config string Path to config file for configuring DNS provider.
--federated-api-burst int Burst to use while talking with federation apiserver (default 30)
- --federated-api-qps value QPS to use while talking with federation apiserver (default 20)
+ --federated-api-qps float32 QPS to use while talking with federation apiserver (default 20)
--federation-name string Federation name.
--kube-api-content-type string ContentType of requests sent to apiserver. Passing application/vnd.kubernetes.protobuf is an experimental feature now.
--kubeconfig string Path to kubeconfig file with authorization and master location information.
@@ -41,14 +43,12 @@ federation-controller-manager
--master string The address of the federation API server (overrides any value in kubeconfig)
--port int The port that the controller-manager's http service runs on (default 10253)
--profiling Enable profiling via web interface host:port/debug/pprof/ (default true)
+ --service-dns-suffix string DNS Suffix to use when publishing federated service names. Defaults to zone-name
+ --zone-id string Zone ID, needed if the zone name is not unique.
--zone-name string Zone name, like example.com.
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
diff --git a/docs/admin/federation/index.md b/docs/admin/federation/index.md
index ec40d581bb..59a0199d7b 100644
--- a/docs/admin/federation/index.md
+++ b/docs/admin/federation/index.md
@@ -3,8 +3,9 @@ assignees:
- madhusudancs
- mml
- nikhiljindal
-
+title: Using `federation-up` and `deploy.sh`
---
+
This guide explains how to set up cluster federation that lets us control multiple Kubernetes clusters.
@@ -109,7 +110,7 @@ $ KUBE_REGISTRY="gcr.io/myrepository" federation/develop/develop.sh build_image
$ KUBE_REGISTRY="gcr.io/myrepository" federation/develop/develop.sh push
```
-Note: This is going to overwite the values you might have set for
+Note: This is going to overwrite the values you might have set for
`apiserverRegistry`, `apiserverVersion`, `controllerManagerRegistry` and
`controllerManagerVersion` in your `${FEDERATION_OUTPUT_ROOT}/values.yaml`
file. Hence, it is not recommend to customize these values in
@@ -217,7 +218,7 @@ Once you've registered your cluster with the federation, you'll need to update K
### Kubernetes 1.5+: Passing federations flag via config map to kube-dns
-For kubernetes clusters of version 1.5+, you can pass the
+For Kubernetes clusters of version 1.5+, you can pass the
`--federations` flag to kube-dns via the kube-dns config map.
The flag uses the following format:
@@ -351,7 +352,7 @@ $ KUBERNETES_PROVIDER=gce FEDERATION_DNS_PROVIDER=google-clouddns FEDERATION_NAM
set appropriately if it is missing and `KUBERNETES_PROVIDER` is one of `gce`, `gke` and `aws`.
This is used to resolve DNS requests for federation services. The service
controller keeps DNS records with the provider updated as services/pods are
-updated in underlying kubernetes clusters.
+updated in underlying Kubernetes clusters.
`FEDERATION_NAME` is a name you can choose for your federation. This is the name that will appear in DNS routes.
diff --git a/docs/admin/federation/kubefed.md b/docs/admin/federation/kubefed.md
index de40263ecb..52d83d3535 100644
--- a/docs/admin/federation/kubefed.md
+++ b/docs/admin/federation/kubefed.md
@@ -3,6 +3,10 @@ assignees:
- madhusudancs
---
+
+* TOC
+{:toc}
+
Kubernetes version 1.5 includes a new command line tool called
`kubefed` to help you administrate your federated clusters.
`kubefed` helps you to deploy a new Kubernetes cluster federation
@@ -14,11 +18,6 @@ using `kubefed`.
> Note: `kubefed` is an alpha feature in Kubernetes 1.5.
-
-* TOC
-{:toc}
-
-
## Prerequisites
This guide assumes that you have a running Kubernetes cluster. Please
@@ -61,8 +60,8 @@ The output should contain an entry corresponding to your host cluster,
similar to the following:
```
-CURRENT NAME CLUSTER AUTHINFO NAMESPACE
- gke_myproject_asia-east1-b_gce-asia-east1 gke_myproject_asia-east1-b_gce-asia-east1 gke_myproject_asia-east1-b_gce-asia-east1
+CURRENT NAME CLUSTER AUTHINFO NAMESPACE
+ gke_myproject_asia-east1-b_gce-asia-east1 gke_myproject_asia-east1-b_gce-asia-east1 gke_myproject_asia-east1-b_gce-asia-east1
```
diff --git a/docs/admin/garbage-collection.md b/docs/admin/garbage-collection.md
index a3112a07f1..3a8ecda475 100644
--- a/docs/admin/garbage-collection.md
+++ b/docs/admin/garbage-collection.md
@@ -1,7 +1,7 @@
---
assignees:
- mikedanese
-
+title: Configuring kubelet Garbage Collection
---
* TOC
@@ -13,11 +13,11 @@ External garbage collection tools are not recommended as these tools can potenti
### Image Collection
-kubernetes manages lifecycle of all images through imageManager, with the cooperation
+Kubernetes manages lifecycle of all images through imageManager, with the cooperation
of cadvisor.
The policy for garbage collecting images takes two factors into consideration:
-`HighThresholdPercent` and `LowThresholdPercent`. Disk usage above the the high threshold
+`HighThresholdPercent` and `LowThresholdPercent`. Disk usage above the high threshold
will trigger garbage collection. The garbage collection will delete least recently used images until the low
threshold has been met.
diff --git a/docs/admin/ha-master-gce.md b/docs/admin/ha-master-gce.md
index 262dafbe0a..871ce56606 100644
--- a/docs/admin/ha-master-gce.md
+++ b/docs/admin/ha-master-gce.md
@@ -24,7 +24,7 @@ If true, reads will be directed to leader etcd replica.
Setting this value to true is optional: reads will be more reliable but will also be slower.
Optionally, you can specify a GCE zone where the first master replica is to be created.
-Set the the following flag:
+Set the following flag:
* `KUBE_GCE_ZONE=zone` - zone where the first master replica will run.
diff --git a/docs/admin/high-availability/index.md b/docs/admin/high-availability/index.md
index ad78270e4a..42e51d3d51 100644
--- a/docs/admin/high-availability/index.md
+++ b/docs/admin/high-availability/index.md
@@ -1,7 +1,7 @@
----
-
----
-
+---
+title: Building High-Availability Clusters
+---
+
## Introduction
This document describes how to build a high-availability (HA) Kubernetes cluster. This is a fairly advanced topic.
diff --git a/docs/admin/index.md b/docs/admin/index.md
index 3624bb4202..68b669cc10 100644
--- a/docs/admin/index.md
+++ b/docs/admin/index.md
@@ -2,7 +2,7 @@
assignees:
- davidopp
- lavalamp
-
+title: Admin Guide
---
The cluster admin guide is for anyone creating or administering a Kubernetes cluster.
@@ -13,7 +13,7 @@ It assumes some familiarity with concepts in the [User Guide](/docs/user-guide/)
## Planning a cluster
-There are many different examples of how to setup a kubernetes cluster. Many of them are listed in this
+There are many different examples of how to setup a Kubernetes cluster. Many of them are listed in this
[matrix](/docs/getting-started-guides/). We call each of the combinations in this matrix a *distro*.
Before choosing a particular guide, here are some things to consider:
@@ -25,12 +25,12 @@ Before choosing a particular guide, here are some things to consider:
- Will your cluster be on-premises, or in the cloud (IaaS)? Kubernetes does not directly support hybrid clusters. We
recommend setting up multiple clusters rather than spanning distant locations.
- Will you be running Kubernetes on "bare metal" or virtual machines? Kubernetes supports both, via different distros.
- - Do you just want to run a cluster, or do you expect to do active development of kubernetes project code? If the
+ - Do you just want to run a cluster, or do you expect to do active development of Kubernetes project code? If the
latter, it is better to pick a distro actively used by other developers. Some distros only use binary releases, but
offer is a greater variety of choices.
- Not all distros are maintained as actively. Prefer ones which are listed as tested on a more recent version of
Kubernetes.
- - If you are configuring kubernetes on-premises, you will need to consider what [networking
+ - If you are configuring Kubernetes on-premises, you will need to consider what [networking
model](/docs/admin/networking) fits best.
- If you are designing for very high-availability, you may want [clusters in multiple zones](/docs/admin/multi-cluster).
- You may want to familiarize yourself with the various
diff --git a/docs/admin/kube-apiserver.md b/docs/admin/kube-apiserver.md
index 4e24cd2d89..1e2c8a602e 100644
--- a/docs/admin/kube-apiserver.md
+++ b/docs/admin/kube-apiserver.md
@@ -1,4 +1,6 @@
---
+title: kube-apiserver
+notitle: true
---
## kube-apiserver
@@ -20,11 +22,12 @@ kube-apiserver
### Options
```
- --admission-control string Ordered list of plug-ins to do admission control of resources into cluster. Comma-delimited list of: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, DefaultStorageClass, DenyEscalatingExec, DenyExecOnPrivileged, ImagePolicyWebhook, InitialResources, LimitPodHardAntiAffinityTopology, LimitRanger, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, PersistentVolumeLabel, PodSecurityPolicy, ResourceQuota, SecurityContextDeny, ServiceAccount. (default "AlwaysAdmit")
+ --admission-control string Ordered list of plug-ins to do admission control of resources into cluster. Comma-delimited list of: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, DefaultStorageClass, DenyEscalatingExec, DenyExecOnPrivileged, ImagePolicyWebhook, InitialResources, LimitPodHardAntiAffinityTopology, LimitRanger, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, OwnerReferencesPermissionEnforcement, PersistentVolumeLabel, PodNodeSelector, PodSecurityPolicy, ResourceQuota, SecurityContextDeny, ServiceAccount. (default "AlwaysAdmit")
--admission-control-config-file string File with admission control configuration.
- --advertise-address value The IP address on which to advertise the apiserver to members of the cluster. This address must be reachable by the rest of the cluster. If blank, the --bind-address will be used. If --bind-address is unspecified, the host's default interface will be used.
+ --advertise-address ip The IP address on which to advertise the apiserver to members of the cluster. This address must be reachable by the rest of the cluster. If blank, the --bind-address will be used. If --bind-address is unspecified, the host's default interface will be used.
--allow-privileged If true, allow privileged containers.
- --apiserver-count int The number of apiservers running in the cluster. (default 1)
+ --anonymous-auth Enables anonymous requests to the secure port of the API server. Requests that are not rejected by another authentication method are treated as anonymous requests. Anonymous requests have a username of system:anonymous, and a group name of system:unauthenticated. (default true)
+ --apiserver-count int The number of apiservers running in the cluster. Must be a positive number. (default 1)
--audit-log-maxage int The maximum number of days to retain old audit log files based on the timestamp encoded in their filename.
--audit-log-maxbackup int The maximum number of old audit log files to retain.
--audit-log-maxsize int The maximum size in megabytes of the audit log file before it gets rotated. Defaults to 100MB.
@@ -38,12 +41,13 @@ kube-apiserver
--authorization-webhook-cache-unauthorized-ttl duration The duration to cache 'unauthorized' responses from the webhook authorizer. Default is 30s. (default 30s)
--authorization-webhook-config-file string File with webhook configuration in kubeconfig format, used with --authorization-mode=Webhook. The API server will query the remote service to determine access on the API server's secure port.
--basic-auth-file string If set, the file that will be used to admit requests to the secure port of the API server via http basic authentication.
- --bind-address value The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank, all interfaces will be used (0.0.0.0). (default 0.0.0.0)
+ --bind-address ip The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank, all interfaces will be used (0.0.0.0). (default 0.0.0.0)
--cert-dir string The directory where the TLS certs are located (by default /var/run/kubernetes). If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored. (default "/var/run/kubernetes")
--client-ca-file string If set, any request presenting a client certificate signed by one of the authorities in the client-ca-file is authenticated with an identity corresponding to the CommonName of the client certificate.
--cloud-config string The path to the cloud provider configuration file. Empty string for no configuration file.
--cloud-provider string The provider for cloud services. Empty string for no provider.
- --cors-allowed-origins value List of allowed origins for CORS, comma separated. An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled. (default [])
+ --contention-profiling Enable contention profiling. Requires --profiling to be set to work.
+ --cors-allowed-origins stringSlice List of allowed origins for CORS, comma separated. An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled.
--delete-collection-workers int Number of workers spawned for DeleteCollection call. These are used to speed up namespace cleanup. (default 1)
--deserialization-cache-size int Number of deserialized json objects to cache in memory.
--enable-garbage-collector Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-controller-manager. (default true)
@@ -53,62 +57,68 @@ kube-apiserver
--etcd-keyfile string SSL key file used to secure etcd communication.
--etcd-prefix string The prefix for all resource paths in etcd. (default "/registry")
--etcd-quorum-read If true, enable quorum read.
- --etcd-servers value List of etcd servers to connect with (http://ip:port), comma separated. (default [])
- --etcd-servers-overrides value Per-resource etcd servers overrides, comma separated. The individual override format: group/resource#servers, where servers are http://ip:port, semicolon separated. (default [])
+ --etcd-servers stringSlice List of etcd servers to connect with (scheme://ip:port), comma separated.
+ --etcd-servers-overrides stringSlice Per-resource etcd servers overrides, comma separated. The individual override format: group/resource#servers, where servers are http://ip:port, semicolon separated.
--event-ttl duration Amount of time to retain events. Default is 1h. (default 1h0m0s)
+ --experimental-keystone-ca-file string If set, the Keystone server's certificate will be verified by one of the authorities in the experimental-keystone-ca-file, otherwise the host's root CA set will be used.
--experimental-keystone-url string If passed, activates the keystone authentication plugin.
--external-hostname string The hostname to use when generating externalized URLs for this master (e.g. Swagger API Docs).
- --feature-gates value A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
+ --feature-gates mapStringBool A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
AllAlpha=true|false (ALPHA - default=false)
-AllowExtTrafficLocalEndpoints=true|false (ALPHA - default=false)
+AllowExtTrafficLocalEndpoints=true|false (BETA - default=true)
AppArmor=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
DynamicVolumeProvisioning=true|false (ALPHA - default=true)
+ExperimentalHostUserNamespaceDefaulting=true|false (ALPHA - default=false)
+StreamingProxyRedirects=true|false (ALPHA - default=false)
--google-json-key string The Google Cloud Platform Service Account JSON Key to use for authentication.
- --insecure-bind-address value The IP address on which to serve the --insecure-port (set to 0.0.0.0 for all interfaces). Defaults to localhost. (default 127.0.0.1)
+ --insecure-allow-any-token username/group1,group2 If set, your server will be INSECURE. Any token will be allowed and user information will be parsed from the token as username/group1,group2
+ --insecure-bind-address ip The IP address on which to serve the --insecure-port (set to 0.0.0.0 for all interfaces). Defaults to localhost. (default 127.0.0.1)
--insecure-port int The port on which to serve unsecured, unauthenticated access. Default 8080. It is assumed that firewall rules are set up such that this port is not reachable from outside of the cluster and that port 443 on the cluster's public address is proxied to this port. This is performed by nginx in the default setup. (default 8080)
--kubelet-certificate-authority string Path to a cert file for the certificate authority.
--kubelet-client-certificate string Path to a client cert file for TLS.
--kubelet-client-key string Path to a client key file for TLS.
--kubelet-https Use https for kubelet connections. (default true)
+ --kubelet-preferred-address-types stringSlice List of the preferred NodeAddressTypes to use for kubelet connections. (default [Hostname,InternalIP,ExternalIP,LegacyHostIP])
--kubelet-timeout duration Timeout for kubelet operations. (default 5s)
--kubernetes-service-node-port int If non-zero, the Kubernetes master service (which apiserver creates/maintains) will be of type NodePort, using this as the value of the port. If zero, the Kubernetes master service will be of type ClusterIP.
--long-running-request-regexp string A regular expression matching long running requests which should be excluded from maximum inflight request handling. (default "(/|^)((watch|proxy)(/|$)|(logs?|portforward|exec|attach)/?$)")
- --master-service-namespace string The namespace from which the kubernetes master services should be injected into pods. (default "default")
+ --master-service-namespace string DEPRECATED: the namespace from which the kubernetes master services should be injected into pods. (default "default")
--max-connection-bytes-per-sec int If non-zero, throttle each user connection to this number of bytes/sec. Currently only applies to long-running requests.
--max-requests-inflight int The maximum number of requests in flight at a given time. When the server exceeds this, it rejects requests. Zero for no limit. (default 400)
--min-request-timeout int An optional field indicating the minimum number of seconds a handler must keep a request open before timing it out. Currently only honored by the watch request handler, which picks a randomized value above this number as the connection timeout, to spread out load. (default 1800)
--oidc-ca-file string If set, the OpenID server's certificate will be verified by one of the authorities in the oidc-ca-file, otherwise the host's root CA set will be used.
--oidc-client-id string The client ID for the OpenID Connect client, must be set if oidc-issuer-url is set.
- --oidc-groups-claim string If provided, the name of a custom OpenID Connect claim for specifying user groups. The claim value is expected to be an array of strings. This flag is experimental, please see the authentication documentation for further details.
+ --oidc-groups-claim string If provided, the name of a custom OpenID Connect claim for specifying user groups. The claim value is expected to be a string or array of strings. This flag is experimental, please see the authentication documentation for further details.
--oidc-issuer-url string The URL of the OpenID issuer, only HTTPS scheme will be accepted. If set, it will be used to verify the OIDC JSON Web Token (JWT).
--oidc-username-claim string The OpenID claim to use as the user name. Note that claims other than the default ('sub') is not guaranteed to be unique and immutable. This flag is experimental, please see the authentication documentation for further details. (default "sub")
--profiling Enable profiling via web interface host:port/debug/pprof/ (default true)
--repair-malformed-updates If true, server will do its best to fix the update request to pass the validation, e.g., setting empty UID in update request to its existing value. This flag can be turned off after we fix all the clients that send malformed updates. (default true)
- --runtime-config value A set of key=value pairs that describe runtime configuration that may be passed to apiserver. apis/ key can be used to turn on/off specific api versions. apis// can be used to turn on/off specific resources. api/all and api/legacy are special keys to control all and legacy api versions respectively.
+ --requestheader-allowed-names stringSlice List of client certificate common names to allow to provide usernames in headers specified by --requestheader-username-headers. If empty, any client certificate validated by the authorities in --requestheader-client-ca-file is allowed.
+ --requestheader-client-ca-file string Root certificate bundle to use to verify client certificates on incoming requests before trusting usernames in headers specified by --requestheader-username-headers
+ --requestheader-username-headers stringSlice List of request headers to inspect for usernames. X-Remote-User is common.
+ --runtime-config mapStringString A set of key=value pairs that describe runtime configuration that may be passed to apiserver. apis/ key can be used to turn on/off specific api versions. apis// can be used to turn on/off specific resources. api/all and api/legacy are special keys to control all and legacy api versions respectively.
--secure-port int The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all. (default 6443)
- --service-account-key-file string File containing PEM-encoded x509 RSA private or public key, used to verify ServiceAccount tokens. If unspecified, --tls-private-key-file is used.
+ --service-account-key-file stringArray File containing PEM-encoded x509 RSA or ECDSA private or public keys, used to verify ServiceAccount tokens. If unspecified, --tls-private-key-file is used. The specified file can contain multiple keys, and the flag can be specified multiple times with different files.
--service-account-lookup If true, validate ServiceAccount tokens exist in etcd as part of authentication.
- --service-cluster-ip-range value A CIDR notation IP range from which to assign service cluster IPs. This must not overlap with any IP ranges assigned to nodes for pods.
- --service-node-port-range value A port range to reserve for services with NodePort visibility. Example: '30000-32767'. Inclusive at both ends of the range. (default 30000-32767)
+ --service-cluster-ip-range ipNet A CIDR notation IP range from which to assign service cluster IPs. This must not overlap with any IP ranges assigned to nodes for pods.
+ --service-node-port-range portRange A port range to reserve for services with NodePort visibility. Example: '30000-32767'. Inclusive at both ends of the range. (default 30000-32767)
--ssh-keyfile string If non-empty, use secure SSH proxy to the nodes, using this user keyfile
--ssh-user string If non-empty, use secure SSH proxy to the nodes, using this user name
--storage-backend string The storage backend for persistence. Options: 'etcd2' (default), 'etcd3'.
--storage-media-type string The media type to use to store objects in storage. Defaults to application/json. Some resources may only support a specific media type and will ignore this setting. (default "application/json")
- --storage-versions string The per-group version to store resources in. Specified in the format "group1/version1,group2/version2,...". In the case where objects are moved from one group to the other, you may specify the format "group1=group2/v1beta1,group3/v1beta1,...". You only need to pass the groups you wish to change from the defaults. It defaults to a list of preferred versions of all registered groups, which is derived from the KUBE_API_VERSIONS environment variable. (default "apps/v1alpha1,authentication.k8s.io/v1beta1,authorization.k8s.io/v1beta1,autoscaling/v1,batch/v1,certificates.k8s.io/v1alpha1,componentconfig/v1alpha1,extensions/v1beta1,imagepolicy.k8s.io/v1alpha1,policy/v1alpha1,rbac.authorization.k8s.io/v1alpha1,storage.k8s.io/v1beta1,v1")
+ --storage-versions string The per-group version to store resources in. Specified in the format "group1/version1,group2/version2,...". In the case where objects are moved from one group to the other, you may specify the format "group1=group2/v1beta1,group3/v1beta1,...". You only need to pass the groups you wish to change from the defaults. It defaults to a list of preferred versions of all registered groups, which is derived from the KUBE_API_VERSIONS environment variable. (default "apps/v1beta1,authentication.k8s.io/v1beta1,authorization.k8s.io/v1beta1,autoscaling/v1,batch/v1,certificates.k8s.io/v1alpha1,componentconfig/v1alpha1,extensions/v1beta1,imagepolicy.k8s.io/v1alpha1,policy/v1beta1,rbac.authorization.k8s.io/v1alpha1,storage.k8s.io/v1beta1,v1")
--target-ram-mb int Memory limit for apiserver in MB (used to configure sizes of caches, etc.)
- --tls-cert-file string File containing x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to /var/run/kubernetes.
- --tls-private-key-file string File containing x509 private key matching --tls-cert-file.
+ --tls-ca-file string If set, this certificate authority will used for secure access from Admission Controllers. This must be a valid PEM-encoded CA bundle.
+ --tls-cert-file string File containing the default x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to /var/run/kubernetes.
+ --tls-private-key-file string File containing the default x509 private key matching --tls-cert-file.
+ --tls-sni-cert-key namedCertKey A pair of x509 certificate and private key file paths, optionally suffixed with a list of domain patterns which are fully qualified domain names, possibly with prefixed wildcard segments. If no domain patterns are provided, the names of the certificate are extracted. Non-wildcard matches trump over wildcard matches, explicit domain patterns trump over extracted names. For multiple key/certificate pairs, use the --tls-sni-cert-key multiple times. Examples: "example.key,example.crt" or "*.foo.com,foo.com:foo.key,foo.crt". (default [])
--token-auth-file string If set, the file that will be used to secure the secure port of the API server via token authentication.
--watch-cache Enable watch caching in the apiserver (default true)
- --watch-cache-sizes value List of watch cache sizes for every resource (pods, nodes, etc.), comma separated. The individual override format: resource#size, where size is a number. It takes effect when watch-cache is enabled. (default [])
+ --watch-cache-sizes stringSlice List of watch cache sizes for every resource (pods, nodes, etc.), comma separated. The individual override format: resource#size, where size is a number. It takes effect when watch-cache is enabled.
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
diff --git a/docs/admin/kube-controller-manager.md b/docs/admin/kube-controller-manager.md
index c6db5ea858..82dd43cbcd 100644
--- a/docs/admin/kube-controller-manager.md
+++ b/docs/admin/kube-controller-manager.md
@@ -1,4 +1,6 @@
---
+title: kube-controller-manager
+notitle: true
---
## kube-controller-manager
@@ -24,7 +26,7 @@ kube-controller-manager
### Options
```
- --address value The IP address to serve on (set to 0.0.0.0 for all interfaces) (default 0.0.0.0)
+ --address ip The IP address to serve on (set to 0.0.0.0 for all interfaces) (default 0.0.0.0)
--allocate-node-cidrs Should CIDRs for Pods be allocated and set on the cloud provider.
--cloud-config string The path to the cloud provider configuration file. Empty string for no configuration file.
--cloud-provider string The provider for cloud services. Empty string for no provider.
@@ -32,37 +34,39 @@ kube-controller-manager
--cluster-name string The instance prefix for the cluster (default "kubernetes")
--cluster-signing-cert-file string Filename containing a PEM-encoded X509 CA certificate used to issue cluster-scoped certificates (default "/etc/kubernetes/ca/ca.pem")
--cluster-signing-key-file string Filename containing a PEM-encoded RSA or ECDSA private key used to sign cluster-scoped certificates (default "/etc/kubernetes/ca/ca.key")
- --concurrent-deployment-syncs value The number of deployment objects that are allowed to sync concurrently. Larger number = more responsive deployments, but more CPU (and network) load (default 5)
- --concurrent-endpoint-syncs value The number of endpoint syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load (default 5)
- --concurrent-gc-syncs value The number of garbage collector workers that are allowed to sync concurrently. (default 20)
- --concurrent-namespace-syncs value The number of namespace objects that are allowed to sync concurrently. Larger number = more responsive namespace termination, but more CPU (and network) load (default 2)
- --concurrent-replicaset-syncs value The number of replica sets that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load (default 5)
- --concurrent-resource-quota-syncs value The number of resource quotas that are allowed to sync concurrently. Larger number = more responsive quota management, but more CPU (and network) load (default 5)
- --concurrent-service-syncs value The number of services that are allowed to sync concurrently. Larger number = more responsive service management, but more CPU (and network) load (default 1)
- --concurrent-serviceaccount-token-syncs value The number of service account token objects that are allowed to sync concurrently. Larger number = more responsive token generation, but more CPU (and network) load (default 5)
- --concurrent_rc_syncs value The number of replication controllers that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load (default 5)
+ --concurrent-deployment-syncs int32 The number of deployment objects that are allowed to sync concurrently. Larger number = more responsive deployments, but more CPU (and network) load (default 5)
+ --concurrent-endpoint-syncs int32 The number of endpoint syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load (default 5)
+ --concurrent-gc-syncs int32 The number of garbage collector workers that are allowed to sync concurrently. (default 20)
+ --concurrent-namespace-syncs int32 The number of namespace objects that are allowed to sync concurrently. Larger number = more responsive namespace termination, but more CPU (and network) load (default 2)
+ --concurrent-replicaset-syncs int32 The number of replica sets that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load (default 5)
+ --concurrent-resource-quota-syncs int32 The number of resource quotas that are allowed to sync concurrently. Larger number = more responsive quota management, but more CPU (and network) load (default 5)
+ --concurrent-service-syncs int32 The number of services that are allowed to sync concurrently. Larger number = more responsive service management, but more CPU (and network) load (default 1)
+ --concurrent-serviceaccount-token-syncs int32 The number of service account token objects that are allowed to sync concurrently. Larger number = more responsive token generation, but more CPU (and network) load (default 5)
+ --concurrent_rc_syncs int32 The number of replication controllers that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load (default 5)
--configure-cloud-routes Should CIDRs allocated by allocate-node-cidrs be configured on the cloud provider. (default true)
- --controller-start-interval duration Interval between starting controller managers. (default 0s)
- --daemonset-lookup-cache-size value The the size of lookup cache for daemonsets. Larger number = more responsive daemonsets, but more MEM load. (default 1024)
+ --controller-start-interval duration Interval between starting controller managers.
+ --daemonset-lookup-cache-size int32 The size of lookup cache for daemonsets. Larger number = more responsive daemonsets, but more MEM load. (default 1024)
--deployment-controller-sync-period duration Period for syncing the deployments. (default 30s)
--enable-dynamic-provisioning Enable dynamic provisioning for environments that support it. (default true)
--enable-garbage-collector Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-apiserver. (default true)
--enable-hostpath-provisioner Enable HostPath PV provisioning when running without a cloud provider. This allows testing and development of provisioning features. HostPath provisioning is not supported in any way, won't work in a multi-node cluster, and should not be used for anything other than testing or development.
- --feature-gates value A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
+ --feature-gates mapStringBool A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
AllAlpha=true|false (ALPHA - default=false)
-AllowExtTrafficLocalEndpoints=true|false (ALPHA - default=false)
+AllowExtTrafficLocalEndpoints=true|false (BETA - default=true)
AppArmor=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
DynamicVolumeProvisioning=true|false (ALPHA - default=true)
+ExperimentalHostUserNamespaceDefaulting=true|false (ALPHA - default=false)
+StreamingProxyRedirects=true|false (ALPHA - default=false)
--flex-volume-plugin-dir string Full path of the directory in which the flex volume plugin should search for additional third party volume plugins. (default "/usr/libexec/kubernetes/kubelet-plugins/volume/exec/")
--google-json-key string The Google Cloud Platform Service Account JSON Key to use for authentication.
--horizontal-pod-autoscaler-sync-period duration The period for syncing the number of pods in horizontal pod autoscaler. (default 30s)
--insecure-experimental-approve-all-kubelet-csrs-for-group string The group for which the controller-manager will auto approve all CSRs for kubelet client certificates.
- --kube-api-burst value Burst to use while talking with kubernetes apiserver (default 30)
+ --kube-api-burst int32 Burst to use while talking with Kubernetes apiserver (default 30)
--kube-api-content-type string Content type of requests sent to apiserver. (default "application/vnd.kubernetes.protobuf")
- --kube-api-qps value QPS to use while talking with kubernetes apiserver (default 20)
+ --kube-api-qps float32 QPS to use while talking with Kubernetes apiserver (default 20)
--kubeconfig string Path to kubeconfig file with authorization and master location information.
- --large-cluster-size-threshold value Number of nodes from which NodeController treats the cluster as large for the eviction logic purposes. --secondary-node-eviction-rate is implicitly overridden to 0 for clusters this size or smaller. (default 50)
+ --large-cluster-size-threshold int32 Number of nodes from which NodeController treats the cluster as large for the eviction logic purposes. --secondary-node-eviction-rate is implicitly overridden to 0 for clusters this size or smaller. (default 50)
--leader-elect Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability. (default true)
--leader-elect-lease-duration duration The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled. (default 15s)
--leader-elect-renew-deadline duration The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled. (default 10s)
@@ -70,39 +74,36 @@ DynamicVolumeProvisioning=true|false (ALPHA - default=true)
--master string The address of the Kubernetes API server (overrides any value in kubeconfig)
--min-resync-period duration The resync period in reflectors will be random between MinResyncPeriod and 2*MinResyncPeriod (default 12h0m0s)
--namespace-sync-period duration The period for syncing namespace life-cycle updates (default 5m0s)
- --node-cidr-mask-size value Mask size for node cidr in cluster. (default 24)
- --node-eviction-rate value Number of nodes per second on which pods are deleted in case of node failure when a zone is healthy (see --unhealthy-zone-threshold for definition of healthy/unhealthy). Zone refers to entire cluster in non-multizone clusters. (default 0.1)
+ --node-cidr-mask-size int32 Mask size for node cidr in cluster. (default 24)
+ --node-eviction-rate float32 Number of nodes per second on which pods are deleted in case of node failure when a zone is healthy (see --unhealthy-zone-threshold for definition of healthy/unhealthy). Zone refers to entire cluster in non-multizone clusters. (default 0.1)
--node-monitor-grace-period duration Amount of time which we allow running Node to be unresponsive before marking it unhealthy. Must be N times more than kubelet's nodeStatusUpdateFrequency, where N means number of retries allowed for kubelet to post node status. (default 40s)
--node-monitor-period duration The period for syncing NodeStatus in NodeController. (default 5s)
--node-startup-grace-period duration Amount of time which we allow starting Node to be unresponsive before marking it unhealthy. (default 1m0s)
- --node-sync-period duration The period for syncing nodes from cloudprovider. Longer periods will result in fewer calls to cloud provider, but may delay addition of new nodes to cluster. (default 10s)
--pod-eviction-timeout duration The grace period for deleting pods on failed nodes. (default 5m0s)
- --port value The port that the controller-manager's http service runs on (default 10252)
+ --port int32 The port that the controller-manager's http service runs on (default 10252)
--profiling Enable profiling via web interface host:port/debug/pprof/ (default true)
- --pv-recycler-increment-timeout-nfs value the increment of time added per Gi to ActiveDeadlineSeconds for an NFS scrubber pod (default 30)
- --pv-recycler-minimum-timeout-hostpath value The minimum ActiveDeadlineSeconds to use for a HostPath Recycler pod. This is for development and testing only and will not work in a multi-node cluster. (default 60)
- --pv-recycler-minimum-timeout-nfs value The minimum ActiveDeadlineSeconds to use for an NFS Recycler pod (default 300)
+ --pv-recycler-increment-timeout-nfs int32 the increment of time added per Gi to ActiveDeadlineSeconds for an NFS scrubber pod (default 30)
+ --pv-recycler-minimum-timeout-hostpath int32 The minimum ActiveDeadlineSeconds to use for a HostPath Recycler pod. This is for development and testing only and will not work in a multi-node cluster. (default 60)
+ --pv-recycler-minimum-timeout-nfs int32 The minimum ActiveDeadlineSeconds to use for an NFS Recycler pod (default 300)
--pv-recycler-pod-template-filepath-hostpath string The file path to a pod definition used as a template for HostPath persistent volume recycling. This is for development and testing only and will not work in a multi-node cluster.
--pv-recycler-pod-template-filepath-nfs string The file path to a pod definition used as a template for NFS persistent volume recycling
- --pv-recycler-timeout-increment-hostpath value the increment of time added per Gi to ActiveDeadlineSeconds for a HostPath scrubber pod. This is for development and testing only and will not work in a multi-node cluster. (default 30)
+ --pv-recycler-timeout-increment-hostpath int32 the increment of time added per Gi to ActiveDeadlineSeconds for a HostPath scrubber pod. This is for development and testing only and will not work in a multi-node cluster. (default 30)
--pvclaimbinder-sync-period duration The period for syncing persistent volumes and persistent volume claims (default 15s)
- --replicaset-lookup-cache-size value The the size of lookup cache for replicatsets. Larger number = more responsive replica management, but more MEM load. (default 4096)
- --replication-controller-lookup-cache-size value The the size of lookup cache for replication controllers. Larger number = more responsive replica management, but more MEM load. (default 4096)
+ --replicaset-lookup-cache-size int32 The size of lookup cache for replicatsets. Larger number = more responsive replica management, but more MEM load. (default 4096)
+ --replication-controller-lookup-cache-size int32 The size of lookup cache for replication controllers. Larger number = more responsive replica management, but more MEM load. (default 4096)
--resource-quota-sync-period duration The period for syncing quota usage status in the system (default 5m0s)
--root-ca-file string If set, this root certificate authority will be included in service account's token secret. This must be a valid PEM-encoded CA bundle.
- --secondary-node-eviction-rate value Number of nodes per second on which pods are deleted in case of node failure when a zone is unhealthy (see --unhealthy-zone-threshold for definition of healthy/unhealthy). Zone refers to entire cluster in non-multizone clusters. This value is implicitly overridden to 0 if the cluster size is smaller than --large-cluster-size-threshold. (default 0.01)
- --service-account-private-key-file string Filename containing a PEM-encoded private RSA key used to sign service account tokens.
+ --route-reconciliation-period duration The period for reconciling routes created for Nodes by cloud provider. (default 10s)
+ --secondary-node-eviction-rate float32 Number of nodes per second on which pods are deleted in case of node failure when a zone is unhealthy (see --unhealthy-zone-threshold for definition of healthy/unhealthy). Zone refers to entire cluster in non-multizone clusters. This value is implicitly overridden to 0 if the cluster size is smaller than --large-cluster-size-threshold. (default 0.01)
+ --service-account-private-key-file string Filename containing a PEM-encoded private RSA or ECDSA key used to sign service account tokens.
--service-cluster-ip-range string CIDR Range for Services in cluster.
--service-sync-period duration The period for syncing services with their external load balancers (default 5m0s)
- --terminated-pod-gc-threshold value Number of terminated pods that can exist before the terminated pod garbage collector starts deleting terminated pods. If <= 0, the terminated pod garbage collector is disabled. (default 12500)
- --unhealthy-zone-threshold value Fraction of Nodes in a zone which needs to be not Ready (minimum 3) for zone to be treated as unhealthy. (default 0.55)
+ --terminated-pod-gc-threshold int32 Number of terminated pods that can exist before the terminated pod garbage collector starts deleting terminated pods. If <= 0, the terminated pod garbage collector is disabled. (default 12500)
+ --unhealthy-zone-threshold float32 Fraction of Nodes in a zone which needs to be not Ready (minimum 3) for zone to be treated as unhealthy. (default 0.55)
+ --use-service-account-credentials If true, use individual service account credentials for each controller.
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
diff --git a/docs/admin/kube-proxy.md b/docs/admin/kube-proxy.md
index 98480612cb..ea13d528e3 100644
--- a/docs/admin/kube-proxy.md
+++ b/docs/admin/kube-proxy.md
@@ -1,4 +1,6 @@
---
+title: kube-proxy
+notitle: true
---
## kube-proxy
@@ -23,42 +25,42 @@ kube-proxy
### Options
```
- --bind-address value The IP address for the proxy server to serve on (set to 0.0.0.0 for all interfaces) (default 0.0.0.0)
+ --bind-address ip The IP address for the proxy server to serve on (set to 0.0.0.0 for all interfaces) (default 0.0.0.0)
--cleanup-iptables If true cleanup iptables rules and exit.
--cluster-cidr string The CIDR range of pods in the cluster. It is used to bridge traffic coming from outside of the cluster. If not provided, no off-cluster bridging will be performed.
--config-sync-period duration How often configuration from the apiserver is refreshed. Must be greater than 0. (default 15m0s)
- --conntrack-max-per-core value Maximum number of NAT connections to track per CPU core (0 to leave the limit as-is and ignore conntrack-min). (default 32768)
- --conntrack-min value Minimum number of conntrack entries to allocate, regardless of conntrack-max-per-core (set conntrack-max-per-core=0 to leave the limit as-is). (default 131072)
+ --conntrack-max-per-core int32 Maximum number of NAT connections to track per CPU core (0 to leave the limit as-is and ignore conntrack-min). (default 32768)
+ --conntrack-min int32 Minimum number of conntrack entries to allocate, regardless of conntrack-max-per-core (set conntrack-max-per-core=0 to leave the limit as-is). (default 131072)
+ --conntrack-tcp-timeout-close-wait duration NAT timeout for TCP connections in the CLOSE_WAIT state (default 1h0m0s)
--conntrack-tcp-timeout-established duration Idle timeout for established TCP connections (0 to leave as-is) (default 24h0m0s)
- --feature-gates value A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
+ --feature-gates mapStringBool A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
AllAlpha=true|false (ALPHA - default=false)
-AllowExtTrafficLocalEndpoints=true|false (ALPHA - default=false)
+AllowExtTrafficLocalEndpoints=true|false (BETA - default=true)
AppArmor=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
DynamicVolumeProvisioning=true|false (ALPHA - default=true)
+ExperimentalHostUserNamespaceDefaulting=true|false (ALPHA - default=false)
+StreamingProxyRedirects=true|false (ALPHA - default=false)
--google-json-key string The Google Cloud Platform Service Account JSON Key to use for authentication.
- --healthz-bind-address value The IP address for the health check server to serve on, defaulting to 127.0.0.1 (set to 0.0.0.0 for all interfaces) (default 127.0.0.1)
- --healthz-port value The port to bind the health check server. Use 0 to disable. (default 10249)
+ --healthz-bind-address ip The IP address for the health check server to serve on, defaulting to 127.0.0.1 (set to 0.0.0.0 for all interfaces) (default 127.0.0.1)
+ --healthz-port int32 The port to bind the health check server. Use 0 to disable. (default 10249)
--hostname-override string If non-empty, will use this string as identification instead of the actual hostname.
- --iptables-masquerade-bit value If using the pure iptables proxy, the bit of the fwmark space to mark packets requiring SNAT with. Must be within the range [0, 31]. (default 14)
- --iptables-sync-period duration How often iptables rules are refreshed (e.g. '5s', '1m', '2h22m'). Must be greater than 0. (default 30s)
- --kube-api-burst value Burst to use while talking with kubernetes apiserver (default 10)
+ --iptables-masquerade-bit int32 If using the pure iptables proxy, the bit of the fwmark space to mark packets requiring SNAT with. Must be within the range [0, 31]. (default 14)
+ --iptables-min-sync-period duration The minimum interval of how often the iptables rules can be refreshed as endpoints and services change (e.g. '5s', '1m', '2h22m').
+ --iptables-sync-period duration The maximum interval of how often iptables rules are refreshed (e.g. '5s', '1m', '2h22m'). Must be greater than 0. (default 30s)
+ --kube-api-burst int32 Burst to use while talking with Kubernetes apiserver (default 10)
--kube-api-content-type string Content type of requests sent to apiserver. (default "application/vnd.kubernetes.protobuf")
- --kube-api-qps value QPS to use while talking with kubernetes apiserver (default 5)
+ --kube-api-qps float32 QPS to use while talking with Kubernetes apiserver (default 5)
--kubeconfig string Path to kubeconfig file with authorization information (the master location is set by the master flag).
--masquerade-all If using the pure iptables proxy, SNAT everything
--master string The address of the Kubernetes API server (overrides any value in kubeconfig)
- --oom-score-adj value The oom-score-adj value for kube-proxy process. Values must be within the range [-1000, 1000] (default -999)
- --proxy-mode value Which proxy mode to use: 'userspace' (older) or 'iptables' (faster). If blank, look at the Node object on the Kubernetes API and respect the 'net.experimental.kubernetes.io/proxy-mode' annotation if provided. Otherwise use the best-available proxy (currently iptables). If the iptables proxy is selected, regardless of how, but the system's kernel or iptables versions are insufficient, this always falls back to the userspace proxy.
- --proxy-port-range value Range of host ports (beginPort-endPort, inclusive) that may be consumed in order to proxy service traffic. If unspecified (0-0) then ports will be randomly chosen.
+ --oom-score-adj int32 The oom-score-adj value for kube-proxy process. Values must be within the range [-1000, 1000] (default -999)
+ --proxy-mode ProxyMode Which proxy mode to use: 'userspace' (older) or 'iptables' (faster). If blank, look at the Node object on the Kubernetes API and respect the 'net.experimental.kubernetes.io/proxy-mode' annotation if provided. Otherwise use the best-available proxy (currently iptables). If the iptables proxy is selected, regardless of how, but the system's kernel or iptables versions are insufficient, this always falls back to the userspace proxy.
+ --proxy-port-range port-range Range of host ports (beginPort-endPort, inclusive) that may be consumed in order to proxy service traffic. If unspecified (0-0) then ports will be randomly chosen.
--udp-timeout duration How long an idle UDP connection will be kept open (e.g. '250ms', '2s'). Must be greater than 0. Only applicable for proxy-mode=userspace (default 250ms)
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
diff --git a/docs/admin/kube-scheduler.md b/docs/admin/kube-scheduler.md
index 3316d7e10d..15e47d2f46 100644
--- a/docs/admin/kube-scheduler.md
+++ b/docs/admin/kube-scheduler.md
@@ -1,4 +1,6 @@
---
+title: kube-scheduler
+notitle: true
---
## kube-scheduler
@@ -24,19 +26,21 @@ kube-scheduler
```
--address string The IP address to serve on (set to 0.0.0.0 for all interfaces) (default "0.0.0.0")
- --algorithm-provider string The scheduling algorithm provider to use, one of: DefaultProvider | ClusterAutoscalerProvider (default "DefaultProvider")
+ --algorithm-provider string The scheduling algorithm provider to use, one of: ClusterAutoscalerProvider | DefaultProvider (default "DefaultProvider")
--failure-domains string Indicate the "all topologies" set for an empty topologyKey when it's used for PreferredDuringScheduling pod anti-affinity. (default "kubernetes.io/hostname,failure-domain.beta.kubernetes.io/zone,failure-domain.beta.kubernetes.io/region")
- --feature-gates value A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
+ --feature-gates mapStringBool A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
AllAlpha=true|false (ALPHA - default=false)
-AllowExtTrafficLocalEndpoints=true|false (ALPHA - default=false)
+AllowExtTrafficLocalEndpoints=true|false (BETA - default=true)
AppArmor=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
DynamicVolumeProvisioning=true|false (ALPHA - default=true)
+ExperimentalHostUserNamespaceDefaulting=true|false (ALPHA - default=false)
+StreamingProxyRedirects=true|false (ALPHA - default=false)
--google-json-key string The Google Cloud Platform Service Account JSON Key to use for authentication.
--hard-pod-affinity-symmetric-weight int RequiredDuringScheduling affinity is not symmetric, but there is an implicit PreferredDuringScheduling affinity rule corresponding to every RequiredDuringScheduling affinity rule. --hard-pod-affinity-symmetric-weight represents the weight of implicit PreferredDuringScheduling affinity rule. (default 1)
- --kube-api-burst value Burst to use while talking with kubernetes apiserver (default 100)
+ --kube-api-burst int32 Burst to use while talking with Kubernetes apiserver (default 100)
--kube-api-content-type string Content type of requests sent to apiserver. (default "application/vnd.kubernetes.protobuf")
- --kube-api-qps value QPS to use while talking with kubernetes apiserver (default 50)
+ --kube-api-qps float32 QPS to use while talking with Kubernetes apiserver (default 50)
--kubeconfig string Path to kubeconfig file with authorization and master location information.
--leader-elect Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability. (default true)
--leader-elect-lease-duration duration The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled. (default 15s)
@@ -44,16 +48,12 @@ DynamicVolumeProvisioning=true|false (ALPHA - default=true)
--leader-elect-retry-period duration The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled. (default 2s)
--master string The address of the Kubernetes API server (overrides any value in kubeconfig)
--policy-config-file string File with scheduler policy configuration
- --port value The port that the scheduler's http service runs on (default 10251)
+ --port int32 The port that the scheduler's http service runs on (default 10251)
--profiling Enable profiling via web interface host:port/debug/pprof/ (default true)
--scheduler-name string Name of the scheduler, used to select which pods will be processed by this scheduler, based on pod's annotation with key 'scheduler.alpha.kubernetes.io/name' (default "default-scheduler")
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
diff --git a/docs/admin/kubeadm.md b/docs/admin/kubeadm.md
index e1c8537149..1014ee1ab6 100644
--- a/docs/admin/kubeadm.md
+++ b/docs/admin/kubeadm.md
@@ -4,10 +4,9 @@ assignees:
- luxas
- errordeveloper
- jbeda
-
+title: kubeadm reference
---
-
This document provides information on how to use kubeadm's advanced options.
Running `kubeadm init` bootstraps a Kubernetes cluster. This consists of the
@@ -82,9 +81,12 @@ of the box. You can specify a cloud provider using `--cloud-provider`.
Valid values are the ones supported by `controller-manager`, namely `"aws"`,
`"azure"`, `"cloudstack"`, `"gce"`, `"mesos"`, `"openstack"`, `"ovirt"`,
`"rackspace"`, `"vsphere"`. In order to provide additional configuration for
-the cloud provider, you should create a `/etc/kubernetes/cloud-config.json`
+the cloud provider, you should create a `/etc/kubernetes/cloud-config`
file manually, before running `kubeadm init`. `kubeadm` automatically
picks those settings up and ensures other nodes are configured correctly.
+The exact format and content of the file `/etc/kubernetes/cloud-config` depends
+on the type you specified for `--cloud-provider`; see the appropriate documentation
+for your cloud provider for details.
You must also set the `--cloud-provider` and `--cloud-config` parameters
yourself by editing the `/etc/systemd/system/kubelet.service.d/10-kubeadm.conf`
file appropriately.
@@ -141,10 +143,10 @@ By default, `kubeadm init` automatically generates the token used to initialise
each new node. If you would like to manually specify this token, you can use the
`--token` flag. The token must be of the format `<6 character string>.<16 character string>`.
-- `--use-kubernetes-version` (default 'v1.4.4') the kubernetes version to initialise
+- `--use-kubernetes-version` (default 'v1.5.1') the kubernetes version to initialise
`kubeadm` was originally built for Kubernetes version **v1.4.0**, older versions are not
-supported. With this flag you can try any future version, e.g. **v1.5.0-beta.1**
+supported. With this flag you can try any future version, e.g. **v1.6.0-beta.1**
whenever it comes out (check [releases page](https://github.com/kubernetes/kubernetes/releases)
for a full list of available versions).
@@ -168,6 +170,59 @@ necessary.
By default, when `kubeadm init` runs, a token is generated and revealed in the output.
That's the token you should use here.
+
+## Using kubeadm with a configuration file
+
+WARNING: kubeadm is in alpha and the configuration API syntax will likely change before GA.
+
+It's possible to configure kubeadm with a configuration file instead of command line flags, and some more advanced features may only be
+available as configuration file options.
+
+### Sample Master Configuration
+
+ ```yaml
+ apiVersion: kubeadm.k8s.io/v1alpha1
+ kind: MasterConfiguration
+ api:
+ advertiseAddresses:
+ -
+ -
+ bindPort:
+ externalDNSNames:
+ -
+ -
+ cloudProvider:
+ discovery:
+ bindPort:
+ etcd:
+ endpoints:
+ -
+ -
+ caFile:
+ certFile:
+ keyFile:
+ kubernetesVersion:
+ networking:
+ dnsDomain:
+ serviceSubnet:
+ podSubnet:
+ secrets:
+ givenToken:
+ ```
+
+### Sample Node Configuration
+
+ ```yaml
+ apiVersion: kubeadm.k8s.io/v1alpha1
+ kind: NodeConfiguration
+ apiPort:
+ discoveryPort:
+ masterAddresses:
+ -
+ secrets:
+ givenToken:
+ ```
+
## Automating kubeadm
Rather than copying the token you obtained from `kubeadm init` to each node, as
@@ -175,13 +230,12 @@ in the basic `kubeadm` tutorials, you can parallelize the token distribution for
easier automation. To implement this automation, you must know the IP address
that the master will have after it is started.
-1. Generate a token. This token must have the form `<6 character string>.<16
-character string>`
+1. Generate a token. This token must have the form `<6 character string>.<16 character string>`.
- Here is a simple python one-liner for this:
+ Kubeadm can pre-generate a token for you:
- ```
- python -c 'import random; print "%0x.%0x" % (random.SystemRandom().getrandbits(3*8), random.SystemRandom().getrandbits(8*8))'
+ ```console
+ $ kubeadm token generate
```
1. Start both the master node and the worker nodes concurrently with this token. As they come up they should find each other and form the cluster.
@@ -191,6 +245,7 @@ Once the cluster is up, you can grab the admin credentials from the master node
## Environment variables
There are some environment variables that modify the way that `kubeadm` works. Most users will have no need to set these.
+These environment variables are a short-term solution, eventually they will be integrated in the kubeadm configuration file.
| Variable | Default | Description |
| --- | --- | --- |
@@ -200,36 +255,10 @@ There are some environment variables that modify the way that `kubeadm` works.
| `KUBE_HYPERKUBE_IMAGE` | `` | If set, use a single hyperkube image with this name. If not set, individual images per server component will be used. |
| `KUBE_DISCOVERY_IMAGE` | `gcr.io/google_containers/kube-discovery-:1.0` | The bootstrap discovery helper image to use. |
| `KUBE_ETCD_IMAGE` | `gcr.io/google_containers/etcd-:2.2.5` | The etcd container image to use. |
-| `KUBE_COMPONENT_LOGLEVEL` | `--v=4` | Logging configuration for all Kubernetes components |
-
+| `KUBE_REPO_PREFIX` | `gcr.io/google_containers` | The image prefix for all images that are used. |
## Releases and release notes
If you already have kubeadm installed and want to upgrade, run `apt-get update && apt-get upgrade` or `yum update` to get the latest version of kubeadm.
- - Second release between v1.4 and v1.5: `v1.5.0-alpha.2.421+a6bea3d79b8bba`
- - Switch to the 10.96.0.0/12 subnet: [#35290](https://github.com/kubernetes/kubernetes/pull/35290)
- - Fix kubeadm on AWS by including /etc/ssl/certs in the controller-manager [#33681](https://github.com/kubernetes/kubernetes/pull/33681)
- - The API was refactored and is now componentconfig: [#33728](https://github.com/kubernetes/kubernetes/pull/33728), [#34147](https://github.com/kubernetes/kubernetes/pull/34147) and [#34555](https://github.com/kubernetes/kubernetes/pull/34555)
- - Allow kubeadm to get config options from a file: [#34501](https://github.com/kubernetes/kubernetes/pull/34501), [#34885](https://github.com/kubernetes/kubernetes/pull/34885) and [#34891](https://github.com/kubernetes/kubernetes/pull/34891)
- - Implement preflight checks: [#34341](https://github.com/kubernetes/kubernetes/pull/34341) and [#35843](https://github.com/kubernetes/kubernetes/pull/35843)
- - Using kubernetes v1.4.4 by default: [#34419](https://github.com/kubernetes/kubernetes/pull/34419) and [#35270](https://github.com/kubernetes/kubernetes/pull/35270)
- - Make api and discovery ports configurable and default to 6443: [#34719](https://github.com/kubernetes/kubernetes/pull/34719)
- - Implement kubeadm reset: [#34807](https://github.com/kubernetes/kubernetes/pull/34807)
- - Make kubeadm poll/wait for endpoints instead of directly fail when the master isn't available [#34703](https://github.com/kubernetes/kubernetes/pull/34703) and [#34718](https://github.com/kubernetes/kubernetes/pull/34718)
- - Allow empty directories in the directory preflight check: [#35632](https://github.com/kubernetes/kubernetes/pull/35632)
- - Started adding unit tests: [#35231](https://github.com/kubernetes/kubernetes/pull/35231), [#35326](https://github.com/kubernetes/kubernetes/pull/35326) and [#35332](https://github.com/kubernetes/kubernetes/pull/35332)
- - Various enhancements: [#35075](https://github.com/kubernetes/kubernetes/pull/35075), [#35111](https://github.com/kubernetes/kubernetes/pull/35111), [#35119](https://github.com/kubernetes/kubernetes/pull/35119), [#35124](https://github.com/kubernetes/kubernetes/pull/35124), [#35265](https://github.com/kubernetes/kubernetes/pull/35265) and [#35777](https://github.com/kubernetes/kubernetes/pull/35777)
- - Bug fixes: [#34352](https://github.com/kubernetes/kubernetes/pull/34352), [#34558](https://github.com/kubernetes/kubernetes/pull/34558), [#34573](https://github.com/kubernetes/kubernetes/pull/34573), [#34834](https://github.com/kubernetes/kubernetes/pull/34834), [#34607](https://github.com/kubernetes/kubernetes/pull/34607), [#34907](https://github.com/kubernetes/kubernetes/pull/34907) and [#35796](https://github.com/kubernetes/kubernetes/pull/35796)
- - Initial v1.4 release: `v1.5.0-alpha.0.1534+cf7301f16c0363`
-
-
-## Troubleshooting
-
-* 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, eg.
-
-```
-# cat /etc/sysctl.d/k8s.conf
-net.bridge.bridge-nf-call-ip6tables = 1
-net.bridge.bridge-nf-call-iptables = 1
-```
+Refer to the [CHANGELOG.md](https://github.com/kubernetes/kubeadm/blob/master/CHANGELOG.md) for more information.
diff --git a/docs/admin/kubelet-authentication-authorization.md b/docs/admin/kubelet-authentication-authorization.md
index b0617b8854..aa8abf85df 100644
--- a/docs/admin/kubelet-authentication-authorization.md
+++ b/docs/admin/kubelet-authentication-authorization.md
@@ -1,7 +1,7 @@
---
assignees:
- liggitt
-
+title: Kubelet authentication/authorization
---
* TOC
@@ -17,35 +17,40 @@ This document describes how to authenticate and authorize access to the kubelet'
## Kubelet authentication
By default, requests to the kubelet's HTTPS endpoint that are not rejected by other configured
-authentication methods are treated as anonymous requests, and given a username of `system:anonymous`
+authentication methods are treated as anonymous requests, and given a username of `system:anonymous`
and a group of `system:unauthenticated`.
To disable anonymous access and send `401 Unauthorized` responses to unauthenticated requests:
+
* start the kubelet with the `--anonymous-auth=false` flag
To enable X509 client certificate authentication to the kubelet's HTTPS endpoint:
-* start the kubelet with the `--client-ca-file` flag, providing a CA bundle to verify client certificates with
+
+* start the kubelet with the `--client-ca-file` flag, providing a CA bundle to verify client certificates with
* start the apiserver with `--kubelet-client-certificate` and `--kubelet-client-key` flags
* see the [apiserver authentication documentation](/docs/admin/authentication/#x509-client-certs) for more details
To enable API bearer tokens (including service account tokens) to be used to authenticate to the kubelet's HTTPS endpoint:
+
* ensure the `authentication.k8s.io/v1beta1` API group is enabled in the API server
* start the kubelet with the `--authentication-token-webhook`, `--kubeconfig`, and `--require-kubeconfig` flags
-* the kubelet calls the `TokenReview` API on the configured API server to determine user information from bearer tokens
+* the kubelet calls the `TokenReview` API on the configured API server to determine user information from bearer tokens
## Kubelet authorization
Any request that is successfully authenticated (including an anonymous request) is then authorized. The default authorization mode is `AlwaysAllow`, which allows all requests.
There are many possible reasons to subdivide access to the kubelet API:
+
* anonymous auth is enabled, but anonymous users' ability to call the kubelet API should be limited
* bearer token auth is enabled, but arbitrary API users' (like service accounts) ability to call the kubelet API should be limited
* client certificate auth is enabled, but only some of the client certificates signed by the configured CA should be allowed to use the kubelet API
To subdivide access to the kubelet API, delegate authorization to the API server:
+
* ensure the `authorization.k8s.io/v1beta1` API group is enabled in the API server
* start the kubelet with the `--authorization-mode=Webhook`, `--kubeconfig`, and `--require-kubeconfig` flags
-* the kubelet calls the `SubjectAccessReview` API on the configured API server to determine whether each request is authorized
+* the kubelet calls the `SubjectAccessReview` API on the configured API server to determine whether each request is authorized
The kubelet authorizes API requests using the same [request attributes](/docs/admin/authorization/#request-attributes) approach as the apiserver.
@@ -63,19 +68,20 @@ The resource and subresource is determined from the incoming request's path:
Kubelet API | resource | subresource
-------------|----------|------------
-/stats/* | nodes | stats
-/metrics/* | nodes | metrics
-/logs/* | nodes | log
-/spec/* | nodes | spec
+/stats/\* | nodes | stats
+/metrics/\* | nodes | metrics
+/logs/\* | nodes | log
+/spec/\* | nodes | spec
*all others* | nodes | proxy
-The namespace and API group attributes are always an empty string, and
+The namespace and API group attributes are always an empty string, and
the resource name is always the name of the kubelet's `Node` API object.
-When running in this mode, ensure the user identified by the `--kubelet-client-certificate` and `--kubelet-client-key`
+When running in this mode, ensure the user identified by the `--kubelet-client-certificate` and `--kubelet-client-key`
flags passed to the apiserver is authorized for the following attributes:
-* verb=*, resource=nodes, subresource=proxy
-* verb=*, resource=nodes, subresource=stats
-* verb=*, resource=nodes, subresource=log
-* verb=*, resource=nodes, subresource=spec
-* verb=*, resource=nodes, subresource=metrics
+
+* verb=\*, resource=nodes, subresource=proxy
+* verb=\*, resource=nodes, subresource=stats
+* verb=\*, resource=nodes, subresource=log
+* verb=\*, resource=nodes, subresource=spec
+* verb=\*, resource=nodes, subresource=metrics
diff --git a/docs/admin/kubelet-tls-bootstrapping.md b/docs/admin/kubelet-tls-bootstrapping.md
index 3458bdb310..0dfc4bbf55 100644
--- a/docs/admin/kubelet-tls-bootstrapping.md
+++ b/docs/admin/kubelet-tls-bootstrapping.md
@@ -1,7 +1,7 @@
---
assignees:
- mikedanese
-
+title: TLS bootstrapping
---
* TOC
@@ -9,7 +9,7 @@ assignees:
## Overview
-This document describes how to set up TLS client certificate boostrapping for kubelets.
+This document describes how to set up TLS client certificate bootstrapping for kubelets.
Kubernetes 1.4 introduces an experimental API for requesting certificates from a cluster-level
Certificate Authority (CA). The first supported use of this API is the provisioning of TLS client
certificates for kubelets. The proposal can be found [here](https://github.com/kubernetes/kubernetes/pull/20439)
@@ -17,7 +17,7 @@ and progress on the feature is being tracked as [feature #43](https://github.com
## apiserver configuration
-You must provide a token file which specifies at least one "bootstrap token" assigned to a kubelet boostrap-specific group.
+You must provide a token file which specifies at least one "bootstrap token" assigned to a kubelet bootstrap-specific group.
This group will later be used in the controller-manager configuration to scope approvals in the default approval
controller. As this feature matures, you should ensure tokens are bound to an RBAC policy which limits requests
using the bootstrap token to only be able to make requests related to certificate provisioning. When RBAC policy
diff --git a/docs/admin/kubelet.md b/docs/admin/kubelet.md
index 88842eab14..258db1e3aa 100644
--- a/docs/admin/kubelet.md
+++ b/docs/admin/kubelet.md
@@ -1,4 +1,6 @@
---
+title: Overview
+notitle: true
---
## kubelet
@@ -15,7 +17,7 @@ various mechanisms (primarily through the apiserver) and ensures that the contai
described in those PodSpecs are running and healthy. The kubelet doesn't manage
containers which were not created by Kubernetes.
-Other than from an PodSpec from the apiserver, there are three ways that a container
+Other than from a PodSpec from the apiserver, there are three ways that a container
manifest can be provided to the Kubelet.
File: Path passed as a flag on the command line. This file is rechecked every 20
@@ -34,123 +36,134 @@ kubelet
### Options
```
- --address value The IP address for the Kubelet to serve on (set to 0.0.0.0 for all interfaces) (default 0.0.0.0)
- --allow-privileged If true, allow containers to request privileged mode. [default=false]
- --cadvisor-port value The port of the localhost cAdvisor endpoint (default 4194)
- --cert-dir string The directory where the TLS certs are located (by default /var/run/kubernetes). If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored. (default "/var/run/kubernetes")
- --cgroup-root string Optional root cgroup to use for pods. This is handled by the container runtime on a best effort basis. Default: '', which means use the container runtime default.
- --chaos-chance float If > 0.0, introduce random client errors and latency. Intended for testing. [default=0.0]
- --cloud-config string The path to the cloud provider configuration file. Empty string for no configuration file.
- --cloud-provider string The provider for cloud services. By default, kubelet will attempt to auto-detect the cloud provider. Specify empty string for running with no cloud provider. [default=auto-detect] (default "auto-detect")
- --cluster-dns string IP address for a cluster DNS server. This value is used for containers' DNS server in case of Pods with "dnsPolicy=ClusterFirst"
- --cluster-domain string Domain for this cluster. If set, kubelet will configure all containers to search this domain in addition to the host's search domains
- --cni-bin-dir string The full path of the directory in which to search for CNI plugin binaries. Default: /opt/cni/bin
- --cni-conf-dir string The full path of the directory in which to search for CNI config files. Default: /etc/cni/net.d
- --container-runtime string The container runtime to use. Possible values: 'docker', 'rkt'. Default: 'docker'. (default "docker")
- --container-runtime-endpoint string The unix socket endpoint of remote runtime service. If not empty, this option will override --container-runtime. This is an experimental feature. Intended for testing only.
- --containerized Experimental support for running kubelet in a container. Intended for testing. [default=false]
- --cpu-cfs-quota Enable CPU CFS quota enforcement for containers that specify CPU limits (default true)
- --docker-endpoint string Use this for the docker endpoint to communicate with (default "unix:///var/run/docker.sock")
- --docker-exec-handler string Handler to use when executing a command in a container. Valid values are 'native' and 'nsenter'. Defaults to 'native'. (default "native")
- --enable-controller-attach-detach Enables the Attach/Detach controller to manage attachment/detachment of volumes scheduled to this node, and disables kubelet from executing any attach/detach operations (default true)
- --enable-custom-metrics Support for gathering custom metrics.
- --enable-debugging-handlers Enables server endpoints for log collection and local running of containers and commands (default true)
- --enable-server Enable the Kubelet's server (default true)
- --event-burst value Maximum size of a bursty event records, temporarily allows event records to burst to this number, while still not exceeding event-qps. Only used if --event-qps > 0 (default 10)
- --event-qps value If > 0, limit event creations per second to this value. If 0, unlimited. (default 5)
- --eviction-hard string A set of eviction thresholds (e.g. memory.available<1Gi) that if met would trigger a pod eviction. (default "memory.available<100Mi")
- --eviction-max-pod-grace-period value Maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. If negative, defer to pod specified value.
- --eviction-minimum-reclaim string A set of minimum reclaims (e.g. imagefs.available=2Gi) that describes the minimum amount of resource the kubelet will reclaim when performing a pod eviction if that resource is under pressure.
- --eviction-pressure-transition-period duration Duration for which the kubelet has to wait before transitioning out of an eviction pressure condition. (default 5m0s)
- --eviction-soft string A set of eviction thresholds (e.g. memory.available<1.5Gi) that if met over a corresponding grace period would trigger a pod eviction.
- --eviction-soft-grace-period string A set of eviction grace periods (e.g. memory.available=1m30s) that correspond to how long a soft eviction threshold must hold before triggering a pod eviction.
- --exit-on-lock-contention Whether kubelet should exit upon lock-file contention.
- --experimental-allowed-unsafe-sysctls value Comma-separated whitelist of unsafe sysctls or unsafe sysctl patterns (ending in *). Use these at your own risk. (default [])
- --experimental-bootstrap-kubeconfig string Path to a kubeconfig file that will be used to get client certificate for kubelet. If the file specified by --kubeconfig does not exist, the bootstrap kubeconfig is used to request a client certificate from the API server. On success, a kubeconfig file referencing the generated key and obtained certificate is written to the path specified by --kubeconfig. The certificate and key file will be stored in the directory pointed by --cert-dir.
- --experimental-nvidia-gpus value Number of NVIDIA GPU devices on this node. Only 0 (default) and 1 are currently supported.
- --feature-gates value A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
+ --address ip The IP address for the Kubelet to serve on (set to 0.0.0.0 for all interfaces) (default 0.0.0.0)
+ --allow-privileged If true, allow containers to request privileged mode. [default=false]
+ --anonymous-auth Enables anonymous requests to the Kubelet server. Requests that are not rejected by another authentication method are treated as anonymous requests. Anonymous requests have a username of system:anonymous, and a group name of system:unauthenticated. (default true)
+ --authentication-token-webhook Use the TokenReview API to determine authentication for bearer tokens.
+ --authentication-token-webhook-cache-ttl duration The duration to cache responses from the webhook token authenticator. (default 2m0s)
+ --authorization-mode string Authorization mode for Kubelet server. Valid options are AlwaysAllow or Webhook. Webhook mode uses the SubjectAccessReview API to determine authorization. (default "AlwaysAllow")
+ --authorization-webhook-cache-authorized-ttl duration The duration to cache 'authorized' responses from the webhook authorizer. (default 5m0s)
+ --authorization-webhook-cache-unauthorized-ttl duration The duration to cache 'unauthorized' responses from the webhook authorizer. (default 30s)
+ --cadvisor-port int32 The port of the localhost cAdvisor endpoint (default 4194)
+ --cert-dir string The directory where the TLS certs are located (by default /var/run/kubernetes). If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored. (default "/var/run/kubernetes")
+ --cgroup-driver string Driver that the kubelet uses to manipulate cgroups on the host. Possible values: 'cgroupfs', 'systemd' (default "cgroupfs")
+ --cgroup-root string Optional root cgroup to use for pods. This is handled by the container runtime on a best effort basis. Default: '', which means use the container runtime default.
+ --chaos-chance float If > 0.0, introduce random client errors and latency. Intended for testing. [default=0.0]
+ --client-ca-file string If set, any request presenting a client certificate signed by one of the authorities in the client-ca-file is authenticated with an identity corresponding to the CommonName of the client certificate.
+ --cloud-config string The path to the cloud provider configuration file. Empty string for no configuration file.
+ --cloud-provider string The provider for cloud services. By default, kubelet will attempt to auto-detect the cloud provider. Specify empty string for running with no cloud provider. [default=auto-detect] (default "auto-detect")
+ --cluster-dns string IP address for a cluster DNS server. This value is used for containers' DNS server in case of Pods with "dnsPolicy=ClusterFirst"
+ --cluster-domain string Domain for this cluster. If set, kubelet will configure all containers to search this domain in addition to the host's search domains
+ --cni-bin-dir string The full path of the directory in which to search for CNI plugin binaries. Default: /opt/cni/bin
+ --cni-conf-dir string The full path of the directory in which to search for CNI config files. Default: /etc/cni/net.d
+ --container-runtime string The container runtime to use. Possible values: 'docker', 'rkt'. Default: 'docker'. (default "docker")
+ --container-runtime-endpoint string [Experimental] The unix socket endpoint of remote runtime service. The endpoint is used only when CRI integration is enabled (--experimental-cri)
+ --containerized Experimental support for running kubelet in a container. Intended for testing. [default=false]
+ --cpu-cfs-quota Enable CPU CFS quota enforcement for containers that specify CPU limits (default true)
+ --docker-endpoint string Use this for the docker endpoint to communicate with (default "unix:///var/run/docker.sock")
+ --docker-exec-handler string Handler to use when executing a command in a container. Valid values are 'native' and 'nsenter'. Defaults to 'native'. (default "native")
+ --enable-controller-attach-detach Enables the Attach/Detach controller to manage attachment/detachment of volumes scheduled to this node, and disables kubelet from executing any attach/detach operations (default true)
+ --enable-custom-metrics Support for gathering custom metrics.
+ --enable-debugging-handlers Enables server endpoints for log collection and local running of containers and commands (default true)
+ --enable-server Enable the Kubelet's server (default true)
+ --event-burst int32 Maximum size of a bursty event records, temporarily allows event records to burst to this number, while still not exceeding event-qps. Only used if --event-qps > 0 (default 10)
+ --event-qps int32 If > 0, limit event creations per second to this value. If 0, unlimited. (default 5)
+ --eviction-hard string A set of eviction thresholds (e.g. memory.available<1Gi) that if met would trigger a pod eviction. (default "memory.available<100Mi")
+ --eviction-max-pod-grace-period int32 Maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. If negative, defer to pod specified value.
+ --eviction-minimum-reclaim string A set of minimum reclaims (e.g. imagefs.available=2Gi) that describes the minimum amount of resource the kubelet will reclaim when performing a pod eviction if that resource is under pressure.
+ --eviction-pressure-transition-period duration Duration for which the kubelet has to wait before transitioning out of an eviction pressure condition. (default 5m0s)
+ --eviction-soft string A set of eviction thresholds (e.g. memory.available<1.5Gi) that if met over a corresponding grace period would trigger a pod eviction.
+ --eviction-soft-grace-period string A set of eviction grace periods (e.g. memory.available=1m30s) that correspond to how long a soft eviction threshold must hold before triggering a pod eviction.
+ --exit-on-lock-contention Whether kubelet should exit upon lock-file contention.
+ --experimental-allowed-unsafe-sysctls stringSlice Comma-separated whitelist of unsafe sysctls or unsafe sysctl patterns (ending in *). Use these at your own risk.
+ --experimental-bootstrap-kubeconfig string Path to a kubeconfig file that will be used to get client certificate for kubelet. If the file specified by --kubeconfig does not exist, the bootstrap kubeconfig is used to request a client certificate from the API server. On success, a kubeconfig file referencing the generated key and obtained certificate is written to the path specified by --kubeconfig. The certificate and key file will be stored in the directory pointed by --cert-dir.
+ --experimental-cgroups-per-qos Enable creation of QoS cgroup hierarchy, if true top level QoS and pod cgroups are created.
+ --experimental-check-node-capabilities-before-mount [Experimental] if set true, the kubelet will check the underlying node for required components (binaries, etc.) before performing the mount
+ --experimental-cri [Experimental] Enable the Container Runtime Interface (CRI) integration. If --container-runtime is set to "remote", Kubelet will communicate with the runtime/image CRI server listening on the endpoint specified by --remote-runtime-endpoint/--remote-image-endpoint. If --container-runtime is set to "docker", Kubelet will launch a in-process CRI server on behalf of docker, and communicate over a default endpoint.
+ --experimental-fail-swap-on Makes the Kubelet fail to start if swap is enabled on the node. This is a temporary option to maintain legacy behavior, failing due to swap enabled will happen by default in v1.6.
+ --experimental-kernel-memcg-notification If enabled, the kubelet will integrate with the kernel memcg notification to determine if memory eviction thresholds are crossed rather than polling.
+ --experimental-mounter-path string [Experimental] Path of mounter binary. Leave empty to use the default mount.
+ --experimental-nvidia-gpus int32 Number of NVIDIA GPU devices on this node. Only 0 (default) and 1 are currently supported.
+ --feature-gates string A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
AllAlpha=true|false (ALPHA - default=false)
-AllowExtTrafficLocalEndpoints=true|false (ALPHA - default=false)
+AllowExtTrafficLocalEndpoints=true|false (BETA - default=true)
AppArmor=true|false (BETA - default=true)
DynamicKubeletConfig=true|false (ALPHA - default=false)
DynamicVolumeProvisioning=true|false (ALPHA - default=true)
- --file-check-frequency duration Duration between checking config files for new data (default 20s)
- --google-json-key string The Google Cloud Platform Service Account JSON Key to use for authentication.
- --hairpin-mode string How should the kubelet setup hairpin NAT. This allows endpoints of a Service to loadbalance back to themselves if they should try to access their own Service. Valid values are "promiscuous-bridge", "hairpin-veth" and "none". (default "promiscuous-bridge")
- --healthz-bind-address value The IP address for the healthz server to serve on, defaulting to 127.0.0.1 (set to 0.0.0.0 for all interfaces) (default 127.0.0.1)
- --healthz-port value The port of the localhost healthz endpoint (default 10248)
- --host-ipc-sources value Comma-separated list of sources from which the Kubelet allows pods to use the host ipc namespace. [default="*"] (default [*])
- --host-network-sources value Comma-separated list of sources from which the Kubelet allows pods to use of host network. [default="*"] (default [*])
- --host-pid-sources value Comma-separated list of sources from which the Kubelet allows pods to use the host pid namespace. [default="*"] (default [*])
- --hostname-override string If non-empty, will use this string as identification instead of the actual hostname.
- --http-check-frequency duration Duration between checking http for new data (default 20s)
- --image-gc-high-threshold value The percent of disk usage after which image garbage collection is always run. Default: 90% (default 90)
- --image-gc-low-threshold value The percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to. Default: 80% (default 80)
- --image-service-endpoint string The unix socket endpoint of remote image service. If not specified, it will be the same with container-runtime-endpoint by default. This is an experimental feature. Intended for testing only.
- --iptables-drop-bit value The bit of the fwmark space to mark packets for dropping. Must be within the range [0, 31]. (default 15)
- --iptables-masquerade-bit value The bit of the fwmark space to mark packets for SNAT. Must be within the range [0, 31]. Please match this parameter with corresponding parameter in kube-proxy. (default 14)
- --kube-api-burst value Burst to use while talking with kubernetes apiserver (default 10)
- --kube-api-content-type string Content type of requests sent to apiserver. (default "application/vnd.kubernetes.protobuf")
- --kube-api-qps value QPS to use while talking with kubernetes apiserver (default 5)
- --kube-reserved value A set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for kubernetes system components. Currently only cpu and memory are supported. See http://releases.k8s.io/release-1.4/docs/user-guide/compute-resources.md for more detail. [default=none]
- --kubeconfig value Path to a kubeconfig file, specifying how to connect to the API server. --api-servers will be used for the location unless --require-kubeconfig is set. (default "/var/lib/kubelet/kubeconfig")
- --kubelet-cgroups string Optional absolute name of cgroups to create and run the Kubelet in.
- --lock-file string The path to file for kubelet to use as a lock file.
- --low-diskspace-threshold-mb value The absolute free disk space, in MB, to maintain. When disk space falls below this threshold, new pods would be rejected. Default: 256 (default 256)
- --make-iptables-util-chains If true, kubelet will ensure iptables utility rules are present on host. (default true)
- --manifest-url string URL for accessing the container manifest
- --manifest-url-header string HTTP header to use when accessing the manifest URL, with the key separated from the value with a ':', as in 'key:value'
- --master-service-namespace string The namespace from which the kubernetes master services should be injected into pods (default "default")
- --max-open-files int Number of files that can be opened by Kubelet process. [default=1000000] (default 1000000)
- --max-pods value Number of Pods that can run on this Kubelet. (default 110)
- --minimum-image-ttl-duration duration Minimum age for an unused image before it is garbage collected. Examples: '300ms', '10s' or '2h45m'. Default: '2m' (default 2m0s)
- --network-plugin string The name of the network plugin to be invoked for various events in kubelet/pod lifecycle
- --network-plugin-dir string The full path of the directory in which to search for network plugins or CNI config
- --network-plugin-mtu value The MTU to be passed to the network plugin, to override the default. Set to 0 to use the default 1460 MTU.
- --node-ip string IP address of the node. If set, kubelet will use this IP address for the node
- --node-labels value Labels to add when registering the node in the cluster. Labels must be key=value pairs separated by ','.
- --node-status-update-frequency duration Specifies how often kubelet posts node status to master. Note: be cautious when changing the constant, it must work with nodeMonitorGracePeriod in nodecontroller. Default: 10s (default 10s)
- --non-masquerade-cidr string Traffic to IPs outside this range will use IP masquerade. (default "10.0.0.0/8")
- --oom-score-adj value The oom-score-adj value for kubelet process. Values must be within the range [-1000, 1000] (default -999)
- --outofdisk-transition-frequency duration Duration for which the kubelet has to wait before transitioning out of out-of-disk node condition status. Default: 5m0s (default 5m0s)
- --pod-cidr string The CIDR to use for pod IP addresses, only used in standalone mode. In cluster mode, this is obtained from the master.
- --pod-infra-container-image string The image whose network/ipc namespaces containers in each pod will use. (default "gcr.io/google_containers/pause-amd64:3.0")
- --pod-manifest-path string Path to to the directory containing pod manifest files to run, or the path to a single pod manifest file.
- --pods-per-core value Number of Pods per core that can run on this Kubelet. The total number of Pods on this Kubelet cannot exceed max-pods, so max-pods will be used if this calculation results in a larger number of Pods allowed on the Kubelet. A value of 0 disables this limit.
- --port value The port for the Kubelet to serve on. (default 10250)
- --protect-kernel-defaults Default kubelet behaviour for kernel tuning. If set, kubelet errors if any of kernel tunables is different than kubelet defaults.
- --read-only-port value The read-only port for the Kubelet to serve on with no authentication/authorization (set to 0 to disable) (default 10255)
- --really-crash-for-testing If true, when panics occur crash. Intended for testing.
- --reconcile-cidr Reconcile node CIDR with the CIDR specified by the API server. No-op if register-node or configure-cbr0 is false. [default=true] (default true)
- --register-node Register the node with the apiserver (defaults to true if --api-servers is set) (default true)
- --register-schedulable Register the node as schedulable. No-op if register-node is false. [default=true] (default true)
- --registry-burst value Maximum size of a bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry-qps. Only used if --registry-qps > 0 (default 10)
- --registry-qps value If > 0, limit registry pull QPS to this value. If 0, unlimited. [default=5.0] (default 5)
- --require-kubeconfig If true the Kubelet will exit if there are configuration errors, and will ignore the value of --api-servers in favor of the server defined in the kubeconfig file.
- --resolv-conf string Resolver configuration file used as the basis for the container DNS resolution configuration. (default "/etc/resolv.conf")
- --rkt-api-endpoint string The endpoint of the rkt API service to communicate with. Only used if --container-runtime='rkt'. (default "localhost:15441")
- --rkt-path string Path of rkt binary. Leave empty to use the first rkt in $PATH. Only used if --container-runtime='rkt'.
- --root-dir string Directory path for managing kubelet files (volume mounts,etc). (default "/var/lib/kubelet")
- --runonce If true, exit after spawning pods from local manifests or remote urls. Exclusive with --api-servers, and --enable-server
- --runtime-cgroups string Optional absolute name of cgroups to create and run the runtime in.
- --runtime-request-timeout duration Timeout of all runtime requests except long running request - pull, logs, exec and attach. When timeout exceeded, kubelet will cancel the request, throw out an error and retry later. Default: 2m0s (default 2m0s)
- --seccomp-profile-root string Directory path for seccomp profiles.
- --serialize-image-pulls Pull images one at a time. We recommend *not* changing the default value on nodes that run docker daemon with version < 1.9 or an Aufs storage backend. Issue #10959 has more details. [default=true] (default true)
- --streaming-connection-idle-timeout duration Maximum time a streaming connection can be idle before the connection is automatically closed. 0 indicates no timeout. Example: '5m' (default 4h0m0s)
- --sync-frequency duration Max period between synchronizing running containers and config (default 1m0s)
- --system-cgroups / Optional absolute name of cgroups in which to place all non-kernel processes that are not already inside a cgroup under /. Empty for no container. Rolling back the flag requires a reboot. (Default: "").
- --system-reserved value A set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for non-kubernetes components. Currently only cpu and memory are supported. See http://releases.k8s.io/release-1.4/docs/user-guide/compute-resources.md for more detail. [default=none]
- --tls-cert-file string File containing x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory passed to --cert-dir.
- --tls-private-key-file string File containing x509 private key matching --tls-cert-file.
- --volume-plugin-dir string The full path of the directory in which to search for additional third party volume plugins (default "/usr/libexec/kubernetes/kubelet-plugins/volume/exec/")
- --volume-stats-agg-period duration Specifies interval for kubelet to calculate and cache the volume disk usage for all pods and volumes. To disable volume calculations, set to 0. Default: '1m' (default 1m0s)
+ExperimentalHostUserNamespaceDefaulting=true|false (ALPHA - default=false)
+StreamingProxyRedirects=true|false (ALPHA - default=false)
+ --file-check-frequency duration Duration between checking config files for new data (default 20s)
+ --google-json-key string The Google Cloud Platform Service Account JSON Key to use for authentication.
+ --hairpin-mode string How should the kubelet setup hairpin NAT. This allows endpoints of a Service to loadbalance back to themselves if they should try to access their own Service. Valid values are "promiscuous-bridge", "hairpin-veth" and "none". (default "promiscuous-bridge")
+ --healthz-bind-address ip The IP address for the healthz server to serve on, defaulting to 127.0.0.1 (set to 0.0.0.0 for all interfaces) (default 127.0.0.1)
+ --healthz-port int32 The port of the localhost healthz endpoint (default 10248)
+ --host-ipc-sources stringSlice Comma-separated list of sources from which the Kubelet allows pods to use the host ipc namespace. [default="*"] (default [*])
+ --host-network-sources stringSlice Comma-separated list of sources from which the Kubelet allows pods to use of host network. [default="*"] (default [*])
+ --host-pid-sources stringSlice Comma-separated list of sources from which the Kubelet allows pods to use the host pid namespace. [default="*"] (default [*])
+ --hostname-override string If non-empty, will use this string as identification instead of the actual hostname.
+ --http-check-frequency duration Duration between checking http for new data (default 20s)
+ --image-gc-high-threshold int32 The percent of disk usage after which image garbage collection is always run. Default: 90% (default 90)
+ --image-gc-low-threshold int32 The percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to. Default: 80% (default 80)
+ --image-service-endpoint string [Experimental] The unix socket endpoint of remote image service. If not specified, it will be the same with container-runtime-endpoint by default. The endpoint is used only when CRI integration is enabled (--experimental-cri)
+ --iptables-drop-bit int32 The bit of the fwmark space to mark packets for dropping. Must be within the range [0, 31]. (default 15)
+ --iptables-masquerade-bit int32 The bit of the fwmark space to mark packets for SNAT. Must be within the range [0, 31]. Please match this parameter with corresponding parameter in kube-proxy. (default 14)
+ --kube-api-burst int32 Burst to use while talking with Kubernetes apiserver (default 10)
+ --kube-api-content-type string Content type of requests sent to apiserver. (default "application/vnd.kubernetes.protobuf")
+ --kube-api-qps int32 QPS to use while talking with Kubernetes apiserver (default 5)
+ --kube-reserved mapStringString A set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for kubernetes system components. Currently only cpu and memory are supported. See http://kubernetes.io/docs/user-guide/compute-resources for more detail. [default=none]
+ --kubeconfig string Path to a kubeconfig file, specifying how to connect to the API server. --api-servers will be used for the location unless --require-kubeconfig is set. (default "/var/lib/kubelet/kubeconfig")
+ --kubelet-cgroups string Optional absolute name of cgroups to create and run the Kubelet in.
+ --lock-file string The path to file for kubelet to use as a lock file.
+ --low-diskspace-threshold-mb int32 The absolute free disk space, in MB, to maintain. When disk space falls below this threshold, new pods would be rejected. Default: 256 (default 256)
+ --make-iptables-util-chains If true, kubelet will ensure iptables utility rules are present on host. (default true)
+ --manifest-url string URL for accessing the container manifest
+ --manifest-url-header string HTTP header to use when accessing the manifest URL, with the key separated from the value with a ':', as in 'key:value'
+ --master-service-namespace string The namespace from which the Kubernetes master services should be injected into pods (default "default")
+ --max-open-files int Number of files that can be opened by Kubelet process. [default=1000000] (default 1000000)
+ --max-pods int32 Number of Pods that can run on this Kubelet. (default 110)
+ --minimum-image-ttl-duration duration Minimum age for an unused image before it is garbage collected. Examples: '300ms', '10s' or '2h45m'. Default: '2m' (default 2m0s)
+ --network-plugin string The name of the network plugin to be invoked for various events in kubelet/pod lifecycle
+ --network-plugin-dir string The full path of the directory in which to search for network plugins or CNI config
+ --network-plugin-mtu int32 The MTU to be passed to the network plugin, to override the default. Set to 0 to use the default 1460 MTU.
+ --node-ip string IP address of the node. If set, kubelet will use this IP address for the node
+ --node-labels mapStringString Labels to add when registering the node in the cluster. Labels must be key=value pairs separated by ','.
+ --node-status-update-frequency duration Specifies how often kubelet posts node status to master. Note: be cautious when changing the constant, it must work with nodeMonitorGracePeriod in nodecontroller. Default: 10s (default 10s)
+ --non-masquerade-cidr string Traffic to IPs outside this range will use IP masquerade. (default "10.0.0.0/8")
+ --oom-score-adj int32 The oom-score-adj value for kubelet process. Values must be within the range [-1000, 1000] (default -999)
+ --outofdisk-transition-frequency duration Duration for which the kubelet has to wait before transitioning out of out-of-disk node condition status. Default: 5m0s (default 5m0s)
+ --pod-cidr string The CIDR to use for pod IP addresses, only used in standalone mode. In cluster mode, this is obtained from the master.
+ --pod-infra-container-image string The image whose network/ipc namespaces containers in each pod will use. (default "gcr.io/google_containers/pause-amd64:3.0")
+ --pod-manifest-path string Path to to the directory containing pod manifest files to run, or the path to a single pod manifest file.
+ --pods-per-core int32 Number of Pods per core that can run on this Kubelet. The total number of Pods on this Kubelet cannot exceed max-pods, so max-pods will be used if this calculation results in a larger number of Pods allowed on the Kubelet. A value of 0 disables this limit.
+ --port int32 The port for the Kubelet to serve on. (default 10250)
+ --protect-kernel-defaults Default kubelet behaviour for kernel tuning. If set, kubelet errors if any of kernel tunables is different than kubelet defaults.
+ --read-only-port int32 The read-only port for the Kubelet to serve on with no authentication/authorization (set to 0 to disable) (default 10255)
+ --really-crash-for-testing If true, when panics occur crash. Intended for testing.
+ --register-node Register the node with the apiserver (defaults to true if --api-servers is set) (default true)
+ --register-schedulable Register the node as schedulable. Won't have any effect if register-node is false. [default=true] (default true)
+ --registry-burst int32 Maximum size of a bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry-qps. Only used if --registry-qps > 0 (default 10)
+ --registry-qps int32 If > 0, limit registry pull QPS to this value. If 0, unlimited. [default=5.0] (default 5)
+ --require-kubeconfig If true the Kubelet will exit if there are configuration errors, and will ignore the value of --api-servers in favor of the server defined in the kubeconfig file.
+ --resolv-conf string Resolver configuration file used as the basis for the container DNS resolution configuration. (default "/etc/resolv.conf")
+ --rkt-api-endpoint string The endpoint of the rkt API service to communicate with. Only used if --container-runtime='rkt'. (default "localhost:15441")
+ --rkt-path string Path of rkt binary. Leave empty to use the first rkt in $PATH. Only used if --container-runtime='rkt'.
+ --root-dir string Directory path for managing kubelet files (volume mounts,etc). (default "/var/lib/kubelet")
+ --runonce If true, exit after spawning pods from local manifests or remote urls. Exclusive with --api-servers, and --enable-server
+ --runtime-cgroups string Optional absolute name of cgroups to create and run the runtime in.
+ --runtime-request-timeout duration Timeout of all runtime requests except long running request - pull, logs, exec and attach. When timeout exceeded, kubelet will cancel the request, throw out an error and retry later. Default: 2m0s (default 2m0s)
+ --seccomp-profile-root string Directory path for seccomp profiles. (default "/var/lib/kubelet/seccomp")
+ --serialize-image-pulls Pull images one at a time. We recommend *not* changing the default value on nodes that run docker daemon with version < 1.9 or an Aufs storage backend. Issue #10959 has more details. [default=true] (default true)
+ --streaming-connection-idle-timeout duration Maximum time a streaming connection can be idle before the connection is automatically closed. 0 indicates no timeout. Example: '5m' (default 4h0m0s)
+ --sync-frequency duration Max period between synchronizing running containers and config (default 1m0s)
+ --system-cgroups / Optional absolute name of cgroups in which to place all non-kernel processes that are not already inside a cgroup under /. Empty for no container. Rolling back the flag requires a reboot. (Default: "").
+ --system-reserved mapStringString A set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for non-kubernetes components. Currently only cpu and memory are supported. See http://kubernetes.io/docs/user-guide/compute-resources for more detail. [default=none]
+ --tls-cert-file string File containing x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory passed to --cert-dir.
+ --tls-private-key-file string File containing x509 private key matching --tls-cert-file.
+ --volume-plugin-dir string The full path of the directory in which to search for additional third party volume plugins (default "/usr/libexec/kubernetes/kubelet-plugins/volume/exec/")
+ --volume-stats-agg-period duration Specifies interval for kubelet to calculate and cache the volume disk usage for all pods and volumes. To disable volume calculations, set to 0. Default: '1m' (default 1m0s)
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
diff --git a/docs/admin/limitrange/index.md b/docs/admin/limitrange/index.md
index 0336264bc3..2241cbb140 100644
--- a/docs/admin/limitrange/index.md
+++ b/docs/admin/limitrange/index.md
@@ -2,7 +2,7 @@
assignees:
- derekwaynecarr
- janetkuo
-
+title: Setting Pod CPU and Memory Limits
---
By default, pods run with unbounded CPU and memory limits. This means that any pod in the
@@ -184,7 +184,7 @@ Note that this pod specifies explicit resource *limits* and *requests* so it did
default values.
Note: The *limits* for CPU resource are enforced in the default Kubernetes setup on the physical node
-that runs the container unless the administrator deploys the kubelet with the folllowing flag:
+that runs the container unless the administrator deploys the kubelet with the following flag:
```shell
$ kubelet --help
diff --git a/docs/admin/master-node-communication.md b/docs/admin/master-node-communication.md
index 9e8b9cfa9e..91ecff7ef9 100644
--- a/docs/admin/master-node-communication.md
+++ b/docs/admin/master-node-communication.md
@@ -3,7 +3,7 @@ assignees:
- dchen1107
- roberthbailey
- liggitt
-
+title: Master-Node communication
---
* TOC
diff --git a/docs/admin/multi-cluster.md b/docs/admin/multi-cluster.md
index 6359782409..67a2589d40 100644
--- a/docs/admin/multi-cluster.md
+++ b/docs/admin/multi-cluster.md
@@ -1,14 +1,14 @@
---
assignees:
- davidopp
-
+title: Using Multiple Clusters
---
You may want to set up multiple Kubernetes clusters, both to
have clusters in different regions to be nearer to your users, and to tolerate failures and/or invasive maintenance.
This document describes some of the issues to consider when making a decision about doing so.
-If you decide to have multiple clusters, kubernetes provides a way to [federate them](/docs/admin/federation/)
+If you decide to have multiple clusters, Kubernetes provides a way to [federate them](/docs/admin/federation/)
## Scope of a single cluster
@@ -52,7 +52,7 @@ Second, decide how many clusters should be able to be unavailable at the same ti
the number that can be unavailable `U`. If you are not sure, then 1 is a fine choice.
If it is allowable for load-balancing to direct traffic to any region in the event of a cluster failure, then
-you need at least the larger of `R` or `U + 1` clusters. If it is not (e.g you want to ensure low latency for all
+you need at least the larger of `R` or `U + 1` clusters. If it is not (e.g. you want to ensure low latency for all
users in the event of a cluster failure), then you need to have `R * (U + 1)` clusters
(`U + 1` in each of `R` regions). In any case, try to put each cluster in a different zone.
diff --git a/docs/admin/multiple-schedulers.md b/docs/admin/multiple-schedulers.md
index 8ba152ac04..eb1c4c44f9 100644
--- a/docs/admin/multiple-schedulers.md
+++ b/docs/admin/multiple-schedulers.md
@@ -2,7 +2,7 @@
assignees:
- davidopp
- madhusudancs
-
+title: Configuring Multiple Schedulers
---
Kubernetes ships with a default scheduler that is described [here](/docs/admin/kube-scheduler/).
diff --git a/docs/admin/multiple-zones.md b/docs/admin/multiple-zones.md
index bfde54213e..e215b31716 100644
--- a/docs/admin/multiple-zones.md
+++ b/docs/admin/multiple-zones.md
@@ -3,7 +3,7 @@ assignees:
- jlowdermilk
- justinsb
- quinton-hoole
-
+title: Running in Multiple Zones
---
## Introduction
diff --git a/docs/admin/namespaces/index.md b/docs/admin/namespaces/index.md
index 574f41b10a..b723a9c361 100644
--- a/docs/admin/namespaces/index.md
+++ b/docs/admin/namespaces/index.md
@@ -2,7 +2,7 @@
assignees:
- derekwaynecarr
- janetkuo
-
+title: Sharing a Cluster with Namespaces
---
A Namespace is a mechanism to partition resources created by users into
diff --git a/docs/admin/namespaces/walkthrough.md b/docs/admin/namespaces/walkthrough.md
index 2a3e6298ea..b9c509697c 100644
--- a/docs/admin/namespaces/walkthrough.md
+++ b/docs/admin/namespaces/walkthrough.md
@@ -2,7 +2,7 @@
assignees:
- derekwaynecarr
- janetkuo
-
+title: Namespaces Walkthrough
---
Kubernetes _namespaces_ help different projects, teams, or customers to share a Kubernetes cluster.
@@ -151,7 +151,7 @@ Let's create some content.
$ kubectl run snowflake --image=kubernetes/serve_hostname --replicas=2
```
We have just created a deployment whose replica size is 2 that is running the pod called snowflake with a basic container that just serves the hostname.
-Note that `kubectl run` creates deployments only on kubernetes cluster >= v1.2. If you are running older versions, it creates replication controllers instead.
+Note that `kubectl run` creates deployments only on Kubernetes cluster >= v1.2. If you are running older versions, it creates replication controllers instead.
If you want to obtain the old behavior, use `--generator=run/v1` to create replication controllers. See [`kubectl run`](/docs/user-guide/kubectl/kubectl_run/) for more details.
```shell
diff --git a/docs/admin/network-plugins.md b/docs/admin/network-plugins.md
index 6c5f354423..dd51a11b86 100644
--- a/docs/admin/network-plugins.md
+++ b/docs/admin/network-plugins.md
@@ -3,7 +3,7 @@ assignees:
- dcbw
- freehan
- thockin
-
+title: Network Plugins
---
* TOC
@@ -26,13 +26,13 @@ The kubelet has a single default network plugin, and a default network common to
## Network Plugin Requirements
-Besides providing the [`NetworkPlugin` interface](https://github.com/kubernetes/kubernetes/tree/{{page.version}}.0/pkg/kubelet/network/plugins.go) to configure and clean up pod networking, the plugin may also need specific support for kube-proxy. The iptables proxy obviously depends on iptables, and the plugin may need to ensure that container traffic is made available to iptables. For example, if the plugin connects containers to a Linux bridge, the plugin must set the `net/bridge/bridge-nf-call-iptables` sysctl to `1` to ensure that the iptables proxy functions correctly. If the plugin does not use a Linux bridge (but instead something like Open vSwitch or some other mechanism) it should ensure container traffic is appropriately routed for the proxy.
+Besides providing the [`NetworkPlugin` interface](https://github.com/kubernetes/kubernetes/tree/{{page.version}}/pkg/kubelet/network/plugins.go) to configure and clean up pod networking, the plugin may also need specific support for kube-proxy. The iptables proxy obviously depends on iptables, and the plugin may need to ensure that container traffic is made available to iptables. For example, if the plugin connects containers to a Linux bridge, the plugin must set the `net/bridge/bridge-nf-call-iptables` sysctl to `1` to ensure that the iptables proxy functions correctly. If the plugin does not use a Linux bridge (but instead something like Open vSwitch or some other mechanism) it should ensure container traffic is appropriately routed for the proxy.
By default if no kubelet network plugin is specified, the `noop` plugin is used, which sets `net/bridge/bridge-nf-call-iptables=1` to ensure simple configurations (like docker with a bridge) work correctly with the iptables proxy.
### Exec
-Place plugins in `network-plugin-dir/plugin-name/plugin-name`, i.e if you have a bridge plugin and `network-plugin-dir` is `/usr/lib/kubernetes`, you'd place the bridge plugin executable at `/usr/lib/kubernetes/bridge/bridge`. See [this comment](https://github.com/kubernetes/kubernetes/tree/{{page.version}}.0/pkg/kubelet/network/exec/exec.go) for more details.
+Place plugins in `network-plugin-dir/plugin-name/plugin-name`, i.e. if you have a bridge plugin and `network-plugin-dir` is `/usr/lib/kubernetes`, you'd place the bridge plugin executable at `/usr/lib/kubernetes/bridge/bridge`. See [this comment](https://github.com/kubernetes/kubernetes/tree/{{page.version}}/pkg/kubelet/network/exec/exec.go) for more details.
### CNI
@@ -50,13 +50,11 @@ Kubenet is a very basic, simple network plugin, on Linux only. It does not, of
Kubenet creates a Linux bridge named `cbr0` and creates a veth pair for each pod with the host end of each pair connected to `cbr0`. The pod end of the pair is assigned an IP address allocated from a range assigned to the node either through configuration or by the controller-manager. `cbr0` is assigned an MTU matching the smallest MTU of an enabled normal interface on the host.
-The kubenet plugin is mutually exclusive with the --configure-cbr0 option.
-
The plugin requires a few things:
* The standard CNI `bridge`, `lo` and `host-local` plugins are required, at minimum version 0.2.0. Kubenet will first search for them in `/opt/cni/bin`. Specify `network-plugin-dir` to supply additional search path. The first found match will take effect.
* Kubelet must be run with the `--network-plugin=kubenet` argument to enable the plugin
-* Kubelet must also be run with the `--reconcile-cidr` argument to ensure the IP subnet assigned to the node by configuration or the controller-manager is propagated to the plugin
+* Kubelet should also be run with the `--non-masquerade-cidr=` argumment to ensure traffic to IPs outside this range will use IP masquerade.
* The node must be assigned an IP subnet through either the `--pod-cidr` kubelet command-line option or the `--allocate-node-cidrs=true --cluster-cidr=` controller-manager command-line options.
### Customizing the MTU (with kubenet)
diff --git a/docs/admin/networking.md b/docs/admin/networking.md
index 28c259a5f7..e1de39fdbd 100644
--- a/docs/admin/networking.md
+++ b/docs/admin/networking.md
@@ -2,7 +2,7 @@
assignees:
- lavalamp
- thockin
-
+title: Networking in Kubernetes
---
Kubernetes approaches networking somewhat differently than Docker does by
@@ -169,12 +169,26 @@ Follow the "With Linux Bridge devices" section of [this very nice
tutorial](http://blog.oddbit.com/2014/08/11/four-ways-to-connect-a-docker/) from
Lars Kellogg-Stedman.
+### Nuage Networks VCS (Virtualized Cloud Services)
+
+[Nuage](http://www.nuagenetworks.net) provides a highly scalable policy-based Software-Defined Networking (SDN) platform. Nuage uses the open source Open vSwitch for the data plane along with a feature rich SDN Controller built on open standards.
+
+The Nuage platform uses overlays to provide seamless policy-based networking between Kubernetes Pods and non-Kubernetes environments (VMs and bare metal servers). Nuage's policy abstraction model is designed with applications in mind and makes it easy to declare fine-grained policies for applications.The platform's real-time analytics engine enables visibility and security monitoring for Kubernetes applications.
+
### OpenVSwitch
[OpenVSwitch](/docs/admin/ovs-networking) is a somewhat more mature but also
complicated way to build an overlay network. This is endorsed by several of the
"Big Shops" for networking.
+### OVN (Open Virtual Networking)
+
+OVN is an opensource network virtualization solution developed by the
+Open vSwitch community. It lets one create logical switches, logical routers,
+stateful ACLs, load-balancers etc to build different virtual networking
+topologies. The project has a specific Kubernetes plugin and documentation
+at [ovn-kubernetes](https://github.com/openvswitch/ovn-kubernetes).
+
### Project Calico
[Project Calico](http://docs.projectcalico.org/) is an open source container networking provider and network policy engine.
diff --git a/docs/admin/node-conformance.md b/docs/admin/node-conformance.md
index 52935bc4cc..f53ba858b1 100644
--- a/docs/admin/node-conformance.md
+++ b/docs/admin/node-conformance.md
@@ -1,7 +1,7 @@
---
assignees:
- Random-Liu
-
+title: Validate Node Setup
---
* TOC
diff --git a/docs/admin/node-problem.md b/docs/admin/node-problem.md
index b6926ba15b..b4f3e6ee31 100644
--- a/docs/admin/node-problem.md
+++ b/docs/admin/node-problem.md
@@ -2,7 +2,7 @@
assignees:
- Random-Liu
- dchen1107
-
+title: Monitoring Node Health
---
* TOC
@@ -49,7 +49,7 @@ either `kubectl` or addon pod.
### Kubectl
-This is the recommanded way to start node problem detector outside of GCE. It
+This is the recommended way to start node problem detector outside of GCE. It
provides more flexible management, such as overwriting the default
configuration to fit it into your environment or detect
customized node problems.
@@ -238,7 +238,7 @@ implement a new translator for a new log format.
## Caveats
-It is recommanded to run the node problem detector in your cluster to monitor
+It is recommended to run the node problem detector in your cluster to monitor
the node health. However, you should be aware that this will introduce extra
resource overhead on each node. Usually this is fine, because:
diff --git a/docs/admin/node.md b/docs/admin/node.md
index ad0867ffc8..cbb70229e7 100644
--- a/docs/admin/node.md
+++ b/docs/admin/node.md
@@ -3,7 +3,7 @@ assignees:
- caesarxuchao
- dchen1107
- lavalamp
-
+title: Nodes
---
* TOC
@@ -20,7 +20,15 @@ architecture design doc for more details.
## Node Status
-A node's status is comprised of the following information.
+A node's status contains the following information:
+
+* [Addresses](#Addresses)
+* ~~[Phase](#Phase)~~ **deprecated**
+* [Condition](#Condition)
+* [Capacity](#Capacity)
+* [Info](#Info)
+
+Each section is described in detail below.
### Addresses
@@ -186,7 +194,7 @@ Modifications include setting labels on the node and marking it unschedulable.
Labels on nodes can be used in conjunction with node selectors on pods to control scheduling,
e.g. to constrain a pod to only be eligible to run on a subset of the nodes.
-Marking a node as unscheduleable will prevent new pods from being scheduled to that
+Marking a node as unschedulable will prevent new pods from being scheduled to that
node, but will not affect any existing pods on the node. This is useful as a
preparatory step before a node reboot, etc. For example, to mark a node
unschedulable, run this command:
@@ -236,6 +244,6 @@ on each kubelet where you want to reserve resources.
## API Object
-Node is a top-level resource in the kubernetes REST API. More details about the
+Node is a top-level resource in the Kubernetes REST API. More details about the
API object can be found at: [Node API
object](/docs/api-reference/v1/definitions/#_v1_node).
diff --git a/docs/admin/out-of-resource.md b/docs/admin/out-of-resource.md
index 8af7114ed6..30b8744624 100644
--- a/docs/admin/out-of-resource.md
+++ b/docs/admin/out-of-resource.md
@@ -3,7 +3,7 @@ assignees:
- derekwaynecarr
- vishh
- timstclair
-
+title: Configuring Out Of Resource Handling
---
* TOC
@@ -330,7 +330,7 @@ for eviction. Instead `DaemonSet` should ideally launch `Guaranteed` pods.
`kubelet` has been freeing up disk space on demand to keep the node stable.
As disk based eviction matures, the following `kubelet` flags will be marked for deprecation
-in favor of the simpler configuation supported around eviction.
+in favor of the simpler configuration supported around eviction.
| Existing Flag | New Flag |
| ------------- | -------- |
@@ -349,7 +349,7 @@ in favor of the simpler configuation supported around eviction.
The `kubelet` currently polls `cAdvisor` to collect memory usage stats at a regular interval. If memory usage
increases within that window rapidly, the `kubelet` may not observe `MemoryPressure` fast enough, and the `OOMKiller`
will still be invoked. We intend to integrate with the `memcg` notification API in a future release to reduce this
-latency, and instead have the kernel tell us when a threshold has been crossed immmediately.
+latency, and instead have the kernel tell us when a threshold has been crossed immediately.
If you are not trying to achieve extreme utilization, but a sensible measure of overcommit, a viable workaround for
this issue is to set eviction thresholds at approximately 75% capacity. This increases the ability of this feature
diff --git a/docs/admin/ovs-networking.md b/docs/admin/ovs-networking.md
index 7a8f89506c..9370dcec46 100644
--- a/docs/admin/ovs-networking.md
+++ b/docs/admin/ovs-networking.md
@@ -2,7 +2,7 @@
assignees:
- lavalamp
- thockin
-
+title: Kubernetes OpenVSwitch GRE/VxLAN networking
---
This document describes how OpenVSwitch is used to setup networking between pods across nodes.
diff --git a/docs/admin/rescheduler.md b/docs/admin/rescheduler.md
index e1a2cca5de..ba3633e83b 100644
--- a/docs/admin/rescheduler.md
+++ b/docs/admin/rescheduler.md
@@ -30,13 +30,13 @@ given the pods that are already running in the cluster
the rescheduler tries to free up space for the add-on by evicting some pods; then the scheduler will schedule the add-on pod.
To avoid situation when another pod is scheduled into the space prepared for the critical add-on,
-the chosen node gets a temporary taint “CriticalAddonsOnly” before the eviction(s)
+the chosen node gets a temporary taint "CriticalAddonsOnly" before the eviction(s)
(see [more details](https://github.com/kubernetes/kubernetes/blob/master/docs/design/taint-toleration-dedicated.md)).
Each critical add-on has to tolerate it,
the other pods shouldn't tolerate the taint. The tain is removed once the add-on is successfully scheduled.
*Warning:* currently there is no guarantee which node is chosen and which pods are being killed
-in order to schedule crical pod, so if rescheduler is enabled you pods might be occasionally
+in order to schedule critical pods, so if rescheduler is enabled you pods might be occasionally
killed for this purpose.
## Config
@@ -50,11 +50,10 @@ It's enabled by default. It can be disabled:
### Marking add-on as critical
-To be critical an add-on has to run in `kube-system` namespace (cofigurable via flag)
+To be critical an add-on has to run in `kube-system` namespace (configurable via flag)
and have the following annotations specified:
* `scheduler.alpha.kubernetes.io/critical-pod` set to empty string
* `scheduler.alpha.kubernetes.io/tolerations` set to `[{"key":"CriticalAddonsOnly", "operator":"Exists"}]`
The first one marks a pod a critical. The second one is required by Rescheduler algorithm.
-
diff --git a/docs/admin/resourcequota/index.md b/docs/admin/resourcequota/index.md
index ff76942702..24d7a09246 100644
--- a/docs/admin/resourcequota/index.md
+++ b/docs/admin/resourcequota/index.md
@@ -1,7 +1,7 @@
---
assignees:
- derekwaynecarr
-
+title: Resource Quotas
---
When several users or teams share a cluster with a fixed number of nodes,
@@ -52,8 +52,7 @@ Resource Quota is enforced in a particular namespace when there is a
## Compute Resource Quota
-You can limit the total sum of [compute resources](/docs/user-guide/compute-resources) and [storage resources](/docs/user-guide/persistent-volumes)
-that can be requested in a given namespace.
+You can limit the total sum of [compute resources](/docs/user-guide/compute-resources) that can be requested in a given namespace.
The following resource types are supported:
@@ -65,7 +64,25 @@ The following resource types are supported:
| `memory` | Across all pods in a non-terminal state, the sum of memory requests cannot exceed this value. |
| `requests.cpu` | Across all pods in a non-terminal state, the sum of CPU requests cannot exceed this value. |
| `requests.memory` | Across all pods in a non-terminal state, the sum of memory requests cannot exceed this value. |
+
+## Storage Resource Quota
+
+You can limit the total sum of [storage resources](/docs/user-guide/persistent-volumes) that can be requested in a given namespace.
+
+In addition, you can limit consumption of storage resources based on associated storage-class.
+
+| Resource Name | Description |
+| --------------------- | ----------------------------------------------------------- |
| `requests.storage` | Across all persistent volume claims, the sum of storage requests cannot exceed this value. |
+| `persistentvolumeclaims` | The total number of [persistent volume claims](/docs/user-guide/persistent-volumes/#persistentvolumeclaims) that can exist in the namespace. |
+| `.storageclass.storage.k8s.io/requests.storage` | Across all persistent volume claims associated with the storage-class-name, the sum of storage requests cannot exceed this value. |
+| `.storageclass.storage.k8s.io/persistentvolumeclaims` | Across all persistent volume claims associated with the storage-class-name, the total number of [persistent volume claims](/docs/user-guide/persistent-volumes/#persistentvolumeclaims) that can exist in the namespace. |
+
+For example, if an operator wants to quota storage with `gold` storage class separate from `bronze` storage class, the operator can
+define a quota as follows:
+
+* `gold.storageclass.storage.k8s.io/requests.storage: 500Gi`
+* `bronze.storageclass.storage.k8s.io/requests.storage: 100Gi`
## Object Count Quota
@@ -125,7 +142,7 @@ The quota can be configured to quota either value.
If the quota has a value specified for `requests.cpu` or `requests.memory`, then it requires that every incoming
container makes an explicit request for those resources. If the quota has a value specified for `limits.cpu` or `limits.memory`,
-then it requires that every incoming container specifies an explict limit for those resources.
+then it requires that every incoming container specifies an explicit limit for those resources.
## Viewing and Setting Quotas
diff --git a/docs/admin/resourcequota/walkthrough.md b/docs/admin/resourcequota/walkthrough.md
index 7422f2abcf..1120e7550d 100644
--- a/docs/admin/resourcequota/walkthrough.md
+++ b/docs/admin/resourcequota/walkthrough.md
@@ -2,7 +2,7 @@
assignees:
- derekwaynecarr
- janetkuo
-
+title: Applying Resource Quotas and Limits
---
This example demonstrates a typical setup to control for resource usage in a namespace.
@@ -232,7 +232,7 @@ services.loadbalancers 0 2
services.nodeports 0 0
```
-As you can see, the pod that was created is consuming explict amounts of compute resources, and the usage is being
+As you can see, the pod that was created is consuming explicit amounts of compute resources, and the usage is being
tracked by Kubernetes properly.
## Step 5: Advanced quota scopes
diff --git a/docs/admin/salt.md b/docs/admin/salt.md
index 5d82b54d39..ba4d4fe227 100644
--- a/docs/admin/salt.md
+++ b/docs/admin/salt.md
@@ -2,7 +2,7 @@
assignees:
- davidopp
- lavalamp
-
+title: Configuring Kubernetes with Salt
---
The Kubernetes cluster can be configured using Salt.
diff --git a/docs/admin/service-accounts-admin.md b/docs/admin/service-accounts-admin.md
index 810f4d7515..4a31fbeced 100644
--- a/docs/admin/service-accounts-admin.md
+++ b/docs/admin/service-accounts-admin.md
@@ -4,7 +4,7 @@ assignees:
- davidopp
- lavalamp
- liggitt
-
+title: Managing Service Accounts
---
*This is a Cluster Administrator guide to service accounts. It assumes knowledge of
diff --git a/docs/admin/static-pods.md b/docs/admin/static-pods.md
index 531494fb04..4766002917 100644
--- a/docs/admin/static-pods.md
+++ b/docs/admin/static-pods.md
@@ -1,7 +1,7 @@
---
assignees:
- jsafrane
-
+title: Static Pods
---
**If you are running clustered Kubernetes and are using static pods to run a pod on every node, you should probably be using a [DaemonSet](/docs/admin/daemons/)!**
@@ -16,7 +16,7 @@ Static pod can be created in two ways: either by using configuration file(s) or
### Configuration files
-The configuration files are just standard pod definition in json or yaml format in specific directory. Use `kubelet --config=` to start kubelet daemon, which periodically scans the directory and creates/deletes static pods as yaml/json files appear/disappear there.
+The configuration files are just standard pod definition in json or yaml format in specific directory. Use `kubelet --pod-manifest-path=` to start kubelet daemon, which periodically scans the directory and creates/deletes static pods as yaml/json files appear/disappear there.
For example, this is how to start a simple web server as a static pod:
@@ -48,10 +48,10 @@ For example, this is how to start a simple web server as a static pod:
EOF
```
-2. Configure your kubelet daemon on the node to use this directory by running it with `--config=/etc/kubelet.d/` argument. On Fedora edit `/etc/kubernetes/kubelet` to include this line:
+2. Configure your kubelet daemon on the node to use this directory by running it with `--pod-manifest-path=/etc/kubelet.d/` argument. On Fedora edit `/etc/kubernetes/kubelet` to include this line:
```conf
- KUBELET_ARGS="--cluster-dns=10.254.0.10 --cluster-domain=kube.local --config=/etc/kubelet.d/"
+ KUBELET_ARGS="--cluster-dns=10.254.0.10 --cluster-domain=kube.local --pod-manifest-path=/etc/kubelet.d/"
```
Instructions for other distributions or Kubernetes installations may vary.
@@ -64,11 +64,11 @@ For example, this is how to start a simple web server as a static pod:
## Pods created via HTTP
-Kubelet periodically downloads a file specified by `--manifest-url=` argument and interprets it as a json/yaml file with a pod definition. It works the same as `--config=`, i.e. it's reloaded every now and then and changes are applied to running static pods (see below).
+Kubelet periodically downloads a file specified by `--manifest-url=` argument and interprets it as a json/yaml file with a pod definition. It works the same as `--pod-manifest-path=`, i.e. it's reloaded every now and then and changes are applied to running static pods (see below).
## Behavior of static pods
-When kubelet starts, it automatically starts all pods defined in directory specified in `--config=` or `--manifest-url=` arguments, i.e. our static-web. (It may take some time to pull nginx image, be patient…):
+When kubelet starts, it automatically starts all pods defined in directory specified in `--pod-manifest-path=` or `--manifest-url=` arguments, i.e. our static-web. (It may take some time to pull nginx image, be patient…):
```shell
[joe@my-node1 ~] $ docker ps
diff --git a/docs/admin/sysctls.md b/docs/admin/sysctls.md
index dc62b8c3d1..ff6829850e 100644
--- a/docs/admin/sysctls.md
+++ b/docs/admin/sysctls.md
@@ -9,7 +9,7 @@ assignees:
This document describes how sysctls are used within a Kubernetes cluster.
-## What is a _Sysctl_?
+## What is a Sysctl?
In Linux, the sysctl interface allows an administrator to modify kernel
parameters at runtime. Parameters are available via the `/proc/sys/` virtual
diff --git a/docs/api-reference/README.md b/docs/api-reference/README.md
index 905b267947..d0040388c8 100644
--- a/docs/api-reference/README.md
+++ b/docs/api-reference/README.md
@@ -1,18 +1,14 @@
---
---
-
# API Reference
-Use the following reference docs to understand the kubernetes REST API for various API group versions:
+Use the following reference docs to understand the Kubernetes REST API for various API group versions:
* v1: [operations](/docs/api-reference/v1/operations.html), [model definitions](/docs/api-reference/v1/definitions.html)
* extensions/v1beta1: [operations](/docs/api-reference/extensions/v1beta1/operations.html), [model definitions](/docs/api-reference/extensions/v1beta1/definitions.html)
* batch/v1: [operations](/docs/api-reference/batch/v1/operations.html), [model definitions](/docs/api-reference/batch/v1/definitions.html)
* autoscaling/v1: [operations](/docs/api-reference/autoscaling/v1/operations.html), [model definitions](/docs/api-reference/autoscaling/v1/definitions.html)
-
-
-
-
+* apps/v1beta1: [operations](/docs/api-reference/apps/v1beta1/operations.html), [model definitions](/docs/api-reference/apps/v1beta1/definitions.html)
diff --git a/docs/api-reference/apps/v1alpha1/definitions.html b/docs/api-reference/apps/v1beta1/definitions.html
similarity index 89%
rename from docs/api-reference/apps/v1alpha1/definitions.html
rename to docs/api-reference/apps/v1beta1/definitions.html
index 0dfdf27a56..77ef25e10c 100755
--- a/docs/api-reference/apps/v1alpha1/definitions.html
+++ b/docs/api-reference/apps/v1beta1/definitions.html
@@ -18,10 +18,10 @@
Represents a Photon Controller persistent disk resource.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
pdID
+
ID that identifies Photon Controller persistent disk
+
true
+
string
+
+
+
+
fsType
+
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.
+
false
+
string
+
+
+
+
+
+
+
+
versioned.Event
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
type
+
+
true
+
string
+
+
+
+
object
+
+
true
+
string
+
+
+
+
+
+
+
v1.Preconditions
Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
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: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
false
string
partition
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#gcepersistentdisk
+
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: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
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: http://releases.k8s.io/release-1.4/docs/user-guide/containers.md#containers-and-commands
+
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: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
false
string array
args
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/containers.md#containers-and-commands
+
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: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
A StatefulSetSpec is the specification of a StatefulSet.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
replicas
+
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.
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.
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.
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.
+
true
+
string
+
+
+
+
+
v1.ObjectMeta
@@ -1232,7 +1410,7 @@ Examples:
-
+
@@ -1246,7 +1424,7 @@ Examples:
name
-
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://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names
+
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
false
string
@@ -1257,7 +1435,7 @@ Examples:
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).
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.
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.
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.
@@ -1307,16 +1485,16 @@ Populated by the system. Read-only. Value must be treated as opaque by clients a
creationTimestamp
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.
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 will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
+
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once 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.
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
false
object
annotations
-
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://releases.k8s.io/release-1.4/docs/user-guide/annotations.md
+
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
false
object
@@ -1378,7 +1556,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -1399,21 +1577,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
@@ -1478,7 +1656,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -1526,7 +1704,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -1568,7 +1746,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
fsType
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#iscsi
+
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: http://kubernetes.io/docs/user-guide/volumes#iscsi
false
string
@@ -1583,68 +1761,6 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
-
-
v1alpha1.PetSetSpec
-
-
A PetSetSpec is the specification of a PetSet.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
replicas
-
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.
Template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the PetSet will fulfill this Template, but have a unique identity from the rest of the PetSet.
VolumeClaimTemplates is a list of claims that pets are allowed to reference. The PetSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pet. 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.
ServiceName is the name of the service that governs this PetSet. This service must exist before the PetSet, and is responsible for the network identity of the set. Pets get DNS/hostnames that follow the pattern: pet-specific-string.serviceName.default.svc.cluster.local where "pet-specific-string" is managed by the PetSet controller.
-
true
-
string
-
-
-
-
-
v1.EmptyDirVolumeSource
@@ -1657,7 +1773,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -1671,7 +1787,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
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: http://kubernetes.io/docs/user-guide/volumes#emptydir
false
string
@@ -1697,7 +1813,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -1711,21 +1827,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
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: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
false
string
@@ -1955,7 +2071,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
@@ -1967,7 +2083,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
v1.FlockerVolumeSource
-
Represents a Flocker volume mounted by the Flocker agent. Flocker volumes do not support ownership management or SELinux relabeling.
+
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.
@@ -1975,7 +2091,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -1989,8 +2105,15 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
datasetName
-
Required: the volume name. This is going to be store on metadata → name on the payload for Flocker
-
true
+
Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated
+
false
+
string
+
+
+
+
datasetUUID
+
UUID of the dataset. This is unique identifier of a Flocker dataset
+
false
string
@@ -2009,7 +2132,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -2030,7 +2153,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
@@ -2098,7 +2221,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -2148,71 +2271,6 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
-
-
v1alpha1.PetSet
-
-
PetSet represents a set of pods with consistent identities. Identities are defined as:
- - Network: A single stable DNS and hostname.
- - Storage: As many VolumeClaims as requested.
-The PetSet guarantees that a given network identity will always map to the same storage identity. PetSet is currently in alpha and subject to change without notice.
@@ -2810,6 +2827,71 @@ The PetSet guarantees that a given network identity will always map to the same
+
+
+
v1beta1.StatefulSet
+
+
StatefulSet represents a set of pods with consistent identities. Identities are defined as:
+ - Network: A single stable DNS and hostname.
+ - Storage: As many VolumeClaims as requested.
+The StatefulSet guarantees that a given network identity will always map to the same storage identity.
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: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#hostpath
+
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: http://kubernetes.io/docs/user-guide/volumes#hostpath
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. More info: http://kubernetes.io/docs/user-guide/containers
@@ -3587,7 +3676,7 @@ The PetSet guarantees that a given network identity will always map to the same
imagePullSecrets
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod
+
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: http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
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: http://kubernetes.io/docs/user-guide/container-environment#hook-details
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: http://releases.k8s.io/release-1.4/docs/user-guide/container-environment.md#hook-details
+
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: http://kubernetes.io/docs/user-guide/container-environment#hook-details
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: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#rbd
+
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: http://kubernetes.io/docs/user-guide/volumes#rbd
@@ -4003,7 +4092,7 @@ The PetSet guarantees that a given network identity will always map to the same
diff --git a/docs/api-reference/apps/v1alpha1/operations.html b/docs/api-reference/apps/v1beta1/operations.html
similarity index 91%
rename from docs/api-reference/apps/v1alpha1/operations.html
rename to docs/api-reference/apps/v1beta1/operations.html
index b46e335e91..8bcd4a2a08 100755
--- a/docs/api-reference/apps/v1alpha1/operations.html
+++ b/docs/api-reference/apps/v1beta1/operations.html
@@ -19,7 +19,7 @@
get available resources
-
GET /apis/apps/v1alpha1
+
GET /apis/apps/v1beta1
@@ -28,7 +28,7 @@
-
+
@@ -84,17 +84,17 @@
-
apisappsv1alpha1
+
apisappsv1beta1
-
list or watch objects of kind PetSet
+
list or watch objects of kind StatefulSet
-
GET /apis/apps/v1alpha1/namespaces/{namespace}/petsets
+
GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
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://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names
+
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
false
string
@@ -180,7 +180,7 @@
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).
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.
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.
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.
@@ -230,16 +230,16 @@ Populated by the system. Read-only. Value must be treated as opaque by clients a
creationTimestamp
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.
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 will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
+
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once 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.
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
false
object
annotations
-
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://releases.k8s.io/release-1.4/docs/user-guide/annotations.md
+
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
false
object
@@ -301,7 +301,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -349,7 +349,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -383,7 +383,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -397,14 +397,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
@@ -500,7 +500,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -548,7 +548,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
diff --git a/docs/api-reference/authentication.k8s.io/v1beta1/operations.html b/docs/api-reference/authentication.k8s.io/v1beta1/operations.html
index 2934b11a6f..9a234b46fc 100755
--- a/docs/api-reference/authentication.k8s.io/v1beta1/operations.html
+++ b/docs/api-reference/authentication.k8s.io/v1beta1/operations.html
@@ -28,7 +28,7 @@
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://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names
+
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
false
string
@@ -125,7 +131,7 @@
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).
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.
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.
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.
@@ -175,16 +181,16 @@ Populated by the system. Read-only. Value must be treated as opaque by clients a
creationTimestamp
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.
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 will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
+
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once 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.
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
false
object
annotations
-
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://releases.k8s.io/release-1.4/docs/user-guide/annotations.md
+
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
false
object
@@ -236,9 +242,9 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
v1beta1.SubjectAccessReview
+
v1beta1.SelfSubjectAccessReview
-
SubjectAccessReview checks whether or not a user or group can perform an action.
+
SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action
@@ -246,7 +252,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -260,14 +266,76 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
@@ -298,9 +366,9 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
unversioned.APIResourceList
+
v1beta1.LocalSubjectAccessReview
-
APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.
+
LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.
@@ -308,7 +376,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -322,14 +390,76 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
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.
APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.
@@ -363,7 +493,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -439,7 +569,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -468,6 +598,47 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
+
+
+
v1beta1.SelfSubjectAccessReviewSpec
+
+
SelfSubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
resourceAttributes
+
ResourceAuthorizationAttributes describes information for a resource access request
@@ -480,7 +651,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -542,7 +713,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -590,7 +761,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -638,7 +809,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
diff --git a/docs/api-reference/authorization.k8s.io/v1beta1/operations.html b/docs/api-reference/authorization.k8s.io/v1beta1/operations.html
index fb0c129910..bb75407034 100755
--- a/docs/api-reference/authorization.k8s.io/v1beta1/operations.html
+++ b/docs/api-reference/authorization.k8s.io/v1beta1/operations.html
@@ -28,7 +28,7 @@
-
+
@@ -91,10 +91,10 @@
-
create a SubjectAccessReview
+
create a LocalSubjectAccessReview
-
POST /apis/authorization.k8s.io/v1beta1/subjectaccessreviews
+
POST /apis/authorization.k8s.io/v1beta1/namespaces/{namespace}/localsubjectaccessreviews
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://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names
+
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
false
string
@@ -743,7 +779,7 @@
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).
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.
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.
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.
@@ -793,16 +829,16 @@ Populated by the system. Read-only. Value must be treated as opaque by clients a
creationTimestamp
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.
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 will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
+
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once 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.
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
false
object
annotations
-
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://releases.k8s.io/release-1.4/docs/user-guide/annotations.md
+
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
false
object
@@ -885,21 +921,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
Represents a Photon Controller persistent disk resource.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
pdID
+
ID that identifies Photon Controller persistent disk
+
true
+
string
+
+
+
+
fsType
+
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.
+
false
+
string
+
+
+
+
+
+
+
+
versioned.Event
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
type
+
+
true
+
string
+
+
+
+
object
+
+
true
+
string
+
+
+
+
+
+
+
v1.Preconditions
Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
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.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
matchLabels
-
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.
-
false
-
object
-
-
-
-
matchExpressions
-
matchExpressions is a list of label selector requirements. The requirements are ANDed.
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: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
false
string
partition
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#gcepersistentdisk
+
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: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
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: http://releases.k8s.io/release-1.4/docs/user-guide/containers.md#containers-and-commands
+
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: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
false
string array
args
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/containers.md#containers-and-commands
+
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: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
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://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names
+
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
false
string
@@ -1312,7 +1348,7 @@ Examples:
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).
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.
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.
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.
@@ -1362,16 +1398,16 @@ Populated by the system. Read-only. Value must be treated as opaque by clients a
creationTimestamp
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.
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 will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
+
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once 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.
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
false
object
annotations
-
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://releases.k8s.io/release-1.4/docs/user-guide/annotations.md
+
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
false
object
@@ -1454,21 +1490,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
@@ -1623,7 +1659,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
fsType
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#iscsi
+
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: http://kubernetes.io/docs/user-guide/volumes#iscsi
false
string
@@ -1664,7 +1700,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
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: http://kubernetes.io/docs/user-guide/volumes#emptydir
false
string
@@ -1704,21 +1740,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
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: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
false
string
@@ -1886,7 +1922,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
@@ -1898,7 +1934,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
v1.FlockerVolumeSource
-
Represents a Flocker volume mounted by the Flocker agent. Flocker volumes do not support ownership management or SELinux relabeling.
+
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.
@@ -1920,8 +1956,15 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
datasetName
-
Required: the volume name. This is going to be store on metadata → name on the payload for Flocker
-
true
+
Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated
+
false
+
string
+
+
+
+
datasetUUID
+
UUID of the dataset. This is unique identifier of a Flocker dataset
+
false
string
@@ -1961,7 +2004,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
@@ -2093,6 +2136,47 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
+
+
+
unversioned.LabelSelector
+
+
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.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
matchLabels
+
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.
+
false
+
object
+
+
+
+
matchExpressions
+
matchExpressions is a list of label selector requirements. The requirements are ANDed.
@@ -2268,54 +2352,6 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
-
-
v1.LabelSelectorRequirement
-
-
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
key
-
key is the label key that the selector applies to.
-
true
-
string
-
-
-
-
operator
-
operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.
-
true
-
string
-
-
-
-
values
-
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.
-
false
-
string array
-
-
-
-
-
v1.EnvVar
@@ -2548,14 +2584,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
@@ -2740,14 +2776,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
parallelism
-
Parallelism 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: http://releases.k8s.io/release-1.4/docs/user-guide/jobs.md
+
Parallelism 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: http://kubernetes.io/docs/user-guide/jobs
false
integer (int32)
completions
-
Completions 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: http://releases.k8s.io/release-1.4/docs/user-guide/jobs.md
+
Completions 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: http://kubernetes.io/docs/user-guide/jobs
false
integer (int32)
@@ -2761,21 +2797,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
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: http://releases.k8s.io/release-1.4/docs/design/selector-generation.md
+
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: http://releases.k8s.io/HEAD/docs/design/selector-generation.md
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: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#hostpath
+
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: http://kubernetes.io/docs/user-guide/volumes#hostpath
@@ -3164,6 +3207,54 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
+
+
+
unversioned.LabelSelectorRequirement
+
+
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
key
+
key is the label key that the selector applies to.
+
true
+
string
+
+
+
+
operator
+
operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.
+
true
+
string
+
+
+
+
values
+
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.
+
false
+
string array
+
+
+
+
+
unversioned.APIResourceList
@@ -3190,14 +3281,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
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. More info: http://kubernetes.io/docs/user-guide/containers
@@ -3574,7 +3665,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
imagePullSecrets
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod
+
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: http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
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: http://kubernetes.io/docs/user-guide/container-environment#hook-details
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: http://releases.k8s.io/release-1.4/docs/user-guide/container-environment.md#hook-details
+
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: http://kubernetes.io/docs/user-guide/container-environment#hook-details
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: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#rbd
+
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: http://kubernetes.io/docs/user-guide/volumes#rbd
@@ -3935,7 +4026,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
diff --git a/docs/api-reference/batch/v1/operations.html b/docs/api-reference/batch/v1/operations.html
index 3883aca7d9..5be3ce0b60 100755
--- a/docs/api-reference/batch/v1/operations.html
+++ b/docs/api-reference/batch/v1/operations.html
@@ -1,5 +1,7 @@
---
+title: Batch API Operations
---
+
@@ -219,6 +221,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -370,6 +378,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -962,6 +976,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
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://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names
+
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
false
string
@@ -720,7 +754,7 @@
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).
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.
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.
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.
@@ -770,16 +804,16 @@ Populated by the system. Read-only. Value must be treated as opaque by clients a
creationTimestamp
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.
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 will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
+
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once 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.
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
false
object
annotations
-
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://releases.k8s.io/release-1.4/docs/user-guide/annotations.md
+
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
false
object
@@ -841,7 +875,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -862,21 +896,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
DesiredNumberScheduled is the total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
+
true
+
integer (int32)
+
+
+
+
numberReady
+
NumberReady is the number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
true
integer (int32)
@@ -191,7 +207,7 @@
v1beta1.Job
-
Job represents the configuration of a single job.
+
Job represents the configuration of a single job. DEPRECATED: extensions/v1beta1.Job is deprecated, use batch/v1.Job instead.
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: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
false
string
partition
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#gcepersistentdisk
+
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: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
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://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names
+
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
false
string
@@ -1280,7 +1354,7 @@ Examples:
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).
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.
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.
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.
@@ -1330,16 +1404,16 @@ Populated by the system. Read-only. Value must be treated as opaque by clients a
creationTimestamp
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.
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 will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
+
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once 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.
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
false
object
annotations
-
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://releases.k8s.io/release-1.4/docs/user-guide/annotations.md
+
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
false
object
@@ -1415,21 +1489,28 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
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)
false
integer (int32)
selector
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md#label-selectors
+
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: http://kubernetes.io/docs/user-guide/labels#label-selectors
Template is the 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: http://kubernetes.io/docs/user-guide/replication-controller#pod-template
@@ -1646,7 +1727,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
fsType
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#iscsi
+
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: http://kubernetes.io/docs/user-guide/volumes#iscsi
false
string
@@ -1687,7 +1768,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
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: http://kubernetes.io/docs/user-guide/volumes#emptydir
false
string
@@ -1721,21 +1802,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
@@ -1794,7 +1875,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
v1.FlockerVolumeSource
-
Represents a Flocker volume mounted by the Flocker agent. Flocker volumes do not support ownership management or SELinux relabeling.
+
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.
@@ -1816,8 +1897,15 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
datasetName
-
Required: the volume name. This is going to be store on metadata → name on the payload for Flocker
-
true
+
Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated
+
false
+
string
+
+
+
+
datasetUUID
+
UUID of the dataset. This is unique identifier of a Flocker dataset
+
false
string
@@ -1850,7 +1938,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
@@ -1968,6 +2056,47 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
+
+
+
unversioned.LabelSelector
+
+
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.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
matchLabels
+
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.
+
false
+
object
+
+
+
+
matchExpressions
+
matchExpressions is a list of label selector requirements. The requirements are ANDed.
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: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#hostpath
+
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: http://kubernetes.io/docs/user-guide/volumes#hostpath
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. Once autoRollback is implemented, the deployment controller will automatically rollback failed deployments. Note that progress will not be estimated during the time a deployment is paused. This is not set by default.
+
false
+
integer (int32)
+
+
@@ -3007,14 +3150,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
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. More info: http://kubernetes.io/docs/user-guide/containers
@@ -3370,7 +3513,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
imagePullSecrets
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod
+
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: http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
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: http://kubernetes.io/docs/user-guide/container-environment#hook-details
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: http://releases.k8s.io/release-1.4/docs/user-guide/container-environment.md#hook-details
+
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: http://kubernetes.io/docs/user-guide/container-environment#hook-details
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: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#rbd
+
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: http://kubernetes.io/docs/user-guide/volumes#rbd
@@ -3770,6 +3913,47 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
+
+
+
v1.PhotonPersistentDiskVolumeSource
+
+
Represents a Photon Controller persistent disk resource.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
pdID
+
ID that identifies Photon Controller persistent disk
+
true
+
string
+
+
+
+
fsType
+
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.
+
false
+
string
+
+
+
+
+
v1beta1.NetworkPolicy
@@ -3793,21 +3977,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
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: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md#label-selectors
+
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: http://kubernetes.io/docs/user-guide/labels#label-selectors
false
string
@@ -3895,7 +4117,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
podSelector
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.
@@ -4494,14 +4716,14 @@ Both these may change in the future. Incoming requests are matched against the h
podSelector
This is a label selector which selects Pods in this namespace. This field follows standard label selector semantics. If not provided, this selector selects no pods. If present but empty, this selector selects all pods in this namespace.
Selects Namespaces using cluster scoped-labels. This matches all pods in all namespaces selected by this label selector. This field follows standard label selector semantics. If omitted, this selector selects no namespaces. If present but empty, this selector selects all namespaces.
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: http://releases.k8s.io/release-1.4/docs/user-guide/containers.md#containers-and-commands
+
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: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
false
string array
args
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/containers.md#containers-and-commands
+
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: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
false
string array
@@ -4771,7 +4993,7 @@ Both these may change in the future. Incoming requests are matched against the h
@@ -5062,51 +5284,24 @@ Both these may change in the future. Incoming requests are matched against the h
+
availableReplicas
+
The number of available replicas (ready for at least minReadySeconds) for this replica set.
+
false
+
integer (int32)
+
+
+
observedGeneration
ObservedGeneration reflects the generation of the most recently observed ReplicaSet.
false
integer (int64)
-
-
-
-
-
-
v1beta1.LabelSelector
-
-
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.
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
matchLabels
-
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.
+
conditions
+
Represents the latest available observations of a replica set’s current state.
false
-
object
-
-
-
-
matchExpressions
-
matchExpressions is a list of label selector requirements. The requirements are ANDed.
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: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
false
string
@@ -5441,7 +5636,7 @@ Both these may change in the future. Incoming requests are matched against the h
@@ -5566,54 +5761,6 @@ Both these may change in the future. Incoming requests are matched against the h
-
-
-
v1beta1.LabelSelectorRequirement
-
-
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
-
-
-
-
-
-
-
-
-
-
-
-
Name
-
Description
-
Required
-
Schema
-
Default
-
-
-
-
-
key
-
key is the label key that the selector applies to.
-
true
-
string
-
-
-
-
operator
-
operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.
-
true
-
string
-
-
-
-
values
-
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.
-
false
-
string array
-
-
-
-
-
v1.EnvVar
@@ -5729,14 +5876,14 @@ Both these may change in the future. Incoming requests are matched against the h
@@ -5782,6 +5929,75 @@ Both these may change in the future. Incoming requests are matched against the h
+
+
+
v1beta1.DeploymentCondition
+
+
DeploymentCondition describes the state of a deployment at a certain point.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
type
+
Type of deployment condition.
+
true
+
string
+
+
+
+
status
+
Status of the condition, one of True, False, Unknown.
+
true
+
string
+
+
+
+
lastUpdateTime
+
The last time this condition was updated.
+
false
+
string (date-time)
+
+
+
+
lastTransitionTime
+
Last time the condition transitioned from one status to another.
+
false
+
string (date-time)
+
+
+
+
reason
+
The reason for the condition’s last transition.
+
false
+
string
+
+
+
+
message
+
A human readable message indicating details about the transition.
+
false
+
string
+
+
+
+
+
v1beta1.JobSpec
@@ -5808,14 +6024,14 @@ Both these may change in the future. Incoming requests are matched against the h
parallelism
-
Parallelism 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: http://releases.k8s.io/release-1.4/docs/user-guide/jobs.md
+
Parallelism 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: http://kubernetes.io/docs/user-guide/jobs
false
integer (int32)
completions
-
Completions 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: http://releases.k8s.io/release-1.4/docs/user-guide/jobs.md
+
Completions 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: http://kubernetes.io/docs/user-guide/jobs
false
integer (int32)
@@ -5829,21 +6045,21 @@ Both these may change in the future. Incoming requests are matched against the h
AutoSelector controls generation of pod labels and pod selectors. It was not present in the original extensions/v1beta1 Job definition, but exists to allow conversion from batch/v1 Jobs, where it corresponds to, but has the opposite meaning as, ManualSelector. More info: http://releases.k8s.io/release-1.4/docs/design/selector-generation.md
+
AutoSelector controls generation of pod labels and pod selectors. It was not present in the original extensions/v1beta1 Job definition, but exists to allow conversion from batch/v1 Jobs, where it corresponds to, but has the opposite meaning as, ManualSelector. More info: http://releases.k8s.io/HEAD/docs/design/selector-generation.md
@@ -5851,6 +6067,54 @@ Both these may change in the future. Incoming requests are matched against the h
+
+
+
unversioned.LabelSelectorRequirement
+
+
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
key
+
key is the label key that the selector applies to.
+
true
+
string
+
+
+
+
operator
+
operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.
+
true
+
string
+
+
+
+
values
+
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.
+
false
+
string array
+
+
+
+
+
unversioned.Status
@@ -5877,28 +6141,28 @@ Both these may change in the future. Incoming requests are matched against the h
@@ -6056,7 +6320,7 @@ Both these may change in the future. Incoming requests are matched against the h
path
-
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.
+
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.
false
string
@@ -6097,35 +6361,35 @@ Both these may change in the future. Incoming requests are matched against the h
@@ -6204,7 +6468,7 @@ Both these may change in the future. Incoming requests are matched against the h
diff --git a/docs/api-reference/extensions/v1beta1/definitions.md b/docs/api-reference/extensions/v1beta1/definitions.md
index c7cdbb0908..f5c5208e1b 100644
--- a/docs/api-reference/extensions/v1beta1/definitions.md
+++ b/docs/api-reference/extensions/v1beta1/definitions.md
@@ -1,11 +1,7 @@
---
---
-{% include v1.4/extensions-v1beta1-definitions.html %}
-
-
-
-
+{% include v1.5/extensions-v1beta1-definitions.html %}
diff --git a/docs/api-reference/extensions/v1beta1/operations.html b/docs/api-reference/extensions/v1beta1/operations.html
index 78a0f60bf6..a97f64b789 100755
--- a/docs/api-reference/extensions/v1beta1/operations.html
+++ b/docs/api-reference/extensions/v1beta1/operations.html
@@ -1,5 +1,7 @@
---
+title: Extensions API Operations
---
+
@@ -219,6 +221,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -362,6 +370,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -505,6 +519,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -648,6 +668,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -791,6 +817,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -942,6 +974,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -1534,6 +1572,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
@@ -2264,6 +2318,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -2856,6 +2916,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
@@ -4092,6 +4168,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -4684,6 +4766,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
@@ -5414,6 +5512,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -5580,7 +5684,7 @@
-
create a Ingress
+
create an Ingress
POST /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
@@ -6736,6 +6856,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -7328,6 +7454,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
@@ -8058,6 +8200,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -8650,6 +8798,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
@@ -9001,6 +9165,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -9593,6 +9763,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
@@ -11073,6 +11259,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -11216,6 +11408,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -11359,6 +11557,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -11919,6 +12123,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
diff --git a/docs/api-reference/extensions/v1beta1/operations.md b/docs/api-reference/extensions/v1beta1/operations.md
index 3aedba68c8..dab4b1d5b7 100644
--- a/docs/api-reference/extensions/v1beta1/operations.md
+++ b/docs/api-reference/extensions/v1beta1/operations.md
@@ -1,11 +1,7 @@
---
---
-{% include v1.4/extensions-v1beta1-operations.html %}
-
-
-
-
+{% include v1.5/extensions-v1beta1-operations.html %}
diff --git a/docs/api-reference/labels-annotations-taints.md b/docs/api-reference/labels-annotations-taints.md
new file mode 100644
index 0000000000..8ed53d763e
--- /dev/null
+++ b/docs/api-reference/labels-annotations-taints.md
@@ -0,0 +1,113 @@
+---
+---
+# Well-Known Labels, Annotations and Taints
+
+Kubernetes reserves all labels and annotations in the kubernetes.io namespace. This document describes
+the well-known kubernetes.io labels and annotations.
+
+This document serves both as a reference to the values, and as a coordination point for assigning values.
+
+**Table of contents:**
+
+
+- [Well-Known Labels, Annotations and Taints](#well-known-labels-annotations-and-taints)
+ - [beta.kubernetes.io/arch](#betakubernetesioarch)
+ - [beta.kubernetes.io/os](#betakubernetesioos)
+ - [kubernetes.io/hostname](#kubernetesiohostname)
+ - [beta.kubernetes.io/instance-type](#betakubernetesioinstance-type)
+ - [failure-domain.beta.kubernetes.io/region](#failure-domainbetakubernetesioregion)
+ - [failure-domain.beta.kubernetes.io/zone](#failure-domainbetakubernetesiozone)
+
+
+
+
+## beta.kubernetes.io/arch
+
+Example: `beta.kubernetes.io/arch=amd64`
+
+Used on: Node
+
+Kubelet populates this with `runtime.GOARCH` as defined by Go. This can be handy if you are mixing arm and x86 nodes,
+for example.
+
+## beta.kubernetes.io/os
+
+Example: `beta.kubernetes.io/os=linux`
+
+Used on: Node
+
+Kubelet populates this with `runtime.GOOS` as defined by Go. This can be handy if you are mixing operating systems
+in your cluster (although currently Linux is the only OS supported by Kubernetes).
+
+## kubernetes.io/hostname
+
+Example: `kubernetes.io/hostname=ip-172-20-114-199.ec2.internal`
+
+Used on: Node
+
+Kubelet populates this with the hostname. Note that the hostname can be changed from the "actual" hostname
+by passing the `--hostname-override` flag to kubelet.
+
+## beta.kubernetes.io/instance-type
+
+Example: `beta.kubernetes.io/instance-type=m3.medium`
+
+Used on: Node
+
+Kubelet populates this with the instance type as defined by the `cloudprovider`. It will not be set if
+not using a cloudprovider. This can be handy if you want to target certain workloads to certain instance
+types, but typically you want to rely on the Kubernetes scheduler to perform resource-based scheduling,
+and you should aim to schedule based on properties rather than on instance types (e.g. require a GPU, instead
+of requiring a `g2.2xlarge`)
+
+
+## failure-domain.beta.kubernetes.io/region
+
+See [failure-domain.beta.kubernetes.io/zone](#failure-domainbetakubernetesiozone)
+
+## failure-domain.beta.kubernetes.io/zone
+
+Example:
+
+`failure-domain.beta.kubernetes.io/region=us-east-1`
+
+`failure-domain.beta.kubernetes.io/zone=us-east-1c`
+
+Used on: Node, PersistentVolume
+
+On the Node: Kubelet populates this with the zone information as defined by the `cloudprovider`. It will not be set if
+not using a `cloudprovider`, but you should consider setting it on the nodes if it makes sense in your topology.
+
+On the PersistentVolume: The `PersistentVolumeLabel` admission controller will automatically add zone labels to PersistentVolumes,
+on GCE and AWS.
+
+Kubernetes will automatically spread the pods in a replication controller or service across nodes in a single-zone
+cluster (to reduce the impact of failures.) With multiple-zone clusters, this spreading behaviour is extended
+across zones (to reduce the impact of zone failures.) This is achieved via SelectorSpreadPriority.
+
+This is a best-effort placement, and so if the zones in your cluster are heterogeneous (e.g. different numbers of nodes,
+different types of nodes, or different pod resource requirements), this might prevent equal spreading of
+your pods across zones. If desired, you can use homogenous zones (same number and types of nodes) to reduce
+the probability of unequal spreading.
+
+The scheduler (via the VolumeZonePredicate predicate) will also ensure that pods that claim a given volume
+are only placed into the same zone as that volume, as volumes cannot be attached across zones.
+
+
+The actual values of zone and region don't matter, and nor is the meaning of the hierarchy rigidly defined. The expectation
+is that failures of nodes in different zones should be uncorrelated unless the entire region has failed. For example,
+zones should typically avoid sharing a single network switch. The exact mapping depends on your particular
+infrastructure - a three-rack installation will choose a very different setup to a multi-datacenter configuration.
+
+If `PersistentVolumeLabel` does not support automatic labeling of your PersistentVolumes, you should consider
+adding the labels manually (or adding support to `PersistentVolumeLabel`), if you want the scheduler to prevent
+pods from mounting volumes in a different zone. If your infrastructure doesn't have this constraint, you don't
+need to add the zone labels to the volumes at all.
+
+
+
+
+
+
+[]()
+
diff --git a/docs/api-reference/policy/v1alpha1/definitions.html b/docs/api-reference/policy/v1beta1/definitions.html
similarity index 84%
rename from docs/api-reference/policy/v1alpha1/definitions.html
rename to docs/api-reference/policy/v1beta1/definitions.html
index d5c2c1124a..844e66c00a 100755
--- a/docs/api-reference/policy/v1alpha1/definitions.html
+++ b/docs/api-reference/policy/v1beta1/definitions.html
@@ -18,10 +18,10 @@
PodDisruptionBudgetStatus represents information about the status of a PodDisruptionBudget. Status may trail the actual state of a system.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
observedGeneration
+
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.
+
false
+
integer (int64)
+
+
+
+
disruptedPods
+
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.
+
true
+
object
+
+
+
+
disruptionsAllowed
+
Number of pod disruptions that are currently allowed.
+
true
+
integer (int32)
+
+
+
+
currentHealthy
+
current number of healthy pods
+
true
+
integer (int32)
+
+
+
+
desiredHealthy
+
minimum desired number of healthy pods
+
true
+
integer (int32)
+
+
+
+
expectedPods
+
total number of pods counted by this disruption budget
+
true
+
integer (int32)
+
+
+
+
+
unversioned.LabelSelector
@@ -463,7 +518,7 @@
-
+
@@ -494,9 +549,9 @@
-
unversioned.Status
+
v1beta1.PodDisruptionBudgetList
-
Status is a return value for calls that don’t return other objects.
+
PodDisruptionBudgetList is a collection of PodDisruptionBudgets.
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://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names
+
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
false
string
@@ -660,7 +770,7 @@
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).
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.
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.
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.
@@ -710,16 +820,16 @@ Populated by the system. Read-only. Value must be treated as opaque by clients a
creationTimestamp
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.
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 will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
+
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once 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.
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
false
object
annotations
-
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://releases.k8s.io/release-1.4/docs/user-guide/annotations.md
+
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
false
object
@@ -781,7 +891,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -802,21 +912,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
@@ -950,7 +957,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -990,6 +997,47 @@ Examples:
+
+
+
v1beta1.PodDisruptionBudgetSpec
+
+
PodDisruptionBudgetSpec is a description of a PodDisruptionBudget.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
minAvailable
+
An 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%".
+
false
+
string
+
+
+
+
selector
+
Label query over pods whose evictions are managed by the disruption budget.
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
@@ -844,7 +866,7 @@
-
+
@@ -894,7 +916,7 @@
-
apispolicyv1alpha1
+
apispolicyv1beta1
@@ -904,7 +926,7 @@
partially update the specified PodDisruptionBudget
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.
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://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names
+
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
false
string
@@ -885,7 +843,7 @@
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).
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.
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.
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.
@@ -935,16 +893,16 @@ Populated by the system. Read-only. Value must be treated as opaque by clients a
creationTimestamp
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.
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 will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
+
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once 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.
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
false
object
annotations
-
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://releases.k8s.io/release-1.4/docs/user-guide/annotations.md
+
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
false
object
@@ -1006,7 +964,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -1027,21 +985,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
@@ -1174,7 +1132,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
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.
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
name
name of the ClusterRoleBinding
@@ -780,7 +802,7 @@
-
+
@@ -852,7 +874,7 @@
-
+
@@ -899,7 +921,7 @@
-
+
@@ -977,7 +999,7 @@
-
+
@@ -1048,7 +1070,7 @@
-
+
@@ -1090,6 +1112,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -1120,7 +1148,7 @@
-
+
@@ -1191,7 +1219,7 @@
-
+
@@ -1263,7 +1291,7 @@
-
+
@@ -1302,7 +1330,7 @@
-
+
@@ -1374,7 +1402,7 @@
-
+
@@ -1413,7 +1441,7 @@
-
+
@@ -1485,7 +1513,7 @@
-
+
@@ -1532,7 +1560,7 @@
-
+
@@ -1604,7 +1632,7 @@
-
+
@@ -1634,6 +1662,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
name
name of the ClusterRole
@@ -1651,7 +1695,7 @@
-
+
@@ -1723,7 +1767,7 @@
-
+
@@ -1770,7 +1814,7 @@
-
+
@@ -1848,7 +1892,7 @@
-
+
@@ -1927,7 +1971,7 @@
-
+
@@ -1969,6 +2013,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -1999,7 +2049,7 @@
-
+
@@ -2078,7 +2128,7 @@
-
+
@@ -2150,7 +2200,7 @@
-
+
@@ -2197,7 +2247,7 @@
-
+
@@ -2269,7 +2319,7 @@
-
+
@@ -2316,7 +2366,7 @@
-
+
@@ -2388,7 +2438,7 @@
-
+
@@ -2443,7 +2493,7 @@
-
+
@@ -2515,7 +2565,7 @@
-
+
@@ -2545,6 +2595,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
@@ -2570,7 +2636,7 @@
-
+
@@ -2642,7 +2708,7 @@
-
+
@@ -2697,7 +2763,7 @@
-
+
@@ -2775,7 +2841,7 @@
-
+
@@ -2854,7 +2920,7 @@
-
+
@@ -2896,6 +2962,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -2926,7 +2998,7 @@
-
+
@@ -3005,7 +3077,7 @@
-
+
@@ -3077,7 +3149,7 @@
-
+
@@ -3124,7 +3196,7 @@
-
+
@@ -3196,7 +3268,7 @@
-
+
@@ -3243,7 +3315,7 @@
-
+
@@ -3315,7 +3387,7 @@
-
+
@@ -3370,7 +3442,7 @@
-
+
@@ -3442,7 +3514,7 @@
-
+
@@ -3472,6 +3544,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
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://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names
+
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
false
string
@@ -581,7 +615,7 @@
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).
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.
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.
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.
@@ -631,16 +665,16 @@ Populated by the system. Read-only. Value must be treated as opaque by clients a
creationTimestamp
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.
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 will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
+
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once 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.
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
false
object
annotations
-
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://releases.k8s.io/release-1.4/docs/user-guide/annotations.md
+
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
false
object
@@ -702,7 +736,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
-
+
@@ -723,21 +757,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
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: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
false
string
partition
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#gcepersistentdisk
+
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: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk
ReplicationControllerCondition describes the state of a replication controller at a certain point.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
type
+
Type of replication controller condition.
+
true
+
string
+
+
+
+
status
+
Status of the condition, one of True, False, Unknown.
+
true
+
string
+
+
+
+
lastTransitionTime
+
The last time the condition transitioned from one status to another.
+
false
+
string (date-time)
+
+
+
+
reason
+
The reason for the condition’s last transition.
+
false
+
string
+
+
+
+
message
+
A human readable message indicating details about the transition.
+
false
+
string
+
+
+
+
+
v1.ScaleStatus
@@ -1201,7 +1261,7 @@ Examples:
selector
-
label query over pods that should match the replicas count. This is same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md#label-selectors
+
label query over pods that should match the replicas count. This is same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors
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://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names
+
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
false
string
@@ -1575,7 +1635,7 @@ Examples:
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).
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.
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.
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.
@@ -1625,16 +1685,16 @@ Populated by the system. Read-only. Value must be treated as opaque by clients a
creationTimestamp
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.
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 will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
+
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once 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.
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
false
object
annotations
-
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://releases.k8s.io/release-1.4/docs/user-guide/annotations.md
+
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
false
object
@@ -1824,7 +1884,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
fsType
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#iscsi
+
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: http://kubernetes.io/docs/user-guide/volumes#iscsi
false
string
@@ -1865,7 +1925,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
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: http://kubernetes.io/docs/user-guide/volumes#emptydir
false
string
@@ -1899,21 +1959,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
@@ -2051,6 +2111,61 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
+
+
+
v1beta1.Eviction
+
+
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.
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: http://releases.k8s.io/release-1.4/docs/user-guide/secrets.md#manually-specifying-an-imagepullsecret
+
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: http://kubernetes.io/docs/user-guide/secrets#manually-specifying-an-imagepullsecret
@@ -2220,7 +2335,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
v1.FlockerVolumeSource
-
Represents a Flocker volume mounted by the Flocker agent. Flocker volumes do not support ownership management or SELinux relabeling.
+
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.
@@ -2242,8 +2357,15 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
datasetName
-
Required: the volume name. This is going to be store on metadata → name on the payload for Flocker
-
true
+
Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated
+
false
+
string
+
+
+
+
datasetUUID
+
UUID of the dataset. This is unique identifier of a Flocker dataset
+
false
string
@@ -2276,7 +2398,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
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: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#hostpath
+
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: http://kubernetes.io/docs/user-guide/volumes#hostpath
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. More info: http://kubernetes.io/docs/user-guide/containers
@@ -4103,7 +4232,7 @@ The resulting set of endpoints can be viewed as:
imagePullSecrets
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod
+
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: http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
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: http://kubernetes.io/docs/user-guide/container-environment#hook-details
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: http://releases.k8s.io/release-1.4/docs/user-guide/container-environment.md#hook-details
+
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: http://kubernetes.io/docs/user-guide/container-environment#hook-details
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)
false
integer (int32)
selector
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md#label-selectors
+
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: http://kubernetes.io/docs/user-guide/labels#label-selectors
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: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#rbd
+
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: http://kubernetes.io/docs/user-guide/volumes#rbd
@@ -4820,6 +4956,85 @@ The resulting set of endpoints can be viewed as:
+
+
+
v1.PhotonPersistentDiskVolumeSource
+
+
Represents a Photon Controller persistent disk resource.
+
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
pdID
+
ID that identifies Photon Controller persistent disk
+
true
+
string
+
+
+
+
fsType
+
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.
+
false
+
string
+
+
+
+
+
+
+
+
versioned.Event
+
+
+
+
+
+
+
+
+
+
+
Name
+
Description
+
Required
+
Schema
+
Default
+
+
+
+
+
type
+
+
true
+
string
+
+
+
+
object
+
+
true
+
string
+
+
+
+
+
v1.PodTemplate
@@ -4846,28 +5061,28 @@ The resulting set of endpoints can be viewed as:
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: http://releases.k8s.io/release-1.4/docs/user-guide/containers.md#containers-and-commands
+
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: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
false
string array
args
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/containers.md#containers-and-commands
+
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: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
false
string array
@@ -5423,7 +5638,7 @@ The resulting set of endpoints can be viewed as:
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: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#hostpath
+
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: http://kubernetes.io/docs/user-guide/volumes#hostpath
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: http://kubernetes.io/docs/user-guide/persistent-volumes#binding
@@ -5838,14 +6074,14 @@ The resulting set of endpoints can be viewed as:
targetPort
-
Number 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: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#defining-a-service
+
Number 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: http://kubernetes.io/docs/user-guide/services#defining-a-service
false
string
nodePort
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#type—nodeport
+
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: http://kubernetes.io/docs/user-guide/services#type—nodeport
false
integer (int32)
@@ -5941,21 +6177,21 @@ The resulting set of endpoints can be viewed as:
@@ -6389,61 +6625,6 @@ The resulting set of endpoints can be viewed as:
-
-
-
v1alpha1.Eviction
-
-
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.
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: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore
false
string
@@ -6494,7 +6675,7 @@ The resulting set of endpoints can be viewed as:
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: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#overview
+
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: http://kubernetes.io/docs/user-guide/services#overview
false
object
clusterIP
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#virtual-ips-and-service-proxies
+
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: http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies
false
string
type
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#overview
+
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: http://kubernetes.io/docs/user-guide/services#overview
false
string
@@ -7831,7 +8012,7 @@ The resulting set of endpoints can be viewed as:
@@ -7845,7 +8026,7 @@ The resulting set of endpoints can be viewed as:
loadBalancerSourceRanges
-
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: http://releases.k8s.io/release-1.4/docs/user-guide/services-firewalls.md
+
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: http://kubernetes.io/docs/user-guide/services-firewalls
false
string array
@@ -7886,35 +8067,35 @@ The resulting set of endpoints can be viewed as:
@@ -8082,7 +8263,7 @@ The resulting set of endpoints can be viewed as:
diff --git a/docs/api-reference/v1/definitions.md b/docs/api-reference/v1/definitions.md
index 6e0097d365..a643643103 100644
--- a/docs/api-reference/v1/definitions.md
+++ b/docs/api-reference/v1/definitions.md
@@ -1,11 +1,7 @@
---
---
-{% include v1.4/v1-definitions.html %}
-
-
-
-
+{% include v1.5/v1-definitions.html %}
diff --git a/docs/api-reference/v1/operations.html b/docs/api-reference/v1/operations.html
index 7e23b5c822..f75e9a44f5 100755
--- a/docs/api-reference/v1/operations.html
+++ b/docs/api-reference/v1/operations.html
@@ -1,5 +1,7 @@
---
+title: Kubernetes API Operations
---
+
@@ -219,6 +221,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -473,6 +481,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -616,6 +630,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -759,6 +779,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -902,6 +928,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -1045,6 +1077,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -1569,6 +1607,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -2161,6 +2205,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
@@ -4398,6 +4502,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -4990,6 +5100,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
@@ -5341,6 +5467,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -5933,6 +6065,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
@@ -6663,6 +6811,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -7255,6 +7409,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
@@ -7887,7 +8057,7 @@
-
create eviction of a Eviction
+
create eviction of an Eviction
POST /api/v1/namespaces/{namespace}/pods/{name}/eviction
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
@@ -11110,6 +11302,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -11702,6 +11900,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
@@ -12811,6 +13025,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -13403,6 +13623,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
@@ -14133,6 +14369,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -14725,6 +14967,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
@@ -15076,6 +15334,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -15668,6 +15932,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
namespace
object name and auth scope, such as for teams and projects
@@ -16019,6 +16299,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -18273,6 +18559,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
name
name of the Namespace
@@ -19074,6 +19376,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -19634,6 +19942,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
+
false
+
boolean
+
+
+
PathParameter
name
name of the Node
@@ -21188,6 +21512,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -21331,6 +21661,12 @@
application/vnd.kubernetes.protobuf
+
+
application/json;stream=watch
+
+
+
application/vnd.kubernetes.protobuf;stream=watch
+
@@ -21891,6 +22227,22 @@
+
QueryParameter
+
gracePeriodSeconds
+
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.
+
false
+
integer (int32)
+
+
+
+
QueryParameter
+
orphanDependents
+
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.
@@ -32446,7 +32966,7 @@
diff --git a/docs/api-reference/v1/operations.md b/docs/api-reference/v1/operations.md
index f76001cc73..2e6a4939e4 100644
--- a/docs/api-reference/v1/operations.md
+++ b/docs/api-reference/v1/operations.md
@@ -1,11 +1,7 @@
---
---
-{% include v1.4/v1-operations.html %}
-
-
-
-
+{% include v1.5/v1-operations.html %}
diff --git a/docs/api.md b/docs/api.md
index 3479dbff94..cfc3c32125 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -3,7 +3,7 @@ assignees:
- bgrant0607
- erictune
- lavalamp
-
+title: Kubernetes API Overview
---
Primary system and API concepts are documented in the [User guide](/docs/user-guide/).
@@ -24,11 +24,13 @@ In our experience, any system that is successful needs to grow and change as new
What constitutes a compatible change and how to change the API are detailed by the [API change document](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel/api_changes.md).
-## API Swagger definitions
+## OpenAPI and Swagger definitions
-Complete API details are documented using [Swagger v1.2](http://swagger.io/). The Kubernetes apiserver (aka "master") exposes an API that can be used to retrieve the Swagger Kubernetes API spec located at `/swaggerapi`. You can also enable a UI to browse the API documentation at `/swagger-ui` by passing the `--enable-swagger-ui=true` flag to apiserver.
+Complete API details are documented using [Swagger v1.2](http://swagger.io/) and [OpenAPI](https://www.openapis.org/). The Kubernetes apiserver (aka "master") exposes an API that can be used to retrieve the Swagger v1.2 Kubernetes API spec located at `/swaggerapi`. You can also enable a UI to browse the API documentation at `/swagger-ui` by passing the `--enable-swagger-ui=true` flag to apiserver.
-We also host a version of the [latest API documentation](http://kubernetes.io/docs/api-reference/README/). This is updated with the latest release, so if you are using a different version of Kubernetes you will want to use the spec from your apiserver.
+We also host a version of the [latest v1.2 API documentation UI](http://kubernetes.io/kubernetes/third_party/swagger-ui/). This is updated with the latest release, so if you are using a different version of Kubernetes you will want to use the spec from your apiserver.
+
+Staring kubernetes 1.4, OpenAPI spec is also available at `/swagger.json`. While we are transitioning from Swagger v1.2 to OpenAPI (aka Swagger v2.0), some of the tools such as kubectl and swagger-ui are still using v1.2 spec. OpenAPI spec is in Beta as of Kubernetes 1.5.
Kubernetes implements an alternative Protobuf based serialization format for the API that is primarily intended for intra-cluster communication, documented in the [design proposal](https://github.com/kubernetes/kubernetes/blob/{{ page.githubbranch }}/docs/proposals/protobuf.md) and the IDL files for each schema are located in the Go packages that define the API objects.
diff --git a/docs/concepts/abstractions/controllers/statefulsets.md b/docs/concepts/abstractions/controllers/statefulsets.md
index 01825fc257..996a63fe8d 100644
--- a/docs/concepts/abstractions/controllers/statefulsets.md
+++ b/docs/concepts/abstractions/controllers/statefulsets.md
@@ -7,6 +7,7 @@ assignees:
- janetkuo
- kow3ns
- smarterclayton
+title: StatefulSets
---
{% capture overview %}
@@ -31,12 +32,12 @@ following.
* Ordered, graceful deployment and scaling.
* Ordered, graceful deletion and termination.
-In the above, stable is synonymous with persistent across Pod (re) schedulings.
+In the above, stable is synonymous with persistence across Pod (re)schedulings.
If an application doesn't require any stable identifiers or ordered deployment,
deletion, or scaling, you should deploy your application with a controller that
-provides a set of stateless replicas. Such controllers, such as
+provides a set of stateless replicas. Controllers such as
[Deployment](/docs/user-guide/deployments/) or
-[ReplicaSet](/docs/user-guide/replicasets/) may be better suited to your needs.
+[ReplicaSet](/docs/user-guide/replicasets/) may be better suited to your stateless needs.
### Limitations
* StatefulSet is a beta resource, not available in any Kubernetes release prior to 1.5.
@@ -51,7 +52,7 @@ The example below demonstrates the components of a StatefulSet.
* A Headless Service, named nginx, is used to control the network domain.
* The StatefulSet, named web, has a Spec that indicates that 3 replicas of the nginx container will be launched in unique Pods.
-* The volumeClaimTemplates, will provide stable storage using [PersistentVolumes](/docs/user-guide/volumes/) provisioned by a
+* The volumeClaimTemplates will provide stable storage using [PersistentVolumes](/docs/user-guide/volumes/) provisioned by a
PersistentVolume Provisioner.
```yaml
@@ -105,7 +106,7 @@ spec:
### Pod Identity
StatefulSet Pods have a unique identity that is comprised of an ordinal, a
stable network identity, and stable storage. The identity sticks to the Pod,
-regardless of which node it's (re) scheduled on.
+regardless of which node it's (re)scheduled on.
__Ordinal Index__
@@ -140,13 +141,12 @@ Note that Cluster Domain will be set to `cluster.local` unless
__Stable Storage__
-Kubernetes creates one [PersistentVolumes](/docs/user-guide/volumes/) for each
-VolumeClaimTemplate, as specified in the StatefulSet's volumeClaimTemplates field
-In the example above, each Pod will receive a single PersistentVolume with a storage
-class of `anything` and 1 Gib of provisioned storage. When a Pod is (re) scheduled onto
-a node, its `volumeMounts` mount the PersistentVolumes associated with its
+Kubernetes creates one [PersistentVolume](/docs/user-guide/volumes/) for each
+VolumeClaimTemplate. In the nginx example above, each Pod will receive a single PersistentVolume
+with a storage class of `anything` and 1 Gib of provisioned storage. When a Pod is (re)scheduled
+onto a node, its `volumeMounts` mount the PersistentVolumes associated with its
PersistentVolume Claims. Note that, the PersistentVolumes associated with the
-Pods' PersistentVolume Claims are not deleted when the Pods, or StatefulSet are deleted.
+Pods' PersistentVolume Claims are not deleted when the Pods, or StatefulSet are deleted.
This must be done manually.
### Deployment and Scaling Guarantee
@@ -156,9 +156,9 @@ This must be done manually.
* Before a scaling operation is applied to a Pod, all of its predecessors must be Running and Ready.
* Before a Pod is terminated, all of its successors must be completely shutdown.
-The StatefulSet should not specify a `pod.Spec.TerminationGracePeriodSeconds` of 0. The practice of setting a `pod.Spec.TerminationGracePeriodSeconds` of 0 seconds is unsafe and strongly discouraged. For further explanation, please refer to [force deleting StatefulSet Pods](/docs/tasks/manage-stateful-set/delete-pods/#deleting-pods).
+The StatefulSet should not specify a `pod.Spec.TerminationGracePeriodSeconds` of 0. This practice is unsafe and strongly discouraged. For further explanation, please refer to [force deleting StatefulSet Pods](/docs/tasks/manage-stateful-set/delete-pods/#deleting-pods).
-When the web example above is created, three Pods will be deployed in the order
+When the nginx example above is created, three Pods will be deployed in the order
web-0, web-1, web-2. web-1 will not be deployed before web-0 is
[Running and Ready](/docs/user-guide/pod-states), and web-2 will not be deployed until
web-1 is Running and Ready. If web-0 should fail, after web-1 is Running and Ready, but before
diff --git a/docs/concepts/index.md b/docs/concepts/index.md
index 72d1ecebb2..c26b972202 100644
--- a/docs/concepts/index.md
+++ b/docs/concepts/index.md
@@ -1,4 +1,5 @@
---
+title: Concepts
---
The Concepts section of the Kubernetes documentation is a work in progress.
diff --git a/docs/concepts/object-metadata/annotations.md b/docs/concepts/object-metadata/annotations.md
index e337493fe1..fbf73f48fd 100644
--- a/docs/concepts/object-metadata/annotations.md
+++ b/docs/concepts/object-metadata/annotations.md
@@ -1,4 +1,5 @@
---
+title: Annotations
---
{% capture overview %}
diff --git a/docs/contribute/create-pull-request.md b/docs/contribute/create-pull-request.md
index 7f42bfb125..4637c0b066 100644
--- a/docs/contribute/create-pull-request.md
+++ b/docs/contribute/create-pull-request.md
@@ -1,4 +1,5 @@
---
+title: Creating a Documentation Pull Request
---
{% capture overview %}
@@ -80,6 +81,12 @@ site where you can verify that your changes have rendered correctly.
If needed, revise your pull request by committing changes to your
new branch in your fork.
+The staging site for the upcoming Kubernetes release is here:
+[http://kubernetes-io-vnext-staging.netlify.com/](http://kubernetes-io-vnext-staging.netlify.com/).
+The staging site reflects the current state of what's been merged in the
+release branch, or in other words, what the docs will look like for the
+next upcoming release. It's automatically updated as new PRs get merged.
+
{% endcapture %}
{% capture whatsnext %}
diff --git a/docs/contribute/page-templates.md b/docs/contribute/page-templates.md
index 4b19cde39b..93fa03a6bb 100644
--- a/docs/contribute/page-templates.md
+++ b/docs/contribute/page-templates.md
@@ -1,7 +1,8 @@
---
redirect_from:
- - /docs/templatedemos/
- - /docs/templatedemos.html
+- "/docs/templatedemos/"
+- "/docs/templatedemos.html"
+title: Using Page Templates
---
[]()
diff --git a/docs/user-guide/kubectl/kubectl_annotate.md b/docs/user-guide/kubectl/kubectl_annotate.md
index a6cf10855f..07f2bc5c52 100644
--- a/docs/user-guide/kubectl/kubectl_annotate.md
+++ b/docs/user-guide/kubectl/kubectl_annotate.md
@@ -1,4 +1,5 @@
---
+title: kubectl annotate
---
## kubectl annotate
@@ -8,40 +9,43 @@ Update the annotations on a resource
### Synopsis
-
Update the annotations on one or more resources.
-An annotation is a key/value pair that can hold larger (compared to a label), and possibly not human-readable, data.
-It is intended to store non-identifying auxiliary data, especially data manipulated by tools and system extensions.
-If --overwrite is true, then existing annotations can be overwritten, otherwise attempting to overwrite an annotation will result in an error.
-If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used.
+ * An annotation is a key/value pair that can hold larger (compared to a label), and possibly not human-readable, data.
+ * It is intended to store non-identifying auxiliary data, especially data manipulated by tools and system extensions.
+ * If --overwrite is true, then existing annotations can be overwritten, otherwise attempting to overwrite an annotation will result in an error.
+ * If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used.
Valid resource types include:
- * clusters (valid only for federation apiservers)
- * componentstatuses (aka 'cs')
- * configmaps (aka 'cm')
- * daemonsets (aka 'ds')
- * deployments (aka 'deploy')
- * events (aka 'ev')
- * endpoints (aka 'ep')
- * horizontalpodautoscalers (aka 'hpa')
- * ingress (aka 'ing')
- * jobs
- * limitranges (aka 'limits')
- * nodes (aka 'no')
- * namespaces (aka 'ns')
- * petsets (alpha feature, may be unstable)
- * pods (aka 'po')
- * persistentvolumes (aka 'pv')
- * persistentvolumeclaims (aka 'pvc')
- * quota
- * resourcequotas (aka 'quota')
- * replicasets (aka 'rs')
- * replicationcontrollers (aka 'rc')
- * secrets
- * serviceaccounts (aka 'sa')
- * services (aka 'svc')
+ * clusters (valid only for federation apiservers)
+ * componentstatuses (aka 'cs')
+ * configmaps (aka 'cm')
+ * daemonsets (aka 'ds')
+ * deployments (aka 'deploy')
+ * endpoints (aka 'ep')
+ * events (aka 'ev')
+ * horizontalpodautoscalers (aka 'hpa')
+ * ingresses (aka 'ing')
+ * jobs
+ * limitranges (aka 'limits')
+ * namespaces (aka 'ns')
+ * networkpolicies
+ * nodes (aka 'no')
+ * persistentvolumeclaims (aka 'pvc')
+ * persistentvolumes (aka 'pv')
+ * pods (aka 'po')
+ * podsecuritypolicies (aka 'psp')
+ * podtemplates
+ * replicasets (aka 'rs')
+ * replicationcontrollers (aka 'rc')
+ * resourcequotas (aka 'quota')
+ * secrets
+ * serviceaccounts (aka 'sa')
+ * services (aka 'svc')
+ * statefulsets
+ * storageclasses
+ * thirdpartyresources
```
kubectl annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]
@@ -50,34 +54,34 @@ kubectl annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=V
### Examples
```
-
-# Update pod 'foo' with the annotation 'description' and the value 'my frontend'.
-# If the same annotation is set multiple times, only the last value will be applied
-kubectl annotate pods foo description='my frontend'
-
-# Update a pod identified by type and name in "pod.json"
-kubectl annotate -f pod.json description='my frontend'
-
-# Update pod 'foo' with the annotation 'description' and the value 'my frontend running nginx', overwriting any existing value.
-kubectl annotate --overwrite pods foo description='my frontend running nginx'
-
-# Update all pods in the namespace
-kubectl annotate pods --all description='my frontend running nginx'
-
-# Update pod 'foo' only if the resource is unchanged from version 1.
-kubectl annotate pods foo description='my frontend running nginx' --resource-version=1
-
-# Update pod 'foo' by removing an annotation named 'description' if it exists.
-# Does not require the --overwrite flag.
-kubectl annotate pods foo description-
+ # Update pod 'foo' with the annotation 'description' and the value 'my frontend'.
+ # If the same annotation is set multiple times, only the last value will be applied
+ kubectl annotate pods foo description='my frontend'
+
+ # Update a pod identified by type and name in "pod.json"
+ kubectl annotate -f pod.json description='my frontend'
+
+ # Update pod 'foo' with the annotation 'description' and the value 'my frontend running nginx', overwriting any existing value.
+ kubectl annotate --overwrite pods foo description='my frontend running nginx'
+
+ # Update all pods in the namespace
+ kubectl annotate pods --all description='my frontend running nginx'
+
+ # Update pod 'foo' only if the resource is unchanged from version 1.
+ kubectl annotate pods foo description='my frontend running nginx' --resource-version=1
+
+ # Update pod 'foo' by removing an annotation named 'description' if it exists.
+ # Does not require the --overwrite flag.
+ kubectl annotate pods foo description-
```
### Options
```
--all select all resources in the namespace of the specified resource types
- -f, --filename value Filename, directory, or URL to a file identifying the resource to update the annotation (default [])
- --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
+ --dry-run If true, only print the object that would be sent, without sending it.
+ -f, --filename stringSlice Filename, directory, or URL to files identifying the resource to update the annotation
+ --local If true, annotation will NOT contact api-server but run locally.
--no-headers When using the default or custom-column output format, don't print headers.
-o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
--output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
@@ -95,37 +99,34 @@ kubectl annotate pods foo description-
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_api-versions.md b/docs/user-guide/kubectl/kubectl_api-versions.md
index b6a14e3ba5..cc79a82059 100644
--- a/docs/user-guide/kubectl/kubectl_api-versions.md
+++ b/docs/user-guide/kubectl/kubectl_api-versions.md
@@ -1,4 +1,5 @@
---
+title: kubectl api-versions
---
## kubectl api-versions
@@ -17,37 +18,34 @@ kubectl api-versions
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_apply.md b/docs/user-guide/kubectl/kubectl_apply.md
index ad21e9cbdc..c729263d6c 100644
--- a/docs/user-guide/kubectl/kubectl_apply.md
+++ b/docs/user-guide/kubectl/kubectl_apply.md
@@ -1,4 +1,5 @@
---
+title: kubectl apply
---
## kubectl apply
@@ -8,13 +9,12 @@ Apply a configuration to a resource by filename or stdin
### Synopsis
-
-Apply a configuration to a resource by filename or stdin.
-This resource will be created if it doesn't exist yet.
-To use 'apply', always create the resource initially with either 'apply' or 'create --save-config'.
+Apply a configuration to a resource by filename or stdin. This resource will be created if it doesn't exist yet. To use 'apply', always create the resource initially with either 'apply' or 'create --save-config'.
JSON and YAML formats are accepted.
+Alpha Disclaimer: the --prune functionality is not yet complete. Do not use unless you are aware of what the current state is. See https://issues.k8s.io/34274.
+
```
kubectl apply -f FILENAME
```
@@ -22,61 +22,78 @@ kubectl apply -f FILENAME
### Examples
```
-
-# Apply the configuration in pod.json to a pod.
-kubectl apply -f ./pod.json
-
-# Apply the JSON passed into stdin to a pod.
-cat pod.json | kubectl apply -f -
+ # Apply the configuration in pod.json to a pod.
+ kubectl apply -f ./pod.json
+
+ # Apply the JSON passed into stdin to a pod.
+ cat pod.json | kubectl apply -f -
+
+ # Note: --prune is still in Alpha
+ # Apply the configuration in manifest.yaml that matches label app=nginx and delete all the other resources that are not in the file and match label app=nginx.
+ kubectl apply --prune -f manifest.yaml -l app=nginx
+
+ # Apply the configuration in manifest.yaml and delete all the other configmaps that are not in the file.
+ kubectl apply --prune -f manifest.yaml --all --prune-whitelist=core/v1/ConfigMap
```
### Options
```
- -f, --filename value Filename, directory, or URL to file that contains the configuration to apply (default [])
- --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
- -o, --output string Output mode. Use "-o name" for shorter output (resource/name).
- --overwrite Automatically resolve conflicts between the modified and live configuration by using values from the modified configuration (default true)
- --record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists.
- -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
- --schema-cache-dir string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema")
- --validate If true, use a schema to validate the input before sending it (default true)
+ --all [-all] to select all the specified resources.
+ --cascade Only relevant during a prune or a force apply. If true, cascade the deletion of the resources managed by pruned or deleted resources (e.g. Pods created by a ReplicationController). (default true)
+ --dry-run If true, only print the object that would be sent, without sending it.
+ -f, --filename stringSlice Filename, directory, or URL to files that contains the configuration to apply
+ --force Delete and re-create the specified resource, when PATCH encounters conflict and has retried for 5 times.
+ --grace-period int Only relevant during a prune or a force apply. Period of time in seconds given to pruned or deleted resources to terminate gracefully. Ignored if negative. (default -1)
+ --no-headers When using the default or custom-column output format, don't print headers.
+ -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
+ --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
+ --overwrite Automatically resolve conflicts between the modified and live configuration by using values from the modified configuration (default true)
+ --prune Automatically delete resource objects that do not appear in the configs and are created by either apply or create --save-config. Should be used with either -l or --all.
+ --prune-whitelist stringArray Overwrite the default whitelist with for --prune
+ --record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists.
+ -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
+ --schema-cache-dir string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema")
+ -l, --selector string Selector (label query) to filter on
+ -a, --show-all When printing, show all resources (default hide terminated pods.)
+ --show-labels When printing, show all labels as the last column (default hide labels column)
+ --sort-by string If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
+ --template string 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 duration Only relevant during a force apply. The length of time to wait before giving up on a delete of the old resource, zero means determine a timeout from the size of the object. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h).
+ --validate If true, use a schema to validate the input before sending it (default true)
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_attach.md b/docs/user-guide/kubectl/kubectl_attach.md
index 0e90db298b..f19e557fc9 100644
--- a/docs/user-guide/kubectl/kubectl_attach.md
+++ b/docs/user-guide/kubectl/kubectl_attach.md
@@ -1,4 +1,5 @@
---
+title: kubectl attach
---
## kubectl attach
@@ -17,16 +18,15 @@ kubectl attach POD -c CONTAINER
### Examples
```
-
-# Get output from running pod 123456-7890, using the first container by default
-kubectl attach 123456-7890
-
-# Get output from ruby-container from pod 123456-7890
-kubectl attach 123456-7890 -c ruby-container
-
-# Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-7890
-# and sends stdout/stderr from 'bash' back to the client
-kubectl attach 123456-7890 -c ruby-container -i -t
+ # Get output from running pod 123456-7890, using the first container by default
+ kubectl attach 123456-7890
+
+ # Get output from ruby-container from pod 123456-7890
+ kubectl attach 123456-7890 -c ruby-container
+
+ # Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-7890
+ # and sends stdout/stderr from 'bash' back to the client
+ kubectl attach 123456-7890 -c ruby-container -i -t
```
### Options
@@ -40,37 +40,34 @@ kubectl attach 123456-7890 -c ruby-container -i -t
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_autoscale.md b/docs/user-guide/kubectl/kubectl_autoscale.md
index b99b9bcc19..b863fc6b66 100644
--- a/docs/user-guide/kubectl/kubectl_autoscale.md
+++ b/docs/user-guide/kubectl/kubectl_autoscale.md
@@ -1,4 +1,5 @@
---
+title: kubectl autoscale
---
## kubectl autoscale
@@ -8,11 +9,9 @@ Auto-scale a Deployment, ReplicaSet, or ReplicationController
### Synopsis
+Creates an autoscaler that automatically chooses and sets the number of pods that run in a Kubernetes cluster.
-Creates an autoscaler that automatically chooses and sets the number of pods that run in a kubernetes cluster.
-
-Looks up a Deployment, ReplicaSet, or ReplicationController by name and creates an autoscaler that uses the given resource as a reference.
-An autoscaler can automatically increase or decrease number of pods deployed within the system as needed.
+Looks up a Deployment, ReplicaSet, or ReplicationController by name and creates an autoscaler that uses the given resource as a reference. An autoscaler can automatically increase or decrease number of pods deployed within the system as needed.
```
kubectl autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU] [flags]
@@ -21,12 +20,11 @@ kubectl autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MA
### Examples
```
-
-# Auto scale a deployment "foo", with the number of pods between 2 and 10, target CPU utilization specified so a default autoscaling policy will be used:
-kubectl autoscale deployment foo --min=2 --max=10
-
-# Auto scale a replication controller "foo", with the number of pods between 1 and 5, target CPU utilization at 80%:
-kubectl autoscale rc foo --max=5 --cpu-percent=80
+ # Auto scale a deployment "foo", with the number of pods between 2 and 10, target CPU utilization specified so a default autoscaling policy will be used:
+ kubectl autoscale deployment foo --min=2 --max=10
+
+ # Auto scale a replication controller "foo", with the number of pods between 1 and 5, target CPU utilization at 80%:
+ kubectl autoscale rc foo --max=5 --cpu-percent=80
```
### Options
@@ -34,9 +32,8 @@ kubectl autoscale rc foo --max=5 --cpu-percent=80
```
--cpu-percent int The target average CPU utilization (represented as a percent of requested CPU) over all the pods. If it's not specified or negative, a default autoscaling policy will be used. (default -1)
--dry-run If true, only print the object that would be sent, without sending it.
- -f, --filename value Filename, directory, or URL to a file identifying the resource to autoscale. (default [])
+ -f, --filename stringSlice Filename, directory, or URL to files identifying the resource to autoscale.
--generator string The name of the API generator to use. Currently there is only 1 generator. (default "horizontalpodautoscaler/v1")
- --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
--max int The upper limit for the number of pods that can be set by the autoscaler. Required. (default -1)
--min int The lower limit for the number of pods that can be set by the autoscaler. If it's not specified or negative, the server will apply a default value. (default -1)
--name string The name for the newly created object. If not specified, the name of the input resource will be used.
@@ -55,37 +52,34 @@ kubectl autoscale rc foo --max=5 --cpu-percent=80
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_certificate.md b/docs/user-guide/kubectl/kubectl_certificate.md
new file mode 100644
index 0000000000..8cc7080b4b
--- /dev/null
+++ b/docs/user-guide/kubectl/kubectl_certificate.md
@@ -0,0 +1,50 @@
+---
+---
+## kubectl certificate
+
+Modify certificate resources.
+
+### Synopsis
+
+
+Modify certificate resources.
+
+```
+kubectl certificate SUBCOMMAND
+```
+
+### Options inherited from parent commands
+
+```
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
+```
+
+
+
+###### Auto generated by spf13/cobra on 13-Dec-2016
+
+
+[]()
+
diff --git a/docs/user-guide/kubectl/kubectl_certificate_approve.md b/docs/user-guide/kubectl/kubectl_certificate_approve.md
new file mode 100644
index 0000000000..706d77928c
--- /dev/null
+++ b/docs/user-guide/kubectl/kubectl_certificate_approve.md
@@ -0,0 +1,62 @@
+---
+---
+## kubectl certificate approve
+
+Approve a certificate signing request
+
+### Synopsis
+
+
+Approve a certificate signing request.
+
+kubectl certificate approve allows a cluster admin to approve a certificate signing request (CSR). This action tells a certificate signing controller to issue a certificate to the requestor with the attributes requested in the CSR.
+
+SECURITY NOTICE: Depending on the requested attributes, the issued certificate can potentially grant a requester access to cluster resources or to authenticate as a requested identity. Before approving a CSR, ensure you understand what the signed certificate can do.
+
+```
+kubectl certificate approve (-f FILENAME | NAME)
+```
+
+### Options
+
+```
+ -f, --filename stringSlice Filename, directory, or URL to files identifying the resource to update
+ -o, --output string Output mode. Use "-o name" for shorter output (resource/name).
+ -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
+```
+
+### Options inherited from parent commands
+
+```
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
+```
+
+
+
+###### Auto generated by spf13/cobra on 13-Dec-2016
+
+
+[]()
+
diff --git a/docs/user-guide/kubectl/kubectl_certificate_deny.md b/docs/user-guide/kubectl/kubectl_certificate_deny.md
new file mode 100644
index 0000000000..bd691f8795
--- /dev/null
+++ b/docs/user-guide/kubectl/kubectl_certificate_deny.md
@@ -0,0 +1,60 @@
+---
+---
+## kubectl certificate deny
+
+Deny a certificate signing request
+
+### Synopsis
+
+
+Deny a certificate signing request.
+
+kubectl certificate deny allows a cluster admin to deny a certificate signing request (CSR). This action tells a certificate signing controller to not to issue a certificate to the requestor.
+
+```
+kubectl certificate deny (-f FILENAME | NAME)
+```
+
+### Options
+
+```
+ -f, --filename stringSlice Filename, directory, or URL to files identifying the resource to update
+ -o, --output string Output mode. Use "-o name" for shorter output (resource/name).
+ -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
+```
+
+### Options inherited from parent commands
+
+```
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
+```
+
+
+
+###### Auto generated by spf13/cobra on 13-Dec-2016
+
+
+[]()
+
diff --git a/docs/user-guide/kubectl/kubectl_cluster-info.md b/docs/user-guide/kubectl/kubectl_cluster-info.md
index 4d1105b086..46823b69f8 100644
--- a/docs/user-guide/kubectl/kubectl_cluster-info.md
+++ b/docs/user-guide/kubectl/kubectl_cluster-info.md
@@ -1,4 +1,5 @@
---
+title: kubectl cluster-info
---
## kubectl cluster-info
@@ -8,8 +9,7 @@ Display cluster info
### Synopsis
-Display addresses of the master and services with label kubernetes.io/cluster-service=true
-To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.
+Display addresses of the master and services with label kubernetes.io/cluster-service=true To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.
```
kubectl cluster-info
@@ -18,43 +18,39 @@ kubectl cluster-info
### Options
```
- --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_cluster-info_dump.md b/docs/user-guide/kubectl/kubectl_cluster-info_dump.md
index d672149697..5c744e0e27 100644
--- a/docs/user-guide/kubectl/kubectl_cluster-info_dump.md
+++ b/docs/user-guide/kubectl/kubectl_cluster-info_dump.md
@@ -1,6 +1,5 @@
---
---
-
## kubectl cluster-info dump
Dump lots of relevant info for debugging and diagnosis
@@ -8,15 +7,9 @@ Dump lots of relevant info for debugging and diagnosis
### Synopsis
+Dumps cluster info out suitable for debugging and diagnosing cluster problems. By default, dumps everything to stdout. You can optionally specify a directory with --output-directory. If you specify a directory, Kubernetes will build a set of files in that directory. By default only dumps things in the 'kube-system' namespace, but you can switch to a different namespace with the --namespaces flag, or specify --all-namespaces to dump all namespaces.
-Dumps cluster info out suitable for debugging and diagnosing cluster problems. By default, dumps everything to
-stdout. You can optionally specify a directory with --output-directory. If you specify a directory, kubernetes will
-build a set of files in that directory. By default only dumps things in the 'kube-system' namespace, but you can
-switch to a different namespace with the --namespaces flag, or specify --all-namespaces to dump all namespaces.
-
-The command also dumps the logs of all of the pods in the cluster, these logs are dumped into different directories
-based on namespace and pod name.
-
+The command also dumps the logs of all of the pods in the cluster, these logs are dumped into different directories based on namespace and pod name.
```
kubectl cluster-info dump
@@ -25,61 +18,58 @@ kubectl cluster-info dump
### Examples
```
-# Dump current cluster state to stdout
-kubectl cluster-info dump
-
-# Dump current cluster state to /path/to/cluster-state
-kubectl cluster-info dump --output-directory=/path/to/cluster-state
-
-# Dump all namespaces to stdout
-kubectl cluster-info dump --all-namespaces
-
-# Dump a set of namespaces to /path/to/cluster-state
-kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state
+ # Dump current cluster state to stdout
+ kubectl cluster-info dump
+
+ # Dump current cluster state to /path/to/cluster-state
+ kubectl cluster-info dump --output-directory=/path/to/cluster-state
+
+ # Dump all namespaces to stdout
+ kubectl cluster-info dump --all-namespaces
+
+ # Dump a set of namespaces to /path/to/cluster-state
+ kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state
```
### Options
```
--all-namespaces If true, dump all namespaces. If true, --namespaces is ignored.
- --namespaces value A comma separated list of namespaces to dump. (default [])
+ --namespaces stringSlice A comma separated list of namespaces to dump.
--output-directory string Where to output the files. If empty or '-' uses stdout, otherwise creates a directory hierarchy in that directory
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_completion.md b/docs/user-guide/kubectl/kubectl_completion.md
index bead2c68fd..125b7791cd 100644
--- a/docs/user-guide/kubectl/kubectl_completion.md
+++ b/docs/user-guide/kubectl/kubectl_completion.md
@@ -1,6 +1,5 @@
---
---
-
## kubectl completion
Output shell completion code for the given shell (bash or zsh)
@@ -10,69 +9,57 @@ Output shell completion code for the given shell (bash or zsh)
Output shell completion code for the given shell (bash or zsh).
-This command prints shell code which must be evaluation to provide interactive
-completion of kubectl commands.
+This command prints shell code which must be evaluation to provide interactive completion of kubectl commands.
+ $ source <(kubectl completion bash)
+
+will load the kubectl completion code for bash. Note that this depends on the bash-completion framework. It must be sourced before sourcing the kubectl completion, e.g. on the Mac:
+
+ $ brew install bash-completion
+ $ source $(brew --prefix)/etc/bash_completion
+ $ source <(kubectl completion bash)
+
+If you use zsh [1], the following will load kubectl zsh completion:
+
+ $ source <(kubectl completion zsh)
+
+ [1] zsh completions are only supported in versions of zsh >= 5.2
```
kubectl completion SHELL
```
-### Examples
-
-```
-
-$ source <(kubectl completion bash)
-
-will load the kubectl completion code for bash. Note that this depends on the
-bash-completion framework. It must be sourced before sourcing the kubectl
-completion, e.g. on the Mac:
-
-$ brew install bash-completion
-$ source $(brew --prefix)/etc/bash_completion
-$ source <(kubectl completion bash)
-
-If you use zsh*, the following will load kubectl zsh completion:
-
-$ source <(kubectl completion zsh)
-
-* zsh completions are only supported in versions of zsh >= 5.2
-```
-
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_config.md b/docs/user-guide/kubectl/kubectl_config.md
index a9c41de181..c19e98d381 100644
--- a/docs/user-guide/kubectl/kubectl_config.md
+++ b/docs/user-guide/kubectl/kubectl_config.md
@@ -1,4 +1,5 @@
---
+title: kubectl config
---
## kubectl config
@@ -11,10 +12,10 @@ Modify kubeconfig files
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. If $KUBECONFIG environment variable is set, then it is used a list of paths (normal path delimitting rules for your system). These paths are merged. When a value is modified, it is modified in the file that defines the stanza. When a value is created, it is created in the first file that exists. If no files in the chain exist, then it creates the last file in the list.
-3. Otherwise, ${HOME}/.kube/config is used and no merging takes place.
+ 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.
+ 3. Otherwise, ${HOME}/.kube/config is used and no merging takes place.
```
kubectl config SUBCOMMAND
@@ -29,36 +30,33 @@ kubectl config SUBCOMMAND
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_config_current-context.md b/docs/user-guide/kubectl/kubectl_config_current-context.md
index 64fd7adbdb..0257ce6b58 100644
--- a/docs/user-guide/kubectl/kubectl_config_current-context.md
+++ b/docs/user-guide/kubectl/kubectl_config_current-context.md
@@ -1,4 +1,5 @@
---
+title: kubectl config current-context
---
## kubectl config current-context
@@ -8,7 +9,6 @@ Displays the current-context
### Synopsis
-
Displays the current-context
```
@@ -18,45 +18,41 @@ kubectl config current-context
### Examples
```
-
-# Display the current-context
-kubectl config current-context
+ # Display the current-context
+ kubectl config current-context
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string use a particular kubeconfig file
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string use a particular kubeconfig file
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_config_delete-cluster.md b/docs/user-guide/kubectl/kubectl_config_delete-cluster.md
index b42ad2c6a7..db5ef7013e 100644
--- a/docs/user-guide/kubectl/kubectl_config_delete-cluster.md
+++ b/docs/user-guide/kubectl/kubectl_config_delete-cluster.md
@@ -1,6 +1,5 @@
---
---
-
## kubectl config delete-cluster
Delete the specified cluster from the kubeconfig
@@ -17,37 +16,34 @@ kubectl config delete-cluster NAME
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string use a particular kubeconfig file
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string use a particular kubeconfig file
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_config_delete-context.md b/docs/user-guide/kubectl/kubectl_config_delete-context.md
index 4d3bc05331..aaf1cf4125 100644
--- a/docs/user-guide/kubectl/kubectl_config_delete-context.md
+++ b/docs/user-guide/kubectl/kubectl_config_delete-context.md
@@ -1,6 +1,5 @@
---
---
-
## kubectl config delete-context
Delete the specified context from the kubeconfig
@@ -17,37 +16,34 @@ kubectl config delete-context NAME
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string use a particular kubeconfig file
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string use a particular kubeconfig file
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_config_get-clusters.md b/docs/user-guide/kubectl/kubectl_config_get-clusters.md
index 0a78eb7684..4ab7420856 100644
--- a/docs/user-guide/kubectl/kubectl_config_get-clusters.md
+++ b/docs/user-guide/kubectl/kubectl_config_get-clusters.md
@@ -1,6 +1,5 @@
---
---
-
## kubectl config get-clusters
Display clusters defined in the kubeconfig
@@ -17,37 +16,34 @@ kubectl config get-clusters
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string use a particular kubeconfig file
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string use a particular kubeconfig file
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_config_get-contexts.md b/docs/user-guide/kubectl/kubectl_config_get-contexts.md
index 4a4486f927..6a247bc734 100644
--- a/docs/user-guide/kubectl/kubectl_config_get-contexts.md
+++ b/docs/user-guide/kubectl/kubectl_config_get-contexts.md
@@ -1,6 +1,5 @@
---
---
-
## kubectl config get-contexts
Describe one or many contexts
@@ -17,11 +16,11 @@ kubectl config get-contexts [(-o|--output=)name)]
### Examples
```
-# List all the contexts in your kubeconfig file
-kubectl config get-contexts
-
-# Describe one context in your kubeconfig file.
-kubectl config get-contexts my-context
+ # List all the contexts in your kubeconfig file
+ kubectl config get-contexts
+
+ # Describe one context in your kubeconfig file.
+ kubectl config get-contexts my-context
```
### Options
@@ -34,37 +33,34 @@ kubectl config get-contexts my-context
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string use a particular kubeconfig file
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string use a particular kubeconfig file
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_config_set-cluster.md b/docs/user-guide/kubectl/kubectl_config_set-cluster.md
index 3da8dbc094..c835a0d255 100644
--- a/docs/user-guide/kubectl/kubectl_config_set-cluster.md
+++ b/docs/user-guide/kubectl/kubectl_config_set-cluster.md
@@ -1,4 +1,5 @@
---
+title: kubectl config set-cluster
---
## kubectl config set-cluster
@@ -8,8 +9,8 @@ Sets a cluster entry in kubeconfig
### Synopsis
-
Sets a cluster entry in kubeconfig.
+
Specifying a name that already exists will merge new fields on top of existing values for those fields.
```
@@ -19,58 +20,54 @@ kubectl config set-cluster NAME [--server=server] [--certificate-authority=path/
### Examples
```
-
-# Set only the server field on the e2e cluster entry without touching other values.
-kubectl config set-cluster e2e --server=https://1.2.3.4
-
-# Embed certificate authority data for the e2e cluster entry
-kubectl config set-cluster e2e --certificate-authority=~/.kube/e2e/kubernetes.ca.crt
-
-# Disable cert checking for the dev cluster entry
-kubectl config set-cluster e2e --insecure-skip-tls-verify=true
+ # Set only the server field on the e2e cluster entry without touching other values.
+ kubectl config set-cluster e2e --server=https://1.2.3.4
+
+ # Embed certificate authority data for the e2e cluster entry
+ kubectl config set-cluster e2e --certificate-authority=~/.kube/e2e/kubernetes.ca.crt
+
+ # Disable cert checking for the dev cluster entry
+ kubectl config set-cluster e2e --insecure-skip-tls-verify=true
```
### Options
```
- --api-version value api-version for the cluster entry in kubeconfig
- --certificate-authority value path to certificate-authority file for the cluster entry in kubeconfig
- --embed-certs value[=true] embed-certs for the cluster entry in kubeconfig
- --insecure-skip-tls-verify value[=true] insecure-skip-tls-verify for the cluster entry in kubeconfig
- --server value server for the cluster entry in kubeconfig
+ --api-version string api-version for the cluster entry in kubeconfig
+ --certificate-authority string path to certificate-authority file for the cluster entry in kubeconfig
+ --embed-certs tristate[=true] embed-certs for the cluster entry in kubeconfig
+ --insecure-skip-tls-verify tristate[=true] insecure-skip-tls-verify for the cluster entry in kubeconfig
+ --server string server for the cluster entry in kubeconfig
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --kubeconfig string use a particular kubeconfig file
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --kubeconfig string use a particular kubeconfig file
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_config_set-context.md b/docs/user-guide/kubectl/kubectl_config_set-context.md
index 86db115730..9fcdce00c8 100644
--- a/docs/user-guide/kubectl/kubectl_config_set-context.md
+++ b/docs/user-guide/kubectl/kubectl_config_set-context.md
@@ -1,4 +1,5 @@
---
+title: kubectl config set-context
---
## kubectl config set-context
@@ -8,8 +9,8 @@ Sets a context entry in kubeconfig
### Synopsis
-
Sets a context entry in kubeconfig
+
Specifying a name that already exists will merge new fields on top of existing values for those fields.
```
@@ -19,50 +20,46 @@ kubectl config set-context NAME [--cluster=cluster_nickname] [--user=user_nickna
### Examples
```
-
-# Set the user field on the gce context entry without touching other values
-kubectl config set-context gce --user=cluster-admin
+ # Set the user field on the gce context entry without touching other values
+ kubectl config set-context gce --user=cluster-admin
```
### Options
```
- --cluster value cluster for the context entry in kubeconfig
- --namespace value namespace for the context entry in kubeconfig
- --user value user for the context entry in kubeconfig
+ --cluster string cluster for the context entry in kubeconfig
+ --namespace string namespace for the context entry in kubeconfig
+ --user string user for the context entry in kubeconfig
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string use a particular kubeconfig file
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string use a particular kubeconfig file
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_config_set-credentials.md b/docs/user-guide/kubectl/kubectl_config_set-credentials.md
index 49743220f2..31a3907a71 100644
--- a/docs/user-guide/kubectl/kubectl_config_set-credentials.md
+++ b/docs/user-guide/kubectl/kubectl_config_set-credentials.md
@@ -1,4 +1,5 @@
---
+title: kubectl config set-credentials
---
## kubectl config set-credentials
@@ -8,12 +9,12 @@ Sets a user entry in kubeconfig
### Synopsis
-
Sets a user entry in kubeconfig
+
Specifying a name that already exists will merge new fields on top of existing values.
Client-certificate flags:
- --client-certificate=certfile --client-key=keyfile
+ --client-certificate=certfile --client-key=keyfile
Bearer token flags:
--token=bearer_token
@@ -21,8 +22,7 @@ Specifying a name that already exists will merge new fields on top of existing v
Basic auth flags:
--username=basic_user --password=basic_password
- Bearer token and basic auth are mutually exclusive.
-
+Bearer token and basic auth are mutually exclusive.
```
kubectl config set-credentials NAME [--client-certificate=path/to/certfile] [--client-key=path/to/keyfile] [--token=bearer_token] [--username=basic_user] [--password=basic_password] [--auth-provider=provider_name] [--auth-provider-arg=key=value]
@@ -31,69 +31,65 @@ kubectl config set-credentials NAME [--client-certificate=path/to/certfile] [--c
### Examples
```
-
-# Set only the "client-key" field on the "cluster-admin"
-# entry, without touching other values:
-kubectl config set-credentials cluster-admin --client-key=~/.kube/admin.key
-
-# Set basic auth for the "cluster-admin" entry
-kubectl config set-credentials cluster-admin --username=admin --password=uXFGweU9l35qcif
-
-# Embed client certificate data in the "cluster-admin" entry
-kubectl config set-credentials cluster-admin --client-certificate=~/.kube/admin.crt --embed-certs=true
-
-# Enable the Google Compute Platform auth provider for the "cluster-admin" entry
-kubectl config set-credentials cluster-admin --auth-provider=gcp
-
-# Enable the OpenID Connect auth provider for the "cluster-admin" entry with additional args
-kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-id=foo --auth-provider-arg=client-secret=bar
-
-# Remove the "client-secret" config value for the OpenID Connect auth provider for the "cluster-admin" entry
-kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-secret-
+ # Set only the "client-key" field on the "cluster-admin"
+ # entry, without touching other values:
+ kubectl config set-credentials cluster-admin --client-key=~/.kube/admin.key
+
+ # Set basic auth for the "cluster-admin" entry
+ kubectl config set-credentials cluster-admin --username=admin --password=uXFGweU9l35qcif
+
+ # Embed client certificate data in the "cluster-admin" entry
+ kubectl config set-credentials cluster-admin --client-certificate=~/.kube/admin.crt --embed-certs=true
+
+ # Enable the Google Compute Platform auth provider for the "cluster-admin" entry
+ kubectl config set-credentials cluster-admin --auth-provider=gcp
+
+ # Enable the OpenID Connect auth provider for the "cluster-admin" entry with additional args
+ kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-id=foo --auth-provider-arg=client-secret=bar
+
+ # Remove the "client-secret" config value for the OpenID Connect auth provider for the "cluster-admin" entry
+ kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-secret-
```
### Options
```
- --auth-provider value auth provider for the user entry in kubeconfig
- --auth-provider-arg value 'key=value' arugments for the auth provider (default [])
- --client-certificate value path to client-certificate file for the user entry in kubeconfig
- --client-key value path to client-key file for the user entry in kubeconfig
- --embed-certs value[=true] embed client cert/key for the user entry in kubeconfig
- --password value password for the user entry in kubeconfig
- --token value token for the user entry in kubeconfig
- --username value username for the user entry in kubeconfig
+ --auth-provider string auth provider for the user entry in kubeconfig
+ --auth-provider-arg stringSlice 'key=value' arugments for the auth provider
+ --client-certificate string path to client-certificate file for the user entry in kubeconfig
+ --client-key string path to client-key file for the user entry in kubeconfig
+ --embed-certs tristate[=true] embed client cert/key for the user entry in kubeconfig
+ --password string password for the user entry in kubeconfig
+ --token string token for the user entry in kubeconfig
+ --username string username for the user entry in kubeconfig
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string use a particular kubeconfig file
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --user string The name of the kubeconfig user to use
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string use a particular kubeconfig file
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --user string The name of the kubeconfig user to use
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_config_set.md b/docs/user-guide/kubectl/kubectl_config_set.md
index 52d8b6397c..dc82b45c7f 100644
--- a/docs/user-guide/kubectl/kubectl_config_set.md
+++ b/docs/user-guide/kubectl/kubectl_config_set.md
@@ -1,4 +1,5 @@
---
+title: kubectl config set
---
## kubectl config set
@@ -8,10 +9,11 @@ Sets an individual value in a kubeconfig file
### Synopsis
-
Sets an individual value in a kubeconfig file
-PROPERTY_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots.
-PROPERTY_VALUE is the new value you wish to set. Binary fields such as 'certificate-authority-data' expect a base64 encoded string unless the --set-raw-bytes flag is used.
+
+PROPERTY _NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots.
+
+PROPERTY _VALUE is the new value you wish to set. Binary fields such as 'certificate-authority-data' expect a base64 encoded string unless the --set-raw-bytes flag is used.
```
kubectl config set PROPERTY_NAME PROPERTY_VALUE
@@ -20,43 +22,40 @@ kubectl config set PROPERTY_NAME PROPERTY_VALUE
### Options
```
- --set-raw-bytes value[=true] When writing a []byte PROPERTY_VALUE, write the given string directly without base64 decoding.
+ --set-raw-bytes tristate[=true] When writing a []byte PROPERTY_VALUE, write the given string directly without base64 decoding.
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string use a particular kubeconfig file
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string use a particular kubeconfig file
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_config_unset.md b/docs/user-guide/kubectl/kubectl_config_unset.md
index 3ee8de73fc..e435fc1f46 100644
--- a/docs/user-guide/kubectl/kubectl_config_unset.md
+++ b/docs/user-guide/kubectl/kubectl_config_unset.md
@@ -1,4 +1,5 @@
---
+title: kubectl config unset
---
## kubectl config unset
@@ -8,9 +9,9 @@ Unsets an individual value in a kubeconfig file
### Synopsis
-
Unsets an individual value in a kubeconfig file
-PROPERTY_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots.
+
+PROPERTY _NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots.
```
kubectl config unset PROPERTY_NAME
@@ -19,37 +20,34 @@ kubectl config unset PROPERTY_NAME
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string use a particular kubeconfig file
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string use a particular kubeconfig file
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_config_use-context.md b/docs/user-guide/kubectl/kubectl_config_use-context.md
index 66cc439eac..d87130d583 100644
--- a/docs/user-guide/kubectl/kubectl_config_use-context.md
+++ b/docs/user-guide/kubectl/kubectl_config_use-context.md
@@ -1,4 +1,5 @@
---
+title: kubectl config use-context
---
## kubectl config use-context
@@ -17,37 +18,34 @@ kubectl config use-context CONTEXT_NAME
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string use a particular kubeconfig file
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string use a particular kubeconfig file
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_config_view.md b/docs/user-guide/kubectl/kubectl_config_view.md
index aed1c205c8..ef7f6649c1 100644
--- a/docs/user-guide/kubectl/kubectl_config_view.md
+++ b/docs/user-guide/kubectl/kubectl_config_view.md
@@ -1,4 +1,5 @@
---
+title: kubectl config view
---
## kubectl config view
@@ -8,7 +9,6 @@ Display merged kubeconfig settings or a specified kubeconfig file
### Synopsis
-
Display merged kubeconfig settings or a specified kubeconfig file.
You can use --output jsonpath={...} to extract specific values using a jsonpath expression.
@@ -20,19 +20,18 @@ kubectl config view
### Examples
```
-
-# Show Merged kubeconfig settings.
-kubectl config view
-
-# Get the password for the e2e user
-kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}'
+ # Show Merged kubeconfig settings.
+ kubectl config view
+
+ # Get the password for the e2e user
+ kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}'
```
### Options
```
--flatten flatten the resulting kubeconfig file into self-contained output (useful for creating portable kubeconfig files)
- --merge value[=true] merge the full hierarchy of kubeconfig files (default true)
+ --merge tristate[=true] merge the full hierarchy of kubeconfig files (default true)
--minify remove all information not used by current-context from the output
--no-headers When using the default or custom-column output format, don't print headers.
-o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
@@ -47,37 +46,34 @@ kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}'
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string use a particular kubeconfig file
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string use a particular kubeconfig file
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_convert.md b/docs/user-guide/kubectl/kubectl_convert.md
index e46e6fdd15..b37b32ff28 100644
--- a/docs/user-guide/kubectl/kubectl_convert.md
+++ b/docs/user-guide/kubectl/kubectl_convert.md
@@ -1,4 +1,5 @@
---
+title: kubectl convert
---
## kubectl convert
@@ -8,17 +9,11 @@ Convert config files between different API versions
### Synopsis
+Convert config files between different API versions. Both YAML and JSON formats are accepted.
-Convert config files between different API versions. Both YAML
-and JSON formats are accepted.
-
-The command takes filename, directory, or URL as input, and convert it into format
-of version specified by --output-version flag. If target version is not specified or
-not supported, convert to latest version.
-
-The default output will be printed to stdout in YAML format. One can use -o option
-to change to output destination.
+The command takes filename, directory, or URL as input, and convert it into format of version specified by --output-version flag. If target version is not specified or not supported, convert to latest version.
+The default output will be printed to stdout in YAML format. One can use -o option to change to output destination.
```
kubectl convert -f FILENAME
@@ -27,24 +22,21 @@ kubectl convert -f FILENAME
### Examples
```
-
-# Convert 'pod.yaml' to latest version and print to stdout.
-kubectl convert -f pod.yaml
-
-# Convert the live state of the resource specified by 'pod.yaml' to the latest version
-# and print to stdout in json format.
-kubectl convert -f pod.yaml --local -o json
-
-# Convert all files under current directory to latest version and create them all.
-kubectl convert -f . | kubectl create -f -
-
+ # Convert 'pod.yaml' to latest version and print to stdout.
+ kubectl convert -f pod.yaml
+
+ # Convert the live state of the resource specified by 'pod.yaml' to the latest version
+ # and print to stdout in json format.
+ kubectl convert -f pod.yaml --local -o json
+
+ # Convert all files under current directory to latest version and create them all.
+ kubectl convert -f . | kubectl create -f -
```
### Options
```
- -f, --filename value Filename, directory, or URL to file to need to get converted. (default [])
- --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
+ -f, --filename stringSlice Filename, directory, or URL to files to need to get converted.
--local If true, convert will NOT try to contact api-server but run locally. (default true)
--no-headers When using the default or custom-column output format, don't print headers.
-o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
@@ -61,37 +53,34 @@ kubectl convert -f . | kubectl create -f -
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_cordon.md b/docs/user-guide/kubectl/kubectl_cordon.md
index 5d757265d8..3ca7782fd4 100644
--- a/docs/user-guide/kubectl/kubectl_cordon.md
+++ b/docs/user-guide/kubectl/kubectl_cordon.md
@@ -1,4 +1,5 @@
---
+title: kubectl cordon
---
## kubectl cordon
@@ -8,10 +9,8 @@ Mark node as unschedulable
### Synopsis
-
Mark node as unschedulable.
-
```
kubectl cordon NODE
```
@@ -19,46 +18,41 @@ kubectl cordon NODE
### Examples
```
-
-# Mark node "foo" as unschedulable.
-kubectl cordon foo
-
+ # Mark node "foo" as unschedulable.
+ kubectl cordon foo
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_cp.md b/docs/user-guide/kubectl/kubectl_cp.md
new file mode 100644
index 0000000000..39d0880f12
--- /dev/null
+++ b/docs/user-guide/kubectl/kubectl_cp.md
@@ -0,0 +1,76 @@
+---
+---
+## kubectl cp
+
+Copy files and directories to and from containers.
+
+### Synopsis
+
+
+Copy files and directories to and from containers.
+
+```
+kubectl cp
+```
+
+### Examples
+
+```
+ # !!!Important Note!!!
+ # Requires that the 'tar' binary is present in your container
+ # image. If 'tar' is not present, 'kubectl cp' will fail.
+
+ # Copy /tmp/foo_dir local directory to /tmp/bar_dir in a remote pod in the default namespace
+ kubectl cp /tmp/foo_dir :/tmp/bar_dir
+
+ # Copy /tmp/foo local file to /tmp/bar in a remote pod in a specific container
+ kubectl cp /tmp/foo :/tmp/bar -c
+
+ # Copy /tmp/foo local file to /tmp/bar in a remote pod in namespace
+ kubectl cp /tmp/foo /:/tmp/bar
+
+ # Copy /tmp/foo from a remote pod to /tmp/bar locally
+ kubectl cp /:/tmp/foo /tmp/bar
+```
+
+### Options
+
+```
+ -c, --container string Container name. If omitted, the first container in the pod will be chosen
+```
+
+### Options inherited from parent commands
+
+```
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
+```
+
+
+
+###### Auto generated by spf13/cobra on 13-Dec-2016
+
+
+[]()
+
diff --git a/docs/user-guide/kubectl/kubectl_create.md b/docs/user-guide/kubectl/kubectl_create.md
index 95da4d6775..abadda07f6 100644
--- a/docs/user-guide/kubectl/kubectl_create.md
+++ b/docs/user-guide/kubectl/kubectl_create.md
@@ -1,4 +1,5 @@
---
+title: kubectl create
---
## kubectl create
@@ -8,7 +9,6 @@ Create a resource by filename or stdin
### Synopsis
-
Create a resource by filename or stdin.
JSON and YAML formats are accepted.
@@ -20,61 +20,68 @@ kubectl create -f FILENAME
### Examples
```
-
-# Create a pod using the data in pod.json.
-kubectl create -f ./pod.json
-
-# Create a pod based on the JSON passed into stdin.
-cat pod.json | kubectl create -f -
+ # Create a pod using the data in pod.json.
+ kubectl create -f ./pod.json
+
+ # Create a pod based on the JSON passed into stdin.
+ cat pod.json | kubectl create -f -
+
+ # Edit the data in docker-registry.yaml in JSON using the v1 API format then create the resource using the edited data.
+ kubectl create -f docker-registry.yaml --edit --output-version=v1 -o json
```
### Options
```
- -f, --filename value Filename, directory, or URL to file to use to create the resource (default [])
- --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
- -o, --output string Output mode. Use "-o name" for shorter output (resource/name).
+ --dry-run If true, only print the object that would be sent, without sending it.
+ --edit Edit the API resource before creating
+ -f, --filename stringSlice Filename, directory, or URL to files to use to create the resource
+ --no-headers When using the default or custom-column output format, don't print headers.
+ -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
+ --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
--record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists.
-R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
--save-config If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
--schema-cache-dir string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema")
+ -a, --show-all When printing, show all resources (default hide terminated pods.)
+ --show-labels When printing, show all labels as the last column (default hide labels column)
+ --sort-by string If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
+ --template string 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 If true, use a schema to validate the input before sending it (default true)
+ --windows-line-endings Only relevant if --edit=true. Use Windows line-endings (default Unix line-endings)
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_create_configmap.md b/docs/user-guide/kubectl/kubectl_create_configmap.md
index 2c733fc055..d5d147b465 100644
--- a/docs/user-guide/kubectl/kubectl_create_configmap.md
+++ b/docs/user-guide/kubectl/kubectl_create_configmap.md
@@ -1,4 +1,5 @@
---
+title: kubectl create configmap
---
## kubectl create configmap
@@ -8,18 +9,13 @@ Create a configmap from a local file, directory or literal value
### Synopsis
-
Create a configmap based on a file, directory, or specified literal value.
A single configmap may package one or more key/value pairs.
-When creating a configmap based on a file, the key will default to the basename of the file, and the value will
-default to the file content. If the basename is an invalid key, you may specify an alternate key.
-
-When creating a configmap based on a directory, each file whose basename is a valid key in the directory will be
-packaged into the configmap. Any directory entries except regular files are ignored (e.g. subdirectories,
-symlinks, devices, pipes, etc).
+When creating a configmap based on a file, the key will default to the basename of the file, and the value will default to the file content. If the basename is an invalid key, you may specify an alternate key.
+When creating a configmap based on a directory, each file whose basename is a valid key in the directory will be packaged into the configmap. Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).
```
kubectl create configmap NAME [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run]
@@ -28,70 +24,66 @@ kubectl create configmap NAME [--from-file=[key=]source] [--from-literal=key1=va
### Examples
```
-
-# Create a new configmap named my-config with keys for each file in folder bar
-kubectl create configmap my-config --from-file=path/to/bar
-
-# Create a new configmap named my-config with specified keys instead of names on disk
-kubectl create configmap my-config --from-file=key1=/path/to/bar/file1.txt --from-file=key2=/path/to/bar/file2.txt
-
-# Create a new configmap named my-config with key1=config1 and key2=config2
-kubectl create configmap my-config --from-literal=key1=config1 --from-literal=key2=config2
+ # Create a new configmap named my-config with keys for each file in folder bar
+ kubectl create configmap my-config --from-file=path/to/bar
+
+ # Create a new configmap named my-config with specified keys instead of names on disk
+ kubectl create configmap my-config --from-file=key1=/path/to/bar/file1.txt --from-file=key2=/path/to/bar/file2.txt
+
+ # Create a new configmap named my-config with key1=config1 and key2=config2
+ kubectl create configmap my-config --from-literal=key1=config1 --from-literal=key2=config2
```
### Options
```
- --dry-run If true, only print the object that would be sent, without sending it.
- --from-file value Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid configmap key. (default [])
- --from-literal value Specify a key and literal value to insert in configmap (i.e. mykey=somevalue) (default [])
- --generator string The name of the API generator to use. (default "configmap/v1")
- --no-headers When using the default or custom-column output format, don't print headers.
- -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
- --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
- --save-config If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
- --schema-cache-dir string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema")
- -a, --show-all When printing, show all resources (default hide terminated pods.)
- --show-labels When printing, show all labels as the last column (default hide labels column)
- --sort-by string If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
- --template string 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 If true, use a schema to validate the input before sending it (default true)
+ --dry-run If true, only print the object that would be sent, without sending it.
+ --from-file stringSlice Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid configmap key.
+ --from-literal stringArray Specify a key and literal value to insert in configmap (i.e. mykey=somevalue)
+ --generator string The name of the API generator to use. (default "configmap/v1")
+ --no-headers When using the default or custom-column output format, don't print headers.
+ -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
+ --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
+ --save-config If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
+ --schema-cache-dir string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema")
+ -a, --show-all When printing, show all resources (default hide terminated pods.)
+ --show-labels When printing, show all labels as the last column (default hide labels column)
+ --sort-by string If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
+ --template string 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 If true, use a schema to validate the input before sending it (default true)
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_create_deployment.md b/docs/user-guide/kubectl/kubectl_create_deployment.md
index 35c2707cd1..685d2dff2b 100644
--- a/docs/user-guide/kubectl/kubectl_create_deployment.md
+++ b/docs/user-guide/kubectl/kubectl_create_deployment.md
@@ -1,6 +1,5 @@
---
---
-
## kubectl create deployment
Create a deployment with the specified name.
@@ -8,7 +7,6 @@ Create a deployment with the specified name.
### Synopsis
-
Create a deployment with the specified name.
```
@@ -18,9 +16,8 @@ kubectl create deployment NAME --image=image [--dry-run]
### Examples
```
-
-# Create a new deployment named my-dep that runs the busybox image.
-kubectl create deployment my-dep --image=busybox
+ # Create a new deployment named my-dep that runs the busybox image.
+ kubectl create deployment my-dep --image=busybox
```
### Options
@@ -28,7 +25,7 @@ kubectl create deployment my-dep --image=busybox
```
--dry-run If true, only print the object that would be sent, without sending it.
--generator string The name of the API generator to use. (default "deployment-basic/v1beta1")
- --image value Image name to run. (default [])
+ --image stringSlice Image name to run.
--no-headers When using the default or custom-column output format, don't print headers.
-o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
--output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
@@ -44,37 +41,34 @@ kubectl create deployment my-dep --image=busybox
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_create_namespace.md b/docs/user-guide/kubectl/kubectl_create_namespace.md
index fd46a53e5e..4d90219754 100644
--- a/docs/user-guide/kubectl/kubectl_create_namespace.md
+++ b/docs/user-guide/kubectl/kubectl_create_namespace.md
@@ -1,4 +1,5 @@
---
+title: kubectl create namespace
---
## kubectl create namespace
@@ -8,7 +9,6 @@ Create a namespace with the specified name
### Synopsis
-
Create a namespace with the specified name.
```
@@ -18,9 +18,8 @@ kubectl create namespace NAME [--dry-run]
### Examples
```
-
-# Create a new namespace named my-namespace
-kubectl create namespace my-namespace
+ # Create a new namespace named my-namespace
+ kubectl create namespace my-namespace
```
### Options
@@ -43,37 +42,34 @@ kubectl create namespace my-namespace
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_create_quota.md b/docs/user-guide/kubectl/kubectl_create_quota.md
index ec2e31a45b..e65e0725e4 100644
--- a/docs/user-guide/kubectl/kubectl_create_quota.md
+++ b/docs/user-guide/kubectl/kubectl_create_quota.md
@@ -1,6 +1,5 @@
---
---
-
## kubectl create quota
Create a quota with the specified name.
@@ -8,7 +7,6 @@ Create a quota with the specified name.
### Synopsis
-
Create a resourcequota with the specified name, hard limits and optional scopes
```
@@ -18,10 +16,10 @@ kubectl create quota NAME [--hard=key1=value1,key2=value2] [--scopes=Scope1,Scop
### Examples
```
- // Create a new resourcequota named my-quota
+ # Create a new resourcequota named my-quota
$ kubectl create quota my-quota --hard=cpu=1,memory=1G,pods=2,services=3,replicationcontrollers=2,resourcequotas=1,secrets=5,persistentvolumeclaims=10
-
- // Create a new resourcequota named best-effort
+
+ # Create a new resourcequota named best-effort
$ kubectl create quota best-effort --hard=pods=100 --scopes=BestEffort
```
@@ -47,37 +45,34 @@ kubectl create quota NAME [--hard=key1=value1,key2=value2] [--scopes=Scope1,Scop
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_create_secret.md b/docs/user-guide/kubectl/kubectl_create_secret.md
index f9f80c8740..965bb16832 100644
--- a/docs/user-guide/kubectl/kubectl_create_secret.md
+++ b/docs/user-guide/kubectl/kubectl_create_secret.md
@@ -1,4 +1,5 @@
---
+title: kubectl create secret
---
## kubectl create secret
@@ -17,37 +18,34 @@ kubectl create secret
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md b/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md
index 18c2eba2dd..fa37d3fd48 100644
--- a/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md
+++ b/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md
@@ -1,4 +1,5 @@
---
+title: kubectl create secret docker-registry
---
## kubectl create secret docker-registry
@@ -8,19 +9,17 @@ Create a secret for use with a Docker registry
### Synopsis
-
Create a new secret for use with Docker registries.
Dockercfg secrets are used to authenticate against Docker registries.
When using the Docker command line to push images, you can authenticate to a given registry by running
- 'docker login DOCKER_REGISTRY_SERVER --username=DOCKER_USER --password=DOCKER_PASSWORD --email=DOCKER_EMAIL'.
-That produces a ~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to
-authenticate to the registry.
-When creating applications, you may have a Docker registry that requires authentication. In order for the
-nodes to pull images on your behalf, they have to have the credentials. You can provide this information
-by creating a dockercfg secret and attaching it to your service account.
+ $ docker login DOCKER_REGISTRY_SERVER --username=DOCKER_USER --password=DOCKER_PASSWORD --email=DOCKER_EMAIL'.
+
+That produces a ~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to authenticate to the registry.
+
+When creating applications, you may have a Docker registry that requires authentication. In order for the nodes to pull images on your behalf, they have to have the credentials. You can provide this information by creating a dockercfg secret and attaching it to your service account.
```
kubectl create secret docker-registry NAME --docker-username=user --docker-password=password --docker-email=email [--docker-server=string] [--from-literal=key1=value1] [--dry-run]
@@ -29,9 +28,8 @@ kubectl create secret docker-registry NAME --docker-username=user --docker-passw
### Examples
```
-
-# If you don't already have a .dockercfg file, you can create a dockercfg secret directly by using:
-kubectl create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL
+ # If you don't already have a .dockercfg file, you can create a dockercfg secret directly by using:
+ kubectl create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL
```
### Options
@@ -43,7 +41,6 @@ kubectl create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_
--docker-username string Username for Docker registry authentication
--dry-run If true, only print the object that would be sent, without sending it.
--generator string The name of the API generator to use. (default "secret-for-docker-registry/v1")
- --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
--no-headers When using the default or custom-column output format, don't print headers.
-o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
--output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
@@ -59,37 +56,34 @@ kubectl create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_create_secret_generic.md b/docs/user-guide/kubectl/kubectl_create_secret_generic.md
index c81404e954..4bddfad2b1 100644
--- a/docs/user-guide/kubectl/kubectl_create_secret_generic.md
+++ b/docs/user-guide/kubectl/kubectl_create_secret_generic.md
@@ -1,4 +1,5 @@
---
+title: kubectl create secret generic
---
## kubectl create secret generic
@@ -8,18 +9,13 @@ Create a secret from a local file, directory or literal value
### Synopsis
-
Create a secret based on a file, directory, or specified literal value.
A single secret may package one or more key/value pairs.
-When creating a secret based on a file, the key will default to the basename of the file, and the value will
-default to the file content. If the basename is an invalid key, you may specify an alternate key.
-
-When creating a secret based on a directory, each file whose basename is a valid key in the directory will be
-packaged into the secret. Any directory entries except regular files are ignored (e.g. subdirectories,
-symlinks, devices, pipes, etc).
+When creating a secret based on a file, the key will default to the basename of the file, and the value will default to the file content. If the basename is an invalid key, you may specify an alternate key.
+When creating a secret based on a directory, each file whose basename is a valid key in the directory will be packaged into the secret. Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).
```
kubectl create secret generic NAME [--type=string] [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run]
@@ -28,71 +24,67 @@ kubectl create secret generic NAME [--type=string] [--from-file=[key=]source] [-
### Examples
```
-
-# Create a new secret named my-secret with keys for each file in folder bar
-kubectl create secret generic my-secret --from-file=path/to/bar
-
-# Create a new secret named my-secret with specified keys instead of names on disk
-kubectl create secret generic my-secret --from-file=ssh-privatekey=~/.ssh/id_rsa --from-file=ssh-publickey=~/.ssh/id_rsa.pub
-
-# Create a new secret named my-secret with key1=supersecret and key2=topsecret
-kubectl create secret generic my-secret --from-literal=key1=supersecret --from-literal=key2=topsecret
+ # Create a new secret named my-secret with keys for each file in folder bar
+ kubectl create secret generic my-secret --from-file=path/to/bar
+
+ # Create a new secret named my-secret with specified keys instead of names on disk
+ kubectl create secret generic my-secret --from-file=ssh-privatekey=~/.ssh/id_rsa --from-file=ssh-publickey=~/.ssh/id_rsa.pub
+
+ # Create a new secret named my-secret with key1=supersecret and key2=topsecret
+ kubectl create secret generic my-secret --from-literal=key1=supersecret --from-literal=key2=topsecret
```
### Options
```
- --dry-run If true, only print the object that would be sent, without sending it.
- --from-file value Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid secret key. (default [])
- --from-literal value Specify a key and literal value to insert in secret (i.e. mykey=somevalue) (default [])
- --generator string The name of the API generator to use. (default "secret/v1")
- --no-headers When using the default or custom-column output format, don't print headers.
- -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
- --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
- --save-config If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
- --schema-cache-dir string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema")
- -a, --show-all When printing, show all resources (default hide terminated pods.)
- --show-labels When printing, show all labels as the last column (default hide labels column)
- --sort-by string If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
- --template string 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 string The type of secret to create
- --validate If true, use a schema to validate the input before sending it (default true)
+ --dry-run If true, only print the object that would be sent, without sending it.
+ --from-file stringSlice Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid secret key.
+ --from-literal stringSlice Specify a key and literal value to insert in secret (i.e. mykey=somevalue)
+ --generator string The name of the API generator to use. (default "secret/v1")
+ --no-headers When using the default or custom-column output format, don't print headers.
+ -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
+ --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
+ --save-config If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
+ --schema-cache-dir string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema")
+ -a, --show-all When printing, show all resources (default hide terminated pods.)
+ --show-labels When printing, show all labels as the last column (default hide labels column)
+ --sort-by string If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
+ --template string 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 string The type of secret to create
+ --validate If true, use a schema to validate the input before sending it (default true)
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_create_secret_tls.md b/docs/user-guide/kubectl/kubectl_create_secret_tls.md
index 0e3badb512..06348dfedc 100644
--- a/docs/user-guide/kubectl/kubectl_create_secret_tls.md
+++ b/docs/user-guide/kubectl/kubectl_create_secret_tls.md
@@ -1,6 +1,5 @@
---
---
-
## kubectl create secret tls
Create a TLS secret
@@ -8,7 +7,6 @@ Create a TLS secret
### Synopsis
-
Create a TLS secret from the given public/private key pair.
The public/private key pair must exist before hand. The public key certificate must be .PEM encoded and match the given private key.
@@ -20,9 +18,8 @@ kubectl create secret tls NAME --cert=path/to/cert/file --key=path/to/key/file [
### Examples
```
-
-# Create a new TLS secret named tls-secret with the given key pair:
-kubectl create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.key
+ # Create a new TLS secret named tls-secret with the given key pair:
+ kubectl create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.key
```
### Options
@@ -47,37 +44,34 @@ kubectl create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.k
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_create_service.md b/docs/user-guide/kubectl/kubectl_create_service.md
index 5183e75de7..d172e9fad9 100644
--- a/docs/user-guide/kubectl/kubectl_create_service.md
+++ b/docs/user-guide/kubectl/kubectl_create_service.md
@@ -1,6 +1,5 @@
---
---
-
## kubectl create service
Create a service using specified subcommand.
@@ -17,37 +16,34 @@ kubectl create service
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_create_service_clusterip.md b/docs/user-guide/kubectl/kubectl_create_service_clusterip.md
index d1a86da92b..367f3c8956 100644
--- a/docs/user-guide/kubectl/kubectl_create_service_clusterip.md
+++ b/docs/user-guide/kubectl/kubectl_create_service_clusterip.md
@@ -1,6 +1,5 @@
---
---
-
## kubectl create service clusterip
Create a clusterIP service.
@@ -8,7 +7,6 @@ Create a clusterIP service.
### Synopsis
-
Create a clusterIP service with the specified name.
```
@@ -18,12 +16,11 @@ kubectl create service clusterip NAME [--tcp=:] [--dry-run]
### Examples
```
-
-# Create a new clusterIP service named my-cs
-kubectl create service clusterip my-cs --tcp=5678:8080
-
-# Create a new clusterIP service named my-cs (in headless mode)
-kubectl create service clusterip my-cs --clusterip="None"
+ # Create a new clusterIP service named my-cs
+ kubectl create service clusterip my-cs --tcp=5678:8080
+
+ # Create a new clusterIP service named my-cs (in headless mode)
+ kubectl create service clusterip my-cs --clusterip="None"
```
### Options
@@ -40,7 +37,7 @@ kubectl create service clusterip my-cs --clusterip="None"
-a, --show-all When printing, show all resources (default hide terminated pods.)
--show-labels When printing, show all labels as the last column (default hide labels column)
--sort-by string If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
- --tcp value Port pairs can be specified as ':'. (default [])
+ --tcp stringSlice Port pairs can be specified as ':'.
--template string 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 If true, use a schema to validate the input before sending it (default true)
```
@@ -48,37 +45,34 @@ kubectl create service clusterip my-cs --clusterip="None"
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_create_service_loadbalancer.md b/docs/user-guide/kubectl/kubectl_create_service_loadbalancer.md
index 83d60f0584..c8d708c81c 100644
--- a/docs/user-guide/kubectl/kubectl_create_service_loadbalancer.md
+++ b/docs/user-guide/kubectl/kubectl_create_service_loadbalancer.md
@@ -1,6 +1,5 @@
---
---
-
## kubectl create service loadbalancer
Create a LoadBalancer service.
@@ -8,7 +7,6 @@ Create a LoadBalancer service.
### Synopsis
-
Create a LoadBalancer service with the specified name.
```
@@ -18,9 +16,8 @@ kubectl create service loadbalancer NAME [--tcp=port:targetPort] [--dry-run]
### Examples
```
-
-# Create a new nodeport service named my-lbs
-kubectl create service loadbalancer my-lbs --tcp=5678:8080
+ # Create a new LoadBalancer service named my-lbs
+ kubectl create service loadbalancer my-lbs --tcp=5678:8080
```
### Options
@@ -36,7 +33,7 @@ kubectl create service loadbalancer my-lbs --tcp=5678:8080
-a, --show-all When printing, show all resources (default hide terminated pods.)
--show-labels When printing, show all labels as the last column (default hide labels column)
--sort-by string If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
- --tcp value Port pairs can be specified as ':'. (default [])
+ --tcp stringSlice Port pairs can be specified as ':'.
--template string 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 If true, use a schema to validate the input before sending it (default true)
```
@@ -44,37 +41,34 @@ kubectl create service loadbalancer my-lbs --tcp=5678:8080
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_create_service_nodeport.md b/docs/user-guide/kubectl/kubectl_create_service_nodeport.md
index 38822d879a..3be99298d1 100644
--- a/docs/user-guide/kubectl/kubectl_create_service_nodeport.md
+++ b/docs/user-guide/kubectl/kubectl_create_service_nodeport.md
@@ -1,6 +1,5 @@
---
---
-
## kubectl create service nodeport
Create a NodePort service.
@@ -8,7 +7,6 @@ Create a NodePort service.
### Synopsis
-
Create a nodeport service with the specified name.
```
@@ -18,9 +16,8 @@ kubectl create service nodeport NAME [--tcp=port:targetPort] [--dry-run]
### Examples
```
-
-# Create a new nodeport service named my-ns
-kubectl create service nodeport my-ns --tcp=5678:8080
+ # Create a new nodeport service named my-ns
+ kubectl create service nodeport my-ns --tcp=5678:8080
```
### Options
@@ -29,6 +26,7 @@ kubectl create service nodeport my-ns --tcp=5678:8080
--dry-run If true, only print the object that would be sent, without sending it.
--generator string The name of the API generator to use. (default "service-nodeport/v1")
--no-headers When using the default or custom-column output format, don't print headers.
+ --node-port int Port used to expose the service on each node in a cluster.
-o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
--output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
--save-config If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
@@ -36,7 +34,7 @@ kubectl create service nodeport my-ns --tcp=5678:8080
-a, --show-all When printing, show all resources (default hide terminated pods.)
--show-labels When printing, show all labels as the last column (default hide labels column)
--sort-by string If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
- --tcp value Port pairs can be specified as ':'. (default [])
+ --tcp stringSlice Port pairs can be specified as ':'.
--template string 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 If true, use a schema to validate the input before sending it (default true)
```
@@ -44,37 +42,34 @@ kubectl create service nodeport my-ns --tcp=5678:8080
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_create_serviceaccount.md b/docs/user-guide/kubectl/kubectl_create_serviceaccount.md
index 20490abfc2..3deab7f566 100644
--- a/docs/user-guide/kubectl/kubectl_create_serviceaccount.md
+++ b/docs/user-guide/kubectl/kubectl_create_serviceaccount.md
@@ -1,4 +1,5 @@
---
+title: kubectl create serviceaccount
---
## kubectl create serviceaccount
@@ -8,7 +9,6 @@ Create a service account with the specified name
### Synopsis
-
Create a service account with the specified name.
```
@@ -18,9 +18,8 @@ kubectl create serviceaccount NAME [--dry-run]
### Examples
```
-
-# Create a new service account named my-service-account
-$ kubectl create serviceaccount my-service-account
+ # Create a new service account named my-service-account
+ $ kubectl create serviceaccount my-service-account
```
### Options
@@ -28,7 +27,6 @@ $ kubectl create serviceaccount my-service-account
```
--dry-run If true, only print the object that would be sent, without sending it.
--generator string The name of the API generator to use. (default "serviceaccount/v1")
- --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
--no-headers When using the default or custom-column output format, don't print headers.
-o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
--output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
@@ -44,37 +42,34 @@ $ kubectl create serviceaccount my-service-account
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_delete.md b/docs/user-guide/kubectl/kubectl_delete.md
index 585ccee091..ddca437942 100644
--- a/docs/user-guide/kubectl/kubectl_delete.md
+++ b/docs/user-guide/kubectl/kubectl_delete.md
@@ -1,4 +1,5 @@
---
+title: kubectl delete
---
## kubectl delete
@@ -8,16 +9,15 @@ Delete resources by filenames, stdin, resources and names, or by resources and l
### Synopsis
-
Delete resources by filenames, stdin, resources and names, or by resources and label selector.
-JSON and YAML formats are accepted.
+JSON and YAML formats are accepted. Only one type of the arguments may be specified: filenames, resources and names, or resources and label selector.
-Only one type of the arguments may be specified: filenames, resources and names, or resources and label selector
+Some resources, such as pods, support graceful deletion. These resources define a default period before they are forcibly terminated (the grace period) but you may override that value with the --grace-period flag, or pass --now to set a grace-period of 1. Because these resources often represent entities in the cluster, deletion may not be acknowledged immediately. If the node hosting a pod is down or cannot reach the API server, termination may take significantly longer than the grace period. To force delete a resource, you must pass a grace period of 0 and specify the --force flag.
-Note that the delete command does NOT do resource version checks, so if someone
-submits an update to a resource right when you submit a delete, their update
-will be lost along with the rest of the resource.
+IMPORTANT: Force deleting pods does not wait for confirmation that the pod's processes have been terminated, which can leave those processes running until the node detects the deletion and completes graceful deletion. If your processes use shared storage or talk to a remote API and depend on the name of the pod to identify themselves, force deleting those pods may result in multiple processes running on different machines using the same identification which may lead to data corruption or inconsistency. Only force delete pods when you are sure the pod is terminated, or if your application can tolerate multiple copies of the same pod running at once. Also, if you force delete pods the scheduler may place new pods on those nodes before the node has released those resources and causing those pods to be evicted immediately.
+
+Note that the delete command does NOT do resource version checks, so if someone submits an update to a resource right when you submit a delete, their update will be lost along with the rest of the resource.
```
kubectl delete ([-f FILENAME] | TYPE [(NAME | -l label | --all)])
@@ -26,79 +26,78 @@ kubectl delete ([-f FILENAME] | TYPE [(NAME | -l label | --all)])
### Examples
```
-
-# Delete a pod using the type and name specified in pod.json.
-kubectl delete -f ./pod.json
-
-# Delete a pod based on the type and name in the JSON passed into stdin.
-cat pod.json | kubectl delete -f -
-
-# Delete pods and services with same names "baz" and "foo"
-kubectl delete pod,service baz foo
-
-# Delete pods and services with label name=myLabel.
-kubectl delete pods,services -l name=myLabel
-
-# Delete a pod immediately (no graceful shutdown)
-kubectl delete pod foo --now
-
-# Delete a pod with UID 1234-56-7890-234234-456456.
-kubectl delete pod 1234-56-7890-234234-456456
-
-# Delete all pods
-kubectl delete pods --all
+ # Delete a pod using the type and name specified in pod.json.
+ kubectl delete -f ./pod.json
+
+ # Delete a pod based on the type and name in the JSON passed into stdin.
+ cat pod.json | kubectl delete -f -
+
+ # Delete pods and services with same names "baz" and "foo"
+ kubectl delete pod,service baz foo
+
+ # Delete pods and services with label name=myLabel.
+ kubectl delete pods,services -l name=myLabel
+
+ # Delete a pod with minimal delay
+ kubectl delete pod foo --now
+
+ # Force delete a pod on a dead node
+ kubectl delete pod foo --grace-period=0 --force
+
+ # Delete a pod with UID 1234-56-7890-234234-456456.
+ kubectl delete pod 1234-56-7890-234234-456456
+
+ # Delete all pods
+ kubectl delete pods --all
```
### Options
```
- --all [-all] to select all the specified resources.
- --cascade If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController). Default true. (default true)
- -f, --filename value Filename, directory, or URL to a file containing the resource to delete. (default [])
- --grace-period int Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. (default -1)
- --ignore-not-found Treat "resource not found" as a successful delete. Defaults to "true" when --all is specified.
- --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
- --now If true, resources are force terminated without graceful deletion (same as --grace-period=0).
- -o, --output string Output mode. Use "-o name" for shorter output (resource/name).
- -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
- -l, --selector string Selector (label query) to filter on.
- --timeout duration The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object (default 0s)
+ --all [-all] to select all the specified resources.
+ --cascade If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController). Default true. (default true)
+ -f, --filename stringSlice Filename, directory, or URL to files containing the resource to delete.
+ --force Immediate deletion of some resources may result in inconsistency or data loss and requires confirmation.
+ --grace-period int Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. (default -1)
+ --ignore-not-found Treat "resource not found" as a successful delete. Defaults to "true" when --all is specified.
+ --now If true, resources are signaled for immediate shutdown (same as --grace-period=1).
+ -o, --output string Output mode. Use "-o name" for shorter output (resource/name).
+ -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
+ -l, --selector string Selector (label query) to filter on.
+ --timeout duration The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_describe.md b/docs/user-guide/kubectl/kubectl_describe.md
index e34a2e4d9f..a5fd703d73 100644
--- a/docs/user-guide/kubectl/kubectl_describe.md
+++ b/docs/user-guide/kubectl/kubectl_describe.md
@@ -1,4 +1,5 @@
---
+title: kubectl describe
---
## kubectl describe
@@ -8,42 +9,42 @@ Show details of a specific resource or group of resources
### Synopsis
+Show details of a specific resource or group of resources. This command joins many API calls together to form a detailed description of a given resource or group of resources.
-Show details of a specific resource or group of resources.
-This command joins many API calls together to form a detailed description of a
-given resource or group of resources.
+ $ kubectl describe TYPE NAME_PREFIX
-$ kubectl describe TYPE NAME_PREFIX
-
-will first check for an exact match on TYPE and NAME_PREFIX. If no such resource
-exists, it will output details for every resource that has a name prefixed with NAME_PREFIX.
+will first check for an exact match on TYPE and NAME PREFIX. If no such resource exists, it will output details for every resource that has a name prefixed with NAME PREFIX.
Valid resource types include:
- * clusters (valid only for federation apiservers)
- * componentstatuses (aka 'cs')
- * configmaps (aka 'cm')
- * daemonsets (aka 'ds')
- * deployments (aka 'deploy')
- * events (aka 'ev')
- * endpoints (aka 'ep')
- * horizontalpodautoscalers (aka 'hpa')
- * ingress (aka 'ing')
- * jobs
- * limitranges (aka 'limits')
- * nodes (aka 'no')
- * namespaces (aka 'ns')
- * petsets (alpha feature, may be unstable)
- * pods (aka 'po')
- * persistentvolumes (aka 'pv')
- * persistentvolumeclaims (aka 'pvc')
- * quota
- * resourcequotas (aka 'quota')
- * replicasets (aka 'rs')
- * replicationcontrollers (aka 'rc')
- * secrets
- * serviceaccounts (aka 'sa')
- * services (aka 'svc')
+ * clusters (valid only for federation apiservers)
+ * componentstatuses (aka 'cs')
+ * configmaps (aka 'cm')
+ * daemonsets (aka 'ds')
+ * deployments (aka 'deploy')
+ * endpoints (aka 'ep')
+ * events (aka 'ev')
+ * horizontalpodautoscalers (aka 'hpa')
+ * ingresses (aka 'ing')
+ * jobs
+ * limitranges (aka 'limits')
+ * namespaces (aka 'ns')
+ * networkpolicies
+ * nodes (aka 'no')
+ * persistentvolumeclaims (aka 'pvc')
+ * persistentvolumes (aka 'pv')
+ * pods (aka 'po')
+ * podsecuritypolicies (aka 'psp')
+ * podtemplates
+ * replicasets (aka 'rs')
+ * replicationcontrollers (aka 'rc')
+ * resourcequotas (aka 'quota')
+ * secrets
+ * serviceaccounts (aka 'sa')
+ * services (aka 'svc')
+ * statefulsets
+ * storageclasses
+ * thirdpartyresources
```
kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME)
@@ -52,72 +53,67 @@ kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME)
### Examples
```
-
-# Describe a node
-kubectl describe nodes kubernetes-minion-emt8.c.myproject.internal
-
-# Describe a pod
-kubectl describe pods/nginx
-
-# Describe a pod identified by type and name in "pod.json"
-kubectl describe -f pod.json
-
-# Describe all pods
-kubectl describe pods
-
-# Describe pods by label name=myLabel
-kubectl describe po -l name=myLabel
-
-# Describe all pods managed by the 'frontend' replication controller (rc-created pods
-# get the name of the rc as a prefix in the pod the name).
-kubectl describe pods frontend
+ # Describe a node
+ kubectl describe nodes kubernetes-node-emt8.c.myproject.internal
+
+ # Describe a pod
+ kubectl describe pods/nginx
+
+ # Describe a pod identified by type and name in "pod.json"
+ kubectl describe -f pod.json
+
+ # Describe all pods
+ kubectl describe pods
+
+ # Describe pods by label name=myLabel
+ kubectl describe po -l name=myLabel
+
+ # Describe all pods managed by the 'frontend' replication controller (rc-created pods
+ # get the name of the rc as a prefix in the pod the name).
+ kubectl describe pods frontend
```
### Options
```
- --all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.
- -f, --filename value Filename, directory, or URL to a file containing the resource to describe (default [])
- --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
- -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
- -l, --selector string Selector (label query) to filter on
- --show-events If true, display events related to the described object. (default true)
+ --all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.
+ -f, --filename stringSlice Filename, directory, or URL to files containing the resource to describe
+ -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
+ -l, --selector string Selector (label query) to filter on
+ --show-events If true, display events related to the described object. (default true)
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_drain.md b/docs/user-guide/kubectl/kubectl_drain.md
index 26e61779a0..69acd19ead 100644
--- a/docs/user-guide/kubectl/kubectl_drain.md
+++ b/docs/user-guide/kubectl/kubectl_drain.md
@@ -1,4 +1,5 @@
---
+title: kubectl drain
---
## kubectl drain
@@ -8,25 +9,16 @@ Drain node in preparation for maintenance
### Synopsis
-
Drain node in preparation for maintenance.
-The given node will be marked unschedulable to prevent new pods from arriving.
-Then drain 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 or Job--, then drain will not delete any pods unless you
-use --force.
+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.
-When you are ready to put the node back into service, use kubectl uncordon, which
-will make the node schedulable again.
+'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.
-
```
kubectl drain NODE
```
@@ -34,58 +26,54 @@ kubectl drain NODE
### Examples
```
-
-# Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet on it.
-$ kubectl drain foo --force
-
-# As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet, and use a grace period of 15 minutes.
-$ kubectl drain foo --grace-period=900
-
+ # Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet on it.
+ $ kubectl drain foo --force
+
+ # As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet, and use a grace period of 15 minutes.
+ $ kubectl drain foo --grace-period=900
```
### Options
```
--delete-local-data Continue even if there are pods using emptyDir (local data that will be deleted when the node is drained).
- --force Continue even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet.
+ --force Continue even if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet.
--grace-period int Period of time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used. (default -1)
--ignore-daemonsets Ignore DaemonSet-managed pods.
+ --timeout duration The length of time to wait before giving up, zero means infinite
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_edit.md b/docs/user-guide/kubectl/kubectl_edit.md
index dc626b9440..bff3f7cd67 100644
--- a/docs/user-guide/kubectl/kubectl_edit.md
+++ b/docs/user-guide/kubectl/kubectl_edit.md
@@ -1,4 +1,5 @@
---
+title: kubectl edit
---
## kubectl edit
@@ -8,26 +9,13 @@ Edit a resource on the server
### Synopsis
-
Edit a resource from the default editor.
-The edit command allows you to directly edit any API resource you can retrieve via the
-command line tools. It will open the editor defined by your KUBE_EDITOR, or EDITOR
-environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows.
-You can edit multiple objects, although changes are applied one at a time. The command
-accepts filenames as well as command line arguments, although the files you point to must
-be previously saved versions of resources.
+The edit command allows you to directly edit any API resource you can retrieve via the command line tools. It will open the editor defined by your KUBE _EDITOR, or EDITOR environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multiple objects, although changes are applied one at a time. The command accepts filenames as well as command line arguments, although the files you point to must be previously saved versions of resources.
-The files to edit will be output in the default API version, or a version specified
-by --output-version. The default format is YAML - if you would like to edit in JSON
-pass -o json. The flag --windows-line-endings can be used to force Windows line endings,
-otherwise the default for your operating system will be used.
+The files to edit will be output in the default API version, or a version specified by --output-version. The default format is YAML - if you would like to edit in JSON pass -o json. The flag --windows-line-endings can be used to force Windows line endings, otherwise the default for your operating system will be used.
-In the event an error occurs while updating, a temporary file will be created on disk
-that contains your unapplied changes. The most common error when updating a resource
-is another editor changing the resource on the server. When this occurs, you will have
-to apply your changes to the newer version of the resource, or update your temporary
-saved copy to include the latest resource version.
+In the event an error occurs while updating, a temporary file will be created on disk that contains your unapplied changes. The most common error when updating a resource is another editor changing the resource on the server. When this occurs, you will have to apply your changes to the newer version of the resource, or update your temporary saved copy to include the latest resource version.
```
kubectl edit (RESOURCE/NAME | -f FILENAME)
@@ -36,22 +24,20 @@ kubectl edit (RESOURCE/NAME | -f FILENAME)
### Examples
```
-
-# Edit the service named 'docker-registry':
-kubectl edit svc/docker-registry
-
-# Use an alternative editor
-KUBE_EDITOR="nano" kubectl edit svc/docker-registry
-
-# Edit the service 'docker-registry' in JSON using the v1 API format:
-kubectl edit svc/docker-registry --output-version=v1 -o json
+ # Edit the service named 'docker-registry':
+ kubectl edit svc/docker-registry
+
+ # Use an alternative editor
+ KUBE_EDITOR="nano" kubectl edit svc/docker-registry
+
+ # Edit the service 'docker-registry' in JSON using the v1 API format:
+ kubectl edit svc/docker-registry --output-version=v1 -o json
```
### Options
```
- -f, --filename value Filename, directory, or URL to file to use to edit the resource (default [])
- --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
+ -f, --filename stringSlice Filename, directory, or URL to files to use to edit the resource
-o, --output string Output format. One of: yaml|json. (default "yaml")
--output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
--record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists.
@@ -65,37 +51,34 @@ kubectl edit svc/docker-registry --output-version=v1 -o json
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_exec.md b/docs/user-guide/kubectl/kubectl_exec.md
index 94bbd4bff0..8a64cd7bcf 100644
--- a/docs/user-guide/kubectl/kubectl_exec.md
+++ b/docs/user-guide/kubectl/kubectl_exec.md
@@ -1,4 +1,5 @@
---
+title: kubectl exec
---
## kubectl exec
@@ -17,16 +18,15 @@ kubectl exec POD [-c CONTAINER] -- COMMAND [args...]
### Examples
```
-
-# Get output from running 'date' from pod 123456-7890, using the first container by default
-kubectl exec 123456-7890 date
-
-# Get output from running 'date' in ruby-container from pod 123456-7890
-kubectl exec 123456-7890 -c ruby-container date
-
-# Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-7890
-# and sends stdout/stderr from 'bash' back to the client
-kubectl exec 123456-7890 -c ruby-container -i -t -- bash -il
+ # Get output from running 'date' from pod 123456-7890, using the first container by default
+ kubectl exec 123456-7890 date
+
+ # Get output from running 'date' in ruby-container from pod 123456-7890
+ kubectl exec 123456-7890 -c ruby-container date
+
+ # Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-7890
+ # and sends stdout/stderr from 'bash' back to the client
+ kubectl exec 123456-7890 -c ruby-container -i -t -- bash -il
```
### Options
@@ -41,37 +41,34 @@ kubectl exec 123456-7890 -c ruby-container -i -t -- bash -il
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_explain.md b/docs/user-guide/kubectl/kubectl_explain.md
index 70f52d6ee4..60523fdc9f 100644
--- a/docs/user-guide/kubectl/kubectl_explain.md
+++ b/docs/user-guide/kubectl/kubectl_explain.md
@@ -1,4 +1,5 @@
---
+title: kubectl explain
---
## kubectl explain
@@ -8,35 +9,38 @@ Documentation of resources
### Synopsis
-
Documentation of resources.
Valid resource types include:
- * clusters (valid only for federation apiservers)
- * componentstatuses (aka 'cs')
- * configmaps (aka 'cm')
- * daemonsets (aka 'ds')
- * deployments (aka 'deploy')
- * events (aka 'ev')
- * endpoints (aka 'ep')
- * horizontalpodautoscalers (aka 'hpa')
- * ingress (aka 'ing')
- * jobs
- * limitranges (aka 'limits')
- * nodes (aka 'no')
- * namespaces (aka 'ns')
- * petsets (alpha feature, may be unstable)
- * pods (aka 'po')
- * persistentvolumes (aka 'pv')
- * persistentvolumeclaims (aka 'pvc')
- * quota
- * resourcequotas (aka 'quota')
- * replicasets (aka 'rs')
- * replicationcontrollers (aka 'rc')
- * secrets
- * serviceaccounts (aka 'sa')
- * services (aka 'svc')
+ * clusters (valid only for federation apiservers)
+ * componentstatuses (aka 'cs')
+ * configmaps (aka 'cm')
+ * daemonsets (aka 'ds')
+ * deployments (aka 'deploy')
+ * endpoints (aka 'ep')
+ * events (aka 'ev')
+ * horizontalpodautoscalers (aka 'hpa')
+ * ingresses (aka 'ing')
+ * jobs
+ * limitranges (aka 'limits')
+ * namespaces (aka 'ns')
+ * networkpolicies
+ * nodes (aka 'no')
+ * persistentvolumeclaims (aka 'pvc')
+ * persistentvolumes (aka 'pv')
+ * pods (aka 'po')
+ * podsecuritypolicies (aka 'psp')
+ * podtemplates
+ * replicasets (aka 'rs')
+ * replicationcontrollers (aka 'rc')
+ * resourcequotas (aka 'quota')
+ * secrets
+ * serviceaccounts (aka 'sa')
+ * services (aka 'svc')
+ * statefulsets
+ * storageclasses
+ * thirdpartyresources
```
kubectl explain RESOURCE
@@ -45,55 +49,50 @@ kubectl explain RESOURCE
### Examples
```
-
-# Get the documentation of the resource and its fields
-kubectl explain pods
-
-# Get the documentation of a specific field of a resource
-kubectl explain pods.spec.containers
+ # Get the documentation of the resource and its fields
+ kubectl explain pods
+
+ # Get the documentation of a specific field of a resource
+ kubectl explain pods.spec.containers
```
### Options
```
- --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
- --recursive Print the fields of fields (Currently only 1 level deep)
+ --recursive Print the fields of fields (Currently only 1 level deep)
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_expose.md b/docs/user-guide/kubectl/kubectl_expose.md
index 6ecb7e5951..f741313c29 100644
--- a/docs/user-guide/kubectl/kubectl_expose.md
+++ b/docs/user-guide/kubectl/kubectl_expose.md
@@ -1,4 +1,5 @@
---
+title: kubectl expose
---
## kubectl expose
@@ -8,20 +9,13 @@ Take a replication controller, service, deployment or pod and expose it as a new
### Synopsis
-
Expose a resource as a new Kubernetes service.
-Looks up a deployment, service, replica set, replication controller or pod by name and uses the selector
-for that resource as the selector for a new service on the specified port. A deployment or replica set
-will be exposed as a service only if its selector is convertible to a selector that service supports,
-i.e. when the selector contains only the matchLabels component. Note that if no port is specified via
---port and the exposed resource has multiple ports, all will be re-used by the new service. Also if no
-labels are specified, the new service will re-use the labels from the resource it exposes.
+Looks up a deployment, service, replica set, replication controller or pod by name and uses the selector for that resource as the selector for a new service on the specified port. A deployment or replica set will be exposed as a service only if its selector is convertible to a selector that service supports, i.e. when the selector contains only the matchLabels component. Note that if no port is specified via --port and the exposed resource has multiple ports, all will be re-used by the new service. Also if no labels are specified, the new service will re-use the labels from the resource it exposes.
Possible resources include (case insensitive):
-pod (po), service (svc), replicationcontroller (rc),
-deployment (deploy), replicaset (rs)
+pod (po), service (svc), replicationcontroller (rc), deployment (deploy), replicaset (rs)
```
kubectl 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]
@@ -30,27 +24,26 @@ kubectl expose (-f FILENAME | TYPE NAME) [--port=port] [--protocol=TCP|UDP] [--t
### Examples
```
-
-# Create a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000.
-kubectl expose rc nginx --port=80 --target-port=8000
-
-# Create a service for a replication controller identified by type and name specified in "nginx-controller.yaml", which serves on port 80 and connects to the containers on port 8000.
-kubectl expose -f nginx-controller.yaml --port=80 --target-port=8000
-
-# Create a service for a pod valid-pod, which serves on port 444 with the name "frontend"
-kubectl expose pod valid-pod --port=444 --name=frontend
-
-# Create a second service based on the above service, exposing the container port 8443 as port 443 with the name "nginx-https"
-kubectl expose service nginx --port=443 --target-port=8443 --name=nginx-https
-
-# Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video-stream'.
-kubectl expose rc streamer --port=4100 --protocol=udp --name=video-stream
-
-# Create a service for a replicated nginx using replica set, which serves on port 80 and connects to the containers on port 8000.
-kubectl expose rs nginx --port=80 --target-port=8000
-
-# Create a service for an nginx deployment, which serves on port 80 and connects to the containers on port 8000.
-kubectl expose deployment nginx --port=80 --target-port=8000
+ # Create a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000.
+ kubectl expose rc nginx --port=80 --target-port=8000
+
+ # Create a service for a replication controller identified by type and name specified in "nginx-controller.yaml", which serves on port 80 and connects to the containers on port 8000.
+ kubectl expose -f nginx-controller.yaml --port=80 --target-port=8000
+
+ # Create a service for a pod valid-pod, which serves on port 444 with the name "frontend"
+ kubectl expose pod valid-pod --port=444 --name=frontend
+
+ # Create a second service based on the above service, exposing the container port 8443 as port 443 with the name "nginx-https"
+ kubectl expose service nginx --port=443 --target-port=8443 --name=nginx-https
+
+ # Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video-stream'.
+ kubectl expose rc streamer --port=4100 --protocol=udp --name=video-stream
+
+ # Create a service for a replicated nginx using replica set, which serves on port 80 and connects to the containers on port 8000.
+ kubectl expose rs nginx --port=80 --target-port=8000
+
+ # Create a service for an nginx deployment, which serves on port 80 and connects to the containers on port 8000.
+ kubectl expose deployment nginx --port=80 --target-port=8000
```
### Options
@@ -59,7 +52,7 @@ kubectl expose deployment nginx --port=80 --target-port=8000
--cluster-ip string ClusterIP to be assigned to the service. Leave empty to auto-allocate, or set to 'None' to create a headless service.
--dry-run If true, only print the object that would be sent, without sending it.
--external-ip string Additional external IP address (not managed by Kubernetes) to accept for the service. If this IP is routed to a node, the service can be accessed by this IP in addition to its generated service IP.
- -f, --filename value Filename, directory, or URL to a file identifying the resource to expose a service (default [])
+ -f, --filename stringSlice Filename, directory, or URL to files identifying the resource to expose a service
--generator string The name of the API generator to use. There are 2 generators: 'service/v1' and 'service/v2'. The only difference between them is that service port in v1 is named 'default', while it is left unnamed in v2. Default is 'service/v2'. (default "service/v2")
-l, --labels string Labels to apply to the service created by this call.
--load-balancer-ip string IP to assign to the Load Balancer. If empty, an ephemeral IP will be created and used (cloud-provider specific).
@@ -86,37 +79,34 @@ kubectl expose deployment nginx --port=80 --target-port=8000
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_get.md b/docs/user-guide/kubectl/kubectl_get.md
index 275a9b620b..7e973d7bc9 100644
--- a/docs/user-guide/kubectl/kubectl_get.md
+++ b/docs/user-guide/kubectl/kubectl_get.md
@@ -1,4 +1,5 @@
---
+title: kubectl get
---
## kubectl get
@@ -8,41 +9,42 @@ Display one or many resources
### Synopsis
-
Display one or many resources.
Valid resource types include:
- * clusters (valid only for federation apiservers)
- * componentstatuses (aka 'cs')
- * configmaps (aka 'cm')
- * daemonsets (aka 'ds')
- * deployments (aka 'deploy')
- * events (aka 'ev')
- * endpoints (aka 'ep')
- * horizontalpodautoscalers (aka 'hpa')
- * ingress (aka 'ing')
- * jobs
- * limitranges (aka 'limits')
- * nodes (aka 'no')
- * namespaces (aka 'ns')
- * petsets (alpha feature, may be unstable)
- * pods (aka 'po')
- * persistentvolumes (aka 'pv')
- * persistentvolumeclaims (aka 'pvc')
- * quota
- * resourcequotas (aka 'quota')
- * replicasets (aka 'rs')
- * replicationcontrollers (aka 'rc')
- * secrets
- * serviceaccounts (aka 'sa')
- * services (aka 'svc')
+ * clusters (valid only for federation apiservers)
+ * componentstatuses (aka 'cs')
+ * configmaps (aka 'cm')
+ * daemonsets (aka 'ds')
+ * deployments (aka 'deploy')
+ * endpoints (aka 'ep')
+ * events (aka 'ev')
+ * horizontalpodautoscalers (aka 'hpa')
+ * ingresses (aka 'ing')
+ * jobs
+ * limitranges (aka 'limits')
+ * namespaces (aka 'ns')
+ * networkpolicies
+ * nodes (aka 'no')
+ * persistentvolumeclaims (aka 'pvc')
+ * persistentvolumes (aka 'pv')
+ * pods (aka 'po')
+ * podsecuritypolicies (aka 'psp')
+ * podtemplates
+ * replicasets (aka 'rs')
+ * replicationcontrollers (aka 'rc')
+ * resourcequotas (aka 'quota')
+ * secrets
+ * serviceaccounts (aka 'sa')
+ * services (aka 'svc')
+ * statefulsets
+ * storageclasses
+ * thirdpartyresources
-This command will hide resources that have completed. For instance, pods that are in the Succeeded or Failed phases.
-You can see the full results for any resource by providing the '--show-all' flag.
+This command will hide resources that have completed. For instance, pods that are in the Succeeded or Failed phases. You can see the full results for any resource by providing the '--show-all' flag.
-By specifying the output as 'template' and providing a Go template as the value
-of the --template flag, you can filter the attributes of the fetched resource(s).
+By specifying the output as 'template' and providing a Go template as the value of the --template flag, you can filter the attributes of the fetched resource(s).
```
kubectl get [(-o|--output=)json|yaml|wide|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=...] (TYPE [NAME | -l label] | TYPE/NAME ...) [flags]
@@ -50,90 +52,85 @@ kubectl get [(-o|--output=)json|yaml|wide|custom-columns=...|custom-columns-file
### Examples
-```
+```{% raw %}
+ # List all pods in ps output format.
+ kubectl get pods
-# List all pods in ps output format.
-kubectl get pods
+ # List all pods in ps output format with more information (such as node name).
+ kubectl get pods -o wide
-# List all pods in ps output format with more information (such as node name).
-kubectl get pods -o wide
+ # List a single replication controller with specified NAME in ps output format.
+ kubectl get replicationcontroller web
-# List a single replication controller with specified NAME in ps output format.
-kubectl get replicationcontroller web
+ # List a single pod in JSON output format.
+ kubectl get -o json pod web-pod-13je7
-# List a single pod in JSON output format.
-kubectl get -o json pod web-pod-13je7
+ # List a pod identified by type and name specified in "pod.yaml" in JSON output format.
+ kubectl get -f pod.yaml -o json
-# List a pod identified by type and name specified in "pod.yaml" in JSON output format.
-kubectl get -f pod.yaml -o json
+ # Return only the phase value of the specified pod.
+ kubectl get -o template pod/web-pod-13je7 --template={{.status.phase}}
-# Return only the phase value of the specified pod.
-kubectl get -o template pod/web-pod-13je7 --template={{.status.phase}}
+ # List all replication controllers and services together in ps output format.
+ kubectl get rc,services
-# List all replication controllers and services together in ps output format.
-kubectl get rc,services
-
-# List one or more resources by their type and names.
-kubectl get rc/web service/frontend pods/web-pod-13je7
-```
+ # List one or more resources by their type and names.
+ kubectl get rc/web service/frontend pods/web-pod-13je7
+{% endraw %}```
### Options
```
- --all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.
- --export If true, use 'export' for the resources. Exported resources are stripped of cluster-specific information.
- -f, --filename value Filename, directory, or URL to a file identifying the resource to get from a server. (default [])
- --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
- -L, --label-columns value Accepts a comma separated list of labels that are going to be presented as columns. Names are case-sensitive. You can also use multiple flag options like -L label1 -L label2... (default [])
- --no-headers When using the default or custom-column output format, don't print headers.
- -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
- --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
- --raw string Raw URI to request from the server. Uses the transport specified by the kubeconfig file.
- -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
- -l, --selector string Selector (label query) to filter on
- -a, --show-all When printing, show all resources (default hide terminated pods.)
- --show-kind If present, list the resource type for the requested object(s).
- --show-labels When printing, show all labels as the last column (default hide labels column)
- --sort-by string If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
- --template string 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].
- -w, --watch After listing/getting the requested object, watch for changes.
- --watch-only Watch for changes to the requested object(s), without listing/getting first.
+ --all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.
+ --export If true, use 'export' for the resources. Exported resources are stripped of cluster-specific information.
+ -f, --filename stringSlice Filename, directory, or URL to files identifying the resource to get from a server.
+ -L, --label-columns stringSlice Accepts a comma separated list of labels that are going to be presented as columns. Names are case-sensitive. You can also use multiple flag options like -L label1 -L label2...
+ --no-headers When using the default or custom-column output format, don't print headers.
+ -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
+ --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
+ --raw string Raw URI to request from the server. Uses the transport specified by the kubeconfig file.
+ -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
+ -l, --selector string Selector (label query) to filter on
+ -a, --show-all When printing, show all resources (default hide terminated pods.)
+ --show-kind If present, list the resource type for the requested object(s).
+ --show-labels When printing, show all labels as the last column (default hide labels column)
+ --sort-by string If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
+ --template string 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].
+ -w, --watch After listing/getting the requested object, watch for changes.
+ --watch-only Watch for changes to the requested object(s), without listing/getting first.
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_label.md b/docs/user-guide/kubectl/kubectl_label.md
index 8a01e1c4e4..be186a6515 100644
--- a/docs/user-guide/kubectl/kubectl_label.md
+++ b/docs/user-guide/kubectl/kubectl_label.md
@@ -1,4 +1,5 @@
---
+title: kubectl label
---
## kubectl label
@@ -8,12 +9,11 @@ Update the labels on a resource
### Synopsis
-
Update the labels on a resource.
-A label must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 63 characters.
-If --overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error.
-If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used.
+ * A label must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 63 characters.
+ * If --overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error.
+ * If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used.
```
kubectl label [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]
@@ -22,25 +22,24 @@ kubectl label [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_
### Examples
```
-
-# Update pod 'foo' with the label 'unhealthy' and the value 'true'.
-kubectl label pods foo unhealthy=true
-
-# Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value.
-kubectl label --overwrite pods foo status=unhealthy
-
-# Update all pods in the namespace
-kubectl label pods --all status=unhealthy
-
-# Update a pod identified by the type and name in "pod.json"
-kubectl label -f pod.json status=unhealthy
-
-# Update pod 'foo' only if the resource is unchanged from version 1.
-kubectl label pods foo status=unhealthy --resource-version=1
-
-# Update pod 'foo' by removing a label named 'bar' if it exists.
-# Does not require the --overwrite flag.
-kubectl label pods foo bar-
+ # Update pod 'foo' with the label 'unhealthy' and the value 'true'.
+ kubectl label pods foo unhealthy=true
+
+ # Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value.
+ kubectl label --overwrite pods foo status=unhealthy
+
+ # Update all pods in the namespace
+ kubectl label pods --all status=unhealthy
+
+ # Update a pod identified by the type and name in "pod.json"
+ kubectl label -f pod.json status=unhealthy
+
+ # Update pod 'foo' only if the resource is unchanged from version 1.
+ kubectl label pods foo status=unhealthy --resource-version=1
+
+ # Update pod 'foo' by removing a label named 'bar' if it exists.
+ # Does not require the --overwrite flag.
+ kubectl label pods foo bar-
```
### Options
@@ -48,8 +47,8 @@ kubectl label pods foo bar-
```
--all select all resources in the namespace of the specified resource types
--dry-run If true, only print the object that would be sent, without sending it.
- -f, --filename value Filename, directory, or URL to a file identifying the resource to update the labels (default [])
- --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
+ -f, --filename stringSlice Filename, directory, or URL to files identifying the resource to update the labels
+ --local If true, label will NOT contact api-server but run locally.
--no-headers When using the default or custom-column output format, don't print headers.
-o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
--output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
@@ -67,37 +66,34 @@ kubectl label pods foo bar-
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_logs.md b/docs/user-guide/kubectl/kubectl_logs.md
index a09a291797..cfc418eb59 100644
--- a/docs/user-guide/kubectl/kubectl_logs.md
+++ b/docs/user-guide/kubectl/kubectl_logs.md
@@ -1,4 +1,5 @@
---
+title: kubectl logs
---
## kubectl logs
@@ -17,71 +18,66 @@ kubectl logs [-f] [-p] POD [-c CONTAINER]
### Examples
```
-
-# Return snapshot logs from pod nginx with only one container
-kubectl logs nginx
-
-# Return snapshot of previous terminated ruby container logs from pod web-1
-kubectl logs -p -c ruby web-1
-
-# Begin streaming the logs of the ruby container in pod web-1
-kubectl logs -f -c ruby web-1
-
-# Display only the most recent 20 lines of output in pod nginx
-kubectl logs --tail=20 nginx
-
-# Show all logs from pod nginx written in the last hour
-kubectl logs --since=1h nginx
+ # Return snapshot logs from pod nginx with only one container
+ kubectl logs nginx
+
+ # Return snapshot of previous terminated ruby container logs from pod web-1
+ kubectl logs -p -c ruby web-1
+
+ # Begin streaming the logs of the ruby container in pod web-1
+ kubectl logs -f -c ruby web-1
+
+ # Display only the most recent 20 lines of output in pod nginx
+ kubectl logs --tail=20 nginx
+
+ # Show all logs from pod nginx written in the last hour
+ kubectl logs --since=1h nginx
```
### Options
```
- -c, --container string Print the logs of this container
- -f, --follow Specify if the logs should be streamed.
- --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
- --limit-bytes int Maximum bytes of logs to return. Defaults to no limit.
- -p, --previous If true, print the logs for the previous instance of the container in a pod if it exists.
- --since duration Only return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since-time / since may be used. (default 0s)
- --since-time string Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since-time / since may be used.
- --tail int Lines of recent log file to display. Defaults to -1, showing all log lines. (default -1)
- --timestamps Include timestamps on each line in the log output
+ -c, --container string Print the logs of this container
+ -f, --follow Specify if the logs should be streamed.
+ --limit-bytes int Maximum bytes of logs to return. Defaults to no limit.
+ -p, --previous If true, print the logs for the previous instance of the container in a pod if it exists.
+ --since duration Only return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since-time / since may be used.
+ --since-time string Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since-time / since may be used.
+ --tail int Lines of recent log file to display. Defaults to -1, showing all log lines. (default -1)
+ --timestamps Include timestamps on each line in the log output
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_namespace.md b/docs/user-guide/kubectl/kubectl_namespace.md
deleted file mode 100644
index c5b7d60883..0000000000
--- a/docs/user-guide/kubectl/kubectl_namespace.md
+++ /dev/null
@@ -1,54 +0,0 @@
----
----
-
-## kubectl namespace
-
-Deprecated: config set-context
-
-### Synopsis
-
-
-Deprecated: This command is deprecated, all its functionalities are covered by "kubectl config set-context"
-
-```
-kubectl namespace [namespace]
-```
-
-### Options inherited from parent commands
-
-```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
-```
-
-
-
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
-
-
-[]()
-
diff --git a/docs/user-guide/kubectl/kubectl_options.md b/docs/user-guide/kubectl/kubectl_options.md
index c82e556ec8..994f9e83f8 100644
--- a/docs/user-guide/kubectl/kubectl_options.md
+++ b/docs/user-guide/kubectl/kubectl_options.md
@@ -1,6 +1,5 @@
---
---
-
## kubectl options
@@ -17,37 +16,34 @@ kubectl options
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_patch.md b/docs/user-guide/kubectl/kubectl_patch.md
index 3497852c34..fb6c4299ad 100644
--- a/docs/user-guide/kubectl/kubectl_patch.md
+++ b/docs/user-guide/kubectl/kubectl_patch.md
@@ -1,4 +1,5 @@
---
+title: kubectl patch
---
## kubectl patch
@@ -8,12 +9,11 @@ Update field(s) of a resource using strategic merge patch
### Synopsis
-
Update field(s) of a resource using strategic merge patch
JSON and YAML formats are accepted.
-Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/release-1.4/docs/api-reference/v1/definitions.html to find if a field is mutable.
+Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/HEAD/docs/api-reference/v1/definitions.html to find if a field is mutable.
```
kubectl patch (-f FILENAME | TYPE NAME) -p PATCH
@@ -22,26 +22,23 @@ kubectl patch (-f FILENAME | TYPE NAME) -p PATCH
### Examples
```
-
-
-# Partially update a node using strategic merge patch
-kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}'
-
-# Partially update a node identified by the type and name specified in "node.json" using strategic merge patch
-kubectl patch -f node.json -p '{"spec":{"unschedulable":true}}'
-
-# Update a container's image; spec.containers[*].name is required because it's a merge key
-kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}'
-
-# Update a container's image using a json patch with positional arrays
-kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]'
+ # Partially update a node using strategic merge patch
+ kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}'
+
+ # Partially update a node identified by the type and name specified in "node.json" using strategic merge patch
+ kubectl patch -f node.json -p '{"spec":{"unschedulable":true}}'
+
+ # Update a container's image; spec.containers[*].name is required because it's a merge key
+ kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}'
+
+ # Update a container's image using a json patch with positional arrays
+ kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]'
```
### Options
```
- -f, --filename value Filename, directory, or URL to a file identifying the resource to update (default [])
- --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
+ -f, --filename stringSlice Filename, directory, or URL to files identifying the resource to update
--local If true, patch will operate on the content of the file, not the server-side resource.
--no-headers When using the default or custom-column output format, don't print headers.
-o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
@@ -59,37 +56,34 @@ kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_port-forward.md b/docs/user-guide/kubectl/kubectl_port-forward.md
index 3a0b6f548b..feb00cf258 100644
--- a/docs/user-guide/kubectl/kubectl_port-forward.md
+++ b/docs/user-guide/kubectl/kubectl_port-forward.md
@@ -1,4 +1,5 @@
---
+title: kubectl port-forward
---
## kubectl port-forward
@@ -17,18 +18,17 @@ kubectl port-forward POD [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMOTE_PORT
### Examples
```
-
-# Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod
-kubectl port-forward mypod 5000 6000
-
-# Listen on port 8888 locally, forwarding to 5000 in the pod
-kubectl port-forward mypod 8888:5000
-
-# Listen on a random port locally, forwarding to 5000 in the pod
-kubectl port-forward mypod :5000
-
-# Listen on a random port locally, forwarding to 5000 in the pod
-kubectl port-forward mypod 0:5000
+ # Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod
+ kubectl port-forward mypod 5000 6000
+
+ # Listen on port 8888 locally, forwarding to 5000 in the pod
+ kubectl port-forward mypod 8888:5000
+
+ # Listen on a random port locally, forwarding to 5000 in the pod
+ kubectl port-forward mypod :5000
+
+ # Listen on a random port locally, forwarding to 5000 in the pod
+ kubectl port-forward mypod 0:5000
```
### Options
@@ -40,37 +40,34 @@ kubectl port-forward mypod 0:5000
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_proxy.md b/docs/user-guide/kubectl/kubectl_proxy.md
index 62f0417c2e..9616d6add6 100644
--- a/docs/user-guide/kubectl/kubectl_proxy.md
+++ b/docs/user-guide/kubectl/kubectl_proxy.md
@@ -1,4 +1,5 @@
---
+title: kubectl proxy
---
## kubectl proxy
@@ -8,24 +9,22 @@ Run a proxy to the Kubernetes API server
### Synopsis
+To proxy all of the Kubernetes api and nothing else, use:
-To proxy all of the kubernetes api and nothing else, use:
+ $ kubectl proxy --api-prefix=/
-kubectl proxy --api-prefix=/
+To proxy only part of the Kubernetes api and also some static files:
-To proxy only part of the kubernetes api and also some static files:
-
-kubectl proxy --www=/my/files --www-prefix=/static/ --api-prefix=/api/
+ $ kubectl proxy --www=/my/files --www-prefix=/static/ --api-prefix=/api/
The above lets you 'curl localhost:8001/api/v1/pods'.
-To proxy the entire kubernetes api at a different root, use:
+To proxy the entire Kubernetes api at a different root, use:
-kubectl proxy --api-prefix=/custom/
+ $ kubectl proxy --api-prefix=/custom/
The above lets you 'curl localhost:8001/custom/api/v1/pods'
-
```
kubectl proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--api-prefix=prefix]
```
@@ -33,23 +32,22 @@ kubectl proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--api-pref
### Examples
```
-
-# Run a proxy to kubernetes apiserver on port 8011, serving static content from ./local/www/
-kubectl proxy --port=8011 --www=./local/www/
-
-# Run a proxy to kubernetes apiserver on an arbitrary local port.
-# The chosen port for the server will be output to stdout.
-kubectl proxy --port=0
-
-# Run a proxy to kubernetes apiserver, changing the api prefix to k8s-api
-# This makes e.g. the pods api available at localhost:8011/k8s-api/v1/pods/
-kubectl proxy --api-prefix=/k8s-api
+ # Run a proxy to kubernetes apiserver on port 8011, serving static content from ./local/www/
+ kubectl proxy --port=8011 --www=./local/www/
+
+ # Run a proxy to kubernetes apiserver on an arbitrary local port.
+ # The chosen port for the server will be output to stdout.
+ kubectl proxy --port=0
+
+ # Run a proxy to kubernetes apiserver, changing the api prefix to k8s-api
+ # This makes e.g. the pods api available at localhost:8011/k8s-api/v1/pods/
+ kubectl proxy --api-prefix=/k8s-api
```
### Options
```
- --accept-hosts string Regular expression for hosts that the proxy should accept. (default "^localhost$,^127\\.0\\.0\\.1$,^\\[::1\\]$")
+ --accept-hosts string Regular expression for hosts that the proxy should accept. (default "^localhost$,^127\.0\.0\.1$,^\[::1\]$")
--accept-paths string Regular expression for paths that the proxy should accept. (default "^/.*")
--address string The IP address on which to serve on. (default "127.0.0.1")
--api-prefix string Prefix to serve the proxied API under. (default "/")
@@ -65,37 +63,34 @@ kubectl proxy --api-prefix=/k8s-api
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_replace.md b/docs/user-guide/kubectl/kubectl_replace.md
index 6816704c17..5e0ee378de 100644
--- a/docs/user-guide/kubectl/kubectl_replace.md
+++ b/docs/user-guide/kubectl/kubectl_replace.md
@@ -1,4 +1,5 @@
---
+title: kubectl replace
---
## kubectl replace
@@ -8,14 +9,13 @@ Replace a resource by filename or stdin
### Synopsis
-
Replace a resource by filename or stdin.
-JSON and YAML formats are accepted. If replacing an existing resource, the
-complete resource spec must be provided. This can be obtained by
-$ kubectl get TYPE NAME -o yaml
+JSON and YAML formats are accepted. If replacing an existing resource, the complete resource spec must be provided. This can be obtained by
-Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/release-1.4/docs/api-reference/v1/definitions.html to find if a field is mutable.
+ $ kubectl get TYPE NAME -o yaml
+
+Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/HEAD/docs/api-reference/v1/definitions.html to find if a field is mutable.
```
kubectl replace -f FILENAME
@@ -24,71 +24,66 @@ kubectl replace -f FILENAME
### Examples
```
-
-# Replace a pod using the data in pod.json.
-kubectl replace -f ./pod.json
-
-# Replace a pod based on the JSON passed into stdin.
-cat pod.json | kubectl replace -f -
-
-# Update a single-container pod's image version (tag) to v4
-kubectl get pod mypod -o yaml | sed 's/\(image: myimage\):.*$/\1:v4/' | kubectl replace -f -
-
-# Force replace, delete and then re-create the resource
-kubectl replace --force -f ./pod.json
+ # Replace a pod using the data in pod.json.
+ kubectl replace -f ./pod.json
+
+ # Replace a pod based on the JSON passed into stdin.
+ cat pod.json | kubectl replace -f -
+
+ # Update a single-container pod's image version (tag) to v4
+ kubectl get pod mypod -o yaml | sed 's/\(image: myimage\):.*$/\1:v4/' | kubectl replace -f -
+
+ # Force replace, delete and then re-create the resource
+ kubectl replace --force -f ./pod.json
```
### Options
```
--cascade Only relevant during a force replace. If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController).
- -f, --filename value Filename, directory, or URL to file to use to replace the resource. (default [])
+ -f, --filename stringSlice Filename, directory, or URL to files to use to replace the resource.
--force Delete and re-create the specified resource
--grace-period int Only relevant during a force replace. Period of time in seconds given to the old resource to terminate gracefully. Ignored if negative. (default -1)
- --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
-o, --output string Output mode. Use "-o name" for shorter output (resource/name).
--record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists.
-R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
--save-config If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
--schema-cache-dir string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema")
- --timeout duration Only relevant during a force replace. The length of time to wait before giving up on a delete of the old resource, zero means determine a timeout from the size of the object. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). (default 0s)
+ --timeout duration Only relevant during a force replace. The length of time to wait before giving up on a delete of the old resource, zero means determine a timeout from the size of the object. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h).
--validate If true, use a schema to validate the input before sending it (default true)
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_rolling-update.md b/docs/user-guide/kubectl/kubectl_rolling-update.md
index 3b9dcb7fb7..382e630c78 100644
--- a/docs/user-guide/kubectl/kubectl_rolling-update.md
+++ b/docs/user-guide/kubectl/kubectl_rolling-update.md
@@ -1,4 +1,5 @@
---
+title: kubectl rolling-update
---
## kubectl rolling-update
@@ -8,15 +9,11 @@ Perform a rolling update of the given ReplicationController
### Synopsis
-
Perform a rolling update of the given ReplicationController.
-Replaces the specified replication controller with a new replication controller by updating one pod at a time to use the
-new PodTemplate. The new-controller.json must specify the same namespace as the
-existing replication controller and overwrite at least one (common) label in its replicaSelector.
-
-
+Replaces the specified replication controller with a new replication controller by updating one pod at a time to use the new PodTemplate. The new-controller.json must specify the same namespace as the existing replication controller and overwrite at least one (common) label in its replicaSelector.
+! http://kubernetes.io/images/docs/kubectl_rollingupdate.svg
```
kubectl rolling-update OLD_CONTROLLER_NAME ([NEW_CONTROLLER_NAME] --image=NEW_CONTAINER_IMAGE | -f NEW_CONTROLLER_SPEC)
@@ -25,23 +22,21 @@ kubectl rolling-update OLD_CONTROLLER_NAME ([NEW_CONTROLLER_NAME] --image=NEW_CO
### Examples
```
-
-# Update pods of frontend-v1 using new replication controller data in frontend-v2.json.
-kubectl rolling-update frontend-v1 -f frontend-v2.json
-
-# Update pods of frontend-v1 using JSON data passed into stdin.
-cat frontend-v2.json | kubectl rolling-update frontend-v1 -f -
-
-# Update the pods of frontend-v1 to frontend-v2 by just changing the image, and switching the
-# name of the replication controller.
-kubectl rolling-update frontend-v1 frontend-v2 --image=image:v2
-
-# Update the pods of frontend by just changing the image, and keeping the old name.
-kubectl rolling-update frontend --image=image:v2
-
-# Abort and reverse an existing rollout in progress (from frontend-v1 to frontend-v2).
-kubectl rolling-update frontend-v1 frontend-v2 --rollback
-
+ # Update pods of frontend-v1 using new replication controller data in frontend-v2.json.
+ kubectl rolling-update frontend-v1 -f frontend-v2.json
+
+ # Update pods of frontend-v1 using JSON data passed into stdin.
+ cat frontend-v2.json | kubectl rolling-update frontend-v1 -f -
+
+ # Update the pods of frontend-v1 to frontend-v2 by just changing the image, and switching the
+ # name of the replication controller.
+ kubectl rolling-update frontend-v1 frontend-v2 --image=image:v2
+
+ # Update the pods of frontend by just changing the image, and keeping the old name.
+ kubectl rolling-update frontend --image=image:v2
+
+ # Abort and reverse an existing rollout in progress (from frontend-v1 to frontend-v2).
+ kubectl rolling-update frontend-v1 frontend-v2 --rollback
```
### Options
@@ -50,10 +45,9 @@ kubectl rolling-update frontend-v1 frontend-v2 --rollback
--container string Container name which will have its image upgraded. Only relevant when --image is specified, ignored otherwise. Required when using --image on a multi-container pod
--deployment-label-key string The key to use to differentiate between two different controllers, default 'deployment'. Only relevant when --image is specified, ignored otherwise (default "deployment")
--dry-run If true, only print the object that would be sent, without sending it.
- -f, --filename value Filename or URL to file to use to create the new replication controller. (default [])
+ -f, --filename stringSlice Filename or URL to file to use to create the new replication controller.
--image string Image to use for upgrading the replication controller. Must be distinct from the existing image (either new image or new image tag). Can not be used with --filename/-f
--image-pull-policy string Explicit policy for when to pull container images. Required when --image is same as existing image, ignored otherwise.
- --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
--no-headers When using the default or custom-column output format, don't print headers.
-o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
--output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
@@ -72,37 +66,34 @@ kubectl rolling-update frontend-v1 frontend-v2 --rollback
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_rollout.md b/docs/user-guide/kubectl/kubectl_rollout.md
index 6b3c2709c6..fb8ab9fdd9 100644
--- a/docs/user-guide/kubectl/kubectl_rollout.md
+++ b/docs/user-guide/kubectl/kubectl_rollout.md
@@ -1,4 +1,5 @@
---
+title: kubectl rollout
---
## kubectl rollout
@@ -8,7 +9,6 @@ Manage a deployment rollout
### Synopsis
-
Manage a deployment using subcommands like "kubectl rollout undo deployment/abc"
```
@@ -18,45 +18,41 @@ kubectl rollout SUBCOMMAND
### Examples
```
-
-# Rollback to the previous deployment
-kubectl rollout undo deployment/abc
+ # Rollback to the previous deployment
+ kubectl rollout undo deployment/abc
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_rollout_history.md b/docs/user-guide/kubectl/kubectl_rollout_history.md
index f660162cd2..440e76de06 100644
--- a/docs/user-guide/kubectl/kubectl_rollout_history.md
+++ b/docs/user-guide/kubectl/kubectl_rollout_history.md
@@ -1,4 +1,5 @@
---
+title: kubectl rollout history
---
## kubectl rollout history
@@ -8,7 +9,6 @@ View rollout history
### Synopsis
-
View previous rollout revisions and configurations.
```
@@ -18,56 +18,52 @@ kubectl rollout history (TYPE NAME | TYPE/NAME) [flags]
### Examples
```
-
-# View the rollout history of a deployment
-kubectl rollout history deployment/abc
-
-# View the details of deployment revision 3
-kubectl rollout history deployment/abc --revision=3
+ # View the rollout history of a deployment
+ kubectl rollout history deployment/abc
+
+ # View the details of deployment revision 3
+ kubectl rollout history deployment/abc --revision=3
```
### Options
```
- -f, --filename value Filename, directory, or URL to a file identifying the resource to get from a server. (default [])
- -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
- --revision int See the details, including podTemplate of the revision specified
+ -f, --filename stringSlice Filename, directory, or URL to files identifying the resource to get from a server.
+ -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
+ --revision int See the details, including podTemplate of the revision specified
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_rollout_pause.md b/docs/user-guide/kubectl/kubectl_rollout_pause.md
index 3e85d3b629..012914c878 100644
--- a/docs/user-guide/kubectl/kubectl_rollout_pause.md
+++ b/docs/user-guide/kubectl/kubectl_rollout_pause.md
@@ -1,4 +1,5 @@
---
+title: kubectl rollout pause
---
## kubectl rollout pause
@@ -8,12 +9,9 @@ Mark the provided resource as paused
### Synopsis
-
Mark the provided resource as paused
-Paused resources will not be reconciled by a controller.
-Use \"kubectl rollout resume\" to resume a paused resource.
-Currently only deployments support being paused.
+Paused resources will not be reconciled by a controller. Use \"kubectl rollout resume \" to resume a paused resource. Currently only deployments support being paused.
```
kubectl rollout pause RESOURCE
@@ -22,54 +20,50 @@ kubectl rollout pause RESOURCE
### Examples
```
-
-# Mark the nginx deployment as paused. Any current state of
-# the deployment will continue its function, new updates to the deployment will not
-# have an effect as long as the deployment is paused.
-kubectl rollout pause deployment/nginx
+ # Mark the nginx deployment as paused. Any current state of
+ # the deployment will continue its function, new updates to the deployment will not
+ # have an effect as long as the deployment is paused.
+ kubectl rollout pause deployment/nginx
```
### Options
```
- -f, --filename value Filename, directory, or URL to a file identifying the resource to get from a server. (default [])
- -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
+ -f, --filename stringSlice Filename, directory, or URL to files identifying the resource to get from a server.
+ -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_rollout_resume.md b/docs/user-guide/kubectl/kubectl_rollout_resume.md
index 6460f30622..193a3f0081 100644
--- a/docs/user-guide/kubectl/kubectl_rollout_resume.md
+++ b/docs/user-guide/kubectl/kubectl_rollout_resume.md
@@ -1,4 +1,5 @@
---
+title: kubectl rollout resume
---
## kubectl rollout resume
@@ -8,12 +9,9 @@ Resume a paused resource
### Synopsis
-
Resume a paused resource
-Paused resources will not be reconciled by a controller. By resuming a
-resource, we allow it to be reconciled again.
-Currently only deployments support being resumed.
+Paused resources will not be reconciled by a controller. By resuming a resource, we allow it to be reconciled again. Currently only deployments support being resumed.
```
kubectl rollout resume RESOURCE
@@ -22,52 +20,48 @@ kubectl rollout resume RESOURCE
### Examples
```
-
-# Resume an already paused deployment
-kubectl rollout resume deployment/nginx
+ # Resume an already paused deployment
+ kubectl rollout resume deployment/nginx
```
### Options
```
- -f, --filename value Filename, directory, or URL to a file identifying the resource to get from a server. (default [])
- -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
+ -f, --filename stringSlice Filename, directory, or URL to files identifying the resource to get from a server.
+ -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_rollout_status.md b/docs/user-guide/kubectl/kubectl_rollout_status.md
index e611dfe6f7..befc51e54d 100644
--- a/docs/user-guide/kubectl/kubectl_rollout_status.md
+++ b/docs/user-guide/kubectl/kubectl_rollout_status.md
@@ -1,15 +1,15 @@
---
---
-
## kubectl rollout status
-Watch rollout status until it's done
+Show the status of the rollout
### Synopsis
+Show the status of the rollout.
-Watch the status of current rollout, until it's done.
+By default 'rollout status' will watch the status of the latest rollout until it's done. If you don't want to wait for the rollout to finish then you can use --watch=false. Note that if a new rollout starts in-between, then 'rollout status' will continue watching the latest revision. If you want to pin to a specific revision and abort if it is rolled over by another revision, use --revision=N where N is the revision you need to watch for.
```
kubectl rollout status (TYPE NAME | TYPE/NAME) [flags]
@@ -18,52 +18,50 @@ kubectl rollout status (TYPE NAME | TYPE/NAME) [flags]
### Examples
```
-
-# Watch the rollout status of a deployment
-kubectl rollout status deployment/nginx
+ # Watch the rollout status of a deployment
+ kubectl rollout status deployment/nginx
```
### Options
```
- -f, --filename value Filename, directory, or URL to a file identifying the resource to get from a server. (default [])
- -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
+ -f, --filename stringSlice Filename, directory, or URL to files identifying the resource to get from a server.
+ -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
+ --revision int Pin to a specific revision for showing its status. Defaults to 0 (last revision).
+ -w, --watch Watch the status of the rollout until it's done. (default true)
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_rollout_undo.md b/docs/user-guide/kubectl/kubectl_rollout_undo.md
index 3e302c7db6..7dcb287be4 100644
--- a/docs/user-guide/kubectl/kubectl_rollout_undo.md
+++ b/docs/user-guide/kubectl/kubectl_rollout_undo.md
@@ -1,4 +1,5 @@
---
+title: kubectl rollout undo
---
## kubectl rollout undo
@@ -8,7 +9,6 @@ Undo a previous rollout
### Synopsis
-
Rollback to a previous rollout.
```
@@ -18,56 +18,56 @@ kubectl rollout undo (TYPE NAME | TYPE/NAME) [flags]
### Examples
```
-
-# Rollback to the previous deployment
-kubectl rollout undo deployment/abc
-
-# Rollback to deployment revision 3
-kubectl rollout undo deployment/abc --to-revision=3
+ # Rollback to the previous deployment
+ kubectl rollout undo deployment/abc
+
+ # Rollback to deployment revision 3
+ kubectl rollout undo deployment/abc --to-revision=3
+
+ # Rollback to the previous deployment with dry-run
+ kubectl rollout undo --dry-run=true deployment/abc
```
### Options
```
- -f, --filename value Filename, directory, or URL to a file identifying the resource to get from a server. (default [])
- -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
- --to-revision int The revision to rollback to. Default to 0 (last revision).
+ --dry-run If true, only print the object that would be sent, without sending it.
+ -f, --filename stringSlice Filename, directory, or URL to files identifying the resource to get from a server.
+ -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
+ --to-revision int The revision to rollback to. Default to 0 (last revision).
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_run.md b/docs/user-guide/kubectl/kubectl_run.md
index 9b3dfb409e..5a468401d3 100644
--- a/docs/user-guide/kubectl/kubectl_run.md
+++ b/docs/user-guide/kubectl/kubectl_run.md
@@ -1,4 +1,5 @@
---
+title: kubectl run
---
## kubectl run
@@ -8,8 +9,8 @@ Run a particular image on the cluster
### Synopsis
-
Create and run a particular image, possibly replicated.
+
Creates a deployment or job to manage the created container(s).
```
@@ -19,39 +20,38 @@ kubectl run NAME --image=image [--env="key=value"] [--port=port] [--replicas=rep
### Examples
```
-
-# Start a single instance of nginx.
-kubectl run nginx --image=nginx
-
-# Start a single instance of hazelcast and let the container expose port 5701 .
-kubectl run hazelcast --image=hazelcast --port=5701
-
-# Start a single instance of hazelcast and set environment variables "DNS_DOMAIN=cluster" and "POD_NAMESPACE=default" in the container.
-kubectl run hazelcast --image=hazelcast --env="DNS_DOMAIN=cluster" --env="POD_NAMESPACE=default"
-
-# Start a replicated instance of nginx.
-kubectl run nginx --image=nginx --replicas=5
-
-# Dry run. Print the corresponding API objects without creating them.
-kubectl run nginx --image=nginx --dry-run
-
-# Start a single instance of nginx, but overload the spec of the deployment with a partial set of values parsed from JSON.
-kubectl run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }'
-
-# Start a pod of busybox and keep it in the foreground, don't restart it if it exits.
-kubectl run -i -t busybox --image=busybox --restart=Never
-
-# Start the nginx container using the default command, but use custom arguments (arg1 .. argN) for that command.
-kubectl run nginx --image=nginx -- ...
-
-# Start the nginx container using a different command and custom arguments.
-kubectl run nginx --image=nginx --command -- ...
-
-# Start the perl container to compute π to 2000 places and print it out.
-kubectl run pi --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
-
-# Start the cron job to compute π to 2000 places and print it out every 5 minutes.
-kubectl run pi --schedule="0/5 * * * ?" --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
+ # Start a single instance of nginx.
+ kubectl run nginx --image=nginx
+
+ # Start a single instance of hazelcast and let the container expose port 5701 .
+ kubectl run hazelcast --image=hazelcast --port=5701
+
+ # Start a single instance of hazelcast and set environment variables "DNS_DOMAIN=cluster" and "POD_NAMESPACE=default" in the container.
+ kubectl run hazelcast --image=hazelcast --env="DNS_DOMAIN=cluster" --env="POD_NAMESPACE=default"
+
+ # Start a replicated instance of nginx.
+ kubectl run nginx --image=nginx --replicas=5
+
+ # Dry run. Print the corresponding API objects without creating them.
+ kubectl run nginx --image=nginx --dry-run
+
+ # Start a single instance of nginx, but overload the spec of the deployment with a partial set of values parsed from JSON.
+ kubectl run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }'
+
+ # Start a pod of busybox and keep it in the foreground, don't restart it if it exits.
+ kubectl run -i -t busybox --image=busybox --restart=Never
+
+ # Start the nginx container using the default command, but use custom arguments (arg1 .. argN) for that command.
+ kubectl run nginx --image=nginx -- ...
+
+ # Start the nginx container using a different command and custom arguments.
+ kubectl run nginx --image=nginx --command -- ...
+
+ # Start the perl container to compute π to 2000 places and print it out.
+ kubectl run pi --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
+
+ # Start the cron job to compute π to 2000 places and print it out every 5 minutes.
+ kubectl run pi --schedule="0/5 * * * ?" --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
```
### Options
@@ -60,13 +60,12 @@ kubectl run pi --schedule="0/5 * * * ?" --image=perl --restart=OnFailure -- perl
--attach If true, wait for the Pod to start running, and then attach to the Pod as if 'kubectl attach ...' were called. Default false, unless '-i/--stdin' is set, in which case the default is true. With '--restart=Never' the exit code of the container process is returned.
--command If true and extra arguments are present, use them as the 'command' field in the container, rather than the 'args' field which is the default.
--dry-run If true, only print the object that would be sent, without sending it.
- --env value Environment variables to set in the container (default [])
+ --env stringSlice Environment variables to set in the container
--expose If true, a public, external service is created for the container(s) which are run
- --generator string The name of the API generator to use. Default is 'deployment/v1beta1' if --restart=Always, 'job/v1' for OnFailure and 'run-pod/v1' for Never. This will happen only for cluster version at least 1.3, for 1.2 we will fallback to 'deployment/v1beta1' for --restart=Always, 'job/v1' for others, for olders we will fallback to 'run/v1' for --restart=Always, 'run-pod/v1' for others.
+ --generator string The name of the API generator to use, see http://kubernetes.io/docs/user-guide/kubectl-conventions/#generators for a list.
--hostport int The host port mapping for the container port. To demonstrate a single-machine container. (default -1)
--image string The image for the container to run.
--image-pull-policy string The image pull policy for the container. If left empty, this value will not be specified by the client and defaulted by the server
- --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
-l, --labels string Labels to apply to the pod(s).
--leave-stdin-open If the pod is started in interactive mode or with stdin, leave stdin open after the first attach completes. By default, stdin will be closed after the first attach completes.
--limits string The resource requirement limits for this container. For example, 'cpu=200m,memory=512Mi'. Note that server side components may assign limits depending on the server configuration, such as limit ranges.
@@ -74,12 +73,12 @@ kubectl run pi --schedule="0/5 * * * ?" --image=perl --restart=OnFailure -- perl
-o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
--output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
--overrides string An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.
- --port int The port that this container exposes. If --expose is true, this is also the port used by the service that is created. (default -1)
+ --port string The port that this container exposes. If --expose is true, this is also the port used by the service that is created.
--quiet If true, suppress prompt messages.
--record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists.
-r, --replicas int Number of replicas to create for this container. Default is 1. (default 1)
--requests string The resource requirement requests for this container. For example, 'cpu=100m,memory=256Mi'. Note that server side components may assign requests depending on the server configuration, such as limit ranges.
- --restart string The restart policy for this Pod. Legal values [Always, OnFailure, Never]. If set to 'Always' a deployment is created for this pod, if set to 'OnFailure', a job is created for this pod, if set to 'Never', a regular pod is created. For the latter two --replicas must be 1. Default 'Always' (default "Always")
+ --restart Never The restart policy for this Pod. Legal values [Always, OnFailure, Never]. If set to 'Always' a deployment is created, if set to 'OnFailure' a job is created, if set to 'Never', a regular pod is created. For the latter two --replicas must be 1. Default 'Always', for ScheduledJobs Never. (default "Always")
--rm If true, delete resources created in this command for attached containers.
--save-config If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
--schedule string A schedule in the Cron format the job should be run with.
@@ -96,37 +95,34 @@ kubectl run pi --schedule="0/5 * * * ?" --image=perl --restart=OnFailure -- perl
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_scale.md b/docs/user-guide/kubectl/kubectl_scale.md
index 4f97fce9ff..93e82ac37b 100644
--- a/docs/user-guide/kubectl/kubectl_scale.md
+++ b/docs/user-guide/kubectl/kubectl_scale.md
@@ -1,4 +1,5 @@
---
+title: kubectl scale
---
## kubectl scale
@@ -8,13 +9,11 @@ Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job
### Synopsis
-
Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job.
Scale also allows users to specify one or more preconditions for the scale action.
-If --current-replicas or --resource-version is specified, it is validated before the
-scale is attempted, and it is guaranteed that the precondition holds true when the
-scale is sent to the server.
+
+If --current-replicas or --resource-version is specified, it is validated before the scale is attempted, and it is guaranteed that the precondition holds true when the scale is sent to the server.
```
kubectl scale [--resource-version=version] [--current-replicas=count] --replicas=COUNT (-f FILENAME | TYPE NAME)
@@ -23,71 +22,66 @@ kubectl scale [--resource-version=version] [--current-replicas=count] --replicas
### Examples
```
-
-# Scale a replicaset named 'foo' to 3.
-kubectl scale --replicas=3 rs/foo
-
-# Scale a resource identified by type and name specified in "foo.yaml" to 3.
-kubectl scale --replicas=3 -f foo.yaml
-
-# If the deployment named mysql's current size is 2, scale mysql to 3.
-kubectl scale --current-replicas=2 --replicas=3 deployment/mysql
-
-# Scale multiple replication controllers.
-kubectl scale --replicas=5 rc/foo rc/bar rc/baz
-
-# Scale job named 'cron' to 3.
-kubectl scale --replicas=3 job/cron
+ # Scale a replicaset named 'foo' to 3.
+ kubectl scale --replicas=3 rs/foo
+
+ # Scale a resource identified by type and name specified in "foo.yaml" to 3.
+ kubectl scale --replicas=3 -f foo.yaml
+
+ # If the deployment named mysql's current size is 2, scale mysql to 3.
+ kubectl scale --current-replicas=2 --replicas=3 deployment/mysql
+
+ # Scale multiple replication controllers.
+ kubectl scale --replicas=5 rc/foo rc/bar rc/baz
+
+ # Scale job named 'cron' to 3.
+ kubectl scale --replicas=3 job/cron
```
### Options
```
--current-replicas int Precondition for current size. Requires that the current size of the resource match this value in order to scale. (default -1)
- -f, --filename value Filename, directory, or URL to a file identifying the resource to set a new size (default [])
- --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
+ -f, --filename stringSlice Filename, directory, or URL to files identifying the resource to set a new size
-o, --output string Output mode. Use "-o name" for shorter output (resource/name).
--record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists.
-R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
--replicas int The new desired number of replicas. Required. (default -1)
--resource-version string Precondition for resource version. Requires that the current resource version match this value in order to scale.
- --timeout duration The length of time to wait before giving up on a scale operation, zero means don't wait. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). (default 0s)
+ --timeout duration The length of time to wait before giving up on a scale operation, zero means don't wait. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h).
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_set.md b/docs/user-guide/kubectl/kubectl_set.md
index dad43a25fc..a3ae525a8a 100644
--- a/docs/user-guide/kubectl/kubectl_set.md
+++ b/docs/user-guide/kubectl/kubectl_set.md
@@ -1,6 +1,5 @@
---
---
-
## kubectl set
Set specific features on objects
@@ -8,7 +7,6 @@ Set specific features on objects
### Synopsis
-
Configure application resources
These commands help you make changes to existing application resources.
@@ -20,37 +18,34 @@ kubectl set SUBCOMMAND
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_set_image.md b/docs/user-guide/kubectl/kubectl_set_image.md
index 6e7a40c903..c1b339ca6d 100644
--- a/docs/user-guide/kubectl/kubectl_set_image.md
+++ b/docs/user-guide/kubectl/kubectl_set_image.md
@@ -1,6 +1,5 @@
---
---
-
## kubectl set image
Update image of a pod template
@@ -8,10 +7,10 @@ Update image of a pod template
### Synopsis
-
Update existing container image(s) of resources.
Possible resources include (case insensitive):
+
pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), job, replicaset (rs)
```
@@ -21,25 +20,24 @@ kubectl set image (-f FILENAME | TYPE NAME) CONTAINER_NAME_1=CONTAINER_IMAGE_1 .
### Examples
```
-
-# Set a deployment's nginx container image to 'nginx:1.9.1', and its busybox container image to 'busybox'.
-kubectl set image deployment/nginx busybox=busybox nginx=nginx:1.9.1
-
-# Update all deployments' and rc's nginx container's image to 'nginx:1.9.1'
-kubectl set image deployments,rc nginx=nginx:1.9.1 --all
-
-# Update image of all containers of daemonset abc to 'nginx:1.9.1'
-kubectl set image daemonset abc *=nginx:1.9.1
-
-# Print result (in yaml format) of updating nginx container image from local file, without hitting the server
-kubectl set image -f path/to/file.yaml nginx=nginx:1.9.1 --local -o yaml
+ # Set a deployment's nginx container image to 'nginx:1.9.1', and its busybox container image to 'busybox'.
+ kubectl set image deployment/nginx busybox=busybox nginx=nginx:1.9.1
+
+ # Update all deployments' and rc's nginx container's image to 'nginx:1.9.1'
+ kubectl set image deployments,rc nginx=nginx:1.9.1 --all
+
+ # Update image of all containers of daemonset abc to 'nginx:1.9.1'
+ kubectl set image daemonset abc *=nginx:1.9.1
+
+ # Print result (in yaml format) of updating nginx container image from local file, without hitting the server
+ kubectl set image -f path/to/file.yaml nginx=nginx:1.9.1 --local -o yaml
```
### Options
```
--all select all resources in the namespace of the specified resource types
- -f, --filename value Filename, directory, or URL to a file identifying the resource to get from a server. (default [])
+ -f, --filename stringSlice Filename, directory, or URL to files identifying the resource to get from a server.
--local If true, set image will NOT contact api-server but run locally.
--no-headers When using the default or custom-column output format, don't print headers.
-o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
@@ -56,37 +54,34 @@ kubectl set image -f path/to/file.yaml nginx=nginx:1.9.1 --local -o yaml
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_set_resources.md b/docs/user-guide/kubectl/kubectl_set_resources.md
new file mode 100644
index 0000000000..880137113d
--- /dev/null
+++ b/docs/user-guide/kubectl/kubectl_set_resources.md
@@ -0,0 +1,92 @@
+---
+---
+## kubectl set resources
+
+update resource requests/limits on objects with pod templates
+
+### Synopsis
+
+
+Specify compute resource requirements (cpu, memory) for any resource that defines a pod template. If a pod is successfully scheduled, it is guaranteed the amount of resource requested, but may burst up to its specified limits.
+
+for each compute resource, if a limit is specified and a request is omitted, the request will default to the limit.
+
+Possible resources include (case insensitive): replicationcontroller, deployment, daemonset, job, replicaset.
+
+```
+kubectl set resources (-f FILENAME | TYPE NAME) ([--limits=LIMITS & --requests=REQUESTS]
+```
+
+### Examples
+
+```
+ # Set a deployments nginx container cpu limits to "200m" and memory to "512Mi"
+ kubectl set resources deployment nginx -c=nginx --limits=cpu=200m,memory=512Mi
+
+ # Set the resource request and limits for all containers in nginx
+ kubectl set resources deployment nginx --limits=cpu=200m,memory=512Mi --requests=cpu=100m,memory=256Mi
+
+ # Remove the resource requests for resources on containers in nginx
+ kubectl set resources deployment nginx --limits=cpu=0,memory=0 --requests=cpu=0,memory=0
+
+ # Print the result (in yaml format) of updating nginx container limits from a local, without hitting the server
+ kubectl set resources -f path/to/file.yaml --limits=cpu=200m,memory=512Mi --local -o yaml
+```
+
+### Options
+
+```
+ --all select all resources in the namespace of the specified resource types
+ -c, --containers string The names of containers in the selected pod templates to change, all containers are selected by default - may use wildcards (default "*")
+ --dry-run If true, only print the object that would be sent, without sending it.
+ -f, --filename stringSlice Filename, directory, or URL to files identifying the resource to get from a server.
+ --limits string The resource requirement requests for this container. For example, 'cpu=100m,memory=256Mi'. Note that server side components may assign requests depending on the server configuration, such as limit ranges.
+ --local If true, set resources will NOT contact api-server but run locally.
+ --no-headers When using the default or custom-column output format, don't print headers.
+ -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
+ --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
+ --record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists.
+ -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
+ --requests string The resource requirement requests for this container. For example, 'cpu=100m,memory=256Mi'. Note that server side components may assign requests depending on the server configuration, such as limit ranges.
+ -l, --selector string Selector (label query) to filter on
+ -a, --show-all When printing, show all resources (default hide terminated pods.)
+ --show-labels When printing, show all labels as the last column (default hide labels column)
+ --sort-by string If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
+ --template string 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].
+```
+
+### Options inherited from parent commands
+
+```
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
+```
+
+
+
+###### Auto generated by spf13/cobra on 13-Dec-2016
+
+
+[]()
+
diff --git a/docs/user-guide/kubectl/kubectl_stop.md b/docs/user-guide/kubectl/kubectl_stop.md
index f46e281c7c..d11142c7ed 100644
--- a/docs/user-guide/kubectl/kubectl_stop.md
+++ b/docs/user-guide/kubectl/kubectl_stop.md
@@ -1,4 +1,5 @@
---
+title: kubectl stop
---
## kubectl stop
@@ -80,10 +81,6 @@ $ kubectl stop -f path/to/resources
###### Auto generated by spf13/cobra on 24-Nov-2015
-
-
-
-
[]()
diff --git a/docs/user-guide/kubectl/kubectl_taint.md b/docs/user-guide/kubectl/kubectl_taint.md
index 3c4bb20b52..6aff265c33 100644
--- a/docs/user-guide/kubectl/kubectl_taint.md
+++ b/docs/user-guide/kubectl/kubectl_taint.md
@@ -1,6 +1,5 @@
---
---
-
## kubectl taint
Update the taints on one or more nodes
@@ -8,14 +7,13 @@ Update the taints on one or more nodes
### Synopsis
-
Update the taints on one or more nodes.
-A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect.
-The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters.
-The value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters.
-The effect must be NoSchedule or PreferNoSchedule.
-Currently taint can only apply to node.
+ * A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect.
+ * The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters.
+ * The value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters.
+ * The effect must be NoSchedule or PreferNoSchedule.
+ * Currently taint can only apply to node.
```
kubectl taint NODE NAME KEY_1=VAL_1:TAINT_EFFECT_1 ... KEY_N=VAL_N:TAINT_EFFECT_N
@@ -24,23 +22,21 @@ kubectl taint NODE NAME KEY_1=VAL_1:TAINT_EFFECT_1 ... KEY_N=VAL_N:TAINT_EFFECT_
### Examples
```
-
-# Update node 'foo' with a taint with key 'dedicated' and value 'special-user' and effect 'NoSchedule'.
-# If a taint with that key and effect already exists, its value is replaced as specified.
-kubectl taint nodes foo dedicated=special-user:NoSchedule
-
-# Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists.
-kubectl taint nodes foo dedicated:NoSchedule-
-
-# Remove from node 'foo' all the taints with key 'dedicated'
-kubectl taint nodes foo dedicated-
+ # Update node 'foo' with a taint with key 'dedicated' and value 'special-user' and effect 'NoSchedule'.
+ # If a taint with that key and effect already exists, its value is replaced as specified.
+ kubectl taint nodes foo dedicated=special-user:NoSchedule
+
+ # Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists.
+ kubectl taint nodes foo dedicated:NoSchedule-
+
+ # Remove from node 'foo' all the taints with key 'dedicated'
+ kubectl taint nodes foo dedicated-
```
### Options
```
--all select all nodes in the cluster
- --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true)
--no-headers When using the default or custom-column output format, don't print headers.
-o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
--output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
@@ -57,37 +53,34 @@ kubectl taint nodes foo dedicated-
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_top-node.md b/docs/user-guide/kubectl/kubectl_top-node.md
deleted file mode 100644
index 8005933965..0000000000
--- a/docs/user-guide/kubectl/kubectl_top-node.md
+++ /dev/null
@@ -1,14 +0,0 @@
----
----
-
-This file is autogenerated, but we've stopped checking such files into the
-repository to reduce the need for rebases. Please run hack/generate-docs.sh to
-populate this file.
-
-
-
-
-
-
-[]()
-
diff --git a/docs/user-guide/kubectl/kubectl_top-pod.md b/docs/user-guide/kubectl/kubectl_top-pod.md
deleted file mode 100644
index 329174b0d9..0000000000
--- a/docs/user-guide/kubectl/kubectl_top-pod.md
+++ /dev/null
@@ -1,14 +0,0 @@
----
----
-
-This file is autogenerated, but we've stopped checking such files into the
-repository to reduce the need for rebases. Please run hack/generate-docs.sh to
-populate this file.
-
-
-
-
-
-
-[]()
-
diff --git a/docs/user-guide/kubectl/kubectl_top.md b/docs/user-guide/kubectl/kubectl_top.md
index 8721c3fa41..fbbf5aa477 100644
--- a/docs/user-guide/kubectl/kubectl_top.md
+++ b/docs/user-guide/kubectl/kubectl_top.md
@@ -1,6 +1,5 @@
---
---
-
## kubectl top
Display Resource (CPU/Memory/Storage) usage
@@ -8,7 +7,6 @@ Display Resource (CPU/Memory/Storage) usage
### Synopsis
-
Display Resource (CPU/Memory/Storage) usage.
The top command allows you to see the resource consumption for nodes or pods.
@@ -20,37 +18,34 @@ kubectl top
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_top_node.md b/docs/user-guide/kubectl/kubectl_top_node.md
index 70737e905e..5864e5b820 100644
--- a/docs/user-guide/kubectl/kubectl_top_node.md
+++ b/docs/user-guide/kubectl/kubectl_top_node.md
@@ -1,6 +1,5 @@
---
---
-
## kubectl top node
Display Resource (CPU/Memory/Storage) usage of nodes
@@ -8,7 +7,6 @@ Display Resource (CPU/Memory/Storage) usage of nodes
### Synopsis
-
Display Resource (CPU/Memory/Storage) usage of nodes.
The top-node command allows you to see the resource consumption of nodes.
@@ -20,12 +18,11 @@ kubectl top node [NAME | -l label]
### Examples
```
-
-# Show metrics for all nodes
-kubectl top node
-
-# Show metrics for a given node
-kubectl top node NODE_NAME
+ # Show metrics for all nodes
+ kubectl top node
+
+ # Show metrics for a given node
+ kubectl top node NODE_NAME
```
### Options
@@ -37,37 +34,34 @@ kubectl top node NODE_NAME
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_top_pod.md b/docs/user-guide/kubectl/kubectl_top_pod.md
index 04cf73524f..d0d596de76 100644
--- a/docs/user-guide/kubectl/kubectl_top_pod.md
+++ b/docs/user-guide/kubectl/kubectl_top_pod.md
@@ -1,6 +1,5 @@
---
---
-
## kubectl top pod
Display Resource (CPU/Memory/Storage) usage of pods
@@ -8,13 +7,11 @@ Display Resource (CPU/Memory/Storage) usage of pods
### Synopsis
-
Display Resource (CPU/Memory/Storage) usage of pods.
The 'top pod' command allows you to see the resource consumption of pods.
-Due to the metrics pipeline delay, they may be unavailable for a few minutes
-since pod creation.
+Due to the metrics pipeline delay, they may be unavailable for a few minutes since pod creation.
```
kubectl top pod [NAME | -l label]
@@ -23,18 +20,17 @@ kubectl top pod [NAME | -l label]
### Examples
```
-
-# Show metrics for all pods in the default namespace
-kubectl top pod
-
-# Show metrics for all pods in the given namespace
-kubectl top pod --namespace=NAMESPACE
-
-# Show metrics for a given pod and its containers
-kubectl top pod POD_NAME --containers
-
-# Show metrics for the pods defined by label name=myLabel
-kubectl top pod -l name=myLabel
+ # Show metrics for all pods in the default namespace
+ kubectl top pod
+
+ # Show metrics for all pods in the given namespace
+ kubectl top pod --namespace=NAMESPACE
+
+ # Show metrics for a given pod and its containers
+ kubectl top pod POD_NAME --containers
+
+ # Show metrics for the pods defined by label name=myLabel
+ kubectl top pod -l name=myLabel
```
### Options
@@ -48,37 +44,34 @@ kubectl top pod -l name=myLabel
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_uncordon.md b/docs/user-guide/kubectl/kubectl_uncordon.md
index 8e1722f223..ce4dcc38ab 100644
--- a/docs/user-guide/kubectl/kubectl_uncordon.md
+++ b/docs/user-guide/kubectl/kubectl_uncordon.md
@@ -1,4 +1,5 @@
---
+title: kubectl uncordon
---
## kubectl uncordon
@@ -8,10 +9,8 @@ Mark node as schedulable
### Synopsis
-
Mark node as schedulable.
-
```
kubectl uncordon NODE
```
@@ -19,46 +18,41 @@ kubectl uncordon NODE
### Examples
```
-
-# Mark node "foo" as schedulable.
-$ kubectl uncordon foo
-
+ # Mark node "foo" as schedulable.
+ $ kubectl uncordon foo
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/kubectl/kubectl_version.md b/docs/user-guide/kubectl/kubectl_version.md
index 66e582c4c7..a86115d790 100644
--- a/docs/user-guide/kubectl/kubectl_version.md
+++ b/docs/user-guide/kubectl/kubectl_version.md
@@ -1,4 +1,5 @@
---
+title: kubectl version
---
## kubectl version
@@ -18,42 +19,40 @@ kubectl version
```
--client Client version only (no server required).
+ --short Print just the version number.
```
### Options inherited from parent commands
```
- --alsologtostderr value log to standard error as well as files
- --as string Username to impersonate for the operation
- --certificate-authority string Path to a cert. file for the certificate authority
- --client-certificate string Path to a client certificate file for TLS
- --client-key string Path to a client key file for TLS
- --cluster string The name of the kubeconfig cluster to use
- --context string The name of the kubeconfig context to use
- --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- --kubeconfig string Path to the kubeconfig file to use for CLI requests.
- --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0)
- --log-dir value If non-empty, write log files in this directory
- --logtostderr value log to standard error instead of files
- --match-server-version Require server version to match client version
- -n, --namespace string If present, the namespace scope for this CLI request
- --password string Password for basic authentication to the API server
- -s, --server string The address and port of the Kubernetes API server
- --stderrthreshold value logs at or above this threshold go to stderr (default 2)
- --token string Bearer token for authentication to the API server
- --user string The name of the kubeconfig user to use
- --username string Username for basic authentication to the API server
- -v, --v value log level for V logs
- --vmodule value comma-separated list of pattern=N settings for file-filtered logging
+ --alsologtostderr log to standard error as well as files
+ --as string Username to impersonate for the operation
+ --certificate-authority string Path to a cert. file for the certificate authority
+ --client-certificate string Path to a client certificate file for TLS
+ --client-key string Path to a client key file for TLS
+ --cluster string The name of the kubeconfig cluster to use
+ --context string The name of the kubeconfig context to use
+ --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
+ --kubeconfig string Path to the kubeconfig file to use for CLI requests.
+ --log-backtrace-at traceLocation when logging hits line file:N, emit a stack trace (default :0)
+ --log-dir string If non-empty, write log files in this directory
+ --logtostderr log to standard error instead of files
+ --match-server-version Require server version to match client version
+ -n, --namespace string If present, the namespace scope for this CLI request
+ --password string Password for basic authentication to the API server
+ --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
+ -s, --server string The address and port of the Kubernetes API server
+ --stderrthreshold severity logs at or above this threshold go to stderr (default 2)
+ --token string Bearer token for authentication to the API server
+ --user string The name of the kubeconfig user to use
+ --username string Username for basic authentication to the API server
+ -v, --v Level log level for V logs
+ --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
```
-###### Auto generated by spf13/cobra on 24-Oct-2016
-
-
-
-
+###### Auto generated by spf13/cobra on 13-Dec-2016
[]()
diff --git a/docs/user-guide/labels.md b/docs/user-guide/labels.md
index 583af0b806..a13e160089 100644
--- a/docs/user-guide/labels.md
+++ b/docs/user-guide/labels.md
@@ -1,7 +1,7 @@
---
assignees:
- mikedanese
-
+title: Labels and Selectors
---
_Labels_ are key/value pairs that are attached to objects, such as pods.
diff --git a/docs/user-guide/liveness/index.md b/docs/user-guide/liveness/index.md
index 44272f28ae..5e77f07768 100644
--- a/docs/user-guide/liveness/index.md
+++ b/docs/user-guide/liveness/index.md
@@ -2,7 +2,7 @@
assignees:
- mikedanese
- thockin
-
+title: Checking Pod Health
---
This example shows two types of pod [health checks](/docs/user-guide/production-pods/#liveness-and-readiness-probes-aka-health-checks): HTTP checks and container execution checks.
diff --git a/docs/user-guide/load-balancer.md b/docs/user-guide/load-balancer.md
index 5299029787..fadeb38d5f 100644
--- a/docs/user-guide/load-balancer.md
+++ b/docs/user-guide/load-balancer.md
@@ -1,5 +1,5 @@
---
-
+title: Creating an External Load Balancer
---
* TOC
@@ -93,7 +93,7 @@ Due to the implementation of this feature, the source IP for sessions as seen in
that will preserve the client Source IP for GCE/GKE environments. This feature will be phased in for other cloud providers in subsequent releases.
## Annotation to modify the LoadBalancer behavior for preservation of Source IP
-In 1.5, an Beta feature has been added that changes the behavior of the external LoadBalancer feature.
+In 1.5, a Beta feature has been added that changes the behavior of the external LoadBalancer feature.
This feature can be activated by adding the beta annotation below to the metadata section of the Service Configuration file.
diff --git a/docs/user-guide/logging.md b/docs/user-guide/logging.md
index d329016c7b..5df73928e0 100644
--- a/docs/user-guide/logging.md
+++ b/docs/user-guide/logging.md
@@ -1,7 +1,7 @@
---
assignees:
- mikedanese
-
+title: Retrieving Logs
---
This page is designed to help you use logs to troubleshoot issues with your Kubernetes solution.
diff --git a/docs/user-guide/managing-deployments.md b/docs/user-guide/managing-deployments.md
index a2e32c4b6c..fc32a5bb46 100644
--- a/docs/user-guide/managing-deployments.md
+++ b/docs/user-guide/managing-deployments.md
@@ -3,8 +3,9 @@ assignees:
- bgrant0607
- janetkuo
- mikedanese
-
+title: Managing Resources
---
+
You've deployed your application and exposed it via a service. Now what? Kubernetes provides a number of tools to help you manage your application deployment, including scaling and updating. Among the features we'll discuss in more depth are [configuration files](/docs/user-guide/configuring-containers/#configuration-in-kubernetes) and [labels](/docs/user-guide/deploying-applications/#labels).
You can find all the files for this example [in our docs
@@ -79,7 +80,7 @@ service "my-nginx-svc" deleted
Because `kubectl` outputs resource names in the same syntax it accepts, it's easy to chain operations using `$()` or `xargs`:
```shell
-$ kubectl get $(k create -f docs/user-guide/nginx/ -o name | grep service)
+$ kubectl get $(kubectl create -f docs/user-guide/nginx/ -o name | grep service)
NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE
my-nginx-svc 10.0.0.208 80/TCP 0s
```
@@ -395,7 +396,7 @@ spec:
The patch is specified using json.
-The system ensures that you don’t clobber changes made by other users or components by confirming that the `resourceVersion` doesn’t differ from the version you edited. If you want to update regardless of other changes, remove the `resourceVersion` field when you edit the resource. However, if you do this, don’t use your original configuration file as the source since additional fields most likely were set in the live state.
+The system ensures that you don't clobber changes made by other users or components by confirming that the `resourceVersion` doesn't differ from the version you edited. If you want to update regardless of other changes, remove the `resourceVersion` field when you edit the resource. However, if you do this, don't use your original configuration file as the source since additional fields most likely were set in the live state.
For more information, please see [kubectl patch](/docs/user-guide/kubectl/kubectl_patch/) document.
diff --git a/docs/user-guide/monitoring.md b/docs/user-guide/monitoring.md
index 0c5f673708..9bf778124b 100644
--- a/docs/user-guide/monitoring.md
+++ b/docs/user-guide/monitoring.md
@@ -1,7 +1,7 @@
---
assignees:
- mikedanese
-
+title: Resource Usage Monitoring
---
Understanding how an application behaves when deployed is crucial to scaling the application and providing a reliable service. In a Kubernetes cluster, application performance can be examined at many different levels: containers, [pods](/docs/user-guide/pods), [services](/docs/user-guide/services), and whole clusters. As part of Kubernetes we want to provide users with detailed resource usage information about their running applications at all these levels. This will give users deep insights into how their applications are performing and where possible application bottlenecks may be found. In comes [Heapster](https://github.com/kubernetes/heapster), a project meant to provide a base monitoring platform on Kubernetes.
diff --git a/docs/user-guide/namespaces.md b/docs/user-guide/namespaces.md
index 8fc9ac4735..d162139358 100644
--- a/docs/user-guide/namespaces.md
+++ b/docs/user-guide/namespaces.md
@@ -3,7 +3,7 @@ assignees:
- derekwaynecarr
- mikedanese
- thockin
-
+title: Namespaces
---
Kubernetes supports multiple virtual clusters backed by the same physical cluster.
@@ -89,7 +89,7 @@ across namespaces, you need to use the fully qualified domain name (FQDN).
## Not All Objects are in a Namespace
-Most kubernetes resources (e.g. pods, services, replication controllers, and others) are
+Most Kubernetes resources (e.g. pods, services, replication controllers, and others) are
in some namespace. However namespace resources are not themselves in a namespace.
And low-level resources, such as [nodes](/docs/admin/node) and
persistentVolumes, are not in any namespace. Events are an exception: they may or may not
diff --git a/docs/user-guide/networkpolicies.md b/docs/user-guide/networkpolicies.md
index 7cd7ee0765..1c8575d4ab 100644
--- a/docs/user-guide/networkpolicies.md
+++ b/docs/user-guide/networkpolicies.md
@@ -2,7 +2,7 @@
assignees:
- thockin
- caseydavenport
-
+title: Network Policies
---
* TOC
diff --git a/docs/user-guide/node-selection/index.md b/docs/user-guide/node-selection/index.md
index 725848b544..b2f13bd5ae 100644
--- a/docs/user-guide/node-selection/index.md
+++ b/docs/user-guide/node-selection/index.md
@@ -2,11 +2,9 @@
assignees:
- davidopp
- kevin-wangzefeng
-
+title: Assigning Pods to Nodes
---
-# Constraining pods to run on particular nodes
-
You can constrain a [pod](/docs/user-guide/pods/) to only be able to run on particular [nodes](/docs/admin/node/) or to prefer to
run on particular nodes. There are several ways to do this, and they all use
[label selectors](/docs/user-guide/labels/) to make the selection.
diff --git a/docs/user-guide/persistent-volumes/index.md b/docs/user-guide/persistent-volumes/index.md
index 082722a829..e5091d1b9c 100644
--- a/docs/user-guide/persistent-volumes/index.md
+++ b/docs/user-guide/persistent-volumes/index.md
@@ -4,7 +4,7 @@ assignees:
- mikedanese
- saad-ali
- thockin
-
+title: Persistent Volumes
---
This document describes the current state of `PersistentVolumes` in Kubernetes. Familiarity with [volumes](/docs/user-guide/volumes/) is suggested.
@@ -18,7 +18,7 @@ Managing storage is a distinct problem from managing compute. The `PersistentVol
A `PersistentVolume` (PV) is a piece of networked storage in the cluster that has been provisioned by an administrator. It is a resource in the cluster just like a node is a cluster resource. PVs are volume plugins like Volumes, but have a lifecycle independent of any individual pod that uses the PV. This API object captures the details of the implementation of the storage, be that NFS, iSCSI, or a cloud-provider-specific storage system.
-A `PersistentVolumeClaim` (PVC) is a request for storage by a user. It is similar to a pod. Pods consume node resources and PVCs consume PV resources. Pods can request specific levels of resources (CPU and Memory). Claims can request specific size and access modes (e.g, can be mounted once read/write or many times read-only).
+A `PersistentVolumeClaim` (PVC) is a request for storage by a user. It is similar to a pod. Pods consume node resources and PVCs consume PV resources. Pods can request specific levels of resources (CPU and Memory). Claims can request specific size and access modes (e.g., can be mounted once read/write or many times read-only).
While `PersistentVolumeClaims` allow a user to consume abstract storage
resources, it is common that users need `PersistentVolumes` with varying
@@ -70,7 +70,36 @@ When a user is done with their volume, they can delete the PVC objects from the
### Reclaiming
-The reclaim policy for a `PersistentVolume` tells the cluster what to do with the volume after it has been released of its claim. Currently, volumes can either be Retained, Recycled or Deleted. Retention allows for manual reclamation of the resource. For those volume plugins that support it, deletion removes both the `PersistentVolume` object from Kubernetes as well as deletes associated storage asset in external infrastructure such as AWS EBS, GCE PD or Cinder volume. Volumes that were dynamically provisioned are always deleted. If supported by appropriate volume plugin, recycling performs a basic scrub (`rm -rf /thevolume/*`) on the volume and makes it available again for a new claim.
+The reclaim policy for a `PersistentVolume` tells the cluster what to do with the volume after it has been released of its claim. Currently, volumes can either be Retained, Recycled or Deleted. Retention allows for manual reclamation of the resource. For those volume plugins that support it, deletion removes both the `PersistentVolume` object from Kubernetes, as well as deleting the associated storage asset in external infrastructure (such as an AWS EBS, GCE PD, Azure Disk, or Cinder volume). Volumes that were dynamically provisioned are always deleted.
+
+#### Recycling
+
+If supported by appropriate volume plugin, recycling performs a basic scrub (`rm -rf /thevolume/*`) on the volume and makes it available again for a new claim.
+
+However, an administrator can configure a custom recycler pod templates using the Kubernetes controller manager command line arguments as described [here](/docs/admin/kube-controller-manager/). The custom recycler pod template must contain a `volumes` specification, as shown in the example below:
+
+```yaml
+apiVersion: v1
+kind: Pod
+metadata:
+ name: pv-recycler-
+ namespace: default
+spec:
+ restartPolicy: Never
+ volumes:
+ - name: vol
+ hostPath:
+ path: /any/path/it/will/be/replaced
+ containers:
+ - name: pv-recycler
+ image: "gcr.io/google_containers/busybox"
+ command: ["/bin/sh", "-c", "test -e /scrub && rm -rf /scrub/..?* /scrub/.[!.]* /scrub/* && test -z \"$(ls -A /scrub)\" || exit 1"]
+ volumeMounts:
+ - name: vol
+ mountPath: /scrub
+```
+
+However, the particular path specified in the custom recycler pod template in the `volumes` part is replaced with the particular path of the volume that is being recycled.
## Types of Persistent Volumes
@@ -79,6 +108,7 @@ The reclaim policy for a `PersistentVolume` tells the cluster what to do with th
* GCEPersistentDisk
* AWSElasticBlockStore
* AzureFile
+* AzureDisk
* FC (Fibre Channel)
* NFS
* iSCSI
@@ -141,6 +171,7 @@ In the CLI, the access modes are abbreviated to:
| :--- | :---: | :---: | :---: |
| AWSElasticBlockStore | x | - | - |
| AzureFile | x | x | x |
+| AzureDisk | x | - | - |
| CephFS | x | x | x |
| Cinder | x | - | - |
| FC | x | x | - |
@@ -164,15 +195,15 @@ class and can only be bound to PVCs that request no particular class.
In the future after beta, the `volume.beta.kubernetes.io/storage-class`
annotation will become an attribute.
-### Recycling Policy
+### Reclaim Policy
-Current recycling policies are:
+Current reclaim policies are:
* Retain -- manual reclamation
* Recycle -- basic scrub ("rm -rf /thevolume/*")
-* Delete -- associated storage asset such as AWS EBS, GCE PD or OpenStack Cinder volume is deleted
+* Delete -- associated storage asset such as AWS EBS, GCE PD, Azure Disk, or OpenStack Cinder volume is deleted
-Currently, only NFS and HostPath support recycling. AWS EBS, GCE PD and Cinder volumes support deletion.
+Currently, only NFS and HostPath support recycling. AWS EBS, GCE PD, Azure Disk, and Cinder volumes support deletion.
### Phase
@@ -468,7 +499,7 @@ parameters:
```
* `quobyteAPIServer`: API Server of Quobyte in the format `http(s)://api-server:7860`
-* `registry`: Quobyte registry to use to mount the volume. You can specifiy the registry as ``:`` pair or if you want to specify multiple registries you just have to put a comma between them e.q. ``:,:,:``. The host can be an IP address or if you have a working DNS you can also provide the DNS names.
+* `registry`: Quobyte registry to use to mount the volume. You can specify the registry as ``:`` pair or if you want to specify multiple registries you just have to put a comma between them e.q. ``:,:,:``. The host can be an IP address or if you have a working DNS you can also provide the DNS names.
* `adminSecretNamespace`: The namespace for `adminSecretName`. Default is "default".
* `adminSecretName`: secret that holds information about the Quobyte user and the password to authenticate agains the API server. The provided secret must have type "kubernetes.io/quobyte", e.g. created in this way:
```
@@ -479,6 +510,24 @@ parameters:
* `quobyteConfig`: use the specified configuration to create the volume. You can create a new configuration or modify an existing one with the Web console or the quobyte CLI. Default is "BASE".
* `quobyteTenant`: use the specified tenant ID to create/delete the volume. This Quobyte tenant has to be already present in Quobyte. Default is "DEFAULT".
+#### Azure Disk
+
+```yaml
+kind: StorageClass
+apiVersion: storage.k8s.io/v1beta1
+metadata:
+ name: slow
+provisioner: kubernetes.io/azure-disk
+parameters:
+ skuName: Standard_LRS
+ location: eastus
+ storageAccount: azure_storage_account_name
+```
+
+* `skuName`: Azure storage account Sku tier. Default is empty.
+* `location`: Azure storage account location. Default is empty.
+* `storageAccount`: Azure storage account name. If storage account is not provided, all storage accounts associated with the resource group are searched to find one that matches `skuName` and `location`. If storage account is provided, `skuName` and `location` are ignored.
+
## Writing Portable Configuration
diff --git a/docs/user-guide/persistent-volumes/walkthrough.md b/docs/user-guide/persistent-volumes/walkthrough.md
index c82a37f7d0..d1cd6a5812 100644
--- a/docs/user-guide/persistent-volumes/walkthrough.md
+++ b/docs/user-guide/persistent-volumes/walkthrough.md
@@ -2,7 +2,7 @@
assignees:
- jsafrane
- saad-ali
-
+title: Persistent Volumes Walkthrough
---
The purpose of this guide is to help you become familiar with [Kubernetes Persistent Volumes](/docs/user-guide/persistent-volumes/). By the end of the guide, we'll have
diff --git a/docs/user-guide/petset.md b/docs/user-guide/petset.md
index 6c205159bc..3247cf5a42 100644
--- a/docs/user-guide/petset.md
+++ b/docs/user-guide/petset.md
@@ -7,7 +7,7 @@ assignees:
- janetkuo
- kow3ns
- smarterclayton
-
+title: Pet Sets
---
__Warning:__ Starting in Kubernetes version 1.5, PetSet has been renamed to
@@ -28,8 +28,8 @@ Throughout this doc you will see a few terms that are sometimes used interchange
* Node: A single virtual or physical machine in a Kubernetes cluster.
* Cluster: A group of nodes in a single failure domain, unless mentioned otherwise.
* Persistent Volume Claim (PVC): A request for storage, typically a [persistent volume](/docs/user-guide/persistent-volumes/walkthrough/).
-* Host name: The hostname attached to the UTS namespace of the pod, i.e the output of `hostname` in the pod.
-* DNS/Domain name: A *cluster local* domain name resolvable using standard methods (eg: [gethostbyname](http://linux.die.net/man/3/gethostbyname)).
+* Host name: The hostname attached to the UTS namespace of the pod, i.e. the output of `hostname` in the pod.
+* DNS/Domain name: A *cluster local* domain name resolvable using standard methods (e.g.: [gethostbyname](http://linux.die.net/man/3/gethostbyname)).
* Ordinality: the property of being "ordinal", or occupying a position in a sequence.
* Pet: a single member of a PetSet; more generally, a stateful application.
* Peer: a process running a server, capable of communicating with other such processes.
@@ -88,7 +88,7 @@ Only use PetSet if your application requires some or all of these properties. Ma
Example workloads for PetSet:
-* Databases like MySQL or PostgreSQL that require a single instance attached to a NFS persistent volume at any time
+* Databases like MySQL or PostgreSQL that require a single instance attached to an NFS persistent volume at any time
* Clustered software like Zookeeper, Etcd, or Elasticsearch that require stable membership.
## Alpha limitations
@@ -303,7 +303,7 @@ NAME DESIRED CURRENT AGE
web 5 5 30m
```
-Note however, that scaling up to N and back down to M *will not* delete the volumes of the M-N pets, as described in the section on [deletion](#deleting-a-petset), i.e scaling back up to M creates new pets that use the same volumes. To see this in action, scale the PetSet back down to 3:
+Note however, that scaling up to N and back down to M *will not* delete the volumes of the M-N pets, as described in the section on [deletion](#deleting-a-petset), i.e. scaling back up to M creates new pets that use the same volumes. To see this in action, scale the PetSet back down to 3:
```shell
$ kubectl get po --watch-only
diff --git a/docs/user-guide/petset/bootstrapping/index.md b/docs/user-guide/petset/bootstrapping/index.md
index 32e1bfed93..de3ccb4bd8 100644
--- a/docs/user-guide/petset/bootstrapping/index.md
+++ b/docs/user-guide/petset/bootstrapping/index.md
@@ -7,6 +7,7 @@ assignees:
- janetkuo
- kow3ns
- smarterclayton
+title: Bootstrapping Pet Sets
---
__Warning:__ Starting in Kubernetes version 1.5, PetSet has been renamed to [StatefulSet](/docs/concepts/abstractions/controllers/statefulsets). To use (or continue to use) PetSet in Kubernetes 1.5, you _must_ [migrate](/docs/tasks/manage-stateful-set/upgrade-pet-set-to-stateful-set/) your existing PetSets to StatefulSets. For information on working with StatefulSet, see the tutorial on [how to run replicated stateful applications](/docs/tutorials/stateful-application/run-replicated-stateful-application).
diff --git a/docs/user-guide/pod-security-policy/index.md b/docs/user-guide/pod-security-policy/index.md
index 6fb1d4cebf..6a756c4766 100644
--- a/docs/user-guide/pod-security-policy/index.md
+++ b/docs/user-guide/pod-security-policy/index.md
@@ -1,19 +1,19 @@
---
assignees:
- pweil-
-
+title: Pod Security Policies
---
Objects of type `podsecuritypolicy` govern the ability
to make requests on a pod that affect the `SecurityContext` that will be
-applied to a pod and container.
+applied to a pod and container.
See [PodSecurityPolicy proposal](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/proposals/security-context-constraints.md) for more information.
* TOC
{:toc}
-## What is a _Pod Security Policy_?
+## What is a Pod Security Policy?
A _Pod Security Policy_ is a cluster-level resource that controls the
actions that a pod can perform and what it has the ability to access. The
@@ -26,7 +26,7 @@ administrator to control the following:
1. The SELinux context of the container.
1. The user ID.
1. The use of host namespaces and networking.
-1. Allocating an FSGroup that owns the pod’s volumes
+1. Allocating an FSGroup that owns the pod's volumes
1. Configuring allowable supplemental groups
1. Requiring the use of a read only root file system
1. Controlling the usage of volume types
@@ -156,3 +156,8 @@ following
1. You have enabled the api type `extensions/v1beta1/podsecuritypolicy`
1. You have enabled the admission controller `PodSecurityPolicy`
1. You have defined your policies
+
+## Working With RBAC
+
+Use PodSecurityPolicy to control access to privileged containers based on role and groups.
+(see [more details](https://github.com/kubernetes/kubernetes/blob/master/examples/podsecuritypolicy/rbac/README.md)).
diff --git a/docs/user-guide/pod-states.md b/docs/user-guide/pod-states.md
index 8f745e9f56..462f8b65bd 100644
--- a/docs/user-guide/pod-states.md
+++ b/docs/user-guide/pod-states.md
@@ -1,7 +1,7 @@
---
assignees:
- mikedanese
-
+title: The Lifecycle of a Pod
---
Updated: 4/14/2015
diff --git a/docs/user-guide/pods/index.md b/docs/user-guide/pods/index.md
index b8a5b65bcc..321900c948 100644
--- a/docs/user-guide/pods/index.md
+++ b/docs/user-guide/pods/index.md
@@ -1,6 +1,6 @@
---
-assignees:
-
+assignees:
+title: Pods
---
* TOC
@@ -10,7 +10,7 @@ assignees:
_pods_ are the smallest deployable units of computing that can be created and
managed in Kubernetes.
-## What is a _pod_?
+## What is a Pod?
A _pod_ (as in a pod of whales or pea pod) is a group of one or more containers
(such as Docker containers), the shared storage for those containers, and
@@ -178,9 +178,9 @@ Force deletions can be potentially dangerous for some pods and should be perform
## Privileged mode for pod containers
-From kubernetes v1.1, any container in a pod can enable privileged mode, using the `privileged` flag on the `SecurityContext` of the container spec. This is useful for containers that want to use linux capabilities like manipulating the network stack and accessing devices. Processes within the container get almost the same privileges that are available to processes outside a container. With privileged mode, it should be easier to write network and volume plugins as separate pods that don't need to be compiled into the kubelet.
+From Kubernetes v1.1, any container in a pod can enable privileged mode, using the `privileged` flag on the `SecurityContext` of the container spec. This is useful for containers that want to use linux capabilities like manipulating the network stack and accessing devices. Processes within the container get almost the same privileges that are available to processes outside a container. With privileged mode, it should be easier to write network and volume plugins as separate pods that don't need to be compiled into the kubelet.
-If the master is running kubernetes v1.1 or higher, and the nodes are running a version lower than v1.1, then new privileged pods will be accepted by api-server, but will not be launched. They will be pending state.
+If the master is running Kubernetes v1.1 or higher, and the nodes are running a version lower than v1.1, then new privileged pods will be accepted by api-server, but will not be launched. They will be pending state.
If user calls `kubectl describe pod FooPodName`, user can see the reason why the pod is in pending state. The events table in the describe command output will say:
`Error validating pod "FooPodName"."FooPodNamespace" from api, ignoring: spec.containers[0].securityContext.privileged: forbidden '<*>(0xc2089d3248)true'`
@@ -191,6 +191,6 @@ spec.containers[0].securityContext.privileged: forbidden '<*>(0xc20b222db0)true'
## API Object
-Pod is a top-level resource in the kubernetes REST API. More details about the
+Pod is a top-level resource in the Kubernetes REST API. More details about the
API object can be found at: [Pod API
object](/docs/api-reference/v1/definitions/#_v1_pod).
diff --git a/docs/user-guide/pods/init-container.md b/docs/user-guide/pods/init-container.md
index 75b6efcac3..e5319b7018 100644
--- a/docs/user-guide/pods/init-container.md
+++ b/docs/user-guide/pods/init-container.md
@@ -105,7 +105,7 @@ If the pod is [restarted](#pod-restart-reasons) all init containers must
execute again.
Changes to the init container spec are limited to the container image field.
-Altering a init container image field is equivalent to restarting the pod.
+Altering an init container image field is equivalent to restarting the pod.
Because init containers can be restarted, retried, or reexecuted, init container
code should be idempotent. In particular, code that writes to files on EmptyDirs
@@ -159,7 +159,7 @@ reasons:
* This is uncommon and would have to be done by someone with root access to nodes.
* All containers in a pod are terminated, requiring a restart (RestartPolicyAlways) AND the record of init container completion has been lost due to garbage collection.
-## Support and compatibilty
+## Support and compatibility
A cluster with Kubelet and Apiserver version 1.4.0 or greater supports init
containers with the beta annotations. Support varies for other combinations of
diff --git a/docs/user-guide/pods/multi-container.md b/docs/user-guide/pods/multi-container.md
index 6c166af20d..55e0e56f84 100644
--- a/docs/user-guide/pods/multi-container.md
+++ b/docs/user-guide/pods/multi-container.md
@@ -1,7 +1,7 @@
---
assignees:
- janetkuo
-
+title: Creating Multi-Container Pods
---
* TOC
diff --git a/docs/user-guide/pods/single-container.md b/docs/user-guide/pods/single-container.md
index 605534acda..4fef42a2f9 100644
--- a/docs/user-guide/pods/single-container.md
+++ b/docs/user-guide/pods/single-container.md
@@ -1,7 +1,7 @@
---
assignees:
- janetkuo
-
+title: Creating Single-Container Pods
---
* TOC
@@ -73,7 +73,7 @@ There are additional flags that can be specified. For a complete list, run:
## Deleting a pod
-If your pod was created using the `run` command, kubernetes creates a
+If your pod was created using the `run` command, Kubernetes creates a
[Deployment](/docs/user-guide/deployments/)
to manage the pod. Pods managed by a Deployment are rescheduled if
they go away, including being deleted by `kubectl delete pod`. To permanently
diff --git a/docs/user-guide/prereqs.md b/docs/user-guide/prereqs.md
index 1902e3315a..19e6d8612b 100644
--- a/docs/user-guide/prereqs.md
+++ b/docs/user-guide/prereqs.md
@@ -2,10 +2,10 @@
assignees:
- bgrant0607
- mikedanese
-
+title: Installing and Setting up kubectl
---
-To deploy and manage applications on Kubernetes, you’ll use the Kubernetes command-line tool, [kubectl](/docs/user-guide/kubectl/). It lets you inspect your cluster resources, create, delete, and update components, and much more. You will use it to look at your new cluster and bring up example apps.
+To deploy and manage applications on Kubernetes, you'll use the Kubernetes command-line tool, [kubectl](/docs/user-guide/kubectl/). It lets you inspect your cluster resources, create, delete, and update components, and much more. You will use it to look at your new cluster and bring up example apps.
## Install kubectl Binary Via curl
@@ -32,7 +32,7 @@ sudo mv ./kubectl /usr/local/bin/kubectl
If you downloaded a pre-compiled [release](https://github.com/kubernetes/kubernetes/releases), kubectl will be under `platforms//` from the tar bundle.
-If you compiled kubernetes from source, kubectl should be either under `_output/local/bin//` or `_output/dockerized/bin//`.
+If you compiled Kubernetes from source, kubectl should be either under `_output/local/bin//` or `_output/dockerized/bin//`.
Copy or move kubectl into a directory already in your PATH (e.g. `/usr/local/bin`). For example:
diff --git a/docs/user-guide/production-pods.md b/docs/user-guide/production-pods.md
index e884409b5a..bd3724cc5e 100644
--- a/docs/user-guide/production-pods.md
+++ b/docs/user-guide/production-pods.md
@@ -3,7 +3,7 @@ assignees:
- bgrant0607
- janetkuo
- thockin
-
+title: Working with Containers in Production
---
You've seen [how to configure and deploy pods and containers](/docs/user-guide/configuring-containers), using some of the most common configuration parameters. This section dives into additional features that are especially useful for running applications in production.
diff --git a/docs/user-guide/quick-start.md b/docs/user-guide/quick-start.md
index 9e9e59dbd8..78e43eb1ce 100644
--- a/docs/user-guide/quick-start.md
+++ b/docs/user-guide/quick-start.md
@@ -2,7 +2,7 @@
assignees:
- bgrant0607
- janetkuo
-
+title: Launching, Exposing, and Killing Applications
---
This guide will help you get oriented to Kubernetes and running your first containers on the cluster. If you are already familiar with the docker-cli, you can also checkout the docker-cli to kubectl migration guide [here](/docs/user-guide/docker-cli-to-kubectl).
@@ -28,6 +28,7 @@ To expose your service to the public internet, run:
$ kubectl expose deployment my-nginx --target-port=80 --type=LoadBalancer
service "my-nginx" exposed
```
+Note: The type, LoadBalancer, is highly dependent upon the underlying platform that Kubernetes is running on. If your cloud provider doesn't have a load balancer implementation (e.g. OpenStack) for Kubernetes, you can simply use the allocated [NodePort](http://kubernetes.io/docs/user-guide/services/#type-nodeport) as a rudimentary form of load balancing across your endpoints.
You can see that they are running by:
diff --git a/docs/user-guide/replicasets.md b/docs/user-guide/replicasets.md
index cd7f620b15..ea3e7bde14 100644
--- a/docs/user-guide/replicasets.md
+++ b/docs/user-guide/replicasets.md
@@ -3,23 +3,23 @@ assignees:
- Kashomon
- bprashanth
- madhusudancs
-
+title: Replica Sets
---
* TOC
{:toc}
-## What is a _Replica Set_?
+## What is a ReplicaSet?
-Replica Set is the next-generation Replication Controller. The only difference
-between a _Replica Set_ and a
+ReplicaSet is the next-generation Replication Controller. The only difference
+between a _ReplicaSet_ and a
[_Replication Controller_](/docs/user-guide/replication-controller/) right now is
-the selector support. Replica Set supports the new set-based selector requirements
+the selector support. ReplicaSet supports the new set-based selector requirements
as described in the [labels user guide](/docs/user-guide/labels/#label-selectors)
whereas a Replication Controller only supports equality-based selector requirements.
Most [`kubectl`](/docs/user-guide/kubectl/) commands that support
-Replication Controllers also support Replica Sets. One exception is the
+Replication Controllers also support ReplicaSets. One exception is the
[`rolling-update`](/docs/user-guide/kubectl/kubectl_rolling-update/) command. If
you want the rolling update functionality please consider using Deployments
instead. Also, the
@@ -27,21 +27,21 @@ instead. Also, the
imperative whereas Deployments are declarative, so we recommend using Deployments
through the [`rollout`](/docs/user-guide/kubectl/kubectl_rollout/) command.
-While Replica Sets can be used independently, today it's mainly used by
+While ReplicaSets can be used independently, today it's mainly used by
[Deployments](/docs/user-guide/deployments/) as a mechanism to orchestrate pod
creation, deletion and updates. When you use Deployments you don't have to worry
-about managing the Replica Sets that they create. Deployments own and manage
-their Replica Sets.
+about managing the ReplicaSets that they create. Deployments own and manage
+their ReplicaSets.
-## When to use a Replica Set?
+## When to use a ReplicaSet?
-A Replica Set ensures that a specified number of pod “replicas” are running at any given
-time. However, a Deployment is a higher-level concept that manages Replica Sets and
+A ReplicaSet ensures that a specified number of pod “replicas” are running at any given
+time. However, a Deployment is a higher-level concept that manages ReplicaSets and
provides declarative updates to pods along with a lot of other useful features.
-Therefore, we recommend using Deployments instead of directly using Replica Sets, unless
+Therefore, we recommend using Deployments instead of directly using ReplicaSets, unless
you require custom update orchestration or don't require updates at all.
-This actually means that you may never need to manipulate Replica Set objects:
+This actually means that you may never need to manipulate ReplicaSet objects:
use directly a Deployment and define your application in the spec section.
## Example
@@ -49,7 +49,7 @@ use directly a Deployment and define your application in the spec section.
{% include code.html language="yaml" file="replicasets/frontend.yaml" ghlink="/docs/user-guide/replicasets/frontend.yaml" %}
Saving this config into `frontend.yaml` and submitting it to a Kubernetes cluster should
-create the defined Replica Set and the pods that it manages.
+create the defined ReplicaSet and the pods that it manages.
```shell
$ kubectl create -f frontend.yaml
@@ -76,18 +76,18 @@ frontend-dnjpy 1/1 Running 0 1m
frontend-qhloh 1/1 Running 0 1m
```
-## Replica Set as an Horizontal Pod Autoscaler target
+## ReplicaSet as an Horizontal Pod Autoscaler target
-A Replica Set can also be a target for
+A ReplicaSet can also be a target for
[Horizontal Pod Autoscalers (HPA)](/docs/user-guide/horizontal-pod-autoscaling/),
-i.e. a Replica Set can be auto-scaled by an HPA. Here is an example HPA targeting
-the Replica Set we created in the previous example.
+i.e. a ReplicaSet can be auto-scaled by an HPA. Here is an example HPA targeting
+the ReplicaSet we created in the previous example.
{% include code.html language="yaml" file="replicasets/hpa-rs.yaml" ghlink="/docs/user-guide/replicasets/hpa-rs.yaml" %}
Saving this config into `hpa-rs.yaml` and submitting it to a Kubernetes cluster should
-create the defined HPA that autoscales the target Replica Set depending on the CPU usage
+create the defined HPA that autoscales the target ReplicaSet depending on the CPU usage
of the replicated pods.
```shell
diff --git a/docs/user-guide/replication-controller/index.md b/docs/user-guide/replication-controller/index.md
index 61263d4994..0fee281cdb 100644
--- a/docs/user-guide/replication-controller/index.md
+++ b/docs/user-guide/replication-controller/index.md
@@ -2,36 +2,36 @@
assignees:
- bprashanth
- janetkuo
-
+title: Replication Controller
---
* TOC
{:toc}
-## What is a _replication controller_?
+## What is a ReplicationController?
-A _replication controller_ ensures that a specified number of pod "replicas" are running at any one
-time. In other words, a replication controller makes sure that a pod or homogeneous set of pods are
+A _ReplicationController_ ensures that a specified number of pod "replicas" are running at any one
+time. In other words, a ReplicationController makes sure that a pod or homogeneous set of pods are
always up and available.
If there are too many pods, it will kill some. If there are too few, the
-replication controller will start more. Unlike manually created pods, the pods maintained by a
-replication controller are automatically replaced if they fail, get deleted, or are terminated.
+ReplicationController will start more. Unlike manually created pods, the pods maintained by a
+ReplicationController are automatically replaced if they fail, get deleted, or are terminated.
For example, your pods get re-created on a node after disruptive maintenance such as a kernel upgrade.
-For this reason, we recommend that you use a replication controller even if your application requires
-only a single pod. You can think of a replication controller as something similar to a process supervisor,
-but rather than individual processes on a single node, the replication controller supervises multiple pods
+For this reason, we recommend that you use a ReplicationController even if your application requires
+only a single pod. You can think of a ReplicationController as something similar to a process supervisor,
+but rather than individual processes on a single node, the ReplicationController supervises multiple pods
across multiple nodes.
-Replication Controller is often abbreviated to "rc" or "rcs" in discussion, and as a shortcut in
+ReplicationController is often abbreviated to "rc" or "rcs" in discussion, and as a shortcut in
kubectl commands.
-A simple case is to create 1 Replication Controller object in order to reliably run one instance of
+A simple case is to create 1 ReplicationController object in order to reliably run one instance of
a Pod indefinitely. A more complex use case is to run several identical replicas of a replicated
service, such as web servers.
-## Running an example Replication Controller
+## Running an example ReplicationController
-Here is an example Replication Controller config. It runs 3 copies of the nginx web server.
+Here is an example ReplicationController config. It runs 3 copies of the nginx web server.
{% include code.html language="yaml" file="replication.yaml" ghlink="/docs/user-guide/replication.yaml" %}
@@ -42,7 +42,7 @@ $ kubectl create -f ./replication.yaml
replicationcontrollers/nginx
```
-Check on the status of the replication controller using this command:
+Check on the status of the ReplicationController using this command:
```shell
$ kubectl describe replicationcontrollers/nginx
@@ -79,18 +79,18 @@ echo $pods
nginx-3ntk0 nginx-4ok8v nginx-qrm3m
```
-Here, the selector is the same as the selector for the replication controller (seen in the
+Here, the selector is the same as the selector for the ReplicationController (seen in the
`kubectl describe` output, and in a different form in `replication.yaml`. The `--output=jsonpath` option
specifies an expression that just gets the name from each pod in the returned list.
-## Writing a Replication Controller Spec
+## Writing a ReplicationController Spec
As with all other Kubernetes config, a Job needs `apiVersion`, `kind`, and `metadata` fields. For
general information about working with config files, see [here](/docs/user-guide/simple-yaml/),
[here](/docs/user-guide/configuring-containers/), and [here](/docs/user-guide/working-with-resources/).
-A Replication Controller also needs a [`.spec` section](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel/api-conventions.md#spec-and-status).
+A ReplicationController also needs a [`.spec` section](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel/api-conventions.md#spec-and-status).
### Pod Template
@@ -100,28 +100,28 @@ The `.spec.template` is a [pod template](#pod-template). It has exactly
the same schema as a [pod](/docs/user-guide/pods/), except it is nested and does not have an `apiVersion` or
`kind`.
-In addition to required fields for a Pod, a pod template in a Replication Controller must specify appropriate
+In addition to required fields for a Pod, a pod template in a ReplicationController must specify appropriate
labels (i.e. don't overlap with other controllers, see [pod selector](#pod-selector)) and an appropriate restart policy.
Only a [`.spec.template.spec.restartPolicy`](/docs/user-guide/pod-states/) equal to `Always` is allowed, which is the default
if not specified.
-For local container restarts, replication controllers delegate to an agent on the node,
+For local container restarts, ReplicationControllers delegate to an agent on the node,
for example the [Kubelet](/docs/admin/kubelet/) or Docker.
-### Labels on the Replication Controller
+### Labels on the ReplicationController
-The replication controller can itself have labels (`.metadata.labels`). Typically, you
+The ReplicationController can itself have labels (`.metadata.labels`). Typically, you
would set these the same as the `.spec.template.metadata.labels`; if `.metadata.labels` is not specified
then it is defaulted to `.spec.template.metadata.labels`. However, they are allowed to be
-different, and the `.metadata.labels` do not affect the behavior of the replication controller.
+different, and the `.metadata.labels` do not affect the behavior of the ReplicationController.
### Pod Selector
The `.spec.selector` field is a [label selector](/docs/user-guide/labels/#label-selectors). A replication
controller manages all the pods with labels which match the selector. It does not distinguish
between pods which it created or deleted versus pods which some other person or process created or
-deleted. This allows the replication controller to be replaced without affecting the running pods.
+deleted. This allows the ReplicationController to be replaced without affecting the running pods.
If specified, the `.spec.template.metadata.labels` must be equal to the `.spec.selector`, or it will
be rejected by the API. If `.spec.selector` is unspecified, it will be defaulted to
@@ -144,54 +144,54 @@ shutdown, and a replacement starts early.
If you do not specify `.spec.replicas`, then it defaults to 1.
-## Working with Replication Controllers
+## Working with ReplicationControllers
-### Deleting a Replication Controller and its Pods
+### Deleting a ReplicationController and its Pods
-To delete a replication controller and all its pods, use [`kubectl
-delete`](/docs/user-guide/kubectl/kubectl_delete/). Kubectl will scale the replication controller to zero and wait
-for it to delete each pod before deleting the replication controller itself. If this kubectl
+To delete a ReplicationController and all its pods, use [`kubectl
+delete`](/docs/user-guide/kubectl/kubectl_delete/). Kubectl will scale the ReplicationController to zero and wait
+for it to delete each pod before deleting the ReplicationController itself. If this kubectl
command is interrupted, it can be restarted.
When using the REST API or go client library, you need to do the steps explicitly (scale replicas to
-0, wait for pod deletions, then delete the replication controller).
+0, wait for pod deletions, then delete the ReplicationController).
-### Deleting just a Replication Controller
+### Deleting just a ReplicationController
-You can delete a replication controller without affecting any of its pods.
+You can delete a ReplicationController without affecting any of its pods.
Using kubectl, specify the `--cascade=false` option to [`kubectl delete`](/docs/user-guide/kubectl/kubectl_delete/).
-When using the REST API or go client library, simply delete the replication controller object.
+When using the REST API or go client library, simply delete the ReplicationController object.
-Once the original is deleted, you can create a new replication controller to replace it. As long
+Once the original is deleted, you can create a new ReplicationController to replace it. As long
as the old and new `.spec.selector` are the same, then the new one will adopt the old pods.
However, it will not make any effort to make existing pods match a new, different pod template.
To update pods to a new spec in a controlled way, use a [rolling update](#rolling-updates).
-### Isolating pods from a Replication Controller
+### Isolating pods from a ReplicationController
-Pods may be removed from a replication controller's target set by changing their labels. This technique may be used to remove pods from service for debugging, data recovery, etc. Pods that are removed in this way will be replaced automatically (assuming that the number of replicas is not also changed).
+Pods may be removed from a ReplicationController's target set by changing their labels. This technique may be used to remove pods from service for debugging, data recovery, etc. Pods that are removed in this way will be replaced automatically (assuming that the number of replicas is not also changed).
## Common usage patterns
### Rescheduling
-As mentioned above, whether you have 1 pod you want to keep running, or 1000, a replication controller will ensure that the specified number of pods exists, even in the event of node failure or pod termination (e.g., due to an action by another control agent).
+As mentioned above, whether you have 1 pod you want to keep running, or 1000, a ReplicationController will ensure that the specified number of pods exists, even in the event of node failure or pod termination (e.g., due to an action by another control agent).
### Scaling
-The replication controller makes it easy to scale the number of replicas up or down, either manually or by an auto-scaling control agent, by simply updating the `replicas` field.
+The ReplicationController makes it easy to scale the number of replicas up or down, either manually or by an auto-scaling control agent, by simply updating the `replicas` field.
### Rolling updates
-The replication controller is designed to facilitate rolling updates to a service by replacing pods one-by-one.
+The ReplicationController is designed to facilitate rolling updates to a service by replacing pods one-by-one.
-As explained in [#1353](http://issue.k8s.io/1353), the recommended approach is to create a new replication controller with 1 replica, scale the new (+1) and old (-1) controllers one by one, and then delete the old controller after it reaches 0 replicas. This predictably updates the set of pods regardless of unexpected failures.
+As explained in [#1353](http://issue.k8s.io/1353), the recommended approach is to create a new ReplicationController with 1 replica, scale the new (+1) and old (-1) controllers one by one, and then delete the old controller after it reaches 0 replicas. This predictably updates the set of pods regardless of unexpected failures.
Ideally, the rolling update controller would take application readiness into account, and would ensure that a sufficient number of pods were productively serving at any given time.
-The two replication controllers would need to create pods with at least one differentiating label, such as the image tag of the primary container of the pod, since it is typically image updates that motivate rolling updates.
+The two ReplicationControllers would need to create pods with at least one differentiating label, such as the image tag of the primary container of the pod, since it is typically image updates that motivate rolling updates.
Rolling update is implemented in the client tool
[`kubectl rolling-update`](/docs/user-guide/kubectl/kubectl_rolling-update). Visit [`kubectl rolling-update` tutorial](/docs/user-guide/rolling-updates/) for more concrete examples.
@@ -200,42 +200,43 @@ Rolling update is implemented in the client tool
In addition to running multiple releases of an application while a rolling update is in progress, it's common to run multiple releases for an extended period of time, or even continuously, using multiple release tracks. The tracks would be differentiated by labels.
-For instance, a service might target all pods with `tier in (frontend), environment in (prod)`. Now say you have 10 replicated pods that make up this tier. But you want to be able to 'canary' a new version of this component. You could set up a replication controller with `replicas` set to 9 for the bulk of the replicas, with labels `tier=frontend, environment=prod, track=stable`, and another replication controller with `replicas` set to 1 for the canary, with labels `tier=frontend, environment=prod, track=canary`. Now the service is covering both the canary and non-canary pods. But you can mess with the replication controllers separately to test things out, monitor the results, etc.
+For instance, a service might target all pods with `tier in (frontend), environment in (prod)`. Now say you have 10 replicated pods that make up this tier. But you want to be able to 'canary' a new version of this component. You could set up a ReplicationController with `replicas` set to 9 for the bulk of the replicas, with labels `tier=frontend, environment=prod, track=stable`, and another ReplicationController with `replicas` set to 1 for the canary, with labels `tier=frontend, environment=prod, track=canary`. Now the service is covering both the canary and non-canary pods. But you can mess with the ReplicationControllers separately to test things out, monitor the results, etc.
-### Using Replication Controllers with Services
+### Using ReplicationControllers with Services
-Multiple replication controllers can sit behind a single service, so that, for example, some traffic
+Multiple ReplicationControllers can sit behind a single service, so that, for example, some traffic
goes to the old version, and some goes to the new version.
-A replication controller will never terminate on its own, but it isn't expected to be as long-lived as services. Services may be composed of pods controlled by multiple replication controllers, and it is expected that many replication controllers may be created and destroyed over the lifetime of a service (for instance, to perform an update of pods that run the service). Both services themselves and their clients should remain oblivious to the replication controllers that maintain the pods of the services.
+A ReplicationController will never terminate on its own, but it isn't expected to be as long-lived as services. Services may be composed of pods controlled by multiple ReplicationControllers, and it is expected that many ReplicationControllers may be created and destroyed over the lifetime of a service (for instance, to perform an update of pods that run the service). Both services themselves and their clients should remain oblivious to the ReplicationControllers that maintain the pods of the services.
## Writing programs for Replication
-Pods created by a replication controller are intended to be fungible and semantically identical, though their configurations may become heterogeneous over time. This is an obvious fit for replicated stateless servers, but replication controllers can also be used to maintain availability of master-elected, sharded, and worker-pool applications. Such applications should use dynamic work assignment mechanisms, such as the [etcd lock module](https://coreos.com/docs/distributed-configuration/etcd-modules/) or [RabbitMQ work queues](https://www.rabbitmq.com/tutorials/tutorial-two-python.html), as opposed to static/one-time customization of the configuration of each pod, which is considered an anti-pattern. Any pod customization performed, such as vertical auto-sizing of resources (e.g., cpu or memory), should be performed by another online controller process, not unlike the replication controller itself.
+Pods created by a ReplicationController are intended to be fungible and semantically identical, though their configurations may become heterogeneous over time. This is an obvious fit for replicated stateless servers, but ReplicationControllers can also be used to maintain availability of master-elected, sharded, and worker-pool applications. Such applications should use dynamic work assignment mechanisms, such as the [etcd lock module](https://coreos.com/docs/distributed-configuration/etcd-modules/) or [RabbitMQ work queues](https://www.rabbitmq.com/tutorials/tutorial-two-python.html), as opposed to static/one-time customization of the configuration of each pod, which is considered an anti-pattern. Any pod customization performed, such as vertical auto-sizing of resources (e.g., cpu or memory), should be performed by another online controller process, not unlike the ReplicationController itself.
-## Responsibilities of the replication controller
+## Responsibilities of the ReplicationController
-The replication controller simply ensures that the desired number of pods matches its label selector and are operational. Currently, only terminated pods are excluded from its count. In the future, [readiness](http://issue.k8s.io/620) and other information available from the system may be taken into account, we may add more controls over the replacement policy, and we plan to emit events that could be used by external clients to implement arbitrarily sophisticated replacement and/or scale-down policies.
+The ReplicationController simply ensures that the desired number of pods matches its label selector and are operational. Currently, only terminated pods are excluded from its count. In the future, [readiness](http://issue.k8s.io/620) and other information available from the system may be taken into account, we may add more controls over the replacement policy, and we plan to emit events that could be used by external clients to implement arbitrarily sophisticated replacement and/or scale-down policies.
-The replication controller is forever constrained to this narrow responsibility. It itself will not perform readiness nor liveness probes. Rather than performing auto-scaling, it is intended to be controlled by an external auto-scaler (as discussed in [#492](http://issue.k8s.io/492)), which would change its `replicas` field. We will not add scheduling policies (e.g., [spreading](http://issue.k8s.io/367#issuecomment-48428019)) to the replication controller. Nor should it verify that the pods controlled match the currently specified template, as that would obstruct auto-sizing and other automated processes. Similarly, completion deadlines, ordering dependencies, configuration expansion, and other features belong elsewhere. We even plan to factor out the mechanism for bulk pod creation ([#170](http://issue.k8s.io/170)).
+The ReplicationController is forever constrained to this narrow responsibility. It itself will not perform readiness nor liveness probes. Rather than performing auto-scaling, it is intended to be controlled by an external auto-scaler (as discussed in [#492](http://issue.k8s.io/492)), which would change its `replicas` field. We will not add scheduling policies (e.g., [spreading](http://issue.k8s.io/367#issuecomment-48428019)) to the ReplicationController. Nor should it verify that the pods controlled match the currently specified template, as that would obstruct auto-sizing and other automated processes. Similarly, completion deadlines, ordering dependencies, configuration expansion, and other features belong elsewhere. We even plan to factor out the mechanism for bulk pod creation ([#170](http://issue.k8s.io/170)).
-The replication controller is intended to be a composable building-block primitive. We expect higher-level APIs and/or tools to be built on top of it and other complementary primitives for user convenience in the future. The "macro" operations currently supported by kubectl (run, stop, scale, rolling-update) are proof-of-concept examples of this. For instance, we could imagine something like [Asgard](http://techblog.netflix.com/2012/06/asgard-web-based-cloud-management-and.html) managing replication controllers, auto-scalers, services, scheduling policies, canaries, etc.
+The ReplicationController is intended to be a composable building-block primitive. We expect higher-level APIs and/or tools to be built on top of it and other complementary primitives for user convenience in the future. The "macro" operations currently supported by kubectl (run, stop, scale, rolling-update) are proof-of-concept examples of this. For instance, we could imagine something like [Asgard](http://techblog.netflix.com/2012/06/asgard-web-based-cloud-management-and.html) managing ReplicationControllers, auto-scalers, services, scheduling policies, canaries, etc.
## API Object
-Replication controller is a top-level resource in the kubernetes REST API. More details about the
+Replication controller is a top-level resource in the Kubernetes REST API. More details about the
API object can be found at: [ReplicationController API
object](/docs/api-reference/v1/definitions/#_v1_replicationcontroller).
-## Alternatives to Replication Controller
+## Alternatives to ReplicationController
### ReplicaSet
-[`ReplicaSet`](/docs/user-guide/replicasets/) is the next-generation Replication Controller that supports the new [set-based label selector](/docs/user-guide/labels/#set-based-requirement).
+[`ReplicaSet`](/docs/user-guide/replicasets/) is the next-generation ReplicationController that supports the new [set-based label selector](/docs/user-guide/labels/#set-based-requirement).
It’s mainly used by [`Deployment`](/docs/user-guide/deployments/) as a mechanism to orchestrate pod creation, deletion and updates.
Note that we recommend using Deployments instead of directly using Replica Sets, unless you require custom update orchestration or don’t require updates at all.
+
### Deployment (Recommended)
[`Deployment`](/docs/user-guide/deployments/) is a higher-level API object that updates its underlying Replica Sets and their Pods
@@ -244,20 +245,20 @@ because unlike `kubectl rolling-update`, they are declarative, server-side, and
### Bare Pods
-Unlike in the case where a user directly created pods, a replication controller replaces pods that are deleted or terminated for any reason, such as in the case of node failure or disruptive node maintenance, such as a kernel upgrade. For this reason, we recommend that you use a replication controller even if your application requires only a single pod. Think of it similarly to a process supervisor, only it supervises multiple pods across multiple nodes instead of individual processes on a single node. A replication controller delegates local container restarts to some agent on the node (e.g., Kubelet or Docker).
+Unlike in the case where a user directly created pods, a ReplicationController replaces pods that are deleted or terminated for any reason, such as in the case of node failure or disruptive node maintenance, such as a kernel upgrade. For this reason, we recommend that you use a ReplicationController even if your application requires only a single pod. Think of it similarly to a process supervisor, only it supervises multiple pods across multiple nodes instead of individual processes on a single node. A ReplicationController delegates local container restarts to some agent on the node (e.g., Kubelet or Docker).
### Job
-Use a [`Job`](/docs/user-guide/jobs/) instead of a replication controller for pods that are expected to terminate on their own
+Use a [`Job`](/docs/user-guide/jobs/) instead of a ReplicationController for pods that are expected to terminate on their own
(i.e. batch jobs).
### DaemonSet
-Use a [`DaemonSet`](/docs/admin/daemons/) instead of a replication controller for pods that provide a
+Use a [`DaemonSet`](/docs/admin/daemons/) instead of a ReplicationController for pods that provide a
machine-level function, such as machine monitoring or machine logging. These pods have a lifetime that is tied
to a machine lifetime: the pod needs to be running on the machine before other pods start, and are
safe to terminate when the machine is otherwise ready to be rebooted/shutdown.
## For more information
-Read [Replication Controller Operations](/docs/user-guide/replication-controller/operations/).
+Read [ReplicationController Operations](/docs/user-guide/replication-controller/operations/).
diff --git a/docs/user-guide/replication-controller/operations.md b/docs/user-guide/replication-controller/operations.md
index 1d33f352c2..b3bd6115cc 100644
--- a/docs/user-guide/replication-controller/operations.md
+++ b/docs/user-guide/replication-controller/operations.md
@@ -1,8 +1,9 @@
---
assignees:
- bprashanth
-
+title: Replication Controller Operations
---
+
* TOC
{:toc}
diff --git a/docs/user-guide/resizing-a-replication-controller.md b/docs/user-guide/resizing-a-replication-controller.md
index 8c3c8dc288..c60ce8e60b 100644
--- a/docs/user-guide/resizing-a-replication-controller.md
+++ b/docs/user-guide/resizing-a-replication-controller.md
@@ -1,7 +1,7 @@
---
assignees:
- bprashanth
-
+title: Resizing a Replication Controller
---
To increase or decrease the number of pods under a replication controller's
diff --git a/docs/user-guide/rolling-updates.md b/docs/user-guide/rolling-updates.md
index c9ba5d3d27..6bd3c469c8 100644
--- a/docs/user-guide/rolling-updates.md
+++ b/docs/user-guide/rolling-updates.md
@@ -1,7 +1,7 @@
---
assignees:
- janetkuo
-
+title: Rolling Updates
---
* TOC
diff --git a/docs/user-guide/secrets/index.md b/docs/user-guide/secrets/index.md
index c55868f1f1..63a2a052ea 100644
--- a/docs/user-guide/secrets/index.md
+++ b/docs/user-guide/secrets/index.md
@@ -1,7 +1,7 @@
---
assignees:
- mikedanese
-
+title: Secrets
---
Objects of type `secret` are intended to hold sensitive information, such as
@@ -158,7 +158,7 @@ type: Opaque
Decode the password field:
```shell
-$ echo "MWYyZDFlMmU2N2Rm" | base64 -d
+$ echo "MWYyZDFlMmU2N2Rm" | base64 --decode
1f2d1e2e67df
```
@@ -486,7 +486,7 @@ Create a secret containing some ssh keys:
$ kubectl create secret generic ssh-key-secret --from-file=ssh-privatekey=/path/to/.ssh/id_rsa --from-file=ssh-publickey=/path/to/.ssh/id_rsa.pub
```
-**Security Note:** think carefully before sending your own ssh keys: other users of the cluster may have access to the secret. Use a service account which you want to have accessible to all the users with whom you share the kubernetes cluster, and can revoke if they are compromised.
+**Security Note:** think carefully before sending your own ssh keys: other users of the cluster may have access to the secret. Use a service account which you want to have accessible to all the users with whom you share the Kubernetes cluster, and can revoke if they are compromised.
Now we can create a pod which references the secret with the ssh key and
@@ -666,7 +666,7 @@ one called, say, `prod-user` with the `prod-db-secret`, and one called, say,
### Use-case: Dotfiles in secret volume
-In order to make piece of data 'hidden' (ie, in a file whose name begins with a dot character), simply
+In order to make piece of data 'hidden' (i.e., in a file whose name begins with a dot character), simply
make that key begin with a dot. For example, when the following secret is mounted into a volume:
```json
diff --git a/docs/user-guide/secrets/walkthrough.md b/docs/user-guide/secrets/walkthrough.md
index 001be6add4..11ca7672df 100644
--- a/docs/user-guide/secrets/walkthrough.md
+++ b/docs/user-guide/secrets/walkthrough.md
@@ -1,6 +1,6 @@
---
-assignees:
-
+assignees:
+title: Secrets Walkthrough
---
Following this example, you will create a secret and a [pod](/docs/user-guide/pods/) that consumes that secret in a [volume](/docs/user-guide/volumes/). See [Secrets design document](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/secrets.md) for more information.
diff --git a/docs/user-guide/security-context.md b/docs/user-guide/security-context.md
index 2d5807a449..c95a14b9b0 100644
--- a/docs/user-guide/security-context.md
+++ b/docs/user-guide/security-context.md
@@ -3,7 +3,7 @@ assignees:
- erictune
- mikedanese
- thockin
-
+title: Security Context
---
A security context defines the operating system security settings (uid, gid, capabilities, SELinux role, etc..) applied to a container. See [security context design](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/security_context.md) for more details.
@@ -20,7 +20,7 @@ metadata:
name: hello-world
spec:
containers:
- # specification of the pod’s containers
+ # specification of the pod's containers
# ...
securityContext:
fsGroup: 1234
@@ -85,4 +85,3 @@ Please refer to the
[API documentation](/docs/api-reference/v1/definitions/#_v1_securitycontext)
for a detailed listing and description of all the fields available
within the container security context.
-
diff --git a/docs/user-guide/service-accounts.md b/docs/user-guide/service-accounts.md
index 1df4635da9..d1129a1983 100644
--- a/docs/user-guide/service-accounts.md
+++ b/docs/user-guide/service-accounts.md
@@ -3,7 +3,7 @@ assignees:
- bprashanth
- liggitt
- thockin
-
+title: Service Accounts
---
A service account provides an identity for processes that run in a Pod.
diff --git a/docs/user-guide/services-firewalls.md b/docs/user-guide/services-firewalls.md
index 8755d222a5..0c87cc7598 100644
--- a/docs/user-guide/services-firewalls.md
+++ b/docs/user-guide/services-firewalls.md
@@ -2,7 +2,7 @@
assignees:
- bprashanth
- davidopp
-
+title: Configuring Your Cloud Provider's Firewalls
---
Many cloud providers (e.g. Google Compute Engine) define firewalls that help prevent inadvertent
diff --git a/docs/user-guide/services/index.md b/docs/user-guide/services/index.md
index cad2b22328..cd9303bd33 100644
--- a/docs/user-guide/services/index.md
+++ b/docs/user-guide/services/index.md
@@ -1,10 +1,10 @@
---
assignees:
- bprashanth
-
+title: Services
---
-Kubernetes [`Pods`](/docs/user-guide/pods) are mortal. They are born and they die, and they
+Kubernetes [`Pods`](/docs/user-guide/pods) are mortal. They are born and when they die, they
are not resurrected. [`ReplicationControllers`](/docs/user-guide/replication-controller) in
particular create and destroy `Pods` dynamically (e.g. when scaling up or down
or when doing [rolling updates](/docs/user-guide/kubectl/kubectl_rolling-update)). While each `Pod` gets its own IP address, even
@@ -353,59 +353,57 @@ Sometimes you don't need or want load-balancing and a single service IP. In
this case, you can create "headless" services by specifying `"None"` for the
cluster IP (`spec.clusterIP`).
-This option allows developers to reduce coupling to the Kubernetes system, if
-they desire, but leaves them freedom to do discovery in their own way.
-Applications can still use a self-registration pattern and adapters for other
-discovery systems could easily be built upon this API.
+This option allows developers to reduce coupling to the Kubernetes system by
+allowing them freedom to do discovery their own way. Applications can still use
+a self-registration pattern and adapters for other discovery systems could easily
+be built upon this API.
-For such `Services` a cluster IP is not allocated, the kube proxy does not handle
+For such `Services`, a cluster IP is not allocated, kube-proxy does not handle
these services, and there is no load balancing or proxying done by the platform
-for them. How DNS is automatically configured depends on if the service has
-selectors or not.
+for them. How DNS is automatically configured depends on whether the service has
+selectors defined.
### With selectors
For headless services that define selectors, the endpoints controller creates
`Endpoints` records in the API, and modifies the DNS configuration to return A
-records (addresses) which point directly to the `Pods` backing the `Service`.
+records (addresses) that point directly to the `Pods` backing the `Service`.
### Without selectors
For headless services that do not define selectors, the endpoints controller does
not create `Endpoints` records. However, the DNS system looks for and configures
either:
- - CNAME records for `ExternalName`-type services
- - A records for any `Endpoints` that share a name with the service, for all
+
+ * CNAME records for `ExternalName`-type services
+ * A records for any `Endpoints` that share a name with the service, for all
other types
## Publishing services - service types
For some parts of your application (e.g. frontends) you may want to expose a
-Service onto an external (outside of your cluster, maybe public internet) IP
-address, other services should be visible only from inside of the cluster.
+Service onto an external (outside of your cluster) IP address.
Kubernetes `ServiceTypes` allow you to specify what kind of service you want.
-The default and base type is `ClusterIP`, which exposes a service to connection
-from inside the cluster. `NodePort` and `LoadBalancer` are two types that expose
-services to external traffic.
+The default is `ClusterIP`.
-Valid values for the `ServiceType` field are:
+`ServiceType` values and their behaviors are:
- * `ExternalName`: map the service to the contents of the `externalName` field
+ * `ClusterIP`: Exposes the service on a cluster-internal IP. Choosing this value
+ makes the service only reachable from within the cluster. This is the
+ default `ServiceType`.
+ * `NodePort`: Exposes the service on each Node's IP at a static port (the `NodePort`).
+ A `ClusterIP` service, to which the NodePort service will route, is automatically
+ created. You'll be able to contact the `NodePort` service, from outside the cluster,
+ by requesting `:`.
+ * `LoadBalancer`: Exposes the service externally using a cloud provider's load balancer.
+ `NodePort` and `ClusterIP` services, to which the external load balancer will route,
+ are automatically created.
+ * `ExternalName`: Maps the service to the contents of the `externalName` field
(e.g. `foo.bar.example.com`), by returning a `CNAME` record with its value.
No proxying of any kind is set up. This requires version 1.7 or higher of
`kube-dns`.
- * `ClusterIP`: use a cluster-internal IP only - this is the default and is
- discussed above. Choosing this value means that you want this service to be
- reachable only from inside of the cluster.
- * `NodePort`: on top of having a cluster-internal IP, expose the service on a
- port on each node of the cluster (the same port on each node). You'll be able
- to contact the service on any `:NodePort` address.
- * `LoadBalancer`: on top of having a cluster-internal IP and exposing service
- on a NodePort also, ask the cloud provider for a load balancer
- which forwards to the `Service` exposed as a `:NodePort`
- for each Node.
### Type NodePort
@@ -420,7 +418,7 @@ will fail (i.e. you need to take care about possible port collisions yourself).
The value you specify must be in the configured range for node ports.
This gives developers the freedom to set up their own load balancers, to
-configure cloud environments that are not fully supported by Kubernetes, or
+configure environments that are not fully supported by Kubernetes, or
even to just expose one or more nodes' IPs directly.
Note that this Service will be visible as both `:spec.ports[*].nodePort`
@@ -502,7 +500,7 @@ within AWS Certificate Manager.
},
```
-The second annotation specificies which protocol a pod speaks. For HTTPS and
+The second annotation specifies which protocol a pod speaks. For HTTPS and
SSL, the ELB will expect the pod to authenticate itself over the encrypted
connection.
@@ -657,7 +655,7 @@ through a load-balancer, though in those cases the client IP does get altered.
## API Object
-Service is a top-level resource in the kubernetes REST API. More details about the
+Service is a top-level resource in the Kubernetes REST API. More details about the
API object can be found at: [Service API
object](/docs/api-reference/v1/definitions/#_v1_service).
diff --git a/docs/user-guide/services/operations.md b/docs/user-guide/services/operations.md
index 6fa6d61bdd..ffeb3e6d05 100644
--- a/docs/user-guide/services/operations.md
+++ b/docs/user-guide/services/operations.md
@@ -2,8 +2,9 @@
assignees:
- bprashanth
- freehan
-
+title: Service Operations
---
+
* TOC
{:toc}
diff --git a/docs/user-guide/sharing-clusters.md b/docs/user-guide/sharing-clusters.md
index 723f54fa14..c21acca84a 100644
--- a/docs/user-guide/sharing-clusters.md
+++ b/docs/user-guide/sharing-clusters.md
@@ -2,7 +2,7 @@
assignees:
- mikedanese
- thockin
-
+title: Sharing Cluster Access with kubeconfig
---
Client access to a running Kubernetes cluster can be shared by copying
diff --git a/docs/user-guide/simple-nginx.md b/docs/user-guide/simple-nginx.md
index 4a40d3df06..83011310a5 100644
--- a/docs/user-guide/simple-nginx.md
+++ b/docs/user-guide/simple-nginx.md
@@ -1,7 +1,7 @@
---
assignees:
- mikedanese
-
+title: Running Your First Containers
---
Ok, you've run one of the [getting started guides](/docs/getting-started-guides/) and you have
@@ -14,7 +14,7 @@ From this point onwards, it is assumed that `kubectl` is on your path from one o
The [`kubectl run`](/docs/user-guide/kubectl/kubectl_run) line below will create a [`Deployment`](/docs/user-guide/deployments) named `my-nginx`, and
two [nginx](https://registry.hub.docker.com/_/nginx/) [pods](/docs/user-guide/pods) listening on port 80. The `Deployment` will ensure that there are
-always exactly two pod running as specified in its spec.
+always exactly two pods running as specified in its spec.
```shell
kubectl run my-nginx --image=nginx --replicas=2 --port=80
diff --git a/docs/user-guide/thirdpartyresources.md b/docs/user-guide/thirdpartyresources.md
index a1035d44c4..b6e608b3b9 100644
--- a/docs/user-guide/thirdpartyresources.md
+++ b/docs/user-guide/thirdpartyresources.md
@@ -1,7 +1,7 @@
---
assignees:
- IanLewis
-
+title: Third Party Resources
---
* TOC
@@ -34,9 +34,9 @@ $ kubectl explain thirdpartyresource
## Creating a ThirdPartyResource
-When you user create a new `ThirdPartyResource`, the Kubernetes API Server reacts by creating a new, namespaced RESTful resource path. For now, non-namespaced objects are not supported. As with existing built-in objects, deleting a namespace deletes all custom objects in that namespace. `ThirdPartyResources` themselves are non-namespaced and are available to all namespaces.
+When you create a new `ThirdPartyResource`, the Kubernetes API Server reacts by creating a new, namespaced RESTful resource path. For now, non-namespaced objects are not supported. As with existing built-in objects, deleting a namespace deletes all custom objects in that namespace. `ThirdPartyResources` themselves are non-namespaced and are available to all namespaces.
-For example, if a save the following `ThirdPartyResource` to `resource.yaml`:
+For example, if you save the following `ThirdPartyResource` to `resource.yaml`:
```yaml
apiVersion: extensions/v1beta1
diff --git a/docs/user-guide/ui.md b/docs/user-guide/ui.md
index 32e3143b52..de50ccde00 100644
--- a/docs/user-guide/ui.md
+++ b/docs/user-guide/ui.md
@@ -3,10 +3,9 @@ assignees:
- bryk
- mikedanese
- rf232
-
+title: Web UI (Dashboard)
---
-
Dashboard is a web-based Kubernetes user interface. You can use Dashboard to deploy containerized applications to a Kubernetes cluster, troubleshoot your containerized application, and manage the cluster itself along with its attendant resources. You can use Dashboard to get an overview of applications running on your cluster, as well as for creating or modifying individual Kubernetes resources (such as Deployments, Jobs, DaemonSets, etc). For example, you can scale a Deployment, initiate a rolling update, restart a pod or deploy new applications using a deploy wizard.
Dashboard also provides information on the state of Kubernetes resources in your cluster, and on any errors that may have occurred.
@@ -16,6 +15,14 @@ Dashboard also provides information on the state of Kubernetes resources in your
* TOC
{:toc}
+## Deploying the Dashboard UI
+
+The Dashboard UI is not deployed by default. To deploy it, run the following command:
+
+```
+kubectl create -f https://rawgit.com/kubernetes/dashboard/master/src/deploy/kubernetes-dashboard.yaml
+```
+
## Accessing the Dashboard UI
There are multiple ways you can access the Dashboard UI; either by using the kubectl command-line interface, or by accessing the Kubernetes master apiserver using your web browser.
diff --git a/docs/user-guide/update-demo/index.md b/docs/user-guide/update-demo/index.md
index d51bcffc08..3ecd743855 100644
--- a/docs/user-guide/update-demo/index.md
+++ b/docs/user-guide/update-demo/index.md
@@ -1,11 +1,10 @@
----
-assignees:
-- lavalamp
-- mikedanese
-
----
-
-
+---
+assignees:
+- lavalamp
+- mikedanese
+title: Rolling Update Demo
+---
+
This example demonstrates the usage of Kubernetes to perform a [rolling update](/docs/user-guide/kubectl/kubectl_rolling-update/) on a running group of [pods](/docs/user-guide/pods/). See [here](/docs/user-guide/managing-deployments/#updating-your-application-without-a-service-outage) to understand why you need a rolling update. Also check [rolling update design document](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/simple-rolling-update.md) for more information.
The files for this example are viewable in [our docs repo
diff --git a/docs/user-guide/volumes.md b/docs/user-guide/volumes.md
index e11f0ca44b..762518fc8f 100644
--- a/docs/user-guide/volumes.md
+++ b/docs/user-guide/volumes.md
@@ -4,7 +4,7 @@ assignees:
- mikedanese
- saad-ali
- thockin
-
+title: Volumes
---
On-disk files in a container are ephemeral, which presents some problems for
@@ -531,6 +531,39 @@ before you can use it__
See the [Quobyte example](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/volumes/quobyte) for more details.
+## Using subPath
+
+Sometimes, it is useful to share one volume for multiple uses in a single pod. The `volumeMounts.subPath`
+property can be used to specify a sub-path inside the referenced volume instead of its root.
+
+Here is an example of a pod with a LAMP stack (Linux Apache Mysql PHP) using a single, shared volume.
+The HTML contents are mapped to its `html` folder, and the databases will be stored in its `mysql` folder:
+
+```yaml
+apiVersion: v1
+kind: Pod
+metadata:
+ name: my-lamp-site
+spec:
+ containers:
+ - name: mysql
+ image: mysql
+ volumeMounts:
+ - mountPath: /var/lib/mysql
+ name: site-data
+ subPath: mysql
+ - name: php
+ image: php
+ volumeMounts:
+ - mountPath: /var/www/html
+ name: site-data
+ subPath: html
+ volumes:
+ - name: site-data
+ persistentVolumeClaim:
+ claimName: my-lamp-site-data
+```
+
## Resources
The storage media (Disk, SSD, etc.) of an `emptyDir` volume is determined by the
diff --git a/docs/user-guide/working-with-resources.md b/docs/user-guide/working-with-resources.md
index d2aeeb621e..07a9bd55b7 100644
--- a/docs/user-guide/working-with-resources.md
+++ b/docs/user-guide/working-with-resources.md
@@ -2,7 +2,7 @@
assignees:
- mikedanese
- thockin
-
+title: Using kubectl to Manage Resources
---
*This document is aimed at users who have worked through some of the examples,
diff --git a/docs/whatisk8s.md b/docs/whatisk8s.md
index ca398edf58..d84be65f74 100644
--- a/docs/whatisk8s.md
+++ b/docs/whatisk8s.md
@@ -2,10 +2,9 @@
assignees:
- bgrant0607
- mikedanese
-
+title: What is Kubernetes?
---
-
Kubernetes is an [open-source platform for automating deployment, scaling, and operations of application containers](http://www.slideshare.net/BrianGrant11/wso2con-us-2015-kubernetes-a-platform-for-automating-deployment-scaling-and-operations) across clusters of hosts, providing container-centric infrastructure.
With Kubernetes, you are able to quickly and efficiently respond to customer demand:
@@ -53,7 +52,7 @@ Summary of container benefits:
* **Cloud and OS distribution portability**:
Runs on Ubuntu, RHEL, CoreOS, on-prem, Google Container Engine, and anywhere else.
* **Application-centric management**:
- Raises the level of abstraction from running an OS on virtual hardware to running an application on an OS using logical resources.
+ Raises the level of abstraction from running an OS on virtual hardware to run an application on an OS using logical resources.
* **Loosely coupled, distributed, elastic, liberated [micro-services](http://martinfowler.com/articles/microservices.html)**:
Applications are broken into smaller, independent pieces and can be deployed and managed dynamically -- not a fat monolithic stack running on one big single-purpose machine.
* **Resource isolation**:
@@ -107,7 +106,7 @@ Kubernetes is not a traditional, all-inclusive PaaS (Platform as a Service) syst
* Kubernetes does not provide nor mandate a comprehensive application configuration language/system (e.g., [jsonnet](https://github.com/google/jsonnet)).
* Kubernetes does not provide nor adopt any comprehensive machine configuration, maintenance, management, or self-healing systems.
-On the other hand, a number of PaaS systems run *on* Kubernetes, such as [Openshift](https://github.com/openshift/origin), [Deis](http://deis.io/), and [Gondor](https://gondor.io/). You could also roll your own custom PaaS, integrate with a CI system of your choice, or get along just fine with just Kubernetes: bring your container images and deploy them on Kubernetes.
+On the other hand, a number of PaaS systems run *on* Kubernetes, such as [Openshift](https://github.com/openshift/origin), [Deis](http://deis.io/), and [Eldarion](http://eldarion.cloud/). You could also roll your own custom PaaS, integrate with a CI system of your choice, or get along just fine with just Kubernetes: bring your container images and deploy them on Kubernetes.
Since Kubernetes operates at the application level rather than at just the hardware level, it provides some generally applicable features common to PaaS offerings, such as deployment, scaling, load balancing, logging, monitoring, etc. However, Kubernetes is not monolithic, and these default solutions are optional and pluggable.
diff --git a/editdocs.md b/editdocs.md
index 0291912aca..b089db1c43 100644
--- a/editdocs.md
+++ b/editdocs.md
@@ -1,5 +1,6 @@
---
layout: docwithnav
+title: Contributing to the Kubernetes Documentation
---
@@ -22,7 +23,7 @@ $( document ).ready(function() {
Continue your edit
-
Click the below link to edit the page you were just on. When you are done, press "Commit Changes" at the bottom of the screen. This will create a copy of our site on your GitHub account called a "fork." You can make other changes in your fork after it is created, if you want. When you are ready to send us all your changes, go to the index page for your fork and click "New Pull Request" to let us know about it.
+
Click the button below to edit the page you were just on. When you are done, click Commit Changes at the bottom of the screen. This creates a copy of our site in your GitHub account called a fork. You can make other changes in your fork after it is created, if you want. When you are ready to send us all your changes, go to the index page for your fork and click New Pull Request to let us know about it.
Click the below button to visit the repo for our site. You can then click the "Fork" button in the upper-right area of the screen to create a copy of our site on your GitHub account called a "fork." Make any changes you want in your fork, and when you are ready to send those changes to us, go to the index page for your fork and click "New Pull Request" to let us know about it.
+
Click the button below to visit the repo for our site. You can then click the Fork button in the upper-right area of the screen to create a copy of our site in your GitHub account called a fork. Make any changes you want in your fork, and when you are ready to send those changes to us, go to the index page for your fork and click New Pull Request to let us know about it.
Restarts containers that fail, replaces and reschedules containers when nodes die, kills containers
- that don’t respond to your user-defined health check, and doesn’t advertise them to clients until they are ready to serve.
+ that don't respond to your user-defined health check, and doesn't advertise them to clients until they are ready to serve.
Kubernetes progressively rolls out changes to your application or its configuration, while monitoring
- application health to ensure it doesn’t kill all your instances at the same time. If something goes
+ application health to ensure it doesn't kill all your instances at the same time. If something goes
wrong, Kubernetes will rollback the change for you. Take advantage of a growing ecosystem of deployment solutions.
@@ -110,7 +109,7 @@ title: Production-Grade Container Orchestration
exposing secrets in your stack configuration.
@@ -155,7 +154,7 @@ title: Production-Grade Container Orchestration
-
+
@@ -163,11 +162,11 @@ title: Production-Grade Container Orchestration
-
+
-
+
@@ -198,9 +197,8 @@ title: Production-Grade Container Orchestration
ga('create', 'UA-36037335-10', 'auto');
ga('send', 'pageview');
-
-
diff --git a/js/redirects.js b/js/redirects.js
index 32b45c2c68..3a371ca5d4 100644
--- a/js/redirects.js
+++ b/js/redirects.js
@@ -1,9 +1,9 @@
$( document ).ready(function() {
- var oldURLs=["/README.md","/README.html",".html",".md","/v1.1/","/v1.0/"];
- var fwdDirs=["examples/","cluster/","docs/devel","docs/design"];
+ var oldURLs = ["/README.md","/README.html",".html",".md","/v1.1/","/v1.0/"];
+ var fwdDirs = ["examples/","cluster/","docs/devel","docs/design"];
var doRedirect = false;
var notHere = false;
- var forwardingURL=window.location.href;
+ var forwardingURL = window.location.href;
var redirects = [{
"from": "resource-quota",
@@ -26,14 +26,14 @@ $( document ).ready(function() {
"to": "http://kubernetes.io/docs/whatisk8s/"
}];
- for (i=0;i -1){
notHere = true;
window.location.replace(redirects[i].to);
}
}
- for (i=0;i -1){
var urlPieces = forwardingURL.split(fwdDirs[i]);
var newURL = "https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/" + fwdDirs[i] + urlPieces[1];
@@ -42,11 +42,11 @@ $( document ).ready(function() {
}
}
if (!notHere) {
- for (i=0;i -1 &&
forwardingURL.indexOf("404.html") < 0){
- doRedirect=true;
- forwardingURL=forwardingURL.replace(oldURLs[i],"/");
+ doRedirect = true;
+ forwardingURL = forwardingURL.replace(oldURLs[i],"/");
}
}
if (doRedirect){
diff --git a/js/script.js b/js/script.js
index 22eff0a1b4..d6ff1dacf8 100755
--- a/js/script.js
+++ b/js/script.js
@@ -1,505 +1,523 @@
//modal close button
(function(){
- //π.modalCloseButton = function(closingFunction){
- // return π.button('pi-modal-close-button', null, null, closingFunction);
- //};
+ //π.modalCloseButton = function(closingFunction){
+ // return π.button('pi-modal-close-button', null, null, closingFunction);
+ //};
})();
// globals
var body;
//helper functions
-function copyCode(elem){
- if (document.getElementById(elem)) {
- // create hidden text element, if it doesn't already exist
- var targetId = "_hiddenCopyText_";
- // must use a temporary form element for the selection and copy
- target = document.getElementById(targetId);
- if (!target) {
- var target = document.createElement("textarea");
- target.style.position = "absolute";
- target.style.left = "-9999px";
- target.style.top = "0";
- target.id = targetId;
- document.body.appendChild(target);
- }
- target.value = document.getElementById(elem).innerText;
- // select the content
- target.setSelectionRange(0, target.value.length);
-
- // copy the selection
- var succeed;
- try {
- succeed = document.execCommand("copy");
- } catch(e) {
- sweetAlert("Oh, no...","Sorry, your browser doesn't support document.execCommand('copy'), so we can't copy this code to your clipboard.");
- succeed = false;
- }
- if (succeed) sweetAlert("Copied to clipboard:",target.value);
- return succeed;
- } else {
- sweetAlert("Oops!",elem + " not found when trying to copy code");
- return false;
- }
- }
-
-function booleanAttributeValue(element, attribute, defaultValue){
- // returns true if an attribute is present with no value
- // e.g. booleanAttributeValue(element, 'data-modal', false);
- if (element.hasAttribute(attribute)) {
- var value = element.getAttribute(attribute);
- if (value === '' || value === 'true') {
- return true;
- } else if (value === 'false') {
- return false;
- }
- }
+function copyCode(elem){
+ if (document.getElementById(elem)) {
+ // create hidden text element, if it doesn't already exist
+ var targetId = "_hiddenCopyText_";
+ // must use a temporary form element for the selection and copy
+ target = document.getElementById(targetId);
+ if (!target) {
+ var target = document.createElement("textarea");
+ target.style.position = "absolute";
+ target.style.left = "-9999px";
+ target.style.top = "0";
+ target.id = targetId;
+ document.body.appendChild(target);
+ }
+ target.value = document.getElementById(elem).innerText;
+ // select the content
+ target.setSelectionRange(0, target.value.length);
- return defaultValue;
+ // copy the selection
+ var succeed;
+ try {
+ succeed = document.execCommand("copy");
+ } catch(e) {
+ sweetAlert("Oh, no...","Sorry, your browser doesn't support document.execCommand('copy'), so we can't copy this code to your clipboard.");
+ succeed = false;
+ }
+ if (succeed) sweetAlert("Copied to clipboard:",target.value);
+ return succeed;
+ } else {
+ sweetAlert("Oops!",elem + " not found when trying to copy code");
+ return false;
+ }
+ }
+
+function booleanAttributeValue(element, attribute, defaultValue){
+ // returns true if an attribute is present with no value
+ // e.g. booleanAttributeValue(element, 'data-modal', false);
+ if (element.hasAttribute(attribute)) {
+ var value = element.getAttribute(attribute);
+ if (value === '' || value === 'true') {
+ return true;
+ } else if (value === 'false') {
+ return false;
+ }
+ }
+
+ return defaultValue;
}
function classOnCondition(element, className, condition) {
- if (condition)
- $(element).addClass(className);
- else
- $(element).removeClass(className);
+ if (condition)
+ $(element).addClass(className);
+ else
+ $(element).removeClass(className);
}
function highestZ() {
- var Z = 1000;
+ var Z = 1000;
- $("*").each(function(){
- var thisZ = $(this).css('z-index');
+ $("*").each(function(){
+ var thisZ = $(this).css('z-index');
- if (thisZ != "auto" && thisZ > Z) Z = ++thisZ;
- });
+ if (thisZ != "auto" && thisZ > Z) Z = ++thisZ;
+ });
- return Z;
+ return Z;
}
function newDOMElement(tag, className, id){
- var el = document.createElement(tag);
+ var el = document.createElement(tag);
- if (className) el.className = className;
- if (id) el.id = id;
+ if (className) el.className = className;
+ if (id) el.id = id;
- return el;
+ return el;
}
function px(n){
- return n + 'px';
+ return n + 'px';
}
var kub = (function () {
- var HEADER_HEIGHT;
- var html, header, mainNav, quickstartButton, hero, encyclopedia, footer, headlineWrapper;
+ var HEADER_HEIGHT;
+ var html, header, mainNav, quickstartButton, hero, encyclopedia, footer, headlineWrapper;
- $(document).ready(function () {
- html = $('html');
- body = $('body');
- header = $('header');
- mainNav = $('#mainNav');
- quickstartButton = $('#quickstartButton');
- hero = $('#hero');
- encyclopedia = $('#encyclopedia');
- footer = $('footer');
- headlineWrapper = $('#headlineWrapper');
- HEADER_HEIGHT = header.outerHeight();
+ $(document).ready(function () {
+ html = $('html');
+ body = $('body');
+ header = $('header');
+ mainNav = $('#mainNav');
+ quickstartButton = $('#quickstartButton');
+ hero = $('#hero');
+ encyclopedia = $('#encyclopedia');
+ footer = $('footer');
+ headlineWrapper = $('#headlineWrapper');
+ HEADER_HEIGHT = header.outerHeight();
- resetTheView();
+ resetTheView();
- window.addEventListener('resize', resetTheView);
- window.addEventListener('scroll', resetTheView);
- window.addEventListener('keydown', handleKeystrokes);
+ window.addEventListener('resize', resetTheView);
+ window.addEventListener('scroll', resetTheView);
+ window.addEventListener('keydown', handleKeystrokes);
- document.onunload = function(){
- window.removeEventListener('resize', resetTheView);
- window.removeEventListener('scroll', resetTheView);
- window.removeEventListener('keydown', handleKeystrokes);
- };
+ document.onunload = function(){
+ window.removeEventListener('resize', resetTheView);
+ window.removeEventListener('scroll', resetTheView);
+ window.removeEventListener('keydown', handleKeystrokes);
+ };
- setInterval(setFooterType, 10);
- });
+ setInterval(setFooterType, 10);
+ });
- function setFooterType() {
- var windowHeight = window.innerHeight;
- var bodyHeight;
+ function setFooterType() {
+ var windowHeight = window.innerHeight;
+ var bodyHeight;
- switch (html[0].id) {
- case 'docs': {
- bodyHeight = hero.outerHeight() + encyclopedia.outerHeight();
- break;
- }
+ switch (html[0].id) {
+ case 'docs': {
+ bodyHeight = hero.outerHeight() + encyclopedia.outerHeight();
+ break;
+ }
- case 'home':
- // case 'caseStudies':
- bodyHeight = windowHeight;
- break;
+ case 'home':
+ // case 'caseStudies':
+ bodyHeight = windowHeight;
+ break;
- case 'caseStudies':
- case 'partners':
- bodyHeight = windowHeight * 2;
- break;
+ case 'caseStudies':
+ case 'partners':
+ bodyHeight = windowHeight * 2;
+ break;
- default: {
- bodyHeight = hero.outerHeight() + $('#mainContent').outerHeight();
- }
- }
+ default: {
+ bodyHeight = hero.outerHeight() + $('#mainContent').outerHeight();
+ }
+ }
- var footerHeight = footer.outerHeight();
- classOnCondition(body, 'fixed', windowHeight - footerHeight > bodyHeight);
- }
+ var footerHeight = footer.outerHeight();
+ classOnCondition(body, 'fixed', windowHeight - footerHeight > bodyHeight);
+ }
- function resetTheView() {
- if (html.hasClass('open-nav')) {
- toggleMenu();
- } else {
- HEADER_HEIGHT = header.outerHeight();
- }
+ function resetTheView() {
+ if (html.hasClass('open-nav')) {
+ toggleMenu();
+ } else {
+ HEADER_HEIGHT = header.outerHeight();
+ }
- if (html.hasClass('open-toc')) {
- toggleToc();
- }
+ if (html.hasClass('open-toc')) {
+ toggleToc();
+ }
- classOnCondition(html, 'flip-nav', window.pageYOffset > 0);
+ classOnCondition(html, 'flip-nav', window.pageYOffset > 0);
- if (html[0].id == 'home') {
- setHomeHeaderStyles();
- }
- }
+ if (html[0].id == 'home') {
+ setHomeHeaderStyles();
+ }
+ }
- function setHomeHeaderStyles() {
- var Y = window.pageYOffset;
- var quickstartBottom = quickstartButton[0].getBoundingClientRect().bottom;
+ function setHomeHeaderStyles() {
+ var Y = window.pageYOffset;
+ var quickstartBottom = quickstartButton[0].getBoundingClientRect().bottom;
- classOnCondition(html[0], 'y-enough', Y > quickstartBottom);
- }
+ classOnCondition(html[0], 'y-enough', Y > quickstartBottom);
+ }
- function toggleMenu() {
- if (window.innerWidth < 800) {
- pushmenu.show('primary');
- }
+ function toggleMenu() {
+ if (window.innerWidth < 800) {
+ pushmenu.show('primary');
+ }
- else {
- var newHeight = HEADER_HEIGHT;
+ else {
+ var newHeight = HEADER_HEIGHT;
- if (!html.hasClass('open-nav')) {
- newHeight = mainNav.outerHeight();
- }
+ if (!html.hasClass('open-nav')) {
+ newHeight = mainNav.outerHeight();
+ }
- header.css({height: px(newHeight)});
- html.toggleClass('open-nav');
- }
- }
+ header.css({height: px(newHeight)});
+ html.toggleClass('open-nav');
+ }
+ }
- function handleKeystrokes(e) {
- switch (e.which) {
- case 27: {
- if (html.hasClass('open-nav')) {
- toggleMenu();
- }
- break;
- }
- }
- }
+ function handleKeystrokes(e) {
+ switch (e.which) {
+ case 27: {
+ if (html.hasClass('open-nav')) {
+ toggleMenu();
+ }
+ break;
+ }
+ }
+ }
- function showVideo() {
- $('body').css({overflow: 'hidden'});
+ function showVideo() {
+ $('body').css({overflow: 'hidden'});
- var videoPlayer = $("#videoPlayer");
- var videoIframe = videoPlayer.find("iframe")[0];
- videoIframe.src = videoIframe.getAttribute("data-url");
- videoPlayer.css({zIndex: highestZ()});
- videoPlayer.fadeIn(300);
- videoPlayer.click(function(){
- $('body').css({overflow: 'auto'});
+ var videoPlayer = $("#videoPlayer");
+ var videoIframe = videoPlayer.find("iframe")[0];
+ videoIframe.src = videoIframe.getAttribute("data-url");
+ videoPlayer.css({zIndex: highestZ()});
+ videoPlayer.fadeIn(300);
+ videoPlayer.click(function(){
+ $('body').css({overflow: 'auto'});
- videoPlayer.fadeOut(300, function(){
- videoIframe.src = '';
- });
- });
- }
+ videoPlayer.fadeOut(300, function(){
+ videoIframe.src = '';
+ });
+ });
+ }
- function tocWasClicked(e) {
- var target = $(e.target);
- var docsToc = $("#docsToc");
- return (target[0] === docsToc[0] || target.parents("#docsToc").length > 0);
- }
+ function tocWasClicked(e) {
+ var target = $(e.target);
+ var docsToc = $("#docsToc");
+ return (target[0] === docsToc[0] || target.parents("#docsToc").length > 0);
+ }
- function listenForTocClick(e) {
- if (!tocWasClicked(e)) toggleToc();
- }
+ function listenForTocClick(e) {
+ if (!tocWasClicked(e)) toggleToc();
+ }
- function toggleToc() {
- html.toggleClass('open-toc');
+ function toggleToc() {
+ html.toggleClass('open-toc');
- setTimeout(function () {
- if (html.hasClass('open-toc')) {
- window.addEventListener('click', listenForTocClick);
- } else {
- window.removeEventListener('click', listenForTocClick);
- }
- }, 100);
- }
+ setTimeout(function () {
+ if (html.hasClass('open-toc')) {
+ window.addEventListener('click', listenForTocClick);
+ } else {
+ window.removeEventListener('click', listenForTocClick);
+ }
+ }, 100);
+ }
- return {
- toggleToc: toggleToc,
- toggleMenu: toggleMenu,
- showVideo: showVideo
- };
+ return {
+ toggleToc: toggleToc,
+ toggleMenu: toggleMenu,
+ showVideo: showVideo
+ };
})();
// accordion
(function(){
- var yah = true;
- var moving = false;
- var CSS_BROWSER_HACK_DELAY = 25;
+ var yah = true;
+ var moving = false;
+ var CSS_BROWSER_HACK_DELAY = 25;
- $(document).ready(function(){
- // Safari chokes on the animation here, so...
- if (navigator.userAgent.indexOf('Chrome') == -1 && navigator.userAgent.indexOf('Safari') != -1){
- var hackStyle = newDOMElement('style');
- hackStyle.innerHTML = '.pi-accordion .wrapper{transition: none}';
- body.append(hackStyle);
- }
- // Gross.
+ $(document).ready(function(){
+ // Safari chokes on the animation here, so...
+ if (navigator.userAgent.indexOf('Chrome') == -1 && navigator.userAgent.indexOf('Safari') != -1){
+ var hackStyle = newDOMElement('style');
+ hackStyle.innerHTML = '.pi-accordion .wrapper{transition: none}';
+ body.append(hackStyle);
+ }
+ // Gross.
- $('.pi-accordion').each(function () {
- var accordion = this;
- var content = this.innerHTML;
- var container = newDOMElement('div', 'container');
- container.innerHTML = content;
- $(accordion).empty();
- accordion.appendChild(container);
- CollapseBox($(container));
- });
+ $('.pi-accordion').each(function () {
+ var accordion = this;
+ var content = this.innerHTML;
+ var container = newDOMElement('div', 'container');
+ container.innerHTML = content;
+ $(accordion).empty();
+ accordion.appendChild(container);
+ CollapseBox($(container));
+ });
- setYAH();
+ setYAH();
- setTimeout(function () {
- yah = false;
- }, 500);
- });
+ setTimeout(function () {
+ yah = false;
+ }, 500);
+ });
- function CollapseBox(container){
- container.children('.item').each(function(){
- // build the TOC DOM
- // the animated open/close is enabled by having each item's content exist in the flow, at its natural height,
- // enclosed in a wrapper with height = 0 when closed, and height = contentHeight when open.
- var item = this;
+ function CollapseBox(container){
+ container.children('.item').each(function(){
+ // build the TOC DOM
+ // the animated open/close is enabled by having each item's content exist in the flow, at its natural height,
+ // enclosed in a wrapper with height = 0 when closed, and height = contentHeight when open.
+ var item = this;
- // only add content wrappers to containers, not to links
- var isContainer = item.tagName === 'DIV';
+ // only add content wrappers to containers, not to links
+ var isContainer = item.tagName === 'DIV';
- var titleText = item.getAttribute('data-title');
- var title = newDOMElement('div', 'title');
- title.innerHTML = titleText;
+ var titleText = item.getAttribute('data-title');
+ var title = newDOMElement('div', 'title');
+ title.innerHTML = titleText;
- var wrapper, content;
+ var wrapper, content;
- if (isContainer) {
- wrapper = newDOMElement('div', 'wrapper');
- content = newDOMElement('div', 'content');
- content.innerHTML = item.innerHTML;
- wrapper.appendChild(content);
- }
+ if (isContainer) {
+ wrapper = newDOMElement('div', 'wrapper');
+ content = newDOMElement('div', 'content');
+ content.innerHTML = item.innerHTML;
+ wrapper.appendChild(content);
+ }
- item.innerHTML = '';
- item.appendChild(title);
+ item.innerHTML = '';
+ item.appendChild(title);
- if (wrapper) {
- item.appendChild(wrapper);
- $(wrapper).css({height: 0});
- }
+ if (wrapper) {
+ item.appendChild(wrapper);
+ $(wrapper).css({height: 0});
+ }
- $(title).click(function(){
- if (!yah) {
- if (moving) return;
- moving = true;
- }
+ $(title).click(function(){
+ if (!yah) {
+ if (moving) return;
+ moving = true;
+ }
- if (container[0].getAttribute('data-single')) {
- var openSiblings = item.siblings().filter(function(sib){return sib.hasClass('on');});
- openSiblings.forEach(function(sibling){
- toggleItem(sibling);
- });
- }
+ if (container[0].getAttribute('data-single')) {
+ var openSiblings = item.siblings().filter(function(sib){return sib.hasClass('on');});
+ openSiblings.forEach(function(sibling){
+ toggleItem(sibling);
+ });
+ }
- setTimeout(function(){
- if (!isContainer) {
- moving = false;
- return;
- }
- toggleItem(item);
- }, CSS_BROWSER_HACK_DELAY);
- });
+ setTimeout(function(){
+ if (!isContainer) {
+ moving = false;
+ return;
+ }
+ toggleItem(item);
+ }, CSS_BROWSER_HACK_DELAY);
+ });
- function toggleItem(thisItem){
- var thisWrapper = $(thisItem).find('.wrapper').eq(0);
+ function toggleItem(thisItem){
+ var thisWrapper = $(thisItem).find('.wrapper').eq(0);
- if (!thisWrapper) return;
+ if (!thisWrapper) return;
- var contentHeight = thisWrapper.find('.content').eq(0).innerHeight() + 'px';
+ var contentHeight = thisWrapper.find('.content').eq(0).innerHeight() + 'px';
- if ($(thisItem).hasClass('on')) {
- thisWrapper.css({height: contentHeight});
- $(thisItem).removeClass('on');
+ if ($(thisItem).hasClass('on')) {
+ thisWrapper.css({height: contentHeight});
+ $(thisItem).removeClass('on');
- setTimeout(function(){
- thisWrapper.css({height: 0});
- moving = false;
- }, CSS_BROWSER_HACK_DELAY);
- } else {
- $(item).addClass('on');
- thisWrapper.css({height: contentHeight});
+ setTimeout(function(){
+ thisWrapper.css({height: 0});
+ moving = false;
+ }, CSS_BROWSER_HACK_DELAY);
+ } else {
+ $(item).addClass('on');
+ thisWrapper.css({height: contentHeight});
- var duration = parseFloat(getComputedStyle(thisWrapper[0]).transitionDuration) * 1000;
+ var duration = parseFloat(getComputedStyle(thisWrapper[0]).transitionDuration) * 1000;
- setTimeout(function(){
- thisWrapper.css({height: ''});
- moving = false;
- }, duration);
- }
- }
+ setTimeout(function(){
+ thisWrapper.css({height: ''});
+ moving = false;
+ }, duration);
+ }
+ }
- if (content) {
- var innerContainers = $(content).children('.container');
- if (innerContainers.length > 0) {
- innerContainers.each(function(){
- CollapseBox($(this));
- });
- }
- }
- });
- }
+ if (content) {
+ var innerContainers = $(content).children('.container');
+ if (innerContainers.length > 0) {
+ innerContainers.each(function(){
+ CollapseBox($(this));
+ });
+ }
+ }
+ });
+ }
- function setYAH() {
- var pathname = location.href.split('#')[0]; // on page load, make sure the page is YAH even if there's a hash
- var currentLinks = [];
+ function setYAH() {
+ var pathname = location.href.split('#')[0]; // on page load, make sure the page is YAH even if there's a hash
+ var currentLinks = [];
- $('.pi-accordion a').each(function () {
- if (pathname === this.href) currentLinks.push(this);
- });
+ $('.pi-accordion a').each(function () {
+ if (pathname === this.href) currentLinks.push(this);
+ });
- currentLinks.forEach(function (yahLink) {
- $(yahLink).parents('.item').each(function(){
- $(this).addClass('on');
- $(this).find('.wrapper').eq(0).css({height: 'auto'});
- $(this).find('.content').eq(0).css({opacity: 1});
- });
+ currentLinks.forEach(function (yahLink) {
+ $(yahLink).parents('.item').each(function(){
+ $(this).addClass('on');
+ $(this).find('.wrapper').eq(0).css({height: 'auto'});
+ $(this).find('.content').eq(0).css({opacity: 1});
+ });
- $(yahLink).addClass('yah');
- yahLink.onclick = function(e){e.preventDefault();};
- });
- }
+ $(yahLink).addClass('yah');
+ yahLink.onclick = function(e){e.preventDefault();};
+ });
+ }
})();
var pushmenu = (function(){
- var allPushMenus = {};
+ var allPushMenus = {};
- $(document).ready(function(){
- $('[data-auto-burger]').each(function(){
- var container = this;
- var id = container.getAttribute('data-auto-burger');
+ $(document).ready(function(){
+ $('[data-auto-burger]').each(function(){
+ var container = this;
+ var id = container.getAttribute('data-auto-burger');
- var autoBurger = document.getElementById(id) || newDOMElement('div', 'pi-pushmenu', id);
- var ul = autoBurger.querySelector('ul') || newDOMElement('ul');
+ var autoBurger = document.getElementById(id) || newDOMElement('div', 'pi-pushmenu', id);
+ var ul = autoBurger.querySelector('ul') || newDOMElement('ul');
- $(container).find('a[href], button').each(function () {
- if (!booleanAttributeValue(this, 'data-auto-burger-exclude', false)) {
- var clone = this.cloneNode(true);
- clone.id = '';
+ $(container).find('a[href], button').each(function () {
+ if (!booleanAttributeValue(this, 'data-auto-burger-exclude', false)) {
+ var clone = this.cloneNode(true);
+ clone.id = '';
- if (clone.tagName == "BUTTON") {
- var aTag = newDOMElement('a');
- aTag.href = '';
- aTag.innerHTML = clone.innerHTML;
- aTag.onclick = clone.onclick;
- clone = aTag;
- }
- var li = newDOMElement('li');
- li.appendChild(clone);
- ul.appendChild(li);
- }
- });
+ if (clone.tagName == "BUTTON") {
+ var aTag = newDOMElement('a');
+ aTag.href = '';
+ aTag.innerHTML = clone.innerHTML;
+ aTag.onclick = clone.onclick;
+ clone = aTag;
+ }
+ var li = newDOMElement('li');
+ li.appendChild(clone);
+ ul.appendChild(li);
+ }
+ });
- autoBurger.appendChild(ul);
- body.append(autoBurger);
- });
+ autoBurger.appendChild(ul);
+ body.append(autoBurger);
+ });
- $(".pi-pushmenu").each(function(){
- allPushMenus[this.id] = PushMenu(this);
- });
- });
+ $(".pi-pushmenu").each(function(){
+ allPushMenus[this.id] = PushMenu(this);
+ });
+ });
- function show(objId) {
- allPushMenus[objId].expose();
- }
+ function show(objId) {
+ allPushMenus[objId].expose();
+ }
- function PushMenu(el) {
- var html = document.querySelector('html');
+ function PushMenu(el) {
+ var html = document.querySelector('html');
- var overlay = newDOMElement('div', 'overlay');
- var content = newDOMElement('div', 'content');
- content.appendChild(el.querySelector('*'));
+ var overlay = newDOMElement('div', 'overlay');
+ var content = newDOMElement('div', 'content');
+ content.appendChild(el.querySelector('*'));
- var side = el.getAttribute("data-side") || "right";
+ var side = el.getAttribute("data-side") || "right";
- var sled = newDOMElement('div', 'sled');
- $(sled).css(side, 0);
+ var sled = newDOMElement('div', 'sled');
+ $(sled).css(side, 0);
- sled.appendChild(content);
+ sled.appendChild(content);
- var closeButton = newDOMElement('button', 'push-menu-close-button');
- closeButton.onclick = closeMe;
+ var closeButton = newDOMElement('button', 'push-menu-close-button');
+ closeButton.onclick = closeMe;
- sled.appendChild(closeButton);
+ sled.appendChild(closeButton);
- overlay.appendChild(sled);
- el.innerHTML = '';
- el.appendChild(overlay);
+ overlay.appendChild(sled);
+ el.innerHTML = '';
+ el.appendChild(overlay);
- sled.onclick = function(e){
- e.stopPropagation();
- };
+ sled.onclick = function(e){
+ e.stopPropagation();
+ };
- overlay.onclick = closeMe;
+ overlay.onclick = closeMe;
- window.addEventListener('resize', closeMe);
+ window.addEventListener('resize', closeMe);
- function closeMe(e) {
- if (e.target == sled) return;
+ function closeMe(e) {
+ if (e.target == sled) return;
- $(el).removeClass('on');
- setTimeout(function(){
- $(el).css({display: 'none'});
+ $(el).removeClass('on');
+ setTimeout(function(){
+ $(el).css({display: 'none'});
- $(body).removeClass('overlay-on');
- }, 300);
- }
+ $(body).removeClass('overlay-on');
+ }, 300);
+ }
- function exposeMe(){
- $(body).addClass('overlay-on'); // in the default config, kills body scrolling
+ function exposeMe(){
+ $(body).addClass('overlay-on'); // in the default config, kills body scrolling
- $(el).css({
- display: 'block',
- zIndex: highestZ()
- });
+ $(el).css({
+ display: 'block',
+ zIndex: highestZ()
+ });
- setTimeout(function(){
- $(el).addClass('on');
- }, 10);
- }
+ setTimeout(function(){
+ $(el).addClass('on');
+ }, 10);
+ }
- return {
- expose: exposeMe
- };
- }
+ return {
+ expose: exposeMe
+ };
+ }
- return {
- show: show
- };
+ return {
+ show: show
+ };
})();
+
+$(function() {
+
+ // Make global nav be active based on pathname
+ if ((location.pathname.split("/")[1]) !== ""){
+ $('.global-nav li a[href^="/' + location.pathname.split("/")[1] + '"]').addClass('active');
+ }
+
+ // If vendor strip doesn't exist add className
+ if ( !$('#vendorStrip').length > 0 ) {
+ $('#hero').addClass('bot-bar');
+ }
+
+ // If is not homepage add class to hero section
+ if (!$('#home').length > 0 ) {
+ $('#hero').addClass('no-sub');
+ }
+});
\ No newline at end of file
diff --git a/kubernetes/third_party/swagger-ui/index.md b/kubernetes/third_party/swagger-ui/index.md
index c481f993f3..425a061477 100644
--- a/kubernetes/third_party/swagger-ui/index.md
+++ b/kubernetes/third_party/swagger-ui/index.md
@@ -1,3 +1,7 @@
+---
+title: Kubernetes API Swagger Spec
+---
+
---
Kubernetes swagger UI has now been replaced by our generated API reference docs
diff --git a/partners/index.html b/partners/index.html
index 9adf7206d9..5a8da670a9 100644
--- a/partners/index.html
+++ b/partners/index.html
@@ -14,7 +14,7 @@ title: Partners
-
We are working with a broad group of partners who contribute to the Kubernetes core codebase, making it stronger and richer. These partners create a vibrant Kubernetes ecosystem supporting a spectrum of complementing platforms, from open source solutions to market-leading technologies.
+
We are working with a broad group of partners who contribute to the Kubernetes core codebase, making it stronger and richer. These partners create a vibrant Kubernetes ecosystem supporting a spectrum of complementing platforms, from open source solutions to market-leading technologies. Partners can get their services and offerings added to this page by completing and submitting the partner request form.
Technology Partners
Services Partners
diff --git a/security/index.md b/security/index.md
new file mode 100644
index 0000000000..5fe3b5b13c
--- /dev/null
+++ b/security/index.md
@@ -0,0 +1,46 @@
+---
+layout: docwithnav
+title: Kubernetes Security and Disclosure Information
+permalink: /security/
+assignees:
+- eparis
+- erictune
+- philips
+- jessfraz
+---
+
+## Security Announcements
+
+Join the [kubernetes-announce](https://groups.google.com/forum/#!forum/kubernetes-announce) group for emails about security and major API announcements.
+
+## Report a Vulnerability
+
+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://github.com/kubernetes/kubernetes/blob/master/.github/ISSUE_TEMPLATE.md).
+
+You may encrypt your email to this list using the GPG keys of the [Product Security Team members](https://github.com/kubernetes/community/blob/master/contributors/devel/security-release-process.md#product-security-team-pst). Encryption using GPG is NOT required to make a disclosure.
+
+### When Should I Report a Vulnerability?
+
+- You think you discovered a potential security vulnerability in Kubernetes
+- You are unsure how a vulnerability affects Kubernetes
+- You think you discovered a vulnerability in another project that Kubernetes depends on (e.g. docker, rkt, etcd)
+
+### When Should I NOT Report a Vulnerability?
+
+- You need help tuning Kubernetes components for security
+- You need help applying security related updates
+- Your issue is not security related
+
+## Security Vulnerability Response
+
+Each report is acknowledged and analyzed by Product Security Team members within 3 working days. This will set off the [Security Release Process](https://github.com/kubernetes/community/blob/master/contributors/devel/security-release-process.md#product-security-team-pst).
+
+Any vulnerability information shared with Product Security Team stays within Kubernetes project and will not be disseminated to other projects unless it is necessary to get the issue fixed.
+
+As the security issue moves from triage, to identified fix, to release planning we will keep the reporter updated.
+
+## Public Disclosure Timing
+
+A public disclosure date is negotiated by the Kubernetes product security team and the bug submitter. We prefer to fully disclose the bug as soon as possible once a user mitigation is available. It is reasonable to delay disclosure when the bug or the fix is not yet fully understood, the solution is not well-tested, or for vendor coordination. The timeframe for disclosure is from immediate (especially if it's already publicly known) to a few weeks. As a basic default, we expect report date to disclosure date to be on the order of 7 days. The Kubernetes product security team holds the final say when setting a disclosure date.
diff --git a/sitemap.xml b/sitemap.xml
deleted file mode 100644
index ff1dd0d398..0000000000
--- a/sitemap.xml
+++ /dev/null
@@ -1,18 +0,0 @@
----
----
-
-
-
-
- http://kubernetes.io/
- {{ site.time | date_to_xmlschema }}
-
-{% for page in site.pages %}{% if page.url != "/404.html" and page.url != "/sitemap.xml" and page.url != "/css/styles.css" %}
- http://kubernetes.io{{ page.url }}
- {% if page.date %}{{ page.date | date_to_xmlschema }}{% else %}{{ site.time | date_to_xmlschema }}{% endif %}
-{% endif %}{% endfor %}
-
diff --git a/staging-container/Dockerfile b/staging-container/Dockerfile
index a5b41625b5..cb0d6a0f70 100644
--- a/staging-container/Dockerfile
+++ b/staging-container/Dockerfile
@@ -1,13 +1,26 @@
-FROM starefossen/ruby-node:2-4
+FROM alpine:3.3
-RUN gem install github-pages
+RUN apk add --no-cache \
+ build-base \
+ ca-certificates \
+ libffi-dev \
+ nodejs \
+ ruby-dev \
+ ruby-nokogiri \
+ zlib-dev
+
+RUN gem install \
+ bundler \
+ github-pages \
+ io-console \
+ --no-rdoc --no-ri
VOLUME /k8sdocs
EXPOSE 4000
+COPY start.sh /start.sh
WORKDIR /k8sdocs
-CMD bundle && jekyll clean && jekyll serve -H 0.0.0.0 -P 4000
-
+CMD [ "/start.sh" ]
# For instructions, see http://kubernetes.io/editdocs/
diff --git a/staging-container/start.sh b/staging-container/start.sh
new file mode 100755
index 0000000000..890e4bb385
--- /dev/null
+++ b/staging-container/start.sh
@@ -0,0 +1,7 @@
+#!/bin/sh
+set -e
+set -x
+
+bundle
+bundle exec jekyll clean
+bundle exec jekyll serve -H 0.0.0.0 -P 4000
diff --git a/test/examples_test.go b/test/examples_test.go
index cb876db9ec..22e71c8bb0 100644
--- a/test/examples_test.go
+++ b/test/examples_test.go
@@ -38,6 +38,8 @@ import (
"k8s.io/kubernetes/pkg/apis/extensions"
expvalidation "k8s.io/kubernetes/pkg/apis/extensions/validation"
"k8s.io/kubernetes/pkg/capabilities"
+ "k8s.io/kubernetes/pkg/apis/policy"
+ policyvalidation "k8s.io/kubernetes/pkg/apis/policy/validation"
"k8s.io/kubernetes/pkg/registry/batch/job"
"k8s.io/kubernetes/pkg/runtime"
"k8s.io/kubernetes/pkg/types"
@@ -147,6 +149,11 @@ func validateObject(obj runtime.Object) (errors field.ErrorList) {
t.Namespace = api.NamespaceDefault
}
errors = apps_validation.ValidateStatefulSet(t)
+ case *policy.PodDisruptionBudget:
+ if t.Namespace == "" {
+ t.Namespace = api.NamespaceDefault
+ }
+ errors = policyvalidation.ValidatePodDisruptionBudget(t)
default:
errors = field.ErrorList{}
errors = append(errors, field.InternalError(field.NewPath(""), fmt.Errorf("no validation defined for %#v", obj)))
@@ -323,6 +330,7 @@ func TestExampleObjectSchemas(t *testing.T) {
"mysql-configmap": {&api.ConfigMap{}},
"mysql-statefulset": {&apps.StatefulSet{}},
"web": {&api.Service{}, &apps.StatefulSet{}},
+ "zookeeper": {&api.Service{}, &api.ConfigMap{}, &policy.PodDisruptionBudget{}, &apps.StatefulSet{}},
},
}
diff --git a/update-imported-docs.sh b/update-imported-docs.sh
index 5c2674cf6c..63231a8aeb 100755
--- a/update-imported-docs.sh
+++ b/update-imported-docs.sh
@@ -3,7 +3,7 @@
# Uncomment this to see the commands as they are run
# set -x
-VERSION=1.4
+VERSION=1.5
# Processes api reference docs.
function process_api_ref_docs {
@@ -37,7 +37,6 @@ cd k8s
git remote add upstream https://github.com/kubernetes/kubernetes.git
git fetch upstream
hack/generate-docs.sh
-build/versionize-docs.sh release-$VERSION
cd ..
rm -rf _includes/v$VERSION
- 
- 