mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-07-31 15:25:57 +00:00
Merge pull request #3722 from bgrant0607/docfix
Update docs to refer to kubectl rather than kubecfg. Remove cli.md.
This commit is contained in:
Tim Hockin
commit
bc01148286
@ -46,8 +46,8 @@ Design docs are in [design](design).
|
||||
* **Kubernetes Web Interface** ([ui.md](ui.md)): Accessing the Kubernetes
|
||||
web user interface.
|
||||
|
||||
* **Kubecfg Command Line Interface** ([cli.md](cli.md)):
|
||||
The `kubecfg` command line reference.
|
||||
* **Kubectl Command Line Interface** ([kubectl.md](kubectl.md)):
|
||||
The `kubectl` command line reference.
|
||||
|
||||
* **Roadmap** ([roadmap.md](roadmap.md)): The set of supported use cases, features,
|
||||
docs, and patterns that are required before Kubernetes 1.0.
|
||||
|
||||
161
docs/cli.md
161
docs/cli.md
@ -1,161 +0,0 @@
|
||||
## kubectl
|
||||
The ```kubectl``` command provides command line access to the kubernetes API.
|
||||
|
||||
See [kubectl documentation](kubectl.md) for details.
|
||||
|
||||
## kubecfg is deprecated. Please use kubectl!
|
||||
## 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)
|
||||
* [Usage](#usage)
|
||||
* [Options](#options)
|
||||
|
||||
### Replication Controller Commands
|
||||
|
||||
#### Run
|
||||
```
|
||||
kubecfg [options] run <image> <replicas> <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
|
||||
|
||||
```
|
||||
kubecfg -p 8080:80 run dockerfile/nginx 2 myNginxController
|
||||
```
|
||||
|
||||
#### Resize
|
||||
```
|
||||
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
|
||||
```
|
||||
|
||||
#### Stop
|
||||
```
|
||||
kubecfg [options] stop <controller-name>
|
||||
```
|
||||
|
||||
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. 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:
|
||||
|
||||
* `pods`
|
||||
* `replicationControllers`
|
||||
* `services`
|
||||
* `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
|
||||
|
||||
#### Commands
|
||||
|
||||
##### get
|
||||
Raw access to a RESTful GET request.
|
||||
|
||||
```
|
||||
kubecfg [options] get pods/pod-abc-123
|
||||
```
|
||||
|
||||
##### list
|
||||
Raw access to a RESTful LIST request.
|
||||
|
||||
```
|
||||
kubecfg [options] list pods
|
||||
```
|
||||
|
||||
##### create
|
||||
Raw access to a RESTful POST request.
|
||||
|
||||
```
|
||||
kubecfg <-c some/body.[json|yaml]> [options] create pods
|
||||
```
|
||||
|
||||
##### update
|
||||
Raw access to a RESTful PUT request.
|
||||
|
||||
```
|
||||
kubecfg <-c some/body.[json|yaml]> [options] update pods/pod-abc-123
|
||||
```
|
||||
|
||||
##### delete
|
||||
Raw access to a RESTful DELETE request.
|
||||
|
||||
```
|
||||
kubecfg [options] delete pods/pod-abc-123
|
||||
```
|
||||
|
||||
|
||||
### Details
|
||||
|
||||
#### Usage
|
||||
```
|
||||
kubecfg -h [-c config/file.json] [-p :,..., :] <method>
|
||||
|
||||
Kubernetes REST API:
|
||||
kubecfg [OPTIONS] get|list|create|delete|update <minions|pods|replicationControllers|services>[/<id>]
|
||||
|
||||
Manage replication controllers:
|
||||
kubecfg [OPTIONS] stop|rm|rollingupdate <controller>
|
||||
kubecfg [OPTIONS] run <image> <replicas> <controller>
|
||||
kubecfg [OPTIONS] resize <controller> <replicas>
|
||||
```
|
||||
|
||||
#### 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. See [Logging Conventions](devel/logging.md) for details
|
||||
* `-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
|
||||
@ -19,7 +19,7 @@ Other details:
|
||||
|
||||
* [API](api-conventions.md)
|
||||
* [Client libraries](client-libraries.md)
|
||||
* [Command-line interface](cli.md)
|
||||
* [Command-line interface](kubectl.md)
|
||||
* [UI](ux.md)
|
||||
* [Images and registries](images.md)
|
||||
* [Container environment](container-environment.md)
|
||||
|
||||
@ -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 elsehwere. 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 kubecfg (run, 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, 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.
|
||||
|
||||
## Common usage patterns
|
||||
|
||||
|
||||
@ -7,7 +7,7 @@ Kubernetes currently supports a simple web user interface.
|
||||
Start the server:
|
||||
|
||||
```sh
|
||||
cluster/kubecfg.sh -proxy -www $PWD/www
|
||||
cluster/kubectl.sh proxy -www=$PWD/www
|
||||
```
|
||||
|
||||
The UI should now be running on [localhost](http://localhost:8001/static/index.html#/groups//selector)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user