diff --git a/Makefile b/Makefile index 64ceef89a0..3657cb577a 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -.PONY: all build build-preview help serve +.PHONY: all build build-preview help serve help: ## Show this help. @awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {sub("\\\\n",sprintf("\n%22c"," "), $$2);printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) diff --git a/_data/concepts.yml b/_data/concepts.yml index a9a7c3eb29..71c6512909 100644 --- a/_data/concepts.yml +++ b/_data/concepts.yml @@ -2,9 +2,16 @@ bigheader: "Concepts" abstract: "Detailed explanations of Kubernetes system concepts and abstractions." toc: - docs/concepts/index.md +- title: Kubectl Command Line + section: + - docs/concepts/tools/kubectl/object-management-overview.md +- title: Kubernetes Objects + section: + - docs/concepts/abstractions/overview.md + - docs/concepts/abstractions/pod.md + - title: Controllers + section: + - docs/concepts/abstractions/controllers/statefulsets.md - title: Object Metadata section: - docs/concepts/object-metadata/annotations.md -- title: Controllers - section: - - docs/concepts/abstractions/controllers/statefulsets.md diff --git a/_data/guides.yml b/_data/guides.yml index c1bdd99a4e..f66d0706ee 100644 --- a/_data/guides.yml +++ b/_data/guides.yml @@ -8,6 +8,7 @@ toc: - docs/whatisk8s.md - docs/getting-started-guides/kubeadm.md - docs/getting-started-guides/kops.md + - docs/getting-started-guides/kargo.md - docs/hellonode.md - docs/getting-started-guides/kubectl.md - docs/getting-started-guides/binary_release.md @@ -65,11 +66,8 @@ toc: - title: Containers and Pods section: - - docs/user-guide/simple-nginx.md - - docs/user-guide/pods/single-container.md - docs/user-guide/pods/multi-container.md - docs/user-guide/pods/init-container.md - - docs/user-guide/configuring-containers.md - docs/user-guide/pod-templates.md - docs/user-guide/containers.md - docs/user-guide/environment-guide/index.md diff --git a/_data/support.yml b/_data/support.yml index c25faa70f8..a6b13e9d09 100644 --- a/_data/support.yml +++ b/_data/support.yml @@ -3,17 +3,6 @@ abstract: "Troubleshooting resources, frequently asked questions, and community toc: - docs/troubleshooting.md -- title: Contributing to the Kubernetes Docs - section: - - 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.md - - docs/contribute/style-guide.md - - - title: Troubleshooting section: - docs/user-guide/debugging-pods-and-replication-controllers.md @@ -31,6 +20,16 @@ toc: - title: Services FAQ path: https://github.com/kubernetes/kubernetes/wiki/Services-FAQ/ +- title: Contributing to the Kubernetes Docs + section: + - 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.md + - docs/contribute/style-guide.md + - title: Other Resources section: - title: Kubernetes Issue Tracker on GitHub @@ -40,6 +39,6 @@ toc: path: https://github.com/kubernetes/kubernetes/releases/ - title: Release Roadmap path: https://github.com/kubernetes/kubernetes/milestones/ - + - title: Deprecation Policy path: /docs/deprecation-policy.md diff --git a/_data/tasks.yml b/_data/tasks.yml index 13315bf5ed..231a583524 100644 --- a/_data/tasks.yml +++ b/_data/tasks.yml @@ -1,5 +1,5 @@ bigheader: "Tasks" -abstract: "Step-by-step instructions for performing operations with Kuberentes." +abstract: "Step-by-step instructions for performing operations with Kubernetes." toc: - docs/tasks/index.md diff --git a/_includes/case-study-styles.html b/_includes/case-study-styles.html deleted file mode 100644 index 48058bd27b..0000000000 --- a/_includes/case-study-styles.html +++ /dev/null @@ -1,313 +0,0 @@ - - diff --git a/_includes/code.html b/_includes/code.html index ce653054e8..59a27ebf1a 100644 --- a/_includes/code.html +++ b/_includes/code.html @@ -7,5 +7,20 @@ ``` {: id="{{include.file | handleize}}"} {% endcapture %} - -
{% if ghlink %}{% endif %}{{include.file}}
{{ mysample | markdownify }}
\ No newline at end of file + + + + + + + + + + + +
+ {% if ghlink %}{% endif %} + {{include.file}} + {% if ghlink %}{% endif %} + +
{{ mysample | markdownify }}
diff --git a/_includes/footer-scripts.html b/_includes/footer-scripts.html new file mode 100644 index 0000000000..091545d12a --- /dev/null +++ b/_includes/footer-scripts.html @@ -0,0 +1,53 @@ + + + + + + + diff --git a/_includes/head-header.html b/_includes/head-header.html deleted file mode 100644 index fa859604d2..0000000000 --- a/_includes/head-header.html +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - - - - - - - - {% seo %} - - -
-
- - - - - -
diff --git a/_includes/head.html b/_includes/head.html new file mode 100644 index 0000000000..2f85549db5 --- /dev/null +++ b/_includes/head.html @@ -0,0 +1,17 @@ + + + + + + + + + + {% if page.class == "gridPage" %}{% endif %} + + + + + + {% seo %} + diff --git a/_includes/header.html b/_includes/header.html new file mode 100644 index 0000000000..436e4262c4 --- /dev/null +++ b/_includes/header.html @@ -0,0 +1,58 @@ +
+ +
+ + + + + +
diff --git a/_includes/templates/concept.md b/_includes/templates/concept.md index dc6efdad13..65edc7f808 100644 --- a/_includes/templates/concept.md +++ b/_includes/templates/concept.md @@ -24,7 +24,7 @@ {% if whatsnext %} -### What's next +## What's next {{ whatsnext }} diff --git a/_includes/templates/task.md b/_includes/templates/task.md index d74ff3b97a..e76cb7b117 100644 --- a/_includes/templates/task.md +++ b/_includes/templates/task.md @@ -15,7 +15,7 @@ {% if prerequisites %} -### Before you begin +## Before you begin {{ prerequisites }} @@ -48,7 +48,7 @@ {% if whatsnext %} -### What's next +## What's next {{ whatsnext }} diff --git a/_includes/templates/tutorial.md b/_includes/templates/tutorial.md index 9c2d680643..b4c1faa0f1 100644 --- a/_includes/templates/tutorial.md +++ b/_includes/templates/tutorial.md @@ -15,7 +15,7 @@ {% if objectives %} -### Objectives +## Objectives {{ objectives }} @@ -28,7 +28,7 @@ {% if prerequisites %} -### Before you begin +## Before you begin {{ prerequisites }} @@ -52,7 +52,7 @@ {% if cleanup %} -### Cleaning up +## Cleaning up {{ cleanup }} @@ -61,7 +61,7 @@ {% if whatsnext %} -### What's next +## What's next {{ whatsnext }} diff --git a/_layouts/basic.html b/_layouts/basic.html new file mode 100644 index 0000000000..d2b684df52 --- /dev/null +++ b/_layouts/basic.html @@ -0,0 +1,15 @@ + + + + {% include head.html %} + + + {% include header.html %} + + {{ content }} + + {% include footer.html %} + + {% include footer-scripts.html %} + + diff --git a/_layouts/docwithnav.html b/_layouts/docwithnav.html index 4ac68e8acd..073e1c9344 100755 --- a/_layouts/docwithnav.html +++ b/_layouts/docwithnav.html @@ -10,7 +10,11 @@ -{% include head-header.html %} +{% include head.html %} + + + +{% include header.html %}
@@ -43,6 +47,7 @@ +

Edit This Page

@@ -71,57 +76,7 @@
{% include_cached footer.html %} +{% include footer-scripts.html %} - - - - - diff --git a/case-studies/index.html b/case-studies/index.html index f593d73fb9..e4e15111c5 100644 --- a/case-studies/index.html +++ b/case-studies/index.html @@ -1,11 +1,10 @@ --- title: Case Studies +layout: basic +class: gridPage +cid: caseStudies --- - - -{% include head-header.html %} -

Kubernetes User Case Studies

A collection of users running Kubernetes in production.
@@ -98,8 +97,3 @@ title: Case Studies -{% include footer.html %} -{% include case-study-styles.html %} - - - diff --git a/case-studies/pearson.html b/case-studies/pearson.html index 50f16ce7ae..45428b0bf3 100644 --- a/case-studies/pearson.html +++ b/case-studies/pearson.html @@ -1,11 +1,10 @@ --- title: Pearson Case Study +layout: basic +class: gridPage +cid: caseStudies --- - - -{% include head-header.html %} -

Pearson Case Study

@@ -80,9 +79,3 @@ title: Pearson Case Study
- -{% include footer.html %} -{% include case-study-styles.html %} - - - diff --git a/case-studies/wikimedia.html b/case-studies/wikimedia.html index 2d3b686128..7431c13650 100644 --- a/case-studies/wikimedia.html +++ b/case-studies/wikimedia.html @@ -1,11 +1,10 @@ --- title: Wikimedia Case Study +layout: basic +class: gridPage +cid: caseStudies --- - - -{% include head-header.html %} -

Wikimedia Case Study

@@ -95,9 +94,3 @@ title: Wikimedia Case Study - -{% include footer.html %} -{% include case-study-styles.html %} - - - diff --git a/community.html b/community/index.html similarity index 94% rename from community.html rename to community/index.html index a10a100375..4686ebb442 100644 --- a/community.html +++ b/community/index.html @@ -1,13 +1,11 @@ --- title: Community +layout: basic +cid: community --- - - -{% include head-header.html %} -
-

Community

+

Community

@@ -61,8 +59,3 @@ title: Community
- -{% include footer.html %} - - - diff --git a/css/gridpage.css b/css/gridpage.css new file mode 100644 index 0000000000..96a39af9c6 --- /dev/null +++ b/css/gridpage.css @@ -0,0 +1,310 @@ +#caseStudyTitle { + margin-top: 1em !important; +} + +.gridPage p { + color: rgb(26,26,26) !important; + margin-left: 0 !important; + padding-left: 0 !important; + font-weight: 300 !important; +} + +.gridPage #mainContent { + padding: 0; +} + +.gridPage #mainContent .content { + padding-top: 0; +} + +.gridPage main { + max-width: 1100px !important; +} + +.gridPage .content { + position: relative; + margin: 0 auto 50px; + max-width: 90%; +} + +.gridPage .content p { + line-height: 24px !important; +} + +.gridPage .content h3 { + padding: 0 !important; +} + +.gridPage #hero h5 { + padding-left: 20px; + margin: 0; +} + +.case-studies { + position: relative; + display: flex; + justify-content: space-between; + flex-wrap: wrap; + margin-top: 50px; +} + +.case-study { + position: relative; + width: 50%; + padding: 0 40px 0 242px; + margin-bottom: 60px; + min-height: 152px; +} + +.case-study:nth-child(3), .case-study:nth-child(4) { + margin-bottom: 0; +} + +.case-study img { + position: absolute; + top: 0; + left: 0; +} + +.gridPage #mainContent .content .case-study p { + font-family: "Roboto", sans-serif; + font-size: 16px; + padding: 0; +} + +p.attrib { + font-style: italic; +} + +.gridPage #video { + background: #f9f9f9; + height: auto; + /*height: 340px;*/ +} + +.gridPage #video main { + position: relative; + max-width: 900px !important; + height: 100%; + display: flex; + justify-content: center; + align-items: center; + padding: 50px 20px; +} + +.gridPage #video main > div { + width: 50%; +} + +.gridPage #video main #zulilyLogo { + width: 100px; +} + +.gridPage #video main img { + max-width: 100%; +} + +.gridPage #video h3 { + font-size: 32px; + font-weight: 300; + line-height: 38px; + max-width: 80%; + margin: 0 0 1em 0; +} + +.gridPage #video p { + margin: 0; +} + +.gridPage #video p.attrib { + margin-bottom: 20px; +} + +.gridPage #video button > h6 { + font-size: 18px; + font-weight: 500; + margin: 1em 0; + color: #326de6; +} + +.gridPage #users { + padding: 50px; +} + +.gridPage #users main { + max-width: 1150px !important; +} + +.gridPage #users main h3 { + padding-left: 20px; + margin-bottom: 20px; +} + +.gridPage #usersGrid { + position: relative; + display: flex; + flex-wrap: wrap; + justify-content: center; +} + +.gridPage #usersGrid a { + display: inline-block; + margin: 5px; +} + +.gridPage #usersGrid a img { + box-shadow: 1px 1px 2px transparent; + transition: box-shadow 0.25s; +} + +.gridPage #usersGrid a img:hover { + box-shadow: 1px 1px 2px #cccccc; +} + +.gridPage #usersGrid a:last-child img, +.gridPage #usersGrid a:last-child img:hover { + box-shadow: 1px 1px 2px transparent; +} + +.tell-your-story { + border: 1px solid #dddddd; + border-radius: 6px; + box-shadow: 1px 2px 2px #dddddd; +} + +.gridPage .feature { + position: relative; + padding: 20px 0 20px 242px; +} + +.gridPage .feature img { + position: absolute; + top: 20px; + left: 0; +} + +section.bullets { + background-color: #eeeeee; + margin-bottom: 50px; +} + +section.bullets main { + position: relative; + max-width: 1100px; + padding: 50px 0; +} + +section.bullets .content { + position: relative; + display: flex; + flex-wrap: wrap; + margin-bottom: 0 !important; +} + +.bullet { + position: relative; + width: 50%; + padding: 15px 30px; +} + +.bullet h4 { + margin-bottom: 0.5em; +} + +.bullet li { + margin-left: 1.25em; + list-style: disc; + font-weight: 300; + color: rgb(26,26,26); + line-height: 1.5em; + margin-bottom: 0.5em; +} + +.details h4, p { + margin-bottom: 0.5em; +} + +.gridPage .feature p.quote { + font-size: 20px; + line-height: 28px !important; +} + +@media screen and (max-width: 1024px){ + .case-study { + padding: 0 10%; + margin-bottom: 50px; + } + + .case-study img { + position: relative; + } + + .case-study p.quote { + margin-top: 20px !important; + } + + .case-study p.attrib { + font-style: italic; + } +} + +@media screen and (max-width: 900px){ + .gridPage #video main { + flex-direction: column; + align-items: center; + } + + .gridPage #video main > div { + width: 400px; + } + + .gridPage #video main > div + div { + margin-top: 30px; + } + + .gridPage #video h3 { + max-width: 100%; + } +} + +@media screen and (max-width: 640px){ + .case-study { + width: 100%; + } + + .case-study:nth-child(3) { + margin-bottom: 60px; + } + + .case-study img { + left: 50%; + transform: translateX(-50%); + } + + .gridPage .feature { + margin-top: 50px; + padding: 180px 0 0; + } + + .gridPage .feature img { + top: 0; + left: 50%; + transform: translateX(-50%); + } +} + +@media screen and (max-width: 480px){ + .gridPage #hero { + padding-right: 20px; + padding-left: 20px; + } + + .gridPage #video main > div { + width: 80%; + min-width: 280px; + } + + .bullet { + width: 100%; + } +} diff --git a/docs/admin/authentication.md b/docs/admin/authentication.md index 4bbd0a4fee..a7cca01126 100644 --- a/docs/admin/authentication.md +++ b/docs/admin/authentication.md @@ -29,9 +29,9 @@ stored as `Secrets`, which are mounted into pods allowing in cluster processes 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 API server, +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 API server, or be treated as an anonymous user. ## Authentication strategies @@ -58,7 +58,7 @@ When multiple are enabled, the first authenticator module to successfully authenticate the request short-circuits evaluation. The API server does not guarantee the order authenticators run in. -The `system:authenticated` group is included in the list of groups for all authenticated users. +The `system:authenticated` group is included in the list of groups for all authenticated users. ### X509 Client Certs @@ -116,10 +116,11 @@ authentication is currently supported for convenience while we finish making the more secure modes described above easier to use. The basic auth file format is implemented in `plugin/pkg/auth/authenticator/password/passwordfile/...` -and is a csv file with 3 columns: password, user name, user id. +and is a csv file with a minimum of 3 columns: password, user name, user id, followed by +optional group names. Note, if you have more than one group the column must be double quoted e.g. ```conf -password,user,uid +password,user,uid,"group1,group2,group3" ``` When using basic authentication from an http client, the API server expects an `Authorization` header @@ -222,44 +223,121 @@ from the OAuth2 [token response](https://openid.net/specs/openid-connect-core-1_ as a bearer token. See [above](#putting-a-bearer-token-in-a-request) for how the token is included in a request. -To enable the plugin, pass the following required flags: +![Kubernetes OpenID Connect Flow](/images/docs/admin/k8s_oidc_login.svg) -* `--oidc-issuer-url` URL of the provider which allows the API server to discover -public signing keys. Only URLs which use the `https://` scheme are accepted. This is typically -the provider's URL without a path, for example "https://accounts.google.com" or "https://login.salesforce.com". +1. Login to your identity provider +2. Your identity provider will provide you with an `access_token`, `id_token` and a `refresh_token` +3. When using `kubectl`, use your `id_token` with the `--token` flag or add it directly to your `kubeconfig` +4. `kubectl` sends your `id_token` in a header called Authorization to the API server +5. The API server will make sure the JWT signature is valid by checking against the certificate named in the configuration +6. Check to make sure the `id_token` hasn't expired +7. Make sure the user is authorized +8. Once authorized the API server returns a response to `kubectl` +9. `kubectl` provides feedback to the user -* `--oidc-client-id` A client id that all tokens must be issued for. +Since all of the data needed to validate who you are is in the `id_token`, Kubernetes doesn't need to +"phone home" to the identity provider. In a model where every request is stateless this provides a very scalable +solution for authentication. It does offer a few challenges: + +1. Kubernetes has no "web interface" to trigger the authentication process. There is no browser or interface to collect credentials which is why you need to authenticate to your identity provider first. +2. The `id_token` can't be revoked, its like a certificate so it should be short-lived (only a few minutes) so it can be very annoying to have to get a new token every few minutes +3. There's no easy way to authenticate to the Kubernetes dashboard without using the `kubectl -proxy` command or a reverse proxy that injects the `id_token` + + +#### Configuring the API Server + +To enable the plugin, configure the following flags on the API server: + +| Parameter | Description | Example | Required | +| --------- | ----------- | ------- | ------- | +| --oidc-issuer-url | URL of the provider which allows the API server to discover public signing keys. Only URLs which use the `https://` scheme are accepted. This is typically the provider's discovery URL without a path, for example "https://accounts.google.com" or "https://login.salesforce.com". This URL should point to the level below .well-known/openid-configuration | If the discovery URL is https://accounts.google.com/.well-known/openid-configuration the value should be https://accounts.google.com | Yes | +| --oidc-client-id | A client id that all tokens must be issued for. | kubernetes | Yes | +| --oidc-username-claim | JWT claim to use as the user name. By default `sub`, which is expected to be a unique identifier of the end user. Admins can choose other claims, such as `email`, depending on their provider. | sub | No | +| --oidc-groups-claim | JWT claim to use as the user's group. If the claim is present it must be an array of strings. | groups | No | +| --oidc-ca-file | The path to the certificate for the CA that signed your identity provider's web certificate. Defaults to the host's root CAs. | `/etc/kubernetes/ssl/kc-ca.pem` | No | Importantly, the API server is not an OAuth2 client, rather it can only be -configured to trust a single client. This allows the use of public providers, +configured to trust a single issuer. This allows the use of public providers, such as Google, without trusting credentials issued to third parties. Admins who -wish utilize multiple OAuth clients should explore providers which support the +wish to utilize multiple OAuth clients should explore providers which support the `azp` (authorized party) claim, a mechanism for allowing one client to issue tokens on behalf of another. -The plugin also accepts the following optional flags: - -* `--oidc-ca-file` Used by the API server to establish and verify the secure -connection to the issuer. Defaults to the host's root CAs. - -And experimental flags: - -* `--oidc-username-claim` JWT claim to use as the user name. By default `sub`, -which is expected to be a unique identifier of the end user. Admins can choose -other claims, such as `email`, depending on their provider. -* `--oidc-groups-claim` JWT claim to use as the user's group. If the claim is present -it must be an array of strings. - Kubernetes does not provide an OpenID Connect Identity Provider. You can use an existing public OpenID Connect Identity Provider (such as Google, or [others](http://connect2id.com/products/nimbus-oauth-openid-connect-sdk/openid-connect-providers)). -Or, you can run your own Identity Provider, such as CoreOS [dex](https://github.com/coreos/dex), [Keycloak](https://github.com/keycloak/keycloak) or CloudFoundry [UAA](https://github.com/cloudfoundry/uaa). +Or, you can run your own Identity Provider, such as CoreOS [dex](https://github.com/coreos/dex), [Keycloak](https://github.com/keycloak/keycloak), CloudFoundry [UAA](https://github.com/cloudfoundry/uaa), or Tremolo Security's [OpenUnison](https://github.com/tremolosecurity/openunison). -The provider needs to support [OpenID connect discovery](https://openid.net/specs/openid-connect-discovery-1_0.html); not all do. +For an identity provider to work with Kubernetes it must: + +1. Support [OpenID connect discovery](https://openid.net/specs/openid-connect-discovery-1_0.html); not all do. +2. Run in TLS with non-obsolete ciphers +3. Have a CA signed certificate (even if the CA is not a commercial CA or is self signed) + +A note about requirement #3 above, requiring a CA signed certificate. If you deploy your own identity provider (as opposed to one of the cloud providers like Google or Microsoft) you MUST have your identity provider's web server certificate signed by a certificate with the `CA` flag set to `TRUE`, even if it is self signed. This is due to GoLang's TLS client implementation being very strict to the standards around certificate validation. If you don't have a CA handy, you can use this script from the CoreOS team to create a simple CA and a signed certificate and key pair - https://github.com/coreos/dex/blob/1ee5920c54f5926d6468d2607c728b71cfe98092/examples/k8s/gencert.sh or this script based on it that will generate SHA256 certs with a longer life and larger key size https://raw.githubusercontent.com/TremoloSecurity/openunison-qs-kubernetes/master/makecerts.sh. Setup instructions for specific systems: - [UAA](http://apigee.com/about/blog/engineering/kubernetes-authentication-enterprise) - [Dex](https://speakerdeck.com/ericchiang/kubernetes-access-control-with-dex) +- [OpenUnison](https://github.com/TremoloSecurity/openunison-qs-kubernetes) + +#### Using kubectl + +##### Option 1 - OIDC Authenticator + +The first option is to use the `oidc` authenticator. This authenticator takes your `id_token`, `refresh_token` and your OIDC `client_secret` and will refresh your token automatically. Once you have authenticated to your identity provider: + +```bash +kubectl config set-credentials USER_NAME \ + --auth-provider=oidc + --auth-provider-arg=idp-issuer-url=( issuer url ) \ + --auth-provider-arg=client-id=( your client id ) \ + --auth-provider-arg=client-secret=( your client secret ) \ + --auth-provider-arg=refresh-token=( your refresh token ) \ + --auth-provider-arg=idp-certificate-authority=( path to your ca certificate ) \ + --auth-provider-arg=id-token=( your id_token ) +``` + +As an example, running the below command after authenticating to your identity provider: + +```bash +kubectl config set-credentials mmosley \ + --auth-provider=oidc \ + --auth-provider-arg=idp-issuer-url=https://oidcidp.tremolo.lan:8443/auth/idp/OidcIdP \ + --auth-provider-arg=client-id=kubernetes \ + --auth-provider-arg=client-secret=1db158f6-177d-4d9c-8a8b-d36869918ec5 \ + --auth-provider-arg=refresh-token=q1bKLFOyUiosTfawzA93TzZIDzH2TNa2SMm0zEiPKTUwME6BkEo6Sql5yUWVBSWpKUGphaWpxSVAfekBOZbBhaEW+VlFUeVRGcluyVF5JT4+haZmPsluFoFu5XkpXk5BXqHega4GAXlF+ma+vmYpFcHe5eZR+slBFpZKtQA= \ + --auth-provider-arg=idp-certificate-authority=/root/ca.pem \ + --auth-provider-arg=id-token=eyJraWQiOiJDTj1vaWRjaWRwLnRyZW1vbG8ubGFuLCBPVT1EZW1vLCBPPVRybWVvbG8gU2VjdXJpdHksIEw9QXJsaW5ndG9uLCBTVD1WaXJnaW5pYSwgQz1VUy1DTj1rdWJlLWNhLTEyMDIxNDc5MjEwMzYwNzMyMTUyIiwiYWxnIjoiUlMyNTYifQ.eyJpc3MiOiJodHRwczovL29pZGNpZHAudHJlbW9sby5sYW46ODQ0My9hdXRoL2lkcC9PaWRjSWRQIiwiYXVkIjoia3ViZXJuZXRlcyIsImV4cCI6MTQ4MzU0OTUxMSwianRpIjoiMm96US15TXdFcHV4WDlHZUhQdy1hZyIsImlhdCI6MTQ4MzU0OTQ1MSwibmJmIjoxNDgzNTQ5MzMxLCJzdWIiOiI0YWViMzdiYS1iNjQ1LTQ4ZmQtYWIzMC0xYTAxZWU0MWUyMTgifQ.w6p4J_6qQ1HzTG9nrEOrubxIMb9K5hzcMPxc9IxPx2K4xO9l-oFiUw93daH3m5pluP6K7eOE6txBuRVfEcpJSwlelsOsW8gb8VJcnzMS9EnZpeA0tW_p-mnkFc3VcfyXuhe5R3G7aa5d8uHv70yJ9Y3-UhjiN9EhpMdfPAoEB9fYKKkJRzF7utTTIPGrSaSU6d2pcpfYKaxIwePzEkT4DfcQthoZdy9ucNvvLoi1DIC-UocFD8HLs8LYKEqSxQvOcvnThbObJ9af71EwmuE21fO5KzMW20KtAeget1gnldOosPtz1G5EwvaQ401-RPQzPGMVBld0_zMCAwZttJ4knw +``` + +Which would produce the below configuration: + +```yaml +users: +- name: mmosley + user: + auth-provider: + config: + client-id: kubernetes + client-secret: 1db158f6-177d-4d9c-8a8b-d36869918ec5 + id-token: eyJraWQiOiJDTj1vaWRjaWRwLnRyZW1vbG8ubGFuLCBPVT1EZW1vLCBPPVRybWVvbG8gU2VjdXJpdHksIEw9QXJsaW5ndG9uLCBTVD1WaXJnaW5pYSwgQz1VUy1DTj1rdWJlLWNhLTEyMDIxNDc5MjEwMzYwNzMyMTUyIiwiYWxnIjoiUlMyNTYifQ.eyJpc3MiOiJodHRwczovL29pZGNpZHAudHJlbW9sby5sYW46ODQ0My9hdXRoL2lkcC9PaWRjSWRQIiwiYXVkIjoia3ViZXJuZXRlcyIsImV4cCI6MTQ4MzU0OTUxMSwianRpIjoiMm96US15TXdFcHV4WDlHZUhQdy1hZyIsImlhdCI6MTQ4MzU0OTQ1MSwibmJmIjoxNDgzNTQ5MzMxLCJzdWIiOiI0YWViMzdiYS1iNjQ1LTQ4ZmQtYWIzMC0xYTAxZWU0MWUyMTgifQ.w6p4J_6qQ1HzTG9nrEOrubxIMb9K5hzcMPxc9IxPx2K4xO9l-oFiUw93daH3m5pluP6K7eOE6txBuRVfEcpJSwlelsOsW8gb8VJcnzMS9EnZpeA0tW_p-mnkFc3VcfyXuhe5R3G7aa5d8uHv70yJ9Y3-UhjiN9EhpMdfPAoEB9fYKKkJRzF7utTTIPGrSaSU6d2pcpfYKaxIwePzEkT4DfcQthoZdy9ucNvvLoi1DIC-UocFD8HLs8LYKEqSxQvOcvnThbObJ9af71EwmuE21fO5KzMW20KtAeget1gnldOosPtz1G5EwvaQ401-RPQzPGMVBld0_zMCAwZttJ4knw + idp-certificate-authority: /root/ca.pem + idp-issuer-url: https://oidcidp.tremolo.lan:8443/auth/idp/OidcIdP + refresh-token: q1bKLFOyUiosTfawzA93TzZIDzH2TNa2SMm0zEiPKTUwME6BkEo6Sql5yUWVBSWpKUGphaWpxSVAfekBOZbBhaEW+VlFUeVRGcluyVF5JT4+haZmPsluFoFu5XkpXk5BXq + name: oidc +``` +Once your `id_token` expires, `kubectl` will attempt to refresh your `id_token` using your `refresh_token` and `client_secret` storing the new values for the `refresh_token` and `id_token` in your `kube/.config`. + + +##### Option 2 - Use the `--token` Option + +The `kubectl` command lets you pass in a token using the `--token` option. Simply copy and paste the `id_token` into this option: + +``` +kubectl --token=eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwczovL21sYi50cmVtb2xvLmxhbjo4MDQzL2F1dGgvaWRwL29pZGMiLCJhdWQiOiJrdWJlcm5ldGVzIiwiZXhwIjoxNDc0NTk2NjY5LCJqdGkiOiI2RDUzNXoxUEpFNjJOR3QxaWVyYm9RIiwiaWF0IjoxNDc0NTk2MzY5LCJuYmYiOjE0NzQ1OTYyNDksInN1YiI6Im13aW5kdSIsInVzZXJfcm9sZSI6WyJ1c2VycyIsIm5ldy1uYW1lc3BhY2Utdmlld2VyIl0sImVtYWlsIjoibXdpbmR1QG5vbW9yZWplZGkuY29tIn0.f2As579n9VNoaKzoF-dOQGmXkFKf1FMyNV0-va_B63jn-_n9LGSCca_6IVMP8pO-Zb4KvRqGyTP0r3HkHxYy5c81AnIh8ijarruczl-TK_yF5akjSTHFZD-0gRzlevBDiH8Q79NAr-ky0P4iIXS8lY9Vnjch5MF74Zx0c3alKJHJUnnpjIACByfF2SCaYzbWFMUNat-K1PaUk5-ujMBG7yYnr95xD-63n8CO8teGUAAEMx6zRjzfhnhbzX-ajwZLGwGUBT4WqjMs70-6a7_8gZmLZb2az1cZynkFRj2BaCkVT3A2RrjeEwZEtGXlMqKJ1_I2ulrOVsYx01_yD35-rw get nodes +``` + ### Webhook Token Authentication @@ -369,12 +447,12 @@ HTTP status codes can be used to supply additional error context. The API server can be configured to identify users from request header values, such as `X-Remote-User`. It is designed for use in combination with an authenticating proxy, which sets the request header value. In order to prevent header spoofing, the authenticating proxy is required to present a valid client -certificate to the API server for validation against the specified CA before the request headers are +certificate to the API server for validation against the specified CA before the request headers are checked. * `--requestheader-username-headers` Required, case-insensitive. Header names to check, in order, for the user identity. The first header containing a value is used as the identity. * `--requestheader-client-ca-file` Required. PEM-encoded certificate bundle. A valid client certificate must be presented and validated against the certificate authorities in the specified file before the request headers are checked for user names. -* `--requestheader-allowed-names` Optional. List of common names (cn). If set, a valid client certificate with a Common Name (cn) in the specified list must be presented before the request headers are checked for user names. If empty, any Common Name is allowed. +* `--requestheader-allowed-names` Optional. List of common names (cn). If set, a valid client certificate with a Common Name (cn) in the specified list must be presented before the request headers are checked for user names. If empty, any Common Name is allowed. ### Keystone Password @@ -402,18 +480,18 @@ changes](https://github.com/kubernetes/kubernetes/pull/25536) for more details. ## Anonymous requests -Anonymous access is enabled by default, and can be disabled by passing `--anonymous-auth=false` +Anonymous access is enabled by default, and can be disabled by passing `--anonymous-auth=false` option to the API server during startup. -When enabled, requests that are not rejected by other configured authentication methods are -treated as anonymous requests, and given a username of `system:anonymous` and a group of +When enabled, requests that are not rejected by other configured authentication methods are +treated as anonymous requests, and given a username of `system:anonymous` and a group of `system:unauthenticated`. For example, on a server with token authentication configured, and anonymous access enabled, -a request providing an invalid bearer token would receive a `401 Unauthorized` error. -A request providing no bearer token would be treated as an anonymous request. +a request providing an invalid bearer token would receive a `401 Unauthorized` error. +A request providing no bearer token would be treated as an anonymous request. -If you rely on authentication alone to authorize access, either change to use an +If you rely on authentication alone to authorize access, either change to use an authorization mode other than `AlwaysAllow`, or set `--anonymous-auth=false`. ## Plugin Development diff --git a/docs/admin/authorization.md b/docs/admin/authorization.md index 8f2b60472c..11b7cabeb2 100644 --- a/docs/admin/authorization.md +++ b/docs/admin/authorization.md @@ -85,8 +85,8 @@ properties: - `kind`, type string: valid values are "Policy". Allows versioning and conversion of the policy format. - `spec` property set to a map with the following properties: - Subject-matching properties: - - `user`, type string; the user-string from `--token-auth-file`. If you specify `user`, it must match the username of the authenticated user. `*` matches all requests. - - `group`, type string; if you specify `group`, it must match one of the groups of the authenticated user. `*` matches all requests. + - `user`, type string; the user-string from `--token-auth-file`. If you specify `user`, it must match the username of the authenticated user. + - `group`, type string; if you specify `group`, it must match one of the groups of the authenticated user. `system:authenticated` matches all authenticated requests. `system:unauthenticated` matches all unauthenticated requests. - `readonly`, type boolean, when true, means that the policy only applies to get, list, and watch operations. - Resource-matching properties: - `apiGroup`, type string; an API group, such as `extensions`. `*` matches all API groups. @@ -115,8 +115,11 @@ The tuple of attributes is checked for a match against every policy in the policy file. If at least one line matches the request attributes, then the request is authorized (but may fail later validation). -To permit any user to do something, write a policy with the user property set to -`"*"`. +To permit any authenticated user to do something, write a policy with the +group property set to `"system:authenticated"`. + +To permit any unauthenticated user to do something, write a policy with the +group property set to `"system:unauthenticated"`. To permit a user to do anything, write a policy with the apiGroup, namespace, resource, and nonResourcePath properties set to `"*"`. @@ -165,7 +168,8 @@ up the verbosity: 5. Anyone can make read-only requests to all non-resource paths: ```json - {"apiVersion": "abac.authorization.kubernetes.io/v1beta1", "kind": "Policy", "spec": {"user": "*", "readonly": true, "nonResourcePath": "*"}} + {"apiVersion": "abac.authorization.kubernetes.io/v1beta1", "kind": "Policy", "spec": {"group": "system:authenticated", "readonly": true, "nonResourcePath": "*"}} + {"apiVersion": "abac.authorization.kubernetes.io/v1beta1", "kind": "Policy", "spec": {"group": "system:unauthenticated", "readonly": true, "nonResourcePath": "*"}} ``` [Complete file example](http://releases.k8s.io/{{page.githubbranch}}/pkg/auth/authorizer/abac/example_policy_file.jsonl) @@ -504,7 +508,7 @@ An example request body: "resourceAttributes": { "namespace": "kittensandponies", "verb": "GET", - "group": "*", + "group": "unicorn.example.org", "resource": "pods" }, "user": "jane", @@ -627,7 +631,7 @@ __EOF__ --- snip lots of output --- -I0913 08:12:31.362873 27425 request.go:908] Response Body: {"kind":"SubjectAccessReview","apiVersion":"authorization.k8s.io/v1beta1","metadata":{"creationTimestamp":null},"spec":{"resourceAttributes":{"namespace":"kittensandponies","verb":"GET","group":"*","resource":"pods"},"user":"jane","group":["group1","group2"]},"status":{"allowed":true}} +I0913 08:12:31.362873 27425 request.go:908] Response Body: {"kind":"SubjectAccessReview","apiVersion":"authorization.k8s.io/v1beta1","metadata":{"creationTimestamp":null},"spec":{"resourceAttributes":{"namespace":"kittensandponies","verb":"GET","group":"unicorn.example.org","resource":"pods"},"user":"jane","group":["group1","group2"]},"status":{"allowed":true}} subjectaccessreview "" created ``` diff --git a/docs/admin/cluster-components.md b/docs/admin/cluster-components.md index 8519a199f4..a3d4f37779 100644 --- a/docs/admin/cluster-components.md +++ b/docs/admin/cluster-components.md @@ -107,7 +107,7 @@ the Kubernetes runtime environment. or via local configuration file) and: * Mounts the pod's required volumes * Downloads the pod's secrets -* Run the pod's containers via docker (or, experimentally, rkt). +* Runs the pod's containers via docker (or, experimentally, rkt). * Periodically executes any requested container liveness probes. * Reports the status of the pod back to the rest of the system, by creating a "mirror pod" if necessary. diff --git a/docs/admin/cluster-large.md b/docs/admin/cluster-large.md index 08d6d6c0d8..13788fdffb 100644 --- a/docs/admin/cluster-large.md +++ b/docs/admin/cluster-large.md @@ -99,13 +99,13 @@ To avoid running into cluster addon resource issues, when creating a cluster wit * Scale memory and CPU limits for each of the following addons, if used, as you scale up the size of cluster (there is one replica of each handling the entire cluster so memory and CPU usage tends to grow proportionally with size/load on cluster): * [InfluxDB and Grafana](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/cluster-monitoring/influxdb/influxdb-grafana-controller.yaml) - * [skydns, kube2sky, and dns etcd](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/dns/skydns-rc.yaml.in) + * [kubedns, dnsmasq, and sidecar](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/dns/kubedns-controller.yaml.in) * [Kibana](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/fluentd-elasticsearch/kibana-controller.yaml) * Scale number of replicas for the following addons, if used, along with the size of cluster (there are multiple replicas of each so increasing replicas should help handle increased load, but, since load per replica also increases slightly, also consider increasing CPU/memory limits): * [elasticsearch](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/fluentd-elasticsearch/es-controller.yaml) * Increase memory and CPU limits slightly for each of the following addons, if used, along with the size of cluster (there is one replica per node but CPU/memory usage increases slightly along with cluster load/size as well): - * [FluentD with ElasticSearch Plugin](http://releases.k8s.io/{{page.githubbranch}}/cluster/saltbase/salt/fluentd-es/fluentd-es.yaml) - * [FluentD with GCP Plugin](http://releases.k8s.io/{{page.githubbranch}}/cluster/saltbase/salt/fluentd-gcp/fluentd-gcp.yaml) + * [FluentD with ElasticSearch Plugin](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/fluentd-elasticsearch/fluentd-es-ds.yaml) + * [FluentD with GCP Plugin](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/fluentd-gcp/fluentd-gcp-ds.yaml) Heapster's resource limits are set dynamically based on the initial size of your cluster (see [#16185](http://issue.k8s.io/16185) and [#22940](http://issue.k8s.io/22940)). If you find that Heapster is running diff --git a/docs/admin/cluster-management.md b/docs/admin/cluster-management.md index 5bcdb8b8f3..310128fd77 100644 --- a/docs/admin/cluster-management.md +++ b/docs/admin/cluster-management.md @@ -159,11 +159,11 @@ node discovery; currently this is only Google Compute Engine, not including Core ### Upgrading to a different API version -When a new API version is released, you may need to upgrade a cluster to support the new API version (e.g. switching from 'v1' to 'v2' when 'v2' is launched) +When a new API version is released, you may need to upgrade a cluster to support the new API version (e.g. switching from 'v1' to 'v2' when 'v2' is launched). This is an infrequent event, but it requires careful management. There is a sequence of steps to upgrade to a new API version. - 1. Turn on the new api version. + 1. Turn on the new API version. 1. Upgrade the cluster's storage to use the new version. 1. Upgrade all config files. Identify users of the old API version endpoints. 1. Update existing objects in the storage to new version by running `cluster/update-storage-objects.sh`. @@ -171,9 +171,9 @@ This is an infrequent event, but it requires careful management. There is a sequ ### Turn on or off an API version for your cluster -Specific API versions can be turned on or off by passing --runtime-config=api/ flag while bringing up the API server. For example: to turn off v1 API, pass `--runtime-config=api/v1=false`. +Specific API versions can be turned on or off by passing `--runtime-config=api/` flag while bringing up the API server. For example: to turn off v1 API, pass `--runtime-config=api/v1=false`. runtime-config also supports 2 special keys: api/all and api/legacy to control all and legacy APIs respectively. -For example, for turning off all api versions except v1, pass `--runtime-config=api/all=false,api/v1=true`. +For example, for turning off all API versions except v1, pass `--runtime-config=api/all=false,api/v1=true`. For the purposes of these flags, _legacy_ APIs are those APIs which have been explicitly deprecated (e.g. `v1beta3`). ### Switching your cluster's storage API version diff --git a/docs/admin/cluster-troubleshooting.md b/docs/admin/cluster-troubleshooting.md index ff8358a7a9..7e11eb12b0 100644 --- a/docs/admin/cluster-troubleshooting.md +++ b/docs/admin/cluster-troubleshooting.md @@ -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 @@ -112,4 +112,4 @@ Mitigations: - Mitigates: Kubelet software fault - Action: [Multiple independent clusters](/docs/admin/multi-cluster) (and avoid making risky changes to all clusters at once) - - Mitigates: Everything listed above. \ No newline at end of file + - Mitigates: Everything listed above. diff --git a/docs/admin/dns.md b/docs/admin/dns.md index 407c439b73..7a845c9f3f 100644 --- a/docs/admin/dns.md +++ b/docs/admin/dns.md @@ -47,8 +47,8 @@ selection from the set. ### SRV records -SRV Records are created for named ports that are part of normal or Headless -Services. +SRV Records are created for named ports that are part of normal or [Headless +Services](http://releases.k8s.io/docs/user-guide/services/#headless-services). For each named port, the SRV record would have the form `_my-port-name._my-port-protocol.my-svc.my-namespace.svc.cluster.local`. For a regular service, this resolves to the port number and the CNAME: @@ -69,7 +69,7 @@ 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 @@ -280,7 +280,7 @@ If you see that no pod is running or that the pod has failed/completed, the DNS 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 kube-dns +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 dnsmasq kubectl logs --namespace=kube-system $(kubectl get pods --namespace=kube-system -l k8s-app=kube-dns -o name) -c healthz ``` @@ -308,7 +308,7 @@ If you have created the service or in the case it should be created by default b #### Are DNS endpoints exposed? -You can verify that dns endpoints are exposed by using the `kubectl get endpoints` command. +You can verify that DNS endpoints are exposed by using the `kubectl get endpoints` command. ``` kubectl get ep kube-dns --namespace=kube-system diff --git a/docs/admin/federation/index.md b/docs/admin/federation/index.md index 59a0199d7b..bb15fe09ff 100644 --- a/docs/admin/federation/index.md +++ b/docs/admin/federation/index.md @@ -236,7 +236,7 @@ metadata: name: kube-dns namespace: kube-system data: - federations: = + federations: = ``` where `` should be replaced by the name you want to give to your @@ -249,7 +249,7 @@ http://kubernetes.io/docs/user-guide/configmap/. ### Kubernetes 1.4 and earlier: Setting federations flag on kube-dns-rc -If your cluster is running Kubernetes version 1.4 or earlier, you must to restart +If your cluster is running Kubernetes version 1.4 or earlier, you must restart KubeDNS and pass it a `--federations` flag, which tells it about valid federation DNS hostnames. The flag uses the following format: diff --git a/docs/admin/garbage-collection.md b/docs/admin/garbage-collection.md index 3a8ecda475..a960172426 100644 --- a/docs/admin/garbage-collection.md +++ b/docs/admin/garbage-collection.md @@ -7,7 +7,7 @@ title: Configuring kubelet Garbage Collection * TOC {:toc} -Garbage collection is a helpful function of kubelet that will clean up unused images and unused containers. kubelet will perform garbage collection for containers every minute and garbage collection for images every five minutes. +Garbage collection is a helpful function of kubelet that will clean up unused images and unused containers. Kubelet will perform garbage collection for containers every minute and garbage collection for images every five minutes. External garbage collection tools are not recommended as these tools can potentially break the behavior of kubelet by removing containers expected to exist. @@ -24,7 +24,7 @@ threshold has been met. ### Container Collection The policy for garbage collecting containers considers three user-defined variables. `MinAge` is the minimum age at which a container can be garbage collected. `MaxPerPodContainer` is the maximum number of dead containers any single -pod (UID, container name) pair is allowed to have. `MaxContainers` is the maximum number of total dead containers. These variables can be individually disabled by setting 'Min Age' to zero and setting 'MaxPerPodContainer' and 'MaxContainers' respectively to less than zero. +pod (UID, container name) pair is allowed to have. `MaxContainers` is the maximum number of total dead containers. These variables can be individually disabled by setting 'MinAge' to zero and setting 'MaxPerPodContainer' and 'MaxContainers' respectively to less than zero. Kubelet will act on containers that are unidentified, deleted, or outside of the boundaries set by the previously mentioned flags. The oldest containers will generally be removed first. 'MaxPerPodContainer' and 'MaxContainer' may potentially conflict with each other in situations where retaining the maximum number of containers per pod ('MaxPerPodContainer') would go outside the allowable range of global dead containers ('MaxContainers'). 'MaxPerPodContainer' would be adjusted in this situation: A worst case scenario would be to downgrade 'MaxPerPodContainer' to 1 and evict the oldest containers. Additionally, containers owned by pods that have been deleted are removed once they are older than `MinAge`. diff --git a/docs/admin/ha-master-gce.md b/docs/admin/ha-master-gce.md index 91e0019272..025035cca7 100644 --- a/docs/admin/ha-master-gce.md +++ b/docs/admin/ha-master-gce.md @@ -84,7 +84,7 @@ The following sample commands demonstrate this process: $ KUBE_DELETE_NODES=false KUBE_GCE_ZONE=replica_zone KUBE_REPLICA_NAME=replica_name ./cluster/kube-down.sh ``` -2. Add a new replica in place of the old one: +
  1. Add a new replica in place of the old one:
```shell $ KUBE_GCE_ZONE=replica-zone KUBE_REPLICATE_EXISTING_MASTER=true ./cluster/kube-up.sh @@ -102,7 +102,7 @@ A two-replica cluster is thus inferior, in terms of HA, to a single replica clus * When you add a master replica, cluster state (etcd) is copied to a new instance. If the cluster is large, it may take a long time to duplicate its state. -This operation may be speed up by migrating etcd data directory, as described [here](https://coreos.com/etcd/docs/latest/admin_guide.html#member-migration) here +This operation may be sped up by migrating etcd data directory, as described [here](https://coreos.com/etcd/docs/latest/admin_guide.html#member-migration) (we are considering adding support for etcd data dir migration in future). ## Implementation notes diff --git a/docs/admin/index.md b/docs/admin/index.md index d4111691c6..f1904aa470 100644 --- a/docs/admin/index.md +++ b/docs/admin/index.md @@ -61,7 +61,7 @@ project](/docs/admin/salt). * **DNS Integration with SkyDNS** ([dns.md](/docs/admin/dns)): Resolving a DNS name directly to a Kubernetes service. -* [**Cluster-level logging**](/docs/user-guide/logging/overview) +* [**Cluster-level logging**](/docs/user-guide/logging/overview): Saving container logs to a central log store with search/browsing interface. ## Multi-tenant support diff --git a/docs/admin/limitrange/index.md b/docs/admin/limitrange/index.md index 2241cbb140..3a31b9e732 100644 --- a/docs/admin/limitrange/index.md +++ b/docs/admin/limitrange/index.md @@ -23,7 +23,7 @@ to 512MB of memory. The cluster operator creates a separate namespace for each each namespace. 3. Users may create a pod which consumes resources just below the capacity of a machine. The left over space may be too small to be useful, but big enough for the waste to be costly over the entire cluster. As a result, -the cluster operator may want to set limits that a pod must consume at least 20% of the memory and cpu of their +the cluster operator may want to set limits that a pod must consume at least 20% of the memory and CPU of their average node size in order to provide for more uniform scheduling and to limit waste. This example demonstrates how limits can be applied to a Kubernetes [namespace](/docs/admin/namespaces/walkthrough/) to control @@ -101,7 +101,7 @@ The limits enumerated in a namespace are only enforced when a pod is created or the cluster. If you change the limits to a different value range, it does not affect pods that were previously created in a namespace. -If a resource (cpu or memory) is being restricted by a limit, the user will get an error at time +If a resource (CPU or memory) is being restricted by a limit, the user will get an error at time of creation explaining why. Let's first spin up a [Deployment](/docs/user-guide/deployments) that creates a single container Pod to demonstrate @@ -145,9 +145,9 @@ spec: volumeMounts: ``` -Note that our nginx container has picked up the namespace default cpu and memory resource *limits* and *requests*. +Note that our nginx container has picked up the namespace default CPU and memory resource *limits* and *requests*. -Let's create a pod that exceeds our allowed limits by having it have a container that requests 3 cpu cores. +Let's create a pod that exceeds our allowed limits by having it have a container that requests 3 CPU cores. ```shell $ kubectl create -f docs/admin/limitrange/invalid-pod.yaml --namespace=limit-example diff --git a/docs/admin/master-node-communication.md b/docs/admin/master-node-communication.md index 91ecff7ef9..d654fd5173 100644 --- a/docs/admin/master-node-communication.md +++ b/docs/admin/master-node-communication.md @@ -91,7 +91,7 @@ HTTP connections and are therefore neither authenticated nor encrypted. They can be run over a secure HTTPS connection by prefixing `https:` to the node, pod, or service name in the API URL, but they will not validate the certificate provided by the HTTPS endpoint nor provide client credentials so while the -connection will by encrypted, it will not provide any guarantees of integrity. +connection will be encrypted, it will not provide any guarantees of integrity. These connections **are not currently safe** to run over untrusted and/or public networks. diff --git a/docs/admin/multi-cluster.md b/docs/admin/multi-cluster.md index 67a2589d40..085a9afa9f 100644 --- a/docs/admin/multi-cluster.md +++ b/docs/admin/multi-cluster.md @@ -8,7 +8,7 @@ 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 @@ -40,7 +40,7 @@ Reasons to have multiple clusters include: ## Selecting the right number of clusters The selection of the number of Kubernetes clusters may be a relatively static choice, only revisited occasionally. -By contrast, the number of nodes in a cluster and the number of pods in a service may be change frequently according to +By contrast, the number of nodes in a cluster and the number of pods in a service may change frequently according to load and growth. To pick the number of clusters, first, decide which regions you need to be in to have adequate latency to all your end users, for services that will run diff --git a/docs/admin/multiple-schedulers.md b/docs/admin/multiple-schedulers.md index eb1c4c44f9..bf7386e492 100644 --- a/docs/admin/multiple-schedulers.md +++ b/docs/admin/multiple-schedulers.md @@ -26,7 +26,7 @@ and build the source. ```shell git clone https://github.com/kubernetes/kubernetes.git cd kubernetes -hack/build-go.sh +make ``` Create a container image containing the kube-scheduler binary. Here is the `Dockerfile` @@ -107,6 +107,7 @@ scheduler as an annotation in that pod spec. Let's look at three examples. ```shell kubectl create -f pod1.yaml ``` + 2. Pod spec with `default-scheduler` annotation {% include code.html language="yaml" file="multiple-schedulers/pod2.yaml" ghlink="/docs/admin/multiple-schedulers/pod2.yaml" %} @@ -120,6 +121,7 @@ scheduler as an annotation in that pod spec. Let's look at three examples. ```shell kubectl create -f pod2.yaml ``` + 3. Pod spec with `my-scheduler` annotation {% include code.html language="yaml" file="multiple-schedulers/pod3.yaml" ghlink="/docs/admin/multiple-schedulers/pod3.yaml" %} diff --git a/docs/admin/multiple-zones.md b/docs/admin/multiple-zones.md index e215b31716..b6421e71c2 100644 --- a/docs/admin/multiple-zones.md +++ b/docs/admin/multiple-zones.md @@ -51,7 +51,7 @@ admission controller automatically adds zone labels to them. The scheduler (via `VolumeZonePredicate` predicate) will then 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. - + ## Limitations There are some important limitations of the multizone support: @@ -158,8 +158,7 @@ kubernetes-minion-wf8i Ready 2m beta.kubernetes.io ### Volume affinity -Create a volume (only PersistentVolumes are supported for zone -affinity), using the new dynamic volume creation: +Create a volume using the dynamic volume creation (only PersistentVolumes are supported for zone affinity): ```json kubectl create -f - < kubectl get pv --show-labels diff --git a/docs/admin/namespaces/index.md b/docs/admin/namespaces/index.md index b723a9c361..887f14cd91 100644 --- a/docs/admin/namespaces/index.md +++ b/docs/admin/namespaces/index.md @@ -87,6 +87,7 @@ a *Namespace*. See [Admission control: Limit Range](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/admission_control_limit_range.md) A namespace can be in one of two phases: + * `Active` the namespace is in use * `Terminating` the namespace is being deleted, and can not be used for new objects diff --git a/docs/admin/namespaces/walkthrough.md b/docs/admin/namespaces/walkthrough.md index b9c509697c..7576d2c2e0 100644 --- a/docs/admin/namespaces/walkthrough.md +++ b/docs/admin/namespaces/walkthrough.md @@ -63,7 +63,7 @@ Create the development namespace using kubectl. $ kubectl create -f docs/admin/namespaces/namespace-dev.json ``` -And then lets create the production namespace using kubectl. +And then let's create the production namespace using kubectl. ```shell $ kubectl create -f docs/admin/namespaces/namespace-prod.json diff --git a/docs/admin/network-plugins.md b/docs/admin/network-plugins.md index dd51a11b86..d5e05ac7b1 100644 --- a/docs/admin/network-plugins.md +++ b/docs/admin/network-plugins.md @@ -13,7 +13,6 @@ __Disclaimer__: Network plugins are in alpha. Its contents will change rapidly. Network plugins in Kubernetes come in a few flavors: -* Plain vanilla exec plugins - deprecated in favor of CNI plugins. * CNI plugins: adhere to the appc/CNI specification, designed for interoperability. * Kubenet plugin: implements basic `cbr0` using the `bridge` and `host-local` CNI plugins @@ -30,10 +29,6 @@ Besides providing the [`NetworkPlugin` interface](https://github.com/kubernetes/ 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}}/pkg/kubelet/network/exec/exec.go) for more details. - ### CNI The CNI plugin is selected by passing Kubelet the `--network-plugin=cni` command-line option. Kubelet reads a file from `--cni-conf-dir` (default `/etc/cni/net.d`) and uses the CNI configuration from that file to set up each pod's network. The CNI configuration file must match the [CNI specification](https://github.com/containernetworking/cni/blob/master/SPEC.md#network-configuration), and any required CNI plugins referenced by the configuration must be present in `--cni-bin-dir` (default `/opt/cni/bin`). @@ -73,7 +68,6 @@ This option is provided to the network-plugin; currently **only kubenet supports ## Usage Summary -* `--network-plugin=exec` specifies that we use the `exec` plugin, with executables located in `--network-plugin-dir`. * `--network-plugin=cni` specifies that we use the `cni` network plugin with actual CNI plugin binaries located in `--cni-bin-dir` (default `/opt/cni/bin`) and CNI plugin configuration located in `--cni-conf-dir` (default `/etc/cni/net.d`). * `--network-plugin=kubenet` specifies that we use the `kubenet` network plugin with CNI `bridge` and `host-local` plugins placed in `/opt/cni/bin` or `network-plugin-dir`. * `--network-plugin-mtu=9001` specifies the MTU to use, currently only used by the `kubenet` network plugin. diff --git a/docs/admin/networking.md b/docs/admin/networking.md index 08b3d1442e..a2b7d37110 100644 --- a/docs/admin/networking.md +++ b/docs/admin/networking.md @@ -129,7 +129,7 @@ We start Docker with: DOCKER_OPTS="--bridge=cbr0 --iptables=false --ip-masq=false" ``` -This bridge is created by Kubelet (controlled by the `--configure-cbr0=true` +This bridge is created by Kubelet (controlled by the `--network-plugin=kubenet` flag) according to the `Node`'s `spec.podCIDR`. Docker will now allocate IPs from the `cbr-cidr` block. Containers can reach diff --git a/docs/admin/node-problem.md b/docs/admin/node-problem.md index b4f3e6ee31..08ca3208dd 100644 --- a/docs/admin/node-problem.md +++ b/docs/admin/node-problem.md @@ -31,7 +31,7 @@ See more information kernel log now. It doesn't support log tools like journald. * The kernel issue detection of node problem detector has assumption on kernel -log format, now it only works on Ubuntu and Debian. However, it is easy to extend +log format, and now it only works on Ubuntu and Debian. However, it is easy to extend it to [support other log format](/docs/admin/node-problem/#support-other-log-format). ## Enable/Disable in GCE cluster @@ -194,7 +194,7 @@ and detects known kernel issues following predefined rules. The Kernel Monitor matches kernel issues according to a set of predefined rule list in [`config/kernel-monitor.json`](https://github.com/kubernetes/node-problem-detector/blob/v0.1/config/kernel-monitor.json). -The rule list is extensible, you can always extend it by [overwriting the +The rule list is extensible, and you can always extend it by [overwriting the configuration](/docs/admin/node-problem/#overwrite-the-configuration). ### Add New NodeConditions diff --git a/docs/admin/rescheduler.md b/docs/admin/rescheduler.md index 1d81ac63f2..9e3fc61c39 100644 --- a/docs/admin/rescheduler.md +++ b/docs/admin/rescheduler.md @@ -31,10 +31,10 @@ To avoid situation when another pod is scheduled into the space prepared for the 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. +while the other pods shouldn't tolerate the taint. The taint 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 critical pods, so if rescheduler is enabled you pods might be occasionally +in order to schedule critical pods, so if rescheduler is enabled your pods might be occasionally killed for this purpose. ## Config diff --git a/docs/admin/salt.md b/docs/admin/salt.md index ab495521bd..05d0ae9250 100644 --- a/docs/admin/salt.md +++ b/docs/admin/salt.md @@ -92,7 +92,7 @@ In addition, a cluster may be running a Debian based operating system or Red Hat ## Best Practices -1. When configuring default arguments for processes, it's best to avoid the use of EnvironmentFiles (Systemd in Red Hat environments) or init.d files (Debian distributions) to hold default values that should be common across operating system environments. This helps keep our Salt template files easy to understand for editors who may not be familiar with the particulars of each distribution. +When configuring default arguments for processes, it's best to avoid the use of EnvironmentFiles (Systemd in Red Hat environments) or init.d files (Debian distributions) to hold default values that should be common across operating system environments. This helps keep our Salt template files easy to understand for editors who may not be familiar with the particulars of each distribution. ## Future enhancements (Networking) diff --git a/docs/admin/static-pods.md b/docs/admin/static-pods.md index 4766002917..8c9e482d0d 100644 --- a/docs/admin/static-pods.md +++ b/docs/admin/static-pods.md @@ -22,45 +22,45 @@ For example, this is how to start a simple web server as a static pod: 1. Choose a node where we want to run the static pod. In this example, it's `my-node1`. - ```shell - [joe@host ~] $ ssh my-node1 - ``` +```shell +[joe@host ~] $ ssh my-node1 +``` 2. Choose a directory, say `/etc/kubelet.d` and place a web server pod definition there, e.g. `/etc/kubernetes.d/static-web.yaml`: - ```shell - [root@my-node1 ~] $ mkdir /etc/kubernetes.d/ - [root@my-node1 ~] $ cat </etc/kubernetes.d/static-web.yaml - apiVersion: v1 - kind: Pod - metadata: - name: static-web - labels: - role: myrole - spec: - containers: +```shell +[root@my-node1 ~] $ mkdir /etc/kubernetes.d/ +[root@my-node1 ~] $ cat </etc/kubernetes.d/static-web.yaml +apiVersion: v1 +kind: Pod +metadata: + name: static-web + labels: + role: myrole +spec: + containers: + - name: web + image: nginx + ports: - name: web - image: nginx - ports: - - name: web - containerPort: 80 - protocol: tcp - EOF - ``` + containerPort: 80 + protocol: TCP +EOF +``` 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 --pod-manifest-path=/etc/kubelet.d/" - ``` +```conf +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. +Instructions for other distributions or Kubernetes installations may vary. 3. Restart kubelet. On Fedora, this is: - ```shell - [root@my-node1 ~] $ systemctl restart kubelet - ``` +```shell +[root@my-node1 ~] $ systemctl restart kubelet +``` ## Pods created via HTTP diff --git a/docs/api-reference/v1.5/documents/_cluster.md b/docs/api-reference/v1.5/documents/_cluster.md deleted file mode 100644 index 5c74168efb..0000000000 --- a/docs/api-reference/v1.5/documents/_cluster.md +++ /dev/null @@ -1,5 +0,0 @@ -# CLUSTER - -Cluster resources are responsible for defining configuration of the cluster itself, and are generally only used by cluster operators. - ------------- diff --git a/docs/api-reference/v1.5/documents/_config.md b/docs/api-reference/v1.5/documents/_config.md deleted file mode 100644 index 555578e2b3..0000000000 --- a/docs/api-reference/v1.5/documents/_config.md +++ /dev/null @@ -1,11 +0,0 @@ -# CONFIG & STORAGE - -Config and Storage resources are responsible for injecting data into your applications and persisting data externally to your container. - -Common resource types: - -- [ConfigMaps](#configmap-v1) for providing text key value pairs injected into the application through environment variables, command line arguments, or files -- [Secrets](#secret-v1) for providing binary data injected into the application through files -- [Volumes](#volume-v1) for providing a filesystem external to the Container. Maybe shared across Containers within the same Pod and have a lifetime persisting beyond a Container or Pod. - ------------- diff --git a/docs/api-reference/v1.5/documents/_definitions.md b/docs/api-reference/v1.5/documents/_definitions.md deleted file mode 100644 index 337695b8d5..0000000000 --- a/docs/api-reference/v1.5/documents/_definitions.md +++ /dev/null @@ -1,3 +0,0 @@ -# DEFINITIONS - -This section contains definitions for objects used in the Kubernetes APIs. diff --git a/docs/api-reference/v1.5/documents/_generated_apigroup_unversioned_concept.md b/docs/api-reference/v1.5/documents/_generated_apigroup_unversioned_concept.md deleted file mode 100644 index d4732c1cea..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_apigroup_unversioned_concept.md +++ /dev/null @@ -1,46 +0,0 @@ - - ------------ -# APIGroup unversioned - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIGroup - - - - - - - -APIGroup contains the name, the supported versions, and the preferred version of a group. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -name
*string* | name is the name of the group. -preferredVersion
*[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned)* | preferredVersion is the version preferred by the API server, which probably is the storage version. -serverAddressByClientCIDRs
*[ServerAddressByClientCIDR](#serveraddressbyclientcidr-unversioned) array* | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. -versions
*[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned) array* | versions are the versions supported in this group. - - -### APIGroupList unversioned - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -groups
*[APIGroup](#apigroup-unversioned) array* | groups is a list of APIGroup. -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_apigroup_unversioned_definition.md b/docs/api-reference/v1.5/documents/_generated_apigroup_unversioned_definition.md deleted file mode 100644 index d6d1173eb5..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_apigroup_unversioned_definition.md +++ /dev/null @@ -1,22 +0,0 @@ -## APIGroup unversioned - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIGroup - - - -APIGroup contains the name, the supported versions, and the preferred version of a group. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -name
*string* | name is the name of the group. -preferredVersion
*[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned)* | preferredVersion is the version preferred by the API server, which probably is the storage version. -serverAddressByClientCIDRs
*[ServerAddressByClientCIDR](#serveraddressbyclientcidr-unversioned) array* | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. -versions
*[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned) array* | versions are the versions supported in this group. - diff --git a/docs/api-reference/v1.5/documents/_generated_apigrouplist_unversioned_concept.md b/docs/api-reference/v1.5/documents/_generated_apigrouplist_unversioned_concept.md deleted file mode 100644 index 99c9d0d8fe..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_apigrouplist_unversioned_concept.md +++ /dev/null @@ -1,32 +0,0 @@ - - ------------ -# APIGroupList unversioned - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIGroupList - - - - - - - -APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -groups
*[APIGroup](#apigroup-unversioned) array* | groups is a list of APIGroup. -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_apigrouplist_unversioned_definition.md b/docs/api-reference/v1.5/documents/_generated_apigrouplist_unversioned_definition.md deleted file mode 100644 index 6267bf8f48..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_apigrouplist_unversioned_definition.md +++ /dev/null @@ -1,18 +0,0 @@ -## APIGroupList unversioned - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIGroupList - - - -APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -groups
*[APIGroup](#apigroup-unversioned) array* | groups is a list of APIGroup. -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds - diff --git a/docs/api-reference/v1.5/documents/_generated_apiresource_unversioned_concept.md b/docs/api-reference/v1.5/documents/_generated_apiresource_unversioned_concept.md deleted file mode 100644 index 2f87ebff79..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_apiresource_unversioned_concept.md +++ /dev/null @@ -1,44 +0,0 @@ - - ------------ -# APIResource unversioned - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIResource - - - - - - - -APIResource specifies the name of a resource and whether it is namespaced. - - - -Field | Description ------------- | ----------- -kind
*string* | kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo') -name
*string* | name is the name of the resource. -namespaced
*boolean* | namespaced indicates if a resource is namespaced or not. - - -### APIResourceList unversioned - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -groupVersion
*string* | groupVersion is the group and version this APIResourceList is for. -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -resources
*[APIResource](#apiresource-unversioned) array* | resources contains the name of the resources and if they are namespaced. - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_apiresource_unversioned_definition.md b/docs/api-reference/v1.5/documents/_generated_apiresource_unversioned_definition.md deleted file mode 100644 index dd9cd0a727..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_apiresource_unversioned_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## APIResource unversioned - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIResource - - - -APIResource specifies the name of a resource and whether it is namespaced. - - - -Field | Description ------------- | ----------- -kind
*string* | kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo') -name
*string* | name is the name of the resource. -namespaced
*boolean* | namespaced indicates if a resource is namespaced or not. - diff --git a/docs/api-reference/v1.5/documents/_generated_apiresourcelist_unversioned_concept.md b/docs/api-reference/v1.5/documents/_generated_apiresourcelist_unversioned_concept.md deleted file mode 100644 index 5bb170d54c..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_apiresourcelist_unversioned_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# APIResourceList unversioned - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | 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. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -groupVersion
*string* | groupVersion is the group and version this APIResourceList is for. -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -resources
*[APIResource](#apiresource-unversioned) array* | resources contains the name of the resources and if they are namespaced. - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_apiresourcelist_unversioned_definition.md b/docs/api-reference/v1.5/documents/_generated_apiresourcelist_unversioned_definition.md deleted file mode 100644 index b5b7649e2f..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_apiresourcelist_unversioned_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## APIResourceList unversioned - -Group | Version | Kind ------------- | ---------- | ----------- -Core | 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. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -groupVersion
*string* | groupVersion is the group and version this APIResourceList is for. -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -resources
*[APIResource](#apiresource-unversioned) array* | resources contains the name of the resources and if they are namespaced. - diff --git a/docs/api-reference/v1.5/documents/_generated_apiversion_v1beta1_concept.md b/docs/api-reference/v1.5/documents/_generated_apiversion_v1beta1_concept.md deleted file mode 100644 index eed2e554dc..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_apiversion_v1beta1_concept.md +++ /dev/null @@ -1,31 +0,0 @@ - - ------------ -# APIVersion v1beta1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1beta1 | APIVersion - - - - - - - -An APIVersion represents a single concrete version of an object model. - - - -Field | Description ------------- | ----------- -name
*string* | Name of this version (e.g. 'v1'). - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_apiversion_v1beta1_definition.md b/docs/api-reference/v1.5/documents/_generated_apiversion_v1beta1_definition.md deleted file mode 100644 index aecfdceaf7..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_apiversion_v1beta1_definition.md +++ /dev/null @@ -1,17 +0,0 @@ -## APIVersion v1beta1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1beta1 | APIVersion - - - -An APIVersion represents a single concrete version of an object model. - - - -Field | Description ------------- | ----------- -name
*string* | Name of this version (e.g. 'v1'). - diff --git a/docs/api-reference/v1.5/documents/_generated_apiversions_unversioned_concept.md b/docs/api-reference/v1.5/documents/_generated_apiversions_unversioned_concept.md deleted file mode 100644 index 31aa6a658a..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_apiversions_unversioned_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# APIVersions unversioned - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIVersions - - - - - - - -APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -serverAddressByClientCIDRs
*[ServerAddressByClientCIDR](#serveraddressbyclientcidr-unversioned) array* | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. -versions
*string array* | versions are the api versions that are available. - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_apiversions_unversioned_definition.md b/docs/api-reference/v1.5/documents/_generated_apiversions_unversioned_definition.md deleted file mode 100644 index 3513f89da7..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_apiversions_unversioned_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## APIVersions unversioned - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIVersions - - - -APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -serverAddressByClientCIDRs
*[ServerAddressByClientCIDR](#serveraddressbyclientcidr-unversioned) array* | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. -versions
*string array* | versions are the api versions that are available. - diff --git a/docs/api-reference/v1.5/documents/_generated_attachedvolume_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_attachedvolume_v1_concept.md deleted file mode 100644 index 7ec6b04185..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_attachedvolume_v1_concept.md +++ /dev/null @@ -1,32 +0,0 @@ - - ------------ -# AttachedVolume v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | AttachedVolume - - - - - - - -AttachedVolume describes a volume attached to a node - - - -Field | Description ------------- | ----------- -devicePath
*string* | DevicePath represents the device path where the volume should be available -name
*string* | Name of the attached volume - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_attachedvolume_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_attachedvolume_v1_definition.md deleted file mode 100644 index ae5004c11a..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_attachedvolume_v1_definition.md +++ /dev/null @@ -1,18 +0,0 @@ -## AttachedVolume v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | AttachedVolume - - - -AttachedVolume describes a volume attached to a node - - - -Field | Description ------------- | ----------- -devicePath
*string* | DevicePath represents the device path where the volume should be available -name
*string* | Name of the attached volume - diff --git a/docs/api-reference/v1.5/documents/_generated_awselasticblockstorevolumesource_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_awselasticblockstorevolumesource_v1_concept.md deleted file mode 100644 index 9dda8fcf2a..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_awselasticblockstorevolumesource_v1_concept.md +++ /dev/null @@ -1,36 +0,0 @@ - - ------------ -# AWSElasticBlockStoreVolumeSource v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | 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. - - - -Field | Description ------------- | ----------- -fsType
*string* | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore -partition
*integer* | The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). -readOnly
*boolean* | Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore -volumeID
*string* | Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_awselasticblockstorevolumesource_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_awselasticblockstorevolumesource_v1_definition.md deleted file mode 100644 index 3c4d7e2d21..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_awselasticblockstorevolumesource_v1_definition.md +++ /dev/null @@ -1,22 +0,0 @@ -## AWSElasticBlockStoreVolumeSource v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | 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. - - - -Field | Description ------------- | ----------- -fsType
*string* | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore -partition
*integer* | The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). -readOnly
*boolean* | Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore -volumeID
*string* | Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore - diff --git a/docs/api-reference/v1.5/documents/_generated_azurediskvolumesource_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_azurediskvolumesource_v1_concept.md deleted file mode 100644 index 1043b9d9ae..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_azurediskvolumesource_v1_concept.md +++ /dev/null @@ -1,35 +0,0 @@ - - ------------ -# AzureDiskVolumeSource v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | AzureDiskVolumeSource - - - - - - - -AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. - - - -Field | Description ------------- | ----------- -cachingMode
*string* | Host Caching mode: None, Read Only, Read Write. -diskName
*string* | The Name of the data disk in the blob storage -diskURI
*string* | The URI the data disk in the blob storage -fsType
*string* | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. -readOnly
*boolean* | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_azurediskvolumesource_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_azurediskvolumesource_v1_definition.md deleted file mode 100644 index 191a407952..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_azurediskvolumesource_v1_definition.md +++ /dev/null @@ -1,21 +0,0 @@ -## AzureDiskVolumeSource v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | AzureDiskVolumeSource - - - -AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. - - - -Field | Description ------------- | ----------- -cachingMode
*string* | Host Caching mode: None, Read Only, Read Write. -diskName
*string* | The Name of the data disk in the blob storage -diskURI
*string* | The URI the data disk in the blob storage -fsType
*string* | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. -readOnly
*boolean* | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - diff --git a/docs/api-reference/v1.5/documents/_generated_azurefilevolumesource_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_azurefilevolumesource_v1_concept.md deleted file mode 100644 index a9dc6186b1..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_azurefilevolumesource_v1_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# AzureFileVolumeSource v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | AzureFileVolumeSource - - - - - - - -AzureFile represents an Azure File Service mount on the host and bind mount to the pod. - - - -Field | Description ------------- | ----------- -readOnly
*boolean* | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. -secretName
*string* | the name of secret that contains Azure Storage Account Name and Key -shareName
*string* | Share Name - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_azurefilevolumesource_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_azurefilevolumesource_v1_definition.md deleted file mode 100644 index 2382e73e4c..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_azurefilevolumesource_v1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## AzureFileVolumeSource v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | AzureFileVolumeSource - - - -AzureFile represents an Azure File Service mount on the host and bind mount to the pod. - - - -Field | Description ------------- | ----------- -readOnly
*boolean* | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. -secretName
*string* | the name of secret that contains Azure Storage Account Name and Key -shareName
*string* | Share Name - diff --git a/docs/api-reference/v1.5/documents/_generated_binding_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_binding_v1_concept.md deleted file mode 100644 index 6c7d6bf32a..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_binding_v1_concept.md +++ /dev/null @@ -1,104 +0,0 @@ - - ------------ -# Binding v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | Binding - - - - - - - -Binding ties one object to another. For example, a pod is bound to a node by a scheduler. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata -target
*[ObjectReference](#objectreference-v1)* | The target object that you want to bind to the standard object. - - - - - -## Write Operations - -See supported operations below... - -## Create - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -create a Binding - -### HTTP Request - -`POST /api/v1/namespaces/{namespace}/bindings` - -### Path Parameters - -Parameter | Description ------------- | ----------- -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[Binding](#binding-v1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[Binding](#binding-v1)* | OK - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_binding_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_binding_v1_definition.md deleted file mode 100644 index 32e2a31908..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_binding_v1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## Binding v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | Binding - - - -Binding ties one object to another. For example, a pod is bound to a node by a scheduler. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata -target
*[ObjectReference](#objectreference-v1)* | The target object that you want to bind to the standard object. - diff --git a/docs/api-reference/v1.5/documents/_generated_capabilities_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_capabilities_v1_concept.md deleted file mode 100644 index 6c47def7ef..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_capabilities_v1_concept.md +++ /dev/null @@ -1,32 +0,0 @@ - - ------------ -# Capabilities v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | Capabilities - - - - - - - -Adds and removes POSIX capabilities from running containers. - - - -Field | Description ------------- | ----------- -add
*string array* | Added capabilities -drop
*string array* | Removed capabilities - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_capabilities_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_capabilities_v1_definition.md deleted file mode 100644 index c18460bf9a..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_capabilities_v1_definition.md +++ /dev/null @@ -1,18 +0,0 @@ -## Capabilities v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | Capabilities - - - -Adds and removes POSIX capabilities from running containers. - - - -Field | Description ------------- | ----------- -add
*string array* | Added capabilities -drop
*string array* | Removed capabilities - diff --git a/docs/api-reference/v1.5/documents/_generated_cephfsvolumesource_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_cephfsvolumesource_v1_concept.md deleted file mode 100644 index 1911dac73b..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_cephfsvolumesource_v1_concept.md +++ /dev/null @@ -1,36 +0,0 @@ - - ------------ -# CephFSVolumeSource v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | CephFSVolumeSource - - - - - - - -Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. - - - -Field | Description ------------- | ----------- -monitors
*string array* | Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it -path
*string* | Optional: Used as the mounted root, rather than the full Ceph tree, default is / -readOnly
*boolean* | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it -secretFile
*string* | Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it -secretRef
*[LocalObjectReference](#localobjectreference-v1)* | Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it -user
*string* | Optional: User is the rados user name, default is admin More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_cephfsvolumesource_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_cephfsvolumesource_v1_definition.md deleted file mode 100644 index d672f53c08..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_cephfsvolumesource_v1_definition.md +++ /dev/null @@ -1,22 +0,0 @@ -## CephFSVolumeSource v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | CephFSVolumeSource - - - -Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. - - - -Field | Description ------------- | ----------- -monitors
*string array* | Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it -path
*string* | Optional: Used as the mounted root, rather than the full Ceph tree, default is / -readOnly
*boolean* | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it -secretFile
*string* | Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it -secretRef
*[LocalObjectReference](#localobjectreference-v1)* | Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it -user
*string* | Optional: User is the rados user name, default is admin More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it - diff --git a/docs/api-reference/v1.5/documents/_generated_certificatesigningrequest_v1alpha1_concept.md b/docs/api-reference/v1.5/documents/_generated_certificatesigningrequest_v1alpha1_concept.md deleted file mode 100644 index 3906344d6e..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_certificatesigningrequest_v1alpha1_concept.md +++ /dev/null @@ -1,590 +0,0 @@ - - ------------ -# CertificateSigningRequest v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Certificates | v1alpha1 | CertificateSigningRequest - - - - - - - -Describes a certificate signing request - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ObjectMeta](#objectmeta-v1)* | -spec
*[CertificateSigningRequestSpec](#certificatesigningrequestspec-v1alpha1)* | The certificate request itself and any additional information. -status
*[CertificateSigningRequestStatus](#certificatesigningrequeststatus-v1alpha1)* | Derived information about the request. - - -### CertificateSigningRequestSpec v1alpha1 - - - -Field | Description ------------- | ----------- -groups
*string array* | -request
*string* | Base64-encoded PKCS#10 CSR data -uid
*string* | -username
*string* | Information about the requesting user (if relevant) See user.Info interface for details - -### CertificateSigningRequestStatus v1alpha1 - - - -Field | Description ------------- | ----------- -certificate
*string* | If request was approved, the controller will place the issued certificate here. -conditions
*[CertificateSigningRequestCondition](#certificatesigningrequestcondition-v1alpha1) array* | Conditions applied to the request, such as approval or denial. - -### CertificateSigningRequestList v1alpha1 - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
*[CertificateSigningRequest](#certificatesigningrequest-v1alpha1) array* | -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ListMeta](#listmeta-unversioned)* | - - - - -## Write Operations - -See supported operations below... - -## Create - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -create a CertificateSigningRequest - -### HTTP Request - -`POST /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests` - - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK - - -## Replace - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace the specified CertificateSigningRequest - -### HTTP Request - -`PUT /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the CertificateSigningRequest - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK - - -## Patch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update the specified CertificateSigningRequest - -### HTTP Request - -`PATCH /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the CertificateSigningRequest - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
*[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK - - -## Delete - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -delete a CertificateSigningRequest - -### HTTP Request - -`DELETE /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the CertificateSigningRequest - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. -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. -orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[DeleteOptions](#deleteoptions-v1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[Status](#status-unversioned)* | OK - - -## Delete Collection - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -delete collection of CertificateSigningRequest - -### HTTP Request - -`DELETE /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests` - - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Status](#status-unversioned)* | OK - - - -## Read Operations - -See supported operations below... - -## Read - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read the specified CertificateSigningRequest - -### HTTP Request - -`GET /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the CertificateSigningRequest - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. -exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace' -export | Should this value be exported. Export strips fields that a user can not specify. - - -### Response - -Code | Description ------------- | ----------- -200
*[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK - - -## List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -list or watch objects of kind CertificateSigningRequest - -### HTTP Request - -`GET /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests` - - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[CertificateSigningRequestList](#certificatesigningrequestlist-v1alpha1)* | OK - - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch changes to an object of kind CertificateSigningRequest - -### HTTP Request - -`GET /apis/certificates.k8s.io/v1alpha1/watch/certificatesigningrequests/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the CertificateSigningRequest - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_certificatesigningrequest_v1alpha1_definition.md b/docs/api-reference/v1.5/documents/_generated_certificatesigningrequest_v1alpha1_definition.md deleted file mode 100644 index 273683ba2f..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_certificatesigningrequest_v1alpha1_definition.md +++ /dev/null @@ -1,21 +0,0 @@ -## CertificateSigningRequest v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Certificates | v1alpha1 | CertificateSigningRequest - - - -Describes a certificate signing request - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ObjectMeta](#objectmeta-v1)* | -spec
*[CertificateSigningRequestSpec](#certificatesigningrequestspec-v1alpha1)* | The certificate request itself and any additional information. -status
*[CertificateSigningRequestStatus](#certificatesigningrequeststatus-v1alpha1)* | Derived information about the request. - diff --git a/docs/api-reference/v1.5/documents/_generated_certificatesigningrequestcondition_v1alpha1_concept.md b/docs/api-reference/v1.5/documents/_generated_certificatesigningrequestcondition_v1alpha1_concept.md deleted file mode 100644 index b11023903e..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_certificatesigningrequestcondition_v1alpha1_concept.md +++ /dev/null @@ -1,34 +0,0 @@ - - ------------ -# CertificateSigningRequestCondition v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestCondition - - - - - - - - - - - -Field | Description ------------- | ----------- -lastUpdateTime
*[Time](#time-unversioned)* | timestamp for the last update to this condition -message
*string* | human readable message with details about the request state -reason
*string* | brief reason for the request state -type
*string* | request approval state, currently Approved or Denied. - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_certificatesigningrequestcondition_v1alpha1_definition.md b/docs/api-reference/v1.5/documents/_generated_certificatesigningrequestcondition_v1alpha1_definition.md deleted file mode 100644 index 4d6c34b60b..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_certificatesigningrequestcondition_v1alpha1_definition.md +++ /dev/null @@ -1,20 +0,0 @@ -## CertificateSigningRequestCondition v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestCondition - - - - - - - -Field | Description ------------- | ----------- -lastUpdateTime
*[Time](#time-unversioned)* | timestamp for the last update to this condition -message
*string* | human readable message with details about the request state -reason
*string* | brief reason for the request state -type
*string* | request approval state, currently Approved or Denied. - diff --git a/docs/api-reference/v1.5/documents/_generated_certificatesigningrequestlist_v1alpha1_concept.md b/docs/api-reference/v1.5/documents/_generated_certificatesigningrequestlist_v1alpha1_concept.md deleted file mode 100644 index 0fadb04d10..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_certificatesigningrequestlist_v1alpha1_concept.md +++ /dev/null @@ -1,99 +0,0 @@ - - ------------ -# CertificateSigningRequestList v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Certificates | v1alpha1 | CertificateSigningRequestList - - - - - - - - - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
*[CertificateSigningRequest](#certificatesigningrequest-v1alpha1) array* | -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ListMeta](#listmeta-unversioned)* | - - - - - -## Read Operations - -See supported operations below... - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of CertificateSigningRequest - -### HTTP Request - -`GET /apis/certificates.k8s.io/v1alpha1/watch/certificatesigningrequests` - - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_certificatesigningrequestlist_v1alpha1_definition.md b/docs/api-reference/v1.5/documents/_generated_certificatesigningrequestlist_v1alpha1_definition.md deleted file mode 100644 index d97323b2c8..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_certificatesigningrequestlist_v1alpha1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## CertificateSigningRequestList v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Certificates | v1alpha1 | CertificateSigningRequestList - - - - - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
*[CertificateSigningRequest](#certificatesigningrequest-v1alpha1) array* | -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ListMeta](#listmeta-unversioned)* | - diff --git a/docs/api-reference/v1.5/documents/_generated_certificatesigningrequestspec_v1alpha1_concept.md b/docs/api-reference/v1.5/documents/_generated_certificatesigningrequestspec_v1alpha1_concept.md deleted file mode 100644 index 9e7fbae674..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_certificatesigningrequestspec_v1alpha1_concept.md +++ /dev/null @@ -1,34 +0,0 @@ - - ------------ -# CertificateSigningRequestSpec v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestSpec - - - - - - - -This information is immutable after the request is created. Only the Request and ExtraInfo fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users. - - - -Field | Description ------------- | ----------- -groups
*string array* | -request
*string* | Base64-encoded PKCS#10 CSR data -uid
*string* | -username
*string* | Information about the requesting user (if relevant) See user.Info interface for details - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_certificatesigningrequestspec_v1alpha1_definition.md b/docs/api-reference/v1.5/documents/_generated_certificatesigningrequestspec_v1alpha1_definition.md deleted file mode 100644 index e335d818d6..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_certificatesigningrequestspec_v1alpha1_definition.md +++ /dev/null @@ -1,20 +0,0 @@ -## CertificateSigningRequestSpec v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestSpec - - - -This information is immutable after the request is created. Only the Request and ExtraInfo fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users. - - - -Field | Description ------------- | ----------- -groups
*string array* | -request
*string* | Base64-encoded PKCS#10 CSR data -uid
*string* | -username
*string* | Information about the requesting user (if relevant) See user.Info interface for details - diff --git a/docs/api-reference/v1.5/documents/_generated_certificatesigningrequeststatus_v1alpha1_concept.md b/docs/api-reference/v1.5/documents/_generated_certificatesigningrequeststatus_v1alpha1_concept.md deleted file mode 100644 index e69876a567..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_certificatesigningrequeststatus_v1alpha1_concept.md +++ /dev/null @@ -1,103 +0,0 @@ - - ------------ -# CertificateSigningRequestStatus v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Certificates | v1alpha1 | CertificateSigningRequestStatus - - - - - - - - - - - -Field | Description ------------- | ----------- -certificate
*string* | If request was approved, the controller will place the issued certificate here. -conditions
*[CertificateSigningRequestCondition](#certificatesigningrequestcondition-v1alpha1) array* | Conditions applied to the request, such as approval or denial. - - - - - -## Write Operations - -See supported operations below... - -## Replace - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace status of the specified CertificateSigningRequest - -### HTTP Request - -`PUT /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the CertificateSigningRequest - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_certificatesigningrequeststatus_v1alpha1_definition.md b/docs/api-reference/v1.5/documents/_generated_certificatesigningrequeststatus_v1alpha1_definition.md deleted file mode 100644 index 55a929b145..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_certificatesigningrequeststatus_v1alpha1_definition.md +++ /dev/null @@ -1,18 +0,0 @@ -## CertificateSigningRequestStatus v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Certificates | v1alpha1 | CertificateSigningRequestStatus - - - - - - - -Field | Description ------------- | ----------- -certificate
*string* | If request was approved, the controller will place the issued certificate here. -conditions
*[CertificateSigningRequestCondition](#certificatesigningrequestcondition-v1alpha1) array* | Conditions applied to the request, such as approval or denial. - diff --git a/docs/api-reference/v1.5/documents/_generated_cindervolumesource_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_cindervolumesource_v1_concept.md deleted file mode 100644 index d31493f61a..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_cindervolumesource_v1_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# CinderVolumeSource v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | CinderVolumeSource - - - - - - - -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. - - - -Field | Description ------------- | ----------- -fsType
*string* | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md -readOnly
*boolean* | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md -volumeID
*string* | volume id used to identify the volume in cinder More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_cindervolumesource_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_cindervolumesource_v1_definition.md deleted file mode 100644 index 670fb61930..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_cindervolumesource_v1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## CinderVolumeSource v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | CinderVolumeSource - - - -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. - - - -Field | Description ------------- | ----------- -fsType
*string* | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md -readOnly
*boolean* | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md -volumeID
*string* | volume id used to identify the volume in cinder More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md - diff --git a/docs/api-reference/v1.5/documents/_generated_clusterrole_v1alpha1_concept.md b/docs/api-reference/v1.5/documents/_generated_clusterrole_v1alpha1_concept.md deleted file mode 100644 index 0691f97e14..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_clusterrole_v1alpha1_concept.md +++ /dev/null @@ -1,565 +0,0 @@ - - ------------ -# ClusterRole v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -RbacAuthorization | v1alpha1 | ClusterRole - - - - - - - -ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. -rules
*[PolicyRule](#policyrule-v1alpha1) array* | Rules holds all the PolicyRules for this ClusterRole - - -### ClusterRoleList v1alpha1 - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
*[ClusterRole](#clusterrole-v1alpha1) array* | Items is a list of ClusterRoles -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ListMeta](#listmeta-unversioned)* | Standard object's metadata. - - - - -## Write Operations - -See supported operations below... - -## Create - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -create a ClusterRole - -### HTTP Request - -`POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles` - - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[ClusterRole](#clusterrole-v1alpha1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[ClusterRole](#clusterrole-v1alpha1)* | OK - - -## Replace - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace the specified ClusterRole - -### HTTP Request - -`PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ClusterRole - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[ClusterRole](#clusterrole-v1alpha1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[ClusterRole](#clusterrole-v1alpha1)* | OK - - -## Patch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update the specified ClusterRole - -### HTTP Request - -`PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ClusterRole - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
*[ClusterRole](#clusterrole-v1alpha1)* | OK - - -## Delete - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -delete a ClusterRole - -### HTTP Request - -`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ClusterRole - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. -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. -orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[DeleteOptions](#deleteoptions-v1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[Status](#status-unversioned)* | OK - - -## Delete Collection - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -delete collection of ClusterRole - -### HTTP Request - -`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles` - - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Status](#status-unversioned)* | OK - - - -## Read Operations - -See supported operations below... - -## Read - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read the specified ClusterRole - -### HTTP Request - -`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ClusterRole - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
*[ClusterRole](#clusterrole-v1alpha1)* | OK - - -## List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -list or watch objects of kind ClusterRole - -### HTTP Request - -`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles` - - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[ClusterRoleList](#clusterrolelist-v1alpha1)* | OK - - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch changes to an object of kind ClusterRole - -### HTTP Request - -`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ClusterRole - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_clusterrole_v1alpha1_definition.md b/docs/api-reference/v1.5/documents/_generated_clusterrole_v1alpha1_definition.md deleted file mode 100644 index c36ca7eb77..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_clusterrole_v1alpha1_definition.md +++ /dev/null @@ -1,20 +0,0 @@ -## ClusterRole v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -RbacAuthorization | v1alpha1 | ClusterRole - - - -ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. -rules
*[PolicyRule](#policyrule-v1alpha1) array* | Rules holds all the PolicyRules for this ClusterRole - diff --git a/docs/api-reference/v1.5/documents/_generated_clusterrolebinding_v1alpha1_concept.md b/docs/api-reference/v1.5/documents/_generated_clusterrolebinding_v1alpha1_concept.md deleted file mode 100644 index 9d249c7387..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_clusterrolebinding_v1alpha1_concept.md +++ /dev/null @@ -1,627 +0,0 @@ - - ------------ -# ClusterRoleBinding v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -RbacAuthorization | v1alpha1 | ClusterRoleBinding - - - - - - - -ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. -roleRef
*[RoleRef](#roleref-v1alpha1)* | RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. -subjects
*[Subject](#subject-v1alpha1) array* | Subjects holds references to the objects the role applies to. - - -### ClusterRoleBindingList v1alpha1 - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
*[ClusterRoleBinding](#clusterrolebinding-v1alpha1) array* | Items is a list of ClusterRoleBindings -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ListMeta](#listmeta-unversioned)* | Standard object's metadata. - - - - -## Write Operations - -See supported operations below... - -## Create - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -create a ClusterRoleBinding - -### HTTP Request - -`POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings` - - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* | OK - - -## Replace - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace the specified ClusterRoleBinding - -### HTTP Request - -`PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ClusterRoleBinding - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* | OK - - -## Patch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update the specified ClusterRoleBinding - -### HTTP Request - -`PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ClusterRoleBinding - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
*[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* | OK - - -## Delete - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -delete a ClusterRoleBinding - -### HTTP Request - -`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ClusterRoleBinding - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. -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. -orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[DeleteOptions](#deleteoptions-v1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[Status](#status-unversioned)* | OK - - -## Delete Collection - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -delete collection of ClusterRoleBinding - -### HTTP Request - -`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings` - - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Status](#status-unversioned)* | OK - - - -## Read Operations - -See supported operations below... - -## Read - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read the specified ClusterRoleBinding - -### HTTP Request - -`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ClusterRoleBinding - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
*[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* | OK - - -## List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -list or watch objects of kind ClusterRoleBinding - -### HTTP Request - -`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings` - - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[ClusterRoleBindingList](#clusterrolebindinglist-v1alpha1)* | OK - - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch changes to an object of kind ClusterRoleBinding - -### HTTP Request - -`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ClusterRoleBinding - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - -## Watch List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of ClusterRoleBinding - -### HTTP Request - -`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings` - - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_clusterrolebinding_v1alpha1_definition.md b/docs/api-reference/v1.5/documents/_generated_clusterrolebinding_v1alpha1_definition.md deleted file mode 100644 index ca190657a5..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_clusterrolebinding_v1alpha1_definition.md +++ /dev/null @@ -1,21 +0,0 @@ -## ClusterRoleBinding v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -RbacAuthorization | v1alpha1 | ClusterRoleBinding - - - -ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. -roleRef
*[RoleRef](#roleref-v1alpha1)* | RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. -subjects
*[Subject](#subject-v1alpha1) array* | Subjects holds references to the objects the role applies to. - diff --git a/docs/api-reference/v1.5/documents/_generated_clusterrolebindinglist_v1alpha1_concept.md b/docs/api-reference/v1.5/documents/_generated_clusterrolebindinglist_v1alpha1_concept.md deleted file mode 100644 index a43a158ede..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_clusterrolebindinglist_v1alpha1_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# ClusterRoleBindingList v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | ClusterRoleBindingList - - - - - - - -ClusterRoleBindingList is a collection of ClusterRoleBindings - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
*[ClusterRoleBinding](#clusterrolebinding-v1alpha1) array* | Items is a list of ClusterRoleBindings -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ListMeta](#listmeta-unversioned)* | Standard object's metadata. - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_clusterrolebindinglist_v1alpha1_definition.md b/docs/api-reference/v1.5/documents/_generated_clusterrolebindinglist_v1alpha1_definition.md deleted file mode 100644 index d2c0dbcf80..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_clusterrolebindinglist_v1alpha1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## ClusterRoleBindingList v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | ClusterRoleBindingList - - - -ClusterRoleBindingList is a collection of ClusterRoleBindings - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
*[ClusterRoleBinding](#clusterrolebinding-v1alpha1) array* | Items is a list of ClusterRoleBindings -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ListMeta](#listmeta-unversioned)* | Standard object's metadata. - diff --git a/docs/api-reference/v1.5/documents/_generated_clusterrolelist_v1alpha1_concept.md b/docs/api-reference/v1.5/documents/_generated_clusterrolelist_v1alpha1_concept.md deleted file mode 100644 index bba333ae62..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_clusterrolelist_v1alpha1_concept.md +++ /dev/null @@ -1,99 +0,0 @@ - - ------------ -# ClusterRoleList v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -RbacAuthorization | v1alpha1 | ClusterRoleList - - - - - - - -ClusterRoleList is a collection of ClusterRoles - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
*[ClusterRole](#clusterrole-v1alpha1) array* | Items is a list of ClusterRoles -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ListMeta](#listmeta-unversioned)* | Standard object's metadata. - - - - - -## Read Operations - -See supported operations below... - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of ClusterRole - -### HTTP Request - -`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles` - - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_clusterrolelist_v1alpha1_definition.md b/docs/api-reference/v1.5/documents/_generated_clusterrolelist_v1alpha1_definition.md deleted file mode 100644 index 416a354cab..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_clusterrolelist_v1alpha1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## ClusterRoleList v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -RbacAuthorization | v1alpha1 | ClusterRoleList - - - -ClusterRoleList is a collection of ClusterRoles - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
*[ClusterRole](#clusterrole-v1alpha1) array* | Items is a list of ClusterRoles -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ListMeta](#listmeta-unversioned)* | Standard object's metadata. - diff --git a/docs/api-reference/v1.5/documents/_generated_componentcondition_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_componentcondition_v1_concept.md deleted file mode 100644 index 7976a2bc40..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_componentcondition_v1_concept.md +++ /dev/null @@ -1,34 +0,0 @@ - - ------------ -# ComponentCondition v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ComponentCondition - - - - - - - -Information about the condition of a component. - - - -Field | Description ------------- | ----------- -error
*string* | Condition error code for a component. For example, a health check error code. -message
*string* | Message about the condition for a component. For example, information about a health check. -status
*string* | Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown". -type
*string* | Type of condition for a component. Valid value: "Healthy" - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_componentcondition_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_componentcondition_v1_definition.md deleted file mode 100644 index 6462a60913..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_componentcondition_v1_definition.md +++ /dev/null @@ -1,20 +0,0 @@ -## ComponentCondition v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ComponentCondition - - - -Information about the condition of a component. - - - -Field | Description ------------- | ----------- -error
*string* | Condition error code for a component. For example, a health check error code. -message
*string* | Message about the condition for a component. For example, information about a health check. -status
*string* | Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown". -type
*string* | Type of condition for a component. Valid value: "Healthy" - diff --git a/docs/api-reference/v1.5/documents/_generated_componentstatus_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_componentstatus_v1_concept.md deleted file mode 100644 index 7952df3b88..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_componentstatus_v1_concept.md +++ /dev/null @@ -1,172 +0,0 @@ - - ------------ -# ComponentStatus v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ComponentStatus - - - - - - - -ComponentStatus (and ComponentStatusList) holds the cluster validation info. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -conditions
*[ComponentCondition](#componentcondition-v1) array* | List of component conditions observed -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - - -### ComponentStatusList v1 - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
*[ComponentStatus](#componentstatus-v1) array* | List of ComponentStatus objects. -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds - - - - -## Read Operations - -See supported operations below... - -## Read - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read the specified ComponentStatus - -### HTTP Request - -`GET /api/v1/componentstatuses/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ComponentStatus - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
*[ComponentStatus](#componentstatus-v1)* | OK - - -## List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -list objects of kind ComponentStatus - -### HTTP Request - -`GET /api/v1/componentstatuses` - - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[ComponentStatusList](#componentstatuslist-v1)* | OK - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_componentstatus_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_componentstatus_v1_definition.md deleted file mode 100644 index efbd73394a..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_componentstatus_v1_definition.md +++ /dev/null @@ -1,20 +0,0 @@ -## ComponentStatus v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ComponentStatus - - - -ComponentStatus (and ComponentStatusList) holds the cluster validation info. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -conditions
*[ComponentCondition](#componentcondition-v1) array* | List of component conditions observed -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - diff --git a/docs/api-reference/v1.5/documents/_generated_componentstatuslist_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_componentstatuslist_v1_concept.md deleted file mode 100644 index b4445da385..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_componentstatuslist_v1_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# ComponentStatusList v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ComponentStatusList - - - - - - - -Status of all the conditions for the component as a list of ComponentStatus objects. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
*[ComponentStatus](#componentstatus-v1) array* | List of ComponentStatus objects. -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_componentstatuslist_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_componentstatuslist_v1_definition.md deleted file mode 100644 index 02c154761e..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_componentstatuslist_v1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## ComponentStatusList v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ComponentStatusList - - - -Status of all the conditions for the component as a list of ComponentStatus objects. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
*[ComponentStatus](#componentstatus-v1) array* | List of ComponentStatus objects. -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds - diff --git a/docs/api-reference/v1.5/documents/_generated_configmap_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_configmap_v1_concept.md deleted file mode 100644 index 3ef2d92fbf..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_configmap_v1_concept.md +++ /dev/null @@ -1,709 +0,0 @@ - - ------------ -# ConfigMap v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ConfigMap - - - - - - - -ConfigMap holds configuration data for pods to consume. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -data
*object* | Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot. -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - - -### ConfigMapList v1 - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
*[ConfigMap](#configmap-v1) array* | Items is the list of ConfigMaps. -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ListMeta](#listmeta-unversioned)* | More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - - - - -## Write Operations - -See supported operations below... - -## Create - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -create a ConfigMap - -### HTTP Request - -`POST /api/v1/namespaces/{namespace}/configmaps` - -### Path Parameters - -Parameter | Description ------------- | ----------- -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[ConfigMap](#configmap-v1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[ConfigMap](#configmap-v1)* | OK - - -## Replace - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace the specified ConfigMap - -### HTTP Request - -`PUT /api/v1/namespaces/{namespace}/configmaps/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ConfigMap -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[ConfigMap](#configmap-v1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[ConfigMap](#configmap-v1)* | OK - - -## Patch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update the specified ConfigMap - -### HTTP Request - -`PATCH /api/v1/namespaces/{namespace}/configmaps/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ConfigMap -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
*[ConfigMap](#configmap-v1)* | OK - - -## Delete - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -delete a ConfigMap - -### HTTP Request - -`DELETE /api/v1/namespaces/{namespace}/configmaps/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ConfigMap -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. -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. -orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[DeleteOptions](#deleteoptions-v1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[Status](#status-unversioned)* | OK - - -## Delete Collection - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -delete collection of ConfigMap - -### HTTP Request - -`DELETE /api/v1/namespaces/{namespace}/configmaps` - -### Path Parameters - -Parameter | Description ------------- | ----------- -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Status](#status-unversioned)* | OK - - - -## Read Operations - -See supported operations below... - -## Read - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read the specified ConfigMap - -### HTTP Request - -`GET /api/v1/namespaces/{namespace}/configmaps/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ConfigMap -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. -exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace' -export | Should this value be exported. Export strips fields that a user can not specify. - - -### Response - -Code | Description ------------- | ----------- -200
*[ConfigMap](#configmap-v1)* | OK - - -## List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -list or watch objects of kind ConfigMap - -### HTTP Request - -`GET /api/v1/namespaces/{namespace}/configmaps` - -### Path Parameters - -Parameter | Description ------------- | ----------- -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[ConfigMapList](#configmaplist-v1)* | OK - - -## List All Namespaces - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -list or watch objects of kind ConfigMap - -### HTTP Request - -`GET /api/v1/configmaps` - - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[ConfigMapList](#configmaplist-v1)* | OK - - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch changes to an object of kind ConfigMap - -### HTTP Request - -`GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ConfigMap -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - -## Watch List All Namespaces - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of ConfigMap - -### HTTP Request - -`GET /api/v1/watch/configmaps` - - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_configmap_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_configmap_v1_definition.md deleted file mode 100644 index b5864ad664..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_configmap_v1_definition.md +++ /dev/null @@ -1,20 +0,0 @@ -## ConfigMap v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ConfigMap - - - -ConfigMap holds configuration data for pods to consume. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -data
*object* | Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot. -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - diff --git a/docs/api-reference/v1.5/documents/_generated_configmapkeyselector_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_configmapkeyselector_v1_concept.md deleted file mode 100644 index 8cb9c40d2d..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_configmapkeyselector_v1_concept.md +++ /dev/null @@ -1,32 +0,0 @@ - - ------------ -# ConfigMapKeySelector v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ConfigMapKeySelector - - - - - - - -Selects a key from a ConfigMap. - - - -Field | Description ------------- | ----------- -key
*string* | The key to select. -name
*string* | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_configmapkeyselector_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_configmapkeyselector_v1_definition.md deleted file mode 100644 index 00e98b82bb..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_configmapkeyselector_v1_definition.md +++ /dev/null @@ -1,18 +0,0 @@ -## ConfigMapKeySelector v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ConfigMapKeySelector - - - -Selects a key from a ConfigMap. - - - -Field | Description ------------- | ----------- -key
*string* | The key to select. -name
*string* | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names - diff --git a/docs/api-reference/v1.5/documents/_generated_configmaplist_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_configmaplist_v1_concept.md deleted file mode 100644 index 337e57078d..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_configmaplist_v1_concept.md +++ /dev/null @@ -1,104 +0,0 @@ - - ------------ -# ConfigMapList v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ConfigMapList - - - - - - - -ConfigMapList is a resource containing a list of ConfigMap objects. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
*[ConfigMap](#configmap-v1) array* | Items is the list of ConfigMaps. -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ListMeta](#listmeta-unversioned)* | More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - - - - - -## Read Operations - -See supported operations below... - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of ConfigMap - -### HTTP Request - -`GET /api/v1/watch/namespaces/{namespace}/configmaps` - -### Path Parameters - -Parameter | Description ------------- | ----------- -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_configmaplist_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_configmaplist_v1_definition.md deleted file mode 100644 index 32e00ed55e..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_configmaplist_v1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## ConfigMapList v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ConfigMapList - - - -ConfigMapList is a resource containing a list of ConfigMap objects. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
*[ConfigMap](#configmap-v1) array* | Items is the list of ConfigMaps. -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ListMeta](#listmeta-unversioned)* | More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - diff --git a/docs/api-reference/v1.5/documents/_generated_configmapvolumesource_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_configmapvolumesource_v1_concept.md deleted file mode 100644 index 5dd5e2b183..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_configmapvolumesource_v1_concept.md +++ /dev/null @@ -1,35 +0,0 @@ - - ------------ -# ConfigMapVolumeSource v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | 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. - - - -Field | Description ------------- | ----------- -defaultMode
*integer* | Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. -items
*[KeyToPath](#keytopath-v1) array* | If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the '..' path or start with '..'. -name
*string* | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_configmapvolumesource_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_configmapvolumesource_v1_definition.md deleted file mode 100644 index e171a6f0d6..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_configmapvolumesource_v1_definition.md +++ /dev/null @@ -1,21 +0,0 @@ -## ConfigMapVolumeSource v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | 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. - - - -Field | Description ------------- | ----------- -defaultMode
*integer* | Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. -items
*[KeyToPath](#keytopath-v1) array* | If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the '..' path or start with '..'. -name
*string* | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names - diff --git a/docs/api-reference/v1.5/documents/_generated_container_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_container_v1_concept.md deleted file mode 100644 index 8c33d2c477..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_container_v1_concept.md +++ /dev/null @@ -1,84 +0,0 @@ - - ------------ -# Container v1 - ->bdocs-tab:kubectl Container Config to run nginx (must be embedded in a PodSpec to run). - -```bdocs-tab:kubectl_yaml - -name: nginx -# Run the nginx:1.10 image -image: nginx:1.10 - - -``` ->bdocs-tab:curl Container Config to run nginx (must be embedded in a PodSpec to run). - -```bdocs-tab:curl_yaml - -name: nginx -# Run the nginx:1.10 image -image: nginx:1.10 - - -``` - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | Container - - - - - - - -A single application container that you want to run within a pod. - - - -Field | Description ------------- | ----------- -args
*string array* | Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands -command
*string array* | Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands -env
*[EnvVar](#envvar-v1) array* | List of environment variables to set in the container. Cannot be updated. -image
*string* | Docker image name. More info: http://kubernetes.io/docs/user-guide/images -imagePullPolicy
*string* | Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/images#updating-images -lifecycle
*[Lifecycle](#lifecycle-v1)* | Actions that the management system should take in response to container lifecycle events. Cannot be updated. -livenessProbe
*[Probe](#probe-v1)* | Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes -name
*string* | Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. -ports
*[ContainerPort](#containerport-v1) array* | List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. -readinessProbe
*[Probe](#probe-v1)* | Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes -resources
*[ResourceRequirements](#resourcerequirements-v1)* | Compute Resources required by this container. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources -securityContext
*[SecurityContext](#securitycontext-v1)* | Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md -stdin
*boolean* | Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. -stdinOnce
*boolean* | Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false -terminationMessagePath
*string* | Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated. -tty
*boolean* | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. -volumeMounts
*[VolumeMount](#volumemount-v1) array* | Pod volumes to mount into the container's filesystem. Cannot be updated. -workingDir
*string* | Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. - - -### ContainerStatus v1 - - - -Field | Description ------------- | ----------- -containerID
*string* | Container's ID in the format 'docker://'. More info: http://kubernetes.io/docs/user-guide/container-environment#container-information -image
*string* | The image the container is running. More info: http://kubernetes.io/docs/user-guide/images -imageID
*string* | ImageID of the container's image. -lastState
*[ContainerState](#containerstate-v1)* | Details about the container's last termination condition. -name
*string* | This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated. -ready
*boolean* | Specifies whether the container has passed its readiness probe. -restartCount
*integer* | The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC. -state
*[ContainerState](#containerstate-v1)* | Details about the container's current condition. - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_container_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_container_v1_definition.md deleted file mode 100644 index a1cd1458e6..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_container_v1_definition.md +++ /dev/null @@ -1,34 +0,0 @@ -## Container v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | Container - - - -A single application container that you want to run within a pod. - - - -Field | Description ------------- | ----------- -args
*string array* | Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands -command
*string array* | Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands -env
*[EnvVar](#envvar-v1) array* | List of environment variables to set in the container. Cannot be updated. -image
*string* | Docker image name. More info: http://kubernetes.io/docs/user-guide/images -imagePullPolicy
*string* | Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/images#updating-images -lifecycle
*[Lifecycle](#lifecycle-v1)* | Actions that the management system should take in response to container lifecycle events. Cannot be updated. -livenessProbe
*[Probe](#probe-v1)* | Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes -name
*string* | Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. -ports
*[ContainerPort](#containerport-v1) array* | List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. -readinessProbe
*[Probe](#probe-v1)* | Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes -resources
*[ResourceRequirements](#resourcerequirements-v1)* | Compute Resources required by this container. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources -securityContext
*[SecurityContext](#securitycontext-v1)* | Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md -stdin
*boolean* | Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. -stdinOnce
*boolean* | Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false -terminationMessagePath
*string* | Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated. -tty
*boolean* | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. -volumeMounts
*[VolumeMount](#volumemount-v1) array* | Pod volumes to mount into the container's filesystem. Cannot be updated. -workingDir
*string* | Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. - diff --git a/docs/api-reference/v1.5/documents/_generated_containerimage_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_containerimage_v1_concept.md deleted file mode 100644 index ca498c5d33..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_containerimage_v1_concept.md +++ /dev/null @@ -1,32 +0,0 @@ - - ------------ -# ContainerImage v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerImage - - - - - - - -Describe a container image - - - -Field | Description ------------- | ----------- -names
*string array* | 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"] -sizeBytes
*integer* | The size of the image in bytes. - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_containerimage_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_containerimage_v1_definition.md deleted file mode 100644 index eee5bc1ffa..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_containerimage_v1_definition.md +++ /dev/null @@ -1,18 +0,0 @@ -## ContainerImage v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerImage - - - -Describe a container image - - - -Field | Description ------------- | ----------- -names
*string array* | 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"] -sizeBytes
*integer* | The size of the image in bytes. - diff --git a/docs/api-reference/v1.5/documents/_generated_containerport_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_containerport_v1_concept.md deleted file mode 100644 index 3c003e33d8..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_containerport_v1_concept.md +++ /dev/null @@ -1,35 +0,0 @@ - - ------------ -# ContainerPort v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerPort - - - - - - - -ContainerPort represents a network port in a single container. - - - -Field | Description ------------- | ----------- -containerPort
*integer* | Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. -hostIP
*string* | What host IP to bind the external port to. -hostPort
*integer* | Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. -name
*string* | If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. -protocol
*string* | Protocol for port. Must be UDP or TCP. Defaults to "TCP". - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_containerport_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_containerport_v1_definition.md deleted file mode 100644 index 1389ec92a8..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_containerport_v1_definition.md +++ /dev/null @@ -1,21 +0,0 @@ -## ContainerPort v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerPort - - - -ContainerPort represents a network port in a single container. - - - -Field | Description ------------- | ----------- -containerPort
*integer* | Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. -hostIP
*string* | What host IP to bind the external port to. -hostPort
*integer* | Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. -name
*string* | If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. -protocol
*string* | Protocol for port. Must be UDP or TCP. Defaults to "TCP". - diff --git a/docs/api-reference/v1.5/documents/_generated_containerstate_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_containerstate_v1_concept.md deleted file mode 100644 index a0958ebb25..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_containerstate_v1_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# ContainerState v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerState - - - - - - - -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. - - - -Field | Description ------------- | ----------- -running
*[ContainerStateRunning](#containerstaterunning-v1)* | Details about a running container -terminated
*[ContainerStateTerminated](#containerstateterminated-v1)* | Details about a terminated container -waiting
*[ContainerStateWaiting](#containerstatewaiting-v1)* | Details about a waiting container - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_containerstate_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_containerstate_v1_definition.md deleted file mode 100644 index 624e3666b5..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_containerstate_v1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## ContainerState v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerState - - - -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. - - - -Field | Description ------------- | ----------- -running
*[ContainerStateRunning](#containerstaterunning-v1)* | Details about a running container -terminated
*[ContainerStateTerminated](#containerstateterminated-v1)* | Details about a terminated container -waiting
*[ContainerStateWaiting](#containerstatewaiting-v1)* | Details about a waiting container - diff --git a/docs/api-reference/v1.5/documents/_generated_containerstaterunning_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_containerstaterunning_v1_concept.md deleted file mode 100644 index 1714dac45b..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_containerstaterunning_v1_concept.md +++ /dev/null @@ -1,31 +0,0 @@ - - ------------ -# ContainerStateRunning v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStateRunning - - - - - - - -ContainerStateRunning is a running state of a container. - - - -Field | Description ------------- | ----------- -startedAt
*[Time](#time-unversioned)* | Time at which the container was last (re-)started - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_containerstaterunning_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_containerstaterunning_v1_definition.md deleted file mode 100644 index 6080af649c..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_containerstaterunning_v1_definition.md +++ /dev/null @@ -1,17 +0,0 @@ -## ContainerStateRunning v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStateRunning - - - -ContainerStateRunning is a running state of a container. - - - -Field | Description ------------- | ----------- -startedAt
*[Time](#time-unversioned)* | Time at which the container was last (re-)started - diff --git a/docs/api-reference/v1.5/documents/_generated_containerstateterminated_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_containerstateterminated_v1_concept.md deleted file mode 100644 index e76ba6af4a..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_containerstateterminated_v1_concept.md +++ /dev/null @@ -1,37 +0,0 @@ - - ------------ -# ContainerStateTerminated v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStateTerminated - - - - - - - -ContainerStateTerminated is a terminated state of a container. - - - -Field | Description ------------- | ----------- -containerID
*string* | Container's ID in the format 'docker://' -exitCode
*integer* | Exit status from the last termination of the container -finishedAt
*[Time](#time-unversioned)* | Time at which the container last terminated -message
*string* | Message regarding the last termination of the container -reason
*string* | (brief) reason from the last termination of the container -signal
*integer* | Signal from the last termination of the container -startedAt
*[Time](#time-unversioned)* | Time at which previous execution of the container started - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_containerstateterminated_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_containerstateterminated_v1_definition.md deleted file mode 100644 index 7c5fa0142a..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_containerstateterminated_v1_definition.md +++ /dev/null @@ -1,23 +0,0 @@ -## ContainerStateTerminated v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStateTerminated - - - -ContainerStateTerminated is a terminated state of a container. - - - -Field | Description ------------- | ----------- -containerID
*string* | Container's ID in the format 'docker://' -exitCode
*integer* | Exit status from the last termination of the container -finishedAt
*[Time](#time-unversioned)* | Time at which the container last terminated -message
*string* | Message regarding the last termination of the container -reason
*string* | (brief) reason from the last termination of the container -signal
*integer* | Signal from the last termination of the container -startedAt
*[Time](#time-unversioned)* | Time at which previous execution of the container started - diff --git a/docs/api-reference/v1.5/documents/_generated_containerstatewaiting_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_containerstatewaiting_v1_concept.md deleted file mode 100644 index 9a9a3eeb1f..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_containerstatewaiting_v1_concept.md +++ /dev/null @@ -1,32 +0,0 @@ - - ------------ -# ContainerStateWaiting v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStateWaiting - - - - - - - -ContainerStateWaiting is a waiting state of a container. - - - -Field | Description ------------- | ----------- -message
*string* | Message regarding why the container is not yet running. -reason
*string* | (brief) reason the container is not yet running. - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_containerstatewaiting_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_containerstatewaiting_v1_definition.md deleted file mode 100644 index a09ace9d38..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_containerstatewaiting_v1_definition.md +++ /dev/null @@ -1,18 +0,0 @@ -## ContainerStateWaiting v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStateWaiting - - - -ContainerStateWaiting is a waiting state of a container. - - - -Field | Description ------------- | ----------- -message
*string* | Message regarding why the container is not yet running. -reason
*string* | (brief) reason the container is not yet running. - diff --git a/docs/api-reference/v1.5/documents/_generated_containerstatus_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_containerstatus_v1_concept.md deleted file mode 100644 index a77e8a3074..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_containerstatus_v1_concept.md +++ /dev/null @@ -1,38 +0,0 @@ - - ------------ -# ContainerStatus v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStatus - - - - - - - -ContainerStatus contains details for the current status of this container. - - - -Field | Description ------------- | ----------- -containerID
*string* | Container's ID in the format 'docker://'. More info: http://kubernetes.io/docs/user-guide/container-environment#container-information -image
*string* | The image the container is running. More info: http://kubernetes.io/docs/user-guide/images -imageID
*string* | ImageID of the container's image. -lastState
*[ContainerState](#containerstate-v1)* | Details about the container's last termination condition. -name
*string* | This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated. -ready
*boolean* | Specifies whether the container has passed its readiness probe. -restartCount
*integer* | The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC. -state
*[ContainerState](#containerstate-v1)* | Details about the container's current condition. - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_containerstatus_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_containerstatus_v1_definition.md deleted file mode 100644 index 4154b694f7..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_containerstatus_v1_definition.md +++ /dev/null @@ -1,24 +0,0 @@ -## ContainerStatus v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStatus - - - -ContainerStatus contains details for the current status of this container. - - - -Field | Description ------------- | ----------- -containerID
*string* | Container's ID in the format 'docker://'. More info: http://kubernetes.io/docs/user-guide/container-environment#container-information -image
*string* | The image the container is running. More info: http://kubernetes.io/docs/user-guide/images -imageID
*string* | ImageID of the container's image. -lastState
*[ContainerState](#containerstate-v1)* | Details about the container's last termination condition. -name
*string* | This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated. -ready
*boolean* | Specifies whether the container has passed its readiness probe. -restartCount
*integer* | The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC. -state
*[ContainerState](#containerstate-v1)* | Details about the container's current condition. - diff --git a/docs/api-reference/v1.5/documents/_generated_cputargetutilization_v1beta1_concept.md b/docs/api-reference/v1.5/documents/_generated_cputargetutilization_v1beta1_concept.md deleted file mode 100644 index 53ce2ba364..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_cputargetutilization_v1beta1_concept.md +++ /dev/null @@ -1,31 +0,0 @@ - - ------------ -# CPUTargetUtilization v1beta1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1beta1 | CPUTargetUtilization - - - - - - - - - - - -Field | Description ------------- | ----------- -targetPercentage
*integer* | fraction of the requested CPU that should be utilized/used, e.g. 70 means that 70% of the requested CPU should be in use. - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_cputargetutilization_v1beta1_definition.md b/docs/api-reference/v1.5/documents/_generated_cputargetutilization_v1beta1_definition.md deleted file mode 100644 index c24e29a5c4..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_cputargetutilization_v1beta1_definition.md +++ /dev/null @@ -1,17 +0,0 @@ -## CPUTargetUtilization v1beta1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1beta1 | CPUTargetUtilization - - - - - - - -Field | Description ------------- | ----------- -targetPercentage
*integer* | fraction of the requested CPU that should be utilized/used, e.g. 70 means that 70% of the requested CPU should be in use. - diff --git a/docs/api-reference/v1.5/documents/_generated_cronjob_v2alpha1_concept.md b/docs/api-reference/v1.5/documents/_generated_cronjob_v2alpha1_concept.md deleted file mode 100644 index f9084661df..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_cronjob_v2alpha1_concept.md +++ /dev/null @@ -1,1000 +0,0 @@ - - ------------ -# CronJob v2alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Batch | v2alpha1 | CronJob - - - - - - - -CronJob represents the configuration of a single cron job. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata -spec
*[CronJobSpec](#cronjobspec-v2alpha1)* | Spec is a structure defining the expected behavior of a job, including the schedule. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status -status
*[CronJobStatus](#cronjobstatus-v2alpha1)* | Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status - - -### CronJobSpec v2alpha1 - - - -Field | Description ------------- | ----------- -concurrencyPolicy
*string* | ConcurrencyPolicy specifies how to treat concurrent executions of a Job. -jobTemplate
*[JobTemplateSpec](#jobtemplatespec-v2alpha1)* | JobTemplate is the object that describes the job that will be created when executing a CronJob. -schedule
*string* | Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. -startingDeadlineSeconds
*integer* | Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. -suspend
*boolean* | Suspend flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false. - -### CronJobStatus v2alpha1 - - - -Field | Description ------------- | ----------- -active
*[ObjectReference](#objectreference-v1) array* | Active holds pointers to currently running jobs. -lastScheduleTime
*[Time](#time-unversioned)* | LastScheduleTime keeps information of when was the last time the job was successfully scheduled. - -### CronJobList v2alpha1 - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
*[CronJob](#cronjob-v2alpha1) array* | Items is the list of CronJob. -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - - - - -## Write Operations - -See supported operations below... - -## Create - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -create a CronJob - -### HTTP Request - -`POST /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs` - -### Path Parameters - -Parameter | Description ------------- | ----------- -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[CronJob](#cronjob-v2alpha1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[CronJob](#cronjob-v2alpha1)* | OK - - -## Replace - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace the specified CronJob - -### HTTP Request - -`PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the CronJob -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[CronJob](#cronjob-v2alpha1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[CronJob](#cronjob-v2alpha1)* | OK - - -## Patch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update the specified CronJob - -### HTTP Request - -`PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the CronJob -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
*[CronJob](#cronjob-v2alpha1)* | OK - - -## Delete - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -delete a CronJob - -### HTTP Request - -`DELETE /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the CronJob -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. -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. -orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[DeleteOptions](#deleteoptions-v1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[Status](#status-unversioned)* | OK - - -## Delete Collection - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -delete collection of CronJob - -### HTTP Request - -`DELETE /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs` - -### Path Parameters - -Parameter | Description ------------- | ----------- -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Status](#status-unversioned)* | OK - - - -## Read Operations - -See supported operations below... - -## Read - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read the specified CronJob - -### HTTP Request - -`GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the CronJob -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. -exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace' -export | Should this value be exported. Export strips fields that a user can not specify. - - -### Response - -Code | Description ------------- | ----------- -200
*[CronJob](#cronjob-v2alpha1)* | OK - - -## List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -list or watch objects of kind CronJob - -### HTTP Request - -`GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs` - -### Path Parameters - -Parameter | Description ------------- | ----------- -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[CronJobList](#cronjoblist-v2alpha1)* | OK - - -## List All Namespaces - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -list or watch objects of kind CronJob - -### HTTP Request - -`GET /apis/batch/v2alpha1/cronjobs` - - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[CronJobList](#cronjoblist-v2alpha1)* | OK - - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch changes to an object of kind CronJob - -### HTTP Request - -`GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the CronJob -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - -## Watch List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of CronJob - -### HTTP Request - -`GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs` - -### Path Parameters - -Parameter | Description ------------- | ----------- -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - -## Watch List All Namespaces - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of CronJob - -### HTTP Request - -`GET /apis/batch/v2alpha1/watch/cronjobs` - - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - - -## Status Operations - -See supported operations below... - -## Patch Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update status of the specified CronJob - -### HTTP Request - -`PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the CronJob -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
*[CronJob](#cronjob-v2alpha1)* | OK - - -## Read Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read status of the specified CronJob - -### HTTP Request - -`GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the CronJob -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
*[CronJob](#cronjob-v2alpha1)* | OK - - -## Replace Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace status of the specified CronJob - -### HTTP Request - -`PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the CronJob -namespace | object name and auth scope, such as for teams and projects - -### Query Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Body Parameters - -Parameter | Description ------------- | ----------- -body
*[CronJob](#cronjob-v2alpha1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[CronJob](#cronjob-v2alpha1)* | OK - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_cronjob_v2alpha1_definition.md b/docs/api-reference/v1.5/documents/_generated_cronjob_v2alpha1_definition.md deleted file mode 100644 index a3477fe785..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_cronjob_v2alpha1_definition.md +++ /dev/null @@ -1,21 +0,0 @@ -## CronJob v2alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Batch | v2alpha1 | CronJob - - - -CronJob represents the configuration of a single cron job. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata -spec
*[CronJobSpec](#cronjobspec-v2alpha1)* | Spec is a structure defining the expected behavior of a job, including the schedule. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status -status
*[CronJobStatus](#cronjobstatus-v2alpha1)* | Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status - diff --git a/docs/api-reference/v1.5/documents/_generated_cronjoblist_v2alpha1_concept.md b/docs/api-reference/v1.5/documents/_generated_cronjoblist_v2alpha1_concept.md deleted file mode 100644 index f63337e893..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_cronjoblist_v2alpha1_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# CronJobList v2alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v2alpha1 | CronJobList - - - - - - - -CronJobList is a collection of cron jobs. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
*[CronJob](#cronjob-v2alpha1) array* | Items is the list of CronJob. -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_cronjoblist_v2alpha1_definition.md b/docs/api-reference/v1.5/documents/_generated_cronjoblist_v2alpha1_definition.md deleted file mode 100644 index 9c0f2059d8..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_cronjoblist_v2alpha1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## CronJobList v2alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v2alpha1 | CronJobList - - - -CronJobList is a collection of cron jobs. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
*[CronJob](#cronjob-v2alpha1) array* | Items is the list of CronJob. -kind
*string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - diff --git a/docs/api-reference/v1.5/documents/_generated_cronjobspec_v2alpha1_concept.md b/docs/api-reference/v1.5/documents/_generated_cronjobspec_v2alpha1_concept.md deleted file mode 100644 index 2e58bf43c9..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_cronjobspec_v2alpha1_concept.md +++ /dev/null @@ -1,35 +0,0 @@ - - ------------ -# CronJobSpec v2alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v2alpha1 | CronJobSpec - - - - - - - -CronJobSpec describes how the job execution will look like and when it will actually run. - - - -Field | Description ------------- | ----------- -concurrencyPolicy
*string* | ConcurrencyPolicy specifies how to treat concurrent executions of a Job. -jobTemplate
*[JobTemplateSpec](#jobtemplatespec-v2alpha1)* | JobTemplate is the object that describes the job that will be created when executing a CronJob. -schedule
*string* | Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. -startingDeadlineSeconds
*integer* | Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. -suspend
*boolean* | Suspend flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false. - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_cronjobspec_v2alpha1_definition.md b/docs/api-reference/v1.5/documents/_generated_cronjobspec_v2alpha1_definition.md deleted file mode 100644 index 56dd8832c3..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_cronjobspec_v2alpha1_definition.md +++ /dev/null @@ -1,21 +0,0 @@ -## CronJobSpec v2alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v2alpha1 | CronJobSpec - - - -CronJobSpec describes how the job execution will look like and when it will actually run. - - - -Field | Description ------------- | ----------- -concurrencyPolicy
*string* | ConcurrencyPolicy specifies how to treat concurrent executions of a Job. -jobTemplate
*[JobTemplateSpec](#jobtemplatespec-v2alpha1)* | JobTemplate is the object that describes the job that will be created when executing a CronJob. -schedule
*string* | Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. -startingDeadlineSeconds
*integer* | Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. -suspend
*boolean* | Suspend flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false. - diff --git a/docs/api-reference/v1.5/documents/_generated_cronjobstatus_v2alpha1_concept.md b/docs/api-reference/v1.5/documents/_generated_cronjobstatus_v2alpha1_concept.md deleted file mode 100644 index 3bd2980690..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_cronjobstatus_v2alpha1_concept.md +++ /dev/null @@ -1,32 +0,0 @@ - - ------------ -# CronJobStatus v2alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v2alpha1 | CronJobStatus - - - - - - - -CronJobStatus represents the current state of a cron job. - - - -Field | Description ------------- | ----------- -active
*[ObjectReference](#objectreference-v1) array* | Active holds pointers to currently running jobs. -lastScheduleTime
*[Time](#time-unversioned)* | LastScheduleTime keeps information of when was the last time the job was successfully scheduled. - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_cronjobstatus_v2alpha1_definition.md b/docs/api-reference/v1.5/documents/_generated_cronjobstatus_v2alpha1_definition.md deleted file mode 100644 index 021803c3e1..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_cronjobstatus_v2alpha1_definition.md +++ /dev/null @@ -1,18 +0,0 @@ -## CronJobStatus v2alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v2alpha1 | CronJobStatus - - - -CronJobStatus represents the current state of a cron job. - - - -Field | Description ------------- | ----------- -active
*[ObjectReference](#objectreference-v1) array* | Active holds pointers to currently running jobs. -lastScheduleTime
*[Time](#time-unversioned)* | LastScheduleTime keeps information of when was the last time the job was successfully scheduled. - diff --git a/docs/api-reference/v1.5/documents/_generated_crossversionobjectreference_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_crossversionobjectreference_v1_concept.md deleted file mode 100644 index e18c960c76..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_crossversionobjectreference_v1_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# CrossVersionObjectReference v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | CrossVersionObjectReference - - - - - - - -CrossVersionObjectReference contains enough information to let you identify the referred resource. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | API version of the referent -kind
*string* | Kind of the referent; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds" -name
*string* | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_crossversionobjectreference_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_crossversionobjectreference_v1_definition.md deleted file mode 100644 index 49aabee65c..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_crossversionobjectreference_v1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## CrossVersionObjectReference v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | CrossVersionObjectReference - - - -CrossVersionObjectReference contains enough information to let you identify the referred resource. - - - -Field | Description ------------- | ----------- -apiVersion
*string* | API version of the referent -kind
*string* | Kind of the referent; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds" -name
*string* | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names - diff --git a/docs/api-reference/v1.5/documents/_generated_daemonendpoint_v1_concept.md b/docs/api-reference/v1.5/documents/_generated_daemonendpoint_v1_concept.md deleted file mode 100644 index e745761332..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_daemonendpoint_v1_concept.md +++ /dev/null @@ -1,31 +0,0 @@ - - ------------ -# DaemonEndpoint v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | DaemonEndpoint - - - - - - - -DaemonEndpoint contains information about a single Daemon endpoint. - - - -Field | Description ------------- | ----------- -Port
*integer* | Port number of the given endpoint. - - - - - - diff --git a/docs/api-reference/v1.5/documents/_generated_daemonendpoint_v1_definition.md b/docs/api-reference/v1.5/documents/_generated_daemonendpoint_v1_definition.md deleted file mode 100644 index f2b131a01e..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_daemonendpoint_v1_definition.md +++ /dev/null @@ -1,17 +0,0 @@ -## DaemonEndpoint v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | DaemonEndpoint - - - -DaemonEndpoint contains information about a single Daemon endpoint. - - - -Field | Description ------------- | ----------- -Port
*integer* | Port number of the given endpoint. - diff --git a/docs/api-reference/v1.5/documents/_generated_daemonset_v1beta1_concept.md b/docs/api-reference/v1.5/documents/_generated_daemonset_v1beta1_concept.md deleted file mode 100644 index c44c764460..0000000000 --- a/docs/api-reference/v1.5/documents/_generated_daemonset_v1beta1_concept.md +++ /dev/null @@ -1,1110 +0,0 @@ - - ------------ -# DaemonSet v1beta1 - ->bdocs-tab:kubectl DaemonSet Config to print the `hostname` on each Node in the cluster every 10 seconds. - -```bdocs-tab:kubectl_yaml - -apiVersion: extensions/v1beta1 -kind: DaemonSet -metadata: - # Unique key of the DaemonSet instance - name: daemonset-example -spec: - template: - metadata: - labels: - app: daemonset-example - spec: - containers: - # This container is run once on each Node in the cluster - - name: daemonset-example - image: ubuntu:trusty - command: - - /bin/sh - args: - - -c - # This script is run through `sh -c - + \ No newline at end of file diff --git a/docs/api-reference/v1.5/manifest.json b/docs/api-reference/v1.5/manifest.json deleted file mode 100644 index 5b56e46622..0000000000 --- a/docs/api-reference/v1.5/manifest.json +++ /dev/null @@ -1,520 +0,0 @@ -{ - "table_of_contents": {}, - "docs": [ - { - "filename": "_overview.md" - }, - { - "filename": "_workloads.md" - }, - { - "filename": "_generated_container_v1_concept.md" - }, - { - "filename": "_generated_cronjob_v2alpha1_concept.md" - }, - { - "filename": "_generated_daemonset_v1beta1_concept.md" - }, - { - "filename": "_generated_deployment_v1beta1_concept.md" - }, - { - "filename": "_generated_job_v1_concept.md" - }, - { - "filename": "_generated_pod_v1_concept.md" - }, - { - "filename": "_generated_replicaset_v1beta1_concept.md" - }, - { - "filename": "_generated_replicationcontroller_v1_concept.md" - }, - { - "filename": "_generated_statefulset_v1beta1_concept.md" - }, - { - "filename": "_servicediscovery.md" - }, - { - "filename": "_generated_endpoints_v1_concept.md" - }, - { - "filename": "_generated_ingress_v1beta1_concept.md" - }, - { - "filename": "_generated_service_v1_concept.md" - }, - { - "filename": "_config.md" - }, - { - "filename": "_generated_configmap_v1_concept.md" - }, - { - "filename": "_generated_secret_v1_concept.md" - }, - { - "filename": "_generated_persistentvolumeclaim_v1_concept.md" - }, - { - "filename": "_generated_storageclass_v1beta1_concept.md" - }, - { - "filename": "_generated_volume_v1_concept.md" - }, - { - "filename": "_meta.md" - }, - { - "filename": "_generated_event_v1_concept.md" - }, - { - "filename": "_generated_limitrange_v1_concept.md" - }, - { - "filename": "_generated_horizontalpodautoscaler_v1_concept.md" - }, - { - "filename": "_generated_podtemplate_v1_concept.md" - }, - { - "filename": "_generated_poddisruptionbudget_v1beta1_concept.md" - }, - { - "filename": "_generated_thirdpartyresource_v1beta1_concept.md" - }, - { - "filename": "_cluster.md" - }, - { - "filename": "_generated_binding_v1_concept.md" - }, - { - "filename": "_generated_certificatesigningrequest_v1alpha1_concept.md" - }, - { - "filename": "_generated_clusterrole_v1alpha1_concept.md" - }, - { - "filename": "_generated_clusterrolebinding_v1alpha1_concept.md" - }, - { - "filename": "_generated_componentstatus_v1_concept.md" - }, - { - "filename": "_generated_localsubjectaccessreview_v1beta1_concept.md" - }, - { - "filename": "_generated_namespace_v1_concept.md" - }, - { - "filename": "_generated_node_v1_concept.md" - }, - { - "filename": "_generated_persistentvolume_v1_concept.md" - }, - { - "filename": "_generated_resourcequota_v1_concept.md" - }, - { - "filename": "_generated_role_v1alpha1_concept.md" - }, - { - "filename": "_generated_rolebinding_v1alpha1_concept.md" - }, - { - "filename": "_generated_selfsubjectaccessreview_v1beta1_concept.md" - }, - { - "filename": "_generated_serviceaccount_v1_concept.md" - }, - { - "filename": "_generated_subjectaccessreview_v1beta1_concept.md" - }, - { - "filename": "_generated_tokenreview_v1beta1_concept.md" - }, - { - "filename": "_generated_networkpolicy_v1beta1_concept.md" - }, - { - "filename": "_definitions.md" - }, - { - "filename": "_generated_apigroup_unversioned_definition.md" - }, - { - "filename": "_generated_apiresource_unversioned_definition.md" - }, - { - "filename": "_generated_apiversion_v1beta1_definition.md" - }, - { - "filename": "_generated_apiversions_unversioned_definition.md" - }, - { - "filename": "_generated_awselasticblockstorevolumesource_v1_definition.md" - }, - { - "filename": "_generated_attachedvolume_v1_definition.md" - }, - { - "filename": "_generated_azurediskvolumesource_v1_definition.md" - }, - { - "filename": "_generated_azurefilevolumesource_v1_definition.md" - }, - { - "filename": "_generated_cputargetutilization_v1beta1_definition.md" - }, - { - "filename": "_generated_capabilities_v1_definition.md" - }, - { - "filename": "_generated_cephfsvolumesource_v1_definition.md" - }, - { - "filename": "_generated_certificatesigningrequestcondition_v1alpha1_definition.md" - }, - { - "filename": "_generated_cindervolumesource_v1_definition.md" - }, - { - "filename": "_generated_componentcondition_v1_definition.md" - }, - { - "filename": "_generated_configmapkeyselector_v1_definition.md" - }, - { - "filename": "_generated_configmapvolumesource_v1_definition.md" - }, - { - "filename": "_generated_containerimage_v1_definition.md" - }, - { - "filename": "_generated_containerport_v1_definition.md" - }, - { - "filename": "_generated_containerstate_v1_definition.md" - }, - { - "filename": "_generated_containerstaterunning_v1_definition.md" - }, - { - "filename": "_generated_containerstateterminated_v1_definition.md" - }, - { - "filename": "_generated_containerstatewaiting_v1_definition.md" - }, - { - "filename": "_generated_crossversionobjectreference_v1_definition.md" - }, - { - "filename": "_generated_daemonendpoint_v1_definition.md" - }, - { - "filename": "_generated_deleteoptions_v1_definition.md" - }, - { - "filename": "_generated_deploymentcondition_v1beta1_definition.md" - }, - { - "filename": "_generated_downwardapivolumefile_v1_definition.md" - }, - { - "filename": "_generated_downwardapivolumesource_v1_definition.md" - }, - { - "filename": "_generated_emptydirvolumesource_v1_definition.md" - }, - { - "filename": "_generated_endpointaddress_v1_definition.md" - }, - { - "filename": "_generated_endpointport_v1_definition.md" - }, - { - "filename": "_generated_endpointsubset_v1_definition.md" - }, - { - "filename": "_generated_envvar_v1_definition.md" - }, - { - "filename": "_generated_envvarsource_v1_definition.md" - }, - { - "filename": "_generated_eventsource_v1_definition.md" - }, - { - "filename": "_generated_eviction_v1beta1_definition.md" - }, - { - "filename": "_generated_execaction_v1_definition.md" - }, - { - "filename": "_generated_fcvolumesource_v1_definition.md" - }, - { - "filename": "_generated_flexvolumesource_v1_definition.md" - }, - { - "filename": "_generated_flockervolumesource_v1_definition.md" - }, - { - "filename": "_generated_gcepersistentdiskvolumesource_v1_definition.md" - }, - { - "filename": "_generated_gitrepovolumesource_v1_definition.md" - }, - { - "filename": "_generated_glusterfsvolumesource_v1_definition.md" - }, - { - "filename": "_generated_groupversionfordiscovery_unversioned_definition.md" - }, - { - "filename": "_generated_httpgetaction_v1_definition.md" - }, - { - "filename": "_generated_httpheader_v1_definition.md" - }, - { - "filename": "_generated_httpingresspath_v1beta1_definition.md" - }, - { - "filename": "_generated_httpingressrulevalue_v1beta1_definition.md" - }, - { - "filename": "_generated_handler_v1_definition.md" - }, - { - "filename": "_generated_hostpathvolumesource_v1_definition.md" - }, - { - "filename": "_generated_iscsivolumesource_v1_definition.md" - }, - { - "filename": "_generated_info_version_definition.md" - }, - { - "filename": "_generated_ingressbackend_v1beta1_definition.md" - }, - { - "filename": "_generated_ingressrule_v1beta1_definition.md" - }, - { - "filename": "_generated_ingresstls_v1beta1_definition.md" - }, - { - "filename": "_generated_intorstring_intstr_definition.md" - }, - { - "filename": "_generated_jobcondition_v1_definition.md" - }, - { - "filename": "_generated_jobtemplatespec_v2alpha1_definition.md" - }, - { - "filename": "_generated_keytopath_v1_definition.md" - }, - { - "filename": "_generated_labelselector_unversioned_definition.md" - }, - { - "filename": "_generated_labelselectorrequirement_unversioned_definition.md" - }, - { - "filename": "_generated_lifecycle_v1_definition.md" - }, - { - "filename": "_generated_limitrangeitem_v1_definition.md" - }, - { - "filename": "_generated_listmeta_unversioned_definition.md" - }, - { - "filename": "_generated_loadbalanceringress_v1_definition.md" - }, - { - "filename": "_generated_loadbalancerstatus_v1_definition.md" - }, - { - "filename": "_generated_localobjectreference_v1_definition.md" - }, - { - "filename": "_generated_nfsvolumesource_v1_definition.md" - }, - { - "filename": "_generated_networkpolicyingressrule_v1beta1_definition.md" - }, - { - "filename": "_generated_networkpolicypeer_v1beta1_definition.md" - }, - { - "filename": "_generated_networkpolicyport_v1beta1_definition.md" - }, - { - "filename": "_generated_nodeaddress_v1_definition.md" - }, - { - "filename": "_generated_nodecondition_v1_definition.md" - }, - { - "filename": "_generated_nodedaemonendpoints_v1_definition.md" - }, - { - "filename": "_generated_nodesysteminfo_v1_definition.md" - }, - { - "filename": "_generated_nonresourceattributes_v1beta1_definition.md" - }, - { - "filename": "_generated_objectfieldselector_v1_definition.md" - }, - { - "filename": "_generated_objectmeta_v1_definition.md" - }, - { - "filename": "_generated_objectreference_v1_definition.md" - }, - { - "filename": "_generated_ownerreference_v1_definition.md" - }, - { - "filename": "_generated_patch_unversioned_definition.md" - }, - { - "filename": "_generated_persistentvolumeclaimvolumesource_v1_definition.md" - }, - { - "filename": "_generated_photonpersistentdiskvolumesource_v1_definition.md" - }, - { - "filename": "_generated_podcondition_v1_definition.md" - }, - { - "filename": "_generated_podsecuritycontext_v1_definition.md" - }, - { - "filename": "_generated_policyrule_v1alpha1_definition.md" - }, - { - "filename": "_generated_preconditions_v1_definition.md" - }, - { - "filename": "_generated_probe_v1_definition.md" - }, - { - "filename": "_generated_quantity_resource_definition.md" - }, - { - "filename": "_generated_quobytevolumesource_v1_definition.md" - }, - { - "filename": "_generated_rbdvolumesource_v1_definition.md" - }, - { - "filename": "_generated_rawextension_runtime_definition.md" - }, - { - "filename": "_generated_replicasetcondition_v1beta1_definition.md" - }, - { - "filename": "_generated_replicationcontrollercondition_v1_definition.md" - }, - { - "filename": "_generated_resourceattributes_v1beta1_definition.md" - }, - { - "filename": "_generated_resourcefieldselector_v1_definition.md" - }, - { - "filename": "_generated_resourcerequirements_v1_definition.md" - }, - { - "filename": "_generated_roleref_v1alpha1_definition.md" - }, - { - "filename": "_generated_rollbackconfig_v1beta1_definition.md" - }, - { - "filename": "_generated_selinuxoptions_v1_definition.md" - }, - { - "filename": "_generated_scale_v1_definition.md" - }, - { - "filename": "_generated_secretkeyselector_v1_definition.md" - }, - { - "filename": "_generated_secretvolumesource_v1_definition.md" - }, - { - "filename": "_generated_securitycontext_v1_definition.md" - }, - { - "filename": "_generated_serveraddressbyclientcidr_unversioned_definition.md" - }, - { - "filename": "_generated_serviceport_v1_definition.md" - }, - { - "filename": "_generated_status_unversioned_definition.md" - }, - { - "filename": "_generated_statuscause_unversioned_definition.md" - }, - { - "filename": "_generated_statusdetails_unversioned_definition.md" - }, - { - "filename": "_generated_subject_v1alpha1_definition.md" - }, - { - "filename": "_generated_subresourcereference_v1beta1_definition.md" - }, - { - "filename": "_generated_tcpsocketaction_v1_definition.md" - }, - { - "filename": "_generated_time_unversioned_definition.md" - }, - { - "filename": "_generated_userinfo_v1beta1_definition.md" - }, - { - "filename": "_generated_volumemount_v1_definition.md" - }, - { - "filename": "_generated_vspherevirtualdiskvolumesource_v1_definition.md" - }, - { - "filename": "_oldversions.md" - }, - { - "filename": "_generated_event_versioned_concept.md" - }, - { - "filename": "_generated_horizontalpodautoscaler_v1beta1_concept.md" - }, - { - "filename": "_generated_job_v1beta1_concept.md" - }, - { - "filename": "_generated_job_v2alpha1_concept.md" - }, - { - "filename": "_generated_jobcondition_v1beta1_concept.md" - }, - { - "filename": "_generated_jobcondition_v2alpha1_concept.md" - }, - { - "filename": "_generated_scale_v1beta1_concept.md" - } - ], - "title": "Kubernetes API Reference Docs", - "copyright": "\u003ca href=\"https://github.com/kubernetes/kubernetes\"\u003eCopyright 2016 The Kubernetes Authors.\u003c/a\u003e" -} \ No newline at end of file diff --git a/docs/api-reference/v1.5/navData.js b/docs/api-reference/v1.5/navData.js index 2b19be8860..fc3b93deea 100644 --- a/docs/api-reference/v1.5/navData.js +++ b/docs/api-reference/v1.5/navData.js @@ -1 +1 @@ -(function(){navData = {"toc":[{"section":"scale-v1beta1","subsections":[]},{"section":"jobcondition-v2alpha1","subsections":[]},{"section":"jobcondition-v1beta1","subsections":[]},{"section":"job-v2alpha1","subsections":[{"section":"-strong-read-operations-strong--484","subsections":[{"section":"watch-list-all-namespaces-489"},{"section":"watch-488"},{"section":"list-all-namespaces-487"},{"section":"list-486"},{"section":"read-485"}]},{"section":"-strong-write-operations-strong--478","subsections":[{"section":"delete-collection-483"},{"section":"delete-482"},{"section":"patch-481"},{"section":"replace-480"},{"section":"create-479"}]}]},{"section":"job-v1beta1","subsections":[{"section":"-strong-read-operations-strong--472","subsections":[{"section":"watch-list-all-namespaces-477"},{"section":"watch-476"},{"section":"list-all-namespaces-475"},{"section":"list-474"},{"section":"read-473"}]},{"section":"-strong-write-operations-strong--466","subsections":[{"section":"delete-collection-471"},{"section":"delete-470"},{"section":"patch-469"},{"section":"replace-468"},{"section":"create-467"}]}]},{"section":"horizontalpodautoscaler-v1beta1","subsections":[{"section":"-strong-read-operations-strong--460","subsections":[{"section":"watch-list-all-namespaces-465"},{"section":"watch-464"},{"section":"list-all-namespaces-463"},{"section":"list-462"},{"section":"read-461"}]},{"section":"-strong-write-operations-strong--454","subsections":[{"section":"delete-collection-459"},{"section":"delete-458"},{"section":"patch-457"},{"section":"replace-456"},{"section":"create-455"}]}]},{"section":"event-versioned","subsections":[]},{"section":"-strong-old-api-versions-strong-","subsections":[]},{"section":"-strong-definitions-strong-","subsections":[{"section":"vspherevirtualdiskvolumesource-v1"},{"section":"volumemount-v1"},{"section":"userinfo-v1beta1"},{"section":"time-unversioned"},{"section":"tcpsocketaction-v1"},{"section":"subresourcereference-v1beta1"},{"section":"subject-v1alpha1"},{"section":"statusdetails-unversioned"},{"section":"statuscause-unversioned"},{"section":"status-unversioned"},{"section":"serviceport-v1"},{"section":"serveraddressbyclientcidr-unversioned"},{"section":"securitycontext-v1"},{"section":"secretvolumesource-v1"},{"section":"secretkeyselector-v1"},{"section":"scale-v1"},{"section":"selinuxoptions-v1"},{"section":"rollbackconfig-v1beta1"},{"section":"roleref-v1alpha1"},{"section":"resourcerequirements-v1"},{"section":"resourcefieldselector-v1"},{"section":"resourceattributes-v1beta1"},{"section":"replicationcontrollercondition-v1"},{"section":"replicasetcondition-v1beta1"},{"section":"rawextension-runtime"},{"section":"rbdvolumesource-v1"},{"section":"quobytevolumesource-v1"},{"section":"quantity-resource"},{"section":"probe-v1"},{"section":"preconditions-v1"},{"section":"policyrule-v1alpha1"},{"section":"podsecuritycontext-v1"},{"section":"podcondition-v1"},{"section":"photonpersistentdiskvolumesource-v1"},{"section":"persistentvolumeclaimvolumesource-v1"},{"section":"patch-unversioned"},{"section":"ownerreference-v1"},{"section":"objectreference-v1"},{"section":"objectmeta-v1"},{"section":"objectfieldselector-v1"},{"section":"nonresourceattributes-v1beta1"},{"section":"nodesysteminfo-v1"},{"section":"nodedaemonendpoints-v1"},{"section":"nodecondition-v1"},{"section":"nodeaddress-v1"},{"section":"networkpolicyport-v1beta1"},{"section":"networkpolicypeer-v1beta1"},{"section":"networkpolicyingressrule-v1beta1"},{"section":"nfsvolumesource-v1"},{"section":"localobjectreference-v1"},{"section":"loadbalancerstatus-v1"},{"section":"loadbalanceringress-v1"},{"section":"listmeta-unversioned"},{"section":"limitrangeitem-v1"},{"section":"lifecycle-v1"},{"section":"labelselectorrequirement-unversioned"},{"section":"labelselector-unversioned"},{"section":"keytopath-v1"},{"section":"jobtemplatespec-v2alpha1"},{"section":"jobcondition-v1"},{"section":"intorstring-intstr"},{"section":"ingresstls-v1beta1"},{"section":"ingressrule-v1beta1"},{"section":"ingressbackend-v1beta1"},{"section":"info-version"},{"section":"iscsivolumesource-v1"},{"section":"hostpathvolumesource-v1"},{"section":"handler-v1"},{"section":"httpingressrulevalue-v1beta1"},{"section":"httpingresspath-v1beta1"},{"section":"httpheader-v1"},{"section":"httpgetaction-v1"},{"section":"groupversionfordiscovery-unversioned"},{"section":"glusterfsvolumesource-v1"},{"section":"gitrepovolumesource-v1"},{"section":"gcepersistentdiskvolumesource-v1"},{"section":"flockervolumesource-v1"},{"section":"flexvolumesource-v1"},{"section":"fcvolumesource-v1"},{"section":"execaction-v1"},{"section":"eviction-v1beta1"},{"section":"eventsource-v1"},{"section":"envvarsource-v1"},{"section":"envvar-v1"},{"section":"endpointsubset-v1"},{"section":"endpointport-v1"},{"section":"endpointaddress-v1"},{"section":"emptydirvolumesource-v1"},{"section":"downwardapivolumesource-v1"},{"section":"downwardapivolumefile-v1"},{"section":"deploymentcondition-v1beta1"},{"section":"deleteoptions-v1"},{"section":"daemonendpoint-v1"},{"section":"crossversionobjectreference-v1"},{"section":"containerstatewaiting-v1"},{"section":"containerstateterminated-v1"},{"section":"containerstaterunning-v1"},{"section":"containerstate-v1"},{"section":"containerport-v1"},{"section":"containerimage-v1"},{"section":"configmapvolumesource-v1"},{"section":"configmapkeyselector-v1"},{"section":"componentcondition-v1"},{"section":"cindervolumesource-v1"},{"section":"certificatesigningrequestcondition-v1alpha1"},{"section":"cephfsvolumesource-v1"},{"section":"capabilities-v1"},{"section":"cputargetutilization-v1beta1"},{"section":"azurefilevolumesource-v1"},{"section":"azurediskvolumesource-v1"},{"section":"attachedvolume-v1"},{"section":"awselasticblockstorevolumesource-v1"},{"section":"apiversions-unversioned"},{"section":"apiversion-v1beta1"},{"section":"apiresource-unversioned"},{"section":"apigroup-unversioned"}]},{"section":"networkpolicy-v1beta1","subsections":[{"section":"-strong-read-operations-strong--448","subsections":[{"section":"watch-list-all-namespaces-453"},{"section":"watch-452"},{"section":"list-all-namespaces-451"},{"section":"list-450"},{"section":"read-449"}]},{"section":"-strong-write-operations-strong--442","subsections":[{"section":"delete-collection-447"},{"section":"delete-446"},{"section":"patch-445"},{"section":"replace-444"},{"section":"create-443"}]}]},{"section":"tokenreview-v1beta1","subsections":[{"section":"-strong-write-operations-strong--440","subsections":[{"section":"create-441"}]}]},{"section":"subjectaccessreview-v1beta1","subsections":[{"section":"-strong-write-operations-strong--438","subsections":[{"section":"create-439"}]}]},{"section":"serviceaccount-v1","subsections":[{"section":"-strong-read-operations-strong--431","subsections":[{"section":"watch-list-all-namespaces-437"},{"section":"watch-list-436"},{"section":"watch-435"},{"section":"list-all-namespaces-434"},{"section":"list-433"},{"section":"read-432"}]},{"section":"-strong-write-operations-strong--425","subsections":[{"section":"delete-collection-430"},{"section":"delete-429"},{"section":"patch-428"},{"section":"replace-427"},{"section":"create-426"}]}]},{"section":"selfsubjectaccessreview-v1beta1","subsections":[{"section":"-strong-write-operations-strong--423","subsections":[{"section":"create-424"}]}]},{"section":"rolebinding-v1alpha1","subsections":[{"section":"-strong-read-operations-strong--416","subsections":[{"section":"watch-list-all-namespaces-422"},{"section":"watch-list-421"},{"section":"watch-420"},{"section":"list-all-namespaces-419"},{"section":"list-418"},{"section":"read-417"}]},{"section":"-strong-write-operations-strong--410","subsections":[{"section":"delete-collection-415"},{"section":"delete-414"},{"section":"patch-413"},{"section":"replace-412"},{"section":"create-411"}]}]},{"section":"role-v1alpha1","subsections":[{"section":"-strong-read-operations-strong--403","subsections":[{"section":"watch-list-all-namespaces-409"},{"section":"watch-list-408"},{"section":"watch-407"},{"section":"list-all-namespaces-406"},{"section":"list-405"},{"section":"read-404"}]},{"section":"-strong-write-operations-strong--397","subsections":[{"section":"delete-collection-402"},{"section":"delete-401"},{"section":"patch-400"},{"section":"replace-399"},{"section":"create-398"}]}]},{"section":"resourcequota-v1","subsections":[{"section":"-strong-status-operations-strong--393","subsections":[{"section":"replace-status-396"},{"section":"read-status-395"},{"section":"patch-status-394"}]},{"section":"-strong-read-operations-strong--387","subsections":[{"section":"watch-list-all-namespaces-392"},{"section":"watch-391"},{"section":"list-all-namespaces-390"},{"section":"list-389"},{"section":"read-388"}]},{"section":"-strong-write-operations-strong--381","subsections":[{"section":"delete-collection-386"},{"section":"delete-385"},{"section":"patch-384"},{"section":"replace-383"},{"section":"create-382"}]}]},{"section":"persistentvolume-v1","subsections":[{"section":"-strong-status-operations-strong--377","subsections":[{"section":"replace-status-380"},{"section":"read-status-379"},{"section":"patch-status-378"}]},{"section":"-strong-read-operations-strong--372","subsections":[{"section":"watch-list-376"},{"section":"watch-375"},{"section":"list-374"},{"section":"read-373"}]},{"section":"-strong-write-operations-strong--366","subsections":[{"section":"delete-collection-371"},{"section":"delete-370"},{"section":"patch-369"},{"section":"replace-368"},{"section":"create-367"}]}]},{"section":"node-v1","subsections":[{"section":"-strong-proxy-operations-strong--347","subsections":[{"section":"replace-proxy-path-365"},{"section":"replace-proxy-364"},{"section":"replace-connect-proxy-path-363"},{"section":"replace-connect-proxy-362"},{"section":"head-connect-proxy-path-361"},{"section":"head-connect-proxy-360"},{"section":"get-proxy-path-359"},{"section":"get-proxy-358"},{"section":"get-connect-proxy-path-357"},{"section":"get-connect-proxy-356"},{"section":"delete-proxy-path-355"},{"section":"delete-proxy-354"},{"section":"delete-connect-proxy-path-353"},{"section":"delete-connect-proxy-352"},{"section":"create-proxy-path-351"},{"section":"create-proxy-350"},{"section":"create-connect-proxy-path-349"},{"section":"create-connect-proxy-348"}]},{"section":"-strong-read-operations-strong--343","subsections":[{"section":"watch-346"},{"section":"list-345"},{"section":"read-344"}]},{"section":"-strong-write-operations-strong--337","subsections":[{"section":"delete-collection-342"},{"section":"delete-341"},{"section":"patch-340"},{"section":"replace-339"},{"section":"create-338"}]}]},{"section":"namespace-v1","subsections":[{"section":"-strong-read-operations-strong--333","subsections":[{"section":"watch-336"},{"section":"list-335"},{"section":"read-334"}]},{"section":"-strong-write-operations-strong--327","subsections":[{"section":"delete-collection-332"},{"section":"delete-331"},{"section":"patch-330"},{"section":"replace-329"},{"section":"create-328"}]}]},{"section":"localsubjectaccessreview-v1beta1","subsections":[{"section":"-strong-write-operations-strong--325","subsections":[{"section":"create-326"}]}]},{"section":"componentstatus-v1","subsections":[{"section":"-strong-read-operations-strong--322","subsections":[{"section":"list-324"},{"section":"read-323"}]}]},{"section":"clusterrolebinding-v1alpha1","subsections":[{"section":"-strong-read-operations-strong--317","subsections":[{"section":"watch-list-321"},{"section":"watch-320"},{"section":"list-319"},{"section":"read-318"}]},{"section":"-strong-write-operations-strong--311","subsections":[{"section":"delete-collection-316"},{"section":"delete-315"},{"section":"patch-314"},{"section":"replace-313"},{"section":"create-312"}]}]},{"section":"clusterrole-v1alpha1","subsections":[{"section":"-strong-read-operations-strong--307","subsections":[{"section":"watch-310"},{"section":"list-309"},{"section":"read-308"}]},{"section":"-strong-write-operations-strong--301","subsections":[{"section":"delete-collection-306"},{"section":"delete-305"},{"section":"patch-304"},{"section":"replace-303"},{"section":"create-302"}]}]},{"section":"certificatesigningrequest-v1alpha1","subsections":[{"section":"-strong-read-operations-strong--297","subsections":[{"section":"watch-300"},{"section":"list-299"},{"section":"read-298"}]},{"section":"-strong-write-operations-strong--291","subsections":[{"section":"delete-collection-296"},{"section":"delete-295"},{"section":"patch-294"},{"section":"replace-293"},{"section":"create-292"}]}]},{"section":"binding-v1","subsections":[{"section":"-strong-write-operations-strong--289","subsections":[{"section":"create-290"}]}]},{"section":"-strong-cluster-strong-","subsections":[]},{"section":"thirdpartyresource-v1beta1","subsections":[{"section":"-strong-read-operations-strong--285","subsections":[{"section":"watch-288"},{"section":"list-287"},{"section":"read-286"}]},{"section":"-strong-write-operations-strong--279","subsections":[{"section":"delete-collection-284"},{"section":"delete-283"},{"section":"patch-282"},{"section":"replace-281"},{"section":"create-280"}]}]},{"section":"poddisruptionbudget-v1beta1","subsections":[{"section":"-strong-read-operations-strong--273","subsections":[{"section":"watch-list-all-namespaces-278"},{"section":"watch-277"},{"section":"list-all-namespaces-276"},{"section":"list-275"},{"section":"read-274"}]},{"section":"-strong-write-operations-strong--267","subsections":[{"section":"delete-collection-272"},{"section":"delete-271"},{"section":"patch-270"},{"section":"replace-269"},{"section":"create-268"}]}]},{"section":"podtemplate-v1","subsections":[{"section":"-strong-read-operations-strong--261","subsections":[{"section":"watch-list-all-namespaces-266"},{"section":"watch-265"},{"section":"list-all-namespaces-264"},{"section":"list-263"},{"section":"read-262"}]},{"section":"-strong-write-operations-strong--255","subsections":[{"section":"delete-collection-260"},{"section":"delete-259"},{"section":"patch-258"},{"section":"replace-257"},{"section":"create-256"}]}]},{"section":"horizontalpodautoscaler-v1","subsections":[{"section":"-strong-read-operations-strong--249","subsections":[{"section":"watch-list-all-namespaces-254"},{"section":"watch-253"},{"section":"list-all-namespaces-252"},{"section":"list-251"},{"section":"read-250"}]},{"section":"-strong-write-operations-strong--243","subsections":[{"section":"delete-collection-248"},{"section":"delete-247"},{"section":"patch-246"},{"section":"replace-245"},{"section":"create-244"}]}]},{"section":"limitrange-v1","subsections":[{"section":"-strong-read-operations-strong--237","subsections":[{"section":"watch-list-all-namespaces-242"},{"section":"watch-241"},{"section":"list-all-namespaces-240"},{"section":"list-239"},{"section":"read-238"}]},{"section":"-strong-write-operations-strong--231","subsections":[{"section":"delete-collection-236"},{"section":"delete-235"},{"section":"patch-234"},{"section":"replace-233"},{"section":"create-232"}]}]},{"section":"event-v1","subsections":[{"section":"-strong-read-operations-strong--225","subsections":[{"section":"watch-list-all-namespaces-230"},{"section":"watch-229"},{"section":"list-all-namespaces-228"},{"section":"list-227"},{"section":"read-226"}]},{"section":"-strong-write-operations-strong--219","subsections":[{"section":"delete-collection-224"},{"section":"delete-223"},{"section":"patch-222"},{"section":"replace-221"},{"section":"create-220"}]}]},{"section":"-strong-metadata-strong-","subsections":[]},{"section":"volume-v1","subsections":[]},{"section":"storageclass-v1beta1","subsections":[{"section":"-strong-read-operations-strong--215","subsections":[{"section":"watch-218"},{"section":"list-217"},{"section":"read-216"}]},{"section":"-strong-write-operations-strong--209","subsections":[{"section":"delete-collection-214"},{"section":"delete-213"},{"section":"patch-212"},{"section":"replace-211"},{"section":"create-210"}]}]},{"section":"persistentvolumeclaim-v1","subsections":[{"section":"-strong-status-operations-strong--205","subsections":[{"section":"replace-status-208"},{"section":"read-status-207"},{"section":"patch-status-206"}]},{"section":"-strong-read-operations-strong--199","subsections":[{"section":"watch-list-all-namespaces-204"},{"section":"watch-203"},{"section":"list-all-namespaces-202"},{"section":"list-201"},{"section":"read-200"}]},{"section":"-strong-write-operations-strong--193","subsections":[{"section":"delete-collection-198"},{"section":"delete-197"},{"section":"patch-196"},{"section":"replace-195"},{"section":"create-194"}]}]},{"section":"secret-v1","subsections":[{"section":"-strong-read-operations-strong--186","subsections":[{"section":"watch-list-all-namespaces-192"},{"section":"watch-list-191"},{"section":"watch-190"},{"section":"list-all-namespaces-189"},{"section":"list-188"},{"section":"read-187"}]},{"section":"-strong-write-operations-strong--180","subsections":[{"section":"delete-collection-185"},{"section":"delete-184"},{"section":"patch-183"},{"section":"replace-182"},{"section":"create-181"}]}]},{"section":"configmap-v1","subsections":[{"section":"-strong-read-operations-strong--174","subsections":[{"section":"watch-list-all-namespaces-179"},{"section":"watch-178"},{"section":"list-all-namespaces-177"},{"section":"list-176"},{"section":"read-175"}]},{"section":"-strong-write-operations-strong--168","subsections":[{"section":"delete-collection-173"},{"section":"delete-172"},{"section":"patch-171"},{"section":"replace-170"},{"section":"create-169"}]}]},{"section":"-strong-config-storage-strong-","subsections":[]},{"section":"service-v1","subsections":[{"section":"-strong-proxy-operations-strong--149","subsections":[{"section":"replace-proxy-path-167"},{"section":"replace-proxy-166"},{"section":"replace-connect-proxy-path-165"},{"section":"replace-connect-proxy-164"},{"section":"head-connect-proxy-path-163"},{"section":"head-connect-proxy-162"},{"section":"get-proxy-path-161"},{"section":"get-proxy-160"},{"section":"get-connect-proxy-path-159"},{"section":"get-connect-proxy-158"},{"section":"delete-proxy-path-157"},{"section":"delete-proxy-156"},{"section":"delete-connect-proxy-path-155"},{"section":"delete-connect-proxy-154"},{"section":"create-proxy-path-153"},{"section":"create-proxy-152"},{"section":"create-connect-proxy-path-151"},{"section":"create-connect-proxy-150"}]},{"section":"-strong-status-operations-strong--145","subsections":[{"section":"replace-status-148"},{"section":"read-status-147"},{"section":"patch-status-146"}]},{"section":"-strong-read-operations-strong--139","subsections":[{"section":"watch-list-all-namespaces-144"},{"section":"watch-143"},{"section":"list-all-namespaces-142"},{"section":"list-141"},{"section":"read-140"}]},{"section":"-strong-write-operations-strong--134","subsections":[{"section":"delete-138"},{"section":"patch-137"},{"section":"replace-136"},{"section":"create-135"}]}]},{"section":"ingress-v1beta1","subsections":[{"section":"-strong-read-operations-strong--128","subsections":[{"section":"watch-list-all-namespaces-133"},{"section":"watch-132"},{"section":"list-all-namespaces-131"},{"section":"list-130"},{"section":"read-129"}]},{"section":"-strong-write-operations-strong--122","subsections":[{"section":"delete-collection-127"},{"section":"delete-126"},{"section":"patch-125"},{"section":"replace-124"},{"section":"create-123"}]}]},{"section":"endpoints-v1","subsections":[{"section":"-strong-read-operations-strong--115","subsections":[{"section":"watch-list-all-namespaces-121"},{"section":"watch-list-120"},{"section":"watch-119"},{"section":"list-all-namespaces-118"},{"section":"list-117"},{"section":"read-116"}]},{"section":"-strong-write-operations-strong--109","subsections":[{"section":"delete-collection-114"},{"section":"delete-113"},{"section":"patch-112"},{"section":"replace-111"},{"section":"create-110"}]}]},{"section":"-strong-discovery-load-balancing-strong-","subsections":[]},{"section":"statefulset-v1beta1","subsections":[{"section":"-strong-status-operations-strong--105","subsections":[{"section":"replace-status-108"},{"section":"read-status-107"},{"section":"patch-status-106"}]},{"section":"-strong-read-operations-strong--98","subsections":[{"section":"watch-list-all-namespaces-104"},{"section":"watch-list-103"},{"section":"watch-102"},{"section":"list-all-namespaces-101"},{"section":"list-100"},{"section":"read-99"}]},{"section":"-strong-write-operations-strong--92","subsections":[{"section":"delete-collection-97"},{"section":"delete-96"},{"section":"patch-95"},{"section":"replace-94"},{"section":"create-93"}]}]},{"section":"replicationcontroller-v1","subsections":[{"section":"-strong-read-operations-strong--86","subsections":[{"section":"watch-list-all-namespaces-91"},{"section":"watch-90"},{"section":"list-all-namespaces-89"},{"section":"list-88"},{"section":"read-87"}]},{"section":"-strong-write-operations-strong--80","subsections":[{"section":"delete-collection-85"},{"section":"delete-84"},{"section":"patch-83"},{"section":"replace-82"},{"section":"create-81"}]}]},{"section":"replicaset-v1beta1","subsections":[{"section":"-strong-misc-operations-strong--76","subsections":[{"section":"patch-scale-79"},{"section":"replace-scale-78"},{"section":"read-scale-77"}]},{"section":"-strong-read-operations-strong--69","subsections":[{"section":"watch-list-all-namespaces-75"},{"section":"watch-list-74"},{"section":"watch-73"},{"section":"list-all-namespaces-72"},{"section":"list-71"},{"section":"read-70"}]},{"section":"-strong-write-operations-strong--63","subsections":[{"section":"delete-collection-68"},{"section":"delete-67"},{"section":"patch-66"},{"section":"replace-65"},{"section":"create-64"}]}]},{"section":"pod-v1","subsections":[{"section":"-strong-misc-operations-strong--62","subsections":[{"section":"read-log"}]},{"section":"-strong-proxy-operations-strong-","subsections":[{"section":"replace-proxy-path"},{"section":"replace-proxy"},{"section":"replace-connect-proxy-path"},{"section":"replace-connect-proxy"},{"section":"head-connect-proxy-path"},{"section":"head-connect-proxy"},{"section":"get-proxy-path"},{"section":"get-proxy"},{"section":"get-connect-proxy-path"},{"section":"get-connect-proxy"},{"section":"get-connect-portforward"},{"section":"delete-proxy-path"},{"section":"delete-proxy"},{"section":"delete-connect-proxy-path"},{"section":"delete-connect-proxy"},{"section":"create-proxy-path"},{"section":"create-proxy"},{"section":"create-connect-proxy-path"},{"section":"create-connect-proxy"},{"section":"create-connect-portforward"}]},{"section":"-strong-read-operations-strong--55","subsections":[{"section":"watch-list-all-namespaces-61"},{"section":"watch-list-60"},{"section":"watch-59"},{"section":"list-all-namespaces-58"},{"section":"list-57"},{"section":"read-56"}]},{"section":"-strong-write-operations-strong--49","subsections":[{"section":"delete-collection-54"},{"section":"delete-53"},{"section":"patch-52"},{"section":"replace-51"},{"section":"create-50"}]}]},{"section":"job-v1","subsections":[{"section":"-strong-read-operations-strong--42","subsections":[{"section":"watch-list-all-namespaces-48"},{"section":"watch-list-47"},{"section":"watch-46"},{"section":"list-all-namespaces-45"},{"section":"list-44"},{"section":"read-43"}]},{"section":"-strong-write-operations-strong--36","subsections":[{"section":"delete-collection-41"},{"section":"delete-40"},{"section":"patch-39"},{"section":"replace-38"},{"section":"create-37"}]}]},{"section":"deployment-v1beta1","subsections":[{"section":"-strong-misc-operations-strong-","subsections":[{"section":"rollback"},{"section":"patch-scale"},{"section":"replace-scale"},{"section":"read-scale"}]},{"section":"-strong-status-operations-strong--32","subsections":[{"section":"replace-status-35"},{"section":"read-status-34"},{"section":"patch-status-33"}]},{"section":"-strong-read-operations-strong--25","subsections":[{"section":"watch-list-all-namespaces-31"},{"section":"watch-list-30"},{"section":"watch-29"},{"section":"list-all-namespaces-28"},{"section":"list-27"},{"section":"read-26"}]},{"section":"-strong-write-operations-strong--19","subsections":[{"section":"delete-collection-24"},{"section":"delete-23"},{"section":"patch-22"},{"section":"replace-21"},{"section":"create-20"}]}]},{"section":"daemonset-v1beta1","subsections":[{"section":"-strong-status-operations-strong--15","subsections":[{"section":"replace-status-18"},{"section":"read-status-17"},{"section":"patch-status-16"}]},{"section":"-strong-read-operations-strong--9","subsections":[{"section":"watch-list-all-namespaces-14"},{"section":"watch-13"},{"section":"list-all-namespaces-12"},{"section":"list-11"},{"section":"read-10"}]},{"section":"-strong-write-operations-strong--3","subsections":[{"section":"delete-collection-8"},{"section":"delete-7"},{"section":"patch-6"},{"section":"replace-5"},{"section":"create-4"}]}]},{"section":"cronjob-v2alpha1","subsections":[{"section":"-strong-status-operations-strong-","subsections":[{"section":"replace-status"},{"section":"read-status"},{"section":"patch-status"}]},{"section":"-strong-read-operations-strong-","subsections":[{"section":"watch-list-all-namespaces"},{"section":"watch-list"},{"section":"watch"},{"section":"list-all-namespaces"},{"section":"list"},{"section":"read-2"}]},{"section":"-strong-write-operations-strong-","subsections":[{"section":"delete-collection"},{"section":"delete-1"},{"section":"patch"},{"section":"replace"},{"section":"create"}]}]},{"section":"container-v1","subsections":[]},{"section":"-strong-workloads-strong-","subsections":[]},{"section":"-strong-api-overview-strong-","subsections":[{"section":"resource-operations"},{"section":"resource-objects"},{"section":"resource-categories"}]}],"flatToc":["scale-v1beta1","jobcondition-v2alpha1","jobcondition-v1beta1","watch-list-all-namespaces-489","watch-488","list-all-namespaces-487","list-486","read-485","-strong-read-operations-strong--484","delete-collection-483","delete-482","patch-481","replace-480","create-479","-strong-write-operations-strong--478","job-v2alpha1","watch-list-all-namespaces-477","watch-476","list-all-namespaces-475","list-474","read-473","-strong-read-operations-strong--472","delete-collection-471","delete-470","patch-469","replace-468","create-467","-strong-write-operations-strong--466","job-v1beta1","watch-list-all-namespaces-465","watch-464","list-all-namespaces-463","list-462","read-461","-strong-read-operations-strong--460","delete-collection-459","delete-458","patch-457","replace-456","create-455","-strong-write-operations-strong--454","horizontalpodautoscaler-v1beta1","event-versioned","-strong-old-api-versions-strong-","vspherevirtualdiskvolumesource-v1","volumemount-v1","userinfo-v1beta1","time-unversioned","tcpsocketaction-v1","subresourcereference-v1beta1","subject-v1alpha1","statusdetails-unversioned","statuscause-unversioned","status-unversioned","serviceport-v1","serveraddressbyclientcidr-unversioned","securitycontext-v1","secretvolumesource-v1","secretkeyselector-v1","scale-v1","selinuxoptions-v1","rollbackconfig-v1beta1","roleref-v1alpha1","resourcerequirements-v1","resourcefieldselector-v1","resourceattributes-v1beta1","replicationcontrollercondition-v1","replicasetcondition-v1beta1","rawextension-runtime","rbdvolumesource-v1","quobytevolumesource-v1","quantity-resource","probe-v1","preconditions-v1","policyrule-v1alpha1","podsecuritycontext-v1","podcondition-v1","photonpersistentdiskvolumesource-v1","persistentvolumeclaimvolumesource-v1","patch-unversioned","ownerreference-v1","objectreference-v1","objectmeta-v1","objectfieldselector-v1","nonresourceattributes-v1beta1","nodesysteminfo-v1","nodedaemonendpoints-v1","nodecondition-v1","nodeaddress-v1","networkpolicyport-v1beta1","networkpolicypeer-v1beta1","networkpolicyingressrule-v1beta1","nfsvolumesource-v1","localobjectreference-v1","loadbalancerstatus-v1","loadbalanceringress-v1","listmeta-unversioned","limitrangeitem-v1","lifecycle-v1","labelselectorrequirement-unversioned","labelselector-unversioned","keytopath-v1","jobtemplatespec-v2alpha1","jobcondition-v1","intorstring-intstr","ingresstls-v1beta1","ingressrule-v1beta1","ingressbackend-v1beta1","info-version","iscsivolumesource-v1","hostpathvolumesource-v1","handler-v1","httpingressrulevalue-v1beta1","httpingresspath-v1beta1","httpheader-v1","httpgetaction-v1","groupversionfordiscovery-unversioned","glusterfsvolumesource-v1","gitrepovolumesource-v1","gcepersistentdiskvolumesource-v1","flockervolumesource-v1","flexvolumesource-v1","fcvolumesource-v1","execaction-v1","eviction-v1beta1","eventsource-v1","envvarsource-v1","envvar-v1","endpointsubset-v1","endpointport-v1","endpointaddress-v1","emptydirvolumesource-v1","downwardapivolumesource-v1","downwardapivolumefile-v1","deploymentcondition-v1beta1","deleteoptions-v1","daemonendpoint-v1","crossversionobjectreference-v1","containerstatewaiting-v1","containerstateterminated-v1","containerstaterunning-v1","containerstate-v1","containerport-v1","containerimage-v1","configmapvolumesource-v1","configmapkeyselector-v1","componentcondition-v1","cindervolumesource-v1","certificatesigningrequestcondition-v1alpha1","cephfsvolumesource-v1","capabilities-v1","cputargetutilization-v1beta1","azurefilevolumesource-v1","azurediskvolumesource-v1","attachedvolume-v1","awselasticblockstorevolumesource-v1","apiversions-unversioned","apiversion-v1beta1","apiresource-unversioned","apigroup-unversioned","-strong-definitions-strong-","watch-list-all-namespaces-453","watch-452","list-all-namespaces-451","list-450","read-449","-strong-read-operations-strong--448","delete-collection-447","delete-446","patch-445","replace-444","create-443","-strong-write-operations-strong--442","networkpolicy-v1beta1","create-441","-strong-write-operations-strong--440","tokenreview-v1beta1","create-439","-strong-write-operations-strong--438","subjectaccessreview-v1beta1","watch-list-all-namespaces-437","watch-list-436","watch-435","list-all-namespaces-434","list-433","read-432","-strong-read-operations-strong--431","delete-collection-430","delete-429","patch-428","replace-427","create-426","-strong-write-operations-strong--425","serviceaccount-v1","create-424","-strong-write-operations-strong--423","selfsubjectaccessreview-v1beta1","watch-list-all-namespaces-422","watch-list-421","watch-420","list-all-namespaces-419","list-418","read-417","-strong-read-operations-strong--416","delete-collection-415","delete-414","patch-413","replace-412","create-411","-strong-write-operations-strong--410","rolebinding-v1alpha1","watch-list-all-namespaces-409","watch-list-408","watch-407","list-all-namespaces-406","list-405","read-404","-strong-read-operations-strong--403","delete-collection-402","delete-401","patch-400","replace-399","create-398","-strong-write-operations-strong--397","role-v1alpha1","replace-status-396","read-status-395","patch-status-394","-strong-status-operations-strong--393","watch-list-all-namespaces-392","watch-391","list-all-namespaces-390","list-389","read-388","-strong-read-operations-strong--387","delete-collection-386","delete-385","patch-384","replace-383","create-382","-strong-write-operations-strong--381","resourcequota-v1","replace-status-380","read-status-379","patch-status-378","-strong-status-operations-strong--377","watch-list-376","watch-375","list-374","read-373","-strong-read-operations-strong--372","delete-collection-371","delete-370","patch-369","replace-368","create-367","-strong-write-operations-strong--366","persistentvolume-v1","replace-proxy-path-365","replace-proxy-364","replace-connect-proxy-path-363","replace-connect-proxy-362","head-connect-proxy-path-361","head-connect-proxy-360","get-proxy-path-359","get-proxy-358","get-connect-proxy-path-357","get-connect-proxy-356","delete-proxy-path-355","delete-proxy-354","delete-connect-proxy-path-353","delete-connect-proxy-352","create-proxy-path-351","create-proxy-350","create-connect-proxy-path-349","create-connect-proxy-348","-strong-proxy-operations-strong--347","watch-346","list-345","read-344","-strong-read-operations-strong--343","delete-collection-342","delete-341","patch-340","replace-339","create-338","-strong-write-operations-strong--337","node-v1","watch-336","list-335","read-334","-strong-read-operations-strong--333","delete-collection-332","delete-331","patch-330","replace-329","create-328","-strong-write-operations-strong--327","namespace-v1","create-326","-strong-write-operations-strong--325","localsubjectaccessreview-v1beta1","list-324","read-323","-strong-read-operations-strong--322","componentstatus-v1","watch-list-321","watch-320","list-319","read-318","-strong-read-operations-strong--317","delete-collection-316","delete-315","patch-314","replace-313","create-312","-strong-write-operations-strong--311","clusterrolebinding-v1alpha1","watch-310","list-309","read-308","-strong-read-operations-strong--307","delete-collection-306","delete-305","patch-304","replace-303","create-302","-strong-write-operations-strong--301","clusterrole-v1alpha1","watch-300","list-299","read-298","-strong-read-operations-strong--297","delete-collection-296","delete-295","patch-294","replace-293","create-292","-strong-write-operations-strong--291","certificatesigningrequest-v1alpha1","create-290","-strong-write-operations-strong--289","binding-v1","-strong-cluster-strong-","watch-288","list-287","read-286","-strong-read-operations-strong--285","delete-collection-284","delete-283","patch-282","replace-281","create-280","-strong-write-operations-strong--279","thirdpartyresource-v1beta1","watch-list-all-namespaces-278","watch-277","list-all-namespaces-276","list-275","read-274","-strong-read-operations-strong--273","delete-collection-272","delete-271","patch-270","replace-269","create-268","-strong-write-operations-strong--267","poddisruptionbudget-v1beta1","watch-list-all-namespaces-266","watch-265","list-all-namespaces-264","list-263","read-262","-strong-read-operations-strong--261","delete-collection-260","delete-259","patch-258","replace-257","create-256","-strong-write-operations-strong--255","podtemplate-v1","watch-list-all-namespaces-254","watch-253","list-all-namespaces-252","list-251","read-250","-strong-read-operations-strong--249","delete-collection-248","delete-247","patch-246","replace-245","create-244","-strong-write-operations-strong--243","horizontalpodautoscaler-v1","watch-list-all-namespaces-242","watch-241","list-all-namespaces-240","list-239","read-238","-strong-read-operations-strong--237","delete-collection-236","delete-235","patch-234","replace-233","create-232","-strong-write-operations-strong--231","limitrange-v1","watch-list-all-namespaces-230","watch-229","list-all-namespaces-228","list-227","read-226","-strong-read-operations-strong--225","delete-collection-224","delete-223","patch-222","replace-221","create-220","-strong-write-operations-strong--219","event-v1","-strong-metadata-strong-","volume-v1","watch-218","list-217","read-216","-strong-read-operations-strong--215","delete-collection-214","delete-213","patch-212","replace-211","create-210","-strong-write-operations-strong--209","storageclass-v1beta1","replace-status-208","read-status-207","patch-status-206","-strong-status-operations-strong--205","watch-list-all-namespaces-204","watch-203","list-all-namespaces-202","list-201","read-200","-strong-read-operations-strong--199","delete-collection-198","delete-197","patch-196","replace-195","create-194","-strong-write-operations-strong--193","persistentvolumeclaim-v1","watch-list-all-namespaces-192","watch-list-191","watch-190","list-all-namespaces-189","list-188","read-187","-strong-read-operations-strong--186","delete-collection-185","delete-184","patch-183","replace-182","create-181","-strong-write-operations-strong--180","secret-v1","watch-list-all-namespaces-179","watch-178","list-all-namespaces-177","list-176","read-175","-strong-read-operations-strong--174","delete-collection-173","delete-172","patch-171","replace-170","create-169","-strong-write-operations-strong--168","configmap-v1","-strong-config-storage-strong-","replace-proxy-path-167","replace-proxy-166","replace-connect-proxy-path-165","replace-connect-proxy-164","head-connect-proxy-path-163","head-connect-proxy-162","get-proxy-path-161","get-proxy-160","get-connect-proxy-path-159","get-connect-proxy-158","delete-proxy-path-157","delete-proxy-156","delete-connect-proxy-path-155","delete-connect-proxy-154","create-proxy-path-153","create-proxy-152","create-connect-proxy-path-151","create-connect-proxy-150","-strong-proxy-operations-strong--149","replace-status-148","read-status-147","patch-status-146","-strong-status-operations-strong--145","watch-list-all-namespaces-144","watch-143","list-all-namespaces-142","list-141","read-140","-strong-read-operations-strong--139","delete-138","patch-137","replace-136","create-135","-strong-write-operations-strong--134","service-v1","watch-list-all-namespaces-133","watch-132","list-all-namespaces-131","list-130","read-129","-strong-read-operations-strong--128","delete-collection-127","delete-126","patch-125","replace-124","create-123","-strong-write-operations-strong--122","ingress-v1beta1","watch-list-all-namespaces-121","watch-list-120","watch-119","list-all-namespaces-118","list-117","read-116","-strong-read-operations-strong--115","delete-collection-114","delete-113","patch-112","replace-111","create-110","-strong-write-operations-strong--109","endpoints-v1","-strong-discovery-load-balancing-strong-","replace-status-108","read-status-107","patch-status-106","-strong-status-operations-strong--105","watch-list-all-namespaces-104","watch-list-103","watch-102","list-all-namespaces-101","list-100","read-99","-strong-read-operations-strong--98","delete-collection-97","delete-96","patch-95","replace-94","create-93","-strong-write-operations-strong--92","statefulset-v1beta1","watch-list-all-namespaces-91","watch-90","list-all-namespaces-89","list-88","read-87","-strong-read-operations-strong--86","delete-collection-85","delete-84","patch-83","replace-82","create-81","-strong-write-operations-strong--80","replicationcontroller-v1","patch-scale-79","replace-scale-78","read-scale-77","-strong-misc-operations-strong--76","watch-list-all-namespaces-75","watch-list-74","watch-73","list-all-namespaces-72","list-71","read-70","-strong-read-operations-strong--69","delete-collection-68","delete-67","patch-66","replace-65","create-64","-strong-write-operations-strong--63","replicaset-v1beta1","read-log","-strong-misc-operations-strong--62","replace-proxy-path","replace-proxy","replace-connect-proxy-path","replace-connect-proxy","head-connect-proxy-path","head-connect-proxy","get-proxy-path","get-proxy","get-connect-proxy-path","get-connect-proxy","get-connect-portforward","delete-proxy-path","delete-proxy","delete-connect-proxy-path","delete-connect-proxy","create-proxy-path","create-proxy","create-connect-proxy-path","create-connect-proxy","create-connect-portforward","-strong-proxy-operations-strong-","watch-list-all-namespaces-61","watch-list-60","watch-59","list-all-namespaces-58","list-57","read-56","-strong-read-operations-strong--55","delete-collection-54","delete-53","patch-52","replace-51","create-50","-strong-write-operations-strong--49","pod-v1","watch-list-all-namespaces-48","watch-list-47","watch-46","list-all-namespaces-45","list-44","read-43","-strong-read-operations-strong--42","delete-collection-41","delete-40","patch-39","replace-38","create-37","-strong-write-operations-strong--36","job-v1","rollback","patch-scale","replace-scale","read-scale","-strong-misc-operations-strong-","replace-status-35","read-status-34","patch-status-33","-strong-status-operations-strong--32","watch-list-all-namespaces-31","watch-list-30","watch-29","list-all-namespaces-28","list-27","read-26","-strong-read-operations-strong--25","delete-collection-24","delete-23","patch-22","replace-21","create-20","-strong-write-operations-strong--19","deployment-v1beta1","replace-status-18","read-status-17","patch-status-16","-strong-status-operations-strong--15","watch-list-all-namespaces-14","watch-13","list-all-namespaces-12","list-11","read-10","-strong-read-operations-strong--9","delete-collection-8","delete-7","patch-6","replace-5","create-4","-strong-write-operations-strong--3","daemonset-v1beta1","replace-status","read-status","patch-status","-strong-status-operations-strong-","watch-list-all-namespaces","watch-list","watch","list-all-namespaces","list","read-2","-strong-read-operations-strong-","delete-collection","delete-1","patch","replace","create","-strong-write-operations-strong-","cronjob-v2alpha1","container-v1","-strong-workloads-strong-","resource-operations","resource-objects","resource-categories","-strong-api-overview-strong-"]}})(); \ No newline at end of file +(function(){navData = {"toc":[{"section":"scale-v1beta1","subsections":[]},{"section":"jobcondition-v2alpha1","subsections":[]},{"section":"jobcondition-v1beta1","subsections":[]},{"section":"job-v2alpha1","subsections":[{"section":"-strong-status-operations-strong--558","subsections":[{"section":"replace-status-561"},{"section":"read-status-560"},{"section":"patch-status-559"}]},{"section":"-strong-read-operations-strong--551","subsections":[{"section":"watch-list-all-namespaces-557"},{"section":"watch-list-556"},{"section":"watch-555"},{"section":"list-all-namespaces-554"},{"section":"list-553"},{"section":"read-552"}]},{"section":"-strong-write-operations-strong--545","subsections":[{"section":"delete-collection-550"},{"section":"delete-549"},{"section":"patch-548"},{"section":"replace-547"},{"section":"create-546"}]}]},{"section":"job-v1beta1","subsections":[{"section":"-strong-status-operations-strong--541","subsections":[{"section":"replace-status-544"},{"section":"read-status-543"},{"section":"patch-status-542"}]},{"section":"-strong-read-operations-strong--534","subsections":[{"section":"watch-list-all-namespaces-540"},{"section":"watch-list-539"},{"section":"watch-538"},{"section":"list-all-namespaces-537"},{"section":"list-536"},{"section":"read-535"}]},{"section":"-strong-write-operations-strong--528","subsections":[{"section":"delete-collection-533"},{"section":"delete-532"},{"section":"patch-531"},{"section":"replace-530"},{"section":"create-529"}]}]},{"section":"horizontalpodautoscaler-v1beta1","subsections":[{"section":"-strong-status-operations-strong--524","subsections":[{"section":"replace-status-527"},{"section":"read-status-526"},{"section":"patch-status-525"}]},{"section":"-strong-read-operations-strong--517","subsections":[{"section":"watch-list-all-namespaces-523"},{"section":"watch-list-522"},{"section":"watch-521"},{"section":"list-all-namespaces-520"},{"section":"list-519"},{"section":"read-518"}]},{"section":"-strong-write-operations-strong--511","subsections":[{"section":"delete-collection-516"},{"section":"delete-515"},{"section":"patch-514"},{"section":"replace-513"},{"section":"create-512"}]}]},{"section":"event-versioned","subsections":[]},{"section":"-strong-old-api-versions-strong-","subsections":[]},{"section":"-strong-definitions-strong-","subsections":[{"section":"vspherevirtualdiskvolumesource-v1"},{"section":"volumemount-v1"},{"section":"userinfo-v1beta1"},{"section":"time-unversioned"},{"section":"tcpsocketaction-v1"},{"section":"subresourcereference-v1beta1"},{"section":"subject-v1alpha1"},{"section":"statusdetails-unversioned"},{"section":"statuscause-unversioned"},{"section":"status-unversioned"},{"section":"serviceport-v1"},{"section":"serveraddressbyclientcidr-unversioned"},{"section":"securitycontext-v1"},{"section":"secretvolumesource-v1"},{"section":"secretkeyselector-v1"},{"section":"scale-v1"},{"section":"selinuxoptions-v1"},{"section":"rollbackconfig-v1beta1"},{"section":"roleref-v1alpha1"},{"section":"resourcerequirements-v1"},{"section":"resourcefieldselector-v1"},{"section":"resourceattributes-v1beta1"},{"section":"replicationcontrollercondition-v1"},{"section":"replicasetcondition-v1beta1"},{"section":"rawextension-runtime"},{"section":"rbdvolumesource-v1"},{"section":"quobytevolumesource-v1"},{"section":"quantity-resource"},{"section":"probe-v1"},{"section":"preconditions-v1"},{"section":"policyrule-v1alpha1"},{"section":"podsecuritycontext-v1"},{"section":"podcondition-v1"},{"section":"photonpersistentdiskvolumesource-v1"},{"section":"persistentvolumeclaimvolumesource-v1"},{"section":"patch-unversioned"},{"section":"ownerreference-v1"},{"section":"objectreference-v1"},{"section":"objectmeta-v1"},{"section":"objectfieldselector-v1"},{"section":"nonresourceattributes-v1beta1"},{"section":"nodesysteminfo-v1"},{"section":"nodedaemonendpoints-v1"},{"section":"nodecondition-v1"},{"section":"nodeaddress-v1"},{"section":"networkpolicyport-v1beta1"},{"section":"networkpolicypeer-v1beta1"},{"section":"networkpolicyingressrule-v1beta1"},{"section":"nfsvolumesource-v1"},{"section":"localobjectreference-v1"},{"section":"loadbalancerstatus-v1"},{"section":"loadbalanceringress-v1"},{"section":"listmeta-unversioned"},{"section":"limitrangeitem-v1"},{"section":"lifecycle-v1"},{"section":"labelselectorrequirement-unversioned"},{"section":"labelselector-unversioned"},{"section":"keytopath-v1"},{"section":"jobtemplatespec-v2alpha1"},{"section":"jobcondition-v1"},{"section":"intorstring-intstr"},{"section":"ingresstls-v1beta1"},{"section":"ingressrule-v1beta1"},{"section":"ingressbackend-v1beta1"},{"section":"info-version"},{"section":"iscsivolumesource-v1"},{"section":"hostpathvolumesource-v1"},{"section":"handler-v1"},{"section":"httpingressrulevalue-v1beta1"},{"section":"httpingresspath-v1beta1"},{"section":"httpheader-v1"},{"section":"httpgetaction-v1"},{"section":"groupversionfordiscovery-unversioned"},{"section":"glusterfsvolumesource-v1"},{"section":"gitrepovolumesource-v1"},{"section":"gcepersistentdiskvolumesource-v1"},{"section":"flockervolumesource-v1"},{"section":"flexvolumesource-v1"},{"section":"fcvolumesource-v1"},{"section":"execaction-v1"},{"section":"eviction-v1beta1"},{"section":"eventsource-v1"},{"section":"envvarsource-v1"},{"section":"envvar-v1"},{"section":"endpointsubset-v1"},{"section":"endpointport-v1"},{"section":"endpointaddress-v1"},{"section":"emptydirvolumesource-v1"},{"section":"downwardapivolumesource-v1"},{"section":"downwardapivolumefile-v1"},{"section":"deploymentcondition-v1beta1"},{"section":"deleteoptions-v1"},{"section":"daemonendpoint-v1"},{"section":"crossversionobjectreference-v1"},{"section":"containerstatewaiting-v1"},{"section":"containerstateterminated-v1"},{"section":"containerstaterunning-v1"},{"section":"containerstate-v1"},{"section":"containerport-v1"},{"section":"containerimage-v1"},{"section":"configmapvolumesource-v1"},{"section":"configmapkeyselector-v1"},{"section":"componentcondition-v1"},{"section":"cindervolumesource-v1"},{"section":"certificatesigningrequestcondition-v1alpha1"},{"section":"cephfsvolumesource-v1"},{"section":"capabilities-v1"},{"section":"cputargetutilization-v1beta1"},{"section":"azurefilevolumesource-v1"},{"section":"azurediskvolumesource-v1"},{"section":"attachedvolume-v1"},{"section":"awselasticblockstorevolumesource-v1"},{"section":"apiversions-unversioned"},{"section":"apiversion-v1beta1"},{"section":"apiresource-unversioned"},{"section":"apigroup-unversioned"}]},{"section":"networkpolicy-v1beta1","subsections":[{"section":"-strong-read-operations-strong--504","subsections":[{"section":"watch-list-all-namespaces-510"},{"section":"watch-list-509"},{"section":"watch-508"},{"section":"list-all-namespaces-507"},{"section":"list-506"},{"section":"read-505"}]},{"section":"-strong-write-operations-strong--498","subsections":[{"section":"delete-collection-503"},{"section":"delete-502"},{"section":"patch-501"},{"section":"replace-500"},{"section":"create-499"}]}]},{"section":"tokenreview-v1beta1","subsections":[{"section":"-strong-write-operations-strong--496","subsections":[{"section":"create-497"}]}]},{"section":"subjectaccessreview-v1beta1","subsections":[{"section":"-strong-write-operations-strong--494","subsections":[{"section":"create-495"}]}]},{"section":"serviceaccount-v1","subsections":[{"section":"-strong-read-operations-strong--487","subsections":[{"section":"watch-list-all-namespaces-493"},{"section":"watch-list-492"},{"section":"watch-491"},{"section":"list-all-namespaces-490"},{"section":"list-489"},{"section":"read-488"}]},{"section":"-strong-write-operations-strong--481","subsections":[{"section":"delete-collection-486"},{"section":"delete-485"},{"section":"patch-484"},{"section":"replace-483"},{"section":"create-482"}]}]},{"section":"selfsubjectaccessreview-v1beta1","subsections":[{"section":"-strong-write-operations-strong--479","subsections":[{"section":"create-480"}]}]},{"section":"rolebinding-v1alpha1","subsections":[{"section":"-strong-read-operations-strong--472","subsections":[{"section":"watch-list-all-namespaces-478"},{"section":"watch-list-477"},{"section":"watch-476"},{"section":"list-all-namespaces-475"},{"section":"list-474"},{"section":"read-473"}]},{"section":"-strong-write-operations-strong--466","subsections":[{"section":"delete-collection-471"},{"section":"delete-470"},{"section":"patch-469"},{"section":"replace-468"},{"section":"create-467"}]}]},{"section":"role-v1alpha1","subsections":[{"section":"-strong-read-operations-strong--459","subsections":[{"section":"watch-list-all-namespaces-465"},{"section":"watch-list-464"},{"section":"watch-463"},{"section":"list-all-namespaces-462"},{"section":"list-461"},{"section":"read-460"}]},{"section":"-strong-write-operations-strong--453","subsections":[{"section":"delete-collection-458"},{"section":"delete-457"},{"section":"patch-456"},{"section":"replace-455"},{"section":"create-454"}]}]},{"section":"resourcequota-v1","subsections":[{"section":"-strong-status-operations-strong--449","subsections":[{"section":"replace-status-452"},{"section":"read-status-451"},{"section":"patch-status-450"}]},{"section":"-strong-read-operations-strong--442","subsections":[{"section":"watch-list-all-namespaces-448"},{"section":"watch-list-447"},{"section":"watch-446"},{"section":"list-all-namespaces-445"},{"section":"list-444"},{"section":"read-443"}]},{"section":"-strong-write-operations-strong--436","subsections":[{"section":"delete-collection-441"},{"section":"delete-440"},{"section":"patch-439"},{"section":"replace-438"},{"section":"create-437"}]}]},{"section":"persistentvolume-v1","subsections":[{"section":"-strong-status-operations-strong--432","subsections":[{"section":"replace-status-435"},{"section":"read-status-434"},{"section":"patch-status-433"}]},{"section":"-strong-read-operations-strong--427","subsections":[{"section":"watch-list-431"},{"section":"watch-430"},{"section":"list-429"},{"section":"read-428"}]},{"section":"-strong-write-operations-strong--421","subsections":[{"section":"delete-collection-426"},{"section":"delete-425"},{"section":"patch-424"},{"section":"replace-423"},{"section":"create-422"}]}]},{"section":"node-v1","subsections":[{"section":"-strong-proxy-operations-strong--402","subsections":[{"section":"replace-proxy-path-420"},{"section":"replace-proxy-419"},{"section":"replace-connect-proxy-path-418"},{"section":"replace-connect-proxy-417"},{"section":"head-connect-proxy-path-416"},{"section":"head-connect-proxy-415"},{"section":"get-proxy-path-414"},{"section":"get-proxy-413"},{"section":"get-connect-proxy-path-412"},{"section":"get-connect-proxy-411"},{"section":"delete-proxy-path-410"},{"section":"delete-proxy-409"},{"section":"delete-connect-proxy-path-408"},{"section":"delete-connect-proxy-407"},{"section":"create-proxy-path-406"},{"section":"create-proxy-405"},{"section":"create-connect-proxy-path-404"},{"section":"create-connect-proxy-403"}]},{"section":"-strong-status-operations-strong--398","subsections":[{"section":"replace-status-401"},{"section":"read-status-400"},{"section":"patch-status-399"}]},{"section":"-strong-read-operations-strong--393","subsections":[{"section":"watch-list-397"},{"section":"watch-396"},{"section":"list-395"},{"section":"read-394"}]},{"section":"-strong-write-operations-strong--387","subsections":[{"section":"delete-collection-392"},{"section":"delete-391"},{"section":"patch-390"},{"section":"replace-389"},{"section":"create-388"}]}]},{"section":"namespace-v1","subsections":[{"section":"-strong-status-operations-strong--383","subsections":[{"section":"replace-status-386"},{"section":"read-status-385"},{"section":"patch-status-384"}]},{"section":"-strong-read-operations-strong--378","subsections":[{"section":"watch-list-382"},{"section":"watch-381"},{"section":"list-380"},{"section":"read-379"}]},{"section":"-strong-write-operations-strong--372","subsections":[{"section":"delete-collection-377"},{"section":"delete-376"},{"section":"patch-375"},{"section":"replace-374"},{"section":"create-373"}]}]},{"section":"localsubjectaccessreview-v1beta1","subsections":[{"section":"-strong-write-operations-strong--370","subsections":[{"section":"create-371"}]}]},{"section":"componentstatus-v1","subsections":[{"section":"-strong-read-operations-strong--367","subsections":[{"section":"list-369"},{"section":"read-368"}]}]},{"section":"clusterrolebinding-v1alpha1","subsections":[{"section":"-strong-read-operations-strong--362","subsections":[{"section":"watch-list-366"},{"section":"watch-365"},{"section":"list-364"},{"section":"read-363"}]},{"section":"-strong-write-operations-strong--356","subsections":[{"section":"delete-collection-361"},{"section":"delete-360"},{"section":"patch-359"},{"section":"replace-358"},{"section":"create-357"}]}]},{"section":"clusterrole-v1alpha1","subsections":[{"section":"-strong-read-operations-strong--351","subsections":[{"section":"watch-list-355"},{"section":"watch-354"},{"section":"list-353"},{"section":"read-352"}]},{"section":"-strong-write-operations-strong--345","subsections":[{"section":"delete-collection-350"},{"section":"delete-349"},{"section":"patch-348"},{"section":"replace-347"},{"section":"create-346"}]}]},{"section":"certificatesigningrequest-v1alpha1","subsections":[{"section":"-strong-status-operations-strong--343","subsections":[{"section":"replace-status-344"}]},{"section":"-strong-read-operations-strong--338","subsections":[{"section":"watch-list-342"},{"section":"watch-341"},{"section":"list-340"},{"section":"read-339"}]},{"section":"-strong-write-operations-strong--332","subsections":[{"section":"delete-collection-337"},{"section":"delete-336"},{"section":"patch-335"},{"section":"replace-334"},{"section":"create-333"}]}]},{"section":"binding-v1","subsections":[{"section":"-strong-write-operations-strong--330","subsections":[{"section":"create-331"}]}]},{"section":"-strong-cluster-strong-","subsections":[]},{"section":"thirdpartyresource-v1beta1","subsections":[{"section":"-strong-read-operations-strong--325","subsections":[{"section":"watch-list-329"},{"section":"watch-328"},{"section":"list-327"},{"section":"read-326"}]},{"section":"-strong-write-operations-strong--319","subsections":[{"section":"delete-collection-324"},{"section":"delete-323"},{"section":"patch-322"},{"section":"replace-321"},{"section":"create-320"}]}]},{"section":"poddisruptionbudget-v1beta1","subsections":[{"section":"-strong-status-operations-strong--315","subsections":[{"section":"replace-status-318"},{"section":"read-status-317"},{"section":"patch-status-316"}]},{"section":"-strong-read-operations-strong--308","subsections":[{"section":"watch-list-all-namespaces-314"},{"section":"watch-list-313"},{"section":"watch-312"},{"section":"list-all-namespaces-311"},{"section":"list-310"},{"section":"read-309"}]},{"section":"-strong-write-operations-strong--302","subsections":[{"section":"delete-collection-307"},{"section":"delete-306"},{"section":"patch-305"},{"section":"replace-304"},{"section":"create-303"}]}]},{"section":"podtemplate-v1","subsections":[{"section":"-strong-read-operations-strong--295","subsections":[{"section":"watch-list-all-namespaces-301"},{"section":"watch-list-300"},{"section":"watch-299"},{"section":"list-all-namespaces-298"},{"section":"list-297"},{"section":"read-296"}]},{"section":"-strong-write-operations-strong--289","subsections":[{"section":"delete-collection-294"},{"section":"delete-293"},{"section":"patch-292"},{"section":"replace-291"},{"section":"create-290"}]}]},{"section":"horizontalpodautoscaler-v1","subsections":[{"section":"-strong-status-operations-strong--285","subsections":[{"section":"replace-status-288"},{"section":"read-status-287"},{"section":"patch-status-286"}]},{"section":"-strong-read-operations-strong--278","subsections":[{"section":"watch-list-all-namespaces-284"},{"section":"watch-list-283"},{"section":"watch-282"},{"section":"list-all-namespaces-281"},{"section":"list-280"},{"section":"read-279"}]},{"section":"-strong-write-operations-strong--272","subsections":[{"section":"delete-collection-277"},{"section":"delete-276"},{"section":"patch-275"},{"section":"replace-274"},{"section":"create-273"}]}]},{"section":"limitrange-v1","subsections":[{"section":"-strong-read-operations-strong--265","subsections":[{"section":"watch-list-all-namespaces-271"},{"section":"watch-list-270"},{"section":"watch-269"},{"section":"list-all-namespaces-268"},{"section":"list-267"},{"section":"read-266"}]},{"section":"-strong-write-operations-strong--259","subsections":[{"section":"delete-collection-264"},{"section":"delete-263"},{"section":"patch-262"},{"section":"replace-261"},{"section":"create-260"}]}]},{"section":"event-v1","subsections":[{"section":"-strong-read-operations-strong--252","subsections":[{"section":"watch-list-all-namespaces-258"},{"section":"watch-list-257"},{"section":"watch-256"},{"section":"list-all-namespaces-255"},{"section":"list-254"},{"section":"read-253"}]},{"section":"-strong-write-operations-strong--246","subsections":[{"section":"delete-collection-251"},{"section":"delete-250"},{"section":"patch-249"},{"section":"replace-248"},{"section":"create-247"}]}]},{"section":"-strong-metadata-strong-","subsections":[]},{"section":"volume-v1","subsections":[]},{"section":"storageclass-v1beta1","subsections":[{"section":"-strong-read-operations-strong--241","subsections":[{"section":"watch-list-245"},{"section":"watch-244"},{"section":"list-243"},{"section":"read-242"}]},{"section":"-strong-write-operations-strong--235","subsections":[{"section":"delete-collection-240"},{"section":"delete-239"},{"section":"patch-238"},{"section":"replace-237"},{"section":"create-236"}]}]},{"section":"persistentvolumeclaim-v1","subsections":[{"section":"-strong-status-operations-strong--231","subsections":[{"section":"replace-status-234"},{"section":"read-status-233"},{"section":"patch-status-232"}]},{"section":"-strong-read-operations-strong--224","subsections":[{"section":"watch-list-all-namespaces-230"},{"section":"watch-list-229"},{"section":"watch-228"},{"section":"list-all-namespaces-227"},{"section":"list-226"},{"section":"read-225"}]},{"section":"-strong-write-operations-strong--218","subsections":[{"section":"delete-collection-223"},{"section":"delete-222"},{"section":"patch-221"},{"section":"replace-220"},{"section":"create-219"}]}]},{"section":"secret-v1","subsections":[{"section":"-strong-read-operations-strong--211","subsections":[{"section":"watch-list-all-namespaces-217"},{"section":"watch-list-216"},{"section":"watch-215"},{"section":"list-all-namespaces-214"},{"section":"list-213"},{"section":"read-212"}]},{"section":"-strong-write-operations-strong--205","subsections":[{"section":"delete-collection-210"},{"section":"delete-209"},{"section":"patch-208"},{"section":"replace-207"},{"section":"create-206"}]}]},{"section":"configmap-v1","subsections":[{"section":"-strong-read-operations-strong--198","subsections":[{"section":"watch-list-all-namespaces-204"},{"section":"watch-list-203"},{"section":"watch-202"},{"section":"list-all-namespaces-201"},{"section":"list-200"},{"section":"read-199"}]},{"section":"-strong-write-operations-strong--192","subsections":[{"section":"delete-collection-197"},{"section":"delete-196"},{"section":"patch-195"},{"section":"replace-194"},{"section":"create-193"}]}]},{"section":"-strong-config-storage-strong-","subsections":[]},{"section":"service-v1","subsections":[{"section":"-strong-proxy-operations-strong--173","subsections":[{"section":"replace-proxy-path-191"},{"section":"replace-proxy-190"},{"section":"replace-connect-proxy-path-189"},{"section":"replace-connect-proxy-188"},{"section":"head-connect-proxy-path-187"},{"section":"head-connect-proxy-186"},{"section":"get-proxy-path-185"},{"section":"get-proxy-184"},{"section":"get-connect-proxy-path-183"},{"section":"get-connect-proxy-182"},{"section":"delete-proxy-path-181"},{"section":"delete-proxy-180"},{"section":"delete-connect-proxy-path-179"},{"section":"delete-connect-proxy-178"},{"section":"create-proxy-path-177"},{"section":"create-proxy-176"},{"section":"create-connect-proxy-path-175"},{"section":"create-connect-proxy-174"}]},{"section":"-strong-status-operations-strong--169","subsections":[{"section":"replace-status-172"},{"section":"read-status-171"},{"section":"patch-status-170"}]},{"section":"-strong-read-operations-strong--162","subsections":[{"section":"watch-list-all-namespaces-168"},{"section":"watch-list-167"},{"section":"watch-166"},{"section":"list-all-namespaces-165"},{"section":"list-164"},{"section":"read-163"}]},{"section":"-strong-write-operations-strong--157","subsections":[{"section":"delete-161"},{"section":"patch-160"},{"section":"replace-159"},{"section":"create-158"}]}]},{"section":"ingress-v1beta1","subsections":[{"section":"-strong-status-operations-strong--153","subsections":[{"section":"replace-status-156"},{"section":"read-status-155"},{"section":"patch-status-154"}]},{"section":"-strong-read-operations-strong--146","subsections":[{"section":"watch-list-all-namespaces-152"},{"section":"watch-list-151"},{"section":"watch-150"},{"section":"list-all-namespaces-149"},{"section":"list-148"},{"section":"read-147"}]},{"section":"-strong-write-operations-strong--140","subsections":[{"section":"delete-collection-145"},{"section":"delete-144"},{"section":"patch-143"},{"section":"replace-142"},{"section":"create-141"}]}]},{"section":"endpoints-v1","subsections":[{"section":"-strong-read-operations-strong--133","subsections":[{"section":"watch-list-all-namespaces-139"},{"section":"watch-list-138"},{"section":"watch-137"},{"section":"list-all-namespaces-136"},{"section":"list-135"},{"section":"read-134"}]},{"section":"-strong-write-operations-strong--127","subsections":[{"section":"delete-collection-132"},{"section":"delete-131"},{"section":"patch-130"},{"section":"replace-129"},{"section":"create-128"}]}]},{"section":"-strong-discovery-load-balancing-strong-","subsections":[]},{"section":"statefulset-v1beta1","subsections":[{"section":"-strong-status-operations-strong--123","subsections":[{"section":"replace-status-126"},{"section":"read-status-125"},{"section":"patch-status-124"}]},{"section":"-strong-read-operations-strong--116","subsections":[{"section":"watch-list-all-namespaces-122"},{"section":"watch-list-121"},{"section":"watch-120"},{"section":"list-all-namespaces-119"},{"section":"list-118"},{"section":"read-117"}]},{"section":"-strong-write-operations-strong--110","subsections":[{"section":"delete-collection-115"},{"section":"delete-114"},{"section":"patch-113"},{"section":"replace-112"},{"section":"create-111"}]}]},{"section":"replicationcontroller-v1","subsections":[{"section":"-strong-status-operations-strong--106","subsections":[{"section":"replace-status-109"},{"section":"read-status-108"},{"section":"patch-status-107"}]},{"section":"-strong-read-operations-strong--99","subsections":[{"section":"watch-list-all-namespaces-105"},{"section":"watch-list-104"},{"section":"watch-103"},{"section":"list-all-namespaces-102"},{"section":"list-101"},{"section":"read-100"}]},{"section":"-strong-write-operations-strong--93","subsections":[{"section":"delete-collection-98"},{"section":"delete-97"},{"section":"patch-96"},{"section":"replace-95"},{"section":"create-94"}]}]},{"section":"replicaset-v1beta1","subsections":[{"section":"-strong-misc-operations-strong--89","subsections":[{"section":"patch-scale-92"},{"section":"replace-scale-91"},{"section":"read-scale-90"}]},{"section":"-strong-status-operations-strong--85","subsections":[{"section":"replace-status-88"},{"section":"read-status-87"},{"section":"patch-status-86"}]},{"section":"-strong-read-operations-strong--78","subsections":[{"section":"watch-list-all-namespaces-84"},{"section":"watch-list-83"},{"section":"watch-82"},{"section":"list-all-namespaces-81"},{"section":"list-80"},{"section":"read-79"}]},{"section":"-strong-write-operations-strong--72","subsections":[{"section":"delete-collection-77"},{"section":"delete-76"},{"section":"patch-75"},{"section":"replace-74"},{"section":"create-73"}]}]},{"section":"pod-v1","subsections":[{"section":"-strong-misc-operations-strong--71","subsections":[{"section":"read-log"}]},{"section":"-strong-proxy-operations-strong-","subsections":[{"section":"replace-proxy-path"},{"section":"replace-proxy"},{"section":"replace-connect-proxy-path"},{"section":"replace-connect-proxy"},{"section":"head-connect-proxy-path"},{"section":"head-connect-proxy"},{"section":"get-proxy-path"},{"section":"get-proxy"},{"section":"get-connect-proxy-path"},{"section":"get-connect-proxy"},{"section":"get-connect-portforward"},{"section":"delete-proxy-path"},{"section":"delete-proxy"},{"section":"delete-connect-proxy-path"},{"section":"delete-connect-proxy"},{"section":"create-proxy-path"},{"section":"create-proxy"},{"section":"create-connect-proxy-path"},{"section":"create-connect-proxy"},{"section":"create-connect-portforward"}]},{"section":"-strong-status-operations-strong--67","subsections":[{"section":"replace-status-70"},{"section":"read-status-69"},{"section":"patch-status-68"}]},{"section":"-strong-read-operations-strong--60","subsections":[{"section":"watch-list-all-namespaces-66"},{"section":"watch-list-65"},{"section":"watch-64"},{"section":"list-all-namespaces-63"},{"section":"list-62"},{"section":"read-61"}]},{"section":"-strong-write-operations-strong--54","subsections":[{"section":"delete-collection-59"},{"section":"delete-58"},{"section":"patch-57"},{"section":"replace-56"},{"section":"create-55"}]}]},{"section":"job-v1","subsections":[{"section":"-strong-status-operations-strong--50","subsections":[{"section":"replace-status-53"},{"section":"read-status-52"},{"section":"patch-status-51"}]},{"section":"-strong-read-operations-strong--43","subsections":[{"section":"watch-list-all-namespaces-49"},{"section":"watch-list-48"},{"section":"watch-47"},{"section":"list-all-namespaces-46"},{"section":"list-45"},{"section":"read-44"}]},{"section":"-strong-write-operations-strong--37","subsections":[{"section":"delete-collection-42"},{"section":"delete-41"},{"section":"patch-40"},{"section":"replace-39"},{"section":"create-38"}]}]},{"section":"deployment-v1beta1","subsections":[{"section":"-strong-misc-operations-strong-","subsections":[{"section":"rollback"},{"section":"patch-scale"},{"section":"replace-scale"},{"section":"read-scale"}]},{"section":"-strong-status-operations-strong--33","subsections":[{"section":"replace-status-36"},{"section":"read-status-35"},{"section":"patch-status-34"}]},{"section":"-strong-read-operations-strong--26","subsections":[{"section":"watch-list-all-namespaces-32"},{"section":"watch-list-31"},{"section":"watch-30"},{"section":"list-all-namespaces-29"},{"section":"list-28"},{"section":"read-27"}]},{"section":"-strong-write-operations-strong--20","subsections":[{"section":"delete-collection-25"},{"section":"delete-24"},{"section":"patch-23"},{"section":"replace-22"},{"section":"create-21"}]}]},{"section":"daemonset-v1beta1","subsections":[{"section":"-strong-status-operations-strong--16","subsections":[{"section":"replace-status-19"},{"section":"read-status-18"},{"section":"patch-status-17"}]},{"section":"-strong-read-operations-strong--9","subsections":[{"section":"watch-list-all-namespaces-15"},{"section":"watch-list-14"},{"section":"watch-13"},{"section":"list-all-namespaces-12"},{"section":"list-11"},{"section":"read-10"}]},{"section":"-strong-write-operations-strong--3","subsections":[{"section":"delete-collection-8"},{"section":"delete-7"},{"section":"patch-6"},{"section":"replace-5"},{"section":"create-4"}]}]},{"section":"cronjob-v2alpha1","subsections":[{"section":"-strong-status-operations-strong-","subsections":[{"section":"replace-status"},{"section":"read-status"},{"section":"patch-status"}]},{"section":"-strong-read-operations-strong-","subsections":[{"section":"watch-list-all-namespaces"},{"section":"watch-list"},{"section":"watch"},{"section":"list-all-namespaces"},{"section":"list"},{"section":"read-2"}]},{"section":"-strong-write-operations-strong-","subsections":[{"section":"delete-collection"},{"section":"delete-1"},{"section":"patch"},{"section":"replace"},{"section":"create"}]}]},{"section":"container-v1","subsections":[]},{"section":"-strong-workloads-strong-","subsections":[]},{"section":"-strong-api-overview-strong-","subsections":[{"section":"resource-operations"},{"section":"resource-objects"},{"section":"resource-categories"}]}],"flatToc":["scale-v1beta1","jobcondition-v2alpha1","jobcondition-v1beta1","replace-status-561","read-status-560","patch-status-559","-strong-status-operations-strong--558","watch-list-all-namespaces-557","watch-list-556","watch-555","list-all-namespaces-554","list-553","read-552","-strong-read-operations-strong--551","delete-collection-550","delete-549","patch-548","replace-547","create-546","-strong-write-operations-strong--545","job-v2alpha1","replace-status-544","read-status-543","patch-status-542","-strong-status-operations-strong--541","watch-list-all-namespaces-540","watch-list-539","watch-538","list-all-namespaces-537","list-536","read-535","-strong-read-operations-strong--534","delete-collection-533","delete-532","patch-531","replace-530","create-529","-strong-write-operations-strong--528","job-v1beta1","replace-status-527","read-status-526","patch-status-525","-strong-status-operations-strong--524","watch-list-all-namespaces-523","watch-list-522","watch-521","list-all-namespaces-520","list-519","read-518","-strong-read-operations-strong--517","delete-collection-516","delete-515","patch-514","replace-513","create-512","-strong-write-operations-strong--511","horizontalpodautoscaler-v1beta1","event-versioned","-strong-old-api-versions-strong-","vspherevirtualdiskvolumesource-v1","volumemount-v1","userinfo-v1beta1","time-unversioned","tcpsocketaction-v1","subresourcereference-v1beta1","subject-v1alpha1","statusdetails-unversioned","statuscause-unversioned","status-unversioned","serviceport-v1","serveraddressbyclientcidr-unversioned","securitycontext-v1","secretvolumesource-v1","secretkeyselector-v1","scale-v1","selinuxoptions-v1","rollbackconfig-v1beta1","roleref-v1alpha1","resourcerequirements-v1","resourcefieldselector-v1","resourceattributes-v1beta1","replicationcontrollercondition-v1","replicasetcondition-v1beta1","rawextension-runtime","rbdvolumesource-v1","quobytevolumesource-v1","quantity-resource","probe-v1","preconditions-v1","policyrule-v1alpha1","podsecuritycontext-v1","podcondition-v1","photonpersistentdiskvolumesource-v1","persistentvolumeclaimvolumesource-v1","patch-unversioned","ownerreference-v1","objectreference-v1","objectmeta-v1","objectfieldselector-v1","nonresourceattributes-v1beta1","nodesysteminfo-v1","nodedaemonendpoints-v1","nodecondition-v1","nodeaddress-v1","networkpolicyport-v1beta1","networkpolicypeer-v1beta1","networkpolicyingressrule-v1beta1","nfsvolumesource-v1","localobjectreference-v1","loadbalancerstatus-v1","loadbalanceringress-v1","listmeta-unversioned","limitrangeitem-v1","lifecycle-v1","labelselectorrequirement-unversioned","labelselector-unversioned","keytopath-v1","jobtemplatespec-v2alpha1","jobcondition-v1","intorstring-intstr","ingresstls-v1beta1","ingressrule-v1beta1","ingressbackend-v1beta1","info-version","iscsivolumesource-v1","hostpathvolumesource-v1","handler-v1","httpingressrulevalue-v1beta1","httpingresspath-v1beta1","httpheader-v1","httpgetaction-v1","groupversionfordiscovery-unversioned","glusterfsvolumesource-v1","gitrepovolumesource-v1","gcepersistentdiskvolumesource-v1","flockervolumesource-v1","flexvolumesource-v1","fcvolumesource-v1","execaction-v1","eviction-v1beta1","eventsource-v1","envvarsource-v1","envvar-v1","endpointsubset-v1","endpointport-v1","endpointaddress-v1","emptydirvolumesource-v1","downwardapivolumesource-v1","downwardapivolumefile-v1","deploymentcondition-v1beta1","deleteoptions-v1","daemonendpoint-v1","crossversionobjectreference-v1","containerstatewaiting-v1","containerstateterminated-v1","containerstaterunning-v1","containerstate-v1","containerport-v1","containerimage-v1","configmapvolumesource-v1","configmapkeyselector-v1","componentcondition-v1","cindervolumesource-v1","certificatesigningrequestcondition-v1alpha1","cephfsvolumesource-v1","capabilities-v1","cputargetutilization-v1beta1","azurefilevolumesource-v1","azurediskvolumesource-v1","attachedvolume-v1","awselasticblockstorevolumesource-v1","apiversions-unversioned","apiversion-v1beta1","apiresource-unversioned","apigroup-unversioned","-strong-definitions-strong-","watch-list-all-namespaces-510","watch-list-509","watch-508","list-all-namespaces-507","list-506","read-505","-strong-read-operations-strong--504","delete-collection-503","delete-502","patch-501","replace-500","create-499","-strong-write-operations-strong--498","networkpolicy-v1beta1","create-497","-strong-write-operations-strong--496","tokenreview-v1beta1","create-495","-strong-write-operations-strong--494","subjectaccessreview-v1beta1","watch-list-all-namespaces-493","watch-list-492","watch-491","list-all-namespaces-490","list-489","read-488","-strong-read-operations-strong--487","delete-collection-486","delete-485","patch-484","replace-483","create-482","-strong-write-operations-strong--481","serviceaccount-v1","create-480","-strong-write-operations-strong--479","selfsubjectaccessreview-v1beta1","watch-list-all-namespaces-478","watch-list-477","watch-476","list-all-namespaces-475","list-474","read-473","-strong-read-operations-strong--472","delete-collection-471","delete-470","patch-469","replace-468","create-467","-strong-write-operations-strong--466","rolebinding-v1alpha1","watch-list-all-namespaces-465","watch-list-464","watch-463","list-all-namespaces-462","list-461","read-460","-strong-read-operations-strong--459","delete-collection-458","delete-457","patch-456","replace-455","create-454","-strong-write-operations-strong--453","role-v1alpha1","replace-status-452","read-status-451","patch-status-450","-strong-status-operations-strong--449","watch-list-all-namespaces-448","watch-list-447","watch-446","list-all-namespaces-445","list-444","read-443","-strong-read-operations-strong--442","delete-collection-441","delete-440","patch-439","replace-438","create-437","-strong-write-operations-strong--436","resourcequota-v1","replace-status-435","read-status-434","patch-status-433","-strong-status-operations-strong--432","watch-list-431","watch-430","list-429","read-428","-strong-read-operations-strong--427","delete-collection-426","delete-425","patch-424","replace-423","create-422","-strong-write-operations-strong--421","persistentvolume-v1","replace-proxy-path-420","replace-proxy-419","replace-connect-proxy-path-418","replace-connect-proxy-417","head-connect-proxy-path-416","head-connect-proxy-415","get-proxy-path-414","get-proxy-413","get-connect-proxy-path-412","get-connect-proxy-411","delete-proxy-path-410","delete-proxy-409","delete-connect-proxy-path-408","delete-connect-proxy-407","create-proxy-path-406","create-proxy-405","create-connect-proxy-path-404","create-connect-proxy-403","-strong-proxy-operations-strong--402","replace-status-401","read-status-400","patch-status-399","-strong-status-operations-strong--398","watch-list-397","watch-396","list-395","read-394","-strong-read-operations-strong--393","delete-collection-392","delete-391","patch-390","replace-389","create-388","-strong-write-operations-strong--387","node-v1","replace-status-386","read-status-385","patch-status-384","-strong-status-operations-strong--383","watch-list-382","watch-381","list-380","read-379","-strong-read-operations-strong--378","delete-collection-377","delete-376","patch-375","replace-374","create-373","-strong-write-operations-strong--372","namespace-v1","create-371","-strong-write-operations-strong--370","localsubjectaccessreview-v1beta1","list-369","read-368","-strong-read-operations-strong--367","componentstatus-v1","watch-list-366","watch-365","list-364","read-363","-strong-read-operations-strong--362","delete-collection-361","delete-360","patch-359","replace-358","create-357","-strong-write-operations-strong--356","clusterrolebinding-v1alpha1","watch-list-355","watch-354","list-353","read-352","-strong-read-operations-strong--351","delete-collection-350","delete-349","patch-348","replace-347","create-346","-strong-write-operations-strong--345","clusterrole-v1alpha1","replace-status-344","-strong-status-operations-strong--343","watch-list-342","watch-341","list-340","read-339","-strong-read-operations-strong--338","delete-collection-337","delete-336","patch-335","replace-334","create-333","-strong-write-operations-strong--332","certificatesigningrequest-v1alpha1","create-331","-strong-write-operations-strong--330","binding-v1","-strong-cluster-strong-","watch-list-329","watch-328","list-327","read-326","-strong-read-operations-strong--325","delete-collection-324","delete-323","patch-322","replace-321","create-320","-strong-write-operations-strong--319","thirdpartyresource-v1beta1","replace-status-318","read-status-317","patch-status-316","-strong-status-operations-strong--315","watch-list-all-namespaces-314","watch-list-313","watch-312","list-all-namespaces-311","list-310","read-309","-strong-read-operations-strong--308","delete-collection-307","delete-306","patch-305","replace-304","create-303","-strong-write-operations-strong--302","poddisruptionbudget-v1beta1","watch-list-all-namespaces-301","watch-list-300","watch-299","list-all-namespaces-298","list-297","read-296","-strong-read-operations-strong--295","delete-collection-294","delete-293","patch-292","replace-291","create-290","-strong-write-operations-strong--289","podtemplate-v1","replace-status-288","read-status-287","patch-status-286","-strong-status-operations-strong--285","watch-list-all-namespaces-284","watch-list-283","watch-282","list-all-namespaces-281","list-280","read-279","-strong-read-operations-strong--278","delete-collection-277","delete-276","patch-275","replace-274","create-273","-strong-write-operations-strong--272","horizontalpodautoscaler-v1","watch-list-all-namespaces-271","watch-list-270","watch-269","list-all-namespaces-268","list-267","read-266","-strong-read-operations-strong--265","delete-collection-264","delete-263","patch-262","replace-261","create-260","-strong-write-operations-strong--259","limitrange-v1","watch-list-all-namespaces-258","watch-list-257","watch-256","list-all-namespaces-255","list-254","read-253","-strong-read-operations-strong--252","delete-collection-251","delete-250","patch-249","replace-248","create-247","-strong-write-operations-strong--246","event-v1","-strong-metadata-strong-","volume-v1","watch-list-245","watch-244","list-243","read-242","-strong-read-operations-strong--241","delete-collection-240","delete-239","patch-238","replace-237","create-236","-strong-write-operations-strong--235","storageclass-v1beta1","replace-status-234","read-status-233","patch-status-232","-strong-status-operations-strong--231","watch-list-all-namespaces-230","watch-list-229","watch-228","list-all-namespaces-227","list-226","read-225","-strong-read-operations-strong--224","delete-collection-223","delete-222","patch-221","replace-220","create-219","-strong-write-operations-strong--218","persistentvolumeclaim-v1","watch-list-all-namespaces-217","watch-list-216","watch-215","list-all-namespaces-214","list-213","read-212","-strong-read-operations-strong--211","delete-collection-210","delete-209","patch-208","replace-207","create-206","-strong-write-operations-strong--205","secret-v1","watch-list-all-namespaces-204","watch-list-203","watch-202","list-all-namespaces-201","list-200","read-199","-strong-read-operations-strong--198","delete-collection-197","delete-196","patch-195","replace-194","create-193","-strong-write-operations-strong--192","configmap-v1","-strong-config-storage-strong-","replace-proxy-path-191","replace-proxy-190","replace-connect-proxy-path-189","replace-connect-proxy-188","head-connect-proxy-path-187","head-connect-proxy-186","get-proxy-path-185","get-proxy-184","get-connect-proxy-path-183","get-connect-proxy-182","delete-proxy-path-181","delete-proxy-180","delete-connect-proxy-path-179","delete-connect-proxy-178","create-proxy-path-177","create-proxy-176","create-connect-proxy-path-175","create-connect-proxy-174","-strong-proxy-operations-strong--173","replace-status-172","read-status-171","patch-status-170","-strong-status-operations-strong--169","watch-list-all-namespaces-168","watch-list-167","watch-166","list-all-namespaces-165","list-164","read-163","-strong-read-operations-strong--162","delete-161","patch-160","replace-159","create-158","-strong-write-operations-strong--157","service-v1","replace-status-156","read-status-155","patch-status-154","-strong-status-operations-strong--153","watch-list-all-namespaces-152","watch-list-151","watch-150","list-all-namespaces-149","list-148","read-147","-strong-read-operations-strong--146","delete-collection-145","delete-144","patch-143","replace-142","create-141","-strong-write-operations-strong--140","ingress-v1beta1","watch-list-all-namespaces-139","watch-list-138","watch-137","list-all-namespaces-136","list-135","read-134","-strong-read-operations-strong--133","delete-collection-132","delete-131","patch-130","replace-129","create-128","-strong-write-operations-strong--127","endpoints-v1","-strong-discovery-load-balancing-strong-","replace-status-126","read-status-125","patch-status-124","-strong-status-operations-strong--123","watch-list-all-namespaces-122","watch-list-121","watch-120","list-all-namespaces-119","list-118","read-117","-strong-read-operations-strong--116","delete-collection-115","delete-114","patch-113","replace-112","create-111","-strong-write-operations-strong--110","statefulset-v1beta1","replace-status-109","read-status-108","patch-status-107","-strong-status-operations-strong--106","watch-list-all-namespaces-105","watch-list-104","watch-103","list-all-namespaces-102","list-101","read-100","-strong-read-operations-strong--99","delete-collection-98","delete-97","patch-96","replace-95","create-94","-strong-write-operations-strong--93","replicationcontroller-v1","patch-scale-92","replace-scale-91","read-scale-90","-strong-misc-operations-strong--89","replace-status-88","read-status-87","patch-status-86","-strong-status-operations-strong--85","watch-list-all-namespaces-84","watch-list-83","watch-82","list-all-namespaces-81","list-80","read-79","-strong-read-operations-strong--78","delete-collection-77","delete-76","patch-75","replace-74","create-73","-strong-write-operations-strong--72","replicaset-v1beta1","read-log","-strong-misc-operations-strong--71","replace-proxy-path","replace-proxy","replace-connect-proxy-path","replace-connect-proxy","head-connect-proxy-path","head-connect-proxy","get-proxy-path","get-proxy","get-connect-proxy-path","get-connect-proxy","get-connect-portforward","delete-proxy-path","delete-proxy","delete-connect-proxy-path","delete-connect-proxy","create-proxy-path","create-proxy","create-connect-proxy-path","create-connect-proxy","create-connect-portforward","-strong-proxy-operations-strong-","replace-status-70","read-status-69","patch-status-68","-strong-status-operations-strong--67","watch-list-all-namespaces-66","watch-list-65","watch-64","list-all-namespaces-63","list-62","read-61","-strong-read-operations-strong--60","delete-collection-59","delete-58","patch-57","replace-56","create-55","-strong-write-operations-strong--54","pod-v1","replace-status-53","read-status-52","patch-status-51","-strong-status-operations-strong--50","watch-list-all-namespaces-49","watch-list-48","watch-47","list-all-namespaces-46","list-45","read-44","-strong-read-operations-strong--43","delete-collection-42","delete-41","patch-40","replace-39","create-38","-strong-write-operations-strong--37","job-v1","rollback","patch-scale","replace-scale","read-scale","-strong-misc-operations-strong-","replace-status-36","read-status-35","patch-status-34","-strong-status-operations-strong--33","watch-list-all-namespaces-32","watch-list-31","watch-30","list-all-namespaces-29","list-28","read-27","-strong-read-operations-strong--26","delete-collection-25","delete-24","patch-23","replace-22","create-21","-strong-write-operations-strong--20","deployment-v1beta1","replace-status-19","read-status-18","patch-status-17","-strong-status-operations-strong--16","watch-list-all-namespaces-15","watch-list-14","watch-13","list-all-namespaces-12","list-11","read-10","-strong-read-operations-strong--9","delete-collection-8","delete-7","patch-6","replace-5","create-4","-strong-write-operations-strong--3","daemonset-v1beta1","replace-status","read-status","patch-status","-strong-status-operations-strong-","watch-list-all-namespaces","watch-list","watch","list-all-namespaces","list","read-2","-strong-read-operations-strong-","delete-collection","delete-1","patch","replace","create","-strong-write-operations-strong-","cronjob-v2alpha1","container-v1","-strong-workloads-strong-","resource-operations","resource-objects","resource-categories","-strong-api-overview-strong-"]}})(); \ No newline at end of file diff --git a/docs/api-reference/v1.5/runbrodocs.sh b/docs/api-reference/v1.5/runbrodocs.sh deleted file mode 100755 index 7e1fce32ca..0000000000 --- a/docs/api-reference/v1.5/runbrodocs.sh +++ /dev/null @@ -1,6 +0,0 @@ -#!/bin/bash - -cp /manifest/manifest.json ./manifest.json -cp /source/* ./documents/ -node brodoc.js -cp -r ./* /build/ diff --git a/docs/api.md b/docs/api.md index 7c6ae95e73..b52e55a298 100644 --- a/docs/api.md +++ b/docs/api.md @@ -72,28 +72,38 @@ in more detail in the [API Changes documentation](https://github.com/kubernetes/ ## API groups -To make it easier to extend the Kubernetes API, we are in the process of implementing [*API -groups*](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/proposals/api-group.md). These are simply different interfaces to read and/or modify the -same underlying resources. The API group is specified in a REST path and in the `apiVersion` field -of a serialized object. +To make it easier to extend the Kubernetes API, we implemented [*API groups*](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-group.md). +The API group is specified in a REST path and in the `apiVersion` field of a serialized object. Currently there are several API groups in use: -1. the "core" group, which is at REST path `/api/v1` and is not specified as part of the `apiVersion` field, e.g. - `apiVersion: v1`. -1. the "extensions" group, which is at REST path `/apis/extensions/$VERSION`, and which uses - `apiVersion: extensions/$VERSION` (e.g. currently `apiVersion: extensions/v1beta1`). - This holds types which will probably move to another API group eventually. -1. the "componentconfig" and "metrics" API groups. +1. the "core" (oftentimes called "legacy", due to not having explicit group name) group, which is at + REST path `/api/v1` and is not specified as part of the `apiVersion` field, e.g. `apiVersion: v1`. +1. the named groups are at REST path `/apis/$GROUP_NAME/$VERSION`, and use `apiVersion: $GROUP_NAME/$VERSION` + (e.g. `apiVersion: batch/v1`). Full list of supported API groups can be seen in [Kubernetes API reference](/docs/reference/). -In the future we expect that there will be more API groups, all at REST path `/apis/$API_GROUP` and -using `apiVersion: $API_GROUP/$VERSION`. We expect that there will be a way for [third parties to -create their own API groups](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/extending-api.md), and to avoid naming collisions. +There are two supported paths to extending the API. +1. [Third Party Resources](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/extending-api.md) + are for users with very basic CRUD needs. +1. Coming soon: users needing the full set of Kubernetes API semantics can implement their own apiserver + and use the [aggregator](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/aggregated-api-servers.md) + to make it seamless for clients. -## Enabling resources in the extensions group + +## Enabling API groups + +Certain resources and API groups are enabled by default. They can be enabled or disabled by setting `--runtime-config` +on apiserver. `--runtime-config` accepts comma separated values. For ex: to disable batch/v1, set +`--runtime-config=batch/v1=false`, to enable batch/v2alpha1, set `--runtime-config=batch/v2alpha1`. +The flag accepts comma separated set of key=value pairs describing runtime configuration of the apiserver. + +IMPORTANT: Enabling or disabling groups or resources requires restarting apiserver and controller-manager +to pick up the `--runtime-config` changes. + +## Enabling resources in the groups DaemonSets, Deployments, HorizontalPodAutoscalers, Ingress, Jobs and ReplicaSets are enabled by default. -Other extensions resources can be enabled by setting runtime-config on -apiserver. runtime-config accepts comma separated values. For ex: to disable deployments and jobs, set +Other extensions resources can be enabled by setting `--runtime-config` on +apiserver. `--runtime-config` accepts comma separated values. For ex: to disable deployments and jobs, set `--runtime-config=extensions/v1beta1/deployments=false,extensions/v1beta1/jobs=false` diff --git a/docs/concepts/abstractions/controllers/statefulsets.md b/docs/concepts/abstractions/controllers/statefulsets.md index 996a63fe8d..fd7ac3277b 100644 --- a/docs/concepts/abstractions/controllers/statefulsets.md +++ b/docs/concepts/abstractions/controllers/statefulsets.md @@ -22,7 +22,7 @@ guarantees about the ordering of deployment and scaling. {% capture body %} -### Using StatefulSets +## Using StatefulSets StatefulSets are valuable for applications that require one or more of the following. @@ -39,15 +39,15 @@ 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 stateless needs. -### Limitations +## Limitations * StatefulSet is a beta resource, not available in any Kubernetes release prior to 1.5. * As with all alpha/beta resources, you can disable StatefulSet through the `--runtime-config` option passed to the apiserver. -* The storage for a given Pod must either be provisioned by a [PersistentVolume Provisioner](http://releases.k8s.io/{{page.githubbranch}}/examples/experimental/persistent-volume-provisioning/README.md) based on the requested `storage class`, or pre-provisioned by an admin. +* The storage for a given Pod must either be provisioned by a [PersistentVolume Provisioner](http://releases.k8s.io/{{page.githubbranch}}/examples/persistent-volume-provisioning/README.md) based on the requested `storage class`, or pre-provisioned by an admin. * Deleting and/or scaling a StatefulSet down will *not* delete the volumes associated with the StatefulSet. This is done to ensure data safety, which is generally more valuable than an automatic purge of all related StatefulSet resources. * StatefulSets currently require a [Headless Service](/docs/user-guide/services/#headless-services) to be responsible for the network identity of the Pods. You are responsible for creating this Service. * Updating an existing StatefulSet is currently a manual process. -### Components +## Components The example below demonstrates the components of a StatefulSet. * A Headless Service, named nginx, is used to control the network domain. @@ -103,17 +103,17 @@ spec: storage: 1Gi ``` -### Pod Identity +## 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. -__Ordinal Index__ +### Ordinal Index For a StatefulSet with N replicas, each Pod in the StatefulSet will be assigned an integer ordinal, in the range [0,N), that is unique over the Set. -__Stable Network ID__ +### Stable Network ID Each Pod in a StatefulSet derives its hostname from the name of the StatefulSet and the ordinal of the Pod. The pattern for the constructed hostname @@ -139,7 +139,7 @@ Cluster Domain | Service (ns/name) | StatefulSet (ns/name) | StatefulSet Domain Note that Cluster Domain will be set to `cluster.local` unless [otherwise configured](http://releases.k8s.io/{{page.githubbranch}}/build/kube-dns/README.md#how-do-i-configure-it). -__Stable Storage__ +### Stable Storage Kubernetes creates one [PersistentVolume](/docs/user-guide/volumes/) for each VolumeClaimTemplate. In the nginx example above, each Pod will receive a single PersistentVolume @@ -149,7 +149,7 @@ PersistentVolume Claims. Note that, the PersistentVolumes associated with the Pods' PersistentVolume Claims are not deleted when the Pods, or StatefulSet are deleted. This must be done manually. -### Deployment and Scaling Guarantee +## Deployment and Scaling Guarantee * For a StatefulSet with N replicas, when Pods are being deployed, they are created sequentially, in order from {0..N-1}. * When Pods are being deleted, they are terminated in reverse order, from {N-1..0}. diff --git a/docs/concepts/abstractions/nginx-deployment.yaml b/docs/concepts/abstractions/nginx-deployment.yaml new file mode 100644 index 0000000000..7a0dd431ef --- /dev/null +++ b/docs/concepts/abstractions/nginx-deployment.yaml @@ -0,0 +1,16 @@ +apiVersion: extensions/v1beta1 +kind: Deployment +metadata: + name: nginx-deployment +spec: + replicas: 3 + template: + metadata: + labels: + app: nginx + spec: + containers: + - name: nginx + image: nginx:1.7.9 + ports: + - containerPort: 80 diff --git a/docs/concepts/abstractions/overview.md b/docs/concepts/abstractions/overview.md new file mode 100644 index 0000000000..dc2e8cf7ab --- /dev/null +++ b/docs/concepts/abstractions/overview.md @@ -0,0 +1,66 @@ +--- +title: Kubernetes Objects +--- + +{% capture overview %} +This page explains how Kubernetes objects are represented in the Kubernetes API, and how you can express them in `.yaml` format. +{% endcapture %} + +{% capture body %} +## Understanding Kubernetes Objects + +*Kubernetes Objects* are persistent entities in the Kubernetes system. Kubenetes uses these entities to represent the state of your cluster. Specifically, they can describe: + +* What containerized applications are running (and on which nodes) +* The resources available to those applications +* The policies around how those applications behave, such as restart policies, upgrades, and fault-tolerance + +A Kubernetes object is a "record of intent"--once you create the object, the Kubernetes system will constantly work to ensure that that object exists. By creating an object, you're effectively telling the Kubernetes system what you want your cluster's workload to look like; this is your cluster's **desired state**. + +To work with Kubernetes objects--whether to create, modify, or delete them--you'll need to use the [Kubernetes API](https://github.com/kubernetes/kubernetes/blob/master/docs/devel/api-conventions.md). When you use the `kubectl` comamnd-line interface, for example, the CLI makes the necessary Kubernetes API calls for you; you can also use the Kubernetes API directly in your own programs. Kubernetes currently provides a `golang` [client library](https://github.com/kubernetes/client-go) for this purpose, and other language libraries (such as [Python](https://github.com/kubernetes-incubator/client-python)) are being developed. + +### Object Spec and Status + +Every Kubernetes object includes two nested object fields that govern the object's configuration: the object *spec* and the object *status*. The *spec*, which you must provide, describes your *desired state* for the object--the characteristics that you want the object to have. The *status* describes the *actual state* for the object, and is supplied and updated by the Kubernetes system. At any given time, the Kubernetes Control Plane actively manages an object's actual state to match the desired state you supplied. + +For example, a Kubernetes Deployment is an object that can represent an application running on your cluster. When you create the Deployment, you might set the Deployment spec to specify that you want three replicas of the application to be running. The Kubernetes system reads the Deployment spec and starts three instances of your desired application--updating the status to match your spec. If any of those instances should fail (a status change), the Kubernetes system responds to the difference between spec and status by making a correction--in this case, starting a replacement instance. + +For more information on the object spec, status, and metadata, see the [Kubernetes API Conventions](https://github.com/kubernetes/kubernetes/blob/master/docs/devel/api-conventions.md#spec-and-status). + +### Describing a Kubernetes Object + +When you create an object in Kubernetes, you must provide the object spec that describes its desired state, as well as some basic information about the object (such as a name). When you use the Kubernetes API to create the object (either directly or via `kubectl`), that API request must include that information as JSON in the request body. **Most often, you provide the information to `kubectl` in a .yaml file.** `kubectl` converts the information to JSON when making the API request. + +Here's an example `.yaml` file that shows the required fields and object spec for a Kubernetes Deployment: + +{% include code.html language="yaml" file="nginx-deployment.yaml" ghlink="/docs/concepts/abstractions/nginx-deployment.yaml" %} + +One way to create a Deployment using a `.yaml` file like the one above is to use the []`kubectl create`]() command in the `kubectl` command-line interface, passing the `.yaml` file as an argument. Here's an example: + +```shell +$ kubectl create -f docs/user-guide/nginx-deployment.yaml --record +``` + +The output is similar to this: + +```shell +deployment "nginx-deployment" created +``` + +### Required Fields + +In the `.yaml` file for the Kubernetes object you want to create, you'll need to set values for the following fields: + +* `apiVersion` - Which version of the Kubernetes API you're using to create this object +* `kind` - What kind of object you want to create +* `metadata` - Data that helps uniquely identify the object, including a `name` string, UID, and optional `namespace` + +You'll also need to provide the object `spec` field. The precise format of the object `spec` is different for every Kubernetes object, and contains nested fields specific to that object. The [Kubernetes API reference](/docs/api/) can help you find the spec format for all of the objects you can create using Kubernetes. + +{% endcapture %} + +{% capture whatsnext %} +* Learn about the most important basic Kubernetes objects, such as [Pod](/docs/concepts/abstractions/pod/). +{% endcapture %} + +{% include templates/concept.md %} diff --git a/docs/concepts/abstractions/pod-termination.md b/docs/concepts/abstractions/pod-termination.md new file mode 100644 index 0000000000..5276dae617 --- /dev/null +++ b/docs/concepts/abstractions/pod-termination.md @@ -0,0 +1,15 @@ +--- +--- + +#### Pod Termination + +Since Pods represent processes running on your cluster, Kubernetes provides for *graceful termination* when Pods are no longer needed. Kubernetes implements graceful termination by applying a default *grace period* of 30 seconds from the time that you issue a termination request. A typical Pod termination in Kubernetes involves the following steps: + +1. You send a command or API call to terminate the Pod. +1. Kubernetes updates the Pod status to reflect the time after which the Pod is to be considered "dead" (the time of the termination request plus the grace period). +1. Kubernetes marks the Pod state as "Terminating" and stops sending traffic to the Pod. +1. Kubernetes send a `TERM` signal to the Pod, indicating that the Pod should shut down. +1. When the grace period expires, Kubernetes issues a `SIGKILL` to any processes still running in the Pod. +1. Kubernetes removes the Pod from the API server on the Kubernetes Master. + +> **Note:** The grace period is configurable; you can set your own grace period when interacting with the cluster to request termination, such as using the `kubectl delete` command. See the [Terminating a Pod]() tutorial for more information. \ No newline at end of file diff --git a/docs/concepts/abstractions/pod.md b/docs/concepts/abstractions/pod.md new file mode 100644 index 0000000000..07f0d18934 --- /dev/null +++ b/docs/concepts/abstractions/pod.md @@ -0,0 +1,78 @@ +--- +title: Pods +--- + +{% capture overview %} +This page provides an overview of `Pod`, the smallest deployable object in the Kubernetes object model. +{% endcapture %} + +{:toc} + +{% capture body %} +## Understanding Pods + +A *Pod* is the basic building block of Kubernetes--the smallest and simplest unit in the Kubernetes object model that you create or deploy. A Pod represents a running process on your cluster. + +A Pod encapsulates an application container (or, in some cases, multiple containers), storage resources, a unique network IP, and options that govern how the container(s) should run. A Pod represents a unit of deployment: *a single instance of an application in Kubernetes*, which might consist of either a single container or a small number of containers that are tightly coupled and that share resources. + +> [Docker](https://www.docker.com) is the most common container runtime used in a Kubernetes Pod, but Pods support other container runtimes as well. + +Pods are employed a number of ways in a Kubernetes cluster, including: + +* **Pods that run a single container**. The "one-container-per-Pod" model is the most common Kubernetes use case; in this case, you can think of a Pod as a wrapper around a single container, and Kubernetes manages the Pods rather than the containers directly. +* **Pods that run multiple containers that need to work together**. A Pod might encapsulate an application composed multiple co-located containers that are tightly coupled and need to share resources. These co-located containers might form a single cohesive unit of service--one container serving files from a shared volume to the public, while a separate "sidecar" container refreshes or updates those files. The Pod wraps these containers and storage resources together as a single managable entity. + +The [Kubernetes Blog](http://blog.kubernetes.io) has some additional information on Pod use cases. For more information, see: + +* [The Distributed System Toolkit: Patterns for Composite Containers](http://blog.kubernetes.io/2015/06/the-distributed-system-toolkit-patterns.html) +* [Container Design Patterns](http://blog.kubernetes.io/2016/06/container-design-patterns.html) + +Each Pod is meant to run a single instance of a given application. If you want to scale your application horizontally (e.g., run muliple instances), you should use multiple Pods, one for each instance. In Kubernetes, this is generally referred to as _replication_. Replicated Pods are usually created and managed as a group by an abstraction called a Controller. See [Pods and Controllers](#pods-and-controllers) for more information. + +### How Pods Manage Multiple Containers + +Pods are designed to support multiple cooperating processes (as containers) that form a cohesive unit of service. The containers in a Pod are automatically co-located and co-scheduled on the same physical or virtual machine in the cluster. The containers can share resources and dependencies, communicate with one another, and coordinate when and how they are terminated. + +Note that grouping multiple co-located and co-managed containers in a single Pod is a relatively advanced use case. You should use this pattern only in specific instances in which your containers are tightly coupled. For example, you might have a container that acts as a web server for files in a shared volume, and a separate "sidecar" container that updates those files from a remote source, as in the following diagram: + +![pod diagram](/images/docs/pod.svg){: style="max-width: 50%" } + +Pods provide two kinds of shared resources for their constituent containers: *networking* and *storage*. + +#### Networking + +Each Pod is assigned a unique IP address. Every the container in a Pod shares the network namespace, including the IP address and network ports. Containers *inside a Pod* can communicate with one another using `localhost`. When containers in a Pod communicate with entities *outside the Pod*, they must coordinate how they use the shared network resources (such as ports). + +#### Storage + +A Pod can specify a set of shared storage *volumes*. All containers in the Pod can access the shared volumes, allowing those containers to share data. Volumes also allow persistent data in a Pod to survive in case one of the containers within needs to be restarted. See Volumes for more information on how Kubernetes implements shared storage in a Pod. + +## Working with Pods + +You'll rarely create individual Pods directly in Kubernetes--even singleton Pods. This is because Pods are designed as relatively ephemeral, disposable entities. When a Pod gets created (directly by you, or indirectly by a Controller), it is scheduled to run on a Node in your your cluster. The Pod remains on that Node until the process is terminated, the pod object is deleted, or the pod is *evicted* for lack of resources, or the Node fails. + +> Note: Restarting a container in a Pod should not be confused with restarting the Pod. The Pod itself does not run, but is an environment the containers run in and persists until it is deleted. + +Pods do not, by themselves, self-heal. If a Pod is scheduled to a Node that fails, or if the scheduling operation itself fails, the Pod is deleted; likewise, a Pod won't survive an eviction due to a lack of resources or Node maintenance. Kubernetes uses a higher-level abstraction, called a *Controller*, that handles the work of managing the relatively disposable Pod instances. Thus, while it is possible to use Pod directly, it's far more common in Kubernetes to manage your pods using a Controller. See [Pods and Controllers](#pods-and-controllers) for more information on how Kubernetes uses Controllers to implement Pod scaling and healing. + +### Pods and Controllers + +A Controller can create and manage multiple Pods for you, handling replication and rollout and providing self-healing capabilities at cluster scope. For example, if a Node fails, the Controller might automatically replace the Pod by scheduling an identical replacement on a different Node). + +Some examples of Controllers that contain one or more pods include: + +* Deployment +* [StatefulSet](/docs/concepts/abstractions/controllers/statefulsets/) +* DaemonSet + +In general, Controllers use a Pod Template that you provide to create the Pods for which it is responsible. + +{% endcapture %} + +{% capture whatsnext %} +* Learn more about Pod behavior: + * Pod Termination + * Other Pod Topics +{% endcapture %} + +{% include templates/concept.md %} diff --git a/docs/concepts/index.md b/docs/concepts/index.md index c26b972202..3f131c6358 100644 --- a/docs/concepts/index.md +++ b/docs/concepts/index.md @@ -2,16 +2,59 @@ title: Concepts --- -The Concepts section of the Kubernetes documentation is a work in progress. +The Concepts section helps you learn about the parts of the Kubernetes system and the abstractions Kubernetes uses to represent your cluster, and helps you obtain a deeper understanding of how Kubernetes works. + +## Overview + +To work with Kubernetes, you use *Kubernetes API objects* to describe your cluster's *desired state*: what applications or other workloads you want to run, what container images they use, the number of replicas, what network and disk resources you want to make available, and more. You set your desired state by creating objects using the Kubernetes API, typically via the command-line interface, `kubectl`. You can also use the Kubernetes API directly to interact with the cluster and set or modify your desired state. + +Once you've set your desired state, the *Kubernetes Control Plane* works to make the cluster's current state match the desired state. To do so, Kuberentes performs a variety of tasks automatically--such as starting or restarting containers, scaling the number of replicas of a given application, and more. The Kubernetes Control Plane consists of a collection processes running on your cluster: + +* The **Kubernetes Master** is a collection of four processes that run on a single node in your cluster, which is designated as the master node. +* Each individual non-master node in your cluster runs two processes: + * **kubelet**, which communicates with the Kubernetes Master. + * **kube-proxy**, a network proxy which reflects Kubernetes networking services on each node. + +## Kubernetes Objects + +Kubernetes contains a number of abstractions that represent your the state of your system: deployed containerized applications and workloads, their associated network and disk resources, and other information about what your cluster is doing. These abstractions are represented by objects in the Kubernetes API; see the [Kubernetes Objects overview](/docs/concepts/abstractions/overview/) for more details. + +The basic Kubernetes objects include: + +* [Pod](/docs/concepts/abstractions/pod/) +* Service +* Volume +* Namespace + +In addition, Kubernetes contains a number of higher-level abstractions called Controllers. Controllers build upon the basic objects, and provide additional functionality and convenience features. They include: + +* ReplicaSet +* Deployment +* [StatefulSet](/docs/concepts/abstractions/controllers/statefulsets/) +* DaemonSet +* Job + +## Kubernetes Control Plane + +The various parts of the Kubernetes Control Plane, such as the Kubernetes Master and kubelet processes, govern how Kubernetes communicates with your cluster. The Control Plane maintains a record of all of the Kubernetes Objects in the system, and runs continuous control loops to manage those objects' state. At any given time, the Control Plane's control loops will respond to changes in the cluster and work to make the actual state of all the objects in the system to the desired state that you provided. + +For example, when you use the Kubernetes API to create a Deployment object, you provide a new desired state for the system. The Kubernetes Control Plane records that object creation, and carries out your instructions by starting the required applications and scheduling them to cluster nodes--thus making the cluster's actual state match the desired state. + +### Kubernetes Master + +The Kubernetes master is responsible for maintaining the desired state for your cluster. When you interact with Kubernetes, such as by using the `kubectl` command-line interface, you're communicating with your cluster's Kubernetes master. + +> The "master" refers to a collection of processes managing the cluster state. Typically these processes are all run on a single node in the cluster, and this node is also referred to as the master. The master can also be replicated for availability and redundnacy. + +### Kubernetes Nodes + +The nodes in a cluster are the machines (VMs, physical servers, etc) that run your applications and cloud workflows. The Kubernetes master controls each node; you'll rarely interact with nodes directly. #### Object Metadata * [Annotations](/docs/concepts/object-metadata/annotations/) -#### Controllers -* [StatefulSets](/docs/concepts/abstractions/controllers/statefulsets/) - ### What's next diff --git a/docs/concepts/object-metadata/annotations.md b/docs/concepts/object-metadata/annotations.md index fbf73f48fd..00840db613 100644 --- a/docs/concepts/object-metadata/annotations.md +++ b/docs/concepts/object-metadata/annotations.md @@ -8,7 +8,7 @@ to objects. Clients such as tools and libraries can retrieve this metadata. {% endcapture %} {% capture body %} -### Attaching metadata to objects +## Attaching metadata to objects You can use either labels or annotations to attach metadata to Kubernetes objects. Labels can be used to select objects and to find diff --git a/docs/concepts/tools/kubectl/object-management-overview.md b/docs/concepts/tools/kubectl/object-management-overview.md new file mode 100644 index 0000000000..0969086ff9 --- /dev/null +++ b/docs/concepts/tools/kubectl/object-management-overview.md @@ -0,0 +1,190 @@ +--- +title: Kubernetes Object Management +--- + +{% capture overview %} +The `kubectl` command-line tool supports several different ways to create and manage +Kubernetes objects. This document provides an overview of the different +approaches. +{% endcapture %} + +{% capture body %} + +## Management techniques + +**Warning:** A Kubernetes object should be managed using only one technique. Mixing +and matching techniques for the same object results in undefined behavior. + +| Management technique | Operates on |Recommended environment | Supported writers | Learning curve | +|----------------------------------|----------------------|------------------------|--------------------|----------------| +| Imperative commands | Live objects | Development projects | 1+ | Lowest | +| Imperative object configuration | Individual files | Production projects | 1 | Moderate | +| Declarative object configuration | Directories of files | Production projects | 1+ | Highest | + +## Imperative commands + +When using imperative commands, a user operates directly on live objects +in a cluster. The user provides operations to +the `kubectl` command as arguments or flags. + +This is the simplest way to get started or to run a one-off task in +a cluster. Because this technique operates directly on live +objects, it provides no history of previous configurations. + +### Examples + +Run an instance of the nginx container by creating a Deployment object: + +```sh +kubectl run nginx --image nginx +``` + +Do the same thing using a different syntax: + +```sh +kubectl create deployment nginx --image nginx +``` + +### Trade-offs + +Advantages compared to object configuration: + +- Commands are simple, easy to learn and easy to remember. +- Commands require only a single step to make changes to the cluster. + +Disadvantages compared to object configuration: + +- Commands do not integrate with change review processes. +- Commands do not provide an audit trail associated with changes. +- Commands do not provide a source of records except for what is live. +- Commands do not provide a template for creating new objects. + +{% comment %} +If we use Markdown comments instead of HTML comments, they won't appear in the built HTML files. +For a tutorial on how to use Imperative Commands for app management, see: +[App Management Using Comands](/docs/tutorials/kubectl/app-management-using-commands/) +{% endcomment %} + +## Imperative object configuration + +When using imperative object configuration, a user operates on object +configuration files stored locally. An object configuration file defines a full +object in either YAML or JSON. + +The user provides an operation (create, replace, delete), one or more files, +and flags to the `kubectl` command. + +This technique requires a deep understanding of the Kubernetes +object definitions. + +**Note:** While this technique defines the object itself through a declarative +configuration file, the operations are imperative: create, replace, delete. + +### Examples + +Create the objects defined in a configuration file: + +```sh +kubectl create -f nginx.yaml +``` + +Delete the objects defined in two configuration files: + +```sh +kubectl delete -f nginx.yaml -f redis.yaml +``` + +Update the objects defined in a configuration file by overwriting +the live configuration: + +```sh +kubectl replace -f nginx.yaml +``` + +### Trade-offs + +Advantages compared to imperative commands: + +- Object configuration can be stored in a source control system such as Git. +- Object configuration can integrate with processes such as reviewing changes before push and audit trails. +- Object configuration provides a template for creating new objects. + +Disadvantages compared to imperative commands: + +- Object configuration requires basic understanding of the object schema. +- Object configuration requires the additional step of writing a YAML file. + +Advantages compared to declarative object configuration: + +- Imperative object configuration behavior is simpler and easier to understand. +- As of Kubernetes version 1.5, imperative object configuration is more mature. + +Disadvantages compared to declarative object configuration: + +- Imperative object configuration works best on files, not directories. +- Updates to live objects must be reflected in configuration files, or they will be lost during the next replacement. + +{% comment %} +For a tutorial on how to use Yaml Config for app management, see: +[App Management Yaml Config](/docs/tutorials/kubectl/app-management-using-yaml-config/) +{% endcomment %} + +## Declarative object configuration + +When using declarative object configuration, a user operates on object +configuration files stored locally, however the user does not define the +operations to be taken on the files. Create, update, and delete operations +are automatically detected per-object by `kubectl`. This enables working on +directories, where different operations might be needed for different objects. + +**Note:** Declarative object configuration retains changes made by other +writers, even if the changes are not merged back to the object configuration file. +This is possible by using the `patch` API operation to write only +observed differences, instead of using the `replace` +API operation to replace the entire object configuration. + +### Examples + +Process all object configuration files in the `configs` directory, and +create or patch the live objects: + +```sh +kubectl apply -f configs/ +``` + +Recursively process directories: + +```sh +kubectl apply -R -f configs/ +``` + +### Trade-offs + +Advantages compared to imperative object configuration: + +- Changes made directly to live objects are retained, even if they are not merged back into the configuration files. +- Declarative object configuration has better support for operating on directories and automatically detecting operation types (create, patch, delete) per-object. + +Disadvantages compared to imperative object configuration: + +- Declarative object configuration is harder to debug and understand results when they are unexpected. +- Partial updates using diffs create complex merge and patch operations. + +{% comment %} +For a tutorial on how to use Yaml Config with multiple writers, see: +[App Management Yaml Config](/docs/tutorials/kubectl/app-management-using-yaml-config-multiple-writers/) +{% endcomment %} + +{% endcapture %} + +{% capture whatsnext %} +- [Kubectl Command Reference](/docs/user-guide/kubectl/v1.5/) +- [Kubernetes Object Schema Reference](/docs/resources-reference/v1.5/) + +{% comment %} +- [App Management Using Yaml Config](/docs/tutorials/kubectl/declarative-app-management-using-yaml-config/) +- [App Management Using Yaml Config With Multiple Writers](/docs/tutorials/kubectl/declarative-app-management-using-yaml-config-multiple-writers/) +{% endcomment %} +{% endcapture %} + +{% include templates/concept.md %} diff --git a/docs/contribute/create-pull-request.md b/docs/contribute/create-pull-request.md index 4637c0b066..7ed2b2b953 100644 --- a/docs/contribute/create-pull-request.md +++ b/docs/contribute/create-pull-request.md @@ -23,7 +23,7 @@ Documentation will be published under the [CC BY SA 4.0](https://github.com/kube {% capture steps %} -### Creating a fork of the Kubernetes documentation repository +## Creating a fork of the Kubernetes documentation repository 1. Go to the [kubernetes/kubernetes.github.io](https://github.com/kubernetes/kubernetes.github.io){: target="_blank"} @@ -33,18 +33,18 @@ repository. Kubernetes documentation repository in your GitHub account. The copy is called a *fork*. -### Making your changes +## Making your changes 1. In your GitHub account, in your fork of the Kubernetes docs, create a new branch to use for your contribution. -1. In your new branch, make your changes and commit them. If you want to +1. In your new branch, make your changes and commit them. If you want to [write a new topic](/docs/contribute/write-new-topic/), choose the [page type](/docs/contribute/page-templates/) that is the best fit for your content. -### Submitting a pull request to the master branch (Current Release) +## Submitting a pull request to the master branch (Current Release) If you want your change to be published in the released version Kubernetes docs, create a pull request against the master branch of the Kubernetes @@ -62,7 +62,7 @@ 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. -### Submitting a pull request to the <vnext> branch (Upcoming Release) +## Submitting a pull request to the <vnext> branch (Upcoming Release) If your documentation change should not be released until the next release of the Kubernetes product, create a pull request against the <vnext> branch diff --git a/docs/contribute/page-templates.md b/docs/contribute/page-templates.md index 93fa03a6bb..0dfb600896 100644 --- a/docs/contribute/page-templates.md +++ b/docs/contribute/page-templates.md @@ -18,7 +18,7 @@ title: Using Page Templates

The page templates are in the _includes/templates directory of the kubernetes.github.io repository. -

Task template

+

Task template

A task page shows how to do a single thing, typically by giving a short sequence of steps. Task pages have minimal explanation, but often provide links @@ -36,10 +36,15 @@ variables, and then include templates/task.md:

  • whatsnext - optional
  • +

    In the steps section, use ## to start with a level-two heading. For subheadings, +use ### and #### as needed. Similarly, if you choose to have a discussion section, +start the section with a level-two heading.

    +

    Here's an example of a Markdown file that uses the task template:

    {% raw %}
    ---
    +title: Configuring This Thing
     ---
     
     {% capture overview %}
    @@ -52,14 +57,14 @@ This page shows how to ...
     {% endcapture %}
     
     {% capture steps %}
    -### Doing ...
    +## Doing ...
     
     1. Do this.
     1. Do this next. Possibly read this [related explanation](...).
     {% endcapture %}
     
     {% capture discussion %}
    -### Understanding ...
    +## Understanding ...
     
     Here's an interesting thing to know about the steps you just did.
     {% endcapture %}
    @@ -77,7 +82,7 @@ Here's an interesting thing to know about the steps you just did.
     
     

    Using an HTTP Proxy to Access the Kubernetes API

    -

    Tutorial template

    +

    Tutorial template

    A tutorial page shows how to accomplish a goal that is larger than a single task. Typically a tutorial page has several sections, each of which has a @@ -99,10 +104,14 @@ variables, and then include templates/tutorial.md:

  • whatsnext - optional
  • +

    In the lessoncontent section, use ## to start with a level-two heading. For subheadings, +use ### and #### as needed. +

    Here's an example of a Markdown file that uses the tutorial template:

    {% raw %}
    ---
    +title: Running a Thing
     ---
     
     {% capture overview %}
    @@ -121,17 +130,17 @@ This page shows how to ...
     {% endcapture %}
     
     {% capture lessoncontent %}
    -### Building ...
    +## Building ...
     
     1. Do this.
     1. Do this next. Possibly read this [related explanation](...).
     
    -### Running ...
    +## Running ...
     
     1. Do this.
     1. Do this next.
     
    -### Understanding the code
    +## Understanding the code
     Here's something interesting about the code you ran in the preceding steps.
     {% endcapture %}
     
    @@ -153,7 +162,7 @@ Here's something interesting about the code you ran in the preceding steps.
     
     

    Running a Stateless Application Using a Deployment

    -

    Concept template

    +

    Concept template

    A concept page explains some aspect of Kubernetes. For example, a concept page might describe the Kubernetes Deployment object and explain the role it @@ -171,10 +180,14 @@ variables, and then include templates/concept.md:

  • whatsnext - optional
  • +

    In the body section, use ## to start with a level-two heading. For subheadings, +use ### and #### as needed. +

    Here's an example of a page that uses the concept template:

    {% raw %}
    ---
    +title: Understanding this Thing
     ---
     
     {% capture overview %}
    @@ -182,11 +195,11 @@ This page explains ...
     {% endcapture %}
     
     {% capture body %}
    -### Understanding ...
    +## Understanding ...
     
     Kubernetes provides ...
     
    -### Using ...
    +## Using ...
     
     To use ...
     {% endcapture %}
    diff --git a/docs/contribute/review-issues.md b/docs/contribute/review-issues.md
    index 38d4424c7b..f5430d0b11 100644
    --- a/docs/contribute/review-issues.md
    +++ b/docs/contribute/review-issues.md
    @@ -9,20 +9,20 @@ This page explains how documentation issues are reviewed and prioritized for the
     
     {% capture body %}
     
    -### Categorizing issues
    -Issues should be sorted into different buckets of work using the following labels and definitions. If an issue doesn't have enough information to identify a problem that can be researched, reviewed, or worked on (i.e. the issue doesn't fit into any of the categories below) you should close the issue with a comment explaining why it is being closed.  
    +## Categorizing issues
    +Issues should be sorted into different buckets of work using the following labels and definitions. If an issue doesn't have enough information to identify a problem that can be researched, reviewed, or worked on (i.e. the issue doesn't fit into any of the categories below) you should close the issue with a comment explaining why it is being closed.
     
     
    -#### Actionable 
    +### Actionable
     * Issues that can be worked on with current information (or may need a comment to explain what needs to be done to make it more clear)
    -* Allows contributors to have easy to find issues to work on 
    +* Allows contributors to have easy to find issues to work on
     
     
    -#### Needs Tech Review 
    +### Needs Tech Review
     * Issues that need more information in order to be worked on (the proposed solution needs to be proven, a subject matter expert needs to be involved, work needs to be done to understand the problem/resolution and if the issue is still relevant)
    -* Promotes transparency about level of work needed for the issue and that issue is in progress 
    +* Promotes transparency about level of work needed for the issue and that issue is in progress
     
    -#### Needs Docs Review
    +### Needs Docs Review
     * Issues that are suggestions for better processes or site improvements that require community agreement to be implemented
     * Topics can be brought to SIG meetings as agenda items
     
    @@ -30,32 +30,32 @@ Issues should be sorted into different buckets of work using the following label
     * Issues that are suggestions for improving the user interface of the site or fixing a broken UX. 
     
     
    -### Prioritizing Issues
    -The following labels and definitions should be used to prioritize issues. If you change the priority of an issues, please comment on the issue with your reasoning for the change.   
    +## Prioritizing Issues
    +The following labels and definitions should be used to prioritize issues. If you change the priority of an issues, please comment on the issue with your reasoning for the change.
     
    -#### P1
    +### P1
     * Major content errors affecting more than 1 page
     * Broken code sample on a heavily trafficked page
     * Errors on a “getting started” page
     * Well known or highly publicized customer pain points
     * Automation issues
     
    -#### P2
    +### P2
     * Default for all new issues
     * Broken code for sample that is not heavily used
     * Minor content issues in a heavily trafficked page
    -* Major content issues on a lower-trafficked page 
    +* Major content issues on a lower-trafficked page
     
    -#### P3
    +### P3
     * Typos and broken anchor links
     
    -### Handling special issue types
    +## Handling special issue types
     
    -#### Duplicate issues
    +### Duplicate issues
     If a single problem has one or more issues open for it, the problem should be consolodated into a single issue. You should decide which issue to keep open (or open a new issue), port over all relevant information, link related issues, and close all the other issues that describe the same problem. Only having a single issue to work on will help reduce confusion and avoid duplicating work on the same problem.
     
    -#### Dead link issues
    -Depending on where the dead link is reported, different actions are required to resolve the issue. Dead links in the API and Kubectl docs are automation issues and should be assigned a P1 until the problem can be fully understood. All other dead links are issues that need to be manually fixed and can be assigned a P3. 
    +### Dead link issues
    +Depending on where the dead link is reported, different actions are required to resolve the issue. Dead links in the API and Kubectl docs are automation issues and should be assigned a P1 until the problem can be fully understood. All other dead links are issues that need to be manually fixed and can be assigned a P3.
     
     {% endcapture %}
     
    diff --git a/docs/contribute/stage-documentation-changes.md b/docs/contribute/stage-documentation-changes.md
    index 50e22a1b8b..452c38170c 100644
    --- a/docs/contribute/stage-documentation-changes.md
    +++ b/docs/contribute/stage-documentation-changes.md
    @@ -14,7 +14,7 @@ Create a fork of the Kubernetes documentation repository as described in
     
     {% capture steps %}
     
    -### Staging from your GitHub account
    +## Staging from your GitHub account
     
     GitHub provides staging of content in your master branch. Note that you
     might not want to merge your changes into your master branch. If that is
    @@ -32,7 +32,7 @@ the master branch.
     
             https://.github.io
     
    -### Staging a pull request
    +## Staging a pull request
     
     When you create a pull request, either against the master or <vnext>
     branch, your changes are staged in a custom subdomain on Netlify so that
    @@ -47,7 +47,7 @@ Wait for the **deploy/netlify** check to complete. To the right of
     **deploy/netlify**, click **Details**. This opens a staging site where you
     can see your changes.
     
    -### Staging locally using Docker
    +## Staging locally using Docker
     
     You can use the k8sdocs Docker image to run a local staging server. If you're
     interested, you can view the
    @@ -66,7 +66,7 @@ web server:
     1. View your staged content at
     [http://localhost:4000](http://localhost:4000){: target="_blank"}.
     
    -### Staging locally without Docker
    +## Staging locally without Docker
     
     1. [Install Ruby 2.2 or later](https://www.ruby-lang.org){: target="_blank"}.
     
    diff --git a/docs/contribute/style-guide.md b/docs/contribute/style-guide.md
    index 47d3cd75c0..6bb1aa5837 100644
    --- a/docs/contribute/style-guide.md
    +++ b/docs/contribute/style-guide.md
    @@ -15,9 +15,9 @@ docs, follow the instructions on
     
     {% capture body %}
     
    -### Documentation formatting standards
    +## Documentation formatting standards
     
    -#### Use Camel Case for API objects
    +### Use Camel Case for API objects
     
     When you refer to an API object, use the same uppercase and lowercase letters
     that are used in the actual object name. Typically, the names of API
    @@ -39,7 +39,7 @@ leads to an awkward construction.
       The two ContainerStateTerminated objects ...The two ContainerStateTerminateds ...
     
     
    -#### Use angle brackets for placeholders
    +### Use angle brackets for placeholders
     
     Use angle brackets for placeholders. Tell the reader what a placeholder
     represents.
    @@ -50,7 +50,7 @@ represents.
     
         where `` is the name of one of your pods.
     
    -#### Use bold for user interface elements
    +### Use bold for user interface elements
     
     
    @@ -58,7 +58,7 @@ represents.
       
    DoDon't
    Select Other.Select 'Other'.
    -#### Use italics to define or introduce new terms +### Use italics to define or introduce new terms @@ -66,7 +66,7 @@ represents.
    DoDon't
    These components form the control plane.These components form the control plane.
    -#### Use code style for filenames, directories, and paths +### Use code style for filenames, directories, and paths @@ -75,9 +75,9 @@ represents.
    DoDon't
    Open the /_data/concepts.yaml file.Open the /_data/concepts.yaml file.
    -### Code snippet formatting +## Code snippet formatting -#### Use code style for inline code and commands +### Use code style for inline code and commands For inline code in an HTML document, use the `` tag. In a Markdown document, use the backtick (`). @@ -88,14 +88,14 @@ document, use the backtick (`). The kubectl run command creates a Deployment.The "kubectl run" command creates a Deployment. -#### Don't include the command prompt +### Don't include the command prompt
    DoDon't
    kubectl get pods$ kubectl get pods
    -#### Separate commands from output +### Separate commands from output Verify that the pod is running on your chosen node: @@ -117,11 +117,11 @@ A list of Kubernetes-specific terms and words to be used consistently across the {% endcomment %} -### Content best practices +## Content best practices This section contains suggested best practices for clear, concise, and consistent content. -#### Use present tense +### Use present tense @@ -131,7 +131,7 @@ This section contains suggested best practices for clear, concise, and consisten Exception: Use future or past tense if it is required to convey the correct meaning. -#### Use active voice +### Use active voice
    DoDon't
    @@ -141,7 +141,7 @@ meaning. Exception: Use passive voice if active voice leads to an awkward construction. -#### Use simple and direct language +### Use simple and direct language Use simple and direct language. Avoid using unnecessary phrases, such as saying "please." @@ -153,7 +153,7 @@ Use simple and direct language. Avoid using unnecessary phrases, such as saying
    DoDon't
    -#### Address the reader as "you" +### Address the reader as "you" @@ -161,9 +161,9 @@ Use simple and direct language. Avoid using unnecessary phrases, such as saying
    DoDon't
    In the preceding output, you can see...In the preceding output, we can see ...
    -### Patterns to avoid +## Patterns to avoid -#### Avoid using "we" +### Avoid using "we" Using "we" in a sentence can be confusing, because the reader might not know whether they're part of the "we" you're describing. @@ -175,7 +175,7 @@ whether they're part of the "we" you're describing. This page teaches you how to use pods.In this page, we are going to learn about pods. -#### Avoid jargon and idioms +### Avoid jargon and idioms Some readers speak English as a second language. Avoid jargon and idioms to help make their understanding easier. @@ -185,13 +185,13 @@ Some readers speak English as a second language. Avoid jargon and idioms to help Create a new cluster.Turn up a new cluster. -#### Avoid statements about the future +### Avoid statements about the future Avoid making promises or giving hints about the future. If you need to talk about an alpha feature, put the text under a heading that identifies it as alpha information. -#### Avoid statements that will soon be out of date +### Avoid statements that will soon be out of date Avoid words like "currently" and "new." A feature that is new today might not be considered new in a few months. diff --git a/docs/contribute/write-new-topic.md b/docs/contribute/write-new-topic.md index 3ecae45674..52256390da 100644 --- a/docs/contribute/write-new-topic.md +++ b/docs/contribute/write-new-topic.md @@ -13,7 +13,7 @@ Create a fork of the Kubernetes documentation repository as described in {% capture steps %} -### Choosing a page type +## Choosing a page type As you prepare to write a new topic, think about which of these page types is the best fit for your content: @@ -42,7 +42,7 @@ Each page type has a that you can use as you write your topic. Using templates helps ensure consistency among topics of a given type. -### Choosing a title and filename +## Choosing a title and filename Choose a title that has the keywords you want search engines to find. Create a filename that uses the words in your title separated by hyphens. @@ -54,18 +54,18 @@ URL for the topic, for example: http://kubernetes.io/docs/tasks/access-kubernetes-api/http-proxy-access-api/ -### Adding the topic title to the front matter +## Adding the topic title to the front matter In your topic, put a `title` field in the [front matter](https://jekyllrb.com/docs/frontmatter/). -The front matter is the YAML block that is between the +The front matter is the YAML block that is between the triple-dashed lines at the top of the page. Here's an example: --- title: Using an HTTP Proxy to Access the Kubernetes API --- -### Choosing a directory +## Choosing a directory Depending on your page type, put your new file in a subdirectory of one of these: @@ -76,7 +76,7 @@ Depending on your page type, put your new file in a subdirectory of one of these You can put your file in an existing subdirectory, or you can create a new subdirectory. -### Creating an entry in the table of contents +## Creating an entry in the table of contents Depending page type, create an entry in one of these files: @@ -88,7 +88,7 @@ Here's an example of an entry in /_data/tasks.yaml: - docs/tasks/configure-pod-container/configure-volume-storage.md -### Including code from another file +## Including code from another file To include a code file in your topic, place the code file in the Kubernetes documentation repository, preferably in the same directory as your topic @@ -107,7 +107,7 @@ Here's an example of using the `include` tag:
    {% include code.html language="yaml" file="gce-volume.yaml" ghlink="/docs/tutorials/stateful-application/gce-volume.yaml" %}
    -### Showing how to create an API object from a configuration file +## Showing how to create an API object from a configuration file If you need to show the reader how to create an API object based on a configuration file, place the configuration file in the Kubernetes documentation @@ -127,7 +127,7 @@ Here's an example of a command that creates an API object from a configuration f For an example of a topic that uses this technique, see [Running a Single-Instance Stateful Application](/docs/tutorials/stateful-application/run-stateful-application/). -### Adding images to a topic +## Adding images to a topic Put image files in the `/images` directory. The preferred image format is SVG. diff --git a/docs/getting-started-guides/kargo.md b/docs/getting-started-guides/kargo.md new file mode 100644 index 0000000000..0a2e1d1c44 --- /dev/null +++ b/docs/getting-started-guides/kargo.md @@ -0,0 +1,104 @@ +--- +title: Installing Kubernetes On-premise/Cloud Providers with Kargo +--- + + + +## Overview + +This quickstart helps to install a Kubernetes cluster hosted +on GCE, Azure, OpenStack, AWS or Baremetal with +[`Kargo`](https://github.com/kubernetes-incubator/kargo) tool. + +Kargo is a composition of [Ansible](http://docs.ansible.com/) playbooks, +[inventory](https://github.com/kubernetes-incubator/kargo/blob/master/docs/ansible.md) +generation CLI tools and domain knowledge for generic OS/Kubernetes +clusters configuration management tasks. It provides: + +* [High available cluster](https://github.com/kubernetes-incubator/kargo/blob/master/docs/ha-mode.md) +* [Composable](https://github.com/kubernetes-incubator/kargo/blob/master/docs/vars.md) + (Choice of the network plugin, for instance) +* Support most popular Linux + [distributions](https://github.com/kubernetes-incubator/kargo#supported-linux-distributions) +* Continuous integration tests + +To choose a tool which fits your use case the best, you may want to read this +[comparison](https://github.com/kubernetes-incubator/kargo/blob/master/docs/comparisons.md) +to [kubeadm](../kubeadm) and [kops](../kops). + +## Creating a cluster + +### (1/4) Ensure the underlay [requirements](https://github.com/kubernetes-incubator/kargo#requirements) are met + +#### Checklist + +* You must have cloud instances or baremetal nodes running for your future Kubernetes cluster. + A way to achieve that is to use the + [kargo-cli tool](https://github.com/kubernetes-incubator/kargo/blob/master/docs/getting-started.md). +* Or provision baremetal hosts with a tool-of-your-choice or launch cloud instances, + then create an inventory file for Ansible with this [tool](https://github.com/kubernetes-incubator/kargo/blob/master/contrib/inventory_builder/inventory.py). + +### (2/4) Compose the deployment + +#### Checklist + +* Customize your deployment by usual Ansible meanings, which is + [generating inventory](https://github.com/kubernetes-incubator/kargo/blob/master/docs/getting-started.md#building-your-own-inventory) + and overriding default data [variables](https://github.com/kubernetes-incubator/kargo/blob/master/docs/vars.md). + Or just stick with default values (Kargo will choose Flannel networking plugin for you + then). This includes steps like deciding on the: + * DNS [configuration options](https://github.com/kubernetes-incubator/kargo/blob/master/docs/dns-stack.md) + * [Networking plugin](https://github.com/kubernetes-incubator/kargo#network-plugins) to use + * [Versions](https://github.com/kubernetes-incubator/kargo#versions-of-supported-components) + of components. + * Additional node groups like [bastion hosts](https://github.com/kubernetes-incubator/kargo/blob/master/docs/ansible.md#bastion-host) or + [Calico BGP route reflectors](https://github.com/kubernetes-incubator/kargo/blob/master/docs/calico.md#optional--bgp-peering-with-border-routers). +* Plan custom deployment steps, if any, or use the default composition layer in the + [cluster definition file](https://github.com/kubernetes-incubator/kargo/blob/master/cluster.yml). + Taking the best from Ansible world, Kargo allows users to execute arbitrary steps via the + ``ansible-playbook`` with given inventory, playbooks, data overrides and tags, limits, batches + of nodes to deploy and so on. +* For large deployments (100+ nodes), you may want to + [tweak things](https://github.com/kubernetes-incubator/kargo/blob/master/docs/large-deployments.md) + for best results. + +### (3/4) Run the deployment + +#### Checklist + +* Apply deployment with + [kargo-cli tool](https://github.com/kubernetes-incubator/kargo/blob/master/docs/getting-started.md) + or ``ansible-playbook`` + [manual commands](https://github.com/kubernetes-incubator/kargo/blob/master/docs/getting-started.md#starting-custom-deployment). + +### (4/4) (Optional) verify inter-pods connectivity and DNS resolve with [Netchecker](https://github.com/kubernetes-incubator/kargo/blob/master/docs/netcheck.md) + +#### Checklist + +* Enusre the netchecker-agent's pods can resolve DNS requests and ping each over within the default namespace. + Those pods mimic similar behavior of the rest of the workloads and serve as cluster health indicators. + +## Explore contributed add-ons + +See the [list of contributed playbooks](https://github.com/kubernetes-incubator/kargo/tree/master/contrib) +to explore other deployment options. + +## What's next + +Kargo has quite a few [marks on the radar](https://github.com/kubernetes-incubator/kargo/blob/master/docs/roadmap.md). + +## Cleanup + +To delete your scratch cluster, you can apply the +[reset role](https://github.com/kubernetes-incubator/kargo/blob/master/roles/reset/tasks/main.yml) +with the manual ``ansible-playbook`` command. + +Note, that it is highly unrecommended to delete production clusters with the reset playbook! + +## Feedback + +* Slack Channel: [#kargo](https://kubernetes.slack.com/messages/kargo/) +* [GitHub Issues](https://github.com/kubernetes-incubator/kargo/issues) + diff --git a/docs/getting-started-guides/minikube.md b/docs/getting-started-guides/minikube.md index 7e47aeadd6..4f4a432185 100644 --- a/docs/getting-started-guides/minikube.md +++ b/docs/getting-started-guides/minikube.md @@ -1,8 +1,8 @@ --- assignees: - dlorenc -- janetkuo -- jlowdermilk +- r2d4 +- aaron-prindle title: Running Kubernetes Locally via Minikube --- @@ -27,23 +27,11 @@ Minikube is a tool that makes it easy to run Kubernetes locally. Minikube runs a ### Requirements * OS X - * [xhyve driver](./DRIVERS.md#xhyve-driver), [VirtualBox](https://www.virtualbox.org/wiki/Downloads) or [VMware Fusion](https://www.vmware.com/products/fusion) installation + * [xhyve driver](https://github.com/kubernetes/minikube/blob/master/DRIVERS.md#xhyve-driver), [VirtualBox](https://www.virtualbox.org/wiki/Downloads) or [VMware Fusion](https://www.vmware.com/products/fusion) installation * Linux * [VirtualBox](https://www.virtualbox.org/wiki/Downloads) or [KVM](http://www.linux-kvm.org/) installation, * VT-x/AMD-v virtualization must be enabled in BIOS -* `kubectl` must be on your path. To install kubectl: - -**Kubectl for Linux/amd64** - -``` -curl -Lo kubectl http://storage.googleapis.com/kubernetes-release/release/{{page.version}}/bin/linux/amd64/kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin/ -``` - -**Kubectl for OS X/amd64** - -``` -curl -Lo kubectl http://storage.googleapis.com/kubernetes-release/release/{{page.version}}/bin/darwin/amd64/kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin/ -``` +* `kubectl` See the [kubectl installation instructions](/docs/getting-started-guides/kubectl/) for more details. ### Instructions @@ -57,8 +45,8 @@ the following drivers: * virtualbox * vmwarefusion -* kvm ([driver installation](./DRIVERS.md#kvm-driver)) -* xhyve ([driver installation](./DRIVERS.md#xhyve-driver)) +* kvm ([driver installation](https://github.com/kubernetes/minikube/blob/master/DRIVERS.md#kvm-driver)) +* xhyve ([driver installation](https://github.com/kubernetes/minikube/blob/master/DRIVERS.md#xhyve-driver)) Note that the IP below is dynamic and can change. It can be retrieved with `minikube ip`. @@ -111,7 +99,7 @@ This will use an alternative minikube ISO image containing both rkt, and Docker, ### Driver plugins -See [DRIVERS](./DRIVERS.md) for details on supported drivers and how to install +See [DRIVERS](https://github.com/kubernetes/minikube/blob/master/DRIVERS.md) for details on supported drivers and how to install plugins, if required. ### Reusing the Docker daemon @@ -150,7 +138,7 @@ Remember to turn off the imagePullPolicy:Always, as otherwise Kubernetes won't u ### Starting a Cluster -The [minikube start](./docs/minikube_start.md) command can be used to start your cluster. +The [minikube start](https://github.com/kubernetes/minikube/blob/master/docs/minikube_start.md) command can be used to start your cluster. This command creates and configures a virtual machine that runs a single-node Kubernetes cluster. This command also configures your [kubectl](http://kubernetes.io/docs/user-guide/kubectl-overview/) installation to communicate with this cluster. @@ -175,7 +163,7 @@ This flag is repeated, so you can pass it several times with several different v This flag takes a string of the form `component.key=value`, where `component` is one of the strings from the above list, `key` is a value on the configuration struct and `value` is the value to set. -Valid `key`s can be found by examining the documentation for the Kubernetes `componentconfigs` for each component. +Valid `key`s can be found by examining the documentation for the Kubernetes `componentconfigs` for each component. Here is the documentation for each supported configuration: * [kubelet](https://godoc.org/k8s.io/kubernetes/pkg/apis/componentconfig#KubeletConfiguration) @@ -191,15 +179,15 @@ To change the `MaxPods` setting to 5 on the Kubelet, pass this flag: `--extra-co This feature also supports nested structs. To change the `LeaderElection.LeaderElect` setting to `true` on the scheduler, pass this flag: `--extra-config=scheduler.LeaderElection.LeaderElect=true`. -To set the `AuthorizationMode` on the `apiserver` to `RBAC`, you can use: `--extra-config=apiserver.AuthorizationMode=RBAC`. +To set the `AuthorizationMode` on the `apiserver` to `RBAC`, you can use: `--extra-config=apiserver.AuthorizationMode=RBAC`. ### Stopping a Cluster -The [minikube stop](./docs/minikube_stop.md) command can be used to stop your cluster. +The [minikube stop](https://github.com/kubernetes/minikube/blob/master/docs/minikube_stop.md) command can be used to stop your cluster. This command shuts down the minikube virtual machine, but preserves all cluster state and data. Starting the cluster again will restore it to it's previous state. ### Deleting a Cluster -The [minikube delete](./docs/minikube_delete.md) command can be used to delete your cluster. +The [minikube delete](https://github.com/kubernetes/minikube/blob/master/docs/minikube_delete.md) command can be used to delete your cluster. This command shuts down and deletes the minikube virtual machine. No data or state is preserved. ## Interacting With your Cluster @@ -288,7 +276,7 @@ In order to have minikube properly start/restart custom addons, place the addon( ## Documentation -For a list of minikube's available commands see the [full CLI docs](./docs/minikube.md). +For a list of minikube's available commands see the [full CLI docs](https://github.com/kubernetes/minikube/blob/master/docs/minikube.md). ## Using Minikube with an HTTP Proxy diff --git a/docs/getting-started-guides/scratch.md b/docs/getting-started-guides/scratch.md index 9b53e28e78..f95f132be6 100644 --- a/docs/getting-started-guides/scratch.md +++ b/docs/getting-started-guides/scratch.md @@ -405,7 +405,7 @@ Arguments to consider: - `--cluster-domain=` to the dns domain prefix to use for cluster DNS addresses. - `--docker-root=` - `--root-dir=` - - `--configure-cbr0=` (described above) + - `--configure-cbr0=` (described below) - `--register-node` (described in [Node](/docs/admin/node) documentation.) ### kube-proxy @@ -774,10 +774,8 @@ Template for controller manager pod: Flags to consider using with controller manager: - `--cluster-name=$CLUSTER_NAME` - - `--cluster-cidr=` - - *TODO*: explain this flag. - - `--allocate-node-cidrs=` - - *TODO*: explain when you want controller to do this and when you want to do it another way. + - `--cluster-cidr=`, the CIDR range for pods in cluster. + - `--allocate-node-cidrs=`, if you are using `--cloud-provider=`, allocate and set the CIDRs for pods on the cloud provider. - `--cloud-provider=` and `--cloud-config` as described in apiserver section. - `--service-account-private-key-file=/srv/kubernetes/server.key`, used by the [service account](/docs/user-guide/service-accounts) feature. - `--master=127.0.0.1:8080` diff --git a/docs/getting-started-guides/ubuntu/index.md b/docs/getting-started-guides/ubuntu/index.md index 9fa4728bed..5e706f0add 100644 --- a/docs/getting-started-guides/ubuntu/index.md +++ b/docs/getting-started-guides/ubuntu/index.md @@ -9,11 +9,27 @@ There are multiple ways to run a Kubernetes cluster with Ubuntu. These pages exp {% capture body %} ## Official Ubuntu Guides -- [The Canonical Distribution of Kubernetes](/docs/getting-started-guides/ubuntu) +- [The Canonical Distribution of Kubernetes](https://www.ubuntu.com/cloud/kubernetes) Supports AWS, GCE, Azure, Joyent, OpenStack, Bare Metal and local workstation deployment. -### Operational Guides +### Quick Start + +[conjure-up](http://conjure-up.io/) provides quick wasy to deploy Kubernetes on multiple clouds and bare metal. It provides a user-friendly UI that prompts you for cloud credentials and configuration options: + +Available for Ubuntu 16.04 and newer: + +``` +sudo apt-add-repository ppa:juju/stable +sudo apt-add-repository ppa:conjure-up/next +sudo apt update +sudo apt install conjure-up +conjure-up +``` + +### Operational Guides + +These are more in-depth guides for users choosing to run Kubernetes in production: - [Installation](/docs/getting-started-guides/ubuntu/installation) - [Validation](/docs/getting-started-guides/ubuntu/validation) diff --git a/docs/getting-started-guides/ubuntu/installation.md b/docs/getting-started-guides/ubuntu/installation.md index b8f892dc46..cc93995144 100644 --- a/docs/getting-started-guides/ubuntu/installation.md +++ b/docs/getting-started-guides/ubuntu/installation.md @@ -38,7 +38,8 @@ so we can find them. - OpenStack deployments are currently only tested on Icehouse and newer. - Network access to the following domains - *.jujucharms.com - - gcr.io + - gcr.io + - github.com - Access to an Ubuntu mirror (public or private) diff --git a/docs/getting-started-guides/ubuntu/networking.md b/docs/getting-started-guides/ubuntu/networking.md index 7b4d3bcb28..54ca15c6ad 100644 --- a/docs/getting-started-guides/ubuntu/networking.md +++ b/docs/getting-started-guides/ubuntu/networking.md @@ -9,7 +9,7 @@ This page shows how to the various network portions of a cluster work, and how t This page assumes you have a working Juju deployed cluster. {% endcapture %} -Kubernetes supports the [Container Network Interface (CNI)]](https://github.com/containernetworking/cni). +Kubernetes supports the [Container Network Interface (CNI)](https://github.com/containernetworking/cni). This is a network plugin architecture that allows you to use whatever Kubernetes-friendly SDN you want. Currently this means support for Flannel. @@ -50,4 +50,4 @@ how large your cluster will potentially scale. Class A IP ranges with /24 are a good option. {% endcapture %} -{% include templates/task.md %} \ No newline at end of file +{% include templates/task.md %} diff --git a/docs/getting-started-guides/vsphere.md b/docs/getting-started-guides/vsphere.md index 36372144c6..ba07d14890 100644 --- a/docs/getting-started-guides/vsphere.md +++ b/docs/getting-started-guides/vsphere.md @@ -79,7 +79,7 @@ Sample Config: #### Known issues * [Volumes are not removed from a VM configuration if the VM is down](https://github.com/kubernetes/kubernetes/issues/33061). The workaround is to manually remove the disk from VM settings before powering it up. -* [FS groups are not supported in 1.4.7](https://github.com/kubernetes/kubernetes/issues/34039) +* [FS groups are not supported in 1.4.7](https://github.com/kubernetes/kubernetes/issues/34039) - This issue is fixed in 1.4.8 ### Kube-up (Deprecated) diff --git a/docs/index.md b/docs/index.md index 24814e55ae..1201403936 100644 --- a/docs/index.md +++ b/docs/index.md @@ -20,6 +20,7 @@ title: Kubernetes Documentation
  • Minikube: Install a single-node Kubernetes cluster on your local machine for development and testing.
  • Installing Kubernetes on AWS with kops: Bring up a complete Kubernetes cluster on Amazon Web Services, using a tool called kops.
  • Installing Kubernetes on Linux with kubeadm (Alpha): Install a secure Kubernetes cluster on any pre-existing machines running Linux, using the built-in kubeadm tool.
  • +
  • Installing Kubernetes On-premise/Cloud Providers with Kargo: Deploy a Kubernetes cluster on-premise baremetal or hosted on cloud providers, with Ansible and kargo tools.
  • Guides, Tutorials, Tasks, and Concepts

    diff --git a/docs/resources-reference/v1.5/documents/_cluster.md b/docs/resources-reference/v1.5/documents/_cluster.md deleted file mode 100644 index 5c74168efb..0000000000 --- a/docs/resources-reference/v1.5/documents/_cluster.md +++ /dev/null @@ -1,5 +0,0 @@ -# CLUSTER - -Cluster resources are responsible for defining configuration of the cluster itself, and are generally only used by cluster operators. - ------------- diff --git a/docs/resources-reference/v1.5/documents/_config.md b/docs/resources-reference/v1.5/documents/_config.md deleted file mode 100644 index 555578e2b3..0000000000 --- a/docs/resources-reference/v1.5/documents/_config.md +++ /dev/null @@ -1,11 +0,0 @@ -# CONFIG & STORAGE - -Config and Storage resources are responsible for injecting data into your applications and persisting data externally to your container. - -Common resource types: - -- [ConfigMaps](#configmap-v1) for providing text key value pairs injected into the application through environment variables, command line arguments, or files -- [Secrets](#secret-v1) for providing binary data injected into the application through files -- [Volumes](#volume-v1) for providing a filesystem external to the Container. Maybe shared across Containers within the same Pod and have a lifetime persisting beyond a Container or Pod. - ------------- diff --git a/docs/resources-reference/v1.5/documents/_definitions.md b/docs/resources-reference/v1.5/documents/_definitions.md deleted file mode 100644 index 337695b8d5..0000000000 --- a/docs/resources-reference/v1.5/documents/_definitions.md +++ /dev/null @@ -1,3 +0,0 @@ -# DEFINITIONS - -This section contains definitions for objects used in the Kubernetes APIs. diff --git a/docs/resources-reference/v1.5/documents/_generated_apigroup_unversioned_concept.md b/docs/resources-reference/v1.5/documents/_generated_apigroup_unversioned_concept.md deleted file mode 100644 index d4732c1cea..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_apigroup_unversioned_concept.md +++ /dev/null @@ -1,46 +0,0 @@ - - ------------ -# APIGroup unversioned - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIGroup - - - - - - - -APIGroup contains the name, the supported versions, and the preferred version of a group. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -name
    *string* | name is the name of the group. -preferredVersion
    *[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned)* | preferredVersion is the version preferred by the API server, which probably is the storage version. -serverAddressByClientCIDRs
    *[ServerAddressByClientCIDR](#serveraddressbyclientcidr-unversioned) array* | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. -versions
    *[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned) array* | versions are the versions supported in this group. - - -### APIGroupList unversioned - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -groups
    *[APIGroup](#apigroup-unversioned) array* | groups is a list of APIGroup. -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_apigroup_unversioned_definition.md b/docs/resources-reference/v1.5/documents/_generated_apigroup_unversioned_definition.md deleted file mode 100644 index d6d1173eb5..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_apigroup_unversioned_definition.md +++ /dev/null @@ -1,22 +0,0 @@ -## APIGroup unversioned - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIGroup - - - -APIGroup contains the name, the supported versions, and the preferred version of a group. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -name
    *string* | name is the name of the group. -preferredVersion
    *[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned)* | preferredVersion is the version preferred by the API server, which probably is the storage version. -serverAddressByClientCIDRs
    *[ServerAddressByClientCIDR](#serveraddressbyclientcidr-unversioned) array* | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. -versions
    *[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned) array* | versions are the versions supported in this group. - diff --git a/docs/resources-reference/v1.5/documents/_generated_apigrouplist_unversioned_concept.md b/docs/resources-reference/v1.5/documents/_generated_apigrouplist_unversioned_concept.md deleted file mode 100644 index 99c9d0d8fe..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_apigrouplist_unversioned_concept.md +++ /dev/null @@ -1,32 +0,0 @@ - - ------------ -# APIGroupList unversioned - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIGroupList - - - - - - - -APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -groups
    *[APIGroup](#apigroup-unversioned) array* | groups is a list of APIGroup. -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_apigrouplist_unversioned_definition.md b/docs/resources-reference/v1.5/documents/_generated_apigrouplist_unversioned_definition.md deleted file mode 100644 index 6267bf8f48..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_apigrouplist_unversioned_definition.md +++ /dev/null @@ -1,18 +0,0 @@ -## APIGroupList unversioned - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIGroupList - - - -APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -groups
    *[APIGroup](#apigroup-unversioned) array* | groups is a list of APIGroup. -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds - diff --git a/docs/resources-reference/v1.5/documents/_generated_apiresource_unversioned_concept.md b/docs/resources-reference/v1.5/documents/_generated_apiresource_unversioned_concept.md deleted file mode 100644 index 2f87ebff79..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_apiresource_unversioned_concept.md +++ /dev/null @@ -1,44 +0,0 @@ - - ------------ -# APIResource unversioned - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIResource - - - - - - - -APIResource specifies the name of a resource and whether it is namespaced. - - - -Field | Description ------------- | ----------- -kind
    *string* | kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo') -name
    *string* | name is the name of the resource. -namespaced
    *boolean* | namespaced indicates if a resource is namespaced or not. - - -### APIResourceList unversioned - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -groupVersion
    *string* | groupVersion is the group and version this APIResourceList is for. -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -resources
    *[APIResource](#apiresource-unversioned) array* | resources contains the name of the resources and if they are namespaced. - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_apiresource_unversioned_definition.md b/docs/resources-reference/v1.5/documents/_generated_apiresource_unversioned_definition.md deleted file mode 100644 index dd9cd0a727..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_apiresource_unversioned_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## APIResource unversioned - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIResource - - - -APIResource specifies the name of a resource and whether it is namespaced. - - - -Field | Description ------------- | ----------- -kind
    *string* | kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo') -name
    *string* | name is the name of the resource. -namespaced
    *boolean* | namespaced indicates if a resource is namespaced or not. - diff --git a/docs/resources-reference/v1.5/documents/_generated_apiresourcelist_unversioned_concept.md b/docs/resources-reference/v1.5/documents/_generated_apiresourcelist_unversioned_concept.md deleted file mode 100644 index 5bb170d54c..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_apiresourcelist_unversioned_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# APIResourceList unversioned - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | 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. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -groupVersion
    *string* | groupVersion is the group and version this APIResourceList is for. -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -resources
    *[APIResource](#apiresource-unversioned) array* | resources contains the name of the resources and if they are namespaced. - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_apiresourcelist_unversioned_definition.md b/docs/resources-reference/v1.5/documents/_generated_apiresourcelist_unversioned_definition.md deleted file mode 100644 index b5b7649e2f..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_apiresourcelist_unversioned_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## APIResourceList unversioned - -Group | Version | Kind ------------- | ---------- | ----------- -Core | 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. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -groupVersion
    *string* | groupVersion is the group and version this APIResourceList is for. -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -resources
    *[APIResource](#apiresource-unversioned) array* | resources contains the name of the resources and if they are namespaced. - diff --git a/docs/resources-reference/v1.5/documents/_generated_apiversion_v1beta1_concept.md b/docs/resources-reference/v1.5/documents/_generated_apiversion_v1beta1_concept.md deleted file mode 100644 index eed2e554dc..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_apiversion_v1beta1_concept.md +++ /dev/null @@ -1,31 +0,0 @@ - - ------------ -# APIVersion v1beta1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1beta1 | APIVersion - - - - - - - -An APIVersion represents a single concrete version of an object model. - - - -Field | Description ------------- | ----------- -name
    *string* | Name of this version (e.g. 'v1'). - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_apiversion_v1beta1_definition.md b/docs/resources-reference/v1.5/documents/_generated_apiversion_v1beta1_definition.md deleted file mode 100644 index aecfdceaf7..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_apiversion_v1beta1_definition.md +++ /dev/null @@ -1,17 +0,0 @@ -## APIVersion v1beta1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1beta1 | APIVersion - - - -An APIVersion represents a single concrete version of an object model. - - - -Field | Description ------------- | ----------- -name
    *string* | Name of this version (e.g. 'v1'). - diff --git a/docs/resources-reference/v1.5/documents/_generated_apiversions_unversioned_concept.md b/docs/resources-reference/v1.5/documents/_generated_apiversions_unversioned_concept.md deleted file mode 100644 index 31aa6a658a..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_apiversions_unversioned_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# APIVersions unversioned - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIVersions - - - - - - - -APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -serverAddressByClientCIDRs
    *[ServerAddressByClientCIDR](#serveraddressbyclientcidr-unversioned) array* | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. -versions
    *string array* | versions are the api versions that are available. - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_apiversions_unversioned_definition.md b/docs/resources-reference/v1.5/documents/_generated_apiversions_unversioned_definition.md deleted file mode 100644 index 3513f89da7..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_apiversions_unversioned_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## APIVersions unversioned - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIVersions - - - -APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -serverAddressByClientCIDRs
    *[ServerAddressByClientCIDR](#serveraddressbyclientcidr-unversioned) array* | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. -versions
    *string array* | versions are the api versions that are available. - diff --git a/docs/resources-reference/v1.5/documents/_generated_attachedvolume_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_attachedvolume_v1_concept.md deleted file mode 100644 index 7ec6b04185..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_attachedvolume_v1_concept.md +++ /dev/null @@ -1,32 +0,0 @@ - - ------------ -# AttachedVolume v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | AttachedVolume - - - - - - - -AttachedVolume describes a volume attached to a node - - - -Field | Description ------------- | ----------- -devicePath
    *string* | DevicePath represents the device path where the volume should be available -name
    *string* | Name of the attached volume - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_attachedvolume_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_attachedvolume_v1_definition.md deleted file mode 100644 index ae5004c11a..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_attachedvolume_v1_definition.md +++ /dev/null @@ -1,18 +0,0 @@ -## AttachedVolume v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | AttachedVolume - - - -AttachedVolume describes a volume attached to a node - - - -Field | Description ------------- | ----------- -devicePath
    *string* | DevicePath represents the device path where the volume should be available -name
    *string* | Name of the attached volume - diff --git a/docs/resources-reference/v1.5/documents/_generated_awselasticblockstorevolumesource_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_awselasticblockstorevolumesource_v1_concept.md deleted file mode 100644 index 9dda8fcf2a..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_awselasticblockstorevolumesource_v1_concept.md +++ /dev/null @@ -1,36 +0,0 @@ - - ------------ -# AWSElasticBlockStoreVolumeSource v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | 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. - - - -Field | Description ------------- | ----------- -fsType
    *string* | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore -partition
    *integer* | The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). -readOnly
    *boolean* | Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore -volumeID
    *string* | Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_awselasticblockstorevolumesource_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_awselasticblockstorevolumesource_v1_definition.md deleted file mode 100644 index 3c4d7e2d21..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_awselasticblockstorevolumesource_v1_definition.md +++ /dev/null @@ -1,22 +0,0 @@ -## AWSElasticBlockStoreVolumeSource v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | 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. - - - -Field | Description ------------- | ----------- -fsType
    *string* | Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore -partition
    *integer* | The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). -readOnly
    *boolean* | Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore -volumeID
    *string* | Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore - diff --git a/docs/resources-reference/v1.5/documents/_generated_azurediskvolumesource_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_azurediskvolumesource_v1_concept.md deleted file mode 100644 index 1043b9d9ae..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_azurediskvolumesource_v1_concept.md +++ /dev/null @@ -1,35 +0,0 @@ - - ------------ -# AzureDiskVolumeSource v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | AzureDiskVolumeSource - - - - - - - -AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. - - - -Field | Description ------------- | ----------- -cachingMode
    *string* | Host Caching mode: None, Read Only, Read Write. -diskName
    *string* | The Name of the data disk in the blob storage -diskURI
    *string* | The URI the data disk in the blob storage -fsType
    *string* | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. -readOnly
    *boolean* | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_azurediskvolumesource_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_azurediskvolumesource_v1_definition.md deleted file mode 100644 index 191a407952..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_azurediskvolumesource_v1_definition.md +++ /dev/null @@ -1,21 +0,0 @@ -## AzureDiskVolumeSource v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | AzureDiskVolumeSource - - - -AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. - - - -Field | Description ------------- | ----------- -cachingMode
    *string* | Host Caching mode: None, Read Only, Read Write. -diskName
    *string* | The Name of the data disk in the blob storage -diskURI
    *string* | The URI the data disk in the blob storage -fsType
    *string* | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. -readOnly
    *boolean* | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. - diff --git a/docs/resources-reference/v1.5/documents/_generated_azurefilevolumesource_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_azurefilevolumesource_v1_concept.md deleted file mode 100644 index a9dc6186b1..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_azurefilevolumesource_v1_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# AzureFileVolumeSource v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | AzureFileVolumeSource - - - - - - - -AzureFile represents an Azure File Service mount on the host and bind mount to the pod. - - - -Field | Description ------------- | ----------- -readOnly
    *boolean* | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. -secretName
    *string* | the name of secret that contains Azure Storage Account Name and Key -shareName
    *string* | Share Name - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_azurefilevolumesource_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_azurefilevolumesource_v1_definition.md deleted file mode 100644 index 2382e73e4c..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_azurefilevolumesource_v1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## AzureFileVolumeSource v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | AzureFileVolumeSource - - - -AzureFile represents an Azure File Service mount on the host and bind mount to the pod. - - - -Field | Description ------------- | ----------- -readOnly
    *boolean* | Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. -secretName
    *string* | the name of secret that contains Azure Storage Account Name and Key -shareName
    *string* | Share Name - diff --git a/docs/resources-reference/v1.5/documents/_generated_binding_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_binding_v1_concept.md deleted file mode 100644 index ee02af2267..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_binding_v1_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# Binding v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | Binding - - - - - - - -Binding ties one object to another. For example, a pod is bound to a node by a scheduler. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata -target
    *[ObjectReference](#objectreference-v1)* | The target object that you want to bind to the standard object. - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_binding_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_binding_v1_definition.md deleted file mode 100644 index 32e2a31908..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_binding_v1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## Binding v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | Binding - - - -Binding ties one object to another. For example, a pod is bound to a node by a scheduler. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata -target
    *[ObjectReference](#objectreference-v1)* | The target object that you want to bind to the standard object. - diff --git a/docs/resources-reference/v1.5/documents/_generated_capabilities_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_capabilities_v1_concept.md deleted file mode 100644 index 6c47def7ef..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_capabilities_v1_concept.md +++ /dev/null @@ -1,32 +0,0 @@ - - ------------ -# Capabilities v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | Capabilities - - - - - - - -Adds and removes POSIX capabilities from running containers. - - - -Field | Description ------------- | ----------- -add
    *string array* | Added capabilities -drop
    *string array* | Removed capabilities - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_capabilities_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_capabilities_v1_definition.md deleted file mode 100644 index c18460bf9a..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_capabilities_v1_definition.md +++ /dev/null @@ -1,18 +0,0 @@ -## Capabilities v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | Capabilities - - - -Adds and removes POSIX capabilities from running containers. - - - -Field | Description ------------- | ----------- -add
    *string array* | Added capabilities -drop
    *string array* | Removed capabilities - diff --git a/docs/resources-reference/v1.5/documents/_generated_cephfsvolumesource_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_cephfsvolumesource_v1_concept.md deleted file mode 100644 index 1911dac73b..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_cephfsvolumesource_v1_concept.md +++ /dev/null @@ -1,36 +0,0 @@ - - ------------ -# CephFSVolumeSource v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | CephFSVolumeSource - - - - - - - -Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. - - - -Field | Description ------------- | ----------- -monitors
    *string array* | Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it -path
    *string* | Optional: Used as the mounted root, rather than the full Ceph tree, default is / -readOnly
    *boolean* | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it -secretFile
    *string* | Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it -secretRef
    *[LocalObjectReference](#localobjectreference-v1)* | Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it -user
    *string* | Optional: User is the rados user name, default is admin More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_cephfsvolumesource_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_cephfsvolumesource_v1_definition.md deleted file mode 100644 index d672f53c08..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_cephfsvolumesource_v1_definition.md +++ /dev/null @@ -1,22 +0,0 @@ -## CephFSVolumeSource v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | CephFSVolumeSource - - - -Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. - - - -Field | Description ------------- | ----------- -monitors
    *string array* | Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it -path
    *string* | Optional: Used as the mounted root, rather than the full Ceph tree, default is / -readOnly
    *boolean* | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it -secretFile
    *string* | Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it -secretRef
    *[LocalObjectReference](#localobjectreference-v1)* | Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it -user
    *string* | Optional: User is the rados user name, default is admin More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it - diff --git a/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequest_v1alpha1_concept.md b/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequest_v1alpha1_concept.md deleted file mode 100644 index 48755e9d1f..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequest_v1alpha1_concept.md +++ /dev/null @@ -1,68 +0,0 @@ - - ------------ -# CertificateSigningRequest v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequest - - - - - - - -Describes a certificate signing request - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ObjectMeta](#objectmeta-v1)* | -spec
    *[CertificateSigningRequestSpec](#certificatesigningrequestspec-v1alpha1)* | The certificate request itself and any additional information. -status
    *[CertificateSigningRequestStatus](#certificatesigningrequeststatus-v1alpha1)* | Derived information about the request. - - -### CertificateSigningRequestSpec v1alpha1 - - - -Field | Description ------------- | ----------- -groups
    *string array* | -request
    *string* | Base64-encoded PKCS#10 CSR data -uid
    *string* | -username
    *string* | Information about the requesting user (if relevant) See user.Info interface for details - -### CertificateSigningRequestStatus v1alpha1 - - - -Field | Description ------------- | ----------- -certificate
    *string* | If request was approved, the controller will place the issued certificate here. -conditions
    *[CertificateSigningRequestCondition](#certificatesigningrequestcondition-v1alpha1) array* | Conditions applied to the request, such as approval or denial. - -### CertificateSigningRequestList v1alpha1 - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
    *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1) array* | -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ListMeta](#listmeta-unversioned)* | - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequest_v1alpha1_definition.md b/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequest_v1alpha1_definition.md deleted file mode 100644 index 4e4341316e..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequest_v1alpha1_definition.md +++ /dev/null @@ -1,21 +0,0 @@ -## CertificateSigningRequest v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequest - - - -Describes a certificate signing request - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ObjectMeta](#objectmeta-v1)* | -spec
    *[CertificateSigningRequestSpec](#certificatesigningrequestspec-v1alpha1)* | The certificate request itself and any additional information. -status
    *[CertificateSigningRequestStatus](#certificatesigningrequeststatus-v1alpha1)* | Derived information about the request. - diff --git a/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequestcondition_v1alpha1_concept.md b/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequestcondition_v1alpha1_concept.md deleted file mode 100644 index b11023903e..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequestcondition_v1alpha1_concept.md +++ /dev/null @@ -1,34 +0,0 @@ - - ------------ -# CertificateSigningRequestCondition v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestCondition - - - - - - - - - - - -Field | Description ------------- | ----------- -lastUpdateTime
    *[Time](#time-unversioned)* | timestamp for the last update to this condition -message
    *string* | human readable message with details about the request state -reason
    *string* | brief reason for the request state -type
    *string* | request approval state, currently Approved or Denied. - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequestcondition_v1alpha1_definition.md b/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequestcondition_v1alpha1_definition.md deleted file mode 100644 index 4d6c34b60b..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequestcondition_v1alpha1_definition.md +++ /dev/null @@ -1,20 +0,0 @@ -## CertificateSigningRequestCondition v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestCondition - - - - - - - -Field | Description ------------- | ----------- -lastUpdateTime
    *[Time](#time-unversioned)* | timestamp for the last update to this condition -message
    *string* | human readable message with details about the request state -reason
    *string* | brief reason for the request state -type
    *string* | request approval state, currently Approved or Denied. - diff --git a/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequestlist_v1alpha1_concept.md b/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequestlist_v1alpha1_concept.md deleted file mode 100644 index 712e294f01..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequestlist_v1alpha1_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# CertificateSigningRequestList v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestList - - - - - - - - - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
    *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1) array* | -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ListMeta](#listmeta-unversioned)* | - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequestlist_v1alpha1_definition.md b/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequestlist_v1alpha1_definition.md deleted file mode 100644 index 351962b063..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequestlist_v1alpha1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## CertificateSigningRequestList v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestList - - - - - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
    *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1) array* | -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ListMeta](#listmeta-unversioned)* | - diff --git a/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequestspec_v1alpha1_concept.md b/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequestspec_v1alpha1_concept.md deleted file mode 100644 index 9e7fbae674..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequestspec_v1alpha1_concept.md +++ /dev/null @@ -1,34 +0,0 @@ - - ------------ -# CertificateSigningRequestSpec v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestSpec - - - - - - - -This information is immutable after the request is created. Only the Request and ExtraInfo fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users. - - - -Field | Description ------------- | ----------- -groups
    *string array* | -request
    *string* | Base64-encoded PKCS#10 CSR data -uid
    *string* | -username
    *string* | Information about the requesting user (if relevant) See user.Info interface for details - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequestspec_v1alpha1_definition.md b/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequestspec_v1alpha1_definition.md deleted file mode 100644 index e335d818d6..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequestspec_v1alpha1_definition.md +++ /dev/null @@ -1,20 +0,0 @@ -## CertificateSigningRequestSpec v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestSpec - - - -This information is immutable after the request is created. Only the Request and ExtraInfo fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users. - - - -Field | Description ------------- | ----------- -groups
    *string array* | -request
    *string* | Base64-encoded PKCS#10 CSR data -uid
    *string* | -username
    *string* | Information about the requesting user (if relevant) See user.Info interface for details - diff --git a/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequeststatus_v1alpha1_concept.md b/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequeststatus_v1alpha1_concept.md deleted file mode 100644 index a51938509e..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequeststatus_v1alpha1_concept.md +++ /dev/null @@ -1,32 +0,0 @@ - - ------------ -# CertificateSigningRequestStatus v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestStatus - - - - - - - - - - - -Field | Description ------------- | ----------- -certificate
    *string* | If request was approved, the controller will place the issued certificate here. -conditions
    *[CertificateSigningRequestCondition](#certificatesigningrequestcondition-v1alpha1) array* | Conditions applied to the request, such as approval or denial. - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequeststatus_v1alpha1_definition.md b/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequeststatus_v1alpha1_definition.md deleted file mode 100644 index 570ad1795d..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_certificatesigningrequeststatus_v1alpha1_definition.md +++ /dev/null @@ -1,18 +0,0 @@ -## CertificateSigningRequestStatus v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestStatus - - - - - - - -Field | Description ------------- | ----------- -certificate
    *string* | If request was approved, the controller will place the issued certificate here. -conditions
    *[CertificateSigningRequestCondition](#certificatesigningrequestcondition-v1alpha1) array* | Conditions applied to the request, such as approval or denial. - diff --git a/docs/resources-reference/v1.5/documents/_generated_cindervolumesource_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_cindervolumesource_v1_concept.md deleted file mode 100644 index d31493f61a..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_cindervolumesource_v1_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# CinderVolumeSource v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | CinderVolumeSource - - - - - - - -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. - - - -Field | Description ------------- | ----------- -fsType
    *string* | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md -readOnly
    *boolean* | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md -volumeID
    *string* | volume id used to identify the volume in cinder More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_cindervolumesource_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_cindervolumesource_v1_definition.md deleted file mode 100644 index 670fb61930..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_cindervolumesource_v1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## CinderVolumeSource v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | CinderVolumeSource - - - -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. - - - -Field | Description ------------- | ----------- -fsType
    *string* | Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md -readOnly
    *boolean* | Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md -volumeID
    *string* | volume id used to identify the volume in cinder More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md - diff --git a/docs/resources-reference/v1.5/documents/_generated_clusterrole_v1alpha1_concept.md b/docs/resources-reference/v1.5/documents/_generated_clusterrole_v1alpha1_concept.md deleted file mode 100644 index 5af5658772..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_clusterrole_v1alpha1_concept.md +++ /dev/null @@ -1,45 +0,0 @@ - - ------------ -# ClusterRole v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | ClusterRole - - - - - - - -ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. -rules
    *[PolicyRule](#policyrule-v1alpha1) array* | Rules holds all the PolicyRules for this ClusterRole - - -### ClusterRoleList v1alpha1 - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
    *[ClusterRole](#clusterrole-v1alpha1) array* | Items is a list of ClusterRoles -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ListMeta](#listmeta-unversioned)* | Standard object's metadata. - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_clusterrole_v1alpha1_definition.md b/docs/resources-reference/v1.5/documents/_generated_clusterrole_v1alpha1_definition.md deleted file mode 100644 index 0a99bcf054..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_clusterrole_v1alpha1_definition.md +++ /dev/null @@ -1,20 +0,0 @@ -## ClusterRole v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | ClusterRole - - - -ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. -rules
    *[PolicyRule](#policyrule-v1alpha1) array* | Rules holds all the PolicyRules for this ClusterRole - diff --git a/docs/resources-reference/v1.5/documents/_generated_clusterrolebinding_v1alpha1_concept.md b/docs/resources-reference/v1.5/documents/_generated_clusterrolebinding_v1alpha1_concept.md deleted file mode 100644 index cab1e888c3..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_clusterrolebinding_v1alpha1_concept.md +++ /dev/null @@ -1,46 +0,0 @@ - - ------------ -# ClusterRoleBinding v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | ClusterRoleBinding - - - - - - - -ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. -roleRef
    *[RoleRef](#roleref-v1alpha1)* | RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. -subjects
    *[Subject](#subject-v1alpha1) array* | Subjects holds references to the objects the role applies to. - - -### ClusterRoleBindingList v1alpha1 - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
    *[ClusterRoleBinding](#clusterrolebinding-v1alpha1) array* | Items is a list of ClusterRoleBindings -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ListMeta](#listmeta-unversioned)* | Standard object's metadata. - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_clusterrolebinding_v1alpha1_definition.md b/docs/resources-reference/v1.5/documents/_generated_clusterrolebinding_v1alpha1_definition.md deleted file mode 100644 index 2399cf6562..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_clusterrolebinding_v1alpha1_definition.md +++ /dev/null @@ -1,21 +0,0 @@ -## ClusterRoleBinding v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | ClusterRoleBinding - - - -ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. -roleRef
    *[RoleRef](#roleref-v1alpha1)* | RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. -subjects
    *[Subject](#subject-v1alpha1) array* | Subjects holds references to the objects the role applies to. - diff --git a/docs/resources-reference/v1.5/documents/_generated_clusterrolebindinglist_v1alpha1_concept.md b/docs/resources-reference/v1.5/documents/_generated_clusterrolebindinglist_v1alpha1_concept.md deleted file mode 100644 index a43a158ede..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_clusterrolebindinglist_v1alpha1_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# ClusterRoleBindingList v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | ClusterRoleBindingList - - - - - - - -ClusterRoleBindingList is a collection of ClusterRoleBindings - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
    *[ClusterRoleBinding](#clusterrolebinding-v1alpha1) array* | Items is a list of ClusterRoleBindings -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ListMeta](#listmeta-unversioned)* | Standard object's metadata. - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_clusterrolebindinglist_v1alpha1_definition.md b/docs/resources-reference/v1.5/documents/_generated_clusterrolebindinglist_v1alpha1_definition.md deleted file mode 100644 index d2c0dbcf80..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_clusterrolebindinglist_v1alpha1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## ClusterRoleBindingList v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | ClusterRoleBindingList - - - -ClusterRoleBindingList is a collection of ClusterRoleBindings - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
    *[ClusterRoleBinding](#clusterrolebinding-v1alpha1) array* | Items is a list of ClusterRoleBindings -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ListMeta](#listmeta-unversioned)* | Standard object's metadata. - diff --git a/docs/resources-reference/v1.5/documents/_generated_clusterrolelist_v1alpha1_concept.md b/docs/resources-reference/v1.5/documents/_generated_clusterrolelist_v1alpha1_concept.md deleted file mode 100644 index 71aae4c153..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_clusterrolelist_v1alpha1_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# ClusterRoleList v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | ClusterRoleList - - - - - - - -ClusterRoleList is a collection of ClusterRoles - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
    *[ClusterRole](#clusterrole-v1alpha1) array* | Items is a list of ClusterRoles -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ListMeta](#listmeta-unversioned)* | Standard object's metadata. - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_clusterrolelist_v1alpha1_definition.md b/docs/resources-reference/v1.5/documents/_generated_clusterrolelist_v1alpha1_definition.md deleted file mode 100644 index d36c6bff0e..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_clusterrolelist_v1alpha1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## ClusterRoleList v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | ClusterRoleList - - - -ClusterRoleList is a collection of ClusterRoles - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
    *[ClusterRole](#clusterrole-v1alpha1) array* | Items is a list of ClusterRoles -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ListMeta](#listmeta-unversioned)* | Standard object's metadata. - diff --git a/docs/resources-reference/v1.5/documents/_generated_componentcondition_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_componentcondition_v1_concept.md deleted file mode 100644 index 7976a2bc40..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_componentcondition_v1_concept.md +++ /dev/null @@ -1,34 +0,0 @@ - - ------------ -# ComponentCondition v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ComponentCondition - - - - - - - -Information about the condition of a component. - - - -Field | Description ------------- | ----------- -error
    *string* | Condition error code for a component. For example, a health check error code. -message
    *string* | Message about the condition for a component. For example, information about a health check. -status
    *string* | Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown". -type
    *string* | Type of condition for a component. Valid value: "Healthy" - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_componentcondition_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_componentcondition_v1_definition.md deleted file mode 100644 index 6462a60913..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_componentcondition_v1_definition.md +++ /dev/null @@ -1,20 +0,0 @@ -## ComponentCondition v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ComponentCondition - - - -Information about the condition of a component. - - - -Field | Description ------------- | ----------- -error
    *string* | Condition error code for a component. For example, a health check error code. -message
    *string* | Message about the condition for a component. For example, information about a health check. -status
    *string* | Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown". -type
    *string* | Type of condition for a component. Valid value: "Healthy" - diff --git a/docs/resources-reference/v1.5/documents/_generated_componentstatus_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_componentstatus_v1_concept.md deleted file mode 100644 index 8188da8893..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_componentstatus_v1_concept.md +++ /dev/null @@ -1,45 +0,0 @@ - - ------------ -# ComponentStatus v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ComponentStatus - - - - - - - -ComponentStatus (and ComponentStatusList) holds the cluster validation info. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -conditions
    *[ComponentCondition](#componentcondition-v1) array* | List of component conditions observed -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - - -### ComponentStatusList v1 - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
    *[ComponentStatus](#componentstatus-v1) array* | List of ComponentStatus objects. -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_componentstatus_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_componentstatus_v1_definition.md deleted file mode 100644 index efbd73394a..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_componentstatus_v1_definition.md +++ /dev/null @@ -1,20 +0,0 @@ -## ComponentStatus v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ComponentStatus - - - -ComponentStatus (and ComponentStatusList) holds the cluster validation info. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -conditions
    *[ComponentCondition](#componentcondition-v1) array* | List of component conditions observed -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - diff --git a/docs/resources-reference/v1.5/documents/_generated_componentstatuslist_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_componentstatuslist_v1_concept.md deleted file mode 100644 index b4445da385..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_componentstatuslist_v1_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# ComponentStatusList v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ComponentStatusList - - - - - - - -Status of all the conditions for the component as a list of ComponentStatus objects. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
    *[ComponentStatus](#componentstatus-v1) array* | List of ComponentStatus objects. -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_componentstatuslist_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_componentstatuslist_v1_definition.md deleted file mode 100644 index 02c154761e..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_componentstatuslist_v1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## ComponentStatusList v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ComponentStatusList - - - -Status of all the conditions for the component as a list of ComponentStatus objects. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
    *[ComponentStatus](#componentstatus-v1) array* | List of ComponentStatus objects. -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds - diff --git a/docs/resources-reference/v1.5/documents/_generated_configmap_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_configmap_v1_concept.md deleted file mode 100644 index 3a174aed15..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_configmap_v1_concept.md +++ /dev/null @@ -1,45 +0,0 @@ - - ------------ -# ConfigMap v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ConfigMap - - - - - - - -ConfigMap holds configuration data for pods to consume. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -data
    *object* | Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot. -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - - -### ConfigMapList v1 - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
    *[ConfigMap](#configmap-v1) array* | Items is the list of ConfigMaps. -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ListMeta](#listmeta-unversioned)* | More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_configmap_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_configmap_v1_definition.md deleted file mode 100644 index b5864ad664..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_configmap_v1_definition.md +++ /dev/null @@ -1,20 +0,0 @@ -## ConfigMap v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ConfigMap - - - -ConfigMap holds configuration data for pods to consume. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -data
    *object* | Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot. -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - diff --git a/docs/resources-reference/v1.5/documents/_generated_configmapkeyselector_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_configmapkeyselector_v1_concept.md deleted file mode 100644 index 8cb9c40d2d..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_configmapkeyselector_v1_concept.md +++ /dev/null @@ -1,32 +0,0 @@ - - ------------ -# ConfigMapKeySelector v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ConfigMapKeySelector - - - - - - - -Selects a key from a ConfigMap. - - - -Field | Description ------------- | ----------- -key
    *string* | The key to select. -name
    *string* | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_configmapkeyselector_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_configmapkeyselector_v1_definition.md deleted file mode 100644 index 00e98b82bb..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_configmapkeyselector_v1_definition.md +++ /dev/null @@ -1,18 +0,0 @@ -## ConfigMapKeySelector v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ConfigMapKeySelector - - - -Selects a key from a ConfigMap. - - - -Field | Description ------------- | ----------- -key
    *string* | The key to select. -name
    *string* | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names - diff --git a/docs/resources-reference/v1.5/documents/_generated_configmaplist_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_configmaplist_v1_concept.md deleted file mode 100644 index a0c4f0a530..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_configmaplist_v1_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# ConfigMapList v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ConfigMapList - - - - - - - -ConfigMapList is a resource containing a list of ConfigMap objects. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
    *[ConfigMap](#configmap-v1) array* | Items is the list of ConfigMaps. -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ListMeta](#listmeta-unversioned)* | More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_configmaplist_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_configmaplist_v1_definition.md deleted file mode 100644 index 32e00ed55e..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_configmaplist_v1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## ConfigMapList v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ConfigMapList - - - -ConfigMapList is a resource containing a list of ConfigMap objects. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
    *[ConfigMap](#configmap-v1) array* | Items is the list of ConfigMaps. -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ListMeta](#listmeta-unversioned)* | More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - diff --git a/docs/resources-reference/v1.5/documents/_generated_configmapvolumesource_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_configmapvolumesource_v1_concept.md deleted file mode 100644 index 5dd5e2b183..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_configmapvolumesource_v1_concept.md +++ /dev/null @@ -1,35 +0,0 @@ - - ------------ -# ConfigMapVolumeSource v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | 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. - - - -Field | Description ------------- | ----------- -defaultMode
    *integer* | Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. -items
    *[KeyToPath](#keytopath-v1) array* | If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the '..' path or start with '..'. -name
    *string* | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_configmapvolumesource_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_configmapvolumesource_v1_definition.md deleted file mode 100644 index e171a6f0d6..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_configmapvolumesource_v1_definition.md +++ /dev/null @@ -1,21 +0,0 @@ -## ConfigMapVolumeSource v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | 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. - - - -Field | Description ------------- | ----------- -defaultMode
    *integer* | Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. -items
    *[KeyToPath](#keytopath-v1) array* | If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the '..' path or start with '..'. -name
    *string* | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names - diff --git a/docs/resources-reference/v1.5/documents/_generated_container_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_container_v1_concept.md deleted file mode 100644 index e564760c1c..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_container_v1_concept.md +++ /dev/null @@ -1,74 +0,0 @@ - - ------------ -# Container v1 - ->bdocs-tab:example Container Config to run nginx (must be embedded in a PodSpec to run). - -```bdocs-tab:example_yaml - -name: nginx -# Run the nginx:1.10 image -image: nginx:1.10 - - -``` - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | Container - - - - - - - -A single application container that you want to run within a pod. - - - -Field | Description ------------- | ----------- -args
    *string array* | Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands -command
    *string array* | Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands -env
    *[EnvVar](#envvar-v1) array* | List of environment variables to set in the container. Cannot be updated. -image
    *string* | Docker image name. More info: http://kubernetes.io/docs/user-guide/images -imagePullPolicy
    *string* | Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/images#updating-images -lifecycle
    *[Lifecycle](#lifecycle-v1)* | Actions that the management system should take in response to container lifecycle events. Cannot be updated. -livenessProbe
    *[Probe](#probe-v1)* | Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes -name
    *string* | Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. -ports
    *[ContainerPort](#containerport-v1) array* | List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. -readinessProbe
    *[Probe](#probe-v1)* | Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes -resources
    *[ResourceRequirements](#resourcerequirements-v1)* | Compute Resources required by this container. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources -securityContext
    *[SecurityContext](#securitycontext-v1)* | Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md -stdin
    *boolean* | Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. -stdinOnce
    *boolean* | Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false -terminationMessagePath
    *string* | Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated. -tty
    *boolean* | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. -volumeMounts
    *[VolumeMount](#volumemount-v1) array* | Pod volumes to mount into the container's filesystem. Cannot be updated. -workingDir
    *string* | Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. - - -### ContainerStatus v1 - - - -Field | Description ------------- | ----------- -containerID
    *string* | Container's ID in the format 'docker://'. More info: http://kubernetes.io/docs/user-guide/container-environment#container-information -image
    *string* | The image the container is running. More info: http://kubernetes.io/docs/user-guide/images -imageID
    *string* | ImageID of the container's image. -lastState
    *[ContainerState](#containerstate-v1)* | Details about the container's last termination condition. -name
    *string* | This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated. -ready
    *boolean* | Specifies whether the container has passed its readiness probe. -restartCount
    *integer* | The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC. -state
    *[ContainerState](#containerstate-v1)* | Details about the container's current condition. - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_container_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_container_v1_definition.md deleted file mode 100644 index a1cd1458e6..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_container_v1_definition.md +++ /dev/null @@ -1,34 +0,0 @@ -## Container v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | Container - - - -A single application container that you want to run within a pod. - - - -Field | Description ------------- | ----------- -args
    *string array* | Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands -command
    *string array* | Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands -env
    *[EnvVar](#envvar-v1) array* | List of environment variables to set in the container. Cannot be updated. -image
    *string* | Docker image name. More info: http://kubernetes.io/docs/user-guide/images -imagePullPolicy
    *string* | Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/images#updating-images -lifecycle
    *[Lifecycle](#lifecycle-v1)* | Actions that the management system should take in response to container lifecycle events. Cannot be updated. -livenessProbe
    *[Probe](#probe-v1)* | Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes -name
    *string* | Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. -ports
    *[ContainerPort](#containerport-v1) array* | List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. -readinessProbe
    *[Probe](#probe-v1)* | Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes -resources
    *[ResourceRequirements](#resourcerequirements-v1)* | Compute Resources required by this container. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources -securityContext
    *[SecurityContext](#securitycontext-v1)* | Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md -stdin
    *boolean* | Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. -stdinOnce
    *boolean* | Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false -terminationMessagePath
    *string* | Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated. -tty
    *boolean* | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. -volumeMounts
    *[VolumeMount](#volumemount-v1) array* | Pod volumes to mount into the container's filesystem. Cannot be updated. -workingDir
    *string* | Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. - diff --git a/docs/resources-reference/v1.5/documents/_generated_containerimage_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_containerimage_v1_concept.md deleted file mode 100644 index ca498c5d33..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_containerimage_v1_concept.md +++ /dev/null @@ -1,32 +0,0 @@ - - ------------ -# ContainerImage v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerImage - - - - - - - -Describe a container image - - - -Field | Description ------------- | ----------- -names
    *string array* | 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"] -sizeBytes
    *integer* | The size of the image in bytes. - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_containerimage_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_containerimage_v1_definition.md deleted file mode 100644 index eee5bc1ffa..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_containerimage_v1_definition.md +++ /dev/null @@ -1,18 +0,0 @@ -## ContainerImage v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerImage - - - -Describe a container image - - - -Field | Description ------------- | ----------- -names
    *string array* | 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"] -sizeBytes
    *integer* | The size of the image in bytes. - diff --git a/docs/resources-reference/v1.5/documents/_generated_containerport_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_containerport_v1_concept.md deleted file mode 100644 index 3c003e33d8..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_containerport_v1_concept.md +++ /dev/null @@ -1,35 +0,0 @@ - - ------------ -# ContainerPort v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerPort - - - - - - - -ContainerPort represents a network port in a single container. - - - -Field | Description ------------- | ----------- -containerPort
    *integer* | Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. -hostIP
    *string* | What host IP to bind the external port to. -hostPort
    *integer* | Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. -name
    *string* | If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. -protocol
    *string* | Protocol for port. Must be UDP or TCP. Defaults to "TCP". - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_containerport_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_containerport_v1_definition.md deleted file mode 100644 index 1389ec92a8..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_containerport_v1_definition.md +++ /dev/null @@ -1,21 +0,0 @@ -## ContainerPort v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerPort - - - -ContainerPort represents a network port in a single container. - - - -Field | Description ------------- | ----------- -containerPort
    *integer* | Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. -hostIP
    *string* | What host IP to bind the external port to. -hostPort
    *integer* | Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. -name
    *string* | If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. -protocol
    *string* | Protocol for port. Must be UDP or TCP. Defaults to "TCP". - diff --git a/docs/resources-reference/v1.5/documents/_generated_containerstate_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_containerstate_v1_concept.md deleted file mode 100644 index a0958ebb25..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_containerstate_v1_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# ContainerState v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerState - - - - - - - -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. - - - -Field | Description ------------- | ----------- -running
    *[ContainerStateRunning](#containerstaterunning-v1)* | Details about a running container -terminated
    *[ContainerStateTerminated](#containerstateterminated-v1)* | Details about a terminated container -waiting
    *[ContainerStateWaiting](#containerstatewaiting-v1)* | Details about a waiting container - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_containerstate_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_containerstate_v1_definition.md deleted file mode 100644 index 624e3666b5..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_containerstate_v1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## ContainerState v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerState - - - -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. - - - -Field | Description ------------- | ----------- -running
    *[ContainerStateRunning](#containerstaterunning-v1)* | Details about a running container -terminated
    *[ContainerStateTerminated](#containerstateterminated-v1)* | Details about a terminated container -waiting
    *[ContainerStateWaiting](#containerstatewaiting-v1)* | Details about a waiting container - diff --git a/docs/resources-reference/v1.5/documents/_generated_containerstaterunning_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_containerstaterunning_v1_concept.md deleted file mode 100644 index 1714dac45b..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_containerstaterunning_v1_concept.md +++ /dev/null @@ -1,31 +0,0 @@ - - ------------ -# ContainerStateRunning v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStateRunning - - - - - - - -ContainerStateRunning is a running state of a container. - - - -Field | Description ------------- | ----------- -startedAt
    *[Time](#time-unversioned)* | Time at which the container was last (re-)started - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_containerstaterunning_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_containerstaterunning_v1_definition.md deleted file mode 100644 index 6080af649c..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_containerstaterunning_v1_definition.md +++ /dev/null @@ -1,17 +0,0 @@ -## ContainerStateRunning v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStateRunning - - - -ContainerStateRunning is a running state of a container. - - - -Field | Description ------------- | ----------- -startedAt
    *[Time](#time-unversioned)* | Time at which the container was last (re-)started - diff --git a/docs/resources-reference/v1.5/documents/_generated_containerstateterminated_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_containerstateterminated_v1_concept.md deleted file mode 100644 index e76ba6af4a..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_containerstateterminated_v1_concept.md +++ /dev/null @@ -1,37 +0,0 @@ - - ------------ -# ContainerStateTerminated v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStateTerminated - - - - - - - -ContainerStateTerminated is a terminated state of a container. - - - -Field | Description ------------- | ----------- -containerID
    *string* | Container's ID in the format 'docker://' -exitCode
    *integer* | Exit status from the last termination of the container -finishedAt
    *[Time](#time-unversioned)* | Time at which the container last terminated -message
    *string* | Message regarding the last termination of the container -reason
    *string* | (brief) reason from the last termination of the container -signal
    *integer* | Signal from the last termination of the container -startedAt
    *[Time](#time-unversioned)* | Time at which previous execution of the container started - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_containerstateterminated_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_containerstateterminated_v1_definition.md deleted file mode 100644 index 7c5fa0142a..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_containerstateterminated_v1_definition.md +++ /dev/null @@ -1,23 +0,0 @@ -## ContainerStateTerminated v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStateTerminated - - - -ContainerStateTerminated is a terminated state of a container. - - - -Field | Description ------------- | ----------- -containerID
    *string* | Container's ID in the format 'docker://' -exitCode
    *integer* | Exit status from the last termination of the container -finishedAt
    *[Time](#time-unversioned)* | Time at which the container last terminated -message
    *string* | Message regarding the last termination of the container -reason
    *string* | (brief) reason from the last termination of the container -signal
    *integer* | Signal from the last termination of the container -startedAt
    *[Time](#time-unversioned)* | Time at which previous execution of the container started - diff --git a/docs/resources-reference/v1.5/documents/_generated_containerstatewaiting_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_containerstatewaiting_v1_concept.md deleted file mode 100644 index 9a9a3eeb1f..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_containerstatewaiting_v1_concept.md +++ /dev/null @@ -1,32 +0,0 @@ - - ------------ -# ContainerStateWaiting v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStateWaiting - - - - - - - -ContainerStateWaiting is a waiting state of a container. - - - -Field | Description ------------- | ----------- -message
    *string* | Message regarding why the container is not yet running. -reason
    *string* | (brief) reason the container is not yet running. - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_containerstatewaiting_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_containerstatewaiting_v1_definition.md deleted file mode 100644 index a09ace9d38..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_containerstatewaiting_v1_definition.md +++ /dev/null @@ -1,18 +0,0 @@ -## ContainerStateWaiting v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStateWaiting - - - -ContainerStateWaiting is a waiting state of a container. - - - -Field | Description ------------- | ----------- -message
    *string* | Message regarding why the container is not yet running. -reason
    *string* | (brief) reason the container is not yet running. - diff --git a/docs/resources-reference/v1.5/documents/_generated_containerstatus_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_containerstatus_v1_concept.md deleted file mode 100644 index a77e8a3074..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_containerstatus_v1_concept.md +++ /dev/null @@ -1,38 +0,0 @@ - - ------------ -# ContainerStatus v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStatus - - - - - - - -ContainerStatus contains details for the current status of this container. - - - -Field | Description ------------- | ----------- -containerID
    *string* | Container's ID in the format 'docker://'. More info: http://kubernetes.io/docs/user-guide/container-environment#container-information -image
    *string* | The image the container is running. More info: http://kubernetes.io/docs/user-guide/images -imageID
    *string* | ImageID of the container's image. -lastState
    *[ContainerState](#containerstate-v1)* | Details about the container's last termination condition. -name
    *string* | This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated. -ready
    *boolean* | Specifies whether the container has passed its readiness probe. -restartCount
    *integer* | The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC. -state
    *[ContainerState](#containerstate-v1)* | Details about the container's current condition. - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_containerstatus_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_containerstatus_v1_definition.md deleted file mode 100644 index 4154b694f7..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_containerstatus_v1_definition.md +++ /dev/null @@ -1,24 +0,0 @@ -## ContainerStatus v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStatus - - - -ContainerStatus contains details for the current status of this container. - - - -Field | Description ------------- | ----------- -containerID
    *string* | Container's ID in the format 'docker://'. More info: http://kubernetes.io/docs/user-guide/container-environment#container-information -image
    *string* | The image the container is running. More info: http://kubernetes.io/docs/user-guide/images -imageID
    *string* | ImageID of the container's image. -lastState
    *[ContainerState](#containerstate-v1)* | Details about the container's last termination condition. -name
    *string* | This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated. -ready
    *boolean* | Specifies whether the container has passed its readiness probe. -restartCount
    *integer* | The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC. -state
    *[ContainerState](#containerstate-v1)* | Details about the container's current condition. - diff --git a/docs/resources-reference/v1.5/documents/_generated_cputargetutilization_v1beta1_concept.md b/docs/resources-reference/v1.5/documents/_generated_cputargetutilization_v1beta1_concept.md deleted file mode 100644 index 53ce2ba364..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_cputargetutilization_v1beta1_concept.md +++ /dev/null @@ -1,31 +0,0 @@ - - ------------ -# CPUTargetUtilization v1beta1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1beta1 | CPUTargetUtilization - - - - - - - - - - - -Field | Description ------------- | ----------- -targetPercentage
    *integer* | fraction of the requested CPU that should be utilized/used, e.g. 70 means that 70% of the requested CPU should be in use. - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_cputargetutilization_v1beta1_definition.md b/docs/resources-reference/v1.5/documents/_generated_cputargetutilization_v1beta1_definition.md deleted file mode 100644 index c24e29a5c4..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_cputargetutilization_v1beta1_definition.md +++ /dev/null @@ -1,17 +0,0 @@ -## CPUTargetUtilization v1beta1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1beta1 | CPUTargetUtilization - - - - - - - -Field | Description ------------- | ----------- -targetPercentage
    *integer* | fraction of the requested CPU that should be utilized/used, e.g. 70 means that 70% of the requested CPU should be in use. - diff --git a/docs/resources-reference/v1.5/documents/_generated_cronjob_v2alpha1_concept.md b/docs/resources-reference/v1.5/documents/_generated_cronjob_v2alpha1_concept.md deleted file mode 100644 index 6183cb7889..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_cronjob_v2alpha1_concept.md +++ /dev/null @@ -1,69 +0,0 @@ - - ------------ -# CronJob v2alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v2alpha1 | CronJob - - - - - - - -CronJob represents the configuration of a single cron job. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata -spec
    *[CronJobSpec](#cronjobspec-v2alpha1)* | Spec is a structure defining the expected behavior of a job, including the schedule. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status -status
    *[CronJobStatus](#cronjobstatus-v2alpha1)* | Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status - - -### CronJobSpec v2alpha1 - - - -Field | Description ------------- | ----------- -concurrencyPolicy
    *string* | ConcurrencyPolicy specifies how to treat concurrent executions of a Job. -jobTemplate
    *[JobTemplateSpec](#jobtemplatespec-v2alpha1)* | JobTemplate is the object that describes the job that will be created when executing a CronJob. -schedule
    *string* | Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. -startingDeadlineSeconds
    *integer* | Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. -suspend
    *boolean* | Suspend flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false. - -### CronJobStatus v2alpha1 - - - -Field | Description ------------- | ----------- -active
    *[ObjectReference](#objectreference-v1) array* | Active holds pointers to currently running jobs. -lastScheduleTime
    *[Time](#time-unversioned)* | LastScheduleTime keeps information of when was the last time the job was successfully scheduled. - -### CronJobList v2alpha1 - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
    *[CronJob](#cronjob-v2alpha1) array* | Items is the list of CronJob. -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ListMeta](#listmeta-unversioned)* | Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_cronjob_v2alpha1_definition.md b/docs/resources-reference/v1.5/documents/_generated_cronjob_v2alpha1_definition.md deleted file mode 100644 index ec4284e0b7..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_cronjob_v2alpha1_definition.md +++ /dev/null @@ -1,21 +0,0 @@ -## CronJob v2alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v2alpha1 | CronJob - - - -CronJob represents the configuration of a single cron job. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata -spec
    *[CronJobSpec](#cronjobspec-v2alpha1)* | Spec is a structure defining the expected behavior of a job, including the schedule. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status -status
    *[CronJobStatus](#cronjobstatus-v2alpha1)* | Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status - diff --git a/docs/resources-reference/v1.5/documents/_generated_cronjoblist_v2alpha1_concept.md b/docs/resources-reference/v1.5/documents/_generated_cronjoblist_v2alpha1_concept.md deleted file mode 100644 index f63337e893..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_cronjoblist_v2alpha1_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# CronJobList v2alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v2alpha1 | CronJobList - - - - - - - -CronJobList is a collection of cron jobs. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
    *[CronJob](#cronjob-v2alpha1) array* | Items is the list of CronJob. -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ListMeta](#listmeta-unversioned)* | Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_cronjoblist_v2alpha1_definition.md b/docs/resources-reference/v1.5/documents/_generated_cronjoblist_v2alpha1_definition.md deleted file mode 100644 index 9c0f2059d8..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_cronjoblist_v2alpha1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## CronJobList v2alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v2alpha1 | CronJobList - - - -CronJobList is a collection of cron jobs. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources -items
    *[CronJob](#cronjob-v2alpha1) array* | Items is the list of CronJob. -kind
    *string* | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds -metadata
    *[ListMeta](#listmeta-unversioned)* | Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - diff --git a/docs/resources-reference/v1.5/documents/_generated_cronjobspec_v2alpha1_concept.md b/docs/resources-reference/v1.5/documents/_generated_cronjobspec_v2alpha1_concept.md deleted file mode 100644 index 2e58bf43c9..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_cronjobspec_v2alpha1_concept.md +++ /dev/null @@ -1,35 +0,0 @@ - - ------------ -# CronJobSpec v2alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v2alpha1 | CronJobSpec - - - - - - - -CronJobSpec describes how the job execution will look like and when it will actually run. - - - -Field | Description ------------- | ----------- -concurrencyPolicy
    *string* | ConcurrencyPolicy specifies how to treat concurrent executions of a Job. -jobTemplate
    *[JobTemplateSpec](#jobtemplatespec-v2alpha1)* | JobTemplate is the object that describes the job that will be created when executing a CronJob. -schedule
    *string* | Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. -startingDeadlineSeconds
    *integer* | Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. -suspend
    *boolean* | Suspend flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false. - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_cronjobspec_v2alpha1_definition.md b/docs/resources-reference/v1.5/documents/_generated_cronjobspec_v2alpha1_definition.md deleted file mode 100644 index 56dd8832c3..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_cronjobspec_v2alpha1_definition.md +++ /dev/null @@ -1,21 +0,0 @@ -## CronJobSpec v2alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v2alpha1 | CronJobSpec - - - -CronJobSpec describes how the job execution will look like and when it will actually run. - - - -Field | Description ------------- | ----------- -concurrencyPolicy
    *string* | ConcurrencyPolicy specifies how to treat concurrent executions of a Job. -jobTemplate
    *[JobTemplateSpec](#jobtemplatespec-v2alpha1)* | JobTemplate is the object that describes the job that will be created when executing a CronJob. -schedule
    *string* | Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. -startingDeadlineSeconds
    *integer* | Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. -suspend
    *boolean* | Suspend flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false. - diff --git a/docs/resources-reference/v1.5/documents/_generated_cronjobstatus_v2alpha1_concept.md b/docs/resources-reference/v1.5/documents/_generated_cronjobstatus_v2alpha1_concept.md deleted file mode 100644 index 3bd2980690..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_cronjobstatus_v2alpha1_concept.md +++ /dev/null @@ -1,32 +0,0 @@ - - ------------ -# CronJobStatus v2alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v2alpha1 | CronJobStatus - - - - - - - -CronJobStatus represents the current state of a cron job. - - - -Field | Description ------------- | ----------- -active
    *[ObjectReference](#objectreference-v1) array* | Active holds pointers to currently running jobs. -lastScheduleTime
    *[Time](#time-unversioned)* | LastScheduleTime keeps information of when was the last time the job was successfully scheduled. - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_cronjobstatus_v2alpha1_definition.md b/docs/resources-reference/v1.5/documents/_generated_cronjobstatus_v2alpha1_definition.md deleted file mode 100644 index 021803c3e1..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_cronjobstatus_v2alpha1_definition.md +++ /dev/null @@ -1,18 +0,0 @@ -## CronJobStatus v2alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v2alpha1 | CronJobStatus - - - -CronJobStatus represents the current state of a cron job. - - - -Field | Description ------------- | ----------- -active
    *[ObjectReference](#objectreference-v1) array* | Active holds pointers to currently running jobs. -lastScheduleTime
    *[Time](#time-unversioned)* | LastScheduleTime keeps information of when was the last time the job was successfully scheduled. - diff --git a/docs/resources-reference/v1.5/documents/_generated_crossversionobjectreference_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_crossversionobjectreference_v1_concept.md deleted file mode 100644 index e18c960c76..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_crossversionobjectreference_v1_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# CrossVersionObjectReference v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | CrossVersionObjectReference - - - - - - - -CrossVersionObjectReference contains enough information to let you identify the referred resource. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | API version of the referent -kind
    *string* | Kind of the referent; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds" -name
    *string* | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_crossversionobjectreference_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_crossversionobjectreference_v1_definition.md deleted file mode 100644 index 49aabee65c..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_crossversionobjectreference_v1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## CrossVersionObjectReference v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | CrossVersionObjectReference - - - -CrossVersionObjectReference contains enough information to let you identify the referred resource. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | API version of the referent -kind
    *string* | Kind of the referent; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds" -name
    *string* | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names - diff --git a/docs/resources-reference/v1.5/documents/_generated_daemonendpoint_v1_concept.md b/docs/resources-reference/v1.5/documents/_generated_daemonendpoint_v1_concept.md deleted file mode 100644 index e745761332..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_daemonendpoint_v1_concept.md +++ /dev/null @@ -1,31 +0,0 @@ - - ------------ -# DaemonEndpoint v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | DaemonEndpoint - - - - - - - -DaemonEndpoint contains information about a single Daemon endpoint. - - - -Field | Description ------------- | ----------- -Port
    *integer* | Port number of the given endpoint. - - - - - - diff --git a/docs/resources-reference/v1.5/documents/_generated_daemonendpoint_v1_definition.md b/docs/resources-reference/v1.5/documents/_generated_daemonendpoint_v1_definition.md deleted file mode 100644 index f2b131a01e..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_daemonendpoint_v1_definition.md +++ /dev/null @@ -1,17 +0,0 @@ -## DaemonEndpoint v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | DaemonEndpoint - - - -DaemonEndpoint contains information about a single Daemon endpoint. - - - -Field | Description ------------- | ----------- -Port
    *integer* | Port number of the given endpoint. - diff --git a/docs/resources-reference/v1.5/documents/_generated_daemonset_v1beta1_concept.md b/docs/resources-reference/v1.5/documents/_generated_daemonset_v1beta1_concept.md deleted file mode 100644 index 7e0e43a04c..0000000000 --- a/docs/resources-reference/v1.5/documents/_generated_daemonset_v1beta1_concept.md +++ /dev/null @@ -1,99 +0,0 @@ - - ------------ -# DaemonSet v1beta1 - ->bdocs-tab:example DaemonSet Config to print the `hostname` on each Node in the cluster every 10 seconds. - -```bdocs-tab:example_yaml - -apiVersion: extensions/v1beta1 -kind: DaemonSet -metadata: - # Unique key of the DaemonSet instance - name: daemonset-example -spec: - template: - metadata: - labels: - app: daemonset-example - spec: - containers: - # This container is run once on each Node in the cluster - - name: daemonset-example - image: ubuntu:trusty - command: - - /bin/sh - args: - - -c - # This script is run through `sh -c - + \ No newline at end of file diff --git a/docs/resources-reference/v1.5/manifest.json b/docs/resources-reference/v1.5/manifest.json deleted file mode 100644 index e87a3fde36..0000000000 --- a/docs/resources-reference/v1.5/manifest.json +++ /dev/null @@ -1,517 +0,0 @@ -{ - "table_of_contents": {}, - "docs": [ - { - "filename": "_workloads.md" - }, - { - "filename": "_generated_container_v1_concept.md" - }, - { - "filename": "_generated_cronjob_v2alpha1_concept.md" - }, - { - "filename": "_generated_daemonset_v1beta1_concept.md" - }, - { - "filename": "_generated_deployment_v1beta1_concept.md" - }, - { - "filename": "_generated_job_v1_concept.md" - }, - { - "filename": "_generated_pod_v1_concept.md" - }, - { - "filename": "_generated_replicaset_v1beta1_concept.md" - }, - { - "filename": "_generated_replicationcontroller_v1_concept.md" - }, - { - "filename": "_generated_statefulset_v1beta1_concept.md" - }, - { - "filename": "_servicediscovery.md" - }, - { - "filename": "_generated_endpoints_v1_concept.md" - }, - { - "filename": "_generated_ingress_v1beta1_concept.md" - }, - { - "filename": "_generated_service_v1_concept.md" - }, - { - "filename": "_config.md" - }, - { - "filename": "_generated_configmap_v1_concept.md" - }, - { - "filename": "_generated_secret_v1_concept.md" - }, - { - "filename": "_generated_persistentvolumeclaim_v1_concept.md" - }, - { - "filename": "_generated_storageclass_v1beta1_concept.md" - }, - { - "filename": "_generated_volume_v1_concept.md" - }, - { - "filename": "_meta.md" - }, - { - "filename": "_generated_event_v1_concept.md" - }, - { - "filename": "_generated_limitrange_v1_concept.md" - }, - { - "filename": "_generated_horizontalpodautoscaler_v1_concept.md" - }, - { - "filename": "_generated_podtemplate_v1_concept.md" - }, - { - "filename": "_generated_poddisruptionbudget_v1beta1_concept.md" - }, - { - "filename": "_generated_thirdpartyresource_v1beta1_concept.md" - }, - { - "filename": "_cluster.md" - }, - { - "filename": "_generated_binding_v1_concept.md" - }, - { - "filename": "_generated_certificatesigningrequest_v1alpha1_concept.md" - }, - { - "filename": "_generated_clusterrole_v1alpha1_concept.md" - }, - { - "filename": "_generated_clusterrolebinding_v1alpha1_concept.md" - }, - { - "filename": "_generated_componentstatus_v1_concept.md" - }, - { - "filename": "_generated_localsubjectaccessreview_v1beta1_concept.md" - }, - { - "filename": "_generated_namespace_v1_concept.md" - }, - { - "filename": "_generated_node_v1_concept.md" - }, - { - "filename": "_generated_persistentvolume_v1_concept.md" - }, - { - "filename": "_generated_resourcequota_v1_concept.md" - }, - { - "filename": "_generated_role_v1alpha1_concept.md" - }, - { - "filename": "_generated_rolebinding_v1alpha1_concept.md" - }, - { - "filename": "_generated_selfsubjectaccessreview_v1beta1_concept.md" - }, - { - "filename": "_generated_serviceaccount_v1_concept.md" - }, - { - "filename": "_generated_subjectaccessreview_v1beta1_concept.md" - }, - { - "filename": "_generated_tokenreview_v1beta1_concept.md" - }, - { - "filename": "_generated_networkpolicy_v1beta1_concept.md" - }, - { - "filename": "_definitions.md" - }, - { - "filename": "_generated_apigroup_unversioned_definition.md" - }, - { - "filename": "_generated_apiresource_unversioned_definition.md" - }, - { - "filename": "_generated_apiversion_v1beta1_definition.md" - }, - { - "filename": "_generated_apiversions_unversioned_definition.md" - }, - { - "filename": "_generated_awselasticblockstorevolumesource_v1_definition.md" - }, - { - "filename": "_generated_attachedvolume_v1_definition.md" - }, - { - "filename": "_generated_azurediskvolumesource_v1_definition.md" - }, - { - "filename": "_generated_azurefilevolumesource_v1_definition.md" - }, - { - "filename": "_generated_cputargetutilization_v1beta1_definition.md" - }, - { - "filename": "_generated_capabilities_v1_definition.md" - }, - { - "filename": "_generated_cephfsvolumesource_v1_definition.md" - }, - { - "filename": "_generated_certificatesigningrequestcondition_v1alpha1_definition.md" - }, - { - "filename": "_generated_cindervolumesource_v1_definition.md" - }, - { - "filename": "_generated_componentcondition_v1_definition.md" - }, - { - "filename": "_generated_configmapkeyselector_v1_definition.md" - }, - { - "filename": "_generated_configmapvolumesource_v1_definition.md" - }, - { - "filename": "_generated_containerimage_v1_definition.md" - }, - { - "filename": "_generated_containerport_v1_definition.md" - }, - { - "filename": "_generated_containerstate_v1_definition.md" - }, - { - "filename": "_generated_containerstaterunning_v1_definition.md" - }, - { - "filename": "_generated_containerstateterminated_v1_definition.md" - }, - { - "filename": "_generated_containerstatewaiting_v1_definition.md" - }, - { - "filename": "_generated_crossversionobjectreference_v1_definition.md" - }, - { - "filename": "_generated_daemonendpoint_v1_definition.md" - }, - { - "filename": "_generated_deleteoptions_v1_definition.md" - }, - { - "filename": "_generated_deploymentcondition_v1beta1_definition.md" - }, - { - "filename": "_generated_downwardapivolumefile_v1_definition.md" - }, - { - "filename": "_generated_downwardapivolumesource_v1_definition.md" - }, - { - "filename": "_generated_emptydirvolumesource_v1_definition.md" - }, - { - "filename": "_generated_endpointaddress_v1_definition.md" - }, - { - "filename": "_generated_endpointport_v1_definition.md" - }, - { - "filename": "_generated_endpointsubset_v1_definition.md" - }, - { - "filename": "_generated_envvar_v1_definition.md" - }, - { - "filename": "_generated_envvarsource_v1_definition.md" - }, - { - "filename": "_generated_eventsource_v1_definition.md" - }, - { - "filename": "_generated_eviction_v1beta1_definition.md" - }, - { - "filename": "_generated_execaction_v1_definition.md" - }, - { - "filename": "_generated_fcvolumesource_v1_definition.md" - }, - { - "filename": "_generated_flexvolumesource_v1_definition.md" - }, - { - "filename": "_generated_flockervolumesource_v1_definition.md" - }, - { - "filename": "_generated_gcepersistentdiskvolumesource_v1_definition.md" - }, - { - "filename": "_generated_gitrepovolumesource_v1_definition.md" - }, - { - "filename": "_generated_glusterfsvolumesource_v1_definition.md" - }, - { - "filename": "_generated_groupversionfordiscovery_unversioned_definition.md" - }, - { - "filename": "_generated_httpgetaction_v1_definition.md" - }, - { - "filename": "_generated_httpheader_v1_definition.md" - }, - { - "filename": "_generated_httpingresspath_v1beta1_definition.md" - }, - { - "filename": "_generated_httpingressrulevalue_v1beta1_definition.md" - }, - { - "filename": "_generated_handler_v1_definition.md" - }, - { - "filename": "_generated_hostpathvolumesource_v1_definition.md" - }, - { - "filename": "_generated_iscsivolumesource_v1_definition.md" - }, - { - "filename": "_generated_info_version_definition.md" - }, - { - "filename": "_generated_ingressbackend_v1beta1_definition.md" - }, - { - "filename": "_generated_ingressrule_v1beta1_definition.md" - }, - { - "filename": "_generated_ingresstls_v1beta1_definition.md" - }, - { - "filename": "_generated_intorstring_intstr_definition.md" - }, - { - "filename": "_generated_jobcondition_v1_definition.md" - }, - { - "filename": "_generated_jobtemplatespec_v2alpha1_definition.md" - }, - { - "filename": "_generated_keytopath_v1_definition.md" - }, - { - "filename": "_generated_labelselector_unversioned_definition.md" - }, - { - "filename": "_generated_labelselectorrequirement_unversioned_definition.md" - }, - { - "filename": "_generated_lifecycle_v1_definition.md" - }, - { - "filename": "_generated_limitrangeitem_v1_definition.md" - }, - { - "filename": "_generated_listmeta_unversioned_definition.md" - }, - { - "filename": "_generated_loadbalanceringress_v1_definition.md" - }, - { - "filename": "_generated_loadbalancerstatus_v1_definition.md" - }, - { - "filename": "_generated_localobjectreference_v1_definition.md" - }, - { - "filename": "_generated_nfsvolumesource_v1_definition.md" - }, - { - "filename": "_generated_networkpolicyingressrule_v1beta1_definition.md" - }, - { - "filename": "_generated_networkpolicypeer_v1beta1_definition.md" - }, - { - "filename": "_generated_networkpolicyport_v1beta1_definition.md" - }, - { - "filename": "_generated_nodeaddress_v1_definition.md" - }, - { - "filename": "_generated_nodecondition_v1_definition.md" - }, - { - "filename": "_generated_nodedaemonendpoints_v1_definition.md" - }, - { - "filename": "_generated_nodesysteminfo_v1_definition.md" - }, - { - "filename": "_generated_nonresourceattributes_v1beta1_definition.md" - }, - { - "filename": "_generated_objectfieldselector_v1_definition.md" - }, - { - "filename": "_generated_objectmeta_v1_definition.md" - }, - { - "filename": "_generated_objectreference_v1_definition.md" - }, - { - "filename": "_generated_ownerreference_v1_definition.md" - }, - { - "filename": "_generated_patch_unversioned_definition.md" - }, - { - "filename": "_generated_persistentvolumeclaimvolumesource_v1_definition.md" - }, - { - "filename": "_generated_photonpersistentdiskvolumesource_v1_definition.md" - }, - { - "filename": "_generated_podcondition_v1_definition.md" - }, - { - "filename": "_generated_podsecuritycontext_v1_definition.md" - }, - { - "filename": "_generated_policyrule_v1alpha1_definition.md" - }, - { - "filename": "_generated_preconditions_v1_definition.md" - }, - { - "filename": "_generated_probe_v1_definition.md" - }, - { - "filename": "_generated_quantity_resource_definition.md" - }, - { - "filename": "_generated_quobytevolumesource_v1_definition.md" - }, - { - "filename": "_generated_rbdvolumesource_v1_definition.md" - }, - { - "filename": "_generated_rawextension_runtime_definition.md" - }, - { - "filename": "_generated_replicasetcondition_v1beta1_definition.md" - }, - { - "filename": "_generated_replicationcontrollercondition_v1_definition.md" - }, - { - "filename": "_generated_resourceattributes_v1beta1_definition.md" - }, - { - "filename": "_generated_resourcefieldselector_v1_definition.md" - }, - { - "filename": "_generated_resourcerequirements_v1_definition.md" - }, - { - "filename": "_generated_roleref_v1alpha1_definition.md" - }, - { - "filename": "_generated_rollbackconfig_v1beta1_definition.md" - }, - { - "filename": "_generated_selinuxoptions_v1_definition.md" - }, - { - "filename": "_generated_scale_v1_definition.md" - }, - { - "filename": "_generated_secretkeyselector_v1_definition.md" - }, - { - "filename": "_generated_secretvolumesource_v1_definition.md" - }, - { - "filename": "_generated_securitycontext_v1_definition.md" - }, - { - "filename": "_generated_serveraddressbyclientcidr_unversioned_definition.md" - }, - { - "filename": "_generated_serviceport_v1_definition.md" - }, - { - "filename": "_generated_status_unversioned_definition.md" - }, - { - "filename": "_generated_statuscause_unversioned_definition.md" - }, - { - "filename": "_generated_statusdetails_unversioned_definition.md" - }, - { - "filename": "_generated_subject_v1alpha1_definition.md" - }, - { - "filename": "_generated_subresourcereference_v1beta1_definition.md" - }, - { - "filename": "_generated_tcpsocketaction_v1_definition.md" - }, - { - "filename": "_generated_time_unversioned_definition.md" - }, - { - "filename": "_generated_userinfo_v1beta1_definition.md" - }, - { - "filename": "_generated_volumemount_v1_definition.md" - }, - { - "filename": "_generated_vspherevirtualdiskvolumesource_v1_definition.md" - }, - { - "filename": "_oldversions.md" - }, - { - "filename": "_generated_event_versioned_concept.md" - }, - { - "filename": "_generated_horizontalpodautoscaler_v1beta1_concept.md" - }, - { - "filename": "_generated_job_v1beta1_concept.md" - }, - { - "filename": "_generated_job_v2alpha1_concept.md" - }, - { - "filename": "_generated_jobcondition_v1beta1_concept.md" - }, - { - "filename": "_generated_jobcondition_v2alpha1_concept.md" - }, - { - "filename": "_generated_scale_v1beta1_concept.md" - } - ], - "title": "Kubernetes Resource Reference Docs", - "copyright": "\u003ca href=\"https://github.com/kubernetes/kubernetes\"\u003eCopyright 2016 The Kubernetes Authors.\u003c/a\u003e" -} \ No newline at end of file diff --git a/docs/resources-reference/v1.5/runbrodocs.sh b/docs/resources-reference/v1.5/runbrodocs.sh deleted file mode 100755 index 7e1fce32ca..0000000000 --- a/docs/resources-reference/v1.5/runbrodocs.sh +++ /dev/null @@ -1,6 +0,0 @@ -#!/bin/bash - -cp /manifest/manifest.json ./manifest.json -cp /source/* ./documents/ -node brodoc.js -cp -r ./* /build/ diff --git a/docs/tasks/access-application-cluster/load-balance-access-application-cluster.md b/docs/tasks/access-application-cluster/load-balance-access-application-cluster.md index c42d97e3e9..f6cb1251fe 100644 --- a/docs/tasks/access-application-cluster/load-balance-access-application-cluster.md +++ b/docs/tasks/access-application-cluster/load-balance-access-application-cluster.md @@ -28,7 +28,7 @@ load-balanced access to an application running in a cluster. {% capture lessoncontent %} -### Creating a Service for an application running in two pods +## Creating a Service for an application running in two pods 1. Run a Hello World application in your cluster: @@ -98,7 +98,7 @@ load-balanced access to an application running in a cluster. where `` us the IP address of your Minikube node, and `` is the NodePort value for your service. -### Using a service configuration file +## Using a service configuration file As an alternative to using `kubectl expose`, you can use a [service configuration file](/docs/user-guide/services/operations) @@ -108,15 +108,6 @@ to create a Service. {% endcapture %} -{% capture cleanup %} - -If you want to stop the Hello World application, enter these commands: - - TODO - -{% endcapture %} - - {% capture whatsnext %} Learn more about diff --git a/docs/tasks/access-application-cluster/port-forward-access-application-cluster.md b/docs/tasks/access-application-cluster/port-forward-access-application-cluster.md index 4b0acb8f88..f3fe10161e 100644 --- a/docs/tasks/access-application-cluster/port-forward-access-application-cluster.md +++ b/docs/tasks/access-application-cluster/port-forward-access-application-cluster.md @@ -22,7 +22,7 @@ for database debugging. {% capture steps %} -### Creating a pod to run a Redis server +## Creating a pod to run a Redis server 1. Create a pod: @@ -51,7 +51,7 @@ for database debugging. 6379 -### Forward a local port to a port on the pod +## Forward a local port to a port on the pod 1. Forward port 6379 on the local workstation to port 6379 of redis-master pod: @@ -77,7 +77,7 @@ for database debugging. {% capture discussion %} -### Discussion +## Discussion Connections made to local port 6379 are forwarded to port 6379 of the pod that is running the Redis server. With this connection in place you can use your diff --git a/docs/tasks/access-kubernetes-api/http-proxy-access-api.md b/docs/tasks/access-kubernetes-api/http-proxy-access-api.md index 9dee7c9c4d..92baf97aa9 100644 --- a/docs/tasks/access-kubernetes-api/http-proxy-access-api.md +++ b/docs/tasks/access-kubernetes-api/http-proxy-access-api.md @@ -19,13 +19,13 @@ This page shows how to use an HTTP proxy to access the Kubernetes API. {% capture steps %} -### Using kubectl to start a proxy server +## Using kubectl to start a proxy server This command starts a proxy to the Kubernetes API server: kubectl proxy --port=8080 -### Exploring the Kubernetes API +## Exploring the Kubernetes API When the proxy server is running, you can explore the API using `curl`, `wget`, or a browser. diff --git a/docs/tasks/administer-cluster/assign-pods-nodes.md b/docs/tasks/administer-cluster/assign-pods-nodes.md index 03dc0c021c..43db077f76 100644 --- a/docs/tasks/administer-cluster/assign-pods-nodes.md +++ b/docs/tasks/administer-cluster/assign-pods-nodes.md @@ -15,7 +15,7 @@ Kubernetes cluster. {% capture steps %} -### Adding a label to a node +## Adding a label to a node 1. List the nodes in your cluster: @@ -49,7 +49,7 @@ Kubernetes cluster. In the preceding output, you can see that the `worker0` node has a `disktype=ssd` label. -### Creating a pod that gets scheduled to your chosen node +## Creating a pod that gets scheduled to your chosen node This pod configuration file describes a pod that has a node selector, `disktype: ssd`. This means that the pod will get scheduled on a node that has diff --git a/docs/tasks/administer-cluster/change-pv-reclaim-policy.md b/docs/tasks/administer-cluster/change-pv-reclaim-policy.md index 0e70c0c709..08a18f8f08 100644 --- a/docs/tasks/administer-cluster/change-pv-reclaim-policy.md +++ b/docs/tasks/administer-cluster/change-pv-reclaim-policy.md @@ -15,7 +15,7 @@ PersistentVolume. {% capture steps %} -### Why change reclaim policy of a PersistentVolume +## Why change reclaim policy of a PersistentVolume `PersistentVolumes` can have various reclaim policies, including "Retain", "Recycle", and "Delete". For dynamically provisioned `PersistentVolumes`, @@ -27,7 +27,7 @@ policy. With the "Retain" policy, if a user deletes a `PeristentVolumeClaim`, the corresponding `PersistentVolume` is not be deleted. Instead, it is moved to the `Released` phase, where all of its data can be manually recovered. -### Changing the reclaim policy of a PersistentVolume +## Changing the reclaim policy of a PersistentVolume 1. List the PersistentVolumes in your cluster: @@ -70,7 +70,7 @@ the corresponding `PersistentVolume` is not be deleted. Instead, it is moved to * Learn more about [PersistentVolumes](/docs/user-guide/persistent-volumes/). * Learn more about [PersistentVolumeClaims](/docs/user-guide/persistent-volumes/#persistentvolumeclaims). -#### Reference +### Reference * [PersistentVolume](/docs/api-reference/v1/definitions/#_v1_persistentvolume) * [PersistentVolumeClaim](/docs/api-reference/v1/definitions/#_v1_persistentvolumeclaim) diff --git a/docs/tasks/administer-cluster/dns-horizontal-autoscaling.md b/docs/tasks/administer-cluster/dns-horizontal-autoscaling.md index fa8202865d..069409058a 100644 --- a/docs/tasks/administer-cluster/dns-horizontal-autoscaling.md +++ b/docs/tasks/administer-cluster/dns-horizontal-autoscaling.md @@ -19,7 +19,7 @@ Kubernetes cluster. {% capture steps %} -### Determining whether DNS horizontal autoscaling is already enabled +## Determining whether DNS horizontal autoscaling is already enabled List the Deployments in your cluster in the kube-system namespace: @@ -36,7 +36,7 @@ If you see "kube-dns-autoscaler" in the output, DNS horizontal autoscaling is already enabled, and you can skip to [Tuning autoscaling parameters](#tuning-autoscaling-parameters). -### Getting the name of your DNS Deployment or ReplicationController +## Getting the name of your DNS Deployment or ReplicationController List the Deployments in your cluster in the kube-system namespace: @@ -63,7 +63,7 @@ The output is similar to this: kube-dns-v20 1 1 1 ... ... -### Determining your scale target +## Determining your scale target If you have a DNS Deployment, your scale target is: @@ -80,7 +80,7 @@ where is the name of your DNS ReplicationController. For example, if your DNS ReplicationController name is kube-dns-v20, your scale target is ReplicationController/kube-dns-v20. -### Enabling DNS horizontal autoscaling +## Enabling DNS horizontal autoscaling In this section, you create a Deployment. The Pods in the Deployment run a container based on the `cluster-proportional-autoscaler-amd64` image. @@ -102,7 +102,7 @@ The output of a successful command is: DNS horizontal autoscaling is now enabled. -### Tuning autoscaling parameters +## Tuning autoscaling parameters Verify that the kube-dns-autoscaler ConfigMap exists: @@ -139,12 +139,12 @@ cores, `nodesPerReplica` dominates. There are other supported scaling patterns. For details, see [cluster-proportional-autoscaler](https://github.com/kubernetes-incubator/cluster-proportional-autoscaler). -### Disable DNS horizontal autoscaling +## Disable DNS horizontal autoscaling There are a few options for turning DNS horizontal autoscaling. Which option to use depends on different conditions. -#### Option 1: Scale down the kube-dns-autoscaler deployment to 0 replicas +### Option 1: Scale down the kube-dns-autoscaler deployment to 0 replicas This option works for all situations. Enter this command: @@ -165,7 +165,7 @@ The output displays 0 in the DESIRED and CURRENT columns: kube-dns-autoscaler 0 0 0 0 ... ... -#### Option 2: Delete the kube-dns-autoscaler deployment +### Option 2: Delete the kube-dns-autoscaler deployment This option works if kube-dns-autoscaler is under your own control, which means no one will re-create it: @@ -176,7 +176,7 @@ The output is: deployment "kube-dns-autoscaler" deleted -#### Option 3: Delete the kube-dns-autoscaler manifest file from the master node +### Option 3: Delete the kube-dns-autoscaler manifest file from the master node This option works if kube-dns-autoscaler is under control of the [Addon Manager](https://github.com/kubernetes/kubernetes/blob/master/cluster/addons/README.md)'s @@ -194,7 +194,7 @@ kube-dns-autoscaler Deployment. {% capture discussion %} -### Understanding how DNS horizontal autoscaling works +## Understanding how DNS horizontal autoscaling works * The cluster-proportional-autoscaler application is deployed separately from the DNS service. @@ -215,7 +215,7 @@ the autoscaler Pod. * The autoscaler provides a controller interface to support two control patterns: *linear* and *ladder*. -### Future enhancements +## Future enhancements Control patterns, in addition to linear and ladder, that consider custom metrics are under consideration as a future development. diff --git a/docs/tasks/administer-cluster/safely-drain-node.md b/docs/tasks/administer-cluster/safely-drain-node.md index 902d9b1db3..d69bcb2363 100644 --- a/docs/tasks/administer-cluster/safely-drain-node.md +++ b/docs/tasks/administer-cluster/safely-drain-node.md @@ -21,7 +21,7 @@ application-level disruption SLOs you want the system to enforce. {% capture steps %} -### Use `kubectl drain` to remove a node from service +## Use `kubectl drain` to remove a node from service You can use `kubectl drain` to safely evict all of your pods from a node before you perform maintenance on the node (e.g. kernel upgrade, @@ -64,7 +64,7 @@ kubectl uncordon ``` afterwards to tell Kubernetes that it can resume scheduling new pods onto the node. -### Draining multiple nodes in parallel +## Draining multiple nodes in parallel The `kubectl drain` command should only be issued to a single node at a time. However, you can run multiple `kubectl drain` commands for diff --git a/docs/tasks/configure-pod-container/assign-cpu-ram-container.md b/docs/tasks/configure-pod-container/assign-cpu-ram-container.md index 8722499c34..24cca3eca5 100644 --- a/docs/tasks/configure-pod-container/assign-cpu-ram-container.md +++ b/docs/tasks/configure-pod-container/assign-cpu-ram-container.md @@ -19,7 +19,7 @@ in a Kubernetes Pod. {% capture steps %} -### Assigning CPU and RAM resources to a container +## Assigning CPU and RAM resources to a container When you create a Pod, you can request CPU and RAM resources for the containers that run in the Pod. You can also set limits for CPU and RAM resources. To @@ -64,7 +64,7 @@ for the `Pod`: cpu: 250m memory: 64Mi -### Understanding CPU and RAM units +## Understanding CPU and RAM units The CPU resource is measured in *cpu*s. Fractional values are allowed. You can use the suffix *m* to mean mili. For example 100m cpu is 100 milicpu, and is @@ -89,7 +89,7 @@ If you specify a request, a Pod is guaranteed to be able to use that much of the resource. See [Resource QoS](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/resource-qos.md) for the difference between resource limits and requests. -### If you don't specify limits or requests +## If you don't specify limits or requests If you don't specify a RAM limit, Kubernetes places no upper bound on the amount of RAM a Container can use. A Container could use all the RAM diff --git a/docs/tasks/configure-pod-container/attach-handler-lifecycle-event.md b/docs/tasks/configure-pod-container/attach-handler-lifecycle-event.md index 715ea3effb..a46f910714 100644 --- a/docs/tasks/configure-pod-container/attach-handler-lifecycle-event.md +++ b/docs/tasks/configure-pod-container/attach-handler-lifecycle-event.md @@ -21,7 +21,7 @@ Container is terminated. {% capture steps %} -### Defining postStart and preStop handlers +## Defining postStart and preStop handlers In this exercise, you create a Pod that has one Container. The Container has handlers for the postStart and preStop events. @@ -60,7 +60,7 @@ The output shows the text written by the postStart handler: {% capture discussion %} -### Discussion +## Discussion Kubernetes sends the postStart event immediately after the Container is created. There is no guarantee, however, that the postStart handler is called before @@ -83,7 +83,7 @@ unless the Pod's grace period expires. For more details, see * Learn more about the [lifecycle of a Pod](https://kubernetes.io/docs/user-guide/pod-states/). -#### Reference +### Reference * [Lifecycle](https://kubernetes.io/docs/resources-reference/1_5/#lifecycle-v1) * [Container](https://kubernetes.io/docs/resources-reference/1_5/#container-v1) diff --git a/docs/tasks/configure-pod-container/communicate-containers-same-pod.md b/docs/tasks/configure-pod-container/communicate-containers-same-pod.md index 0f934dc085..815ee8dc19 100644 --- a/docs/tasks/configure-pod-container/communicate-containers-same-pod.md +++ b/docs/tasks/configure-pod-container/communicate-containers-same-pod.md @@ -19,7 +19,7 @@ in the same Pod. {% capture steps %} -### Creating a Pod that runs two Containers +## Creating a Pod that runs two Containers In this exercise, you create a Pod that runs two Containers. The two containers share a Volume that they can use to communicate. Here is the configuration file @@ -111,7 +111,7 @@ The output shows that nginx serves a web page written by the debian container: {% capture discussion %} -### Discussion +## Discussion The primary reason that Pods can have multiple containers is to support helper applications that assist a primary application. Typical examples of diff --git a/docs/tasks/configure-pod-container/configure-liveness-readiness-probes.md b/docs/tasks/configure-pod-container/configure-liveness-readiness-probes.md index 3b7f7462ef..8c877ac16c 100644 --- a/docs/tasks/configure-pod-container/configure-liveness-readiness-probes.md +++ b/docs/tasks/configure-pod-container/configure-liveness-readiness-probes.md @@ -30,7 +30,7 @@ When a Pod is not ready, it is removed from Service load balancers. {% capture steps %} -### Defining a liveness command +## Defining a liveness command Many applications running for long periods of time eventually transition to broken states, and cannot recover except by being restarted. Kubernetes provides @@ -117,7 +117,7 @@ NAME READY STATUS RESTARTS AGE liveness-exec 1/1 Running 1 1m ``` -### Defining a liveness HTTP request +## Defining a liveness HTTP request Another kind of liveness probe uses an HTTP GET request. Here is the configuration file for a Pod that runs a container based on the `gcr.io/google_containers/liveness` @@ -173,7 +173,7 @@ the Container has been restarted: kubectl describe pod liveness-http ``` -### Using a named port +## Using a named port You can use a named [ContainerPort](/docs/api-reference/v1/definitions/#_v1_containerport) @@ -191,7 +191,7 @@ livenessProbe: port: liveness-port ``` -### Defining readiness probes +## Defining readiness probes Sometimes, applications are temporarily unable to serve traffic. For example, an application might need to load large data or configuration @@ -219,7 +219,7 @@ readinessProbe: {% capture discussion %} -### Discussion +## Discussion {% comment %} Eventually, some of this Discussion section could be moved to a concept topic. @@ -260,7 +260,7 @@ In addition to command probes and HTTP probes, Kubenetes supports * Learn more about [Health Checking section](/docs/user-guide/walkthrough/k8s201/#health-checking). -#### Reference +### Reference * [Pod](http://kubernetes.io/docs/api-reference/v1/definitions#_v1_pod) * [Container](/docs/api-reference/v1/definitions/#_v1_container) diff --git a/docs/tasks/configure-pod-container/configure-pod-initialization.md b/docs/tasks/configure-pod-container/configure-pod-initialization.md index add65b09ee..7aa2bff40a 100644 --- a/docs/tasks/configure-pod-container/configure-pod-initialization.md +++ b/docs/tasks/configure-pod-container/configure-pod-initialization.md @@ -16,7 +16,7 @@ application Container runs. {% capture steps %} -### Creating a Pod that has an init Container +## Creating a Pod that has an init Container In this exercise you create a Pod that has one application Container and one init Container. The init Container runs to completion before the application diff --git a/docs/tasks/configure-pod-container/configure-volume-storage.md b/docs/tasks/configure-pod-container/configure-volume-storage.md index 6919a91fb0..92756615a8 100644 --- a/docs/tasks/configure-pod-container/configure-volume-storage.md +++ b/docs/tasks/configure-pod-container/configure-volume-storage.md @@ -23,7 +23,7 @@ key-value cache and store. {% capture steps %} -### Configuring a volume for a Pod +## Configuring a volume for a Pod In this exercise, you create a Pod that runs one Container. This Pod has a Volume of type diff --git a/docs/tasks/configure-pod-container/define-command-argument-container.md b/docs/tasks/configure-pod-container/define-command-argument-container.md index 4fd988744d..df4350aa1a 100644 --- a/docs/tasks/configure-pod-container/define-command-argument-container.md +++ b/docs/tasks/configure-pod-container/define-command-argument-container.md @@ -19,7 +19,7 @@ in a Kubernetes Pod. {% capture steps %} -### Defining a command and arguments when you create a Pod +## Defining a command and arguments when you create a Pod When you create a Pod, you can define a command and arguments for the containers that run in the Pod. To define a command, include the `command` @@ -60,7 +60,7 @@ from the Pod: command-demo tcp://10.3.240.1:443 -### Using environment variables to define arguments +## Using environment variables to define arguments In the preceding example, you defined the arguments directly by providing strings. As an alternative to providing strings directly, @@ -81,7 +81,7 @@ and NOTE: The environment variable appears in parentheses, `"$(VAR)"`. This is required for the variable to be expanded in the `command` or `args` field. -### Running a command in a shell +## Running a command in a shell In some cases, you need your command to run in a shell. For example, your command might consist of several commands piped together, or it might be a shell diff --git a/docs/tasks/configure-pod-container/define-environment-variable-container.md b/docs/tasks/configure-pod-container/define-environment-variable-container.md index f24f1bcc8a..214142fa80 100644 --- a/docs/tasks/configure-pod-container/define-environment-variable-container.md +++ b/docs/tasks/configure-pod-container/define-environment-variable-container.md @@ -19,7 +19,7 @@ in a Kubernetes Pod. {% capture steps %} -### Defining an environment variable for a container +## Defining an environment variable for a container When you create a Pod, you can set environment variables for the containers that run in the Pod. To set environment variables, include the `env` field in @@ -38,7 +38,7 @@ Pod: 1. List the running Pods: - kubectl get pods + kubectl get pods -l purpose=demonstrate-envars The output is similar to this: diff --git a/docs/tasks/configure-pod-container/distribute-credentials-secure.md b/docs/tasks/configure-pod-container/distribute-credentials-secure.md index 48272a7cba..69d5d37890 100644 --- a/docs/tasks/configure-pod-container/distribute-credentials-secure.md +++ b/docs/tasks/configure-pod-container/distribute-credentials-secure.md @@ -15,7 +15,7 @@ encryption keys, into Pods. {% capture steps %} -### Converting your secret data to a base-64 representation +## Converting your secret data to a base-64 representation Suppose you want to have two pieces of secret data: a username `my-app` and a password `39528$vdg7Jb`. First, use [Base64 encoding](https://www.base64encode.org/) to @@ -28,7 +28,7 @@ example: The output shows that the base-64 representation of your username is `bXktYXBwCg==`, and the base-64 representation of your password is `Mzk1MjgkdmRnN0piCg==`. -### Creating a Secret +## Creating a Secret Here is a configuration file you can use to create a Secret that holds your username and password: @@ -72,7 +72,7 @@ username and password: password: 13 bytes username: 7 bytes -### Creating a Pod that has access to the secret data through a Volume +## Creating a Pod that has access to the secret data through a Volume Here is a configuration file you can use to create a Pod: @@ -119,7 +119,7 @@ is exposed: my-app 39528$vdg7Jb -### Creating a Pod that has access to the secret data through environment variables +## Creating a Pod that has access to the secret data through environment variables Here is a configuration file you can use to create a Pod: @@ -160,7 +160,7 @@ Here is a configuration file you can use to create a Pod: * Learn more about [Secrets](/docs/user-guide/secrets/). * Learn about [Volumes](/docs/user-guide/volumes/). -#### Reference +### Reference * [Secret](docs/api-reference/v1/definitions/#_v1_secret) * [Volume](docs/api-reference/v1/definitions/#_v1_volume) diff --git a/docs/tasks/configure-pod-container/pull-image-private-registry.md b/docs/tasks/configure-pod-container/pull-image-private-registry.md index 5560dd9a30..e9b640873a 100644 --- a/docs/tasks/configure-pod-container/pull-image-private-registry.md +++ b/docs/tasks/configure-pod-container/pull-image-private-registry.md @@ -20,7 +20,7 @@ private Docker registry or repository. {% capture steps %} -### Logging in to Docker +## Logging in to Docker docker login @@ -43,7 +43,7 @@ The output contains a section similar to this: } } -### Creating a Secret that holds your authorization token +## Creating a Secret that holds your authorization token Create a Secret named `regsecret`: @@ -55,7 +55,7 @@ where: * `` is your Docker password. * `` is your Docker email. -### Understanding your Secret +## Understanding your Secret To understand what's in the Secret you just created, start by viewing the Secret in YAML format: @@ -92,7 +92,7 @@ The output is similar to this: Notice that the secret data contains the authorization token from your `config.json` file. -### Creating a Pod that uses your Secret +## Creating a Pod that uses your Secret Here is a configuration file for a Pod that needs access to your secret data: diff --git a/docs/tasks/debug-application-cluster/determine-reason-pod-failure.md b/docs/tasks/debug-application-cluster/determine-reason-pod-failure.md index 3f1c5fbc89..3a0e79898a 100644 --- a/docs/tasks/debug-application-cluster/determine-reason-pod-failure.md +++ b/docs/tasks/debug-application-cluster/determine-reason-pod-failure.md @@ -27,7 +27,7 @@ the general {% capture steps %} -### Writing and reading a termination message +## Writing and reading a termination message In this exercise, you create a Pod that runs one container. The configuration file specifies a command that runs when @@ -75,7 +75,7 @@ only the termination message: {% raw %} kubectl get pod termination-demo -o go-template="{{range .status.containerStatuses}}{{.lastState.terminated.message}}{{end}}"{% endraw %} ``` -### Setting the termination log file +## Setting the termination log file By default Kubernetes retrieves termination messages from `/dev/termination-log`. To change this to a different file, diff --git a/docs/tasks/index.md b/docs/tasks/index.md index 544036b749..242c1dca75 100644 --- a/docs/tasks/index.md +++ b/docs/tasks/index.md @@ -3,6 +3,12 @@ title: Tasks redirect_from: - "/docs/user-guide/production-pods/" - "/docs/user-guide/production-pods.html" +- "/docs/user-guide/simple-nginx/" +- "/docs/user-guide/simple-nginx.html" +- "/docs/user-guide/pods/single-container/" +- "/docs/user-guide/pods/single-container.html" +- "/docs/user-guide/configuring-containers/" +- "/docs/user-guide/configuring-containers.html" --- This section of the Kubernetes documentation contains pages that @@ -18,7 +24,7 @@ single thing, typically by giving a short sequence of steps. * [Distributing Credentials Securely](/docs/tasks/configure-pod-container/distribute-credentials-secure/) * [Pulling an Image from a Private Registry](/docs/tasks/configure-pod-container/pull-image-private-registry/) * [Configuring Liveness and Readiness Probes](/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/) -* [Communicating Between Pods Running in the Same Container](/docs/tasks/configure-pod-container/communicate-containers-same-pod/) +* [Communicating Between Containers Running in the Same Pod](/docs/tasks/configure-pod-container/communicate-containers-same-pod/) * [Configuring Pod Initialization](/docs/tasks/configure-pod-container/configure-pod-initialization/) * [Attaching Handlers to Container Lifecycle Events](/docs/tasks/configure-pod-container/attach-handler-lifecycle-event/) diff --git a/docs/tasks/manage-stateful-set/debugging-a-statefulset.md b/docs/tasks/manage-stateful-set/debugging-a-statefulset.md index 2266d7a323..f66a8a1c53 100644 --- a/docs/tasks/manage-stateful-set/debugging-a-statefulset.md +++ b/docs/tasks/manage-stateful-set/debugging-a-statefulset.md @@ -26,7 +26,7 @@ This task shows you how to debug a StatefulSet. {% capture steps %} -### Debugging a StatefulSet +## Debugging a StatefulSet In order to list all the pods which belong to a StatefulSet, which have a label `app=myapp` set on them, you can use the following: @@ -44,7 +44,7 @@ kubectl annotate pods pod.alpha.kubernetes.io/initialized="false" --o When the annotation is set to `"false"`, the StatefulSet will not respond to its Pods becoming unhealthy or unavailable. It will not create replacement Pods till the annotation is removed or set to `"true"` on each StatefulSet Pod. -#### Step-wise Initialization +### Step-wise Initialization You can also use the same annotation to debug race conditions during bootstrapping of the StatefulSet by setting the `pod.alpha.kubernetes.io/initialized` annotation to `"false"` in the `.spec.template.metadata.annotations` field of the StatefulSet prior to creating it. diff --git a/docs/tasks/manage-stateful-set/delete-pods.md b/docs/tasks/manage-stateful-set/delete-pods.md index 4b31def936..d1b66ce881 100644 --- a/docs/tasks/manage-stateful-set/delete-pods.md +++ b/docs/tasks/manage-stateful-set/delete-pods.md @@ -21,13 +21,13 @@ This page shows how to delete Pods which are part of a stateful set, and explain {% capture steps %} -### StatefulSet considerations +## StatefulSet considerations In normal operation of a StatefulSet, there is **never** a need to force delete a StatefulSet Pod. The StatefulSet controller is responsible for creating, scaling and deleting members of the StatefulSet. It tries to ensure that the specified number of Pods from ordinal 0 through N-1 are alive and ready. StatefulSet ensures that, at any time, there is at most one Pod with a given identity running in a cluster. This is referred to as *at most one* semantics provided by a StatefulSet. Manual force deletion should be undertaken with caution, as it has the potential to violate the at most one semantics inherent to StatefulSet. StatefulSets may be used to run distributed and clustered applications which have a need for a stable network identity and stable storage. These applications often have configuration which relies on an ensemble of a fixed number of members with fixed identities. Having multiple members with the same identity can be disastrous and may lead to data loss (e.g. split brain scenario in quorum-based systems). -### Deleting Pods +## Deleting Pods You can perform a graceful pod deletion with the following command: @@ -46,7 +46,7 @@ The recommended best practice is to use the first or second approach. If a Node Normally, the system completes the deletion once the Pod is no longer running on a Node, or the Node is deleted by an administrator. You may override this by force deleting the Pod. -#### Force Deletion +### Force Deletion Force deletions **do not** wait for confirmation from the kubelet that the Pod has been terminated. Irrespective of whether a force deletion is successful in killing a Pod, it will immediately free up the name from the apiserver. This would let the StatefulSet controller create a replacement Pod with that same identity; this can lead to the duplication of a still-running Pod, and if said Pod can still communicate with the other members of the StatefulSet, will violate the at most one semantics that StatefulSet is designed to guarantee. diff --git a/docs/tasks/manage-stateful-set/deleting-a-statefulset.md b/docs/tasks/manage-stateful-set/deleting-a-statefulset.md index 5ea82aef04..76cc87dcf0 100644 --- a/docs/tasks/manage-stateful-set/deleting-a-statefulset.md +++ b/docs/tasks/manage-stateful-set/deleting-a-statefulset.md @@ -22,7 +22,7 @@ This task shows you how to delete a StatefulSet. {% capture steps %} -### Deleting a StatefulSet +## Deleting a StatefulSet You can delete a StatefulSet in the same way you delete other resources in Kubernetes: use the `kubectl delete` command, and specify the StatefulSet either by file or by name. @@ -52,13 +52,13 @@ By passing `--cascade=false` to `kubectl delete`, the Pods managed by the Statef kubectl delete pods -l app=myapp ``` -#### Persistent Volumes +### Persistent Volumes Deleting the Pods in a StatefulSet will not delete the associated volumes. This is to ensure that you have the chance to copy data off the volume before deleting it. Deleting the PVC after the pods have left the [terminating state](/docs/user-guide/pods/index#termination-of-pods) might trigger deletion of the backing Persistent Volumes depending on the storage class and reclaim policy. You should never assume ability to access a volume after claim deletion. **Note: Use caution when deleting a PVC, as it may lead to data loss.** -#### Complete deletion of a StatefulSet +### Complete deletion of a StatefulSet To simply delete everything in a StatefulSet, including the associated pods, you can run a series of commands similar to the following: @@ -72,7 +72,7 @@ kubectl delete pvc -l app=myapp In the example above, the Pods have the label `app=myapp`; substitute your own label as appropriate. -#### Force deletion of StatefulSet pods +### Force deletion of StatefulSet pods If you find that some pods in your StatefulSet are stuck in the 'Terminating' or 'Unknown' states for an extended period of time, you may need to manually intervene to forcefully delete the pods from the apiserver. This is a potentially dangerous task. Refer to [Deleting StatefulSet Pods](/docs/tasks/manage-stateful-set/delete-pods/) for details. diff --git a/docs/tasks/manage-stateful-set/scale-stateful-set.md b/docs/tasks/manage-stateful-set/scale-stateful-set.md index d00fbc055b..eda728efdd 100644 --- a/docs/tasks/manage-stateful-set/scale-stateful-set.md +++ b/docs/tasks/manage-stateful-set/scale-stateful-set.md @@ -25,13 +25,13 @@ This page shows how to scale a StatefulSet. {% capture steps %} -### Use `kubectl` to scale StatefulSets +## Use `kubectl` to scale StatefulSets Make sure you have `kubectl` upgraded to Kubernetes version 1.5 or later before continuing. If you're unsure, run `kubectl version` and check `Client Version` for which kubectl you're using. -#### `kubectl scale` +### `kubectl scale` First, find the StatefulSet you want to scale. Remember, you need to first understand if you can scale it or not. @@ -45,7 +45,7 @@ Change the number of replicas of your StatefulSet: kubectl scale statefulsets --replicas= ``` -#### Alternative: `kubectl apply` / `kubectl edit` / `kubectl patch` +### Alternative: `kubectl apply` / `kubectl edit` / `kubectl patch` Alternatively, you can do [in-place updates](/docs/user-guide/managing-deployments/#in-place-updates-of-resources) on your StatefulSets. @@ -68,9 +68,9 @@ Or use `kubectl patch`: kubectl patch statefulsets -p '{"spec":{"replicas":}}' ``` -### Troubleshooting +## Troubleshooting -#### Scaling down doesn't not work right +### Scaling down doesn't not work right You cannot scale down a StatefulSet when any of the stateful Pods it manages is unhealthy. Scaling down only takes place after those stateful Pods become running and ready. diff --git a/docs/tasks/manage-stateful-set/upgrade-pet-set-to-stateful-set.md b/docs/tasks/manage-stateful-set/upgrade-pet-set-to-stateful-set.md index 592d07f833..57852bd1cc 100644 --- a/docs/tasks/manage-stateful-set/upgrade-pet-set-to-stateful-set.md +++ b/docs/tasks/manage-stateful-set/upgrade-pet-set-to-stateful-set.md @@ -23,7 +23,7 @@ This page shows how to upgrade from PetSets (Kubernetes version 1.3 or 1.4) to * {% capture steps %} -### Differences between alpha PetSets and beta StatefulSets +## Differences between alpha PetSets and beta StatefulSets PetSet was introduced as an alpha resource in Kubernetes release 1.3, and was renamed to StatefulSet as a beta resource in 1.5. Here are some notable changes: @@ -33,13 +33,13 @@ Here are some notable changes: * **Flipped debug annotation behavior**: The default value of the debug annotation (`pod.alpha.kubernetes.io/initialized`) is now `true`. The absence of this annotation will pause PetSet operations, but will NOT pause StatefulSet operations. In most cases, you no longer need this annotation in your StatefulSet manifests. -### Upgrading from PetSets to StatefulSets +## Upgrading from PetSets to StatefulSets Note that these steps need to be done in the specified order. You **should NOT upgrade your Kubernetes master, nodes, or `kubectl` to Kubernetes version 1.5 or later**, until told to do so. -#### Find all PetSets and their manifests +### Find all PetSets and their manifests First, find all existing PetSets in your cluster: @@ -60,7 +60,7 @@ Here's an example command for you to save all existing PetSets as one file. kubectl get petsets --all-namespaces -o yaml > all-petsets.yaml ``` -#### Prepare StatefulSet manifests +### Prepare StatefulSet manifests Now, for every PetSet manifest you have, prepare a corresponding StatefulSet manifest: @@ -71,7 +71,7 @@ Now, for every PetSet manifest you have, prepare a corresponding StatefulSet man It's recommended that you keep both PetSet manifests and StatefulSet manifests, so that you can safely roll back and recreate your PetSets, if you decide not to upgrade your cluster. -#### Delete all PetSets without cascading +### Delete all PetSets without cascading If you find existing PetSets in your cluster in the previous step, you need to delete all PetSets *without cascading*. You can do this from `kubectl` with `--cascade=false`. Note that if the flag isn't set, **cascading deletion will be performed by default**, and all Pods managed by your PetSets will be gone. @@ -103,18 +103,18 @@ kubectl get petsets --all-namespaces At this moment, you've deleted all PetSets in your cluster, but not their Pods, Persistent Volumes, or Persistent Volume Claims. However, since the Pods are not managed by PetSets anymore, they will be vulnerable to node failures until you finish the master upgrade and recreate StatefulSets. -#### Upgrade your master to Kubernetes version 1.5 or later +### Upgrade your master to Kubernetes version 1.5 or later Now, you can [upgrade your Kubernetes master](/docs/admin/cluster-management/#upgrading-a-cluster) to Kubernetes version 1.5 or later. Note that **you should NOT upgrade Nodes at this time**, because the Pods (that were once managed by PetSets) are now vulnerable to node failures. -#### Upgrade kubectl to Kubernetes version 1.5 or later +### Upgrade kubectl to Kubernetes version 1.5 or later Upgrade `kubectl` to Kubernetes version 1.5 or later, following [the steps for installing and setting up kubectl](/docs/user-guide/prereqs/). -#### Create StatefulSets +### Create StatefulSets Make sure you have both master and `kubectl` upgraded to Kubernetes version 1.5 or later before continuing: @@ -147,7 +147,7 @@ newly-upgraded cluster: kubectl get statefulsets --all-namespaces ``` -#### Upgrade nodes to Kubernetes version 1.5 or later (optional) +### Upgrade nodes to Kubernetes version 1.5 or later (optional) You can now [upgrade Kubernetes nodes](/docs/admin/cluster-management/#upgrading-a-cluster) to Kubernetes version 1.5 or later. This step is optional, but needs to be done after all StatefulSets diff --git a/docs/tasks/troubleshoot/debug-init-containers.md b/docs/tasks/troubleshoot/debug-init-containers.md index 1739c03f5a..3c362c5072 100644 --- a/docs/tasks/troubleshoot/debug-init-containers.md +++ b/docs/tasks/troubleshoot/debug-init-containers.md @@ -30,7 +30,7 @@ Init Containers. {% capture steps %} -### Checking the status of Init Containers +## Checking the status of Init Containers The Pod status will give you an overview of Init Container execution: @@ -49,7 +49,7 @@ NAME READY STATUS RESTARTS AGE See [Understanding Pod status](#understanding-pod-status) for more examples of status values and their meanings. -### Getting details about Init Containers +## Getting details about Init Containers You can see detailed information about Init Container execution by running: @@ -98,7 +98,7 @@ kubectl get pod --template '{{index .metadata.annotations "pod.beta.k This will return the same information as above, but in raw JSON format. -### Accessing logs from Init Containers +## Accessing logs from Init Containers You can access logs for an Init Container by passing its Container name along with the Pod name: @@ -115,7 +115,7 @@ commands as they're executed. For example, you can do this in Bash by running {% capture discussion %} -### Understanding Pod status +## Understanding Pod status A Pod status beginning with `Init:` summarizes the status of Init Container execution. The table below describes some example status values that you might diff --git a/docs/tutorials/services/source-ip.md b/docs/tutorials/services/source-ip.md index 6efdb42870..56daa8b345 100644 --- a/docs/tutorials/services/source-ip.md +++ b/docs/tutorials/services/source-ip.md @@ -15,7 +15,7 @@ of Services, and how you can toggle this behavior according to your needs. {% include task-tutorial-prereqs.md %} -### Terminology +## Terminology This document makes use of the following terms: @@ -26,7 +26,7 @@ This document makes use of the following terms: * [Kube-proxy](/docs/user-guide/services/#virtual-ips-and-service-proxies): a network daemon that orchestrates Service VIP management on every node -### Prerequisites +## Prerequisites You must have a working Kubernetes 1.5 cluster to run the examples in this document. The examples use a small nginx webserver that echoes back the source @@ -50,7 +50,7 @@ deployment "source-ip-app" created {% capture lessoncontent %} -### Source IP for Services with Type=ClusterIP +## Source IP for Services with Type=ClusterIP Packets sent to ClusterIP from within the cluster are never source NAT'd if you're running kube-proxy in [iptables mode](/docs/user-guide/services/#proxy-mode-iptables), @@ -107,7 +107,7 @@ command=GET ... ``` -### Source IP for Services with Type=NodePort +## Source IP for Services with Type=NodePort As of Kubernetes 1.5, packets sent to Services with [Type=NodePort](/docs/user-guide/services/#type-nodeport) are source NAT'd by default. You can test this by creating a `NodePort` Service: @@ -204,7 +204,7 @@ Visually: -### Source IP for Services with Type=LoadBalancer +## Source IP for Services with Type=LoadBalancer As of Kubernetes 1.5, packets sent to Services with [Type=LoadBalancer](/docs/user-guide/services/#type-loadbalancer) are source NAT'd by default, because all schedulable Kubernetes nodes in the diff --git a/docs/tutorials/stateful-application/basic-stateful-set.md b/docs/tutorials/stateful-application/basic-stateful-set.md index 179dd94f71..2a72070ac8 100644 --- a/docs/tutorials/stateful-application/basic-stateful-set.md +++ b/docs/tutorials/stateful-application/basic-stateful-set.md @@ -25,6 +25,7 @@ following Kubernetes concepts. * [Cluster DNS](/docs/admin/dns/) * [Headless Services](/docs/user-guide/services/#headless-services) * [PersistentVolumes](/docs/user-guide/volumes/) +* [PersistentVolume Provisioning](http://releases.k8s.io/{{page.githubbranch}}/examples/persistent-volume-provisioning/) * [StatefulSets](/docs/concepts/abstractions/controllers/statefulsets/) * [kubectl CLI](/docs/user-guide/kubectl) @@ -51,7 +52,7 @@ After this tutorial, you will be familiar with the following. {% endcapture %} {% capture lessoncontent %} -### Creating a StatefulSet +## Creating a StatefulSet Begin by creating a StatefulSet using the example below. It is similar to the example presented in the @@ -95,7 +96,7 @@ NAME DESIRED CURRENT AGE web 2 1 20s ``` -#### Ordered Pod Creation +### Ordered Pod Creation For a StatefulSet with N replicas, when Pods are being deployed, they are created sequentially, in order from {0..N-1}. Examine the output of the @@ -120,11 +121,11 @@ Notice that the `web-0` Pod is launched and set to Pending prior to launching `web-1`. In fact, `web-1` is not launched until `web-0` is [Running and Ready](/docs/user-guide/pod-states). -### Pods in a StatefulSet +## Pods in a StatefulSet Unlike Pods in other controllers, the Pods in a StatefulSet have a unique ordinal index and a stable network identity. -#### Examining the Pod's Ordinal Index +### Examining the Pod's Ordinal Index Get the StatefulSet's Pods. @@ -143,7 +144,7 @@ Set controller. The Pods' names take the form `-`. Since the `web` StatefulSet has two replicas, it creates two Pods, `web-0` and `web-1`. -#### Using Stable Network Identities +### Using Stable Network Identities Each Pod has a stable hostname based on its ordinal index. Use [`kubectl exec`](/docs/user-guide/kubectl/kubectl_exec/) to execute the `hostname` command in each Pod. @@ -253,7 +254,7 @@ liveness and readiness, you can use the SRV records of the Pods ( application will be able to discover the Pods' addresses when they transition to Running and Ready. -#### Writing to Stable Storage +### Writing to Stable Storage Get the PersistentVolumeClaims for `web-0` and `web-1`. @@ -284,6 +285,16 @@ web-0 web-1 ``` +Note, if you instead see 403 Forbidden responses for the above curl command, +you will need to fix the permissions of the directory mounted by the `volumeMounts` +(due to a [bug when using hostPath volumes](https://github.com/kubernetes/kubernetes/issues/2630)) with: + +```shell +for i in 0 1; do kubectl exec web-$i -- chmod 755 /usr/share/nginx/html; done +``` + +before retrying the curl command above. + In one terminal, watch the StatefulSet's Pods. ```shell @@ -326,14 +337,14 @@ Volume Claims are remounted to their `volumeMount`s. No matter what node `web-0` and `web-1` are scheduled on, their PersistentVolumes will be mounted to the appropriate mount points. -### Scaling a StatefulSet +## Scaling a StatefulSet Scaling a StatefulSet refers to increasing or decreasing the number of replicas. This is accomplished by updating the `replicas` field. You can use either [`kubectl scale`](/docs/user-guide/kubectl/kubectl_scale/) or [`kubectl patch`](/docs/user-guide/kubectl/kubectl_patch/) to scale a Stateful Set. -#### Scaling Up +### Scaling Up In one terminal window, watch the Pods in the StatefulSet. @@ -378,7 +389,7 @@ created each Pod sequentially with respect to its ordinal index, and it waited for each Pod's predecessor to be Running and Ready before launching the subsequent Pod. -#### Scaling Down +### Scaling Down In one terminal, watch the StatefulSet's Pods. @@ -412,7 +423,7 @@ web-3 1/1 Terminating 0 42s web-3 1/1 Terminating 0 42s ``` -#### Ordered Pod Termination +### Ordered Pod Termination The controller deleted one Pod at a time, with respect to its ordinal index, in reverse order, and it waited for each to be completely shutdown before @@ -438,7 +449,7 @@ the StatefulSet's Pods are deleted. This is still true when Pod deletion is caused by scaling the StatefulSet down. This feature can be used to facilitate upgrading the container images of Pods in a StatefulSet. -### Updating Containers +## Updating Containers As demonstrated in the [Scaling a StatefulSet](#scaling-a-statefulset) section, the `replicas` field of a StatefulSet is mutable. The only other field of a StatefulSet that can be updated is the `spec.template.containers` field. @@ -530,14 +541,14 @@ gcr.io/google_containers/nginx-slim:0.7 All the Pods in the StatefulSet are now running a new container image. -### Deleting StatefulSets +## Deleting StatefulSets StatefulSet supports both Non-Cascading and Cascading deletion. In a Non-Cascading Delete, the StatefulSet's Pods are not deleted when the Stateful Set is deleted. In a Cascading Delete, both the StatefulSet and its Pods are deleted. -#### Non-Cascading Delete +### Non-Cascading Delete In one terminal window, watch the Pods in the StatefulSet. @@ -643,7 +654,7 @@ because the StatefulSet never deletes the PersistentVolumes associated with a Pod. When you recreated the StatefulSet and it relaunched `web-0`, its original PersistentVolume was remounted. -#### Cascading Delete +### Cascading Delete In one terminal window, watch the Pods in the StatefulSet. diff --git a/docs/tutorials/stateful-application/mysql-statefulset.yaml b/docs/tutorials/stateful-application/mysql-statefulset.yaml index 106f77cd99..d8ee2d9ac9 100644 --- a/docs/tutorials/stateful-application/mysql-statefulset.yaml +++ b/docs/tutorials/stateful-application/mysql-statefulset.yaml @@ -16,8 +16,6 @@ spec: "image": "mysql:5.7", "command": ["bash", "-c", " set -ex\n - # mysqld --initialize expects an empty data dir.\n - rm -rf /mnt/data/lost+found\n # Generate mysql server-id from pod ordinal index.\n [[ `hostname` =~ -([0-9]+)$ ]] || exit 1\n ordinal=${BASH_REMATCH[1]}\n @@ -32,7 +30,6 @@ spec: fi\n "], "volumeMounts": [ - {"name": "data", "mountPath": "/mnt/data"}, {"name": "conf", "mountPath": "/mnt/conf.d"}, {"name": "config-map", "mountPath": "/mnt/config-map"} ] @@ -54,7 +51,7 @@ spec: xtrabackup --prepare --target-dir=/var/lib/mysql\n "], "volumeMounts": [ - {"name": "data", "mountPath": "/var/lib/mysql"}, + {"name": "data", "mountPath": "/var/lib/mysql", "subPath": "mysql"}, {"name": "conf", "mountPath": "/etc/mysql/conf.d"} ] } @@ -72,6 +69,7 @@ spec: volumeMounts: - name: data mountPath: /var/lib/mysql + subPath: mysql - name: conf mountPath: /etc/mysql/conf.d resources: @@ -140,6 +138,7 @@ spec: volumeMounts: - name: data mountPath: /var/lib/mysql + subPath: mysql - name: conf mountPath: /etc/mysql/conf.d resources: diff --git a/docs/tutorials/stateful-application/run-replicated-stateful-application.md b/docs/tutorials/stateful-application/run-replicated-stateful-application.md index 30d22e1cce..cdc373b00d 100644 --- a/docs/tutorials/stateful-application/run-replicated-stateful-application.md +++ b/docs/tutorials/stateful-application/run-replicated-stateful-application.md @@ -49,12 +49,12 @@ on general patterns for running stateful applications in Kubernetes. {% capture lessoncontent %} -### Deploying MySQL +## Deploying MySQL The example MySQL deployment consists of a ConfigMap, two Services, and a StatefulSet. -#### ConfigMap +### ConfigMap Create the ConfigMap from the following YAML configuration file: @@ -74,7 +74,7 @@ portions to apply to different Pods. Each Pod decides which portion to look at as it's initializing, based on information provided by the StatefulSet controller. -#### Services +### Services Create the Services from the following YAML configuration file: @@ -100,7 +100,7 @@ Because there is only one MySQL master, clients should connect directly to the MySQL master Pod (through its DNS entry within the Headless Service) to execute writes. -#### StatefulSet +### StatefulSet Finally, create the StatefulSet from the following YAML configuration file: @@ -133,7 +133,7 @@ This manifest uses a variety of techniques for managing stateful Pods as part of a StatefulSet. The next section highlights some of these techniques to explain what happens as the StatefulSet creates Pods. -### Understanding stateful Pod initialization +## Understanding stateful Pod initialization The StatefulSet controller starts Pods one at a time, in order by their ordinal index. @@ -146,7 +146,7 @@ In this case, that results in Pods named `mysql-0`, `mysql-1`, and `mysql-2`. The Pod template in the above StatefulSet manifest takes advantage of these properties to perform orderly startup of MySQL replication. -#### Generating configuration +### Generating configuration Before starting any of the containers in the Pod spec, the Pod first runs any [Init Containers](/docs/user-guide/production-pods/#handling-initialization) @@ -175,7 +175,7 @@ Combined with the StatefulSet controller's this ensures the MySQL master is Ready before creating slaves, so they can begin replicating. -#### Cloning existing data +### Cloning existing data In general, when a new Pod joins the set as a slave, it must assume the MySQL master might already have data on it. It also must assume that the replication @@ -196,7 +196,7 @@ from the Pod whose ordinal index is one lower. This works because the StatefulSet controller always ensures Pod `N` is Ready before starting Pod `N+1`. -#### Starting replication +### Starting replication After the Init Containers complete successfully, the regular containers run. The MySQL Pods consist of a `mysql` container that runs the actual `mysqld` @@ -220,7 +220,7 @@ connections from other Pods requesting a data clone. This server remains up indefinitely in case the StatefulSet scales up, or in case the next Pod loses its PersistentVolumeClaim and needs to redo the clone. -### Sending client traffic +## Sending client traffic You can send test queries to the MySQL master (hostname `mysql-0.mysql`) by running a temporary container with the `mysql:5.7` image and running the @@ -287,13 +287,13 @@ endpoint might be selected upon each connection attempt: You can press **Ctrl+C** when you want to stop the loop, but it's useful to keep it running in another window so you can see the effects of the following steps. -### Simulating Pod and Node downtime +## Simulating Pod and Node downtime To demonstrate the increased availability of reading from the pool of slaves instead of a single server, keep the `SELECT @@server_id` loop from above running while you force a Pod out of the Ready state. -#### Break the Readiness Probe +### Break the Readiness Probe The [readiness probe](/docs/user-guide/production-pods/#liveness-and-readiness-probes-aka-health-checks) for the `mysql` container runs the command `mysql -h 127.0.0.1 -e 'SELECT 1'` @@ -333,7 +333,7 @@ after a few seconds: kubectl exec mysql-2 -c mysql -- mv /usr/bin/mysql.off /usr/bin/mysql ``` -#### Delete Pods +### Delete Pods The StatefulSet also recreates Pods if they're deleted, similar to what a ReplicaSet does for stateless Pods. @@ -348,7 +348,7 @@ PersistentVolumeClaim. You should see server ID `102` disappear from the loop output for a while and then return on its own. -#### Drain a Node +### Drain a Node If your Kubernetes cluster has multiple Nodes, you can simulate Node downtime (such as when Nodes are upgraded) by issuing a @@ -407,7 +407,7 @@ Now uncordon the Node to return it to a normal state: kubectl uncordon ``` -### Scaling the number of slaves +## Scaling the number of slaves With MySQL replication, you can scale your read query capacity by adding slaves. With StatefulSet, you can do this with a single command: diff --git a/docs/tutorials/stateful-application/run-stateful-application.md b/docs/tutorials/stateful-application/run-stateful-application.md index 928aaecacd..dc7655831f 100644 --- a/docs/tutorials/stateful-application/run-stateful-application.md +++ b/docs/tutorials/stateful-application/run-stateful-application.md @@ -37,7 +37,7 @@ application is MySQL. {% capture lessoncontent %} -### Set up a disk in your environment +## Set up a disk in your environment You can use any type of persistent volume for your stateful app. See [Types of Persistent Volumes](/docs/user-guide/persistent-volumes/#types-of-persistent-volumes) @@ -66,7 +66,7 @@ kubectl create -f http://k8s.io/docs/tutorials/stateful-application/gce-volume.y ``` -### Deploy MySQL +## Deploy MySQL You can run a stateful application by creating a Kubernetes Deployment and connecting it to an existing PersistentVolume using a @@ -146,7 +146,7 @@ for a secure solution. Access Modes: RWO No events. -### Accessing the MySQL instance +## Accessing the MySQL instance The preceding YAML file creates a service that allows other Pods in the cluster to access the database. The Service option @@ -171,7 +171,7 @@ If you don't see a command prompt, try pressing enter. mysql> ``` -### Updating +## Updating The image or any other part of the Deployment can be updated as usual with the `kubectl apply` command. Here are some precautions that are @@ -187,7 +187,7 @@ specific to stateful apps: one Pod running at a time. The `Recreate` strategy will stop the first pod before creating a new one with the updated configuration. -### Deleting a deployment +## Deleting a deployment Delete the deployed objects by name: diff --git a/docs/tutorials/stateful-application/zookeeper.md b/docs/tutorials/stateful-application/zookeeper.md index 1b550fe718..ba2bb219d6 100644 --- a/docs/tutorials/stateful-application/zookeeper.md +++ b/docs/tutorials/stateful-application/zookeeper.md @@ -26,7 +26,7 @@ Kubernetes concepts. * [Cluster DNS](/docs/admin/dns/) * [Headless Services](/docs/user-guide/services/#headless-services) * [PersistentVolumes](/docs/user-guide/volumes/) -* [PersistentVolume Provisioning](http://releases.k8s.io/{{page.githubbranch}}/examples/experimental/persistent-volume-provisioning/) +* [PersistentVolume Provisioning](http://releases.k8s.io/{{page.githubbranch}}/examples/persistent-volume-provisioning/) * [ConfigMaps](/docs/user-guide/configmap/) * [StatefulSets](/docs/concepts/abstractions/controllers/statefulsets/) * [PodDisruptionBudgets](/docs/admin/disruptions/#specifying-a-poddisruptionbudget) @@ -58,7 +58,7 @@ After this tutorial, you will know the following. {% capture lessoncontent %} -#### ZooKeeper Basics +### ZooKeeper Basics [Apache ZooKeeper](https://zookeeper.apache.org/doc/current/) is a distributed, open-source coordination service for distributed applications. @@ -86,7 +86,7 @@ snapshot their in memory state to storage media. These snapshots can be loaded directly into memory, and all WAL entries that preceded the snapshot may be safely discarded. -### Creating a ZooKeeper Ensemble +## Creating a ZooKeeper Ensemble The manifest below contains a [Headless Service](/docs/user-guide/services/#headless-services), @@ -145,7 +145,7 @@ zk-2 1/1 Running 0 40s The StatefulSet controller creates three Pods, and each Pod has a container with a [ZooKeeper 3.4.9](http://www-us.apache.org/dist/zookeeper/zookeeper-3.4.9/) server. -#### Facilitating Leader Election +### Facilitating Leader Election As there is no terminating algorithm for electing a leader in an anonymous network, Zab requires explicit membership configuration in order to perform @@ -242,7 +242,7 @@ server.2=zk-1.zk-headless.default.svc.cluster.local:2888:3888 server.3=zk-2.zk-headless.default.svc.cluster.local:2888:3888 ``` -#### Achieving Consensus +### Achieving Consensus Consensus protocols require that the identifiers of each participant be unique. No two participants in the Zab protocol should claim the same unique @@ -301,7 +301,7 @@ and at least two of the Pods are Running and Ready), or they will fail to do so (if either of the aforementioned conditions are not met). No state will arise where one server acknowledges a write on behalf of another. -#### Sanity Testing the Ensemble +### Sanity Testing the Ensemble The most basic sanity test is to write some data to one ZooKeeper server and to read the data from another. @@ -348,7 +348,7 @@ dataLength = 5 numChildren = 0 ``` -#### Providing Durable Storage +### Providing Durable Storage As mentioned in the [ZooKeeper Basics](#zookeeper-basics) section, ZooKeeper commits all entries to a durable WAL, and periodically writes snapshots @@ -507,7 +507,7 @@ same PersistentVolume mounted to the ZooKeeper server's data directory. Even when the Pods are rescheduled, all of the writes made to the ZooKeeper servers' WALs, and all of their snapshots, remain durable. -### Ensuring Consistent Configuration +## Ensuring Consistent Configuration As noted in the [Facilitating Leader Election](#facilitating-leader-election) and [Achieving Consensus](#achieving-consensus) sections, the servers in a @@ -651,7 +651,7 @@ ZK_DATA_LOG_DIR=/var/lib/zookeeper/log ZK_LOG_DIR=/var/log/zookeeper ``` -#### Configuring Logging +### Configuring Logging One of the files generated by the `zkConfigGen.sh` script controls ZooKeeper's logging. ZooKeeper uses [Log4j](http://logging.apache.org/log4j/2.x/), and, by default, @@ -721,7 +721,7 @@ For cluster level log shipping and aggregation, you should consider deploying a [sidecar](http://blog.kubernetes.io/2015/06/the-distributed-system-toolkit-patterns.html) container to rotate and ship your logs. -#### Configuring a Non-Privileged User +### Configuring a Non-Privileged User The best practices with respect to allowing an application to run as a privileged user inside of a container are a matter of debate. If your organization requires @@ -773,7 +773,7 @@ and the ZooKeeper process is able to successfully read and write its data. drwxr-sr-x 3 zookeeper zookeeper 4096 Dec 5 20:45 /var/lib/zookeeper/data ``` -### Managing the ZooKeeper Process +## Managing the ZooKeeper Process The [ZooKeeper documentation](https://zookeeper.apache.org/doc/current/zookeeperAdmin.html#sc_supervision) documentation indicates that "You will want to have a supervisory process that @@ -783,7 +783,7 @@ common pattern. When deploying an application in Kubernetes, rather than using an external utility as a supervisory process, you should use Kubernetes as the watchdog for your application. -#### Handling Process Failure +### Handling Process Failure [Restart Policies](/docs/user-guide/pod-states/#restartpolicy) control how @@ -846,7 +846,7 @@ child process. This ensures that Kubernetes will restart the application's container when the process implementing the application's business logic fails. -#### Testing for Liveness +### Testing for Liveness Configuring your application to restart failed processes is not sufficient to @@ -918,7 +918,7 @@ zk-0 1/1 Running 1 1h ``` -#### Testing for Readiness +### Testing for Readiness Readiness is not the same as liveness. If a process is alive, it is scheduled @@ -951,7 +951,7 @@ to specify both. This ensures that only healthy servers in the ZooKeeper ensemble receive network traffic. -### Tolerating Node Failure +## Tolerating Node Failure ZooKeeper needs a quorum of servers in order to successfully commit mutations to data. For a three server ensemble, two servers must be healthy in order for @@ -1013,7 +1013,7 @@ Service in the domain defined by the `topologyKey`. The `topologyKey` different rules, labels, and selectors, you can extend this technique to spread your ensemble across physical, network, and power failure domains. -### Surviving Maintenance +## Surviving Maintenance **In this section you will cordon and drain nodes. If you are using this tutorial on a shared cluster, be sure that this will not adversely affect other tenants.** diff --git a/docs/tutorials/stateless-application/expose-external-ip-address-service.md b/docs/tutorials/stateless-application/expose-external-ip-address-service.md index 23bffda9df..f4a63b1e31 100644 --- a/docs/tutorials/stateless-application/expose-external-ip-address-service.md +++ b/docs/tutorials/stateless-application/expose-external-ip-address-service.md @@ -29,7 +29,7 @@ provides load balancing for an application that has two running instances. {% capture lessoncontent %} -### Creating a service for an application running in two pods +## Creating a service for an application running in two pods 1. Run a Hello World application in your cluster: @@ -111,7 +111,7 @@ provides load balancing for an application that has two running instances. Hello Kubernetes! -### Using a service configuration file +## Using a service configuration file As an alternative to using `kubectl expose`, you can use a [service configuration file](/docs/user-guide/services/operations) diff --git a/docs/tutorials/stateless-application/expose-external-ip-address.md b/docs/tutorials/stateless-application/expose-external-ip-address.md index f21abf7e61..665a06a2b0 100644 --- a/docs/tutorials/stateless-application/expose-external-ip-address.md +++ b/docs/tutorials/stateless-application/expose-external-ip-address.md @@ -36,7 +36,7 @@ external IP address. {% capture lessoncontent %} -### Creating a service for an application running in five pods +## Creating a service for an application running in five pods 1. Run a Hello World application in your cluster: diff --git a/docs/tutorials/stateless-application/hello-minikube.md b/docs/tutorials/stateless-application/hello-minikube.md index 4f75960b4e..36b92dd97a 100644 --- a/docs/tutorials/stateless-application/hello-minikube.md +++ b/docs/tutorials/stateless-application/hello-minikube.md @@ -38,7 +38,7 @@ driver. {% capture lessoncontent %} -### Create a Minikube cluster +## Create a Minikube cluster This tutorial uses [Minikube](https://github.com/kubernetes/minikube) to create a local cluster. This tutorial also assumes you are using @@ -70,12 +70,23 @@ curl -LO https://storage.googleapis.com/kubernetes-release/release/$(curl -s htt chmod +x ./kubectl sudo mv ./kubectl /usr/local/bin/kubectl ``` +Determine whether you can access sites like [https://cloud.google.com/container-registry/](https://cloud.google.com/container-registry/) directly without a proxy, by opening a new terminal and using +```shell +export http_proxy="" +export https_proxy="" +curl https://cloud.google.com/container-registry/ +``` -Start the Minikube cluster: +If NO proxy is required, start the Minikube cluster: ```shell minikube start --vm-driver=xhyve ``` +If a proxy server is required, use the following method to start Minikube cluster with proxy setting: + +```shell +minikube start --vm-driver=xhyve --docker-env HTTP_PROXY=http://your-http-proxy-host:your-http-proxy-port --docker-env HTTPS_PROXY=http(s)://your-https-proxy-host:your-https-proxy-port +``` The `--vm-driver=xyhve` flag specifies that you are using Docker for Mac. The default VM driver is VirtualBox. @@ -94,7 +105,7 @@ Verify that `kubectl` is configured to communicate with your cluster: kubectl cluster-info ``` -### Create your Node.js application +## Create your Node.js application The next step is to write the application. Save this code in a folder named `hellonode` with the filename `server.js`: @@ -113,7 +124,7 @@ Stop the running Node.js server by pressing **Ctrl-C**. The next step is to package your application in a Docker container. -### Create a Docker container image +## Create a Docker container image Create a file, also in the `hellonode` folder, named `Dockerfile`. A Dockerfile describes the image that you want to build. You can build a Docker container image by extending an @@ -145,7 +156,7 @@ docker build -t hello-node:v1 . Now the Minikube VM can run the image you built. -### Create a Deployment +## Create a Deployment A Kubernetes [*Pod*](/docs/user-guide/pods/) is a group of one or more Containers, tied together for the purposes of administration and networking. The Pod in this @@ -206,7 +217,7 @@ kubectl config view For more information about `kubectl`commands, see the [kubectl overview](/docs/user-guide/kubectl-overview/). -### Create a Service +## Create a Service By default, the Pod is only accessible by its internal IP address within the Kubernetes cluster. To make the `hello-node` Container accessible from outside the @@ -254,7 +265,7 @@ you should now be able to see some logs: kubectl logs ``` -### Update your app +## Update your app Edit your `server.js` file to return a new message: @@ -281,7 +292,7 @@ Run your app again to view the new message: minikube service hello-node ``` -### Clean up +## Clean up Now you can clean up the resources you created in your cluster: diff --git a/docs/tutorials/stateless-application/run-stateless-application-deployment.md b/docs/tutorials/stateless-application/run-stateless-application-deployment.md index 06ccc74579..8e3d725752 100644 --- a/docs/tutorials/stateless-application/run-stateless-application-deployment.md +++ b/docs/tutorials/stateless-application/run-stateless-application-deployment.md @@ -27,7 +27,7 @@ This page shows how to run an application using a Kubernetes Deployment object. {% capture lessoncontent %} -### Creating and exploring an nginx deployment +## Creating and exploring an nginx deployment You can run an application by creating a Kubernetes Deployment object, and you can describe a Deployment in a YAML file. For example, this YAML file describes @@ -72,7 +72,7 @@ a Deployment that runs the nginx:1.7.9 Docker image: where `` is the name of one of your pods. -### Updating the deployment +## Updating the deployment You can update the deployment by applying a new YAML file. This YAML file specifies that the deployment should be updated to use nginx 1.8. @@ -87,7 +87,7 @@ specifies that the deployment should be updated to use nginx 1.8. kubectl get pods -l app=nginx -### Scaling the application by increasing the replica count +## Scaling the application by increasing the replica count You can increase the number of pods in your Deployment by applying a new YAML file. This YAML file sets `replicas` to 4, which specifies that the Deployment @@ -111,7 +111,7 @@ should have four pods: nginx-deployment-148880595-fxcez 1/1 Running 0 2m nginx-deployment-148880595-rwovn 1/1 Running 0 2m -### Deleting a deployment +## Deleting a deployment Delete the deployment by name: diff --git a/docs/user-guide/compute-resources.md b/docs/user-guide/compute-resources.md index 2e524e9117..d2856f50aa 100644 --- a/docs/user-guide/compute-resources.md +++ b/docs/user-guide/compute-resources.md @@ -122,17 +122,16 @@ runner (Docker or rkt). When using Docker: - The `spec.containers[].resources.requests.cpu` is converted to its core value (potentially fractional), - and multiplied by 1024, and used as the value of the [`--cpu-shares`]( - https://docs.docker.com/reference/run/#runtime-constraints-on-resources) flag to the `docker run` - command. + and multiplied by 1024, and used as the value of the [`--cpu-shares`](https://docs.docker.com/engine/reference/run/#/cpu-share-constraint) + flag to the `docker run` command. - The `spec.containers[].resources.limits.cpu` is converted to its millicore value, multiplied by 100000, and then divided by 1000, and used as the value of the [`--cpu-quota`]( - https://docs.docker.com/reference/run/#runtime-constraints-on-resources) flag to the `docker run` + https://docs.docker.com/engine/reference/run/#/cpu-quota-constraint) flag to the `docker run` command. The [`--cpu-period`] flag is set to 100000 which represents the default 100ms period for measuring quota usage. The kubelet enforces cpu limits if it was started with the [`--cpu-cfs-quota`] flag set to true. As of version 1.2, this flag will now default to true. - The `spec.containers[].resources.limits.memory` is converted to an integer, and used as the value - of the [`--memory`](https://docs.docker.com/reference/run/#runtime-constraints-on-resources) flag + of the [`--memory`](https://docs.docker.com/engine/reference/run/#/user-memory-constraints) flag to the `docker run` command. **TODO: document behavior for rkt** @@ -362,7 +361,7 @@ such as [EmptyDir volumes](/docs/user-guide/volumes/#emptydir). The current system only supports container requests and limits for CPU and Memory. It is planned to add new resource types, including a node disk space -resource, and a framework for adding custom [resource types](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/resources.md#resource-types). +resource, and a framework for adding custom [resource types](https://github.com/kubernetes/community/blob/{{page.githubbranch}}/contributors/design-proposals/resources.md). Kubernetes supports overcommitment of resources by supporting multiple levels of [Quality of Service](http://issue.k8s.io/168). diff --git a/docs/user-guide/configmap/index.md b/docs/user-guide/configmap/index.md index d630ed2aa8..3227e416c0 100644 --- a/docs/user-guide/configmap/index.md +++ b/docs/user-guide/configmap/index.md @@ -291,6 +291,34 @@ SPECIAL_LEVEL_KEY=very SPECIAL_TYPE_KEY=charm ``` +#### Optional ConfigMap in environment variables + +There might be situations where environment variables are not +always required. These environment variables can be marked as optional in a +pod like so: + +```yaml +apiVersion: v1 +kind: Pod +metadata: + name: dapi-test-pod +spec: + containers: + - name: test-container + image: gcr.io/google_containers/busybox + command: [ "/bin/sh", "-c", "env" ] + env: + - name: SPECIAL_LEVEL_KEY + valueFrom: + configMapKeyRef: + name: a-config + key: akey + optional: true + restartPolicy: Never +``` + +When this pod is run, the output will be empty. + ### Use-Case: Set command-line arguments with ConfigMap ConfigMaps can also be used to set the value of the command or arguments in a container. This is @@ -422,6 +450,38 @@ very You can project keys to specific paths and specific permissions on a per-file basis. The [Secrets](/docs/user-guide/secrets/) user guide explains the syntax. +#### Optional ConfigMap via volume plugin + +Volumes and files provided by a ConfigMap can be also be marked as optional. +The ConfigMap or the key specified does not have to exist. The mount path for +such items will always be created. + +```yaml +apiVersion: v1 +kind: Pod +metadata: + name: dapi-test-pod +spec: + containers: + - name: test-container + image: gcr.io/google_containers/busybox + command: [ "/bin/sh", "-c", "ls /etc/config" ] + volumeMounts: + - name: config-volume + mountPath: /etc/config + volumes: + - name: config-volume + configMap: + name: no-config + optional: true + restartPolicy: Never +``` + +When this pod is run, the output will be: + +```shell +``` + ## Real World Example: Configuring Redis Let's take a look at a real-world example: configuring redis using ConfigMap. Say we want to inject @@ -517,9 +577,10 @@ $ kubectl exec -it redis redis-cli ## Restrictions -ConfigMaps must be created before they are consumed in pods. Controllers may be written to tolerate -missing configuration data; consult individual components configured via ConfigMap on a case-by-case -basis. +ConfigMaps must be created before they are consumed in pods unless they are +marked as optional. Controllers may be written to tolerate missing +configuration data; consult individual components configured via ConfigMap on +a case-by-case basis. ConfigMaps reside in a namespace. They can only be referenced by pods in the same namespace. diff --git a/docs/user-guide/configuring-containers.md b/docs/user-guide/configuring-containers.md deleted file mode 100644 index 51ac150f07..0000000000 --- a/docs/user-guide/configuring-containers.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -assignees: -- caesarxuchao -- thockin -title: Configuring Containers ---- - -* TOC -{:toc} - -## Configuration in Kubernetes - -In addition to the imperative-style commands, such as `kubectl run` and `kubectl expose`, described [elsewhere](/docs/user-guide/quick-start), Kubernetes supports declarative configuration. Oftentimes, configuration files are preferable to imperative commands, since they can be checked into version control and changes to the files can be code reviewed, which is especially important for more complex configurations, producing a more robust, reliable and archival system. - -In the declarative style, all configuration is stored in YAML or JSON configuration files using Kubernetes's API resource schemas as the configuration schemas. `kubectl` can create, update, delete, and get API resources. The `apiVersion` (currently `v1`?), resource `kind`, and resource `name` are used by `kubectl` to construct the appropriate API path to invoke for the specified operation. - -## Launching a container using a configuration file - -Kubernetes executes containers in [*Pods*](/docs/user-guide/pods). A pod containing a simple Hello World container can be specified in YAML as follows: - -```yaml -apiVersion: v1 -kind: Pod -metadata: - name: hello-world -spec: # specification of the pod's contents - restartPolicy: Never - containers: - - name: hello - image: "ubuntu:14.04" - command: ["/bin/echo", "hello", "world"] -``` - -The value of `metadata.name`, `hello-world`, will be the name of the pod resource created, and must be unique within the cluster, whereas `containers[0].name` is just a nickname for the container within that pod. `image` is the name of the Docker image, which Kubernetes expects to be able to pull from a registry, the [Docker Hub](https://registry.hub.docker.com/) by default. - -`restartPolicy: Never` indicates that we just want to run the container once and then terminate the pod. - -The [`command`](/docs/user-guide/containers/#containers-and-commands) overrides the Docker container's `Entrypoint`. Command arguments (corresponding to Docker's `Cmd`) may be specified using `args`, as follows: - -```yaml - command: ["/bin/echo"] - args: ["hello","world"] -``` - -This pod can be created using the `create` command: - -```shell -$ kubectl create -f ./hello-world.yaml -pods/hello-world -``` - -`kubectl` prints the resource type and name of the resource created when successful. - -## Validating configuration - -We enable validation by default in `kubectl` since v1.1. - -Let's say you specified `entrypoint` instead of `command`. You'd see output as follows: - -```shell -error validating "./hello-world.yaml": error validating data: found invalid field Entrypoint for v1.Container; if you choose to ignore these errors, turn validation off with --validate=false -``` - -Using `kubectl create --validate=false` to turn validation off, it creates the resource anyway, unless a required field is absent or a field value is invalid. Unknown API fields are ignored, so be careful. This pod was created, but with no `command`, which is an optional field, since the image may specify an `Entrypoint`. -View the [Pod API -object](/docs/api-reference/v1/definitions/#_v1_pod) -to see the list of valid fields. - -## Environment variables and variable expansion - -Kubernetes [does not automatically run commands in a shell](https://github.com/kubernetes/kubernetes/wiki/User-FAQ#use-of-environment-variables-on-the-command-line) (not all images contain shells). If you would like to run your command in a shell, such as to expand environment variables (specified using `env`), you could do the following: - -```yaml -apiVersion: v1 -kind: Pod -metadata: - name: hello-world -spec: # specification of the pod's contents - restartPolicy: Never - containers: - - name: hello - image: "ubuntu:14.04" - env: - - name: MESSAGE - value: "hello world" - command: ["/bin/sh","-c"] - args: ["/bin/echo \"${MESSAGE}\""] -``` - -However, a shell isn't necessary just to expand environment variables. Kubernetes will do it for you if you use [`$(ENVVAR)` syntax](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/expansion.md): - -```yaml - command: ["/bin/echo"] - args: ["$(MESSAGE)"] -``` - -## Viewing pod status - -You can see the pod you created (actually all of your cluster's pods) using the `get` command. - -If you're quick, it will look as follows: - -```shell -$ kubectl get pods -NAME READY STATUS RESTARTS AGE -hello-world 0/1 Pending 0 0s -``` - -Initially, a newly created pod is unscheduled -- no node has been selected to run it. Scheduling happens after creation, but is fast, so you normally shouldn't see pods in an unscheduled state unless there's a problem. - -After the pod has been scheduled, the image may need to be pulled to the node on which it was scheduled, if it hadn't been pulled already. After a few seconds, you should see the container running: - -```shell -$ kubectl get pods -NAME READY STATUS RESTARTS AGE -hello-world 1/1 Running 0 5s -``` - -The `READY` column shows how many containers in the pod are running. - -Almost immediately after it starts running, this command will terminate. `kubectl` shows that the container is no longer running and displays the exit status: - -```shell -$ kubectl get pods --show-all -NAME READY STATUS RESTARTS AGE -hello-world 0/1 ExitCode:0 0 15s -``` - -## Viewing pod output - -You probably want to see the output of the command you ran. As with [`docker logs`](https://docs.docker.com/engine/reference/commandline/logs/), `kubectl logs` will show you the output: - -```shell -$ kubectl logs hello-world -hello world -``` - -## Deleting pods - -When you're done looking at the output, you should delete the pod: - -```shell -$ kubectl delete pod hello-world -pods/hello-world -``` - -As with `create`, `kubectl` prints the resource type and name of the resource deleted when successful. - -You can also use the resource/name format to specify the pod: - -```shell -$ kubectl delete pods/hello-world -pods/hello-world -``` - -Terminated pods aren't currently automatically deleted, so that you can observe their final status, so be sure to clean up your dead pods. - -On the other hand, containers and their logs are eventually deleted automatically in order to free up disk space on the nodes. - -## What's next? - -[Learn about deploying continuously running applications.](/docs/user-guide/deploying-applications) diff --git a/docs/user-guide/counter-pod.yaml b/docs/user-guide/counter-pod.yaml deleted file mode 100644 index c624b4d339..0000000000 --- a/docs/user-guide/counter-pod.yaml +++ /dev/null @@ -1,12 +0,0 @@ -apiVersion: v1 -kind: Pod -metadata: - name: counter -spec: - containers: - - name: count - image: ubuntu:14.04 - args: [bash, -c, - 'for ((i = 0; ; i++)); do echo "$i: $(date)"; sleep 1; done'] - - diff --git a/docs/user-guide/downward-api/dapi-pod.yaml b/docs/user-guide/downward-api/dapi-pod.yaml index 7d688aa0e9..5de0260bfc 100644 --- a/docs/user-guide/downward-api/dapi-pod.yaml +++ b/docs/user-guide/downward-api/dapi-pod.yaml @@ -8,6 +8,10 @@ spec: image: gcr.io/google_containers/busybox command: [ "/bin/sh", "-c", "env" ] env: + - name: MY_NODE_NAME + valueFrom: + fieldRef: + fieldPath: spec.nodeName - name: MY_POD_NAME valueFrom: fieldRef: @@ -20,4 +24,8 @@ spec: valueFrom: fieldRef: fieldPath: status.podIP + - name: MY_POD_SERVICE_ACCOUNT + valueFrom: + fieldRef: + fieldPath: spec.serviceAccountName restartPolicy: Never diff --git a/docs/user-guide/downward-api/index.md b/docs/user-guide/downward-api/index.md index 00cef8f43e..33b2b06c49 100644 --- a/docs/user-guide/downward-api/index.md +++ b/docs/user-guide/downward-api/index.md @@ -22,9 +22,11 @@ the Pod's name, for example, and inject it into this well-known variable. The following information is available to a `Pod` through the downward API: -* The pod's name +* The node's name +*   The pod's name * The pod's namespace * The pod's IP +* The pod's service account name * A container's cpu limit * A container's cpu request * A container's memory limit @@ -101,10 +103,12 @@ In future, it will be possible to specify an output format option. Downward API volumes can expose: +* The node's name * The pod's name * The pod's namespace * The pod's labels * The pod's annotations +* The pod's service account name * A container's cpu limit * A container's cpu request * A container's memory limit diff --git a/docs/user-guide/environment-guide/index.md b/docs/user-guide/environment-guide/index.md index 417cf5be33..cbdd806ecd 100644 --- a/docs/user-guide/environment-guide/index.md +++ b/docs/user-guide/environment-guide/index.md @@ -79,7 +79,7 @@ First the frontend pod's information is printed. The pod name and [namespace](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/namespaces.md) are retrieved from the [Downward API](/docs/user-guide/downward-api). Next, `USER_VAR` is the name of an environment variable set in the [pod -definition](/docs/user-guide/environment-guide/show-rc.yaml). Then, the dynamic Kubernetes environment +definition](https://raw.githubusercontent.com/kubernetes/kubernetes.github.io/master/docs/user-guide/environment-guide/show-rc.yaml). Then, the dynamic Kubernetes environment variables are scanned and printed. These are used to find the backend service, named `backend-srv`. Finally, the frontend pod queries the backend service and prints the information returned. Again the backend diff --git a/docs/user-guide/federation/index.md b/docs/user-guide/federation/index.md index 719a3e8174..cf1c1f96ed 100644 --- a/docs/user-guide/federation/index.md +++ b/docs/user-guide/federation/index.md @@ -37,13 +37,15 @@ Once we have the control plane setup, we can start creating federation API resources. The following guides explain some of the resources in detail: +* [ConfigMap](/docs/user-guide/federation/configmap/) +* [DaemonSets](/docs/user-guide/federation/daemonsets/) +* [Deployment](/docs/user-guide/federation/deployment/) * [Events](/docs/user-guide/federation/events/) * [Ingress](/docs/user-guide/federation/federated-ingress/) * [Namespaces](/docs/user-guide/federation/namespaces/) * [ReplicaSets](/docs/user-guide/federation/replicasets/) * [Secrets](/docs/user-guide/federation/secrets/) * [Services](/docs/user-guide/federation/federated-services/) - [API reference docs](/docs/federation/api-reference/) lists all the resources supported by federation apiserver. diff --git a/docs/user-guide/garbage-collection.md b/docs/user-guide/garbage-collection.md index fe55949f1f..af90b4dd1a 100644 --- a/docs/user-guide/garbage-collection.md +++ b/docs/user-guide/garbage-collection.md @@ -27,7 +27,7 @@ You can set up owner-dependent relationships among other objects by manually set When deleting an object, you can request the GC to ***asynchronously*** delete its dependents by ***explicitly*** specifying `deleteOptions.orphanDependents=false` in the deletion request that you send to the API server. A 200 OK response from the API server indicates the owner is deleted. -In Kubernetes version 1.5, synchronous garbage collection is under active development. See the [tracking [issue](https://github.com/kubernetes/kubernetes/issues/29891) for more details. +In Kubernetes version 1.5, synchronous garbage collection is under active development. See the tracking [issue](https://github.com/kubernetes/kubernetes/issues/29891) for more details. If you specify `deleteOptions.orphanDependents=true`, or leave it blank, then the GC will first reset the `ownerReferences` in the dependents, then delete the owner. Note that the deletion of the owner object is asynchronous, that is, a 200 OK response will be sent by the API server before the owner object gets deleted. diff --git a/docs/user-guide/jobs.md b/docs/user-guide/jobs.md index d8476d73d5..cc2f9d38c3 100644 --- a/docs/user-guide/jobs.md +++ b/docs/user-guide/jobs.md @@ -172,20 +172,20 @@ parallelism, for a variety or reasons: A Container in a Pod may fail for a number of reasons, such as because the process in it exited with a non-zero exit code, or the Container was killed for exceeding a memory limit, etc. If this -happens, and the `.spec.template.containers[].restartPolicy = "OnFailure"`, then the Pod stays +happens, and the `.spec.template.spec.restartPolicy = "OnFailure"`, then the Pod stays on the node, but the Container is re-run. Therefore, your program needs to handle the case when it is -restarted locally, or else specify `.spec.template.containers[].restartPolicy = "Never"`. +restarted locally, or else specify `.spec.template.spec.restartPolicy = "Never"`. See [pods-states](/docs/user-guide/pod-states) for more information on `restartPolicy`. An entire Pod can also fail, for a number of reasons, such as when the pod is kicked off the node (node is upgraded, rebooted, deleted, etc.), or if a container of the Pod fails and the -`.spec.template.containers[].restartPolicy = "Never"`. When a Pod fails, then the Job controller +`.spec.template.spec.restartPolicy = "Never"`. When a Pod fails, then the Job controller starts a new Pod. Therefore, your program needs to handle the case when it is restarted in a new pod. In particular, it needs to handle temporary files, locks, incomplete output and the like caused by previous runs. Note that even if you specify `.spec.parallelism = 1` and `.spec.completions = 1` and -`.spec.template.containers[].restartPolicy = "Never"`, the same program may +`.spec.template.spec.restartPolicy = "Never"`, the same program may sometimes be started twice. If you do specify `.spec.parallelism` and `.spec.completions` both greater than 1, then there may be diff --git a/docs/user-guide/jobs/work-queue-2/index.md b/docs/user-guide/jobs/work-queue-2/index.md index 98d327d9a9..621be7f795 100644 --- a/docs/user-guide/jobs/work-queue-2/index.md +++ b/docs/user-guide/jobs/work-queue-2/index.md @@ -31,7 +31,7 @@ Here is an overview of the steps in this example: ## Starting Redis For this example, for simplicitly, we will start a single instance of Redis. -See the [Redis Example](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/redis/README.md) for an example +See the [Redis Example](https://github.com/kubernetes/kubernetes/tree/master/examples/guestbook) for an example of deploying Redis scalably and redundantly. Start a temporary Pod running Redis and a service so we can find it. diff --git a/docs/user-guide/kubectl-cheatsheet.md b/docs/user-guide/kubectl-cheatsheet.md index c16e7c264d..c147304a7d 100644 --- a/docs/user-guide/kubectl-cheatsheet.md +++ b/docs/user-guide/kubectl-cheatsheet.md @@ -200,7 +200,7 @@ $ kubectl logs my-pod # dump pod logs (stdout) $ kubectl logs -f my-pod # stream pod logs (stdout) $ kubectl run -i --tty busybox --image=busybox -- sh # Run pod as interactive shell $ kubectl attach my-pod -i # Attach to Running Container -$ kubectl port-forward my-pod 5000 6000 # Forward port 6000 of Pod to your to 5000 on your local machine +$ kubectl port-forward my-pod 5000:6000 # Forward port 6000 of Pod to your to 5000 on your local machine $ kubectl port-forward my-svc 6000 # Forward port to service $ kubectl exec my-pod -- ls / # Run command in existing pod (1 container case) $ kubectl exec my-pod -c my-container -- ls / # Run command in existing pod (multi-container case) diff --git a/docs/user-guide/kubectl/v1.5/documents/_app_management.md b/docs/user-guide/kubectl/v1.5/documents/_app_management.md deleted file mode 100644 index dd2a7ec5a6..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_app_management.md +++ /dev/null @@ -1,4 +0,0 @@ -# APP MANAGEMENT - -This section contains commands for creating, updating, deleting, and -viewing your workloads in a Kubernetes cluster. \ No newline at end of file diff --git a/docs/user-guide/kubectl/v1.5/documents/_cluster.md b/docs/user-guide/kubectl/v1.5/documents/_cluster.md deleted file mode 100644 index f0119f1c7b..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_cluster.md +++ /dev/null @@ -1,5 +0,0 @@ -# CLUSTER - -These are responsible for defining configuration of the cluster itself, and are generally only used by cluster operators. - ------------- diff --git a/docs/user-guide/kubectl/v1.5/documents/_config.md b/docs/user-guide/kubectl/v1.5/documents/_config.md deleted file mode 100644 index 2dd32a3d6f..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_config.md +++ /dev/null @@ -1,11 +0,0 @@ -# CONFIG & STORAGE - -These are responsible for injecting data into your applications and persisting data externally to your container. - -Common resource types: - -- [ConfigMaps](#configmap-v1) for providing text key value pairs injected into the application through environment variables, command line arguments, or files -- [Secrets](#secret-v1) for providing binary data injected into the application through files -- [Volumes](#volume-v1) for providing a filesystem external to the Container. Maybe shared across Containers within the same Pod and have a lifetime persisting beyond a Container or Pod. - ------------- diff --git a/docs/user-guide/kubectl/v1.5/documents/_definitions.md b/docs/user-guide/kubectl/v1.5/documents/_definitions.md deleted file mode 100644 index b71e4e1b57..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_definitions.md +++ /dev/null @@ -1,3 +0,0 @@ -# DEFINITIONS - -These are Definitions for objects used by the above APIs diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_annotate.md b/docs/user-guide/kubectl/v1.5/documents/_generated_annotate.md deleted file mode 100644 index 4513eb2aa7..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_annotate.md +++ /dev/null @@ -1,108 +0,0 @@ ------------- - -# annotate - ->bdocs-tab:example 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 - -```bdocs-tab:example_shell -kubectl annotate pods foo description='my frontend' -``` - ->bdocs-tab:example Update a pod identified by type and name in "pod.json" - -```bdocs-tab:example_shell -kubectl annotate -f pod.json description='my frontend' -``` - ->bdocs-tab:example Update pod 'foo' with the annotation 'description' and the value 'my frontend running nginx', overwriting any existing value. - -```bdocs-tab:example_shell -kubectl annotate --overwrite pods foo description='my frontend running nginx' -``` - ->bdocs-tab:example Update all pods in the namespace - -```bdocs-tab:example_shell -kubectl annotate pods --all description='my frontend running nginx' -``` - ->bdocs-tab:example Update pod 'foo' only if the resource is unchanged from version 1. - -```bdocs-tab:example_shell -kubectl annotate pods foo description='my frontend running nginx' --resource-version=1 -``` - ->bdocs-tab:example Update pod 'foo' by removing an annotation named 'description' if it exists. # Does not require the --overwrite flag. - -```bdocs-tab:example_shell -kubectl annotate pods foo description- -``` - - -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. - -Valid resource types include: - - * 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 - -### Usage - -`$ annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -all | | false | select all resources in the namespace of the specified resource types -dry-run | | false | If true, only print the object that would be sent, without sending it. -filename | f | [] | Filename, directory, or URL to files identifying the resource to update the annotation -include-extended-apis | | true | If true, include definitions of new APIs via calls to the API server. [default true] -local | | false | If true, annotation will NOT contact api-server but run locally. -no-headers | | false | When using the default or custom-column output format, don't print headers. -output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. -output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -overwrite | | false | If true, allow annotations to be overwritten, otherwise reject annotation updates that overwrite existing annotations. -record | | false | Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. -recursive | R | false | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. -resource-version | | | If non-empty, the annotation update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. -selector | l | | Selector (label query) to filter on -show-all | a | false | When printing, show all resources (default hide terminated pods.) -show-labels | | false | When printing, show all labels as the last column (default hide labels column) -sort-by | | | 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 | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_api-versions.md b/docs/user-guide/kubectl/v1.5/documents/_generated_api-versions.md deleted file mode 100644 index 5bd5b2ff13..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_api-versions.md +++ /dev/null @@ -1,14 +0,0 @@ ------------- - -# api-versions - - - - - -### Usage - -`$ api-versions` - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_apigroup_unversioned_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_apigroup_unversioned_concept.md deleted file mode 100644 index d7cbddabc9..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_apigroup_unversioned_concept.md +++ /dev/null @@ -1,42 +0,0 @@ - - ------------ -# APIGroup unversioned - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIGroup - - - - - - - -APIGroup contains the name, the supported versions, and the preferred version of a group. - - - -Field | Description ------------- | ----------- -name
    *string* | name is the name of the group. -preferredVersion
    *[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned)* | preferredVersion is the version preferred by the API server, which probably is the storage version. -serverAddressByClientCIDRs
    *[ServerAddressByClientCIDR](#serveraddressbyclientcidr-unversioned) array* | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. -versions
    *[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned) array* | versions are the versions supported in this group. - - -### APIGroupList unversioned - - - -Field | Description ------------- | ----------- -groups
    *[APIGroup](#apigroup-unversioned) array* | groups is a list of APIGroup. - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_apigroup_unversioned_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_apigroup_unversioned_definition.md deleted file mode 100644 index 9720a50d6a..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_apigroup_unversioned_definition.md +++ /dev/null @@ -1,22 +0,0 @@ -## APIGroup unversioned - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIGroup - -> Example yaml coming soon... - - - -APIGroup contains the name, the supported versions, and the preferred version of a group. - - - -Field | Description ------------- | ----------- -name
    *string* | name is the name of the group. -preferredVersion
    *[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned)* | preferredVersion is the version preferred by the API server, which probably is the storage version. -serverAddressByClientCIDRs
    *[ServerAddressByClientCIDR](#serveraddressbyclientcidr-unversioned) array* | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. -versions
    *[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned) array* | versions are the versions supported in this group. - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_apigrouplist_unversioned_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_apigrouplist_unversioned_concept.md deleted file mode 100644 index 30c2b10a97..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_apigrouplist_unversioned_concept.md +++ /dev/null @@ -1,30 +0,0 @@ - - ------------ -# APIGroupList unversioned - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIGroupList - - - - - - - -APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis. - - - -Field | Description ------------- | ----------- -groups
    *[APIGroup](#apigroup-unversioned) array* | groups is a list of APIGroup. - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_apigrouplist_unversioned_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_apigrouplist_unversioned_definition.md deleted file mode 100644 index be7477038d..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_apigrouplist_unversioned_definition.md +++ /dev/null @@ -1,18 +0,0 @@ -## APIGroupList unversioned - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIGroupList - -> Example yaml coming soon... - - - -APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis. - - - -Field | Description ------------- | ----------- -groups
    *[APIGroup](#apigroup-unversioned) array* | groups is a list of APIGroup. - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_apiresource_unversioned_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_apiresource_unversioned_concept.md deleted file mode 100644 index da0db93926..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_apiresource_unversioned_concept.md +++ /dev/null @@ -1,42 +0,0 @@ - - ------------ -# APIResource unversioned - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIResource - - - - - - - -APIResource specifies the name of a resource and whether it is namespaced. - - - -Field | Description ------------- | ----------- -kind
    *string* | kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo') -name
    *string* | name is the name of the resource. -namespaced
    *boolean* | namespaced indicates if a resource is namespaced or not. - - -### APIResourceList unversioned - - - -Field | Description ------------- | ----------- -groupVersion
    *string* | groupVersion is the group and version this APIResourceList is for. -resources
    *[APIResource](#apiresource-unversioned) array* | resources contains the name of the resources and if they are namespaced. - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_apiresource_unversioned_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_apiresource_unversioned_definition.md deleted file mode 100644 index dc8dcfd5de..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_apiresource_unversioned_definition.md +++ /dev/null @@ -1,21 +0,0 @@ -## APIResource unversioned - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIResource - -> Example yaml coming soon... - - - -APIResource specifies the name of a resource and whether it is namespaced. - - - -Field | Description ------------- | ----------- -kind
    *string* | kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo') -name
    *string* | name is the name of the resource. -namespaced
    *boolean* | namespaced indicates if a resource is namespaced or not. - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_apiresourcelist_unversioned_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_apiresourcelist_unversioned_concept.md deleted file mode 100644 index 7094c8d3ea..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_apiresourcelist_unversioned_concept.md +++ /dev/null @@ -1,31 +0,0 @@ - - ------------ -# APIResourceList unversioned - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | 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. - - - -Field | Description ------------- | ----------- -groupVersion
    *string* | groupVersion is the group and version this APIResourceList is for. -resources
    *[APIResource](#apiresource-unversioned) array* | resources contains the name of the resources and if they are namespaced. - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_apiresourcelist_unversioned_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_apiresourcelist_unversioned_definition.md deleted file mode 100644 index 403dccf2ad..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_apiresourcelist_unversioned_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## APIResourceList unversioned - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIResourceList - -> Example yaml coming soon... - - - -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. - - - -Field | Description ------------- | ----------- -groupVersion
    *string* | groupVersion is the group and version this APIResourceList is for. -resources
    *[APIResource](#apiresource-unversioned) array* | resources contains the name of the resources and if they are namespaced. - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_apiversion_v1beta1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_apiversion_v1beta1_concept.md deleted file mode 100644 index eed2e554dc..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_apiversion_v1beta1_concept.md +++ /dev/null @@ -1,31 +0,0 @@ - - ------------ -# APIVersion v1beta1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1beta1 | APIVersion - - - - - - - -An APIVersion represents a single concrete version of an object model. - - - -Field | Description ------------- | ----------- -name
    *string* | Name of this version (e.g. 'v1'). - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_apiversion_v1beta1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_apiversion_v1beta1_definition.md deleted file mode 100644 index f72906f32a..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_apiversion_v1beta1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## APIVersion v1beta1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1beta1 | APIVersion - -> Example yaml coming soon... - - - -An APIVersion represents a single concrete version of an object model. - - - -Field | Description ------------- | ----------- -name
    *string* | Name of this version (e.g. 'v1'). - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_apiversions_unversioned_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_apiversions_unversioned_concept.md deleted file mode 100644 index 03be0bc7bd..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_apiversions_unversioned_concept.md +++ /dev/null @@ -1,31 +0,0 @@ - - ------------ -# APIVersions unversioned - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIVersions - - - - - - - -APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API. - - - -Field | Description ------------- | ----------- -serverAddressByClientCIDRs
    *[ServerAddressByClientCIDR](#serveraddressbyclientcidr-unversioned) array* | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. -versions
    *string array* | versions are the api versions that are available. - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_apiversions_unversioned_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_apiversions_unversioned_definition.md deleted file mode 100644 index 3697fbbe6f..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_apiversions_unversioned_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## APIVersions unversioned - -Group | Version | Kind ------------- | ---------- | ----------- -Core | unversioned | APIVersions - -> Example yaml coming soon... - - - -APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API. - - - -Field | Description ------------- | ----------- -serverAddressByClientCIDRs
    *[ServerAddressByClientCIDR](#serveraddressbyclientcidr-unversioned) array* | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. -versions
    *string array* | versions are the api versions that are available. - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_apply.md b/docs/user-guide/kubectl/v1.5/documents/_generated_apply.md deleted file mode 100644 index f876b45193..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_apply.md +++ /dev/null @@ -1,70 +0,0 @@ ------------- - -# apply - ->bdocs-tab:example Apply the configuration in pod.json to a pod. - -```bdocs-tab:example_shell -kubectl apply -f ./pod.json -``` - ->bdocs-tab:example Apply the JSON passed into stdin to a pod. - -```bdocs-tab:example_shell -cat pod.json | kubectl apply -f - -``` - ->bdocs-tab:example 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. - -```bdocs-tab:example_shell -kubectl apply --prune -f manifest.yaml -l app=nginx -``` - ->bdocs-tab:example Apply the configuration in manifest.yaml and delete all the other configmaps that are not in the file. - -```bdocs-tab:example_shell -kubectl apply --prune -f manifest.yaml --all --prune-whitelist=core/v1/ConfigMap -``` - - -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. - -### Usage - -`$ apply -f FILENAME` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -all | | false | [-all] to select all the specified resources. -cascade | | true | 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). -dry-run | | false | If true, only print the object that would be sent, without sending it. -filename | f | [] | Filename, directory, or URL to files that contains the configuration to apply -force | | false | Delete and re-create the specified resource, when PATCH encounters conflict and has retried for 5 times. -grace-period | | -1 | 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. -include-extended-apis | | true | If true, include definitions of new APIs via calls to the API server. [default true] -no-headers | | false | When using the default or custom-column output format, don't print headers. -output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. -output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -overwrite | | true | Automatically resolve conflicts between the modified and live configuration by using values from the modified configuration -prune | | false | 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 | | [] | Overwrite the default whitelist with for --prune -record | | false | Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. -recursive | R | false | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. -schema-cache-dir | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' -selector | l | | Selector (label query) to filter on -show-all | a | false | When printing, show all resources (default hide terminated pods.) -show-labels | | false | When printing, show all labels as the last column (default hide labels column) -sort-by | | | 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 | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -timeout | | 0s | 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 | | true | If true, use a schema to validate the input before sending it - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_attach.md b/docs/user-guide/kubectl/v1.5/documents/_generated_attach.md deleted file mode 100644 index 918d5f1641..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_attach.md +++ /dev/null @@ -1,40 +0,0 @@ ------------- - -# attach - ->bdocs-tab:example Get output from running pod 123456-7890, using the first container by default - -```bdocs-tab:example_shell -kubectl attach 123456-7890 -``` - ->bdocs-tab:example Get output from ruby-container from pod 123456-7890 - -```bdocs-tab:example_shell -kubectl attach 123456-7890 -c ruby-container -``` - ->bdocs-tab:example 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 - -```bdocs-tab:example_shell -kubectl attach 123456-7890 -c ruby-container -i -t -``` - - -Attach to a process that is already running inside an existing container. - -### Usage - -`$ attach POD -c CONTAINER` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -container | c | | Container name. If omitted, the first container in the pod will be chosen -stdin | i | false | Pass stdin to the container -tty | t | false | Stdin is a TTY - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_attachedvolume_v1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_attachedvolume_v1_concept.md deleted file mode 100644 index 7ec6b04185..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_attachedvolume_v1_concept.md +++ /dev/null @@ -1,32 +0,0 @@ - - ------------ -# AttachedVolume v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | AttachedVolume - - - - - - - -AttachedVolume describes a volume attached to a node - - - -Field | Description ------------- | ----------- -devicePath
    *string* | DevicePath represents the device path where the volume should be available -name
    *string* | Name of the attached volume - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_attachedvolume_v1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_attachedvolume_v1_definition.md deleted file mode 100644 index d37451d55f..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_attachedvolume_v1_definition.md +++ /dev/null @@ -1,20 +0,0 @@ -## AttachedVolume v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | AttachedVolume - -> Example yaml coming soon... - - - -AttachedVolume describes a volume attached to a node - - - -Field | Description ------------- | ----------- -devicePath
    *string* | DevicePath represents the device path where the volume should be available -name
    *string* | Name of the attached volume - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_autoscale.md b/docs/user-guide/kubectl/v1.5/documents/_generated_autoscale.md deleted file mode 100644 index 056eedbff0..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_autoscale.md +++ /dev/null @@ -1,51 +0,0 @@ ------------- - -# autoscale - ->bdocs-tab:example 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: - -```bdocs-tab:example_shell -kubectl autoscale deployment foo --min=2 --max=10 -``` - ->bdocs-tab:example Auto scale a replication controller "foo", with the number of pods between 1 and 5, target CPU utilization at 80%: - -```bdocs-tab:example_shell -kubectl autoscale rc foo --max=5 --cpu-percent=80 -``` - - -Creates an autoscaler that automatically chooses and sets the number of pods that run in a kubernetes cluster. - -Looks up a Deployment, ReplicaSet, or ReplicationController by name and creates an autoscaler that uses the given resource as a reference. An autoscaler can automatically increase or decrease number of pods deployed within the system as needed. - -### Usage - -`$ autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU] [flags]` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -cpu-percent | | -1 | 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. -dry-run | | false | If true, only print the object that would be sent, without sending it. -filename | f | [] | Filename, directory, or URL to files identifying the resource to autoscale. -generator | | horizontalpodautoscaler/v1 | The name of the API generator to use. Currently there is only 1 generator. -include-extended-apis | | true | If true, include definitions of new APIs via calls to the API server. [default true] -max | | -1 | The upper limit for the number of pods that can be set by the autoscaler. Required. -min | | -1 | 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. -name | | | The name for the newly created object. If not specified, the name of the input resource will be used. -no-headers | | false | When using the default or custom-column output format, don't print headers. -output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. -output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -record | | false | Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. -recursive | R | false | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. -save-config | | false | 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. -show-all | a | false | When printing, show all resources (default hide terminated pods.) -show-labels | | false | When printing, show all labels as the last column (default hide labels column) -sort-by | | | 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 | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_binding_v1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_binding_v1_concept.md deleted file mode 100644 index 35f35035a7..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_binding_v1_concept.md +++ /dev/null @@ -1,93 +0,0 @@ - - ------------ -# Binding v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | Binding - - - - - - - -Binding ties one object to another. For example, a pod is bound to a node by a scheduler. - - - -Field | Description ------------- | ----------- -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata -target
    *[ObjectReference](#objectreference-v1)* | The target object that you want to bind to the standard object. - - - - - -## Write Operations - -See supported operations below... - -## Create - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -create a Binding - -### HTTP Request - -`POST /api/v1/namespaces/{namespace}/bindings` - -### Path Parameters - -Parameter | Description ------------- | ----------- -body
    *[Binding](#binding-v1)* | -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
    *[Binding](#binding-v1)* | OK - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_binding_v1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_binding_v1_definition.md deleted file mode 100644 index 0771a47781..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_binding_v1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## Binding v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | Binding - -> Example yaml coming soon... - - - -Binding ties one object to another. For example, a pod is bound to a node by a scheduler. - - - -Field | Description ------------- | ----------- -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata -target
    *[ObjectReference](#objectreference-v1)* | The target object that you want to bind to the standard object. - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_capabilities_v1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_capabilities_v1_concept.md deleted file mode 100644 index 6c47def7ef..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_capabilities_v1_concept.md +++ /dev/null @@ -1,32 +0,0 @@ - - ------------ -# Capabilities v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | Capabilities - - - - - - - -Adds and removes POSIX capabilities from running containers. - - - -Field | Description ------------- | ----------- -add
    *string array* | Added capabilities -drop
    *string array* | Removed capabilities - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_capabilities_v1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_capabilities_v1_definition.md deleted file mode 100644 index b422b55921..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_capabilities_v1_definition.md +++ /dev/null @@ -1,20 +0,0 @@ -## Capabilities v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | Capabilities - -> Example yaml coming soon... - - - -Adds and removes POSIX capabilities from running containers. - - - -Field | Description ------------- | ----------- -add
    *string array* | Added capabilities -drop
    *string array* | Removed capabilities - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_category_cluster_management.md b/docs/user-guide/kubectl/v1.5/documents/_generated_category_cluster_management.md deleted file mode 100644 index 3cc58a9543..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_category_cluster_management.md +++ /dev/null @@ -1 +0,0 @@ -# CLUSTER MANAGEMENT diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_category_declarative_app_management.md b/docs/user-guide/kubectl/v1.5/documents/_generated_category_declarative_app_management.md deleted file mode 100644 index 3dc1ae6821..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_category_declarative_app_management.md +++ /dev/null @@ -1 +0,0 @@ -# DECLARATIVE APP MANAGEMENT diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_category_deprecated_commands.md b/docs/user-guide/kubectl/v1.5/documents/_generated_category_deprecated_commands.md deleted file mode 100644 index 9e83dd2dbe..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_category_deprecated_commands.md +++ /dev/null @@ -1 +0,0 @@ -# DEPRECATED COMMANDS diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_category_kubectl_settings_and_usage.md b/docs/user-guide/kubectl/v1.5/documents/_generated_category_kubectl_settings_and_usage.md deleted file mode 100644 index 37bbbc1e52..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_category_kubectl_settings_and_usage.md +++ /dev/null @@ -1 +0,0 @@ -# KUBECTL SETTINGS AND USAGE diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_certificate.md b/docs/user-guide/kubectl/v1.5/documents/_generated_certificate.md deleted file mode 100644 index 3e23d607c5..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_certificate.md +++ /dev/null @@ -1,68 +0,0 @@ ------------- - -# certificate - - - - - -### Usage - -`$ certificate SUBCOMMAND` - - - ------------- - -## approve - - - -Approve a certificate signing request. - -kubectl certificate approve allows a cluster admin to approve a certificate signing request (CSR). This action tells a certificate signing controller to issue a certificate to the requestor with the attributes requested in the CSR. - -SECURITY NOTICE: Depending on the requested attributes, the issued certificate can potentially grant a requester access to cluster resources or to authenticate as a requested identity. Before approving a CSR, ensure you understand what the signed certificate can do. - -### Usage - -`$ approve (-f FILENAME | NAME)` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -filename | f | [] | Filename, directory, or URL to files identifying the resource to update -output | o | | Output mode. Use "-o name" for shorter output (resource/name). -recursive | R | false | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. - - - ------------- - -## deny - - - -Deny a certificate signing request. - -kubectl certificate deny allows a cluster admin to deny a certificate signing request (CSR). This action tells a certificate signing controller to not to issue a certificate to the requestor. - -### Usage - -`$ deny (-f FILENAME | NAME)` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -filename | f | [] | Filename, directory, or URL to files identifying the resource to update -output | o | | Output mode. Use "-o name" for shorter output (resource/name). -recursive | R | false | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequest_v1alpha1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequest_v1alpha1_concept.md deleted file mode 100644 index 43ed8a3918..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequest_v1alpha1_concept.md +++ /dev/null @@ -1,630 +0,0 @@ - - ------------ -# CertificateSigningRequest v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Certificates | v1alpha1 | CertificateSigningRequest - - - - - - - -Describes a certificate signing request - - - -Field | Description ------------- | ----------- -metadata
    *[ObjectMeta](#objectmeta-v1)* | -spec
    *[CertificateSigningRequestSpec](#certificatesigningrequestspec-v1alpha1)* | The certificate request itself and any additional information. -status
    *[CertificateSigningRequestStatus](#certificatesigningrequeststatus-v1alpha1)* | Derived information about the request. - - -### CertificateSigningRequestSpec v1alpha1 - - - -Field | Description ------------- | ----------- -groups
    *string array* | -request
    *string* | Base64-encoded PKCS#10 CSR data -uid
    *string* | -username
    *string* | Information about the requesting user (if relevant) See user.Info interface for details - -### CertificateSigningRequestStatus v1alpha1 - - - -Field | Description ------------- | ----------- -certificate
    *string* | If request was approved, the controller will place the issued certificate here. -conditions
    *[CertificateSigningRequestCondition](#certificatesigningrequestcondition-v1alpha1) array* | Conditions applied to the request, such as approval or denial. - -### CertificateSigningRequestList v1alpha1 - - - -Field | Description ------------- | ----------- -items
    *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1) array* | -metadata
    *[ListMeta](#listmeta-unversioned)* | - - - - -## Write Operations - -See supported operations below... - -## Create - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -create a CertificateSigningRequest - -### HTTP Request - -`POST /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests` - -### Path Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
    *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | - -### Response - -Code | Description ------------- | ----------- -200
    *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK - - -## Replace - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace the specified CertificateSigningRequest - -### HTTP Request - -`PUT /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the CertificateSigningRequest -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
    *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | - -### Response - -Code | Description ------------- | ----------- -200
    *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK - - -## Patch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update the specified CertificateSigningRequest - -### HTTP Request - -`PATCH /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the CertificateSigningRequest -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
    *[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
    *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK - - -## Delete - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -delete a CertificateSigningRequest - -### HTTP Request - -`DELETE /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the CertificateSigningRequest -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
    *[DeleteOptions](#deleteoptions-v1)* | -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. -orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. - -### Response - -Code | Description ------------- | ----------- -200
    *[Status](#status-unversioned)* | OK - - -## Delete Collection - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -delete collection of CertificateSigningRequest - -### HTTP Request - -`DELETE /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests` - -### Path Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - -### Response - -Code | Description ------------- | ----------- -200
    *[Status](#status-unversioned)* | OK - - - -## Read Operations - -See supported operations below... - -## Read - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read the specified CertificateSigningRequest - -### HTTP Request - -`GET /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the CertificateSigningRequest -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace' -export | Should this value be exported. Export strips fields that a user can not specify. - -### Response - -Code | Description ------------- | ----------- -200
    *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK - - -## List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -list or watch objects of kind CertificateSigningRequest - -### HTTP Request - -`GET /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests` - -### Path Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - -### Response - -Code | Description ------------- | ----------- -200
    *[CertificateSigningRequestList](#certificatesigningrequestlist-v1alpha1)* | OK - - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch changes to an object of kind CertificateSigningRequest - -### HTTP Request - -`GET /apis/certificates.k8s.io/v1alpha1/watch/certificatesigningrequests/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -name | name of the CertificateSigningRequest -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
    *[Event](#event-versioned)* | OK - - -## Watch List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of CertificateSigningRequest - -### HTTP Request - -`GET /apis/certificates.k8s.io/v1alpha1/watch/certificatesigningrequests` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
    *[Event](#event-versioned)* | OK - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequest_v1alpha1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequest_v1alpha1_definition.md deleted file mode 100644 index 51285b5612..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequest_v1alpha1_definition.md +++ /dev/null @@ -1,21 +0,0 @@ -## CertificateSigningRequest v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Certificates | v1alpha1 | CertificateSigningRequest - -> Example yaml coming soon... - - - -Describes a certificate signing request - - - -Field | Description ------------- | ----------- -metadata
    *[ObjectMeta](#objectmeta-v1)* | -spec
    *[CertificateSigningRequestSpec](#certificatesigningrequestspec-v1alpha1)* | The certificate request itself and any additional information. -status
    *[CertificateSigningRequestStatus](#certificatesigningrequeststatus-v1alpha1)* | Derived information about the request. - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequestcondition_v1alpha1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequestcondition_v1alpha1_concept.md deleted file mode 100644 index b11023903e..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequestcondition_v1alpha1_concept.md +++ /dev/null @@ -1,34 +0,0 @@ - - ------------ -# CertificateSigningRequestCondition v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestCondition - - - - - - - - - - - -Field | Description ------------- | ----------- -lastUpdateTime
    *[Time](#time-unversioned)* | timestamp for the last update to this condition -message
    *string* | human readable message with details about the request state -reason
    *string* | brief reason for the request state -type
    *string* | request approval state, currently Approved or Denied. - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequestcondition_v1alpha1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequestcondition_v1alpha1_definition.md deleted file mode 100644 index 5be80fe21f..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequestcondition_v1alpha1_definition.md +++ /dev/null @@ -1,22 +0,0 @@ -## CertificateSigningRequestCondition v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestCondition - -> Example yaml coming soon... - - - - - - - -Field | Description ------------- | ----------- -lastUpdateTime
    *[Time](#time-unversioned)* | timestamp for the last update to this condition -message
    *string* | human readable message with details about the request state -reason
    *string* | brief reason for the request state -type
    *string* | request approval state, currently Approved or Denied. - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequestlist_v1alpha1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequestlist_v1alpha1_concept.md deleted file mode 100644 index d67ab588c5..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequestlist_v1alpha1_concept.md +++ /dev/null @@ -1,31 +0,0 @@ - - ------------ -# CertificateSigningRequestList v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestList - - - - - - - - - - - -Field | Description ------------- | ----------- -items
    *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1) array* | -metadata
    *[ListMeta](#listmeta-unversioned)* | - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequestlist_v1alpha1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequestlist_v1alpha1_definition.md deleted file mode 100644 index 1ea0c615e4..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequestlist_v1alpha1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## CertificateSigningRequestList v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestList - -> Example yaml coming soon... - - - - - - - -Field | Description ------------- | ----------- -items
    *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1) array* | -metadata
    *[ListMeta](#listmeta-unversioned)* | - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequestspec_v1alpha1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequestspec_v1alpha1_concept.md deleted file mode 100644 index 9e7fbae674..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequestspec_v1alpha1_concept.md +++ /dev/null @@ -1,34 +0,0 @@ - - ------------ -# CertificateSigningRequestSpec v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestSpec - - - - - - - -This information is immutable after the request is created. Only the Request and ExtraInfo fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users. - - - -Field | Description ------------- | ----------- -groups
    *string array* | -request
    *string* | Base64-encoded PKCS#10 CSR data -uid
    *string* | -username
    *string* | Information about the requesting user (if relevant) See user.Info interface for details - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequestspec_v1alpha1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequestspec_v1alpha1_definition.md deleted file mode 100644 index 9b301b0c36..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequestspec_v1alpha1_definition.md +++ /dev/null @@ -1,22 +0,0 @@ -## CertificateSigningRequestSpec v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestSpec - -> Example yaml coming soon... - - - -This information is immutable after the request is created. Only the Request and ExtraInfo fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users. - - - -Field | Description ------------- | ----------- -groups
    *string array* | -request
    *string* | Base64-encoded PKCS#10 CSR data -uid
    *string* | -username
    *string* | Information about the requesting user (if relevant) See user.Info interface for details - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequeststatus_v1alpha1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequeststatus_v1alpha1_concept.md deleted file mode 100644 index dd927e259b..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequeststatus_v1alpha1_concept.md +++ /dev/null @@ -1,94 +0,0 @@ - - ------------ -# CertificateSigningRequestStatus v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Certificates | v1alpha1 | CertificateSigningRequestStatus - - - - - - - - - - - -Field | Description ------------- | ----------- -certificate
    *string* | If request was approved, the controller will place the issued certificate here. -conditions
    *[CertificateSigningRequestCondition](#certificatesigningrequestcondition-v1alpha1) array* | Conditions applied to the request, such as approval or denial. - - - - - -## Write Operations - -See supported operations below... - -## Replace - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace status of the specified CertificateSigningRequest - -### HTTP Request - -`PUT /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -body
    *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | -name | name of the CertificateSigningRequest -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
    *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequeststatus_v1alpha1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequeststatus_v1alpha1_definition.md deleted file mode 100644 index c6420756ba..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_certificatesigningrequeststatus_v1alpha1_definition.md +++ /dev/null @@ -1,20 +0,0 @@ -## CertificateSigningRequestStatus v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Certificates | v1alpha1 | CertificateSigningRequestStatus - -> Example yaml coming soon... - - - - - - - -Field | Description ------------- | ----------- -certificate
    *string* | If request was approved, the controller will place the issued certificate here. -conditions
    *[CertificateSigningRequestCondition](#certificatesigningrequestcondition-v1alpha1) array* | Conditions applied to the request, such as approval or denial. - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_cluster-info.md b/docs/user-guide/kubectl/v1.5/documents/_generated_cluster-info.md deleted file mode 100644 index 26606eb9e7..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_cluster-info.md +++ /dev/null @@ -1,70 +0,0 @@ ------------- - -# cluster-info - - - -Display addresses of the master and services with label kubernetes.io/cluster-service=true To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'. - -### Usage - -`$ cluster-info` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -include-extended-apis | | true | If true, include definitions of new APIs via calls to the API server. [default true] - - ------------- - -## dump - ->bdocs-tab:example Dump current cluster state to stdout - -```bdocs-tab:example_shell -kubectl cluster-info dump -``` - ->bdocs-tab:example Dump current cluster state to /path/to/cluster-state - -```bdocs-tab:example_shell -kubectl cluster-info dump --output-directory=/path/to/cluster-state -``` - ->bdocs-tab:example Dump all namespaces to stdout - -```bdocs-tab:example_shell -kubectl cluster-info dump --all-namespaces -``` - ->bdocs-tab:example Dump a set of namespaces to /path/to/cluster-state - -```bdocs-tab:example_shell -kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state -``` - - -Dumps cluster info out suitable for debugging and diagnosing cluster problems. By default, dumps everything to stdout. You can optionally specify a directory with --output-directory. If you specify a directory, kubernetes will build a set of files in that directory. By default only dumps things in the 'kube-system' namespace, but you can switch to a different namespace with the --namespaces flag, or specify --all-namespaces to dump all namespaces. - -The command also dumps the logs of all of the pods in the cluster, these logs are dumped into different directories based on namespace and pod name. - -### Usage - -`$ dump` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -all-namespaces | | false | If true, dump all namespaces. If true, --namespaces is ignored. -namespaces | | [] | A comma separated list of namespaces to dump. -output-directory | | | Where to output the files. If empty or '-' uses stdout, otherwise creates a directory hierarchy in that directory - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrole_v1alpha1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrole_v1alpha1_concept.md deleted file mode 100644 index 6e829a2d86..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrole_v1alpha1_concept.md +++ /dev/null @@ -1,601 +0,0 @@ - - ------------ -# ClusterRole v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -RbacAuthorization | v1alpha1 | ClusterRole - - - - - - - -ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. - - - -Field | Description ------------- | ----------- -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. -rules
    *[PolicyRule](#policyrule-v1alpha1) array* | Rules holds all the PolicyRules for this ClusterRole - - -### ClusterRoleList v1alpha1 - - - -Field | Description ------------- | ----------- -items
    *[ClusterRole](#clusterrole-v1alpha1) array* | Items is a list of ClusterRoles -metadata
    *[ListMeta](#listmeta-unversioned)* | Standard object's metadata. - - - - -## Write Operations - -See supported operations below... - -## Create - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -create a ClusterRole - -### HTTP Request - -`POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles` - -### Path Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
    *[ClusterRole](#clusterrole-v1alpha1)* | - -### Response - -Code | Description ------------- | ----------- -200
    *[ClusterRole](#clusterrole-v1alpha1)* | OK - - -## Replace - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace the specified ClusterRole - -### HTTP Request - -`PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ClusterRole -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
    *[ClusterRole](#clusterrole-v1alpha1)* | - -### Response - -Code | Description ------------- | ----------- -200
    *[ClusterRole](#clusterrole-v1alpha1)* | OK - - -## Patch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update the specified ClusterRole - -### HTTP Request - -`PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ClusterRole -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
    *[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
    *[ClusterRole](#clusterrole-v1alpha1)* | OK - - -## Delete - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -delete a ClusterRole - -### HTTP Request - -`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ClusterRole -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
    *[DeleteOptions](#deleteoptions-v1)* | -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. -orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. - -### Response - -Code | Description ------------- | ----------- -200
    *[Status](#status-unversioned)* | OK - - -## Delete Collection - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -delete collection of ClusterRole - -### HTTP Request - -`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles` - -### Path Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - -### Response - -Code | Description ------------- | ----------- -200
    *[Status](#status-unversioned)* | OK - - - -## Read Operations - -See supported operations below... - -## Read - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read the specified ClusterRole - -### HTTP Request - -`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ClusterRole -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
    *[ClusterRole](#clusterrole-v1alpha1)* | OK - - -## List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -list or watch objects of kind ClusterRole - -### HTTP Request - -`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles` - -### Path Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - -### Response - -Code | Description ------------- | ----------- -200
    *[ClusterRoleList](#clusterrolelist-v1alpha1)* | OK - - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch changes to an object of kind ClusterRole - -### HTTP Request - -`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -name | name of the ClusterRole -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
    *[Event](#event-versioned)* | OK - - -## Watch List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of ClusterRole - -### HTTP Request - -`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
    *[Event](#event-versioned)* | OK - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrole_v1alpha1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrole_v1alpha1_definition.md deleted file mode 100644 index 33d9c6958a..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrole_v1alpha1_definition.md +++ /dev/null @@ -1,20 +0,0 @@ -## ClusterRole v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -RbacAuthorization | v1alpha1 | ClusterRole - -> Example yaml coming soon... - - - -ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. - - - -Field | Description ------------- | ----------- -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. -rules
    *[PolicyRule](#policyrule-v1alpha1) array* | Rules holds all the PolicyRules for this ClusterRole - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrolebinding_v1alpha1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrolebinding_v1alpha1_concept.md deleted file mode 100644 index 8e39037a88..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrolebinding_v1alpha1_concept.md +++ /dev/null @@ -1,542 +0,0 @@ - - ------------ -# ClusterRoleBinding v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -RbacAuthorization | v1alpha1 | ClusterRoleBinding - - - - - - - -ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. - - - -Field | Description ------------- | ----------- -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. -roleRef
    *[RoleRef](#roleref-v1alpha1)* | RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. -subjects
    *[Subject](#subject-v1alpha1) array* | Subjects holds references to the objects the role applies to. - - -### ClusterRoleBindingList v1alpha1 - - - -Field | Description ------------- | ----------- -items
    *[ClusterRoleBinding](#clusterrolebinding-v1alpha1) array* | Items is a list of ClusterRoleBindings -metadata
    *[ListMeta](#listmeta-unversioned)* | Standard object's metadata. - - - - -## Write Operations - -See supported operations below... - -## Create - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -create a ClusterRoleBinding - -### HTTP Request - -`POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings` - -### Path Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
    *[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* | - -### Response - -Code | Description ------------- | ----------- -200
    *[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* | OK - - -## Replace - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace the specified ClusterRoleBinding - -### HTTP Request - -`PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ClusterRoleBinding -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
    *[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* | - -### Response - -Code | Description ------------- | ----------- -200
    *[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* | OK - - -## Patch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update the specified ClusterRoleBinding - -### HTTP Request - -`PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ClusterRoleBinding -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
    *[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
    *[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* | OK - - -## Delete - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -delete a ClusterRoleBinding - -### HTTP Request - -`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ClusterRoleBinding -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
    *[DeleteOptions](#deleteoptions-v1)* | -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. -orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. - -### Response - -Code | Description ------------- | ----------- -200
    *[Status](#status-unversioned)* | OK - - -## Delete Collection - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -delete collection of ClusterRoleBinding - -### HTTP Request - -`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings` - -### Path Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - -### Response - -Code | Description ------------- | ----------- -200
    *[Status](#status-unversioned)* | OK - - - -## Read Operations - -See supported operations below... - -## Read - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read the specified ClusterRoleBinding - -### HTTP Request - -`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ClusterRoleBinding -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
    *[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* | OK - - -## List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -list or watch objects of kind ClusterRoleBinding - -### HTTP Request - -`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings` - -### Path Parameters - -Parameter | Description ------------- | ----------- -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - -### Response - -Code | Description ------------- | ----------- -200
    *[ClusterRoleBindingList](#clusterrolebindinglist-v1alpha1)* | OK - - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch changes to an object of kind ClusterRoleBinding - -### HTTP Request - -`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -name | name of the ClusterRoleBinding -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
    *[Event](#event-versioned)* | OK - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrolebinding_v1alpha1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrolebinding_v1alpha1_definition.md deleted file mode 100644 index 9ad8044537..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrolebinding_v1alpha1_definition.md +++ /dev/null @@ -1,21 +0,0 @@ -## ClusterRoleBinding v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -RbacAuthorization | v1alpha1 | ClusterRoleBinding - -> Example yaml coming soon... - - - -ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. - - - -Field | Description ------------- | ----------- -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. -roleRef
    *[RoleRef](#roleref-v1alpha1)* | RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. -subjects
    *[Subject](#subject-v1alpha1) array* | Subjects holds references to the objects the role applies to. - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrolebindinglist_v1alpha1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrolebindinglist_v1alpha1_concept.md deleted file mode 100644 index 2f6cc5edf7..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrolebindinglist_v1alpha1_concept.md +++ /dev/null @@ -1,96 +0,0 @@ - - ------------ -# ClusterRoleBindingList v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -RbacAuthorization | v1alpha1 | ClusterRoleBindingList - - - - - - - -ClusterRoleBindingList is a collection of ClusterRoleBindings - - - -Field | Description ------------- | ----------- -items
    *[ClusterRoleBinding](#clusterrolebinding-v1alpha1) array* | Items is a list of ClusterRoleBindings -metadata
    *[ListMeta](#listmeta-unversioned)* | Standard object's metadata. - - - - - -## Read Operations - -See supported operations below... - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of ClusterRoleBinding - -### HTTP Request - -`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
    *[Event](#event-versioned)* | OK - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrolebindinglist_v1alpha1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrolebindinglist_v1alpha1_definition.md deleted file mode 100644 index efe0a2175a..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrolebindinglist_v1alpha1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## ClusterRoleBindingList v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -RbacAuthorization | v1alpha1 | ClusterRoleBindingList - -> Example yaml coming soon... - - - -ClusterRoleBindingList is a collection of ClusterRoleBindings - - - -Field | Description ------------- | ----------- -items
    *[ClusterRoleBinding](#clusterrolebinding-v1alpha1) array* | Items is a list of ClusterRoleBindings -metadata
    *[ListMeta](#listmeta-unversioned)* | Standard object's metadata. - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrolelist_v1alpha1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrolelist_v1alpha1_concept.md deleted file mode 100644 index fc2468dc6e..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrolelist_v1alpha1_concept.md +++ /dev/null @@ -1,31 +0,0 @@ - - ------------ -# ClusterRoleList v1alpha1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | ClusterRoleList - - - - - - - -ClusterRoleList is a collection of ClusterRoles - - - -Field | Description ------------- | ----------- -items
    *[ClusterRole](#clusterrole-v1alpha1) array* | Items is a list of ClusterRoles -metadata
    *[ListMeta](#listmeta-unversioned)* | Standard object's metadata. - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrolelist_v1alpha1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrolelist_v1alpha1_definition.md deleted file mode 100644 index 53946616f1..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_clusterrolelist_v1alpha1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## ClusterRoleList v1alpha1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1alpha1 | ClusterRoleList - -> Example yaml coming soon... - - - -ClusterRoleList is a collection of ClusterRoles - - - -Field | Description ------------- | ----------- -items
    *[ClusterRole](#clusterrole-v1alpha1) array* | Items is a list of ClusterRoles -metadata
    *[ListMeta](#listmeta-unversioned)* | Standard object's metadata. - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_completion.md b/docs/user-guide/kubectl/v1.5/documents/_generated_completion.md deleted file mode 100644 index e0cf691d5e..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_completion.md +++ /dev/null @@ -1,30 +0,0 @@ ------------- - -# completion - - - -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. - - $ 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 - -### Usage - -`$ completion SHELL` - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_componentcondition_v1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_componentcondition_v1_concept.md deleted file mode 100644 index 7976a2bc40..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_componentcondition_v1_concept.md +++ /dev/null @@ -1,34 +0,0 @@ - - ------------ -# ComponentCondition v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ComponentCondition - - - - - - - -Information about the condition of a component. - - - -Field | Description ------------- | ----------- -error
    *string* | Condition error code for a component. For example, a health check error code. -message
    *string* | Message about the condition for a component. For example, information about a health check. -status
    *string* | Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown". -type
    *string* | Type of condition for a component. Valid value: "Healthy" - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_componentcondition_v1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_componentcondition_v1_definition.md deleted file mode 100644 index 760a69ce1f..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_componentcondition_v1_definition.md +++ /dev/null @@ -1,22 +0,0 @@ -## ComponentCondition v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ComponentCondition - -> Example yaml coming soon... - - - -Information about the condition of a component. - - - -Field | Description ------------- | ----------- -error
    *string* | Condition error code for a component. For example, a health check error code. -message
    *string* | Message about the condition for a component. For example, information about a health check. -status
    *string* | Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown". -type
    *string* | Type of condition for a component. Valid value: "Healthy" - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_componentstatus_v1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_componentstatus_v1_concept.md deleted file mode 100644 index 18a7cf067f..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_componentstatus_v1_concept.md +++ /dev/null @@ -1,162 +0,0 @@ - - ------------ -# ComponentStatus v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ComponentStatus - - - - - - - -ComponentStatus (and ComponentStatusList) holds the cluster validation info. - - - -Field | Description ------------- | ----------- -conditions
    *[ComponentCondition](#componentcondition-v1) array* | List of component conditions observed -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - - -### ComponentStatusList v1 - - - -Field | Description ------------- | ----------- -items
    *[ComponentStatus](#componentstatus-v1) array* | List of ComponentStatus objects. -metadata
    *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds - - - - -## Read Operations - -See supported operations below... - -## Read - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read the specified ComponentStatus - -### HTTP Request - -`GET /api/v1/componentstatuses/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ComponentStatus -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
    *[ComponentStatus](#componentstatus-v1)* | OK - - -## List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -list objects of kind ComponentStatus - -### HTTP Request - -`GET /api/v1/componentstatuses` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
    *[ComponentStatusList](#componentstatuslist-v1)* | OK - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_componentstatus_v1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_componentstatus_v1_definition.md deleted file mode 100644 index 3d3571542c..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_componentstatus_v1_definition.md +++ /dev/null @@ -1,20 +0,0 @@ -## ComponentStatus v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ComponentStatus - -> Example yaml coming soon... - - - -ComponentStatus (and ComponentStatusList) holds the cluster validation info. - - - -Field | Description ------------- | ----------- -conditions
    *[ComponentCondition](#componentcondition-v1) array* | List of component conditions observed -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_componentstatuslist_v1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_componentstatuslist_v1_concept.md deleted file mode 100644 index 812ce55079..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_componentstatuslist_v1_concept.md +++ /dev/null @@ -1,31 +0,0 @@ - - ------------ -# ComponentStatusList v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ComponentStatusList - - - - - - - -Status of all the conditions for the component as a list of ComponentStatus objects. - - - -Field | Description ------------- | ----------- -items
    *[ComponentStatus](#componentstatus-v1) array* | List of ComponentStatus objects. -metadata
    *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_componentstatuslist_v1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_componentstatuslist_v1_definition.md deleted file mode 100644 index eb4a1c7495..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_componentstatuslist_v1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## ComponentStatusList v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ComponentStatusList - -> Example yaml coming soon... - - - -Status of all the conditions for the component as a list of ComponentStatus objects. - - - -Field | Description ------------- | ----------- -items
    *[ComponentStatus](#componentstatus-v1) array* | List of ComponentStatus objects. -metadata
    *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_config.md b/docs/user-guide/kubectl/v1.5/documents/_generated_config.md deleted file mode 100644 index e81e705103..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_config.md +++ /dev/null @@ -1,382 +0,0 @@ ------------- - -# config - - - -Modify kubeconfig files using subcommands like "kubectl config set current-context my-context" - -The loading order follows these rules: - - 1. If the --kubeconfig flag is set, then only that file is loaded. The flag may only be set once and no merging takes place. - 2. 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. - -### Usage - -`$ config SUBCOMMAND` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -kubeconfig | | | use a particular kubeconfig file - - ------------- - -## current-context - ->bdocs-tab:example Display the current-context - -```bdocs-tab:example_shell -kubectl config current-context -``` - - -Displays the current-context - -### Usage - -`$ current-context` - - - - ------------- - -## delete-cluster - - - - - -### Usage - -`$ delete-cluster NAME` - - - - ------------- - -## delete-context - - - - - -### Usage - -`$ delete-context NAME` - - - - ------------- - -## get-clusters - - - - - -### Usage - -`$ get-clusters` - - - - ------------- - -## get-contexts - ->bdocs-tab:example List all the contexts in your kubeconfig file - -```bdocs-tab:example_shell -kubectl config get-contexts -``` - ->bdocs-tab:example Describe one context in your kubeconfig file. - -```bdocs-tab:example_shell -kubectl config get-contexts my-context -``` - - -Displays one or many contexts from the kubeconfig file. - -### Usage - -`$ get-contexts [(-o|--output=)name)]` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -no-headers | | false | When using the default or custom-column output format, don't print headers. -output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. - - - ------------- - -## set - - - -Sets an individual value in a kubeconfig file - -PROPERTY _NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. - -PROPERTY _VALUE is the new value you wish to set. Binary fields such as 'certificate-authority-data' expect a base64 encoded string unless the --set-raw-bytes flag is used. - -### Usage - -`$ set PROPERTY_NAME PROPERTY_VALUE` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -set-raw-bytes | | false | When writing a []byte PROPERTY_VALUE, write the given string directly without base64 decoding. - - - ------------- - -## set-cluster - ->bdocs-tab:example Set only the server field on the e2e cluster entry without touching other values. - -```bdocs-tab:example_shell -kubectl config set-cluster e2e --server=https://1.2.3.4 -``` - ->bdocs-tab:example Embed certificate authority data for the e2e cluster entry - -```bdocs-tab:example_shell -kubectl config set-cluster e2e --certificate-authority=~/.kube/e2e/kubernetes.ca.crt -``` - ->bdocs-tab:example Disable cert checking for the dev cluster entry - -```bdocs-tab:example_shell -kubectl config set-cluster e2e --insecure-skip-tls-verify=true -``` - - -Sets a cluster entry in kubeconfig. - -Specifying a name that already exists will merge new fields on top of existing values for those fields. - -### Usage - -`$ set-cluster NAME [--server=server] [--certificate-authority=path/to/certificate/authority] [--insecure-skip-tls-verify=true]` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -api-version | | | api-version for the cluster entry in kubeconfig -certificate-authority | | | path to certificate-authority file for the cluster entry in kubeconfig -embed-certs | | false | embed-certs for the cluster entry in kubeconfig -insecure-skip-tls-verify | | false | insecure-skip-tls-verify for the cluster entry in kubeconfig -server | | | server for the cluster entry in kubeconfig - - - ------------- - -## set-context - ->bdocs-tab:example Set the user field on the gce context entry without touching other values - -```bdocs-tab:example_shell -kubectl config set-context gce --user=cluster-admin -``` - - -Sets a context entry in kubeconfig - -Specifying a name that already exists will merge new fields on top of existing values for those fields. - -### Usage - -`$ set-context NAME [--cluster=cluster_nickname] [--user=user_nickname] [--namespace=namespace]` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -cluster | | | cluster for the context entry in kubeconfig -namespace | | | namespace for the context entry in kubeconfig -user | | | user for the context entry in kubeconfig - - - ------------- - -## set-credentials - ->bdocs-tab:example Set only the "client-key" field on the "cluster-admin" # entry, without touching other values: - -```bdocs-tab:example_shell -kubectl config set-credentials cluster-admin --client-key=~/.kube/admin.key -``` - ->bdocs-tab:example Set basic auth for the "cluster-admin" entry - -```bdocs-tab:example_shell -kubectl config set-credentials cluster-admin --username=admin --password=uXFGweU9l35qcif -``` - ->bdocs-tab:example Embed client certificate data in the "cluster-admin" entry - -```bdocs-tab:example_shell -kubectl config set-credentials cluster-admin --client-certificate=~/.kube/admin.crt --embed-certs=true -``` - ->bdocs-tab:example Enable the Google Compute Platform auth provider for the "cluster-admin" entry - -```bdocs-tab:example_shell -kubectl config set-credentials cluster-admin --auth-provider=gcp -``` - ->bdocs-tab:example Enable the OpenID Connect auth provider for the "cluster-admin" entry with additional args - -```bdocs-tab:example_shell -kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-id=foo --auth-provider-arg=client-secret=bar -``` - ->bdocs-tab:example Remove the "client-secret" config value for the OpenID Connect auth provider for the "cluster-admin" entry - -```bdocs-tab:example_shell -kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-secret- -``` - - -Sets a user entry in kubeconfig - -Specifying a name that already exists will merge new fields on top of existing values. - - Client-certificate flags: - --client-certificate=certfile --client-key=keyfile - - Bearer token flags: - --token=bearer_token - - Basic auth flags: - --username=basic_user --password=basic_password - -Bearer token and basic auth are mutually exclusive. - -### Usage - -`$ set-credentials NAME [--client-certificate=path/to/certfile] [--client-key=path/to/keyfile] [--token=bearer_token] [--username=basic_user] [--password=basic_password] [--auth-provider=provider_name] [--auth-provider-arg=key=value]` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -auth-provider | | | auth provider for the user entry in kubeconfig -auth-provider-arg | | [] | 'key=value' arugments for the auth provider -client-certificate | | | path to client-certificate file for the user entry in kubeconfig -client-key | | | path to client-key file for the user entry in kubeconfig -embed-certs | | false | embed client cert/key for the user entry in kubeconfig -password | | | password for the user entry in kubeconfig -token | | | token for the user entry in kubeconfig -username | | | username for the user entry in kubeconfig - - - ------------- - -## unset - - - -Unsets an individual value in a kubeconfig file - -PROPERTY _NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. - -### Usage - -`$ unset PROPERTY_NAME` - - - - ------------- - -## use-context - - - -Sets the current-context in a kubeconfig file - -### Usage - -`$ use-context CONTEXT_NAME` - - - - ------------- - -## view - ->bdocs-tab:example Show Merged kubeconfig settings. - -```bdocs-tab:example_shell -kubectl config view -``` - ->bdocs-tab:example Get the password for the e2e user - -```bdocs-tab:example_shell -kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}' -``` - - -Display merged kubeconfig settings or a specified kubeconfig file. - -You can use --output jsonpath={...} to extract specific values using a jsonpath expression. - -### Usage - -`$ view` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -flatten | | false | flatten the resulting kubeconfig file into self-contained output (useful for creating portable kubeconfig files) -merge | | true | merge the full hierarchy of kubeconfig files -minify | | false | remove all information not used by current-context from the output -no-headers | | false | When using the default or custom-column output format, don't print headers. -output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. -output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -raw | | false | display raw byte data -show-all | a | false | When printing, show all resources (default hide terminated pods.) -show-labels | | false | When printing, show all labels as the last column (default hide labels column) -sort-by | | | 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 | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_configmap_v1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_configmap_v1_concept.md deleted file mode 100644 index d31e5aac23..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_configmap_v1_concept.md +++ /dev/null @@ -1,675 +0,0 @@ - - ------------ -# ConfigMap v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ConfigMap - - - - - - - -ConfigMap holds configuration data for pods to consume. - - - -Field | Description ------------- | ----------- -data
    *object* | Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot. -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - - -### ConfigMapList v1 - - - -Field | Description ------------- | ----------- -items
    *[ConfigMap](#configmap-v1) array* | Items is the list of ConfigMaps. -metadata
    *[ListMeta](#listmeta-unversioned)* | More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - - - - -## Write Operations - -See supported operations below... - -## Create - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -create a ConfigMap - -### HTTP Request - -`POST /api/v1/namespaces/{namespace}/configmaps` - -### Path Parameters - -Parameter | Description ------------- | ----------- -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
    *[ConfigMap](#configmap-v1)* | - -### Response - -Code | Description ------------- | ----------- -200
    *[ConfigMap](#configmap-v1)* | OK - - -## Replace - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace the specified ConfigMap - -### HTTP Request - -`PUT /api/v1/namespaces/{namespace}/configmaps/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ConfigMap -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
    *[ConfigMap](#configmap-v1)* | - -### Response - -Code | Description ------------- | ----------- -200
    *[ConfigMap](#configmap-v1)* | OK - - -## Patch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update the specified ConfigMap - -### HTTP Request - -`PATCH /api/v1/namespaces/{namespace}/configmaps/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ConfigMap -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
    *[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
    *[ConfigMap](#configmap-v1)* | OK - - -## Delete - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -delete a ConfigMap - -### HTTP Request - -`DELETE /api/v1/namespaces/{namespace}/configmaps/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ConfigMap -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
    *[DeleteOptions](#deleteoptions-v1)* | -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. -orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. - -### Response - -Code | Description ------------- | ----------- -200
    *[Status](#status-unversioned)* | OK - - -## Delete Collection - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -delete collection of ConfigMap - -### HTTP Request - -`DELETE /api/v1/namespaces/{namespace}/configmaps` - -### Path Parameters - -Parameter | Description ------------- | ----------- -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - -### Response - -Code | Description ------------- | ----------- -200
    *[Status](#status-unversioned)* | OK - - - -## Read Operations - -See supported operations below... - -## Read - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read the specified ConfigMap - -### HTTP Request - -`GET /api/v1/namespaces/{namespace}/configmaps/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ConfigMap -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace' -export | Should this value be exported. Export strips fields that a user can not specify. - -### Response - -Code | Description ------------- | ----------- -200
    *[ConfigMap](#configmap-v1)* | OK - - -## List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -list or watch objects of kind ConfigMap - -### HTTP Request - -`GET /api/v1/namespaces/{namespace}/configmaps` - -### Path Parameters - -Parameter | Description ------------- | ----------- -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - -### Response - -Code | Description ------------- | ----------- -200
    *[ConfigMapList](#configmaplist-v1)* | OK - - -## List All Namespaces - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -list or watch objects of kind ConfigMap - -### HTTP Request - -`GET /api/v1/configmaps` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
    *[ConfigMapList](#configmaplist-v1)* | OK - - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch changes to an object of kind ConfigMap - -### HTTP Request - -`GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -name | name of the ConfigMap -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
    *[Event](#event-versioned)* | OK - - -## Watch List All Namespaces - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of ConfigMap - -### HTTP Request - -`GET /api/v1/watch/configmaps` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
    *[Event](#event-versioned)* | OK - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_configmap_v1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_configmap_v1_definition.md deleted file mode 100644 index de3efa273f..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_configmap_v1_definition.md +++ /dev/null @@ -1,20 +0,0 @@ -## ConfigMap v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ConfigMap - -> Example yaml coming soon... - - - -ConfigMap holds configuration data for pods to consume. - - - -Field | Description ------------- | ----------- -data
    *object* | Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot. -metadata
    *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_configmapkeyselector_v1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_configmapkeyselector_v1_concept.md deleted file mode 100644 index a602f360e4..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_configmapkeyselector_v1_concept.md +++ /dev/null @@ -1,31 +0,0 @@ - - ------------ -# ConfigMapKeySelector v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ConfigMapKeySelector - - - - - - - -Selects a key from a ConfigMap. - - - -Field | Description ------------- | ----------- -key
    *string* | The key to select. - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_configmapkeyselector_v1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_configmapkeyselector_v1_definition.md deleted file mode 100644 index ba027f9d1a..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_configmapkeyselector_v1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## ConfigMapKeySelector v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ConfigMapKeySelector - -> Example yaml coming soon... - - - -Selects a key from a ConfigMap. - - - -Field | Description ------------- | ----------- -key
    *string* | The key to select. - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_configmaplist_v1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_configmaplist_v1_concept.md deleted file mode 100644 index 799ed34747..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_configmaplist_v1_concept.md +++ /dev/null @@ -1,97 +0,0 @@ - - ------------ -# ConfigMapList v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ConfigMapList - - - - - - - -ConfigMapList is a resource containing a list of ConfigMap objects. - - - -Field | Description ------------- | ----------- -items
    *[ConfigMap](#configmap-v1) array* | Items is the list of ConfigMaps. -metadata
    *[ListMeta](#listmeta-unversioned)* | More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - - - - - -## Read Operations - -See supported operations below... - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of ConfigMap - -### HTTP Request - -`GET /api/v1/watch/namespaces/{namespace}/configmaps` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. -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. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
    *[Event](#event-versioned)* | OK - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_configmaplist_v1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_configmaplist_v1_definition.md deleted file mode 100644 index 599578689f..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_configmaplist_v1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## ConfigMapList v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ConfigMapList - -> Example yaml coming soon... - - - -ConfigMapList is a resource containing a list of ConfigMap objects. - - - -Field | Description ------------- | ----------- -items
    *[ConfigMap](#configmap-v1) array* | Items is the list of ConfigMaps. -metadata
    *[ListMeta](#listmeta-unversioned)* | More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_container_v1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_container_v1_concept.md deleted file mode 100644 index 8c33d2c477..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_container_v1_concept.md +++ /dev/null @@ -1,84 +0,0 @@ - - ------------ -# Container v1 - ->bdocs-tab:kubectl Container Config to run nginx (must be embedded in a PodSpec to run). - -```bdocs-tab:kubectl_yaml - -name: nginx -# Run the nginx:1.10 image -image: nginx:1.10 - - -``` ->bdocs-tab:curl Container Config to run nginx (must be embedded in a PodSpec to run). - -```bdocs-tab:curl_yaml - -name: nginx -# Run the nginx:1.10 image -image: nginx:1.10 - - -``` - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | Container - - - - - - - -A single application container that you want to run within a pod. - - - -Field | Description ------------- | ----------- -args
    *string array* | Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands -command
    *string array* | Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands -env
    *[EnvVar](#envvar-v1) array* | List of environment variables to set in the container. Cannot be updated. -image
    *string* | Docker image name. More info: http://kubernetes.io/docs/user-guide/images -imagePullPolicy
    *string* | Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/images#updating-images -lifecycle
    *[Lifecycle](#lifecycle-v1)* | Actions that the management system should take in response to container lifecycle events. Cannot be updated. -livenessProbe
    *[Probe](#probe-v1)* | Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes -name
    *string* | Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. -ports
    *[ContainerPort](#containerport-v1) array* | List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. -readinessProbe
    *[Probe](#probe-v1)* | Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes -resources
    *[ResourceRequirements](#resourcerequirements-v1)* | Compute Resources required by this container. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources -securityContext
    *[SecurityContext](#securitycontext-v1)* | Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md -stdin
    *boolean* | Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. -stdinOnce
    *boolean* | Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false -terminationMessagePath
    *string* | Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated. -tty
    *boolean* | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. -volumeMounts
    *[VolumeMount](#volumemount-v1) array* | Pod volumes to mount into the container's filesystem. Cannot be updated. -workingDir
    *string* | Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. - - -### ContainerStatus v1 - - - -Field | Description ------------- | ----------- -containerID
    *string* | Container's ID in the format 'docker://'. More info: http://kubernetes.io/docs/user-guide/container-environment#container-information -image
    *string* | The image the container is running. More info: http://kubernetes.io/docs/user-guide/images -imageID
    *string* | ImageID of the container's image. -lastState
    *[ContainerState](#containerstate-v1)* | Details about the container's last termination condition. -name
    *string* | This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated. -ready
    *boolean* | Specifies whether the container has passed its readiness probe. -restartCount
    *integer* | The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC. -state
    *[ContainerState](#containerstate-v1)* | Details about the container's current condition. - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_container_v1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_container_v1_definition.md deleted file mode 100644 index cf5fae961c..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_container_v1_definition.md +++ /dev/null @@ -1,36 +0,0 @@ -## Container v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | Container - -> Example yaml coming soon... - - - -A single application container that you want to run within a pod. - - - -Field | Description ------------- | ----------- -args
    *string array* | Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands -command
    *string array* | Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands -env
    *[EnvVar](#envvar-v1) array* | List of environment variables to set in the container. Cannot be updated. -image
    *string* | Docker image name. More info: http://kubernetes.io/docs/user-guide/images -imagePullPolicy
    *string* | Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/images#updating-images -lifecycle
    *[Lifecycle](#lifecycle-v1)* | Actions that the management system should take in response to container lifecycle events. Cannot be updated. -livenessProbe
    *[Probe](#probe-v1)* | Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes -name
    *string* | Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. -ports
    *[ContainerPort](#containerport-v1) array* | List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. -readinessProbe
    *[Probe](#probe-v1)* | Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes -resources
    *[ResourceRequirements](#resourcerequirements-v1)* | Compute Resources required by this container. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources -securityContext
    *[SecurityContext](#securitycontext-v1)* | Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md -stdin
    *boolean* | Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. -stdinOnce
    *boolean* | Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false -terminationMessagePath
    *string* | Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated. -tty
    *boolean* | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. -volumeMounts
    *[VolumeMount](#volumemount-v1) array* | Pod volumes to mount into the container's filesystem. Cannot be updated. -workingDir
    *string* | Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_containerimage_v1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_containerimage_v1_concept.md deleted file mode 100644 index ca498c5d33..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_containerimage_v1_concept.md +++ /dev/null @@ -1,32 +0,0 @@ - - ------------ -# ContainerImage v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerImage - - - - - - - -Describe a container image - - - -Field | Description ------------- | ----------- -names
    *string array* | 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"] -sizeBytes
    *integer* | The size of the image in bytes. - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_containerimage_v1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_containerimage_v1_definition.md deleted file mode 100644 index 2d8be28bcf..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_containerimage_v1_definition.md +++ /dev/null @@ -1,20 +0,0 @@ -## ContainerImage v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerImage - -> Example yaml coming soon... - - - -Describe a container image - - - -Field | Description ------------- | ----------- -names
    *string array* | 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"] -sizeBytes
    *integer* | The size of the image in bytes. - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_containerport_v1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_containerport_v1_concept.md deleted file mode 100644 index 3c003e33d8..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_containerport_v1_concept.md +++ /dev/null @@ -1,35 +0,0 @@ - - ------------ -# ContainerPort v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerPort - - - - - - - -ContainerPort represents a network port in a single container. - - - -Field | Description ------------- | ----------- -containerPort
    *integer* | Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. -hostIP
    *string* | What host IP to bind the external port to. -hostPort
    *integer* | Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. -name
    *string* | If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. -protocol
    *string* | Protocol for port. Must be UDP or TCP. Defaults to "TCP". - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_containerport_v1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_containerport_v1_definition.md deleted file mode 100644 index 3340705be7..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_containerport_v1_definition.md +++ /dev/null @@ -1,23 +0,0 @@ -## ContainerPort v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerPort - -> Example yaml coming soon... - - - -ContainerPort represents a network port in a single container. - - - -Field | Description ------------- | ----------- -containerPort
    *integer* | Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. -hostIP
    *string* | What host IP to bind the external port to. -hostPort
    *integer* | Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. -name
    *string* | If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. -protocol
    *string* | Protocol for port. Must be UDP or TCP. Defaults to "TCP". - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_containerstate_v1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_containerstate_v1_concept.md deleted file mode 100644 index a0958ebb25..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_containerstate_v1_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# ContainerState v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerState - - - - - - - -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. - - - -Field | Description ------------- | ----------- -running
    *[ContainerStateRunning](#containerstaterunning-v1)* | Details about a running container -terminated
    *[ContainerStateTerminated](#containerstateterminated-v1)* | Details about a terminated container -waiting
    *[ContainerStateWaiting](#containerstatewaiting-v1)* | Details about a waiting container - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_containerstate_v1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_containerstate_v1_definition.md deleted file mode 100644 index 74e9f2f9d0..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_containerstate_v1_definition.md +++ /dev/null @@ -1,21 +0,0 @@ -## ContainerState v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerState - -> Example yaml coming soon... - - - -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. - - - -Field | Description ------------- | ----------- -running
    *[ContainerStateRunning](#containerstaterunning-v1)* | Details about a running container -terminated
    *[ContainerStateTerminated](#containerstateterminated-v1)* | Details about a terminated container -waiting
    *[ContainerStateWaiting](#containerstatewaiting-v1)* | Details about a waiting container - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_containerstaterunning_v1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_containerstaterunning_v1_concept.md deleted file mode 100644 index 1714dac45b..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_containerstaterunning_v1_concept.md +++ /dev/null @@ -1,31 +0,0 @@ - - ------------ -# ContainerStateRunning v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStateRunning - - - - - - - -ContainerStateRunning is a running state of a container. - - - -Field | Description ------------- | ----------- -startedAt
    *[Time](#time-unversioned)* | Time at which the container was last (re-)started - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_containerstaterunning_v1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_containerstaterunning_v1_definition.md deleted file mode 100644 index c8caef45db..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_containerstaterunning_v1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## ContainerStateRunning v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStateRunning - -> Example yaml coming soon... - - - -ContainerStateRunning is a running state of a container. - - - -Field | Description ------------- | ----------- -startedAt
    *[Time](#time-unversioned)* | Time at which the container was last (re-)started - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_containerstateterminated_v1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_containerstateterminated_v1_concept.md deleted file mode 100644 index e76ba6af4a..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_containerstateterminated_v1_concept.md +++ /dev/null @@ -1,37 +0,0 @@ - - ------------ -# ContainerStateTerminated v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStateTerminated - - - - - - - -ContainerStateTerminated is a terminated state of a container. - - - -Field | Description ------------- | ----------- -containerID
    *string* | Container's ID in the format 'docker://' -exitCode
    *integer* | Exit status from the last termination of the container -finishedAt
    *[Time](#time-unversioned)* | Time at which the container last terminated -message
    *string* | Message regarding the last termination of the container -reason
    *string* | (brief) reason from the last termination of the container -signal
    *integer* | Signal from the last termination of the container -startedAt
    *[Time](#time-unversioned)* | Time at which previous execution of the container started - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_containerstateterminated_v1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_containerstateterminated_v1_definition.md deleted file mode 100644 index 03b2d1eef2..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_containerstateterminated_v1_definition.md +++ /dev/null @@ -1,25 +0,0 @@ -## ContainerStateTerminated v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStateTerminated - -> Example yaml coming soon... - - - -ContainerStateTerminated is a terminated state of a container. - - - -Field | Description ------------- | ----------- -containerID
    *string* | Container's ID in the format 'docker://' -exitCode
    *integer* | Exit status from the last termination of the container -finishedAt
    *[Time](#time-unversioned)* | Time at which the container last terminated -message
    *string* | Message regarding the last termination of the container -reason
    *string* | (brief) reason from the last termination of the container -signal
    *integer* | Signal from the last termination of the container -startedAt
    *[Time](#time-unversioned)* | Time at which previous execution of the container started - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_containerstatewaiting_v1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_containerstatewaiting_v1_concept.md deleted file mode 100644 index 9a9a3eeb1f..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_containerstatewaiting_v1_concept.md +++ /dev/null @@ -1,32 +0,0 @@ - - ------------ -# ContainerStateWaiting v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStateWaiting - - - - - - - -ContainerStateWaiting is a waiting state of a container. - - - -Field | Description ------------- | ----------- -message
    *string* | Message regarding why the container is not yet running. -reason
    *string* | (brief) reason the container is not yet running. - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_containerstatewaiting_v1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_containerstatewaiting_v1_definition.md deleted file mode 100644 index 82dcc3ec8b..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_containerstatewaiting_v1_definition.md +++ /dev/null @@ -1,20 +0,0 @@ -## ContainerStateWaiting v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStateWaiting - -> Example yaml coming soon... - - - -ContainerStateWaiting is a waiting state of a container. - - - -Field | Description ------------- | ----------- -message
    *string* | Message regarding why the container is not yet running. -reason
    *string* | (brief) reason the container is not yet running. - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_containerstatus_v1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_containerstatus_v1_concept.md deleted file mode 100644 index a77e8a3074..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_containerstatus_v1_concept.md +++ /dev/null @@ -1,38 +0,0 @@ - - ------------ -# ContainerStatus v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStatus - - - - - - - -ContainerStatus contains details for the current status of this container. - - - -Field | Description ------------- | ----------- -containerID
    *string* | Container's ID in the format 'docker://'. More info: http://kubernetes.io/docs/user-guide/container-environment#container-information -image
    *string* | The image the container is running. More info: http://kubernetes.io/docs/user-guide/images -imageID
    *string* | ImageID of the container's image. -lastState
    *[ContainerState](#containerstate-v1)* | Details about the container's last termination condition. -name
    *string* | This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated. -ready
    *boolean* | Specifies whether the container has passed its readiness probe. -restartCount
    *integer* | The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC. -state
    *[ContainerState](#containerstate-v1)* | Details about the container's current condition. - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_containerstatus_v1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_containerstatus_v1_definition.md deleted file mode 100644 index 1979433275..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_containerstatus_v1_definition.md +++ /dev/null @@ -1,26 +0,0 @@ -## ContainerStatus v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | ContainerStatus - -> Example yaml coming soon... - - - -ContainerStatus contains details for the current status of this container. - - - -Field | Description ------------- | ----------- -containerID
    *string* | Container's ID in the format 'docker://'. More info: http://kubernetes.io/docs/user-guide/container-environment#container-information -image
    *string* | The image the container is running. More info: http://kubernetes.io/docs/user-guide/images -imageID
    *string* | ImageID of the container's image. -lastState
    *[ContainerState](#containerstate-v1)* | Details about the container's last termination condition. -name
    *string* | This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated. -ready
    *boolean* | Specifies whether the container has passed its readiness probe. -restartCount
    *integer* | The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC. -state
    *[ContainerState](#containerstate-v1)* | Details about the container's current condition. - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_convert.md b/docs/user-guide/kubectl/v1.5/documents/_generated_convert.md deleted file mode 100644 index ff2f9fd292..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_convert.md +++ /dev/null @@ -1,54 +0,0 @@ ------------- - -# convert - ->bdocs-tab:example Convert 'pod.yaml' to latest version and print to stdout. - -```bdocs-tab:example_shell -kubectl convert -f pod.yaml -``` - ->bdocs-tab:example Convert the live state of the resource specified by 'pod.yaml' to the latest version # and print to stdout in json format. - -```bdocs-tab:example_shell -kubectl convert -f pod.yaml --local -o json -``` - ->bdocs-tab:example Convert all files under current directory to latest version and create them all. - -```bdocs-tab:example_shell -kubectl convert -f . | kubectl create -f - -``` - - -Convert config files between different API versions. Both YAML and JSON formats are accepted. - -The command takes filename, directory, or URL as input, and convert it into format of version specified by --output-version flag. If target version is not specified or not supported, convert to latest version. - -The default output will be printed to stdout in YAML format. One can use -o option to change to output destination. - -### Usage - -`$ convert -f FILENAME` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -filename | f | [] | Filename, directory, or URL to files to need to get converted. -include-extended-apis | | true | If true, include definitions of new APIs via calls to the API server. [default true] -local | | true | If true, convert will NOT try to contact api-server but run locally. -no-headers | | false | When using the default or custom-column output format, don't print headers. -output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. -output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -recursive | R | false | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. -schema-cache-dir | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' -show-all | a | false | When printing, show all resources (default hide terminated pods.) -show-labels | | false | When printing, show all labels as the last column (default hide labels column) -sort-by | | | 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 | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -validate | | true | If true, use a schema to validate the input before sending it - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_cordon.md b/docs/user-guide/kubectl/v1.5/documents/_generated_cordon.md deleted file mode 100644 index 3919b06051..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_cordon.md +++ /dev/null @@ -1,19 +0,0 @@ ------------- - -# cordon - ->bdocs-tab:example Mark node "foo" as unschedulable. - -```bdocs-tab:example_shell -kubectl cordon foo -``` - - -Mark node as unschedulable. - -### Usage - -`$ cordon NODE` - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_cp.md b/docs/user-guide/kubectl/v1.5/documents/_generated_cp.md deleted file mode 100644 index c759333488..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_cp.md +++ /dev/null @@ -1,44 +0,0 @@ ------------- - -# cp - ->bdocs-tab:example !!!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 - -```bdocs-tab:example_shell -kubectl cp /tmp/foo_dir :/tmp/bar_dir -``` - ->bdocs-tab:example Copy /tmp/foo local file to /tmp/bar in a remote pod in a specific container - -```bdocs-tab:example_shell -kubectl cp /tmp/foo :/tmp/bar -c -``` - ->bdocs-tab:example Copy /tmp/foo local file to /tmp/bar in a remote pod in namespace - -```bdocs-tab:example_shell -kubectl cp /tmp/foo /:/tmp/bar -``` - ->bdocs-tab:example Copy /tmp/foo from a remote pod to /tmp/bar locally - -```bdocs-tab:example_shell -kubectl cp /:/tmp/foo /tmp/bar -``` - - -Copy files and directories to and from containers. - -### Usage - -`$ cp ` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -container | c | | Container name. If omitted, the first container in the pod will be chosen - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_cputargetutilization_v1beta1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_cputargetutilization_v1beta1_concept.md deleted file mode 100644 index 53ce2ba364..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_cputargetutilization_v1beta1_concept.md +++ /dev/null @@ -1,31 +0,0 @@ - - ------------ -# CPUTargetUtilization v1beta1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1beta1 | CPUTargetUtilization - - - - - - - - - - - -Field | Description ------------- | ----------- -targetPercentage
    *integer* | fraction of the requested CPU that should be utilized/used, e.g. 70 means that 70% of the requested CPU should be in use. - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_cputargetutilization_v1beta1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_cputargetutilization_v1beta1_definition.md deleted file mode 100644 index a6223fe793..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_cputargetutilization_v1beta1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## CPUTargetUtilization v1beta1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1beta1 | CPUTargetUtilization - -> Example yaml coming soon... - - - - - - - -Field | Description ------------- | ----------- -targetPercentage
    *integer* | fraction of the requested CPU that should be utilized/used, e.g. 70 means that 70% of the requested CPU should be in use. - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_create.md b/docs/user-guide/kubectl/v1.5/documents/_generated_create.md deleted file mode 100644 index dbab43806e..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_create.md +++ /dev/null @@ -1,585 +0,0 @@ ------------- - -# create - ->bdocs-tab:example Create a pod using the data in pod.json. - -```bdocs-tab:example_shell -kubectl create -f ./pod.json -``` - ->bdocs-tab:example Create a pod based on the JSON passed into stdin. - -```bdocs-tab:example_shell -cat pod.json | kubectl create -f - -``` - ->bdocs-tab:example Edit the data in docker-registry.yaml in JSON using the v1 API format then create the resource using the edited data. - -```bdocs-tab:example_shell -kubectl create -f docker-registry.yaml --edit --output-version=v1 -o json -``` - - -Create a resource by filename or stdin. - -JSON and YAML formats are accepted. - -### Usage - -`$ create -f FILENAME` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -dry-run | | false | If true, only print the object that would be sent, without sending it. -edit | | false | Edit the API resource before creating -filename | f | [] | Filename, directory, or URL to files to use to create the resource -include-extended-apis | | true | If true, include definitions of new APIs via calls to the API server. [default true] -no-headers | | false | When using the default or custom-column output format, don't print headers. -output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. -output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -record | | false | Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. -recursive | R | false | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. -save-config | | false | 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 | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' -show-all | a | false | When printing, show all resources (default hide terminated pods.) -show-labels | | false | When printing, show all labels as the last column (default hide labels column) -sort-by | | | 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 | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -validate | | true | If true, use a schema to validate the input before sending it -windows-line-endings | | false | Only relevant if --edit=true. Use Windows line-endings (default Unix line-endings) - - ------------- - -## configmap - ->bdocs-tab:example Create a new configmap named my-config with keys for each file in folder bar - -```bdocs-tab:example_shell -kubectl create configmap my-config --from-file=path/to/bar -``` - ->bdocs-tab:example Create a new configmap named my-config with specified keys instead of names on disk - -```bdocs-tab:example_shell -kubectl create configmap my-config --from-file=key1=/path/to/bar/file1.txt --from-file=key2=/path/to/bar/file2.txt -``` - ->bdocs-tab:example Create a new configmap named my-config with key1=config1 and key2=config2 - -```bdocs-tab:example_shell -kubectl create configmap my-config --from-literal=key1=config1 --from-literal=key2=config2 -``` - - -Create a configmap based on a file, directory, or specified literal value. - -A single configmap may package one or more key/value pairs. - -When creating a configmap based on a file, the key will default to the basename of the file, and the value will default to the file content. If the basename is an invalid key, you may specify an alternate key. - -When creating a configmap based on a directory, each file whose basename is a valid key in the directory will be packaged into the configmap. Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc). - -### Usage - -`$ configmap NAME [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run]` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -dry-run | | false | If true, only print the object that would be sent, without sending it. -from-file | | [] | Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid configmap key. -from-literal | | [] | Specify a key and literal value to insert in configmap (i.e. mykey=somevalue) -generator | | configmap/v1 | The name of the API generator to use. -no-headers | | false | When using the default or custom-column output format, don't print headers. -output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. -output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -save-config | | false | 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 | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' -show-all | a | false | When printing, show all resources (default hide terminated pods.) -show-labels | | false | When printing, show all labels as the last column (default hide labels column) -sort-by | | | 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 | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -validate | | true | If true, use a schema to validate the input before sending it - - - ------------- - -## deployment - ->bdocs-tab:example Create a new deployment named my-dep that runs the busybox image. - -```bdocs-tab:example_shell -kubectl create deployment my-dep --image=busybox -``` - - -Create a deployment with the specified name. - -### Usage - -`$ deployment NAME --image=image [--dry-run]` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -dry-run | | false | If true, only print the object that would be sent, without sending it. -generator | | deployment-basic/v1beta1 | The name of the API generator to use. -image | | [] | Image name to run. -no-headers | | false | When using the default or custom-column output format, don't print headers. -output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. -output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -save-config | | false | 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 | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' -show-all | a | false | When printing, show all resources (default hide terminated pods.) -show-labels | | false | When printing, show all labels as the last column (default hide labels column) -sort-by | | | 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 | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -validate | | true | If true, use a schema to validate the input before sending it - - - ------------- - -## namespace - ->bdocs-tab:example Create a new namespace named my-namespace - -```bdocs-tab:example_shell -kubectl create namespace my-namespace -``` - - -Create a namespace with the specified name. - -### Usage - -`$ namespace NAME [--dry-run]` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -dry-run | | false | If true, only print the object that would be sent, without sending it. -generator | | namespace/v1 | The name of the API generator to use. -no-headers | | false | When using the default or custom-column output format, don't print headers. -output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. -output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -save-config | | false | 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 | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' -show-all | a | false | When printing, show all resources (default hide terminated pods.) -show-labels | | false | When printing, show all labels as the last column (default hide labels column) -sort-by | | | 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 | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -validate | | true | If true, use a schema to validate the input before sending it - - - ------------- - -## quota - ->bdocs-tab:example Create a new resourcequota named my-quota - -```bdocs-tab:example_shell -$ kubectl create quota my-quota --hard=cpu=1,memory=1G,pods=2,services=3,replicationcontrollers=2,resourcequotas=1,secrets=5,persistentvolumeclaims=10 -``` - ->bdocs-tab:example Create a new resourcequota named best-effort - -```bdocs-tab:example_shell -$ kubectl create quota best-effort --hard=pods=100 --scopes=BestEffort -``` - - -Create a resourcequota with the specified name, hard limits and optional scopes - -### Usage - -`$ quota NAME [--hard=key1=value1,key2=value2] [--scopes=Scope1,Scope2] [--dry-run=bool]` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -dry-run | | false | If true, only print the object that would be sent, without sending it. -generator | | resourcequotas/v1 | The name of the API generator to use. -hard | | | A comma-delimited set of resource=quantity pairs that define a hard limit. -no-headers | | false | When using the default or custom-column output format, don't print headers. -output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. -output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -save-config | | false | 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 | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' -scopes | | | A comma-delimited set of quota scopes that must all match each object tracked by the quota. -show-all | a | false | When printing, show all resources (default hide terminated pods.) -show-labels | | false | When printing, show all labels as the last column (default hide labels column) -sort-by | | | 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 | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -validate | | true | If true, use a schema to validate the input before sending it - - - ------------- - -## secret - - - -Create a secret using specified subcommand. - -### Usage - -`$ secret` - - - - ------------- - -## secret docker-registry - ->bdocs-tab:example If you don't already have a .dockercfg file, you can create a dockercfg secret directly by using: - -```bdocs-tab:example_shell -kubectl create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL -``` - - -Create a new secret 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. - -### Usage - -`$ docker-registry NAME --docker-username=user --docker-password=password --docker-email=email [--docker-server=string] [--from-literal=key1=value1] [--dry-run]` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -docker-email | | | Email for Docker registry -docker-password | | | Password for Docker registry authentication -docker-server | | https://index.docker.io/v1/ | Server location for Docker registry -docker-username | | | Username for Docker registry authentication -dry-run | | false | If true, only print the object that would be sent, without sending it. -generator | | secret-for-docker-registry/v1 | The name of the API generator to use. -include-extended-apis | | true | If true, include definitions of new APIs via calls to the API server. [default true] -no-headers | | false | When using the default or custom-column output format, don't print headers. -output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. -output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -save-config | | false | 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 | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' -show-all | a | false | When printing, show all resources (default hide terminated pods.) -show-labels | | false | When printing, show all labels as the last column (default hide labels column) -sort-by | | | 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 | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -validate | | true | If true, use a schema to validate the input before sending it - - - ------------- - -## secret generic - ->bdocs-tab:example Create a new secret named my-secret with keys for each file in folder bar - -```bdocs-tab:example_shell -kubectl create secret generic my-secret --from-file=path/to/bar -``` - ->bdocs-tab:example Create a new secret named my-secret with specified keys instead of names on disk - -```bdocs-tab:example_shell -kubectl create secret generic my-secret --from-file=ssh-privatekey=~/.ssh/id_rsa --from-file=ssh-publickey=~/.ssh/id_rsa.pub -``` - ->bdocs-tab:example Create a new secret named my-secret with key1=supersecret and key2=topsecret - -```bdocs-tab:example_shell -kubectl create secret generic my-secret --from-literal=key1=supersecret --from-literal=key2=topsecret -``` - - -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). - -### Usage - -`$ generic NAME [--type=string] [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run]` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -dry-run | | false | If true, only print the object that would be sent, without sending it. -from-file | | [] | Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid secret key. -from-literal | | [] | Specify a key and literal value to insert in secret (i.e. mykey=somevalue) -generator | | secret/v1 | The name of the API generator to use. -no-headers | | false | When using the default or custom-column output format, don't print headers. -output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. -output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -save-config | | false | 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 | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' -show-all | a | false | When printing, show all resources (default hide terminated pods.) -show-labels | | false | When printing, show all labels as the last column (default hide labels column) -sort-by | | | 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 | | | 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 | | | The type of secret to create -validate | | true | If true, use a schema to validate the input before sending it - - - ------------- - -## secret tls - ->bdocs-tab:example Create a new TLS secret named tls-secret with the given key pair: - -```bdocs-tab:example_shell -kubectl create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.key -``` - - -Create a TLS secret from the given public/private key pair. - -The public/private key pair must exist before hand. The public key certificate must be .PEM encoded and match the given private key. - -### Usage - -`$ tls NAME --cert=path/to/cert/file --key=path/to/key/file [--dry-run]` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -cert | | | Path to PEM encoded public key certificate. -dry-run | | false | If true, only print the object that would be sent, without sending it. -generator | | secret-for-tls/v1 | The name of the API generator to use. -key | | | Path to private key associated with given certificate. -no-headers | | false | When using the default or custom-column output format, don't print headers. -output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. -output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -save-config | | false | 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 | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' -show-all | a | false | When printing, show all resources (default hide terminated pods.) -show-labels | | false | When printing, show all labels as the last column (default hide labels column) -sort-by | | | 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 | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -validate | | true | If true, use a schema to validate the input before sending it - - - ------------- - -## service - - - -Create a service using specified subcommand. - -### Usage - -`$ service` - - - - ------------- - -## service clusterip - ->bdocs-tab:example Create a new clusterIP service named my-cs - -```bdocs-tab:example_shell -kubectl create service clusterip my-cs --tcp=5678:8080 -``` - ->bdocs-tab:example Create a new clusterIP service named my-cs (in headless mode) - -```bdocs-tab:example_shell -kubectl create service clusterip my-cs --clusterip="None" -``` - - -Create a clusterIP service with the specified name. - -### Usage - -`$ clusterip NAME [--tcp=:] [--dry-run]` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -clusterip | | | Assign your own ClusterIP or set to 'None' for a 'headless' service (no loadbalancing). -dry-run | | false | If true, only print the object that would be sent, without sending it. -generator | | service-clusterip/v1 | The name of the API generator to use. -no-headers | | false | When using the default or custom-column output format, don't print headers. -output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. -output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -save-config | | false | 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 | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' -show-all | a | false | When printing, show all resources (default hide terminated pods.) -show-labels | | false | When printing, show all labels as the last column (default hide labels column) -sort-by | | | 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 | | [] | Port pairs can be specified as ':'. -template | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -validate | | true | If true, use a schema to validate the input before sending it - - - ------------- - -## service loadbalancer - ->bdocs-tab:example Create a new LoadBalancer service named my-lbs - -```bdocs-tab:example_shell -kubectl create service loadbalancer my-lbs --tcp=5678:8080 -``` - - -Create a LoadBalancer service with the specified name. - -### Usage - -`$ loadbalancer NAME [--tcp=port:targetPort] [--dry-run]` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -dry-run | | false | If true, only print the object that would be sent, without sending it. -generator | | service-loadbalancer/v1 | The name of the API generator to use. -no-headers | | false | When using the default or custom-column output format, don't print headers. -output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. -output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -save-config | | false | 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 | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' -show-all | a | false | When printing, show all resources (default hide terminated pods.) -show-labels | | false | When printing, show all labels as the last column (default hide labels column) -sort-by | | | 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 | | [] | Port pairs can be specified as ':'. -template | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -validate | | true | If true, use a schema to validate the input before sending it - - - ------------- - -## service nodeport - ->bdocs-tab:example Create a new nodeport service named my-ns - -```bdocs-tab:example_shell -kubectl create service nodeport my-ns --tcp=5678:8080 -``` - - -Create a nodeport service with the specified name. - -### Usage - -`$ nodeport NAME [--tcp=port:targetPort] [--dry-run]` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -dry-run | | false | If true, only print the object that would be sent, without sending it. -generator | | service-nodeport/v1 | The name of the API generator to use. -no-headers | | false | When using the default or custom-column output format, don't print headers. -node-port | | 0 | Port used to expose the service on each node in a cluster. -output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. -output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -save-config | | false | 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 | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' -show-all | a | false | When printing, show all resources (default hide terminated pods.) -show-labels | | false | When printing, show all labels as the last column (default hide labels column) -sort-by | | | 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 | | [] | Port pairs can be specified as ':'. -template | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -validate | | true | If true, use a schema to validate the input before sending it - - - ------------- - -## serviceaccount - ->bdocs-tab:example Create a new service account named my-service-account - -```bdocs-tab:example_shell -$ kubectl create serviceaccount my-service-account -``` - - -Create a service account with the specified name. - -### Usage - -`$ serviceaccount NAME [--dry-run]` - - - -### Flags - -Name | Shorthand | Default | Usage ----- | --------- | ------- | ----- -dry-run | | false | If true, only print the object that would be sent, without sending it. -generator | | serviceaccount/v1 | The name of the API generator to use. -include-extended-apis | | true | If true, include definitions of new APIs via calls to the API server. [default true] -no-headers | | false | When using the default or custom-column output format, don't print headers. -output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. -output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -save-config | | false | 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 | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' -show-all | a | false | When printing, show all resources (default hide terminated pods.) -show-labels | | false | When printing, show all labels as the last column (default hide labels column) -sort-by | | | 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 | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -validate | | true | If true, use a schema to validate the input before sending it - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_crossversionobjectreference_v1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_crossversionobjectreference_v1_concept.md deleted file mode 100644 index e18c960c76..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_crossversionobjectreference_v1_concept.md +++ /dev/null @@ -1,33 +0,0 @@ - - ------------ -# CrossVersionObjectReference v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | CrossVersionObjectReference - - - - - - - -CrossVersionObjectReference contains enough information to let you identify the referred resource. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | API version of the referent -kind
    *string* | Kind of the referent; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds" -name
    *string* | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_crossversionobjectreference_v1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_crossversionobjectreference_v1_definition.md deleted file mode 100644 index a921988b82..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_crossversionobjectreference_v1_definition.md +++ /dev/null @@ -1,21 +0,0 @@ -## CrossVersionObjectReference v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | CrossVersionObjectReference - -> Example yaml coming soon... - - - -CrossVersionObjectReference contains enough information to let you identify the referred resource. - - - -Field | Description ------------- | ----------- -apiVersion
    *string* | API version of the referent -kind
    *string* | Kind of the referent; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds" -name
    *string* | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_daemonendpoint_v1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_daemonendpoint_v1_concept.md deleted file mode 100644 index e745761332..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_daemonendpoint_v1_concept.md +++ /dev/null @@ -1,31 +0,0 @@ - - ------------ -# DaemonEndpoint v1 - - - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | DaemonEndpoint - - - - - - - -DaemonEndpoint contains information about a single Daemon endpoint. - - - -Field | Description ------------- | ----------- -Port
    *integer* | Port number of the given endpoint. - - - - - - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_daemonendpoint_v1_definition.md b/docs/user-guide/kubectl/v1.5/documents/_generated_daemonendpoint_v1_definition.md deleted file mode 100644 index d64250cd5d..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_daemonendpoint_v1_definition.md +++ /dev/null @@ -1,19 +0,0 @@ -## DaemonEndpoint v1 - -Group | Version | Kind ------------- | ---------- | ----------- -Core | v1 | DaemonEndpoint - -> Example yaml coming soon... - - - -DaemonEndpoint contains information about a single Daemon endpoint. - - - -Field | Description ------------- | ----------- -Port
    *integer* | Port number of the given endpoint. - diff --git a/docs/user-guide/kubectl/v1.5/documents/_generated_daemonset_v1beta1_concept.md b/docs/user-guide/kubectl/v1.5/documents/_generated_daemonset_v1beta1_concept.md deleted file mode 100644 index aa7a6d8b49..0000000000 --- a/docs/user-guide/kubectl/v1.5/documents/_generated_daemonset_v1beta1_concept.md +++ /dev/null @@ -1,1122 +0,0 @@ - - ------------ -# DaemonSet v1beta1 - ->bdocs-tab:kubectl DaemonSet Config to print the `hostname` on each Node in the cluster every 10 seconds. - -```bdocs-tab:kubectl_yaml - -apiVersion: extensions/v1beta1 -kind: DaemonSet -metadata: - # Unique key of the DaemonSet instance - name: daemonset-example -spec: - template: - metadata: - labels: - app: daemonset-example - spec: - containers: - # This container is run once on each Node in the cluster - - name: daemonset-example - image: ubuntu:trusty - command: - - /bin/sh - args: - - -c - # This script is run through `sh -c - - - diff --git a/partners/index.html b/partners/index.html index 5a8da670a9..13ee6e2396 100644 --- a/partners/index.html +++ b/partners/index.html @@ -1,11 +1,10 @@ --- title: Partners +layout: basic +class: gridPage +cid: partners --- - - -{% include head-header.html %} -

    Kubernetes Partners

    Growing the Kubernetes ecosystem.
    @@ -22,9 +21,6 @@ title: Partners
    -{% include footer.html %} -{% include case-study-styles.html %} - @@ -32,6 +28,3 @@ title: Partners - - - diff --git a/skip_title_check.txt b/skip_title_check.txt index 3c62da283d..90ac6482c5 100644 --- a/skip_title_check.txt +++ b/skip_title_check.txt @@ -9,3 +9,4 @@ docs/api-reference/v1/definitions.md docs/api-reference/v1/operations.md docs/user-guide/pods/_viewing-a-pod.md docs/user-guide/simple-yaml.md +docs/concepts/abstractions/pod-termination.md \ No newline at end of file diff --git a/skip_toc_check.txt b/skip_toc_check.txt index 00d5a5bdec..255bb26d10 100644 --- a/skip_toc_check.txt +++ b/skip_toc_check.txt @@ -8,3 +8,4 @@ docs/user-guide/walkthrough/k8s201.md docs/user-guide/logging-demo/README.md docs/user-guide/downward-api/README.md docs/user-guide/configmap/README.md +docs/concepts/abstractions/pod-termination.md \ No newline at end of file