diff --git a/.travis.yml b/.travis.yml index 33db17d9e7..791d289e88 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,6 +1,6 @@ language: go go: - - 1.6.2 + - 1.7.3 # Don't want default ./... here: install: 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 9d08a88367..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,13 +66,9 @@ 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/production-pods.md - docs/user-guide/containers.md - docs/user-guide/environment-guide/index.md - docs/user-guide/compute-resources.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 9605e925b0..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 @@ -13,7 +13,8 @@ toc: - docs/tasks/configure-pod-container/pull-image-private-registry.md - docs/tasks/configure-pod-container/configure-liveness-readiness-probes.md - docs/tasks/configure-pod-container/communicate-containers-same-pod.md - - docs/tasks/configure-pod-container/configure-pod-initialization.md + - docs/tasks/configure-pod-container/configure-pod-initialization.md + - docs/tasks/configure-pod-container/attach-handler-lifecycle-event.md - title: Accessing Applications in a Cluster section: 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/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 c9dd662449..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) @@ -259,7 +263,6 @@ rules: - apiGroups: [""] # The API group "" indicates the core API Group. resources: ["pods"] verbs: ["get", "watch", "list"] - nonResourceURLs: [] ``` `ClusterRoles` hold the same information as a `Role` but can apply to any @@ -505,7 +508,7 @@ An example request body: "resourceAttributes": { "namespace": "kittensandponies", "verb": "GET", - "group": "*", + "group": "unicorn.example.org", "resource": "pods" }, "user": "jane", @@ -628,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 d2479ffff2..05d0ae9250 100644 --- a/docs/admin/salt.md +++ b/docs/admin/salt.md @@ -6,7 +6,7 @@ title: Configuring Kubernetes with Salt The Kubernetes cluster can be configured using Salt. -The Salt scripts are shared across multiple hosting providers, so it's important to understand some background information prior to making a modification to ensure your changes do not break hosting Kubernetes across multiple environments. Depending on where you host your Kubernetes cluster, you may be using different operating systems and different networking configurations. As a result, it's important to understand some background information before making Salt changes in order to minimize introducing failures for other hosting providers. +The Salt scripts are shared across multiple hosting providers and depending on where you host your Kubernetes cluster, you may be using different operating systems and different networking configurations. As a result, it's important to understand some background information before making Salt changes in order to minimize introducing failures for other hosting providers. ## Salt cluster setup @@ -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