mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-08-05 10:19:50 +00:00
Cleanup
This commit is contained in:
MikeJeffrey
parent
5eda48dc5d
commit
02666f0324
84
docs/cli.md
84
docs/cli.md
@ -1,9 +1,11 @@
|
||||
## kubecfg command line interface
|
||||
The `kubecfg` command line tools is used to interact with the Kubernetes HTTP API.
|
||||
|
||||
* [ReplicationController Commands](#replication-controller-commands)
|
||||
* [RESTful Commands](#restful-commands)
|
||||
* [Complete Details](#details)
|
||||
* [ReplicationController Commands](#replication-controller-commands)
|
||||
* [RESTful Commands](#restful-commands)
|
||||
* [Complete Details](#details)
|
||||
* [Usage](#usage)
|
||||
* [Options](#options)
|
||||
|
||||
### Replication Controller Commands
|
||||
|
||||
@ -12,7 +14,12 @@ The `kubecfg` command line tools is used to interact with the Kubernetes HTTP AP
|
||||
kubecfg [options] run <image> <replicas> <controller-name>
|
||||
```
|
||||
|
||||
This command creates a Kuberenetes ReplicaController object which creates `<replicas>` copies of the container named by `<image>`, the newly created ReplicaController is named `<controller-name>`
|
||||
Creates a Kubernetes ReplicaController object.
|
||||
|
||||
* `[options]` are described in the [Options](#options) section.
|
||||
* `<image>` is the Docker image to use.
|
||||
* `<replicas>` is the number of replicas of the container to create.
|
||||
* `<controller-name>` is the name to assign to this new ReplicaController.
|
||||
|
||||
##### Example
|
||||
|
||||
@ -27,6 +34,9 @@ kubecfg [options] resize <controller-name> <new-size>
|
||||
|
||||
Changes the desired number of replicas, causing replicas to be created or deleted.
|
||||
|
||||
* `[options]` are described in the [Options](#options) section.
|
||||
|
||||
|
||||
##### Example
|
||||
```
|
||||
kubecfg resize myNginxController 3
|
||||
@ -37,17 +47,22 @@ kubecfg resize myNginxController 3
|
||||
kubecfg [options] stop <controller-name>
|
||||
```
|
||||
|
||||
Stops a controller by setting its desired size to zero. Syntactic sugar on top of resize.
|
||||
Stops a controller by setting its desired size to zero. Syntactic sugar on top of resize.
|
||||
|
||||
* `[options]` are described in the [Options](#options) section.
|
||||
|
||||
#### Remove
|
||||
```
|
||||
kubecfg [options] rm <controller-name>
|
||||
```
|
||||
|
||||
Delete a replication controller. Only works if the desired size of the controller is zero.
|
||||
Delete a replication controller. The desired size of the controller must be zero, by
|
||||
calling either `kubecfg resize <controller-name> 0` or `kubecfg stop <controller-name>`.
|
||||
|
||||
* `[options]` are described in the [Options](#options) section.
|
||||
|
||||
### RESTful Commands
|
||||
Kubecfg also supports raw access to the basic restful requests. There are four different resources you can acccess:
|
||||
Kubecfg also supports raw access to the basic restful requests. There are four different resources you can acccess:
|
||||
|
||||
* `pods`
|
||||
* `replicationControllers`
|
||||
@ -55,6 +70,7 @@ Kubecfg also supports raw access to the basic restful requests. There are four
|
||||
* `minions`
|
||||
|
||||
###### Common Flags
|
||||
|
||||
* -yaml : output in YAML format
|
||||
* -json : output in JSON format
|
||||
* -c <config-file> : Accept a file in JSON or YAML for POST/PUT
|
||||
@ -98,8 +114,10 @@ kubecfg [options] delete pods/pod-abc-123
|
||||
|
||||
|
||||
### Details
|
||||
|
||||
#### Usage
|
||||
```
|
||||
usage: kubecfg -h [-c config/file.json] [-p :,..., :] <method>
|
||||
kubecfg -h [-c config/file.json] [-p :,..., :] <method>
|
||||
|
||||
Kubernetes REST API:
|
||||
kubecfg [OPTIONS] get|list|create|delete|update <minions|pods|replicationControllers|services>[/<id>]
|
||||
@ -108,30 +126,30 @@ usage: kubecfg -h [-c config/file.json] [-p :,..., :] <method>
|
||||
kubecfg [OPTIONS] stop|rm|rollingupdate <controller>
|
||||
kubecfg [OPTIONS] run <image> <replicas> <controller>
|
||||
kubecfg [OPTIONS] resize <controller> <replicas>
|
||||
|
||||
Options:
|
||||
-V=false: Print the version number.
|
||||
-alsologtostderr=false: log to standard error as well as files
|
||||
-auth="/Users/bburns/.kubernetes_auth": Path to the auth info file. If missing, prompt the user. Only used if doing https.
|
||||
-c="": Path to the config file.
|
||||
-h="": The host to connect to.
|
||||
-json=false: If true, print raw JSON for responses
|
||||
-l="": Selector (label query) to use for listing
|
||||
-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=false: log to standard error instead of files
|
||||
-p="": The port spec, comma-separated list of <external>:<internal>,...
|
||||
-proxy=false: If true, run a proxy to the api server
|
||||
-s=-1: If positive, create and run a corresponding service on this port, only used with 'run'
|
||||
-stderrthreshold=0: logs at or above this threshold go to stderr
|
||||
-template="": If present, parse this string as a golang template and use it for output printing
|
||||
-template_file="": If present, load this file as a golang template and use it for output printing
|
||||
-u=1m0s: Update interval period
|
||||
-v=0: log level for V logs
|
||||
-verbose=false: If true, print extra information
|
||||
-vmodule=: comma-separated list of pattern=N settings for file-filtered logging
|
||||
-www="": If -proxy is true, use this directory to serve static files
|
||||
-yaml=false: If true, print raw YAML for responses
|
||||
```
|
||||
|
||||
#### Options
|
||||
|
||||
* `-V=true|false`: Print the version number.
|
||||
* `-alsologtostderr=true|false`: log to standard error as well as files
|
||||
* `-auth="/path/to/.kubernetes_auth"`: Path to the auth info file. Only used if doing https.
|
||||
* `-c="/path/to/config_file"`: Path to the config file.
|
||||
* `-h=""`: The host to connect to.
|
||||
* `-json=true|false`: If true, print raw JSON for responses
|
||||
* `-l=""`: Selector (label query) to use for listing
|
||||
* `-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|false`: log to standard error instead of files
|
||||
* `-p=""`: The port spec, comma-separated list of `<external>:<internal>,...`
|
||||
* `-proxy=true|false`: If true, run a proxy to the API server
|
||||
* `-s=-1`: If positive, create and run a corresponding service on this port, only used with 'run'
|
||||
* `-stderrthreshold=0`: logs at or above this threshold go to stderr
|
||||
* `-template=""`: If present, parse this string as a golang template and use it for output printing
|
||||
* `-template_file=""`: If present, load this file as a golang template and use it for output printing
|
||||
* `-u=1m0s`: Update interval period
|
||||
* `-v=0`: log level for V logs
|
||||
* `-verbose=true|false`: If true, print extra information
|
||||
* `-vmodule=""`: comma-separated list of pattern=N settings for file-filtered logging
|
||||
* `-www=""`: If -proxy is true, use this directory to serve static files
|
||||
* `-yaml=true|false`: If true, print raw YAML for responses
|
||||
|
||||
Loading…
Reference in New Issue
Block a user