279 lines
10 KiB
Markdown
279 lines
10 KiB
Markdown
---
|
||
approvers:
|
||
- bgrant0607
|
||
- brendandburns
|
||
- thockin
|
||
title: kubectl for Docker Users
|
||
---
|
||
|
||
In this doc, we introduce the Kubernetes command line for interacting with the api to docker-cli users. The tool, kubectl, is designed to be familiar to docker-cli users but there are a few necessary differences. Each section of this doc highlights a docker subcommand explains the kubectl equivalent.
|
||
|
||
* TOC
|
||
{:toc}
|
||
|
||
#### docker run
|
||
|
||
How do I run an nginx Deployment and expose it to the world? Checkout [kubectl run](/docs/user-guide/kubectl/{{page.version}}/#run).
|
||
|
||
With docker:
|
||
|
||
```shell
|
||
$ docker run -d --restart=always -e DOMAIN=cluster --name nginx-app -p 80:80 nginx
|
||
a9ec34d9878748d2f33dc20cb25c714ff21da8d40558b45bfaec9955859075d0
|
||
$ docker ps
|
||
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
||
a9ec34d98787 nginx "nginx -g 'daemon of 2 seconds ago Up 2 seconds 0.0.0.0:80->80/tcp, 443/tcp nginx-app
|
||
```
|
||
|
||
With kubectl:
|
||
|
||
```shell
|
||
# start the pod running nginx
|
||
$ kubectl run --image=nginx nginx-app --port=80 --env="DOMAIN=cluster"
|
||
deployment "nginx-app" created
|
||
```
|
||
|
||
`kubectl run` creates a Deployment named "nginx-app" on Kubernetes cluster >= v1.2. If you are running older versions, it creates replication controllers instead.
|
||
If you want to obtain the old behavior, use `--generator=run/v1` to create replication controllers. See [`kubectl run`](/docs/user-guide/kubectl/{{page.version}}/#run) for more details.
|
||
Note that `kubectl` commands will print the type and name of the resource created or mutated, which can then be used in subsequent commands. Now, we can expose a new Service with the deployment created above:
|
||
|
||
```shell
|
||
# expose a port through with a service
|
||
$ kubectl expose deployment nginx-app --port=80 --name=nginx-http
|
||
service "nginx-http" exposed
|
||
```
|
||
|
||
With kubectl, we create a [Deployment](/docs/concepts/workloads/controllers/deployment/) which will make sure that N pods are running nginx (where N is the number of replicas stated in the spec, which defaults to 1). We also create a [service](/docs/user-guide/services) with a selector that matches the Deployment's selector. See the [Quick start](/docs/user-guide/quick-start) for more information.
|
||
|
||
By default images are run in the background, similar to `docker run -d ...`, if you want to run things in the foreground, use:
|
||
|
||
```shell
|
||
kubectl run [-i] [--tty] --attach <name> --image=<image>
|
||
```
|
||
|
||
Unlike `docker run ...`, if `--attach` is specified, we attach to `stdin`, `stdout` and `stderr`, there is no ability to control which streams are attached (`docker -a ...`).
|
||
|
||
Because we start a Deployment for your container, it will be restarted if you terminate the attached process (e.g. `ctrl-c`), this is different from `docker run -it`.
|
||
To destroy the Deployment (and its pods) you need to run `kubectl delete deployment <name>`.
|
||
|
||
#### docker ps
|
||
|
||
How do I list what is currently running? Checkout [kubectl get](/docs/user-guide/kubectl/{{page.version}}/#get).
|
||
|
||
With docker:
|
||
|
||
```shell
|
||
$ docker ps
|
||
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
||
a9ec34d98787 nginx "nginx -g 'daemon of About an hour ago Up About an hour 0.0.0.0:80->80/tcp, 443/tcp nginx-app
|
||
```
|
||
|
||
With kubectl:
|
||
|
||
```shell
|
||
$ kubectl get po
|
||
NAME READY STATUS RESTARTS AGE
|
||
nginx-app-5jyvm 1/1 Running 0 1h
|
||
```
|
||
|
||
#### docker attach
|
||
|
||
How do I attach to a process that is already running in a container? Checkout [kubectl attach](/docs/user-guide/kubectl/{{page.version}}/#attach).
|
||
|
||
With docker:
|
||
|
||
```shell
|
||
$ docker ps
|
||
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
||
a9ec34d98787 nginx "nginx -g 'daemon of 8 minutes ago Up 8 minutes 0.0.0.0:80->80/tcp, 443/tcp nginx-app
|
||
$ docker attach a9ec34d98787
|
||
...
|
||
```
|
||
|
||
With kubectl:
|
||
|
||
```shell
|
||
$ kubectl get pods
|
||
NAME READY STATUS RESTARTS AGE
|
||
nginx-app-5jyvm 1/1 Running 0 10m
|
||
$ kubectl attach -it nginx-app-5jyvm
|
||
...
|
||
```
|
||
|
||
#### docker exec
|
||
|
||
How do I execute a command in a container? Checkout [kubectl exec](/docs/user-guide/kubectl/{{page.version}}/#exec).
|
||
|
||
With docker:
|
||
|
||
```shell
|
||
$ docker ps
|
||
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
||
a9ec34d98787 nginx "nginx -g 'daemon of 8 minutes ago Up 8 minutes 0.0.0.0:80->80/tcp, 443/tcp nginx-app
|
||
$ docker exec a9ec34d98787 cat /etc/hostname
|
||
a9ec34d98787
|
||
```
|
||
|
||
With kubectl:
|
||
|
||
```shell
|
||
$ kubectl get po
|
||
NAME READY STATUS RESTARTS AGE
|
||
nginx-app-5jyvm 1/1 Running 0 10m
|
||
$ kubectl exec nginx-app-5jyvm -- cat /etc/hostname
|
||
nginx-app-5jyvm
|
||
```
|
||
|
||
What about interactive commands?
|
||
|
||
|
||
With docker:
|
||
|
||
```shell
|
||
$ docker exec -ti a9ec34d98787 /bin/sh
|
||
# exit
|
||
```
|
||
|
||
With kubectl:
|
||
|
||
```shell
|
||
$ kubectl exec -ti nginx-app-5jyvm -- /bin/sh
|
||
# exit
|
||
```
|
||
|
||
For more information see [Getting a Shell to a Running Container](/docs/tasks/debug-application-cluster/get-shell-running-container/).
|
||
|
||
#### docker logs
|
||
|
||
How do I follow stdout/stderr of a running process? Checkout [kubectl logs](/docs/user-guide/kubectl/{{page.version}}/#logs).
|
||
|
||
|
||
With docker:
|
||
|
||
```shell
|
||
$ docker logs -f a9e
|
||
192.168.9.1 - - [14/Jul/2015:01:04:02 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.35.0" "-"
|
||
192.168.9.1 - - [14/Jul/2015:01:04:03 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.35.0" "-"
|
||
```
|
||
|
||
With kubectl:
|
||
|
||
```shell
|
||
$ kubectl logs -f nginx-app-zibvs
|
||
10.240.63.110 - - [14/Jul/2015:01:09:01 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.26.0" "-"
|
||
10.240.63.110 - - [14/Jul/2015:01:09:02 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.26.0" "-"
|
||
```
|
||
|
||
Now's a good time to mention slight difference between pods and containers; by default pods will not terminate if their processes exit. Instead it will restart the process. This is similar to the docker run option `--restart=always` with one major difference. In docker, the output for each invocation of the process is concatenated, but for Kubernetes, each invocation is separate. To see the output from a previous run in Kubernetes, do this:
|
||
|
||
```shell
|
||
$ kubectl logs --previous nginx-app-zibvs
|
||
10.240.63.110 - - [14/Jul/2015:01:09:01 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.26.0" "-"
|
||
10.240.63.110 - - [14/Jul/2015:01:09:02 +0000] "GET / HTTP/1.1" 200 612 "-" "curl/7.26.0" "-"
|
||
```
|
||
|
||
See [Logging and Monitoring Cluster Activity](/docs/concepts/cluster-administration/logging/) for more information.
|
||
|
||
#### docker stop and docker rm
|
||
|
||
How do I stop and delete a running process? Checkout [kubectl delete](/docs/user-guide/kubectl/{{page.version}}/#delete).
|
||
|
||
With docker:
|
||
|
||
```shell
|
||
$ docker ps
|
||
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
||
a9ec34d98787 nginx "nginx -g 'daemon of 22 hours ago Up 22 hours 0.0.0.0:80->80/tcp, 443/tcp nginx-app
|
||
$ docker stop a9ec34d98787
|
||
a9ec34d98787
|
||
$ docker rm a9ec34d98787
|
||
a9ec34d98787
|
||
```
|
||
|
||
With kubectl:
|
||
|
||
```shell
|
||
$ kubectl get deployment nginx-app
|
||
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
|
||
nginx-app 1 1 1 1 2m
|
||
$ kubectl get po -l run=nginx-app
|
||
NAME READY STATUS RESTARTS AGE
|
||
nginx-app-2883164633-aklf7 1/1 Running 0 2m
|
||
$ kubectl delete deployment nginx-app
|
||
deployment "nginx-app" deleted
|
||
$ kubectl get po -l run=nginx-app
|
||
# Return nothing
|
||
```
|
||
|
||
Notice that we don't delete the pod directly. With kubectl we want to delete the Deployment that owns the pod. If we delete the pod directly, the Deployment will recreate the pod.
|
||
|
||
#### docker login
|
||
|
||
There is no direct analog of `docker login` in kubectl. If you are interested in using Kubernetes with a private registry, see [Using a Private Registry](/docs/concepts/containers/images/#using-a-private-registry).
|
||
|
||
#### docker version
|
||
|
||
How do I get the version of my client and server? Checkout [kubectl version](/docs/user-guide/kubectl/{{page.version}}/#version).
|
||
|
||
With docker:
|
||
|
||
```shell
|
||
$ docker version
|
||
Client version: 1.7.0
|
||
Client API version: 1.19
|
||
Go version (client): go1.4.2
|
||
Git commit (client): 0baf609
|
||
OS/Arch (client): linux/amd64
|
||
Server version: 1.7.0
|
||
Server API version: 1.19
|
||
Go version (server): go1.4.2
|
||
Git commit (server): 0baf609
|
||
OS/Arch (server): linux/amd64
|
||
```
|
||
|
||
With kubectl:
|
||
|
||
```shell
|
||
$ kubectl version
|
||
Client Version: version.Info{Major:"1", Minor:"6", GitVersion:"v1.6.9+a3d1dfa6f4335", GitCommit:"9b77fed11a9843ce3780f70dd251e92901c43072", GitTreeState:"dirty", BuildDate:"2017-08-29T20:32:58Z", OpenPaasKubernetesVersion:"v1.03.02", GoVersion:"go1.7.5", Compiler:"gc", Platform:"linux/amd64"}
|
||
Server Version: version.Info{Major:"1", Minor:"6", GitVersion:"v1.6.9+a3d1dfa6f4335", GitCommit:"9b77fed11a9843ce3780f70dd251e92901c43072", GitTreeState:"dirty", BuildDate:"2017-08-29T20:32:58Z", OpenPaasKubernetesVersion:"v1.03.02", GoVersion:"go1.7.5", Compiler:"gc", Platform:"linux/amd64"}
|
||
```
|
||
|
||
#### docker info
|
||
|
||
How do I get miscellaneous info about my environment and configuration? Checkout [kubectl cluster-info](/docs/user-guide/kubectl/{{page.version}}/#cluster-info).
|
||
|
||
With docker:
|
||
|
||
```shell
|
||
$ docker info
|
||
Containers: 40
|
||
Images: 168
|
||
Storage Driver: aufs
|
||
Root Dir: /usr/local/google/docker/aufs
|
||
Backing Filesystem: extfs
|
||
Dirs: 248
|
||
Dirperm1 Supported: false
|
||
Execution Driver: native-0.2
|
||
Logging Driver: json-file
|
||
Kernel Version: 3.13.0-53-generic
|
||
Operating System: Ubuntu 14.04.2 LTS
|
||
CPUs: 12
|
||
Total Memory: 31.32 GiB
|
||
Name: k8s-is-fun.mtv.corp.google.com
|
||
ID: ADUV:GCYR:B3VJ:HMPO:LNPQ:KD5S:YKFQ:76VN:IANZ:7TFV:ZBF4:BYJO
|
||
WARNING: No swap limit support
|
||
```
|
||
|
||
With kubectl:
|
||
|
||
```shell
|
||
$ kubectl cluster-info
|
||
Kubernetes master is running at https://108.59.85.141
|
||
KubeDNS is running at https://108.59.85.141/api/v1/namespaces/kube-system/services/kube-dns/proxy
|
||
KubeUI is running at https://108.59.85.141/api/v1/namespaces/kube-system/services/kube-ui/proxy
|
||
Grafana is running at https://108.59.85.141/api/v1/namespaces/kube-system/services/monitoring-grafana/proxy
|
||
Heapster is running at https://108.59.85.141/api/v1/namespaces/kube-system/services/monitoring-heapster/proxy
|
||
InfluxDB is running at https://108.59.85.141/api/v1/namespaces/kube-system/services/monitoring-influxdb/proxy
|
||
```
|