k8s常見命令合集

kubernetes用到的一些命令

kubectl管理工具以及命令

基礎命令：create，delete，get，run，expose，set，explain，edit。

create命令：根據文件或者輸入來創建資源

# 創建Deployment和Service資源
kubectl create -f javak8s-deployment.yaml
kubectl create -f javak8s-service.yaml

**delete命令：**刪除資源

# 根據yaml文件刪除對應的資源，但是yaml文件並不會被刪除，這樣更加高效
kubectl delete -f javak8s-deployment.yaml 
kubectl delete -f javak8s-service.yaml
# 也可以通過具體的資源名稱來進行刪除，使用這個刪除資源，需要同時刪除pod和service資源才行
kubectl delete 具體的資源名稱

**get命令：**獲得資源信息

# 查看所有的資源信息
kubectl get all
# 查看pod列表
kubectl get pod
# 顯示pod節點的標籤信息
kubectl get pod --show-labels
# 根據指定標籤匹配到具體的pod
kubectl get pods -l app=example
# 查看node節點列表
kubectl get node 
# 顯示node節點的標籤信息
kubectl get node --show-labels
# 查看pod詳細信息，也就是可以查看pod具體運行在哪個節點上（ip地址信息）
kubectl get pod -o wide
# 查看服務的詳細信息，顯示了服務名稱，類型，集羣ip，端口，時間等信息
kubectl get svc
[root@master ~]# kubectl get svc
NAME            TYPE        CLUSTER-IP     EXTERNAL-IP   PORT(S)          AGE
go-service      NodePort    10.10.10.247   <none>        8089:33702/TCP   29m
java-service    NodePort    10.10.10.248   <none>        8082:32823/TCP   5h17m
kubernetes      ClusterIP   10.10.10.1     <none>        443/TCP          5d16h
nginx-service   NodePort    10.10.10.146   <none>        88:34823/TCP     2d19h
# 查看命名空間
kubectl get ns
# 查看所有pod所屬的命名空間
kubectl get pod --all-namespaces
# 查看所有pod所屬的命名空間並且查看都在哪些節點上運行
kubectl get pod --all-namespaces  -o wide
# 查看目前所有的replica set，顯示了所有的pod的副本數，以及他們的可用數量以及狀態等信息
kubectl get rs
[root@master ~]# kubectl get rs
NAME                          DESIRED   CURRENT   READY   AGE
go-deployment-58c76f7d5c      1         1         1       32m
java-deployment-76889f56c5    1         1         1       5h21m
nginx-deployment-58d6d6ccb8   3         3         3       2d19h
# 查看目前所有的deployment
kubectl get deployment
[root@master ~]# kubectl get deployment
NAME               READY   UP-TO-DATE   AVAILABLE   AGE
go-deployment      1/1     1            1           34m
java-deployment    1/1     1            1           5h23m
nginx-deployment   3/3     3            3           2d19h
# 查看已經部署了的所有應用，可以看到容器，以及容器所用的鏡像，標籤等信息
 kubectl get deploy -o wide
[root@master bin]# kubectl get deploy -o wide     
NAME    READY   UP-TO-DATE   AVAILABLE   AGE   CONTAINERS   IMAGES       SELECTOR
nginx   3/3     3            3           16m   nginx        nginx:1.10   app=example

**run命令：**在集羣中創建並運行一個或多個容器鏡像。

# 基本語法
run NAME --image=image [--env="key=value"] [--port=port] [--replicas=replicas] [--dry-run=bool] [--overrides=inline-json] [--command] -- [COMMAND] [args...]
# 示例，運行一個名稱爲nginx，副本數爲3，標籤爲app=example，鏡像爲nginx:1.10，端口爲80的容器實例
kubectl run nginx --replicas=3 --labels="app=example" --image=nginx:1.10 --port=80
其他用法參見：http://docs.kubernetes.org.cn/468.html

**expose命令：**創建一個service服務，並且暴露端口讓外部可以訪問

# 創建一個nginx服務並且暴露端口讓外界可以訪問
kubectl expose deployment nginx --port=88 --type=NodePort --target-port=80 --name=nginx-service
關於expose的詳細用法參見：http://docs.kubernetes.org.cn/475.html

set命令： 配置應用的一些特定資源，也可以修改應用已有的資源

# 使用kubectl set --help查看，它的子命令，env，image，resources，selector，serviceaccount，subject。
set命令詳情參見：http://docs.kubernetes.org.cn/669.html
語法：
resources (-f FILENAME | TYPE NAME) ([--limits=LIMITS & --requests=REQUESTS]

kubectl set resources 命令

這個命令用於設置資源的一些範圍限制。

資源對象中的Pod可以指定計算資源需求（CPU-單位m、內存-單位Mi），即使用的最小資源請求（Requests），限制（Limits）的最大資源需求，Pod將保證使用在設置的資源數量範圍。

對於每個Pod資源，如果指定了Limits（限制）值，並省略了Requests（請求），則Requests默認爲Limits的值。

可用資源對象包括(支持大小寫)：replicationcontroller、deployment、daemonset、job、replicaset。

例如：

# 將deployment的nginx容器cpu限制爲“200m”，將內存設置爲“512Mi”
kubectl set resources deployment nginx -c=nginx --limits=cpu=200m,memory=512Mi
# 爲nginx中的所有容器設置 Requests和Limits
kubectl set resources deployment nginx --limits=cpu=200m,memory=512Mi --requests=cpu=100m,memory=256Mi
# 刪除nginx中容器的計算資源值
kubectl set resources deployment nginx --limits=cpu=0,memory=0 --requests=cpu=0,memory=0

kubectl set selector命令

設置資源的selector（選擇器）。如果在調用"set selector"命令之前已經存在選擇器，則新創建的選擇器將覆蓋原來的選擇器。

selector必須以字母或數字開頭，最多包含63個字符，可使用：字母、數字、連字符" - " 、點".“和下劃線” _ "。如果指定了–resource-version，則更新將使用此資源版本，否則將使用現有的資源版本。

注意：目前selector命令只能用於Service對象。

# 語法
selector (-f FILENAME | TYPE NAME) EXPRESSIONS [--resource-version=version]

kubectl set image命令

​ 用於更新現有資源的容器鏡像。

可用資源對象包括：pod (po)、replicationcontroller (rc)、deployment (deploy)、daemonset (ds)、job、replicaset (rs)。

# 語法
image (-f FILENAME | TYPE NAME) CONTAINER_NAME_1=CONTAINER_IMAGE_1 ... CONTAINER_NAME_N=CONTAINER_IMAGE_N

# 將deployment中的nginx容器鏡像設置爲“nginx：1.9.1”。
kubectl set image deployment/nginx busybox=busybox nginx=nginx:1.9.1
# 所有deployment和rc的nginx容器鏡像更新爲“nginx：1.9.1”
kubectl set image deployments,rc nginx=nginx:1.9.1 --all
# 將daemonset abc的所有容器鏡像更新爲“nginx：1.9.1”
kubectl set image daemonset abc *=nginx:1.9.1
# 從本地文件中更新nginx容器鏡像
kubectl set image -f path/to/file.yaml nginx=nginx:1.9.1 --local -o yaml

---

explain命令：用於顯示資源文檔信息

kubectl explain rs

edit命令:用於編輯資源信息

# 編輯Deployment nginx的一些信息
kubectl edit deployment nginx
# 編輯service類型的nginx的一些信息
kubectl edit service/nginx

---

設置命令：label，annotate，completion

label命令:用於更新（增加、修改或刪除）資源上的 label（標籤）

• label 必須以字母或數字開頭，可以使用字母、數字、連字符、點和下劃線，最長63個字符。
• 如果–overwrite 爲 true，則可以覆蓋已有的 label，否則嘗試覆蓋 label 將會報錯。
• 如果指定了–resource-version，則更新將使用此資源版本，否則將使用現有的資源版本。

# 語法
label [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]

# 給名爲foo的Pod添加label unhealthy=true
kubectl label pods foo unhealthy=true
# 給名爲foo的Pod修改label 爲 'status' / value 'unhealthy'，且覆蓋現有的value
kubectl label --overwrite pods foo status=unhealthy
# 給 namespace 中的所有 pod 添加 label
kubectl label  pods --all status=unhealthy
# 僅當resource-version=1時才更新 名爲foo的Pod上的label
kubectl label pods foo status=unhealthy --resource-version=1
# 刪除名爲“bar”的label 。（使用“ - ”減號相連）
kubectl label pods foo bar-

annotate命令：更新一個或多個資源的Annotations信息。也就是註解信息，可以方便的查看做了哪些操作。

• Annotations由key/value組成。
• Annotations的目的是存儲輔助數據，特別是通過工具和系統擴展操作的數據，更多介紹在這裏。
• 如果–overwrite爲true，現有的annotations可以被覆蓋，否則試圖覆蓋annotations將會報錯。
• 如果設置了–resource-version，則更新將使用此resource version，否則將使用原有的resource version。

# 語法
annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]

# 更新Pod“foo”，設置annotation “description”的value “my frontend”，如果同一個annotation多次設置，則只使用最後設置的value值
kubectl annotate pods foo description='my frontend'
# 根據“pod.json”中的type和name更新pod的annotation
kubectl annotate -f pod.json description='my frontend'
# 更新Pod"foo"，設置annotation“description”的value“my frontend running nginx”，覆蓋現有的值
kubectl annotate --overwrite pods foo description='my frontend running nginx'
# 更新 namespace中的所有pod
kubectl annotate pods --all description='my frontend running nginx'
# 只有當resource-version爲1時，才更新pod ' foo '
kubectl annotate pods foo description='my frontend running nginx' --resource-version=1
# 通過刪除名爲“description”的annotations來更新pod ' foo '。#不需要- overwrite flag。
kubectl annotate pods foo description-

completion命令：用於設置kubectl命令自動補全

$ source <(kubectl completion bash) # setup autocomplete in bash, bash-completion package should be installed first.
$ source <(kubectl completion zsh)  # setup autocomplete in zsh

---

kubectl 部署命令：rollout，rolling-update，scale，autoscale

rollout命令:用於對資源進行管理

可用資源包括：deployments，daemonsets。

子命令：

• history（查看歷史版本）
• pause（暫停資源）
• resume（恢復暫停資源）
• status（查看資源狀態）
• undo（回滾版本）

# 語法
kubectl rollout SUBCOMMAND
# 回滾到之前的deployment
kubectl rollout undo deployment/abc
# 查看daemonet的狀態
kubectl rollout status daemonset/foo

**rolling-update命令:**執行指定ReplicationController的滾動更新。

該命令創建了一個新的RC， 然後一次更新一個pod方式逐步使用新的PodTemplate，最終實現Pod滾動更新，new-controller.json需要與之前RC在相同的namespace下。

# 語法
rolling-update OLD_CONTROLLER_NAME ([NEW_CONTROLLER_NAME] --image=NEW_CONTAINER_IMAGE | -f NEW_CONTROLLER_SPEC)
# 使用frontend-v2.json中的新RC數據更新frontend-v1的pod
kubectl rolling-update frontend-v1 -f frontend-v2.json
# 使用JSON數據更新frontend-v1的pod
cat frontend-v2.json | kubectl rolling-update frontend-v1 -f -
# 其他的一些滾動更新
kubectl rolling-update frontend-v1 frontend-v2 --image=image:v2

kubectl rolling-update frontend --image=image:v2

kubectl rolling-update frontend-v1 frontend-v2 --rollback

scale命令：擴容或縮容 Deployment、ReplicaSet、Replication Controller或 Job 中Pod數量

scale也可以指定多個前提條件，如：當前副本數量或 --resource-version ，進行伸縮比例設置前，系統會先驗證前提條件是否成立。這個就是彈性伸縮策略

# 語法
kubectl scale [--resource-version=version] [--current-replicas=count] --replicas=COUNT (-f FILENAME | TYPE NAME)
# 將名爲foo中的pod副本數設置爲3。
kubectl scale --replicas=3 rs/foo
kubectl scale deploy/nginx --replicas=30
# 將由“foo.yaml”配置文件中指定的資源對象和名稱標識的Pod資源副本設爲3
kubectl scale --replicas=3 -f foo.yaml
# 如果當前副本數爲2，則將其擴展至3。
kubectl scale --current-replicas=2 --replicas=3 deployment/mysql
# 設置多個RC中Pod副本數量
kubectl scale --replicas=5 rc/foo rc/bar rc/baz

autoscale命令： 這個比scale更加強大，也是彈性伸縮策略 ，它是根據流量的多少來自動進行擴展或者縮容

指定Deployment、ReplicaSet或ReplicationController，並創建已經定義好資源的自動伸縮器。使用自動伸縮器可以根據需要自動增加或減少系統中部署的pod數量。

# 語法
kubectl autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU] [flags]
# 使用 Deployment “foo”設定，使用默認的自動伸縮策略，指定目標CPU使用率，使其Pod數量在2到10之間
kubectl autoscale deployment foo --min=2 --max=10
# 使用RC“foo”設定，使其Pod的數量介於1和5之間，CPU使用率維持在80％
kubectl autoscale rc foo --max=5 --cpu-percent=80

---

集羣管理命令：certificate，cluster-info，top，cordon，uncordon，drain，taint

certificate命令：用於證書資源管理，授權等

[root@master ~]# kubectl certificate --help
Modify certificate resources.

Available Commands:
  approve     Approve a certificate signing request
  deny        Deny a certificate signing request

Usage:
  kubectl certificate SUBCOMMAND [options]

Use "kubectl <command> --help" for more information about a given command.
Use "kubectl options" for a list of global command-line options (applies to all commands).

# 例如，當有node節點要向master請求，那麼是需要master節點授權的
kubectl  certificate approve node-csr-81F5uBehyEyLWco5qavBsxc1GzFcZk3aFM3XW5rT3mw node-csr-Ed0kbFhc_q7qx14H3QpqLIUs0uKo036O2SnFpIheM18

**cluster-info命令：**顯示集羣信息

kubectl cluster-info

[root@master ~]# kubectl cluster-info
Kubernetes master is running at http://localhost:8080
To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.

**top命令：**用於查看資源的cpu，內存磁盤等資源的使用率

kubectl top pod --all-namespaces
它需要heapster運行才行

cordon命令：用於標記某個節點不可調度

**uncordon命令：**用於標籤節點可以調度

drain命令： 用於在維護期間排除節點。

taint命令：參見：https://blog.frognew.com/2018/05/taint-and-toleration.html

---

集羣故障排查和調試命令：describe，logs，exec，attach，port-foward，proxy，cp，auth

describe命令：顯示特定資源的詳細信息

# 語法
kubectl describe TYPE NAME_PREFIX
（首先檢查是否有精確匹配TYPE和NAME_PREFIX的資源，如果沒有，將會輸出所有名稱以NAME_PREFIX開頭的資源詳細信息）
支持的資源包括但不限於（大小寫不限）：pods (po)、services (svc)、 replicationcontrollers (rc)、nodes (no)、events (ev)、componentstatuses (cs)、 limitranges (limits)、persistentvolumes (pv)、persistentvolumeclaims (pvc)、 resourcequotas (quota)和secrets。
#查看my-nginx pod的詳細狀態
kubectl describe po my-nginx

**logs命令：**用於在一個pod中打印一個容器的日誌，如果pod中只有一個容器，可以省略容器名

# 語法
kubectl logs [-f] [-p] POD [-c CONTAINER]

# 返回僅包含一個容器的pod nginx的日誌快照
$ kubectl logs nginx
# 返回pod ruby中已經停止的容器web-1的日誌快照
$ kubectl logs -p -c ruby web-1
# 持續輸出pod ruby中的容器web-1的日誌
$ kubectl logs -f -c ruby web-1
# 僅輸出pod nginx中最近的20條日誌
$ kubectl logs --tail=20 nginx
# 輸出pod nginx中最近一小時內產生的所有日誌
$ kubectl logs --since=1h nginx
# 參數選項
  -c, --container="": 容器名。
  -f, --follow[=false]: 指定是否持續輸出日誌（實時日誌）。
      --interactive[=true]: 如果爲true，當需要時提示用戶進行輸入。默認爲true。
      --limit-bytes=0: 輸出日誌的最大字節數。默認無限制。
  -p, --previous[=false]: 如果爲true，輸出pod中曾經運行過，但目前已終止的容器的日誌。
      --since=0: 僅返回相對時間範圍，如5s、2m或3h，之內的日誌。默認返回所有日誌。只能同時使用since和since-time中的一種。
      --since-time="": 僅返回指定時間（RFC3339格式）之後的日誌。默認返回所有日誌。只能同時使用since和since-time中的一種。
      --tail=-1: 要顯示的最新的日誌條數。默認爲-1，顯示所有的日誌。
      --timestamps[=false]: 在日誌中包含時間戳。

exec命令：進入容器進行交互，在容器中執行命令

# 語法
kubectl exec POD [-c CONTAINER] -- COMMAND [args...]
#命令選項
  -c, --container="": 容器名。如果未指定，使用pod中的一個容器。
  -p, --pod="": Pod名。
  -i, --stdin[=false]: 將控制檯輸入發送到容器。
  -t, --tty[=false]: 將標準輸入控制檯作爲容器的控制檯輸入。
# 進入nginx容器，執行一些命令操作
kubectl exec -it nginx-deployment-58d6d6ccb8-lc5fp bash

attach命令：連接到一個正在運行的容器。

#語法
kubectl attach POD -c CONTAINER
# 參數選項
-c, --container="": 容器名。如果省略，則默認選擇第一個 pod
  -i, --stdin[=false]: 將控制檯輸入發送到容器。
  -t, --tty[=false]: 將標準輸入控制檯作爲容器的控制檯輸入。

# 獲取正在運行中的pod 123456-7890的輸出，默認連接到第一個容器
kubectl attach 123456-7890
# 獲取pod 123456-7890中ruby-container的輸出
kubectl attach 123456-7890 -c ruby-container
# 切換到終端模式，將控制檯輸入發送到pod 123456-7890的ruby-container的“bash”命令，並將其輸出到控制檯/
# 錯誤控制檯的信息發送回客戶端。
kubectl attach 123456-7890 -c ruby-container -i -t

cp命令：拷貝文件或者目錄到pod容器中

用於pod和外部的文件交換,類似於docker 的cp，就是將容器中的內容和外部的內容進行交換。

---

其他命令：api-servions，config，help，plugin，version

api-servions命令：打印受支持的api版本信息

# kubectl api-versions
[root@master ~]# kubectl api-versions
admissionregistration.k8s.io/v1beta1
apiextensions.k8s.io/v1beta1
apiregistration.k8s.io/v1beta1
apps/v1
apps/v1beta1
apps/v1beta2
authentication.k8s.io/v1
authentication.k8s.io/v1beta1
authorization.k8s.io/v1
authorization.k8s.io/v1beta1
autoscaling/v1
autoscaling/v2beta1
batch/v1
batch/v1beta1
certificates.k8s.io/v1beta1
events.k8s.io/v1beta1
extensions/v1beta1
networking.k8s.io/v1
policy/v1beta1
rbac.authorization.k8s.io/v1
rbac.authorization.k8s.io/v1beta1
storage.k8s.io/v1
storage.k8s.io/v1beta1
v1

help命令：用於查看命令幫助

# 顯示全部的命令幫助提示
kubectl --help
# 具體的子命令幫助，例如
kubectl create --help

config:用於修改kubeconfig配置文件（用於訪問api，例如配置認證信息）

**version命令：**打印客戶端和服務端版本信息

[root@master ~]# kubectl version
Client Version: version.Info{Major:"1", Minor:"15", GitVersion:"v1.15.3", GitCommit:"2d3c76f9091b6bec110a5e63777c332469e0cba2", GitTreeState:"clean", BuildDate:"2019-08-19T11:13:54Z", GoVersion:"go1.12.9", Compiler:"gc", Platform:"linux/amd64"}
Server Version: version.Info{Major:"1", Minor:"9", GitVersion:"v1.9.0", GitCommit:"925c127ec6b946659ad0fd596fa959be43f0cc05", GitTreeState:"clean", BuildDate:"2017-12-15T20:55:30Z", GoVersion:"go1.9.2", Compiler:"gc", Platform:"linux/amd64"}

**plugin命令：**運行一個命令行插件

---

高級命令：apply，patch，replace，convert

apply命令： 通過文件名或者標準輸入對資源應用配置

通過文件名或控制檯輸入，對資源進行配置。 如果資源不存在，將會新建一個。可以使用 JSON 或者 YAML 格式。

# 語法
kubectl apply -f FILENAME

# 將pod.json中的配置應用到pod
kubectl apply -f ./pod.json
# 將控制檯輸入的JSON配置應用到Pod
cat pod.json | kubectl apply -f -

選項
-f, --filename=[]: 包含配置信息的文件名，目錄名或者URL。
      --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true]
  -o, --output="": 輸出模式。"-o name"爲快捷輸出(資源/name).
      --record[=false]: 在資源註釋中記錄當前 kubectl 命令。
  -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
      --schema-cache-dir="~/.kube/schema": 非空則將API schema緩存爲指定文件，默認緩存到'$HOME/.kube/schema'
      --validate[=true]: 如果爲true，在發送到服務端前先使用schema來驗證輸入。

patch命令： 使用補丁修改，更新資源的字段，也就是修改資源的部分內容

# 語法
kubectl patch (-f FILENAME | TYPE NAME) -p PATCH

# Partially update a node using strategic merge patch
kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}'
# Update a container's image; spec.containers[*].name is required because it's a merge key
kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}'

replace命令： 通過文件或者標準輸入替換原有資源

# 語法
kubectl replace -f FILENAME

# Replace a pod using the data in pod.json.
kubectl replace -f ./pod.json
# Replace a pod based on the JSON passed into stdin.
cat pod.json | kubectl replace -f -
# Update a single-container pod's image version (tag) to v4
kubectl get pod mypod -o yaml | sed 's/\(image: myimage\):.*$/\1:v4/' | kubectl replace -f -
# Force replace, delete and then re-create the resource
kubectl replace --force -f ./pod.json

convert命令： 不同的版本之間轉換配置文件

# 語法
kubectl convert -f FILENAME

# Convert 'pod.yaml' to latest version and print to stdout.
kubectl convert -f pod.yaml
# Convert the live state of the resource specified by 'pod.yaml' to the latest version
# and print to stdout in json format.
kubectl convert -f pod.yaml --local -o json
# Convert all files under current directory to latest version and create them all.
kubectl convert -f . | kubectl create -f -