scottk/kubernetes
1
0
Fork 0
mirror of https://github.com/optim-enterprises-bv/kubernetes.git synced 2025-11-03 19:58:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Generate new docs with the new changes

Browse Source
This commit is contained in:
Eric Paris
2015-02-20 16:29:23 -05:00
parent aab9cc3219
commit 421da2043a
51 changed files with 3144 additions and 361 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/kubectl-config-set-cluster.md
View File

@@ -4,12 +4,14 @@ Sets a cluster entry in .kubeconfig
### Synopsis
```
Sets a cluster entry in .kubeconfig
Specifying a name that already exists will merge new fields on top of existing values for those fields.
e.g.
kubectl config set-cluster e2e --certificate-authority=~/.kube/e2e/.kubernetes.ca.cert
only sets the certificate-authority field on the e2e cluster entry without touching other values.
```
kubectl config set-cluster name [--server=server] [--certificate-authority=path/to/certficate/authority] [--api-version=apiversion] [--insecure-skip-tls-verify=true]

3
docs/kubectl-config-set-context.md
View File

@@ -4,12 +4,13 @@ Sets a context entry in .kubeconfig
### Synopsis
```
Sets a context entry in .kubeconfig
Specifying a name that already exists will merge new fields on top of existing values for those fields.
e.g.
kubectl config set-context gce --user=cluster-admin
only sets the user field on the gce context entry without touching other values.
```
kubectl config set-context name [--cluster=cluster-nickname] [--user=user-nickname] [--namespace=namespace]

2
docs/kubectl-config-set-credentials.md
View File

@@ -4,6 +4,7 @@ Sets a user entry in .kubeconfig
### Synopsis
```
Sets a user entry in .kubeconfig
Specifying a name that already exists will merge new fields on top of existing
@@ -23,6 +24,7 @@ Sets a user entry in .kubeconfig
Bearer token and basic auth are mutually exclusive.
```
kubectl config set-credentials name [--auth-path=authfile] [--client-certificate=certfile] [--client-key=keyfile] [--token=bearer_token] [--username=basic_user] [--password=basic_password]

2
docs/kubectl-config-set.md
View File

@@ -4,12 +4,14 @@ Sets an individual value in a .kubeconfig file
### Synopsis
```
Sets an individual value in a .kubeconfig file
property-name is a dot delimited name where each token represents either a attribute name or a map key. Map keys may not contain dots.
property-value is the new value you wish to set.
```
kubectl config set property-name property-value

2
docs/kubectl-config-unset.md
View File

@@ -4,10 +4,12 @@ Unsets an individual value in a .kubeconfig file
### Synopsis
```
Unsets an individual value in a .kubeconfig file
property-name is a dot delimited name where each token represents either a attribute name or a map key. Map keys may not contain dots.
```
kubectl config unset property-name

2
docs/kubectl-config-use-context.md
View File

@@ -4,7 +4,9 @@ Sets the current-context in a .kubeconfig file
### Synopsis
```
Sets the current-context in a .kubeconfig file
```
kubectl config use-context context-name

18
docs/kubectl-config-view.md
View File

@@ -4,16 +4,22 @@ displays merged .kubeconfig settings or a specified .kubeconfig file.
### Synopsis
```
displays merged .kubeconfig settings or a specified .kubeconfig file.
Examples:
// Show merged .kubeconfig settings.
$ kubectl config view
// Show only local ./.kubeconfig settings
$ kubectl config view --local
```
kubectl config view
### Examples
```
// Show merged .kubeconfig settings.
$ kubectl config view
// Show only local ./.kubeconfig settings
$ kubectl config view --local
```
### Options
```

2
docs/kubectl-config.md
View File

@@ -4,7 +4,9 @@ config modifies .kubeconfig files
### Synopsis
```
config modifies .kubeconfig files using subcommands like "kubectl config set current-context my-context"
```
kubectl config <subcommand>

20
docs/kubectl-create.md
View File

@@ -4,20 +4,24 @@ Create a resource by filename or stdin
### Synopsis
```
Create a resource by filename or stdin.
JSON and YAML formats are accepted.
Examples:
// Create a pod using the data in pod.json.
$ kubectl create -f pod.json
// Create a pod based on the JSON passed into stdin.
$ cat pod.json | kubectl create -f -
```
kubectl create -f filename
### Examples
```
// Create a pod using the data in pod.json.
$ kubectl create -f pod.json
// Create a pod based on the JSON passed into stdin.
$ cat pod.json | kubectl create -f -
```
### Options
```

38
docs/kubectl-delete.md
View File

@@ -4,6 +4,7 @@ Delete a resource by filename, stdin, or resource and ID.
### Synopsis
```
Delete a resource by filename, stdin, resource and ID, or by resources and label selector.
JSON and YAML formats are accepted.
@@ -14,26 +15,29 @@ arguments are used and the filename is ignored.
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.
Examples:
// Delete a pod using the type and ID specified in pod.json.
$ kubectl delete -f pod.json
// Delete a pod based on the type and ID in the JSON passed into stdin.
$ cat pod.json | kubectl delete -f -
// Delete pods and services with label name=myLabel.
$ kubectl delete pods,services -l name=myLabel
// Delete a pod with ID 1234-56-7890-234234-456456.
$ kubectl delete pod 1234-56-7890-234234-456456
// Delete all pods
$ kubectl delete pods --all
```
kubectl delete ([-f filename] | (<resource> [(<id> | -l <label> | --all)]
### Examples
```
// Delete a pod using the type and ID specified in pod.json.
$ kubectl delete -f pod.json
// Delete a pod based on the type and ID in the JSON passed into stdin.
$ cat pod.json | kubectl delete -f -
// Delete pods and services with label name=myLabel.
$ kubectl delete pods,services -l name=myLabel
// Delete a pod with ID 1234-56-7890-234234-456456.
$ kubectl delete pod 1234-56-7890-234234-456456
// Delete all pods
$ kubectl delete pods --all
```
### Options
```

2
docs/kubectl-describe.md
View File

@@ -4,10 +4,12 @@ Show details of a specific resource
### Synopsis
```
Show details of a specific resource.
This command joins many API calls together to form a detailed description of a
given resource.
```
kubectl describe <resource> <id>

19
docs/kubectl-exec.md
View File

@@ -4,17 +4,22 @@ Execute a command in a container.
### Synopsis
```
Execute a command in a container.
Examples:
$ kubectl exec -p 123456-7890 -c ruby-container date
<returns output from running 'date' in ruby-container from pod 123456-7890>
$ kubectl exec -p 123456-7890 -c ruby-container -i -t -- bash -il
<switches to raw terminal mode, sends stdin to 'bash' in ruby-container from
pod 123456-780 and sends stdout/stderr from 'bash' back to the client
```
kubectl exec -p <pod> -c <container> -- <command> [<args...>]
### Examples
```
// get output from running 'date' in ruby-container from pod 123456-7890
$ kubectl exec -p 123456-7890 -c ruby-container date
//switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-780 and sends stdout/stderr from 'bash' back to the client
$ kubectl exec -p 123456-7890 -c ruby-container -i -t -- bash -il
```
### Options
```

20
docs/kubectl-expose.md
View File

@@ -4,21 +4,25 @@ Take a replicated application and expose it as Kubernetes Service
### Synopsis
```
Take a replicated application and expose it as Kubernetes Service.
Looks up a ReplicationController by name, and uses the selector for that replication controller
as the selector for a new Service on the specified port.
Examples:
// Creates a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000.
$ kubectl expose nginx --port=80 --container-port=8000
// Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video-stream'.
$ kubectl expose streamer --port=4100 --protocol=udp --service-name=video-stream
```
kubectl expose <name> --port=<port> [--protocol=TCP|UDP] [--container-port=<number-or-name>] [--service-name=<name>] [--public-ip=<ip>] [--create-external-load-balancer]
### Examples
```
// Creates a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000.
$ kubectl expose nginx --port=80 --container-port=8000
// Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video-stream'.
$ kubectl expose streamer --port=4100 --protocol=udp --service-name=video-stream
```
### Options
```

38
docs/kubectl-get.md
View File

@@ -4,6 +4,7 @@ Display one or many resources
### Synopsis
```
Display one or many resources.
Possible resources include pods (po), replication controllers (rc), services
@@ -11,26 +12,29 @@ Possible resources include pods (po), replication controllers (rc), services
By specifying the output as 'template' and providing a Go template as the value
of the --template flag, you can filter the attributes of the fetched resource(s).
Examples:
// List all pods in ps output format.
$ kubectl get pods
// List a single replication controller with specified ID in ps output format.
$ kubectl get replicationController 1234-56-7890-234234-456456
// List a single pod in JSON output format.
$ kubectl get -o json pod 1234-56-7890-234234-456456
// Return only the status value of the specified pod.
$ kubectl get -o template pod 1234-56-7890-234234-456456 --template={{.currentState.status}}
// List all replication controllers and services together in ps output format.
$ kubectl get rc,services
```
kubectl get [(-o|--output=)json|yaml|template|...] <resource> [<id>]
### Examples
```
// List all pods in ps output format.
$ kubectl get pods
// List a single replication controller with specified ID in ps output format.
$ kubectl get replicationController 1234-56-7890-234234-456456
// List a single pod in JSON output format.
$ kubectl get -o json pod 1234-56-7890-234234-456456
// Return only the status value of the specified pod.
$ kubectl get -o template pod 1234-56-7890-234234-456456 --template={{.currentState.status}}
// List all replication controllers and services together in ps output format.
$ kubectl get rc,services
```
### Options
```

33
docs/kubectl-label.md
View File

@@ -4,27 +4,32 @@ Update the labels on a resource
### Synopsis
```
Update the labels on a resource.
If --overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error.
If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used.
Examples:
// Update pod 'foo' with the label 'unhealthy' and the value 'true'.
$ kubectl label pods foo unhealthy=true
// Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value.
$ kubectl label --overwrite pods foo status=unhealthy
// Update pod 'foo' only if the resource is unchanged from version 1.
$ kubectl label pods foo status=unhealthy --resource-version=1
// Update pod 'foo' by removing a label named 'bar' if it exists.
// Does not require the --overwrite flag.
$ kubectl label pods foo bar-
```
kubectl label [--overwrite] <resource> <name> <key-1>=<val-1> ... <key-n>=<val-n> [--resource-version=<version>]
### Examples
```
// Update pod 'foo' with the label 'unhealthy' and the value 'true'.
$ kubectl label pods foo unhealthy=true
// Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value.
$ kubectl label --overwrite pods foo status=unhealthy
// Update pod 'foo' only if the resource is unchanged from version 1.
$ kubectl label pods foo status=unhealthy --resource-version=1
// Update pod 'foo' by removing a label named 'bar' if it exists.
// Does not require the --overwrite flag.
$ kubectl label pods foo bar-
```
### Options
```

20
docs/kubectl-log.md
View File

@@ -4,18 +4,22 @@ Print the logs for a container in a pod.
### Synopsis
```
Print the logs for a container in a pod. If the pod has only one container, the container name is optional.
Examples:
// Returns snapshot of ruby-container logs from pod 123456-7890.
$ kubectl log 123456-7890 ruby-container
// Starts streaming of ruby-container logs from pod 123456-7890.
$ kubectl log -f 123456-7890 ruby-container
```
kubectl log [-f] <pod> [<container>]
### Examples
```
// Returns snapshot of ruby-container logs from pod 123456-7890.
$ kubectl log 123456-7890 ruby-container
// Starts streaming of ruby-container logs from pod 123456-7890.
$ kubectl log -f 123456-7890 ruby-container
```
### Options
```

2
docs/kubectl-namespace.md
View File

@@ -4,10 +4,12 @@ SUPERCEDED: Set and view the current Kubernetes namespace
### Synopsis
```
SUPERCEDED: Set and view the current Kubernetes namespace scope for command line requests.
namespace has been superceded by the context.namespace field of .kubeconfig files. See 'kubectl config set-context --help' for more details.
```
kubectl namespace [<namespace>]

32
docs/kubectl-port-forward.md
View File

@@ -4,24 +4,28 @@ Forward 1 or more local ports to a pod.
### Synopsis
```
Forward 1 or more local ports to a pod.
Examples:
$ kubectl port-forward -p mypod 5000 6000
<listens on ports 5000 and 6000 locally, forwarding data to/from ports 5000
and 6000 in the pod>
$ kubectl port-forward -p mypod 8888:5000
<listens on port 8888 locally, forwarding to 5000 in the pod>
$ kubectl port-forward -p mypod :5000
<listens on a random port locally, forwarding to 5000 in the pod>
$ kubectl port-forward -p mypod 0:5000
<listens on a random port locally, forwarding to 5000 in the pod>
```
kubectl port-forward -p <pod> [<local port>:]<remote port> [<port>...]
### Examples
```
$ kubectl port-forward -p mypod 5000 6000
<listens on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod>
$ kubectl port-forward -p mypod 8888:5000
<listens on port 8888 locally, forwarding to 5000 in the pod>
$ kubectl port-forward -p mypod :5000
<listens on a random port locally, forwarding to 5000 in the pod>
$ kubectl port-forward -p mypod 0:5000
<listens on a random port locally, forwarding to 5000 in the pod>
```
### Options
```

2
docs/kubectl-proxy.md
View File

@@ -4,7 +4,9 @@ Run a proxy to the Kubernetes API server
### Synopsis
```
Run a proxy to the Kubernetes API server.
```
kubectl proxy

20
docs/kubectl-resize.md
View File

@@ -4,23 +4,27 @@ Set a new size for a Replication Controller.
### Synopsis
```
Set a new size for a Replication Controller.
Resize also allows users to specify one or more preconditions for the resize action.
If --current-replicas or --resource-version is specified, it is validated before the
resize is attempted, and it is guaranteed that the precondition holds true when the
resize is sent to the server.
Examples:
// Resize replication controller named 'foo' to 3.
$ kubectl resize --replicas=3 replicationcontrollers foo
// If the replication controller named foo's current size is 2, resize foo to 3.
$ kubectl resize --current-replicas=2 --replicas=3 replicationcontrollers foo
```
kubectl resize [--resource-version=<version>] [--current-replicas=<count>] --replicas=<count> <resource> <id>
### Examples
```
// Resize replication controller named 'foo' to 3.
$ kubectl resize --replicas=3 replicationcontrollers foo
// If the replication controller named foo's current size is 2, resize foo to 3.
$ kubectl resize --current-replicas=2 --replicas=3 replicationcontrollers foo
```
### Options
```

20
docs/kubectl-rollingupdate.md
View File

@@ -4,22 +4,26 @@ Perform a rolling update of the given ReplicationController.
### Synopsis
```
Perform a rolling update of the given ReplicationController.
Replaces the specified controller with new controller, updating one pod at a time to use the
new PodTemplate. The new-controller.json must specify the same namespace as the
existing controller and overwrite at least one (common) label in its replicaSelector.
Examples:
// Update pods of frontend-v1 using new controller data in frontend-v2.json.
$ kubectl rollingupdate frontend-v1 -f frontend-v2.json
// Update pods of frontend-v1 using JSON data passed into stdin.
$ cat frontend-v2.json | kubectl rollingupdate frontend-v1 -f -
```
kubectl rollingupdate <old-controller-name> -f <new-controller.json>
### Examples
```
// Update pods of frontend-v1 using new controller data in frontend-v2.json.
$ kubectl rollingupdate frontend-v1 -f frontend-v2.json
// Update pods of frontend-v1 using JSON data passed into stdin.
$ cat frontend-v2.json | kubectl rollingupdate frontend-v1 -f -
```
### Options
```

32
docs/kubectl-run-container.md
View File

@@ -4,25 +4,29 @@ Run a particular image on the cluster.
### Synopsis
```
Create and run a particular image, possibly replicated.
Creates a replication controller to manage the created container(s).
Examples:
// Starts a single instance of nginx.
$ kubectl run-container nginx --image=dockerfile/nginx
// Starts a replicated instance of nginx.
$ kubectl run-container nginx --image=dockerfile/nginx --replicas=5
// Dry run. Print the corresponding API objects without creating them.
$ kubectl run-container nginx --image=dockerfile/nginx --dry-run
// Start a single instance of nginx, but overload the desired state with a partial set of values parsed from JSON.
$ kubectl run-container nginx --image=dockerfile/nginx --overrides='{ "apiVersion": "v1beta1", "desiredState": { ... } }'
```
kubectl run-container <name> --image=<image> [--port=<port>] [--replicas=replicas] [--dry-run=<bool>] [--overrides=<inline-json>]
### Examples
```
// Starts a single instance of nginx.
$ kubectl run-container nginx --image=dockerfile/nginx
// Starts a replicated instance of nginx.
$ kubectl run-container nginx --image=dockerfile/nginx --replicas=5
// Dry run. Print the corresponding API objects without creating them.
$ kubectl run-container nginx --image=dockerfile/nginx --dry-run
// Start a single instance of nginx, but overload the desired state with a partial set of values parsed from JSON.
$ kubectl run-container nginx --image=dockerfile/nginx --overrides='{ "apiVersion": "v1beta1", "desiredState": { ... } }'
```
### Options
```

26
docs/kubectl-stop.md
View File

@@ -4,24 +4,28 @@ Gracefully shut down a resource by id or filename.
### Synopsis
```
Gracefully shut down a resource by id or filename.
Attempts to shut down and delete a resource that supports graceful termination.
If the resource is resizable it will be resized to 0 before deletion.
Examples:
// Shut down foo.
$ kubectl stop replicationcontroller foo
// Shut down the service defined in service.json
$ kubectl stop -f service.json
// Shut down all resources in the path/to/resources directory
$ kubectl stop -f path/to/resources
```
kubectl stop (<resource> <id>|-f filename)
### Examples
```
// Shut down foo.
$ kubectl stop replicationcontroller foo
// Shut down the service defined in service.json
$ kubectl stop -f service.json
// Shut down all resources in the path/to/resources directory
$ kubectl stop -f path/to/resources
```
### Options
```

26
docs/kubectl-update.md
View File

@@ -4,23 +4,27 @@ Update a resource by filename or stdin.
### Synopsis
```
Update a resource by filename or stdin.
JSON and YAML formats are accepted.
Examples:
// Update a pod using the data in pod.json.
$ kubectl update -f pod.json
// Update a pod based on the JSON passed into stdin.
$ cat pod.json | kubectl update -f -
// Update a pod by downloading it, applying the patch, then updating. Requires apiVersion be specified.
$ kubectl update pods my-pod --patch='{ "apiVersion": "v1beta1", "desiredState": { "manifest": [{ "cpu": 100 }]}}'
```
kubectl update -f filename
### Examples
```
// Update a pod using the data in pod.json.
$ kubectl update -f pod.json
// Update a pod based on the JSON passed into stdin.
$ cat pod.json | kubectl update -f -
// Update a pod by downloading it, applying the patch, then updating. Requires apiVersion be specified.
$ kubectl update pods my-pod --patch='{ "apiVersion": "v1beta1", "desiredState": { "manifest": [{ "cpu": 100 }]}}'
```
### Options
```

2
docs/kubectl-version.md
View File

@@ -4,7 +4,9 @@ Print the client and server version information.
### Synopsis
```
Print the client and server version information.
```
kubectl version

2
docs/kubectl.md
View File

@@ -4,9 +4,11 @@ kubectl controls the Kubernetes cluster manager
### Synopsis
```
kubectl controls the Kubernetes cluster manager.
Find more information at https://github.com/GoogleCloudPlatform/kubernetes.
```
kubectl

112
docs/man/man1/kubectl-config-set-cluster.1
View File

@@ -20,22 +20,122 @@ Sets a cluster entry in .kubeconfig
only sets the certificate\-authority field on the e2e cluster entry without touching other values.
.SH OPTIONS
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
api\-version for the cluster entry in .kubeconfig
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
certificate\-authority for the cluster entry in .kubeconfig
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-envvar\fP=false
use the .kubeconfig from $KUBECONFIG
.PP
\fB\-\-global\fP=false
use the .kubeconfig from /home/username
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for config
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
insecure\-skip\-tls\-verify for the cluster entry in .kubeconfig
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-server\fP=""
server for the cluster entry in .kubeconfig
\fB\-\-kubeconfig\fP=""
use a particular .kubeconfig file
.PP
\fB\-\-local\fP=false
use the .kubeconfig in the current directory
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH SEE ALSO

112
docs/man/man1/kubectl-config-set-context.1
View File

@@ -20,18 +20,122 @@ Sets a context entry in .kubeconfig
only sets the user field on the gce context entry without touching other values.
.SH OPTIONS
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
cluster for the context entry in .kubeconfig
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-envvar\fP=false
use the .kubeconfig from $KUBECONFIG
.PP
\fB\-\-global\fP=false
use the .kubeconfig from /home/username
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for config
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
use a particular .kubeconfig file
.PP
\fB\-\-local\fP=false
use the .kubeconfig in the current directory
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
namespace for the context entry in .kubeconfig
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
user for the context entry in .kubeconfig
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH SEE ALSO

108
docs/man/man1/kubectl-config-set-credentials.1
View File

@@ -45,30 +45,122 @@ Basic auth flags:
Bearer token and basic auth are mutually exclusive.
.SH OPTIONS
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-auth\-path\fP=""
auth\-path for the user entry in .kubeconfig
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
client\-certificate for the user entry in .kubeconfig
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
client\-key for the user entry in .kubeconfig
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-envvar\fP=false
use the .kubeconfig from $KUBECONFIG
.PP
\fB\-\-global\fP=false
use the .kubeconfig from /home/username
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for config
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
use a particular .kubeconfig file
.PP
\fB\-\-local\fP=false
use the .kubeconfig in the current directory
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
password for the user entry in .kubeconfig
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
token for the user entry in .kubeconfig
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
username for the user entry in .kubeconfig
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH SEE ALSO

118
docs/man/man1/kubectl-config-set.1
View File

@@ -26,6 +26,124 @@ Sets an individual value in a .kubeconfig file
.RE
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-envvar\fP=false
use the .kubeconfig from $KUBECONFIG
.PP
\fB\-\-global\fP=false
use the .kubeconfig from /home/username
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for config
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
use a particular .kubeconfig file
.PP
\fB\-\-local\fP=false
use the .kubeconfig in the current directory
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH SEE ALSO
.PP
\fBkubectl\-config(1)\fP,

118
docs/man/man1/kubectl-config-unset.1
View File

@@ -25,6 +25,124 @@ Unsets an individual value in a .kubeconfig file
.RE
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-envvar\fP=false
use the .kubeconfig from $KUBECONFIG
.PP
\fB\-\-global\fP=false
use the .kubeconfig from /home/username
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for config
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
use a particular .kubeconfig file
.PP
\fB\-\-local\fP=false
use the .kubeconfig in the current directory
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH SEE ALSO
.PP
\fBkubectl\-config(1)\fP,

118
docs/man/man1/kubectl-config-use-context.1
View File

@@ -16,6 +16,124 @@ kubectl config use\-context \- Sets the current\-context in a .kubeconfig file
Sets the current\-context in a .kubeconfig file
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-envvar\fP=false
use the .kubeconfig from $KUBECONFIG
.PP
\fB\-\-global\fP=false
use the .kubeconfig from /home/username
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for config
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
use a particular .kubeconfig file
.PP
\fB\-\-local\fP=false
use the .kubeconfig in the current directory
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH SEE ALSO
.PP
\fBkubectl\-config(1)\fP,

140
docs/man/man1/kubectl-config-view.1
View File

@@ -14,13 +14,6 @@ kubectl config view \- displays merged .kubeconfig settings or a specified .kube
.SH DESCRIPTION
.PP
displays merged .kubeconfig settings or a specified .kubeconfig file.
Examples:
// Show merged .kubeconfig settings.
$ kubectl config view
.PP
// Show only local ./.kubeconfig settings
$ kubectl config view \-\-local
.SH OPTIONS
@@ -46,6 +39,139 @@ Examples:
\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-envvar\fP=false
use the .kubeconfig from $KUBECONFIG
.PP
\fB\-\-global\fP=false
use the .kubeconfig from /home/username
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for config
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
use a particular .kubeconfig file
.PP
\fB\-\-local\fP=false
use the .kubeconfig in the current directory
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Show merged .kubeconfig settings.
$ kubectl config view
// Show only local ./.kubeconfig settings
$ kubectl config view \-\-local
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl\-config(1)\fP,

120
docs/man/man1/kubectl-config.1
View File

@@ -16,6 +16,126 @@ kubectl config \- config modifies .kubeconfig files
config modifies .kubeconfig files using subcommands like "kubectl config set current\-context my\-context"
.SH OPTIONS
.PP
\fB\-\-envvar\fP=false
use the .kubeconfig from $KUBECONFIG
.PP
\fB\-\-global\fP=false
use the .kubeconfig from /home/username
.PP
\fB\-\-local\fP=false
use the .kubeconfig in the current directory
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for kubectl
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH SEE ALSO
.PP
\fBkubectl(1)\fP, \fBkubectl\-config\-view(1)\fP, \fBkubectl\-config\-set\-cluster(1)\fP, \fBkubectl\-config\-set\-credentials(1)\fP, \fBkubectl\-config\-set\-context(1)\fP, \fBkubectl\-config\-set(1)\fP, \fBkubectl\-config\-unset(1)\fP, \fBkubectl\-config\-use\-context(1)\fP,

121
docs/man/man1/kubectl-create.1
View File

@@ -18,9 +18,120 @@ Create a resource by filename or stdin.
.PP
JSON and YAML formats are accepted.
.PP
Examples:
.SH OPTIONS
.PP
\fB\-f\fP, \fB\-\-filename\fP=[]
Filename, directory, or URL to file to use to create the resource
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for kubectl
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
@@ -35,12 +146,6 @@ $ cat pod.json | kubectl create \-f \-
.RE
.SH OPTIONS
.PP
\fB\-f\fP, \fB\-\-filename\fP=[]
Filename, directory, or URL to file to use to create the resource
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,

137
docs/man/man1/kubectl-delete.1
View File

@@ -27,9 +27,128 @@ 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.
.PP
Examples:
.SH OPTIONS
.PP
\fB\-\-all\fP=false
[\-all] to select all the specified resources
.PP
\fB\-f\fP, \fB\-\-filename\fP=[]
Filename, directory, or URL to a file containing the resource to delete
.PP
\fB\-l\fP, \fB\-\-selector\fP=""
Selector (label query) to filter on
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for kubectl
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
@@ -53,20 +172,6 @@ $ kubectl delete pods \-\-all
.RE
.SH OPTIONS
.PP
\fB\-\-all\fP=false
[\-all] to select all the specified resources
.PP
\fB\-f\fP, \fB\-\-filename\fP=[]
Filename, directory, or URL to a file containing the resource to delete
.PP
\fB\-l\fP, \fB\-\-selector\fP=""
Selector (label query) to filter on
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,

106
docs/man/man1/kubectl-describe.1
View File

@@ -20,6 +20,112 @@ This command joins many API calls together to form a detailed description of a
given resource.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for kubectl
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,

129
docs/man/man1/kubectl-exec.1
View File

@@ -14,14 +14,6 @@ kubectl exec \- Execute a command in a container.
.SH DESCRIPTION
.PP
Execute a command in a container.
Examples:
$ kubectl exec \-p 123456\-7890 \-c ruby\-container date
<returns output from running 'date' in ruby-container from pod 123456-7890>
.PP
$ kubectl exec \-p 123456\-7890 \-c ruby\-container \-i \-t \-\- bash \-il
<switches to raw terminal mode, sends stdin to 'bash' in ruby\-container from
pod 123456\-780 and sends stdout/stderr from 'bash' back to the client
.SH OPTIONS
@@ -42,6 +34,127 @@ $ kubectl exec \-p 123456\-7890 \-c ruby\-container \-i \-t \-\- bash \-il
Stdin is a TTY
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for kubectl
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// get output from running 'date' in ruby\-container from pod 123456\-7890
$ kubectl exec \-p 123456\-7890 \-c ruby\-container date
//switch to raw terminal mode, sends stdin to 'bash' in ruby\-container from pod 123456\-780 and sends stdout/stderr from 'bash' back to the client
$ kubectl exec \-p 123456\-7890 \-c ruby\-container \-i \-t \-\- bash \-il
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,

137
docs/man/man1/kubectl-expose.1
View File

@@ -19,22 +19,6 @@ Take a replicated application and expose it as Kubernetes Service.
Looks up a ReplicationController by name, and uses the selector for that replication controller
as the selector for a new Service on the specified port.
.PP
Examples:
.PP
.RS
.nf
// Creates a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000.
$ kubectl expose nginx \-\-port=80 \-\-container\-port=8000
// Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video\-stream'.
$ kubectl expose streamer \-\-port=4100 \-\-protocol=udp \-\-service\-name=video\-stream
.fi
.RE
.SH OPTIONS
.PP
@@ -95,6 +79,127 @@ $ kubectl expose streamer \-\-port=4100 \-\-protocol=udp \-\-service\-name=video
\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for kubectl
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Creates a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000.
$ kubectl expose nginx \-\-port=80 \-\-container\-port=8000
// Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video\-stream'.
$ kubectl expose streamer \-\-port=4100 \-\-protocol=udp \-\-service\-name=video\-stream
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,

155
docs/man/man1/kubectl-get.1
View File

@@ -23,31 +23,6 @@ Possible resources include pods (po), replication controllers (rc), services
By specifying the output as 'template' and providing a Go template as the value
of the \-\-template flag, you can filter the attributes of the fetched resource(s).
.PP
Examples:
.PP
.RS
.nf
// List all pods in ps output format.
$ kubectl get pods
// List a single replication controller with specified ID in ps output format.
$ kubectl get replicationController 1234\-56\-7890\-234234\-456456
// List a single pod in JSON output format.
$ kubectl get \-o json pod 1234\-56\-7890\-234234\-456456
// Return only the status value of the specified pod.
$ kubectl get \-o template pod 1234\-56\-7890\-234234\-456456 \-\-template=\{\{.currentState.status\}\}
// List all replication controllers and services together in ps output format.
$ kubectl get rc,services
.fi
.RE
.SH OPTIONS
.PP
@@ -80,6 +55,136 @@ $ kubectl get rc,services
Watch for changes to the requested object(s), without listing/getting first.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for kubectl
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// List all pods in ps output format.
$ kubectl get pods
// List a single replication controller with specified ID in ps output format.
$ kubectl get replicationController 1234\-56\-7890\-234234\-456456
// List a single pod in JSON output format.
$ kubectl get \-o json pod 1234\-56\-7890\-234234\-456456
// Return only the status value of the specified pod.
$ kubectl get \-o template pod 1234\-56\-7890\-234234\-456456 \-\-template=\{\{.currentState.status\}\}
// List all replication controllers and services together in ps output format.
$ kubectl get rc,services
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,

146
docs/man/man1/kubectl-label.1
View File

@@ -19,24 +19,6 @@ Update the labels on a resource.
If \-\-overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error.
If \-\-resource\-version is specified, then updates will use this resource version, otherwise the existing resource\-version will be used.
.PP
Examples:
// Update pod 'foo' with the label 'unhealthy' and the value 'true'.
$ kubectl label pods foo unhealthy=true
.PP
// Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value.
$ kubectl label \-\-overwrite pods foo status=unhealthy
.PP
// Update pod 'foo' only if the resource is unchanged from version 1.
$ kubectl label pods foo status=unhealthy \-\-resource\-version=1
.PP
// Update pod 'foo' by removing a label named 'bar' if it exists.
// Does not require the \-\-overwrite flag.
$ kubectl label pods foo bar\-
.SH OPTIONS
.PP
@@ -65,6 +47,134 @@ Examples:
\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for kubectl
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Update pod 'foo' with the label 'unhealthy' and the value 'true'.
$ kubectl label pods foo unhealthy=true
// Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value.
$ kubectl label \-\-overwrite pods foo status=unhealthy
// Update pod 'foo' only if the resource is unchanged from version 1.
$ kubectl label pods foo status=unhealthy \-\-resource\-version=1
// Update pod 'foo' by removing a label named 'bar' if it exists.
// Does not require the \-\-overwrite flag.
$ kubectl label pods foo bar\-
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,

121
docs/man/man1/kubectl-log.1
View File

@@ -15,9 +15,120 @@ kubectl log \- Print the logs for a container in a pod.
.PP
Print the logs for a container in a pod. If the pod has only one container, the container name is optional.
.PP
Examples:
.SH OPTIONS
.PP
\fB\-f\fP, \fB\-\-follow\fP=false
Specify if the logs should be streamed.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for kubectl
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
@@ -32,12 +143,6 @@ $ kubectl log \-f 123456\-7890 ruby\-container
.RE
.SH OPTIONS
.PP
\fB\-f\fP, \fB\-\-follow\fP=false
Specify if the logs should be streamed.
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,

106
docs/man/man1/kubectl-namespace.1
View File

@@ -19,6 +19,112 @@ SUPERCEDED: Set and view the current Kubernetes namespace scope for command lin
namespace has been superceded by the context.namespace field of .kubeconfig files. See 'kubectl config set\-context \-\-help' for more details.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for kubectl
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,

129
docs/man/man1/kubectl-port-forward.1
View File

@@ -14,15 +14,128 @@ kubectl port\-forward \- Forward 1 or more local ports to a pod.
.SH DESCRIPTION
.PP
Forward 1 or more local ports to a pod.
Examples:
$ kubectl port\-forward \-p mypod 5000 6000
<listens on ports 5000 and 6000 locally, forwarding data to/from ports 5000
and 6000 in the pod>
.SH OPTIONS
.PP
\fB\-p\fP, \fB\-\-pod\fP=""
Pod name
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for kubectl
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
$ kubectl port\-forward \-p mypod 5000 6000
<listens on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod>
$ kubectl port\-forward \-p mypod 8888:5000
<listens on port 8888 locally, forwarding to 5000 in the pod>
@@ -30,18 +143,12 @@ $ kubectl port\-forward \-p mypod :5000
<listens on a random port locally, forwarding to 5000 in the pod>
$ kubectl port\-forward \-p mypod 0:5000
<listens on a random port locally, forwarding to 5000 in the pod>
<listens on a random port locally, forwarding to 5000 in the pod>
.fi
.RE
.SH OPTIONS
.PP
\fB\-p\fP, \fB\-\-pod\fP=""
Pod name
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,

106
docs/man/man1/kubectl-proxy.1
View File

@@ -34,6 +34,112 @@ Run a proxy to the Kubernetes API server.
Prefix to serve static files under, if static file directory is specified.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for kubectl
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,

137
docs/man/man1/kubectl-resize.1
View File

@@ -21,22 +21,6 @@ If \-\-current\-replicas or \-\-resource\-version is specified, it is validated
resize is attempted, and it is guaranteed that the precondition holds true when the
resize is sent to the server.
.PP
Examples:
.PP
.RS
.nf
// Resize replication controller named 'foo' to 3.
$ kubectl resize \-\-replicas=3 replicationcontrollers foo
// If the replication controller named foo's current size is 2, resize foo to 3.
$ kubectl resize \-\-current\-replicas=2 \-\-replicas=3 replicationcontrollers foo
.fi
.RE
.SH OPTIONS
.PP
@@ -52,6 +36,127 @@ $ kubectl resize \-\-current\-replicas=2 \-\-replicas=3 replicationcontrollers f
Precondition for resource version. Requires that the current resource version match this value in order to resize.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for kubectl
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Resize replication controller named 'foo' to 3.
$ kubectl resize \-\-replicas=3 replicationcontrollers foo
// If the replication controller named foo's current size is 2, resize foo to 3.
$ kubectl resize \-\-current\-replicas=2 \-\-replicas=3 replicationcontrollers foo
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,

137
docs/man/man1/kubectl-rollingupdate.1
View File

@@ -20,22 +20,6 @@ Replaces the specified controller with new controller, updating one pod at a tim
new PodTemplate. The new\-controller.json must specify the same namespace as the
existing controller and overwrite at least one (common) label in its replicaSelector.
.PP
Examples:
.PP
.RS
.nf
// Update pods of frontend\-v1 using new controller data in frontend\-v2.json.
$ kubectl rollingupdate frontend\-v1 \-f frontend\-v2.json
// Update pods of frontend\-v1 using JSON data passed into stdin.
$ cat frontend\-v2.json | kubectl rollingupdate frontend\-v1 \-f \-
.fi
.RE
.SH OPTIONS
.PP
@@ -55,6 +39,127 @@ $ cat frontend\-v2.json | kubectl rollingupdate frontend\-v1 \-f \-
Time to wait between updating pods. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for kubectl
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Update pods of frontend\-v1 using new controller data in frontend\-v2.json.
$ kubectl rollingupdate frontend\-v1 \-f frontend\-v2.json
// Update pods of frontend\-v1 using JSON data passed into stdin.
$ cat frontend\-v2.json | kubectl rollingupdate frontend\-v1 \-f \-
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,

149
docs/man/man1/kubectl-run-container.1
View File

@@ -16,28 +16,6 @@ kubectl run\-container \- Run a particular image on the cluster.
Create and run a particular image, possibly replicated.
Creates a replication controller to manage the created container(s).
.PP
Examples:
.PP
.RS
.nf
// Starts a single instance of nginx.
$ kubectl run\-container nginx \-\-image=dockerfile/nginx
// Starts a replicated instance of nginx.
$ kubectl run\-container nginx \-\-image=dockerfile/nginx \-\-replicas=5
// Dry run. Print the corresponding API objects without creating them.
$ kubectl run\-container nginx \-\-image=dockerfile/nginx \-\-dry\-run
// Start a single instance of nginx, but overload the desired state with a partial set of values parsed from JSON.
$ kubectl run\-container nginx \-\-image=dockerfile/nginx \-\-overrides='\{ "apiVersion": "v1beta1", "desiredState": \{ ... \} \}'
.fi
.RE
.SH OPTIONS
.PP
@@ -86,6 +64,133 @@ $ kubectl run\-container nginx \-\-image=dockerfile/nginx \-\-overrides='\{ "api
\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for kubectl
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
.nf
// Starts a single instance of nginx.
$ kubectl run\-container nginx \-\-image=dockerfile/nginx
// Starts a replicated instance of nginx.
$ kubectl run\-container nginx \-\-image=dockerfile/nginx \-\-replicas=5
// Dry run. Print the corresponding API objects without creating them.
$ kubectl run\-container nginx \-\-image=dockerfile/nginx \-\-dry\-run
// Start a single instance of nginx, but overload the desired state with a partial set of values parsed from JSON.
$ kubectl run\-container nginx \-\-image=dockerfile/nginx \-\-overrides='\{ "apiVersion": "v1beta1", "desiredState": \{ ... \} \}'
.fi
.RE
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,

121
docs/man/man1/kubectl-stop.1
View File

@@ -19,9 +19,120 @@ Gracefully shut down a resource by id or filename.
Attempts to shut down and delete a resource that supports graceful termination.
If the resource is resizable it will be resized to 0 before deletion.
.PP
Examples:
.SH OPTIONS
.PP
\fB\-f\fP, \fB\-\-filename\fP=[]
Filename, directory, or URL to file of resource(s) to be stopped
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for kubectl
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
@@ -39,12 +150,6 @@ $ kubectl stop \-f path/to/resources
.RE
.SH OPTIONS
.PP
\fB\-f\fP, \fB\-\-filename\fP=[]
Filename, directory, or URL to file of resource(s) to be stopped
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,

129
docs/man/man1/kubectl-update.1
View File

@@ -18,9 +18,124 @@ Update a resource by filename or stdin.
.PP
JSON and YAML formats are accepted.
.PP
Examples:
.SH OPTIONS
.PP
\fB\-f\fP, \fB\-\-filename\fP=[]
Filename, directory, or URL to file to use to update the resource.
.PP
\fB\-\-patch\fP=""
A JSON document to override the existing resource. The resource is downloaded, patched with the JSON, then updated.
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for kubectl
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH EXAMPLE
.PP
.RS
@@ -38,16 +153,6 @@ $ kubectl update pods my\-pod \-\-patch='\{ "apiVersion": "v1beta1", "desiredSta
.RE
.SH OPTIONS
.PP
\fB\-f\fP, \fB\-\-filename\fP=[]
Filename, directory, or URL to file to use to update the resource.
.PP
\fB\-\-patch\fP=""
A JSON document to override the existing resource. The resource is downloaded, patched with the JSON, then updated.
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,

106
docs/man/man1/kubectl-version.1
View File

@@ -22,6 +22,112 @@ Print the client and server version information.
Client version only (no server required).
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-a\fP, \fB\-\-auth\-path\fP=""
Path to the auth info file. If missing, prompt the user. Only used if using https.
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for kubectl
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.PP
\fB\-\-log\_backtrace\_at\fP=:0
when logging hits line file:N, emit a stack trace
.PP
\fB\-\-log\_dir\fP=""
If non\-empty, write log files in this directory
.PP
\fB\-\-log\_flush\_frequency\fP=5s
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-validate\fP=false
If true, use a schema to validate the input before sending it
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,