github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Make naming of kubectl subcommands consistent

Browse Source
This commit is contained in:
Sam Ghods
2015-03-27 16:24:59 -07:00
parent 620af16892
commit ca18e86877
22 changed files with 235 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/cli-roadmap.md
View File

@@ -11,7 +11,7 @@ See also issues with the following labels:
1. Service address/port lookup command(s)
1. Finish rolling update [#1353](https://github.com/GoogleCloudPlatform/kubernetes/issues/1353)
1. Friendly to auto-scaling [#2863](https://github.com/GoogleCloudPlatform/kubernetes/pull/2863#issuecomment-69701562)
1. Rollback (make rollingupdate reversible, and complete an in-progress rolling update by taking 2 replication controller names rather than always taking a file)
1. Rollback (make rolling-update reversible, and complete an in-progress rolling update by taking 2 replication controller names rather than always taking a file)
1. Rollover (replace multiple replication controllers with one, such as to clean up an aborted partial rollout)
1. Write a ReplicationController generator to derive the new ReplicationController from an old one (e.g., `--image-version=newversion`, which would apply a name suffix, update a label value, and apply an image tag)
1. Use readiness [#620](https://github.com/GoogleCloudPlatform/kubernetes/issues/620)

52
docs/kubectl-api-versions.md Normal file
View File

@@ -0,0 +1,52 @@
## kubectl api-versions
Print available API versions.
### Synopsis
Print available API versions.
```
kubectl api-versions
```
### Options
```
-h, --help=false: help for api-versions
```
### Options inherrited from parent commands
```
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
--log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
--log_dir=: If non-empty, write log files in this directory
--log_flush_frequency=5s: Maximum number of seconds between log flushes
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
--password="": Password for basic authentication to the API server.
-s, --server="": The address and port of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use
--username="": Username for basic authentication to the API server.
--v=0: log level for V logs
--validate=false: If true, use a schema to validate the input before sending it
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kubectl](kubectl.md)

6
docs/kubectl-apiversions.md
View File

@@ -1,4 +1,4 @@
## kubectl apiversions
## kubectl api-versions
Print available API versions.
@@ -8,13 +8,13 @@ Print available API versions.
Print available API versions.
```
kubectl apiversions
kubectl api-versions
```
### Options
```
-h, --help=false: help for apiversions
-h, --help=false: help for api-versions
```
### Options inherrited from parent commands

52
docs/kubectl-cluster-info.md Normal file
View File

@@ -0,0 +1,52 @@
## kubectl cluster-info
Display cluster info
### Synopsis
Display addresses of the master and services with label kubernetes.io/cluster-service=true
```
kubectl cluster-info
```
### Options
```
-h, --help=false: help for cluster-info
```
### Options inherrited from parent commands
```
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
--log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
--log_dir=: If non-empty, write log files in this directory
--log_flush_frequency=5s: Maximum number of seconds between log flushes
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
--password="": Password for basic authentication to the API server.
-s, --server="": The address and port of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use
--username="": Username for basic authentication to the API server.
--v=0: log level for V logs
--validate=false: If true, use a schema to validate the input before sending it
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kubectl](kubectl.md)

6
docs/kubectl-clusterinfo.md
View File

@@ -1,4 +1,4 @@
## kubectl clusterinfo
## kubectl cluster-info
Display cluster info
@@ -8,13 +8,13 @@ Display cluster info
Display addresses of the master and services with label kubernetes.io/cluster-service=true
```
kubectl clusterinfo
kubectl cluster-info
```
### Options
```
-h, --help=false: help for clusterinfo
-h, --help=false: help for cluster-info
```
### Options inherrited from parent commands

10
docs/kubectl-rollingupdate.md → docs/kubectl-rolling-update.md
View File

@@ -1,4 +1,4 @@
## kubectl rollingupdate
## kubectl rolling-update
Perform a rolling update of the given ReplicationController.
@@ -12,24 +12,24 @@ 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.
```
kubectl rollingupdate OLD_CONTROLLER_NAME -f NEW_CONTROLLER_SPEC
kubectl rolling-update OLD_CONTROLLER_NAME -f NEW_CONTROLLER_SPEC
```
### Examples
```
// Update pods of frontend-v1 using new controller data in frontend-v2.json.
$ kubectl rollingupdate frontend-v1 -f frontend-v2.json
$ kubectl rolling-update frontend-v1 -f frontend-v2.json
// Update pods of frontend-v1 using JSON data passed into stdin.
$ cat frontend-v2.json | kubectl rollingupdate frontend-v1 -f -
$ cat frontend-v2.json | kubectl rolling-update frontend-v1 -f -
```
### Options
```
-f, --filename="": Filename or URL to file to use to create the new controller.
-h, --help=false: help for rollingupdate
-h, --help=false: help for rolling-update
--poll-interval="3s": Time delay between polling controller status after update. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
--timeout="5m0s": Max time to wait for a controller to update before giving up. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
--update-period="1m0s": Time to wait between updating pods. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".

6
docs/kubectl.md
View File

@@ -52,7 +52,7 @@ kubectl
* [kubectl-delete](kubectl-delete.md)
* [kubectl-namespace](kubectl-namespace.md)
* [kubectl-log](kubectl-log.md)
* [kubectl-rollingupdate](kubectl-rollingupdate.md)
* [kubectl-rolling-update](kubectl-rolling-update.md)
* [kubectl-resize](kubectl-resize.md)
* [kubectl-exec](kubectl-exec.md)
* [kubectl-port-forward](kubectl-port-forward.md)
@@ -62,7 +62,7 @@ kubectl
* [kubectl-expose](kubectl-expose.md)
* [kubectl-label](kubectl-label.md)
* [kubectl-config](kubectl-config.md)
* [kubectl-clusterinfo](kubectl-clusterinfo.md)
* [kubectl-apiversions](kubectl-apiversions.md)
* [kubectl-cluster-info](kubectl-cluster-info.md)
* [kubectl-api-versions](kubectl-api-versions.md)
* [kubectl-version](kubectl-version.md)

6
docs/man/man1/kubectl-apiversions.1 → docs/man/man1/kubectl-api-versions.1
View File

@@ -3,12 +3,12 @@
.SH NAME
.PP
kubectl apiversions \- Print available API versions.
kubectl api\-versions \- Print available API versions.
.SH SYNOPSIS
.PP
\fBkubectl apiversions\fP [OPTIONS]
\fBkubectl api\-versions\fP [OPTIONS]
.SH DESCRIPTION
@@ -19,7 +19,7 @@ Print available API versions.
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for apiversions
help for api\-versions
.SH OPTIONS INHERITED FROM PARENT COMMANDS

6
docs/man/man1/kubectl-clusterinfo.1 → docs/man/man1/kubectl-cluster-info.1
View File

@@ -3,12 +3,12 @@
.SH NAME
.PP
kubectl clusterinfo \- Display cluster info
kubectl cluster\-info \- Display cluster info
.SH SYNOPSIS
.PP
\fBkubectl clusterinfo\fP [OPTIONS]
\fBkubectl cluster\-info\fP [OPTIONS]
.SH DESCRIPTION
@@ -19,7 +19,7 @@ Display addresses of the master and services with label kubernetes.io/cluster\-s
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for clusterinfo
help for cluster\-info
.SH OPTIONS INHERITED FROM PARENT COMMANDS

10
docs/man/man1/kubectl-rollingupdate.1 → docs/man/man1/kubectl-rolling-update.1
View File

@@ -3,12 +3,12 @@
.SH NAME
.PP
kubectl rollingupdate \- Perform a rolling update of the given ReplicationController.
kubectl rolling\-update \- Perform a rolling update of the given ReplicationController.
.SH SYNOPSIS
.PP
\fBkubectl rollingupdate\fP [OPTIONS]
\fBkubectl rolling\-update\fP [OPTIONS]
.SH DESCRIPTION
@@ -28,7 +28,7 @@ existing controller and overwrite at least one (common) label in its replicaSele
.PP
\fB\-h\fP, \fB\-\-help\fP=false
help for rollingupdate
help for rolling\-update
.PP
\fB\-\-poll\-interval\fP="3s"
@@ -151,10 +151,10 @@ existing controller and overwrite at least one (common) label in its replicaSele
.nf
// Update pods of frontend\-v1 using new controller data in frontend\-v2.json.
$ kubectl rollingupdate frontend\-v1 \-f frontend\-v2.json
$ kubectl rolling\-update frontend\-v1 \-f frontend\-v2.json
// Update pods of frontend\-v1 using JSON data passed into stdin.
$ cat frontend\-v2.json | kubectl rollingupdate frontend\-v1 \-f \-
$ cat frontend\-v2.json | kubectl rolling\-update frontend\-v1 \-f \-
.fi
.RE

2
docs/man/man1/kubectl.1
View File

@@ -128,7 +128,7 @@ Find more information at
.SH SEE ALSO
.PP
\fBkubectl\-get(1)\fP, \fBkubectl\-describe(1)\fP, \fBkubectl\-create(1)\fP, \fBkubectl\-update(1)\fP, \fBkubectl\-delete(1)\fP, \fBkubectl\-namespace(1)\fP, \fBkubectl\-log(1)\fP, \fBkubectl\-rollingupdate(1)\fP, \fBkubectl\-resize(1)\fP, \fBkubectl\-exec(1)\fP, \fBkubectl\-port\-forward(1)\fP, \fBkubectl\-proxy(1)\fP, \fBkubectl\-run\-container(1)\fP, \fBkubectl\-stop(1)\fP, \fBkubectl\-expose(1)\fP, \fBkubectl\-label(1)\fP, \fBkubectl\-config(1)\fP, \fBkubectl\-clusterinfo(1)\fP, \fBkubectl\-apiversions(1)\fP, \fBkubectl\-version(1)\fP,
\fBkubectl\-get(1)\fP, \fBkubectl\-describe(1)\fP, \fBkubectl\-create(1)\fP, \fBkubectl\-update(1)\fP, \fBkubectl\-delete(1)\fP, \fBkubectl\-namespace(1)\fP, \fBkubectl\-log(1)\fP, \fBkubectl\-rolling\-update(1)\fP, \fBkubectl\-resize(1)\fP, \fBkubectl\-exec(1)\fP, \fBkubectl\-port\-forward(1)\fP, \fBkubectl\-proxy(1)\fP, \fBkubectl\-run\-container(1)\fP, \fBkubectl\-stop(1)\fP, \fBkubectl\-expose(1)\fP, \fBkubectl\-label(1)\fP, \fBkubectl\-config(1)\fP, \fBkubectl\-cluster\-info(1)\fP, \fBkubectl\-api\-versions(1)\fP, \fBkubectl\-version(1)\fP,
.SH HISTORY

2
docs/replication-controller.md
View File

@@ -36,7 +36,7 @@ The replication controller simply ensures that the desired number of pods matche
The replication controller is forever constrained to this narrow responsibility. It itself will not perform readiness nor liveness probes. Rather than performing auto-scaling, it is intended to be controlled by an external auto-scaler (as discussed in [#492](https://github.com/GoogleCloudPlatform/kubernetes/issues/492)), which would change its `replicas` field. We will not add scheduling policies (e.g., [spreading](https://github.com/GoogleCloudPlatform/kubernetes/issues/367#issuecomment-48428019)) to replication controller. Nor should it verify that the pods controlled match the currently specified template, as that would obstruct auto-sizing and other automated processes. Similarly, completion deadlines, ordering dependencies, configuration expansion, and other features belong elsewhere. We even plan to factor out the mechanism for bulk pod creation ([#170](https://github.com/GoogleCloudPlatform/kubernetes/issues/170)).
The replication controller is intended to be a composable building-block primitive. We expect higher-level APIs and/or tools to be built on top of it and other complementary primitives for user convenience in the future. The "macro" operations currently supported by kubectl (run-container, stop, resize, rollingupdate) are proof-of-concept examples of this. For instance, we could imagine something like [Asgard](http://techblog.netflix.com/2012/06/asgard-web-based-cloud-management-and.html) managing replication controllers, auto-scalers, services, scheduling policies, canaries, etc.
The replication controller is intended to be a composable building-block primitive. We expect higher-level APIs and/or tools to be built on top of it and other complementary primitives for user convenience in the future. The "macro" operations currently supported by kubectl (run-container, stop, resize, rolling-update) are proof-of-concept examples of this. For instance, we could imagine something like [Asgard](http://techblog.netflix.com/2012/06/asgard-web-based-cloud-management-and.html) managing replication controllers, auto-scalers, services, scheduling policies, canaries, etc.
## Common usage patterns