Merge pull request #2301 from pwittrock/api-ref
Fix Various Issues In Reference Docs
This commit is contained in:
devin-donnelly
@@ -1,4 +0,0 @@
|
||||
# <strong>APP MANAGEMENT</strong>
|
||||
|
||||
This section contains commands for creating, updating, deleting, and
|
||||
viewing your workloads in a Kubernetes cluster.
|
||||
@@ -1,5 +0,0 @@
|
||||
# <strong>CLUSTER</strong>
|
||||
|
||||
These are responsible for defining configuration of the cluster itself, and are generally only used by cluster operators.
|
||||
|
||||
------------
|
||||
@@ -1,11 +0,0 @@
|
||||
# <strong>CONFIG & STORAGE</strong>
|
||||
|
||||
These are responsible for injecting data into your applications and persisting data externally to your container.
|
||||
|
||||
Common resource types:
|
||||
|
||||
- [ConfigMaps](#configmap-v1) for providing text key value pairs injected into the application through environment variables, command line arguments, or files
|
||||
- [Secrets](#secret-v1) for providing binary data injected into the application through files
|
||||
- [Volumes](#volume-v1) for providing a filesystem external to the Container. Maybe shared across Containers within the same Pod and have a lifetime persisting beyond a Container or Pod.
|
||||
|
||||
------------
|
||||
@@ -1,3 +0,0 @@
|
||||
# <strong>DEFINITIONS</strong>
|
||||
|
||||
These are Definitions for objects used by the above APIs
|
||||
@@ -1,108 +0,0 @@
|
||||
------------
|
||||
|
||||
# annotate
|
||||
|
||||
>bdocs-tab:example Update pod 'foo' with the annotation 'description' and the value 'my frontend'. # If the same annotation is set multiple times, only the last value will be applied
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl annotate pods foo description='my frontend'
|
||||
```
|
||||
|
||||
>bdocs-tab:example Update a pod identified by type and name in "pod.json"
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl annotate -f pod.json description='my frontend'
|
||||
```
|
||||
|
||||
>bdocs-tab:example Update pod 'foo' with the annotation 'description' and the value 'my frontend running nginx', overwriting any existing value.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl annotate --overwrite pods foo description='my frontend running nginx'
|
||||
```
|
||||
|
||||
>bdocs-tab:example Update all pods in the namespace
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl annotate pods --all description='my frontend running nginx'
|
||||
```
|
||||
|
||||
>bdocs-tab:example Update pod 'foo' only if the resource is unchanged from version 1.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl annotate pods foo description='my frontend running nginx' --resource-version=1
|
||||
```
|
||||
|
||||
>bdocs-tab:example Update pod 'foo' by removing an annotation named 'description' if it exists. # Does not require the --overwrite flag.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl annotate pods foo description-
|
||||
```
|
||||
|
||||
|
||||
Update the annotations on one or more resources.
|
||||
|
||||
* An annotation is a key/value pair that can hold larger (compared to a label), and possibly not human-readable, data.
|
||||
* It is intended to store non-identifying auxiliary data, especially data manipulated by tools and system extensions.
|
||||
* If --overwrite is true, then existing annotations can be overwritten, otherwise attempting to overwrite an annotation will result in an error.
|
||||
* If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used.
|
||||
|
||||
Valid resource types include:
|
||||
|
||||
* clusters (valid only for federation apiservers)
|
||||
* componentstatuses (aka 'cs')
|
||||
* configmaps (aka 'cm')
|
||||
* daemonsets (aka 'ds')
|
||||
* deployments (aka 'deploy')
|
||||
* endpoints (aka 'ep')
|
||||
* events (aka 'ev')
|
||||
* horizontalpodautoscalers (aka 'hpa')
|
||||
* ingresses (aka 'ing')
|
||||
* jobs
|
||||
* limitranges (aka 'limits')
|
||||
* namespaces (aka 'ns')
|
||||
* networkpolicies
|
||||
* nodes (aka 'no')
|
||||
* persistentvolumeclaims (aka 'pvc')
|
||||
* persistentvolumes (aka 'pv')
|
||||
* pods (aka 'po')
|
||||
* podsecuritypolicies (aka 'psp')
|
||||
* podtemplates
|
||||
* replicasets (aka 'rs')
|
||||
* replicationcontrollers (aka 'rc')
|
||||
* resourcequotas (aka 'quota')
|
||||
* secrets
|
||||
* serviceaccounts (aka 'sa')
|
||||
* services (aka 'svc')
|
||||
* statefulsets
|
||||
* storageclasses
|
||||
* thirdpartyresources
|
||||
|
||||
### Usage
|
||||
|
||||
`$ annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
all | | false | select all resources in the namespace of the specified resource types
|
||||
dry-run | | false | If true, only print the object that would be sent, without sending it.
|
||||
filename | f | [] | Filename, directory, or URL to files identifying the resource to update the annotation
|
||||
include-extended-apis | | true | If true, include definitions of new APIs via calls to the API server. [default true]
|
||||
local | | false | If true, annotation will NOT contact api-server but run locally.
|
||||
no-headers | | false | When using the default or custom-column output format, don't print headers.
|
||||
output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
|
||||
output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
|
||||
overwrite | | false | If true, allow annotations to be overwritten, otherwise reject annotation updates that overwrite existing annotations.
|
||||
record | | false | Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists.
|
||||
recursive | R | false | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
|
||||
resource-version | | | If non-empty, the annotation update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource.
|
||||
selector | l | | Selector (label query) to filter on
|
||||
show-all | a | false | When printing, show all resources (default hide terminated pods.)
|
||||
show-labels | | false | When printing, show all labels as the last column (default hide labels column)
|
||||
sort-by | | | If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
|
||||
template | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
|
||||
|
||||
|
||||
@@ -1,14 +0,0 @@
|
||||
------------
|
||||
|
||||
# api-versions
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Usage
|
||||
|
||||
`$ api-versions`
|
||||
|
||||
|
||||
|
||||
@@ -1,42 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# APIGroup unversioned
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | unversioned | APIGroup
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
APIGroup contains the name, the supported versions, and the preferred version of a group.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#apigrouplist-unversioned">APIGroupList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
name <br /> *string* | name is the name of the group.
|
||||
preferredVersion <br /> *[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned)* | preferredVersion is the version preferred by the API server, which probably is the storage version.
|
||||
serverAddressByClientCIDRs <br /> *[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 <br /> *[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned) array* | versions are the versions supported in this group.
|
||||
|
||||
|
||||
### APIGroupList unversioned
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
groups <br /> *[APIGroup](#apigroup-unversioned) array* | groups is a list of APIGroup.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,22 +0,0 @@
|
||||
## APIGroup unversioned
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | unversioned | APIGroup
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
APIGroup contains the name, the supported versions, and the preferred version of a group.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#apigrouplist-unversioned">APIGroupList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
name <br /> *string* | name is the name of the group.
|
||||
preferredVersion <br /> *[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned)* | preferredVersion is the version preferred by the API server, which probably is the storage version.
|
||||
serverAddressByClientCIDRs <br /> *[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 <br /> *[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned) array* | versions are the versions supported in this group.
|
||||
|
||||
@@ -1,30 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# APIGroupList unversioned
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | unversioned | APIGroupList
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
groups <br /> *[APIGroup](#apigroup-unversioned) array* | groups is a list of APIGroup.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-18
@@ -1,18 +0,0 @@
|
||||
## APIGroupList unversioned
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | unversioned | APIGroupList
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
groups <br /> *[APIGroup](#apigroup-unversioned) array* | groups is a list of APIGroup.
|
||||
|
||||
@@ -1,42 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# APIResource unversioned
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | unversioned | APIResource
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
APIResource specifies the name of a resource and whether it is namespaced.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#apiresourcelist-unversioned">APIResourceList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
kind <br /> *string* | kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
|
||||
name <br /> *string* | name is the name of the resource.
|
||||
namespaced <br /> *boolean* | namespaced indicates if a resource is namespaced or not.
|
||||
|
||||
|
||||
### APIResourceList unversioned
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
groupVersion <br /> *string* | groupVersion is the group and version this APIResourceList is for.
|
||||
resources <br /> *[APIResource](#apiresource-unversioned) array* | resources contains the name of the resources and if they are namespaced.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-21
@@ -1,21 +0,0 @@
|
||||
## APIResource unversioned
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | unversioned | APIResource
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
APIResource specifies the name of a resource and whether it is namespaced.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#apiresourcelist-unversioned">APIResourceList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
kind <br /> *string* | kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
|
||||
name <br /> *string* | name is the name of the resource.
|
||||
namespaced <br /> *boolean* | namespaced indicates if a resource is namespaced or not.
|
||||
|
||||
-31
@@ -1,31 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# APIResourceList unversioned
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | unversioned | APIResourceList
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
groupVersion <br /> *string* | groupVersion is the group and version this APIResourceList is for.
|
||||
resources <br /> *[APIResource](#apiresource-unversioned) array* | resources contains the name of the resources and if they are namespaced.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-19
@@ -1,19 +0,0 @@
|
||||
## APIResourceList unversioned
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | unversioned | APIResourceList
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
groupVersion <br /> *string* | groupVersion is the group and version this APIResourceList is for.
|
||||
resources <br /> *[APIResource](#apiresource-unversioned) array* | resources contains the name of the resources and if they are namespaced.
|
||||
|
||||
@@ -1,31 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# APIVersion v1beta1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | APIVersion
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
An APIVersion represents a single concrete version of an object model.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#thirdpartyresource-v1beta1">ThirdPartyResource</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
name <br /> *string* | Name of this version (e.g. 'v1').
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
## APIVersion v1beta1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | APIVersion
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
An APIVersion represents a single concrete version of an object model.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#thirdpartyresource-v1beta1">ThirdPartyResource</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
name <br /> *string* | Name of this version (e.g. 'v1').
|
||||
|
||||
@@ -1,31 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# APIVersions unversioned
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | unversioned | APIVersions
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
serverAddressByClientCIDRs <br /> *[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 <br /> *string array* | versions are the api versions that are available.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-19
@@ -1,19 +0,0 @@
|
||||
## APIVersions unversioned
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | unversioned | APIVersions
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
serverAddressByClientCIDRs <br /> *[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 <br /> *string array* | versions are the api versions that are available.
|
||||
|
||||
@@ -1,70 +0,0 @@
|
||||
------------
|
||||
|
||||
# apply
|
||||
|
||||
>bdocs-tab:example Apply the configuration in pod.json to a pod.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl apply -f ./pod.json
|
||||
```
|
||||
|
||||
>bdocs-tab:example Apply the JSON passed into stdin to a pod.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
cat pod.json | kubectl apply -f -
|
||||
```
|
||||
|
||||
>bdocs-tab:example Note: --prune is still in Alpha # Apply the configuration in manifest.yaml that matches label app=nginx and delete all the other resources that are not in the file and match label app=nginx.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl apply --prune -f manifest.yaml -l app=nginx
|
||||
```
|
||||
|
||||
>bdocs-tab:example Apply the configuration in manifest.yaml and delete all the other configmaps that are not in the file.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl apply --prune -f manifest.yaml --all --prune-whitelist=core/v1/ConfigMap
|
||||
```
|
||||
|
||||
|
||||
Apply a configuration to a resource by filename or stdin. This resource will be created if it doesn't exist yet. To use 'apply', always create the resource initially with either 'apply' or 'create --save-config'.
|
||||
|
||||
JSON and YAML formats are accepted.
|
||||
|
||||
Alpha Disclaimer: the --prune functionality is not yet complete. Do not use unless you are aware of what the current state is. See https://issues.k8s.io/34274.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ apply -f FILENAME`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
all | | false | [-all] to select all the specified resources.
|
||||
cascade | | true | Only relevant during a prune or a force apply. If true, cascade the deletion of the resources managed by pruned or deleted resources (e.g. Pods created by a ReplicationController).
|
||||
dry-run | | false | If true, only print the object that would be sent, without sending it.
|
||||
filename | f | [] | Filename, directory, or URL to files that contains the configuration to apply
|
||||
force | | false | Delete and re-create the specified resource, when PATCH encounters conflict and has retried for 5 times.
|
||||
grace-period | | -1 | Only relevant during a prune or a force apply. Period of time in seconds given to pruned or deleted resources to terminate gracefully. Ignored if negative.
|
||||
include-extended-apis | | true | If true, include definitions of new APIs via calls to the API server. [default true]
|
||||
no-headers | | false | When using the default or custom-column output format, don't print headers.
|
||||
output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
|
||||
output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
|
||||
overwrite | | true | Automatically resolve conflicts between the modified and live configuration by using values from the modified configuration
|
||||
prune | | false | Automatically delete resource objects that do not appear in the configs and are created by either apply or create --save-config. Should be used with either -l or --all.
|
||||
prune-whitelist | | [] | Overwrite the default whitelist with <group/version/kind> for --prune
|
||||
record | | false | Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists.
|
||||
recursive | R | false | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
|
||||
schema-cache-dir | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema'
|
||||
selector | l | | Selector (label query) to filter on
|
||||
show-all | a | false | When printing, show all resources (default hide terminated pods.)
|
||||
show-labels | | false | When printing, show all labels as the last column (default hide labels column)
|
||||
sort-by | | | If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
|
||||
template | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
|
||||
timeout | | 0s | Only relevant during a force apply. The length of time to wait before giving up on a delete of the old resource, zero means determine a timeout from the size of the object. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h).
|
||||
validate | | true | If true, use a schema to validate the input before sending it
|
||||
|
||||
|
||||
@@ -1,40 +0,0 @@
|
||||
------------
|
||||
|
||||
# attach
|
||||
|
||||
>bdocs-tab:example Get output from running pod 123456-7890, using the first container by default
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl attach 123456-7890
|
||||
```
|
||||
|
||||
>bdocs-tab:example Get output from ruby-container from pod 123456-7890
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl attach 123456-7890 -c ruby-container
|
||||
```
|
||||
|
||||
>bdocs-tab:example Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-7890 # and sends stdout/stderr from 'bash' back to the client
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl attach 123456-7890 -c ruby-container -i -t
|
||||
```
|
||||
|
||||
|
||||
Attach to a process that is already running inside an existing container.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ attach POD -c CONTAINER`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
container | c | | Container name. If omitted, the first container in the pod will be chosen
|
||||
stdin | i | false | Pass stdin to the container
|
||||
tty | t | false | Stdin is a TTY
|
||||
|
||||
|
||||
@@ -1,32 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# AttachedVolume v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | AttachedVolume
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
AttachedVolume describes a volume attached to a node
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#nodestatus-v1">NodeStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
devicePath <br /> *string* | DevicePath represents the device path where the volume should be available
|
||||
name <br /> *string* | Name of the attached volume
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
## AttachedVolume v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | AttachedVolume
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
AttachedVolume describes a volume attached to a node
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#nodestatus-v1">NodeStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
devicePath <br /> *string* | DevicePath represents the device path where the volume should be available
|
||||
name <br /> *string* | Name of the attached volume
|
||||
|
||||
@@ -1,51 +0,0 @@
|
||||
------------
|
||||
|
||||
# autoscale
|
||||
|
||||
>bdocs-tab:example Auto scale a deployment "foo", with the number of pods between 2 and 10, target CPU utilization specified so a default autoscaling policy will be used:
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl autoscale deployment foo --min=2 --max=10
|
||||
```
|
||||
|
||||
>bdocs-tab:example Auto scale a replication controller "foo", with the number of pods between 1 and 5, target CPU utilization at 80%:
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl autoscale rc foo --max=5 --cpu-percent=80
|
||||
```
|
||||
|
||||
|
||||
Creates an autoscaler that automatically chooses and sets the number of pods that run in a kubernetes cluster.
|
||||
|
||||
Looks up a Deployment, ReplicaSet, or ReplicationController by name and creates an autoscaler that uses the given resource as a reference. An autoscaler can automatically increase or decrease number of pods deployed within the system as needed.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU] [flags]`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
cpu-percent | | -1 | The target average CPU utilization (represented as a percent of requested CPU) over all the pods. If it's not specified or negative, a default autoscaling policy will be used.
|
||||
dry-run | | false | If true, only print the object that would be sent, without sending it.
|
||||
filename | f | [] | Filename, directory, or URL to files identifying the resource to autoscale.
|
||||
generator | | horizontalpodautoscaler/v1 | The name of the API generator to use. Currently there is only 1 generator.
|
||||
include-extended-apis | | true | If true, include definitions of new APIs via calls to the API server. [default true]
|
||||
max | | -1 | The upper limit for the number of pods that can be set by the autoscaler. Required.
|
||||
min | | -1 | The lower limit for the number of pods that can be set by the autoscaler. If it's not specified or negative, the server will apply a default value.
|
||||
name | | | The name for the newly created object. If not specified, the name of the input resource will be used.
|
||||
no-headers | | false | When using the default or custom-column output format, don't print headers.
|
||||
output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
|
||||
output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
|
||||
record | | false | Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists.
|
||||
recursive | R | false | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
|
||||
save-config | | false | If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
|
||||
show-all | a | false | When printing, show all resources (default hide terminated pods.)
|
||||
show-labels | | false | When printing, show all labels as the last column (default hide labels column)
|
||||
sort-by | | | If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
|
||||
template | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
|
||||
|
||||
|
||||
@@ -1,93 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# Binding v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | Binding
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Binding ties one object to another. For example, a pod is bound to a node by a scheduler.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
target <br /> *[ObjectReference](#objectreference-v1)* | The target object that you want to bind to the standard object.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Write Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Create
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
create a Binding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/v1/namespaces/{namespace}/bindings`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Binding](#binding-v1)* |
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Binding](#binding-v1)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
## Binding v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | Binding
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
Binding ties one object to another. For example, a pod is bound to a node by a scheduler.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
target <br /> *[ObjectReference](#objectreference-v1)* | The target object that you want to bind to the standard object.
|
||||
|
||||
@@ -1,32 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# Capabilities v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | Capabilities
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Adds and removes POSIX capabilities from running containers.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#securitycontext-v1">SecurityContext</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
add <br /> *string array* | Added capabilities
|
||||
drop <br /> *string array* | Removed capabilities
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
## Capabilities v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | Capabilities
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
Adds and removes POSIX capabilities from running containers.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#securitycontext-v1">SecurityContext</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
add <br /> *string array* | Added capabilities
|
||||
drop <br /> *string array* | Removed capabilities
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
# <strong>CLUSTER MANAGEMENT</strong>
|
||||
-1
@@ -1 +0,0 @@
|
||||
# <strong>DECLARATIVE APP MANAGEMENT</strong>
|
||||
@@ -1 +0,0 @@
|
||||
# <strong>DEPRECATED COMMANDS</strong>
|
||||
-1
@@ -1 +0,0 @@
|
||||
# <strong>KUBECTL SETTINGS AND USAGE</strong>
|
||||
@@ -1,68 +0,0 @@
|
||||
------------
|
||||
|
||||
# certificate
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Usage
|
||||
|
||||
`$ certificate SUBCOMMAND`
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>approve</em>
|
||||
|
||||
|
||||
|
||||
Approve a certificate signing request.
|
||||
|
||||
kubectl certificate approve allows a cluster admin to approve a certificate signing request (CSR). This action tells a certificate signing controller to issue a certificate to the requestor with the attributes requested in the CSR.
|
||||
|
||||
SECURITY NOTICE: Depending on the requested attributes, the issued certificate can potentially grant a requester access to cluster resources or to authenticate as a requested identity. Before approving a CSR, ensure you understand what the signed certificate can do.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ approve (-f FILENAME | NAME)`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
filename | f | [] | Filename, directory, or URL to files identifying the resource to update
|
||||
output | o | | Output mode. Use "-o name" for shorter output (resource/name).
|
||||
recursive | R | false | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>deny</em>
|
||||
|
||||
|
||||
|
||||
Deny a certificate signing request.
|
||||
|
||||
kubectl certificate deny allows a cluster admin to deny a certificate signing request (CSR). This action tells a certificate signing controller to not to issue a certificate to the requestor.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ deny (-f FILENAME | NAME)`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
filename | f | [] | Filename, directory, or URL to files identifying the resource to update
|
||||
output | o | | Output mode. Use "-o name" for shorter output (resource/name).
|
||||
recursive | R | false | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
|
||||
|
||||
|
||||
|
||||
-630
@@ -1,630 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# CertificateSigningRequest v1alpha1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Certificates | v1alpha1 | CertificateSigningRequest
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Describes a certificate signing request
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#certificatesigningrequestlist-v1alpha1">CertificateSigningRequestList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* |
|
||||
spec <br /> *[CertificateSigningRequestSpec](#certificatesigningrequestspec-v1alpha1)* | The certificate request itself and any additional information.
|
||||
status <br /> *[CertificateSigningRequestStatus](#certificatesigningrequeststatus-v1alpha1)* | Derived information about the request.
|
||||
|
||||
|
||||
### CertificateSigningRequestSpec v1alpha1
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#certificatesigningrequest-v1alpha1">CertificateSigningRequest</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
groups <br /> *string array* |
|
||||
request <br /> *string* | Base64-encoded PKCS#10 CSR data
|
||||
uid <br /> *string* |
|
||||
username <br /> *string* | Information about the requesting user (if relevant) See user.Info interface for details
|
||||
|
||||
### CertificateSigningRequestStatus v1alpha1
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#certificatesigningrequest-v1alpha1">CertificateSigningRequest</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
certificate <br /> *string* | If request was approved, the controller will place the issued certificate here.
|
||||
conditions <br /> *[CertificateSigningRequestCondition](#certificatesigningrequestcondition-v1alpha1) array* | Conditions applied to the request, such as approval or denial.
|
||||
|
||||
### CertificateSigningRequestList v1alpha1
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1) array* |
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* |
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Write Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Create
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
create a CertificateSigningRequest
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`POST /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Replace
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
replace the specified CertificateSigningRequest
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PUT /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CertificateSigningRequest
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Patch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
partially update the specified CertificateSigningRequest
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CertificateSigningRequest
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Delete
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
delete a CertificateSigningRequest
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CertificateSigningRequest
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
|
||||
orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Status](#status-unversioned)* | OK
|
||||
|
||||
|
||||
## Delete Collection
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
delete collection of CertificateSigningRequest
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Status](#status-unversioned)* | OK
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Read
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
read the specified CertificateSigningRequest
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CertificateSigningRequest
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
|
||||
export | Should this value be exported. Export strips fields that a user can not specify.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK
|
||||
|
||||
|
||||
## List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind CertificateSigningRequest
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CertificateSigningRequestList](#certificatesigningrequestlist-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Watch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch changes to an object of kind CertificateSigningRequest
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/certificates.k8s.io/v1alpha1/watch/certificatesigningrequests/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the CertificateSigningRequest
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
## Watch List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of CertificateSigningRequest
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/certificates.k8s.io/v1alpha1/watch/certificatesigningrequests`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
-21
@@ -1,21 +0,0 @@
|
||||
## CertificateSigningRequest v1alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Certificates | v1alpha1 | CertificateSigningRequest
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
Describes a certificate signing request
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#certificatesigningrequestlist-v1alpha1">CertificateSigningRequestList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* |
|
||||
spec <br /> *[CertificateSigningRequestSpec](#certificatesigningrequestspec-v1alpha1)* | The certificate request itself and any additional information.
|
||||
status <br /> *[CertificateSigningRequestStatus](#certificatesigningrequeststatus-v1alpha1)* | Derived information about the request.
|
||||
|
||||
-34
@@ -1,34 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# CertificateSigningRequestCondition v1alpha1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1alpha1 | CertificateSigningRequestCondition
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#certificatesigningrequeststatus-v1alpha1">CertificateSigningRequestStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
lastUpdateTime <br /> *[Time](#time-unversioned)* | timestamp for the last update to this condition
|
||||
message <br /> *string* | human readable message with details about the request state
|
||||
reason <br /> *string* | brief reason for the request state
|
||||
type <br /> *string* | request approval state, currently Approved or Denied.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-22
@@ -1,22 +0,0 @@
|
||||
## CertificateSigningRequestCondition v1alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1alpha1 | CertificateSigningRequestCondition
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#certificatesigningrequeststatus-v1alpha1">CertificateSigningRequestStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
lastUpdateTime <br /> *[Time](#time-unversioned)* | timestamp for the last update to this condition
|
||||
message <br /> *string* | human readable message with details about the request state
|
||||
reason <br /> *string* | brief reason for the request state
|
||||
type <br /> *string* | request approval state, currently Approved or Denied.
|
||||
|
||||
-31
@@ -1,31 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# CertificateSigningRequestList v1alpha1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1alpha1 | CertificateSigningRequestList
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1) array* |
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-19
@@ -1,19 +0,0 @@
|
||||
## CertificateSigningRequestList v1alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1alpha1 | CertificateSigningRequestList
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1) array* |
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* |
|
||||
|
||||
-34
@@ -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.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#certificatesigningrequest-v1alpha1">CertificateSigningRequest</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
groups <br /> *string array* |
|
||||
request <br /> *string* | Base64-encoded PKCS#10 CSR data
|
||||
uid <br /> *string* |
|
||||
username <br /> *string* | Information about the requesting user (if relevant) See user.Info interface for details
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-22
@@ -1,22 +0,0 @@
|
||||
## CertificateSigningRequestSpec v1alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1alpha1 | CertificateSigningRequestSpec
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
This information is immutable after the request is created. Only the Request and ExtraInfo fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#certificatesigningrequest-v1alpha1">CertificateSigningRequest</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
groups <br /> *string array* |
|
||||
request <br /> *string* | Base64-encoded PKCS#10 CSR data
|
||||
uid <br /> *string* |
|
||||
username <br /> *string* | Information about the requesting user (if relevant) See user.Info interface for details
|
||||
|
||||
-94
@@ -1,94 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# CertificateSigningRequestStatus v1alpha1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Certificates | v1alpha1 | CertificateSigningRequestStatus
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#certificatesigningrequest-v1alpha1">CertificateSigningRequest</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
certificate <br /> *string* | If request was approved, the controller will place the issued certificate here.
|
||||
conditions <br /> *[CertificateSigningRequestCondition](#certificatesigningrequestcondition-v1alpha1) array* | Conditions applied to the request, such as approval or denial.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Write Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Replace
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
replace status of the specified CertificateSigningRequest
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PUT /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* |
|
||||
name | name of the CertificateSigningRequest
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
-20
@@ -1,20 +0,0 @@
|
||||
## CertificateSigningRequestStatus v1alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Certificates | v1alpha1 | CertificateSigningRequestStatus
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#certificatesigningrequest-v1alpha1">CertificateSigningRequest</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
certificate <br /> *string* | If request was approved, the controller will place the issued certificate here.
|
||||
conditions <br /> *[CertificateSigningRequestCondition](#certificatesigningrequestcondition-v1alpha1) array* | Conditions applied to the request, such as approval or denial.
|
||||
|
||||
@@ -1,70 +0,0 @@
|
||||
------------
|
||||
|
||||
# cluster-info
|
||||
|
||||
|
||||
|
||||
Display addresses of the master and services with label kubernetes.io/cluster-service=true To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ cluster-info`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
include-extended-apis | | true | If true, include definitions of new APIs via calls to the API server. [default true]
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>dump</em>
|
||||
|
||||
>bdocs-tab:example Dump current cluster state to stdout
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl cluster-info dump
|
||||
```
|
||||
|
||||
>bdocs-tab:example Dump current cluster state to /path/to/cluster-state
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl cluster-info dump --output-directory=/path/to/cluster-state
|
||||
```
|
||||
|
||||
>bdocs-tab:example Dump all namespaces to stdout
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl cluster-info dump --all-namespaces
|
||||
```
|
||||
|
||||
>bdocs-tab:example Dump a set of namespaces to /path/to/cluster-state
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state
|
||||
```
|
||||
|
||||
|
||||
Dumps cluster info out suitable for debugging and diagnosing cluster problems. By default, dumps everything to stdout. You can optionally specify a directory with --output-directory. If you specify a directory, kubernetes will build a set of files in that directory. By default only dumps things in the 'kube-system' namespace, but you can switch to a different namespace with the --namespaces flag, or specify --all-namespaces to dump all namespaces.
|
||||
|
||||
The command also dumps the logs of all of the pods in the cluster, these logs are dumped into different directories based on namespace and pod name.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ dump`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
all-namespaces | | false | If true, dump all namespaces. If true, --namespaces is ignored.
|
||||
namespaces | | [] | A comma separated list of namespaces to dump.
|
||||
output-directory | | | Where to output the files. If empty or '-' uses stdout, otherwise creates a directory hierarchy in that directory
|
||||
|
||||
|
||||
|
||||
@@ -1,601 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# ClusterRole v1alpha1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
RbacAuthorization | v1alpha1 | ClusterRole
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#clusterrolelist-v1alpha1">ClusterRoleList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata.
|
||||
rules <br /> *[PolicyRule](#policyrule-v1alpha1) array* | Rules holds all the PolicyRules for this ClusterRole
|
||||
|
||||
|
||||
### ClusterRoleList v1alpha1
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ClusterRole](#clusterrole-v1alpha1) array* | Items is a list of ClusterRoles
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard object's metadata.
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Write Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Create
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
create a ClusterRole
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[ClusterRole](#clusterrole-v1alpha1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ClusterRole](#clusterrole-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Replace
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
replace the specified ClusterRole
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRole
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[ClusterRole](#clusterrole-v1alpha1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ClusterRole](#clusterrole-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Patch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
partially update the specified ClusterRole
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRole
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ClusterRole](#clusterrole-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Delete
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
delete a ClusterRole
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRole
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
|
||||
orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Status](#status-unversioned)* | OK
|
||||
|
||||
|
||||
## Delete Collection
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
delete collection of ClusterRole
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Status](#status-unversioned)* | OK
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Read
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
read the specified ClusterRole
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRole
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ClusterRole](#clusterrole-v1alpha1)* | OK
|
||||
|
||||
|
||||
## List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind ClusterRole
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ClusterRoleList](#clusterrolelist-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Watch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch changes to an object of kind ClusterRole
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the ClusterRole
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
## Watch List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of ClusterRole
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
## ClusterRole v1alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
RbacAuthorization | v1alpha1 | ClusterRole
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#clusterrolelist-v1alpha1">ClusterRoleList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata.
|
||||
rules <br /> *[PolicyRule](#policyrule-v1alpha1) array* | Rules holds all the PolicyRules for this ClusterRole
|
||||
|
||||
-542
@@ -1,542 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# ClusterRoleBinding v1alpha1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
RbacAuthorization | v1alpha1 | ClusterRoleBinding
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#clusterrolebindinglist-v1alpha1">ClusterRoleBindingList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata.
|
||||
roleRef <br /> *[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 <br /> *[Subject](#subject-v1alpha1) array* | Subjects holds references to the objects the role applies to.
|
||||
|
||||
|
||||
### ClusterRoleBindingList v1alpha1
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1) array* | Items is a list of ClusterRoleBindings
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard object's metadata.
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Write Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Create
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
create a ClusterRoleBinding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Replace
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
replace the specified ClusterRoleBinding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRoleBinding
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Patch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
partially update the specified ClusterRoleBinding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRoleBinding
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Delete
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
delete a ClusterRoleBinding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRoleBinding
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
|
||||
orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Status](#status-unversioned)* | OK
|
||||
|
||||
|
||||
## Delete Collection
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
delete collection of ClusterRoleBinding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Status](#status-unversioned)* | OK
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Read
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
read the specified ClusterRoleBinding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRoleBinding
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* | OK
|
||||
|
||||
|
||||
## List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind ClusterRoleBinding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ClusterRoleBindingList](#clusterrolebindinglist-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Watch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch changes to an object of kind ClusterRoleBinding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the ClusterRoleBinding
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
-21
@@ -1,21 +0,0 @@
|
||||
## ClusterRoleBinding v1alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
RbacAuthorization | v1alpha1 | ClusterRoleBinding
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#clusterrolebindinglist-v1alpha1">ClusterRoleBindingList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata.
|
||||
roleRef <br /> *[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 <br /> *[Subject](#subject-v1alpha1) array* | Subjects holds references to the objects the role applies to.
|
||||
|
||||
-96
@@ -1,96 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# ClusterRoleBindingList v1alpha1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
RbacAuthorization | v1alpha1 | ClusterRoleBindingList
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ClusterRoleBindingList is a collection of ClusterRoleBindings
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1) array* | Items is a list of ClusterRoleBindings
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard object's metadata.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Watch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of ClusterRoleBinding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
-19
@@ -1,19 +0,0 @@
|
||||
## ClusterRoleBindingList v1alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
RbacAuthorization | v1alpha1 | ClusterRoleBindingList
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
ClusterRoleBindingList is a collection of ClusterRoleBindings
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1) array* | Items is a list of ClusterRoleBindings
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard object's metadata.
|
||||
|
||||
@@ -1,31 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# ClusterRoleList v1alpha1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1alpha1 | ClusterRoleList
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ClusterRoleList is a collection of ClusterRoles
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ClusterRole](#clusterrole-v1alpha1) array* | Items is a list of ClusterRoles
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard object's metadata.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-19
@@ -1,19 +0,0 @@
|
||||
## ClusterRoleList v1alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1alpha1 | ClusterRoleList
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
ClusterRoleList is a collection of ClusterRoles
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ClusterRole](#clusterrole-v1alpha1) array* | Items is a list of ClusterRoles
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard object's metadata.
|
||||
|
||||
@@ -1,30 +0,0 @@
|
||||
------------
|
||||
|
||||
# completion
|
||||
|
||||
|
||||
|
||||
Output shell completion code for the given shell (bash or zsh).
|
||||
|
||||
This command prints shell code which must be evaluation to provide interactive completion of kubectl commands.
|
||||
|
||||
$ source <(kubectl completion bash)
|
||||
|
||||
will load the kubectl completion code for bash. Note that this depends on the bash-completion framework. It must be sourced before sourcing the kubectl completion, e.g. on the Mac:
|
||||
|
||||
$ brew install bash-completion
|
||||
$ source $(brew --prefix)/etc/bash_completion
|
||||
$ source <(kubectl completion bash)
|
||||
|
||||
If you use zsh [1], the following will load kubectl zsh completion:
|
||||
|
||||
$ source <(kubectl completion zsh)
|
||||
|
||||
[1] zsh completions are only supported in versions of zsh >= 5.2
|
||||
|
||||
### Usage
|
||||
|
||||
`$ completion SHELL`
|
||||
|
||||
|
||||
|
||||
@@ -1,34 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# ComponentCondition v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ComponentCondition
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Information about the condition of a component.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#componentstatus-v1">ComponentStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
error <br /> *string* | Condition error code for a component. For example, a health check error code.
|
||||
message <br /> *string* | Message about the condition for a component. For example, information about a health check.
|
||||
status <br /> *string* | Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".
|
||||
type <br /> *string* | Type of condition for a component. Valid value: "Healthy"
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,22 +0,0 @@
|
||||
## ComponentCondition v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ComponentCondition
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
Information about the condition of a component.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#componentstatus-v1">ComponentStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
error <br /> *string* | Condition error code for a component. For example, a health check error code.
|
||||
message <br /> *string* | Message about the condition for a component. For example, information about a health check.
|
||||
status <br /> *string* | Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".
|
||||
type <br /> *string* | Type of condition for a component. Valid value: "Healthy"
|
||||
|
||||
@@ -1,162 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# ComponentStatus v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ComponentStatus
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ComponentStatus (and ComponentStatusList) holds the cluster validation info.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#componentstatuslist-v1">ComponentStatusList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
conditions <br /> *[ComponentCondition](#componentcondition-v1) array* | List of component conditions observed
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
||||
### ComponentStatusList v1
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ComponentStatus](#componentstatus-v1) array* | List of ComponentStatus objects.
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Read
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
read the specified ComponentStatus
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/v1/componentstatuses/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ComponentStatus
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ComponentStatus](#componentstatus-v1)* | OK
|
||||
|
||||
|
||||
## List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
list objects of kind ComponentStatus
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/v1/componentstatuses`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ComponentStatusList](#componentstatuslist-v1)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
## ComponentStatus v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ComponentStatus
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
ComponentStatus (and ComponentStatusList) holds the cluster validation info.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#componentstatuslist-v1">ComponentStatusList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
conditions <br /> *[ComponentCondition](#componentcondition-v1) array* | List of component conditions observed
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
@@ -1,31 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# ComponentStatusList v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ComponentStatusList
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Status of all the conditions for the component as a list of ComponentStatus objects.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ComponentStatus](#componentstatus-v1) array* | List of ComponentStatus objects.
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-19
@@ -1,19 +0,0 @@
|
||||
## ComponentStatusList v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ComponentStatusList
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
Status of all the conditions for the component as a list of ComponentStatus objects.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ComponentStatus](#componentstatus-v1) array* | List of ComponentStatus objects.
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
|
||||
@@ -1,382 +0,0 @@
|
||||
------------
|
||||
|
||||
# config
|
||||
|
||||
|
||||
|
||||
Modify kubeconfig files using subcommands like "kubectl config set current-context my-context"
|
||||
|
||||
The loading order follows these rules:
|
||||
|
||||
1. If the --kubeconfig flag is set, then only that file is loaded. The flag may only be set once and no merging takes place.
|
||||
2. If $KUBECONFIG environment variable is set, then it is used a list of paths (normal path delimitting rules for your system). These paths are merged. When a value is modified, it is modified in the file that defines the stanza. When a value is created, it is created in the first file that exists. If no files in the chain exist, then it creates the last file in the list.
|
||||
3. Otherwise, ${HOME}/.kube/config is used and no merging takes place.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ config SUBCOMMAND`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
kubeconfig | | | use a particular kubeconfig file
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>current-context</em>
|
||||
|
||||
>bdocs-tab:example Display the current-context
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl config current-context
|
||||
```
|
||||
|
||||
|
||||
Displays the current-context
|
||||
|
||||
### Usage
|
||||
|
||||
`$ current-context`
|
||||
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>delete-cluster</em>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Usage
|
||||
|
||||
`$ delete-cluster NAME`
|
||||
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>delete-context</em>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Usage
|
||||
|
||||
`$ delete-context NAME`
|
||||
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>get-clusters</em>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Usage
|
||||
|
||||
`$ get-clusters`
|
||||
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>get-contexts</em>
|
||||
|
||||
>bdocs-tab:example List all the contexts in your kubeconfig file
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl config get-contexts
|
||||
```
|
||||
|
||||
>bdocs-tab:example Describe one context in your kubeconfig file.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl config get-contexts my-context
|
||||
```
|
||||
|
||||
|
||||
Displays one or many contexts from the kubeconfig file.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ get-contexts [(-o|--output=)name)]`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
no-headers | | false | When using the default or custom-column output format, don't print headers.
|
||||
output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>set</em>
|
||||
|
||||
|
||||
|
||||
Sets an individual value in a kubeconfig file
|
||||
|
||||
PROPERTY _NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots.
|
||||
|
||||
PROPERTY _VALUE is the new value you wish to set. Binary fields such as 'certificate-authority-data' expect a base64 encoded string unless the --set-raw-bytes flag is used.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ set PROPERTY_NAME PROPERTY_VALUE`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
set-raw-bytes | | false | When writing a []byte PROPERTY_VALUE, write the given string directly without base64 decoding.
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>set-cluster</em>
|
||||
|
||||
>bdocs-tab:example Set only the server field on the e2e cluster entry without touching other values.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl config set-cluster e2e --server=https://1.2.3.4
|
||||
```
|
||||
|
||||
>bdocs-tab:example Embed certificate authority data for the e2e cluster entry
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl config set-cluster e2e --certificate-authority=~/.kube/e2e/kubernetes.ca.crt
|
||||
```
|
||||
|
||||
>bdocs-tab:example Disable cert checking for the dev cluster entry
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl config set-cluster e2e --insecure-skip-tls-verify=true
|
||||
```
|
||||
|
||||
|
||||
Sets a cluster entry in kubeconfig.
|
||||
|
||||
Specifying a name that already exists will merge new fields on top of existing values for those fields.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ set-cluster NAME [--server=server] [--certificate-authority=path/to/certificate/authority] [--insecure-skip-tls-verify=true]`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
api-version | | | api-version for the cluster entry in kubeconfig
|
||||
certificate-authority | | | path to certificate-authority file for the cluster entry in kubeconfig
|
||||
embed-certs | | false | embed-certs for the cluster entry in kubeconfig
|
||||
insecure-skip-tls-verify | | false | insecure-skip-tls-verify for the cluster entry in kubeconfig
|
||||
server | | | server for the cluster entry in kubeconfig
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>set-context</em>
|
||||
|
||||
>bdocs-tab:example Set the user field on the gce context entry without touching other values
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl config set-context gce --user=cluster-admin
|
||||
```
|
||||
|
||||
|
||||
Sets a context entry in kubeconfig
|
||||
|
||||
Specifying a name that already exists will merge new fields on top of existing values for those fields.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ set-context NAME [--cluster=cluster_nickname] [--user=user_nickname] [--namespace=namespace]`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
cluster | | | cluster for the context entry in kubeconfig
|
||||
namespace | | | namespace for the context entry in kubeconfig
|
||||
user | | | user for the context entry in kubeconfig
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>set-credentials</em>
|
||||
|
||||
>bdocs-tab:example Set only the "client-key" field on the "cluster-admin" # entry, without touching other values:
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl config set-credentials cluster-admin --client-key=~/.kube/admin.key
|
||||
```
|
||||
|
||||
>bdocs-tab:example Set basic auth for the "cluster-admin" entry
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl config set-credentials cluster-admin --username=admin --password=uXFGweU9l35qcif
|
||||
```
|
||||
|
||||
>bdocs-tab:example Embed client certificate data in the "cluster-admin" entry
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl config set-credentials cluster-admin --client-certificate=~/.kube/admin.crt --embed-certs=true
|
||||
```
|
||||
|
||||
>bdocs-tab:example Enable the Google Compute Platform auth provider for the "cluster-admin" entry
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl config set-credentials cluster-admin --auth-provider=gcp
|
||||
```
|
||||
|
||||
>bdocs-tab:example Enable the OpenID Connect auth provider for the "cluster-admin" entry with additional args
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-id=foo --auth-provider-arg=client-secret=bar
|
||||
```
|
||||
|
||||
>bdocs-tab:example Remove the "client-secret" config value for the OpenID Connect auth provider for the "cluster-admin" entry
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-secret-
|
||||
```
|
||||
|
||||
|
||||
Sets a user entry in kubeconfig
|
||||
|
||||
Specifying a name that already exists will merge new fields on top of existing values.
|
||||
|
||||
Client-certificate flags:
|
||||
--client-certificate=certfile --client-key=keyfile
|
||||
|
||||
Bearer token flags:
|
||||
--token=bearer_token
|
||||
|
||||
Basic auth flags:
|
||||
--username=basic_user --password=basic_password
|
||||
|
||||
Bearer token and basic auth are mutually exclusive.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ set-credentials NAME [--client-certificate=path/to/certfile] [--client-key=path/to/keyfile] [--token=bearer_token] [--username=basic_user] [--password=basic_password] [--auth-provider=provider_name] [--auth-provider-arg=key=value]`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
auth-provider | | | auth provider for the user entry in kubeconfig
|
||||
auth-provider-arg | | [] | 'key=value' arugments for the auth provider
|
||||
client-certificate | | | path to client-certificate file for the user entry in kubeconfig
|
||||
client-key | | | path to client-key file for the user entry in kubeconfig
|
||||
embed-certs | | false | embed client cert/key for the user entry in kubeconfig
|
||||
password | | | password for the user entry in kubeconfig
|
||||
token | | | token for the user entry in kubeconfig
|
||||
username | | | username for the user entry in kubeconfig
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>unset</em>
|
||||
|
||||
|
||||
|
||||
Unsets an individual value in a kubeconfig file
|
||||
|
||||
PROPERTY _NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ unset PROPERTY_NAME`
|
||||
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>use-context</em>
|
||||
|
||||
|
||||
|
||||
Sets the current-context in a kubeconfig file
|
||||
|
||||
### Usage
|
||||
|
||||
`$ use-context CONTEXT_NAME`
|
||||
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>view</em>
|
||||
|
||||
>bdocs-tab:example Show Merged kubeconfig settings.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl config view
|
||||
```
|
||||
|
||||
>bdocs-tab:example Get the password for the e2e user
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}'
|
||||
```
|
||||
|
||||
|
||||
Display merged kubeconfig settings or a specified kubeconfig file.
|
||||
|
||||
You can use --output jsonpath={...} to extract specific values using a jsonpath expression.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ view`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
flatten | | false | flatten the resulting kubeconfig file into self-contained output (useful for creating portable kubeconfig files)
|
||||
merge | | true | merge the full hierarchy of kubeconfig files
|
||||
minify | | false | remove all information not used by current-context from the output
|
||||
no-headers | | false | When using the default or custom-column output format, don't print headers.
|
||||
output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
|
||||
output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
|
||||
raw | | false | display raw byte data
|
||||
show-all | a | false | When printing, show all resources (default hide terminated pods.)
|
||||
show-labels | | false | When printing, show all labels as the last column (default hide labels column)
|
||||
sort-by | | | If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
|
||||
template | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
|
||||
|
||||
|
||||
|
||||
@@ -1,675 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# ConfigMap v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ConfigMap
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ConfigMap holds configuration data for pods to consume.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#configmaplist-v1">ConfigMapList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
data <br /> *object* | Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot.
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
||||
### ConfigMapList v1
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ConfigMap](#configmap-v1) array* | Items is the list of ConfigMaps.
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Write Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Create
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
create a ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/v1/namespaces/{namespace}/configmaps`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[ConfigMap](#configmap-v1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ConfigMap](#configmap-v1)* | OK
|
||||
|
||||
|
||||
## Replace
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
replace the specified ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PUT /api/v1/namespaces/{namespace}/configmaps/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ConfigMap
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[ConfigMap](#configmap-v1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ConfigMap](#configmap-v1)* | OK
|
||||
|
||||
|
||||
## Patch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
partially update the specified ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /api/v1/namespaces/{namespace}/configmaps/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ConfigMap
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ConfigMap](#configmap-v1)* | OK
|
||||
|
||||
|
||||
## Delete
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
delete a ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /api/v1/namespaces/{namespace}/configmaps/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ConfigMap
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
|
||||
orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Status](#status-unversioned)* | OK
|
||||
|
||||
|
||||
## Delete Collection
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
delete collection of ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /api/v1/namespaces/{namespace}/configmaps`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Status](#status-unversioned)* | OK
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Read
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
read the specified ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/v1/namespaces/{namespace}/configmaps/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ConfigMap
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
|
||||
export | Should this value be exported. Export strips fields that a user can not specify.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ConfigMap](#configmap-v1)* | OK
|
||||
|
||||
|
||||
## List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/v1/namespaces/{namespace}/configmaps`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ConfigMapList](#configmaplist-v1)* | OK
|
||||
|
||||
|
||||
## List All Namespaces
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/v1/configmaps`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ConfigMapList](#configmaplist-v1)* | OK
|
||||
|
||||
|
||||
## Watch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch changes to an object of kind ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the ConfigMap
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
## Watch List All Namespaces
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/v1/watch/configmaps`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
## ConfigMap v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ConfigMap
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
ConfigMap holds configuration data for pods to consume.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#configmaplist-v1">ConfigMapList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
data <br /> *object* | Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot.
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
@@ -1,31 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# ConfigMapKeySelector v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ConfigMapKeySelector
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Selects a key from a ConfigMap.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#envvarsource-v1">EnvVarSource</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
key <br /> *string* | The key to select.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-19
@@ -1,19 +0,0 @@
|
||||
## ConfigMapKeySelector v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ConfigMapKeySelector
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
Selects a key from a ConfigMap.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#envvarsource-v1">EnvVarSource</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
key <br /> *string* | The key to select.
|
||||
|
||||
@@ -1,97 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# ConfigMapList v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ConfigMapList
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ConfigMapList is a resource containing a list of ConfigMap objects.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ConfigMap](#configmap-v1) array* | Items is the list of ConfigMaps.
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Watch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/v1/watch/namespaces/{namespace}/configmaps`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
## ConfigMapList v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ConfigMapList
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
ConfigMapList is a resource containing a list of ConfigMap objects.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ConfigMap](#configmap-v1) array* | Items is the list of ConfigMaps.
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
@@ -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
|
||||
|
||||
<aside class="warning">Containers are only ever created within the context of a <a href="#pod-v1">Pod</a>. This is usually done using a Controller. See Controllers: <a href="#deployment-v1beta1">Deployment</a>, <a href="#job-v1">Job</a>, or <a href="#statefulset-v1beta1">StatefulSet</a></aside>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
A single application container that you want to run within a pod.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#podspec-v1">PodSpec</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
args <br /> *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 <br /> *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 <br /> *[EnvVar](#envvar-v1) array* | List of environment variables to set in the container. Cannot be updated.
|
||||
image <br /> *string* | Docker image name. More info: http://kubernetes.io/docs/user-guide/images
|
||||
imagePullPolicy <br /> *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 <br /> *[Lifecycle](#lifecycle-v1)* | Actions that the management system should take in response to container lifecycle events. Cannot be updated.
|
||||
livenessProbe <br /> *[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 <br /> *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 <br /> *[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 <br /> *[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 <br /> *[ResourceRequirements](#resourcerequirements-v1)* | Compute Resources required by this container. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources
|
||||
securityContext <br /> *[SecurityContext](#securitycontext-v1)* | Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md
|
||||
stdin <br /> *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 <br /> *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 <br /> *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 <br /> *boolean* | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
|
||||
volumeMounts <br /> *[VolumeMount](#volumemount-v1) array* | Pod volumes to mount into the container's filesystem. Cannot be updated.
|
||||
workingDir <br /> *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
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#podstatus-v1">PodStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
containerID <br /> *string* | Container's ID in the format 'docker://<container_id>'. More info: http://kubernetes.io/docs/user-guide/container-environment#container-information
|
||||
image <br /> *string* | The image the container is running. More info: http://kubernetes.io/docs/user-guide/images
|
||||
imageID <br /> *string* | ImageID of the container's image.
|
||||
lastState <br /> *[ContainerState](#containerstate-v1)* | Details about the container's last termination condition.
|
||||
name <br /> *string* | This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
|
||||
ready <br /> *boolean* | Specifies whether the container has passed its readiness probe.
|
||||
restartCount <br /> *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 <br /> *[ContainerState](#containerstate-v1)* | Details about the container's current condition.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,36 +0,0 @@
|
||||
## Container v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | Container
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
A single application container that you want to run within a pod.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#podspec-v1">PodSpec</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
args <br /> *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 <br /> *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 <br /> *[EnvVar](#envvar-v1) array* | List of environment variables to set in the container. Cannot be updated.
|
||||
image <br /> *string* | Docker image name. More info: http://kubernetes.io/docs/user-guide/images
|
||||
imagePullPolicy <br /> *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 <br /> *[Lifecycle](#lifecycle-v1)* | Actions that the management system should take in response to container lifecycle events. Cannot be updated.
|
||||
livenessProbe <br /> *[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 <br /> *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 <br /> *[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 <br /> *[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 <br /> *[ResourceRequirements](#resourcerequirements-v1)* | Compute Resources required by this container. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources
|
||||
securityContext <br /> *[SecurityContext](#securitycontext-v1)* | Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md
|
||||
stdin <br /> *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 <br /> *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 <br /> *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 <br /> *boolean* | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
|
||||
volumeMounts <br /> *[VolumeMount](#volumemount-v1) array* | Pod volumes to mount into the container's filesystem. Cannot be updated.
|
||||
workingDir <br /> *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.
|
||||
|
||||
@@ -1,32 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# ContainerImage v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerImage
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Describe a container image
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#nodestatus-v1">NodeStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
names <br /> *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 <br /> *integer* | The size of the image in bytes.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
## ContainerImage v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerImage
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
Describe a container image
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#nodestatus-v1">NodeStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
names <br /> *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 <br /> *integer* | The size of the image in bytes.
|
||||
|
||||
@@ -1,35 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# ContainerPort v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerPort
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ContainerPort represents a network port in a single container.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#container-v1">Container</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
containerPort <br /> *integer* | Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
|
||||
hostIP <br /> *string* | What host IP to bind the external port to.
|
||||
hostPort <br /> *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 <br /> *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 <br /> *string* | Protocol for port. Must be UDP or TCP. Defaults to "TCP".
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,23 +0,0 @@
|
||||
## ContainerPort v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerPort
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
ContainerPort represents a network port in a single container.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#container-v1">Container</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
containerPort <br /> *integer* | Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
|
||||
hostIP <br /> *string* | What host IP to bind the external port to.
|
||||
hostPort <br /> *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 <br /> *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 <br /> *string* | Protocol for port. Must be UDP or TCP. Defaults to "TCP".
|
||||
|
||||
@@ -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.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#containerstatus-v1">ContainerStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
running <br /> *[ContainerStateRunning](#containerstaterunning-v1)* | Details about a running container
|
||||
terminated <br /> *[ContainerStateTerminated](#containerstateterminated-v1)* | Details about a terminated container
|
||||
waiting <br /> *[ContainerStateWaiting](#containerstatewaiting-v1)* | Details about a waiting container
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,21 +0,0 @@
|
||||
## ContainerState v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerState
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#containerstatus-v1">ContainerStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
running <br /> *[ContainerStateRunning](#containerstaterunning-v1)* | Details about a running container
|
||||
terminated <br /> *[ContainerStateTerminated](#containerstateterminated-v1)* | Details about a terminated container
|
||||
waiting <br /> *[ContainerStateWaiting](#containerstatewaiting-v1)* | Details about a waiting container
|
||||
|
||||
@@ -1,31 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# ContainerStateRunning v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerStateRunning
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ContainerStateRunning is a running state of a container.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#containerstate-v1">ContainerState</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
startedAt <br /> *[Time](#time-unversioned)* | Time at which the container was last (re-)started
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-19
@@ -1,19 +0,0 @@
|
||||
## ContainerStateRunning v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerStateRunning
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
ContainerStateRunning is a running state of a container.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#containerstate-v1">ContainerState</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
startedAt <br /> *[Time](#time-unversioned)* | Time at which the container was last (re-)started
|
||||
|
||||
-37
@@ -1,37 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# ContainerStateTerminated v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerStateTerminated
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ContainerStateTerminated is a terminated state of a container.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#containerstate-v1">ContainerState</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
containerID <br /> *string* | Container's ID in the format 'docker://<container_id>'
|
||||
exitCode <br /> *integer* | Exit status from the last termination of the container
|
||||
finishedAt <br /> *[Time](#time-unversioned)* | Time at which the container last terminated
|
||||
message <br /> *string* | Message regarding the last termination of the container
|
||||
reason <br /> *string* | (brief) reason from the last termination of the container
|
||||
signal <br /> *integer* | Signal from the last termination of the container
|
||||
startedAt <br /> *[Time](#time-unversioned)* | Time at which previous execution of the container started
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-25
@@ -1,25 +0,0 @@
|
||||
## ContainerStateTerminated v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerStateTerminated
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
ContainerStateTerminated is a terminated state of a container.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#containerstate-v1">ContainerState</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
containerID <br /> *string* | Container's ID in the format 'docker://<container_id>'
|
||||
exitCode <br /> *integer* | Exit status from the last termination of the container
|
||||
finishedAt <br /> *[Time](#time-unversioned)* | Time at which the container last terminated
|
||||
message <br /> *string* | Message regarding the last termination of the container
|
||||
reason <br /> *string* | (brief) reason from the last termination of the container
|
||||
signal <br /> *integer* | Signal from the last termination of the container
|
||||
startedAt <br /> *[Time](#time-unversioned)* | Time at which previous execution of the container started
|
||||
|
||||
@@ -1,32 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# ContainerStateWaiting v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerStateWaiting
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ContainerStateWaiting is a waiting state of a container.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#containerstate-v1">ContainerState</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
message <br /> *string* | Message regarding why the container is not yet running.
|
||||
reason <br /> *string* | (brief) reason the container is not yet running.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-20
@@ -1,20 +0,0 @@
|
||||
## ContainerStateWaiting v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerStateWaiting
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
ContainerStateWaiting is a waiting state of a container.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#containerstate-v1">ContainerState</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
message <br /> *string* | Message regarding why the container is not yet running.
|
||||
reason <br /> *string* | (brief) reason the container is not yet running.
|
||||
|
||||
@@ -1,38 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# ContainerStatus v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerStatus
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ContainerStatus contains details for the current status of this container.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#podstatus-v1">PodStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
containerID <br /> *string* | Container's ID in the format 'docker://<container_id>'. More info: http://kubernetes.io/docs/user-guide/container-environment#container-information
|
||||
image <br /> *string* | The image the container is running. More info: http://kubernetes.io/docs/user-guide/images
|
||||
imageID <br /> *string* | ImageID of the container's image.
|
||||
lastState <br /> *[ContainerState](#containerstate-v1)* | Details about the container's last termination condition.
|
||||
name <br /> *string* | This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
|
||||
ready <br /> *boolean* | Specifies whether the container has passed its readiness probe.
|
||||
restartCount <br /> *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 <br /> *[ContainerState](#containerstate-v1)* | Details about the container's current condition.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
## ContainerStatus v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerStatus
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
ContainerStatus contains details for the current status of this container.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#podstatus-v1">PodStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
containerID <br /> *string* | Container's ID in the format 'docker://<container_id>'. More info: http://kubernetes.io/docs/user-guide/container-environment#container-information
|
||||
image <br /> *string* | The image the container is running. More info: http://kubernetes.io/docs/user-guide/images
|
||||
imageID <br /> *string* | ImageID of the container's image.
|
||||
lastState <br /> *[ContainerState](#containerstate-v1)* | Details about the container's last termination condition.
|
||||
name <br /> *string* | This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
|
||||
ready <br /> *boolean* | Specifies whether the container has passed its readiness probe.
|
||||
restartCount <br /> *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 <br /> *[ContainerState](#containerstate-v1)* | Details about the container's current condition.
|
||||
|
||||
@@ -1,54 +0,0 @@
|
||||
------------
|
||||
|
||||
# convert
|
||||
|
||||
>bdocs-tab:example Convert 'pod.yaml' to latest version and print to stdout.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl convert -f pod.yaml
|
||||
```
|
||||
|
||||
>bdocs-tab:example Convert the live state of the resource specified by 'pod.yaml' to the latest version # and print to stdout in json format.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl convert -f pod.yaml --local -o json
|
||||
```
|
||||
|
||||
>bdocs-tab:example Convert all files under current directory to latest version and create them all.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl convert -f . | kubectl create -f -
|
||||
```
|
||||
|
||||
|
||||
Convert config files between different API versions. Both YAML and JSON formats are accepted.
|
||||
|
||||
The command takes filename, directory, or URL as input, and convert it into format of version specified by --output-version flag. If target version is not specified or not supported, convert to latest version.
|
||||
|
||||
The default output will be printed to stdout in YAML format. One can use -o option to change to output destination.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ convert -f FILENAME`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
filename | f | [] | Filename, directory, or URL to files to need to get converted.
|
||||
include-extended-apis | | true | If true, include definitions of new APIs via calls to the API server. [default true]
|
||||
local | | true | If true, convert will NOT try to contact api-server but run locally.
|
||||
no-headers | | false | When using the default or custom-column output format, don't print headers.
|
||||
output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
|
||||
output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
|
||||
recursive | R | false | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
|
||||
schema-cache-dir | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema'
|
||||
show-all | a | false | When printing, show all resources (default hide terminated pods.)
|
||||
show-labels | | false | When printing, show all labels as the last column (default hide labels column)
|
||||
sort-by | | | If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
|
||||
template | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
|
||||
validate | | true | If true, use a schema to validate the input before sending it
|
||||
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
------------
|
||||
|
||||
# cordon
|
||||
|
||||
>bdocs-tab:example Mark node "foo" as unschedulable.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl cordon foo
|
||||
```
|
||||
|
||||
|
||||
Mark node as unschedulable.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ cordon NODE`
|
||||
|
||||
|
||||
|
||||
@@ -1,44 +0,0 @@
|
||||
------------
|
||||
|
||||
# cp
|
||||
|
||||
>bdocs-tab:example !!!Important Note!!! # Requires that the 'tar' binary is present in your container # image. If 'tar' is not present, 'kubectl cp' will fail. # Copy /tmp/foo_dir local directory to /tmp/bar_dir in a remote pod in the default namespace
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl cp /tmp/foo_dir <some-pod>:/tmp/bar_dir
|
||||
```
|
||||
|
||||
>bdocs-tab:example Copy /tmp/foo local file to /tmp/bar in a remote pod in a specific container
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl cp /tmp/foo <some-pod>:/tmp/bar -c <specific-container>
|
||||
```
|
||||
|
||||
>bdocs-tab:example Copy /tmp/foo local file to /tmp/bar in a remote pod in namespace <some-namespace>
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl cp /tmp/foo <some-namespace>/<some-pod>:/tmp/bar
|
||||
```
|
||||
|
||||
>bdocs-tab:example Copy /tmp/foo from a remote pod to /tmp/bar locally
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl cp <some-namespace>/<some-pod>:/tmp/foo /tmp/bar
|
||||
```
|
||||
|
||||
|
||||
Copy files and directories to and from containers.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ cp <file-spec-src> <file-spec-dest>`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
container | c | | Container name. If omitted, the first container in the pod will be chosen
|
||||
|
||||
|
||||
-31
@@ -1,31 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# CPUTargetUtilization v1beta1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | CPUTargetUtilization
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#horizontalpodautoscalerspec-v1beta1">HorizontalPodAutoscalerSpec</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
targetPercentage <br /> *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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-19
@@ -1,19 +0,0 @@
|
||||
## CPUTargetUtilization v1beta1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | CPUTargetUtilization
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#horizontalpodautoscalerspec-v1beta1">HorizontalPodAutoscalerSpec</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
targetPercentage <br /> *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.
|
||||
|
||||
@@ -1,585 +0,0 @@
|
||||
------------
|
||||
|
||||
# create
|
||||
|
||||
>bdocs-tab:example Create a pod using the data in pod.json.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl create -f ./pod.json
|
||||
```
|
||||
|
||||
>bdocs-tab:example Create a pod based on the JSON passed into stdin.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
cat pod.json | kubectl create -f -
|
||||
```
|
||||
|
||||
>bdocs-tab:example Edit the data in docker-registry.yaml in JSON using the v1 API format then create the resource using the edited data.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl create -f docker-registry.yaml --edit --output-version=v1 -o json
|
||||
```
|
||||
|
||||
|
||||
Create a resource by filename or stdin.
|
||||
|
||||
JSON and YAML formats are accepted.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ create -f FILENAME`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
dry-run | | false | If true, only print the object that would be sent, without sending it.
|
||||
edit | | false | Edit the API resource before creating
|
||||
filename | f | [] | Filename, directory, or URL to files to use to create the resource
|
||||
include-extended-apis | | true | If true, include definitions of new APIs via calls to the API server. [default true]
|
||||
no-headers | | false | When using the default or custom-column output format, don't print headers.
|
||||
output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
|
||||
output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
|
||||
record | | false | Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists.
|
||||
recursive | R | false | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
|
||||
save-config | | false | If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
|
||||
schema-cache-dir | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema'
|
||||
show-all | a | false | When printing, show all resources (default hide terminated pods.)
|
||||
show-labels | | false | When printing, show all labels as the last column (default hide labels column)
|
||||
sort-by | | | If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
|
||||
template | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
|
||||
validate | | true | If true, use a schema to validate the input before sending it
|
||||
windows-line-endings | | false | Only relevant if --edit=true. Use Windows line-endings (default Unix line-endings)
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>configmap</em>
|
||||
|
||||
>bdocs-tab:example Create a new configmap named my-config with keys for each file in folder bar
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl create configmap my-config --from-file=path/to/bar
|
||||
```
|
||||
|
||||
>bdocs-tab:example Create a new configmap named my-config with specified keys instead of names on disk
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl create configmap my-config --from-file=key1=/path/to/bar/file1.txt --from-file=key2=/path/to/bar/file2.txt
|
||||
```
|
||||
|
||||
>bdocs-tab:example Create a new configmap named my-config with key1=config1 and key2=config2
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl create configmap my-config --from-literal=key1=config1 --from-literal=key2=config2
|
||||
```
|
||||
|
||||
|
||||
Create a configmap based on a file, directory, or specified literal value.
|
||||
|
||||
A single configmap may package one or more key/value pairs.
|
||||
|
||||
When creating a configmap based on a file, the key will default to the basename of the file, and the value will default to the file content. If the basename is an invalid key, you may specify an alternate key.
|
||||
|
||||
When creating a configmap based on a directory, each file whose basename is a valid key in the directory will be packaged into the configmap. Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).
|
||||
|
||||
### Usage
|
||||
|
||||
`$ configmap NAME [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run]`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
dry-run | | false | If true, only print the object that would be sent, without sending it.
|
||||
from-file | | [] | Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid configmap key.
|
||||
from-literal | | [] | Specify a key and literal value to insert in configmap (i.e. mykey=somevalue)
|
||||
generator | | configmap/v1 | The name of the API generator to use.
|
||||
no-headers | | false | When using the default or custom-column output format, don't print headers.
|
||||
output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
|
||||
output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
|
||||
save-config | | false | If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
|
||||
schema-cache-dir | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema'
|
||||
show-all | a | false | When printing, show all resources (default hide terminated pods.)
|
||||
show-labels | | false | When printing, show all labels as the last column (default hide labels column)
|
||||
sort-by | | | If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
|
||||
template | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
|
||||
validate | | true | If true, use a schema to validate the input before sending it
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>deployment</em>
|
||||
|
||||
>bdocs-tab:example Create a new deployment named my-dep that runs the busybox image.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl create deployment my-dep --image=busybox
|
||||
```
|
||||
|
||||
|
||||
Create a deployment with the specified name.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ deployment NAME --image=image [--dry-run]`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
dry-run | | false | If true, only print the object that would be sent, without sending it.
|
||||
generator | | deployment-basic/v1beta1 | The name of the API generator to use.
|
||||
image | | [] | Image name to run.
|
||||
no-headers | | false | When using the default or custom-column output format, don't print headers.
|
||||
output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
|
||||
output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
|
||||
save-config | | false | If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
|
||||
schema-cache-dir | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema'
|
||||
show-all | a | false | When printing, show all resources (default hide terminated pods.)
|
||||
show-labels | | false | When printing, show all labels as the last column (default hide labels column)
|
||||
sort-by | | | If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
|
||||
template | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
|
||||
validate | | true | If true, use a schema to validate the input before sending it
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>namespace</em>
|
||||
|
||||
>bdocs-tab:example Create a new namespace named my-namespace
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl create namespace my-namespace
|
||||
```
|
||||
|
||||
|
||||
Create a namespace with the specified name.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ namespace NAME [--dry-run]`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
dry-run | | false | If true, only print the object that would be sent, without sending it.
|
||||
generator | | namespace/v1 | The name of the API generator to use.
|
||||
no-headers | | false | When using the default or custom-column output format, don't print headers.
|
||||
output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
|
||||
output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
|
||||
save-config | | false | If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
|
||||
schema-cache-dir | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema'
|
||||
show-all | a | false | When printing, show all resources (default hide terminated pods.)
|
||||
show-labels | | false | When printing, show all labels as the last column (default hide labels column)
|
||||
sort-by | | | If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
|
||||
template | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
|
||||
validate | | true | If true, use a schema to validate the input before sending it
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>quota</em>
|
||||
|
||||
>bdocs-tab:example Create a new resourcequota named my-quota
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
$ kubectl create quota my-quota --hard=cpu=1,memory=1G,pods=2,services=3,replicationcontrollers=2,resourcequotas=1,secrets=5,persistentvolumeclaims=10
|
||||
```
|
||||
|
||||
>bdocs-tab:example Create a new resourcequota named best-effort
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
$ kubectl create quota best-effort --hard=pods=100 --scopes=BestEffort
|
||||
```
|
||||
|
||||
|
||||
Create a resourcequota with the specified name, hard limits and optional scopes
|
||||
|
||||
### Usage
|
||||
|
||||
`$ quota NAME [--hard=key1=value1,key2=value2] [--scopes=Scope1,Scope2] [--dry-run=bool]`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
dry-run | | false | If true, only print the object that would be sent, without sending it.
|
||||
generator | | resourcequotas/v1 | The name of the API generator to use.
|
||||
hard | | | A comma-delimited set of resource=quantity pairs that define a hard limit.
|
||||
no-headers | | false | When using the default or custom-column output format, don't print headers.
|
||||
output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
|
||||
output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
|
||||
save-config | | false | If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
|
||||
schema-cache-dir | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema'
|
||||
scopes | | | A comma-delimited set of quota scopes that must all match each object tracked by the quota.
|
||||
show-all | a | false | When printing, show all resources (default hide terminated pods.)
|
||||
show-labels | | false | When printing, show all labels as the last column (default hide labels column)
|
||||
sort-by | | | If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
|
||||
template | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
|
||||
validate | | true | If true, use a schema to validate the input before sending it
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>secret</em>
|
||||
|
||||
|
||||
|
||||
Create a secret using specified subcommand.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ secret`
|
||||
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>secret docker-registry</em>
|
||||
|
||||
>bdocs-tab:example If you don't already have a .dockercfg file, you can create a dockercfg secret directly by using:
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL
|
||||
```
|
||||
|
||||
|
||||
Create a new secret for use with Docker registries.
|
||||
|
||||
Dockercfg secrets are used to authenticate against Docker registries.
|
||||
|
||||
When using the Docker command line to push images, you can authenticate to a given registry by running
|
||||
|
||||
$ docker login DOCKER_REGISTRY_SERVER --username=DOCKER_USER --password=DOCKER_PASSWORD --email=DOCKER_EMAIL'.
|
||||
|
||||
That produces a ~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to authenticate to the registry.
|
||||
|
||||
When creating applications, you may have a Docker registry that requires authentication. In order for the nodes to pull images on your behalf, they have to have the credentials. You can provide this information by creating a dockercfg secret and attaching it to your service account.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ docker-registry NAME --docker-username=user --docker-password=password --docker-email=email [--docker-server=string] [--from-literal=key1=value1] [--dry-run]`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
docker-email | | | Email for Docker registry
|
||||
docker-password | | | Password for Docker registry authentication
|
||||
docker-server | | https://index.docker.io/v1/ | Server location for Docker registry
|
||||
docker-username | | | Username for Docker registry authentication
|
||||
dry-run | | false | If true, only print the object that would be sent, without sending it.
|
||||
generator | | secret-for-docker-registry/v1 | The name of the API generator to use.
|
||||
include-extended-apis | | true | If true, include definitions of new APIs via calls to the API server. [default true]
|
||||
no-headers | | false | When using the default or custom-column output format, don't print headers.
|
||||
output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
|
||||
output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
|
||||
save-config | | false | If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
|
||||
schema-cache-dir | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema'
|
||||
show-all | a | false | When printing, show all resources (default hide terminated pods.)
|
||||
show-labels | | false | When printing, show all labels as the last column (default hide labels column)
|
||||
sort-by | | | If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
|
||||
template | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
|
||||
validate | | true | If true, use a schema to validate the input before sending it
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>secret generic</em>
|
||||
|
||||
>bdocs-tab:example Create a new secret named my-secret with keys for each file in folder bar
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl create secret generic my-secret --from-file=path/to/bar
|
||||
```
|
||||
|
||||
>bdocs-tab:example Create a new secret named my-secret with specified keys instead of names on disk
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl create secret generic my-secret --from-file=ssh-privatekey=~/.ssh/id_rsa --from-file=ssh-publickey=~/.ssh/id_rsa.pub
|
||||
```
|
||||
|
||||
>bdocs-tab:example Create a new secret named my-secret with key1=supersecret and key2=topsecret
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl create secret generic my-secret --from-literal=key1=supersecret --from-literal=key2=topsecret
|
||||
```
|
||||
|
||||
|
||||
Create a secret based on a file, directory, or specified literal value.
|
||||
|
||||
A single secret may package one or more key/value pairs.
|
||||
|
||||
When creating a secret based on a file, the key will default to the basename of the file, and the value will default to the file content. If the basename is an invalid key, you may specify an alternate key.
|
||||
|
||||
When creating a secret based on a directory, each file whose basename is a valid key in the directory will be packaged into the secret. Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).
|
||||
|
||||
### Usage
|
||||
|
||||
`$ generic NAME [--type=string] [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run]`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
dry-run | | false | If true, only print the object that would be sent, without sending it.
|
||||
from-file | | [] | Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid secret key.
|
||||
from-literal | | [] | Specify a key and literal value to insert in secret (i.e. mykey=somevalue)
|
||||
generator | | secret/v1 | The name of the API generator to use.
|
||||
no-headers | | false | When using the default or custom-column output format, don't print headers.
|
||||
output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
|
||||
output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
|
||||
save-config | | false | If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
|
||||
schema-cache-dir | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema'
|
||||
show-all | a | false | When printing, show all resources (default hide terminated pods.)
|
||||
show-labels | | false | When printing, show all labels as the last column (default hide labels column)
|
||||
sort-by | | | If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
|
||||
template | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
|
||||
type | | | The type of secret to create
|
||||
validate | | true | If true, use a schema to validate the input before sending it
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>secret tls</em>
|
||||
|
||||
>bdocs-tab:example Create a new TLS secret named tls-secret with the given key pair:
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.key
|
||||
```
|
||||
|
||||
|
||||
Create a TLS secret from the given public/private key pair.
|
||||
|
||||
The public/private key pair must exist before hand. The public key certificate must be .PEM encoded and match the given private key.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ tls NAME --cert=path/to/cert/file --key=path/to/key/file [--dry-run]`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
cert | | | Path to PEM encoded public key certificate.
|
||||
dry-run | | false | If true, only print the object that would be sent, without sending it.
|
||||
generator | | secret-for-tls/v1 | The name of the API generator to use.
|
||||
key | | | Path to private key associated with given certificate.
|
||||
no-headers | | false | When using the default or custom-column output format, don't print headers.
|
||||
output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
|
||||
output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
|
||||
save-config | | false | If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
|
||||
schema-cache-dir | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema'
|
||||
show-all | a | false | When printing, show all resources (default hide terminated pods.)
|
||||
show-labels | | false | When printing, show all labels as the last column (default hide labels column)
|
||||
sort-by | | | If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
|
||||
template | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
|
||||
validate | | true | If true, use a schema to validate the input before sending it
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>service</em>
|
||||
|
||||
|
||||
|
||||
Create a service using specified subcommand.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ service`
|
||||
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>service clusterip</em>
|
||||
|
||||
>bdocs-tab:example Create a new clusterIP service named my-cs
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl create service clusterip my-cs --tcp=5678:8080
|
||||
```
|
||||
|
||||
>bdocs-tab:example Create a new clusterIP service named my-cs (in headless mode)
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl create service clusterip my-cs --clusterip="None"
|
||||
```
|
||||
|
||||
|
||||
Create a clusterIP service with the specified name.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ clusterip NAME [--tcp=<port>:<targetPort>] [--dry-run]`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
clusterip | | | Assign your own ClusterIP or set to 'None' for a 'headless' service (no loadbalancing).
|
||||
dry-run | | false | If true, only print the object that would be sent, without sending it.
|
||||
generator | | service-clusterip/v1 | The name of the API generator to use.
|
||||
no-headers | | false | When using the default or custom-column output format, don't print headers.
|
||||
output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
|
||||
output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
|
||||
save-config | | false | If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
|
||||
schema-cache-dir | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema'
|
||||
show-all | a | false | When printing, show all resources (default hide terminated pods.)
|
||||
show-labels | | false | When printing, show all labels as the last column (default hide labels column)
|
||||
sort-by | | | If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
|
||||
tcp | | [] | Port pairs can be specified as '<port>:<targetPort>'.
|
||||
template | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
|
||||
validate | | true | If true, use a schema to validate the input before sending it
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>service loadbalancer</em>
|
||||
|
||||
>bdocs-tab:example Create a new LoadBalancer service named my-lbs
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl create service loadbalancer my-lbs --tcp=5678:8080
|
||||
```
|
||||
|
||||
|
||||
Create a LoadBalancer service with the specified name.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ loadbalancer NAME [--tcp=port:targetPort] [--dry-run]`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
dry-run | | false | If true, only print the object that would be sent, without sending it.
|
||||
generator | | service-loadbalancer/v1 | The name of the API generator to use.
|
||||
no-headers | | false | When using the default or custom-column output format, don't print headers.
|
||||
output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
|
||||
output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
|
||||
save-config | | false | If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
|
||||
schema-cache-dir | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema'
|
||||
show-all | a | false | When printing, show all resources (default hide terminated pods.)
|
||||
show-labels | | false | When printing, show all labels as the last column (default hide labels column)
|
||||
sort-by | | | If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
|
||||
tcp | | [] | Port pairs can be specified as '<port>:<targetPort>'.
|
||||
template | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
|
||||
validate | | true | If true, use a schema to validate the input before sending it
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>service nodeport</em>
|
||||
|
||||
>bdocs-tab:example Create a new nodeport service named my-ns
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl create service nodeport my-ns --tcp=5678:8080
|
||||
```
|
||||
|
||||
|
||||
Create a nodeport service with the specified name.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ nodeport NAME [--tcp=port:targetPort] [--dry-run]`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
dry-run | | false | If true, only print the object that would be sent, without sending it.
|
||||
generator | | service-nodeport/v1 | The name of the API generator to use.
|
||||
no-headers | | false | When using the default or custom-column output format, don't print headers.
|
||||
node-port | | 0 | Port used to expose the service on each node in a cluster.
|
||||
output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
|
||||
output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
|
||||
save-config | | false | If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
|
||||
schema-cache-dir | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema'
|
||||
show-all | a | false | When printing, show all resources (default hide terminated pods.)
|
||||
show-labels | | false | When printing, show all labels as the last column (default hide labels column)
|
||||
sort-by | | | If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
|
||||
tcp | | [] | Port pairs can be specified as '<port>:<targetPort>'.
|
||||
template | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
|
||||
validate | | true | If true, use a schema to validate the input before sending it
|
||||
|
||||
|
||||
|
||||
------------
|
||||
|
||||
## <em>serviceaccount</em>
|
||||
|
||||
>bdocs-tab:example Create a new service account named my-service-account
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
$ kubectl create serviceaccount my-service-account
|
||||
```
|
||||
|
||||
|
||||
Create a service account with the specified name.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ serviceaccount NAME [--dry-run]`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
dry-run | | false | If true, only print the object that would be sent, without sending it.
|
||||
generator | | serviceaccount/v1 | The name of the API generator to use.
|
||||
include-extended-apis | | true | If true, include definitions of new APIs via calls to the API server. [default true]
|
||||
no-headers | | false | When using the default or custom-column output format, don't print headers.
|
||||
output | o | | Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
|
||||
output-version | | | Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
|
||||
save-config | | false | If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future.
|
||||
schema-cache-dir | | ~/.kube/schema | If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema'
|
||||
show-all | a | false | When printing, show all resources (default hide terminated pods.)
|
||||
show-labels | | false | When printing, show all labels as the last column (default hide labels column)
|
||||
sort-by | | | If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
|
||||
template | | | Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
|
||||
validate | | true | If true, use a schema to validate the input before sending it
|
||||
|
||||
|
||||
|
||||
-33
@@ -1,33 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# CrossVersionObjectReference v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | CrossVersionObjectReference
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
CrossVersionObjectReference contains enough information to let you identify the referred resource.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#horizontalpodautoscalerspec-v1">HorizontalPodAutoscalerSpec</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | API version of the referent
|
||||
kind <br /> *string* | Kind of the referent; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds"
|
||||
name <br /> *string* | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-21
@@ -1,21 +0,0 @@
|
||||
## CrossVersionObjectReference v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | CrossVersionObjectReference
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
CrossVersionObjectReference contains enough information to let you identify the referred resource.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#horizontalpodautoscalerspec-v1">HorizontalPodAutoscalerSpec</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | API version of the referent
|
||||
kind <br /> *string* | Kind of the referent; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds"
|
||||
name <br /> *string* | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
|
||||
@@ -1,31 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# DaemonEndpoint v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | DaemonEndpoint
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
DaemonEndpoint contains information about a single Daemon endpoint.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#nodedaemonendpoints-v1">NodeDaemonEndpoints</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
Port <br /> *integer* | Port number of the given endpoint.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
## DaemonEndpoint v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | DaemonEndpoint
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
DaemonEndpoint contains information about a single Daemon endpoint.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#nodedaemonendpoints-v1">NodeDaemonEndpoints</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
Port <br /> *integer* | Port number of the given endpoint.
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,21 +0,0 @@
|
||||
## DaemonSet v1beta1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Extensions | v1beta1 | DaemonSet
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
DaemonSet represents the configuration of a daemon set.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#daemonsetlist-v1beta1">DaemonSetList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
spec <br /> *[DaemonSetSpec](#daemonsetspec-v1beta1)* | Spec defines the desired behavior of this daemon set. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
|
||||
status <br /> *[DaemonSetStatus](#daemonsetstatus-v1beta1)* | Status is the current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
|
||||
|
||||
@@ -1,31 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# DaemonSetList v1beta1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | DaemonSetList
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
DaemonSetList is a collection of daemon sets.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[DaemonSet](#daemonset-v1beta1) array* | Items is a list of daemon sets.
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
## DaemonSetList v1beta1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | DaemonSetList
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
DaemonSetList is a collection of daemon sets.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[DaemonSet](#daemonset-v1beta1) array* | Items is a list of daemon sets.
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
@@ -1,32 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# DaemonSetSpec v1beta1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | DaemonSetSpec
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
DaemonSetSpec is the specification of a daemon set.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#daemonset-v1beta1">DaemonSet</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
selector <br /> *[LabelSelector](#labelselector-unversioned)* | Selector is a label query over pods that are managed by the daemon set. Must match in order to be controlled. If empty, defaulted to labels on Pod template. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
|
||||
template <br /> *[PodTemplateSpec](#podtemplatespec-v1)* | Template is the object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
## DaemonSetSpec v1beta1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | DaemonSetSpec
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
DaemonSetSpec is the specification of a daemon set.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#daemonset-v1beta1">DaemonSet</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
selector <br /> *[LabelSelector](#labelselector-unversioned)* | Selector is a label query over pods that are managed by the daemon set. Must match in order to be controlled. If empty, defaulted to labels on Pod template. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
|
||||
template <br /> *[PodTemplateSpec](#podtemplatespec-v1)* | Template is the object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template
|
||||
|
||||
@@ -1,34 +0,0 @@
|
||||
|
||||
|
||||
-----------
|
||||
# DaemonSetStatus v1beta1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | DaemonSetStatus
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
DaemonSetStatus represents the current status of a daemon set.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#daemonset-v1beta1">DaemonSet</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
currentNumberScheduled <br /> *integer* | CurrentNumberScheduled is the number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
|
||||
desiredNumberScheduled <br /> *integer* | DesiredNumberScheduled is the total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
|
||||
numberMisscheduled <br /> *integer* | NumberMisscheduled is the number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
|
||||
numberReady <br /> *integer* | NumberReady is the number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-22
@@ -1,22 +0,0 @@
|
||||
## DaemonSetStatus v1beta1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | DaemonSetStatus
|
||||
|
||||
> Example yaml coming soon...
|
||||
|
||||
|
||||
|
||||
DaemonSetStatus represents the current status of a daemon set.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#daemonset-v1beta1">DaemonSet</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
currentNumberScheduled <br /> *integer* | CurrentNumberScheduled is the number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
|
||||
desiredNumberScheduled <br /> *integer* | DesiredNumberScheduled is the total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
|
||||
numberMisscheduled <br /> *integer* | NumberMisscheduled is the number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
|
||||
numberReady <br /> *integer* | NumberReady is the number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
|
||||
|
||||
@@ -1,87 +0,0 @@
|
||||
------------
|
||||
|
||||
# delete
|
||||
|
||||
>bdocs-tab:example Delete a pod using the type and name specified in pod.json.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl delete -f ./pod.json
|
||||
```
|
||||
|
||||
>bdocs-tab:example Delete a pod based on the type and name in the JSON passed into stdin.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
cat pod.json | kubectl delete -f -
|
||||
```
|
||||
|
||||
>bdocs-tab:example Delete pods and services with same names "baz" and "foo"
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl delete pod,service baz foo
|
||||
```
|
||||
|
||||
>bdocs-tab:example Delete pods and services with label name=myLabel.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl delete pods,services -l name=myLabel
|
||||
```
|
||||
|
||||
>bdocs-tab:example Delete a pod with minimal delay
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl delete pod foo --now
|
||||
```
|
||||
|
||||
>bdocs-tab:example Force delete a pod on a dead node
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl delete pod foo --grace-period=0 --force
|
||||
```
|
||||
|
||||
>bdocs-tab:example Delete a pod with UID 1234-56-7890-234234-456456.
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl delete pod 1234-56-7890-234234-456456
|
||||
```
|
||||
|
||||
>bdocs-tab:example Delete all pods
|
||||
|
||||
```bdocs-tab:example_shell
|
||||
kubectl delete pods --all
|
||||
```
|
||||
|
||||
|
||||
Delete resources by filenames, stdin, resources and names, or by resources and label selector.
|
||||
|
||||
JSON and YAML formats are accepted. Only one type of the arguments may be specified: filenames, resources and names, or resources and label selector.
|
||||
|
||||
Some resources, such as pods, support graceful deletion. These resources define a default period before they are forcibly terminated (the grace period) but you may override that value with the --grace-period flag, or pass --now to set a grace-period of 1. Because these resources often represent entities in the cluster, deletion may not be acknowledged immediately. If the node hosting a pod is down or cannot reach the API server, termination may take significantly longer than the grace period. To force delete a resource, you must pass a grace period of 0 and specify the --force flag.
|
||||
|
||||
IMPORTANT: Force deleting pods does not wait for confirmation that the pod's processes have been terminated, which can leave those processes running until the node detects the deletion and completes graceful deletion. If your processes use shared storage or talk to a remote API and depend on the name of the pod to identify themselves, force deleting those pods may result in multiple processes running on different machines using the same identification which may lead to data corruption or inconsistency. Only force delete pods when you are sure the pod is terminated, or if your application can tolerate multiple copies of the same pod running at once. Also, if you force delete pods the scheduler may place new pods on those nodes before the node has released those resources and causing those pods to be evicted immediately.
|
||||
|
||||
Note that the delete command does NOT do resource version checks, so if someone submits an update to a resource right when you submit a delete, their update will be lost along with the rest of the resource.
|
||||
|
||||
### Usage
|
||||
|
||||
`$ delete ([-f FILENAME] | TYPE [(NAME | -l label | --all)])`
|
||||
|
||||
|
||||
|
||||
### Flags
|
||||
|
||||
Name | Shorthand | Default | Usage
|
||||
---- | --------- | ------- | -----
|
||||
all | | false | [-all] to select all the specified resources.
|
||||
cascade | | true | If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController). Default true.
|
||||
filename | f | [] | Filename, directory, or URL to files containing the resource to delete.
|
||||
force | | false | Immediate deletion of some resources may result in inconsistency or data loss and requires confirmation.
|
||||
grace-period | | -1 | Period of time in seconds given to the resource to terminate gracefully. Ignored if negative.
|
||||
ignore-not-found | | false | Treat "resource not found" as a successful delete. Defaults to "true" when --all is specified.
|
||||
include-extended-apis | | true | If true, include definitions of new APIs via calls to the API server. [default true]
|
||||
now | | false | If true, resources are signaled for immediate shutdown (same as --grace-period=1).
|
||||
output | o | | Output mode. Use "-o name" for shorter output (resource/name).
|
||||
recursive | R | false | Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
|
||||
selector | l | | Selector (label query) to filter on.
|
||||
timeout | | 0s | The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user