kubectl常用命令指南

有了這篇 Kubectl 命令總結(jié)，5分鐘優(yōu)雅入門 K8s！

kubectl 常用命令指南

Kubectl 命令是操作 kubernetes 集群的最直接的方式，特別是運(yùn)維人員，需要對(duì)這些命令有一個(gè)詳細(xì)的掌握

Kubectl 自動(dòng)補(bǔ)全

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

Kubectl 上下文和配置

設(shè)置 kubectl 命令交互的 kubernetes 集群并修改配置信息。參閱 使用 kubeconfig 文件進(jìn)行跨集群驗(yàn)證 獲取關(guān)于配置文件的詳細(xì)信息。

# 顯示合并后的 kubeconfig 配置
$ kubectl config view 
# 同時(shí)使用多個(gè) kubeconfig 文件并查看合并后的配置
$ KUBECONFIG=~/.kube/config:~/.kube/kubconfig2 kubectl config view
# 獲取 e2e 用戶的密碼
$ kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}'
# 顯示當(dāng)前的上下文
$ kubectl config current-context    
# 設(shè)置默認(rèn)上下文為 my-cluster-name
$ kubectl config use-context my-cluster-name  
# 向 kubeconf 中增加支持基本認(rèn)證的新集群
$ kubectl config set-credentials kubeuser/foo.kubernetes.com --username=kubeuser --password=kubepassword
# 使用指定的用戶名和 namespace 設(shè)置上下文
$ kubectl config set-context gce --user=cluster-admin --namespace=foo 
  && kubectl config use-context gce

創(chuàng)建對(duì)象

Kubernetes 的清單文件可以使用 json 或 yaml 格式定義?？梢砸?yaml、.yml、或者.json為擴(kuò)展名。

# 創(chuàng)建資源
$ kubectl create -f ./my-manifest.yaml     
# 使用多個(gè)文件創(chuàng)建資源
$ kubectl create -f ./my1.yaml -f ./my2.yaml   
# 使用目錄下的所有清單文件來(lái)創(chuàng)建資源
$ kubectl create -f ./dir    
# 使用 url 來(lái)創(chuàng)建資源
$ kubectl create -f https://git.io/vPieo  
# 啟動(dòng)一個(gè) nginx 實(shí)例
$ kubectl run nginx --image=nginx  
 # 獲取 pod 和 svc 的文檔
$ kubectl explain pods,svc                      
# 從 stdin 輸入中創(chuàng)建多個(gè) YAML 對(duì)象
$ cat <

	

	顯示和查找資源

	
# Get commands with basic output
# 列出所有 namespace 中的所有 service
$ kubectl get services            




# 列出所有 namespace 中的所有 pod
$ kubectl get pods --all-namespaces  




# 列出所有 pod 并顯示詳細(xì)信息
$ kubectl get pods -o wide      




# 列出指定 deployment
$ kubectl get deployment my-dep      




# 列出該 namespace 中的所有 pod 包括未初始化的
$ kubectl get pods --include-uninitialized      




# 使用詳細(xì)輸出來(lái)描述命令
$ kubectl describe nodes my-node
$ kubectl describe pods my-pod




# List Services Sorted by Name
$ kubectl get services --sort-by=.metadata.name 




# 根據(jù)重啟次數(shù)排序列出 pod
$ kubectl get pods --sort-by='.status.containerStatuses[0].restartCount'




# 獲取所有具有 app=cassandra 的 pod 中的 version 標(biāo)簽
$ kubectl get pods --selector=app=cassandra rc -o 
  jsonpath='{.items[*].metadata.labels.version}'




# 獲取所有節(jié)點(diǎn)的 ExternalIP
$ kubectl get nodes -o jsonpath='{.items[*].status.addresses[?(@.type=="ExternalIP")].address}'




# 列出屬于某個(gè) PC 的 Pod 的名字
# “jq”命令用于轉(zhuǎn)換復(fù)雜的 jsonpath，參考 https://stedolan.github.io/jq/
$ sel=${$(kubectl get rc my-rc --output=json | jq -j '.spec.selector | to_entries | .[] | "(.key)=(.value),"')%?}
$ echo $(kubectl get pods --selector=$sel --output=jsonpath={.items..metadata.name})




# 查看哪些節(jié)點(diǎn)已就緒
$ JSONPATH='{range .items[*]}{@.metadata.name}:{range @.status.conditions[*]}{@.type}={@.status};{end}{end}' 
 && kubectl get nodes -o jsonpath="$JSONPATH" | grep "Ready=True"




# 列出當(dāng)前 Pod 中使用的 Secret
$ kubectl get pods -o json | jq '.items[].spec.containers[].env[]?.valueFrom.secretKeyRef.name' | grep -v null | sort | uniq

	

	更新資源

	
$ kubectl rolling-update frontend-v1 -f frontend-v2.json           # 滾動(dòng)更新 pod frontend-v1
$ kubectl rolling-update frontend-v1 frontend-v2 --image=image:v2  # 更新資源名稱并更新鏡像
$ kubectl rolling-update frontend --image=image:v2                 # 更新 frontend pod 中的鏡像
$ kubectl rolling-update frontend-v1 frontend-v2 --rollback        # 退出已存在的進(jìn)行中的滾動(dòng)更新
$ cat pod.json | kubectl replace -f -                              # 基于 stdin 輸入的 JSON 替換 pod
# 強(qiáng)制替換，刪除后重新創(chuàng)建資源。會(huì)導(dǎo)致服務(wù)中斷。
$ kubectl replace --force -f ./pod.json
# 為 nginx RC 創(chuàng)建服務(wù)，啟用本地 80 端口連接到容器上的 8000 端口
$ kubectl expose rc nginx --port=80 --target-port=8000
# 更新單容器 pod 的鏡像版本（tag）到 v4
$ kubectl get pod mypod -o yaml | sed 's/(image: myimage):.*$/1:v4/' | kubectl replace -f -
# 添加標(biāo)簽
$ kubectl label pods my-pod new-label=awesome        
 # 添加注解
$ kubectl annotate pods my-pod icon-url=http://goo.gl/XXBTWq   
# 自動(dòng)擴(kuò)展 deployment “foo”
$ kubectl autoscale deployment foo --min=2 --max=10

	

	修補(bǔ)資源

	使用策略合并補(bǔ)丁并修補(bǔ)資源。

	
# 部分更新節(jié)點(diǎn)
kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}' 
# 更新容器鏡像；spec.containers[*].name 是必須的，因?yàn)檫@是合并的關(guān)鍵字
$ kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}'
# 使用具有位置數(shù)組的 json 補(bǔ)丁更新容器鏡像
$ kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]'
# 使用具有位置數(shù)組的 json 補(bǔ)丁禁用 deployment 的 livenessProbe
$ kubectl patch deployment valid-deployment  --type json   -p='[{"op": "remove", "path": "/spec/template/spec/containers/0/livenessProbe"}]'

	

	編輯資源

	在編輯器中編輯任何 API 資源。

	
# 編輯名為 docker-registry 的 service
$ kubectl edit svc/docker-registry           
# 使用其它編輯器
$ KUBE_EDITOR="nano" kubectl edit svc/docker-registry

	

	Scale 資源

	
# Scale a replicaset named 'foo' to 3
$ kubectl scale --replicas=3 rs/foo       
# Scale a resource specified in "foo.yaml" to 3
$ kubectl scale --replicas=3 -f foo.yaml     
# If the deployment named mysql's current size is 2, scale mysql to 3
$ kubectl scale --current-replicas=2 --replicas=3 deployment/mysql  
# Scale multiple replication controllers
$ kubectl scale --replicas=5 rc/foo rc/bar rc/baz

	

	刪除資源

	
# 刪除 pod.json 文件中定義的類型和名稱的 pod
$ kubectl delete -f ./pod.json        
# 刪除名為“baz”的 pod 和名為“foo”的 service
$ kubectl delete pod,service baz foo      
# 刪除具有 name=myLabel 標(biāo)簽的 pod 和 serivce
$ kubectl delete pods,services -l name=myLabel       
# 刪除具有 name=myLabel 標(biāo)簽的 pod 和 service，包括尚未初始化的
$ kubectl delete pods,services -l name=myLabel --include-uninitialized   
# 刪除 my-ns namespace 下的所有 pod 和 serivce包
$ kubectl -n my-ns delete po,svc --all

	

	與運(yùn)行中的 Pod 交互

	
# dump 輸出 pod 的日志（stdout）
$ kubectl logs my-pod  
 # dump 輸出 pod 中容器的日志（stdout，pod 中有多個(gè)容器的情況下使用）
$ kubectl logs my-pod -c my-container      
# 流式輸出 pod 的日志（stdout）
$ kubectl logs -f my-pod             
# 流式輸出 pod 中容器的日志（stdout，pod 中有多個(gè)容器的情況下使用）
$ kubectl logs -f my-pod -c my-container
# 交互式 shell 的方式運(yùn)行 pod
$ kubectl run -i --tty busybox --image=busybox -- sh  
 # 連接到運(yùn)行中的容器
$ kubectl attach my-pod -i    
# 轉(zhuǎn)發(fā) pod 中的 6000 端口到本地的 5000 端口
$ kubectl port-forward my-pod 5000:6000   
  # 在已存在的容器中執(zhí)行命令（只有一個(gè)容器的情況下）
$ kubectl exec my-pod -- ls /          
# 在已存在的容器中執(zhí)行命令（pod 中有多個(gè)容器的情況下）
$ kubectl exec my-pod -c my-container -- ls /    
# 顯示指定 pod 和容器的指標(biāo)度量
$ kubectl top pod POD_NAME --containers

	

	與節(jié)點(diǎn)和集群交互

	
# 標(biāo)記 my-node 不可調(diào)度
$ kubectl cordon my-node       
# 清空 my-node 以待維護(hù)
$ kubectl drain my-node    
# 標(biāo)記 my-node 可調(diào)度
$ kubectl uncordon my-node             
 # 顯示 my-node 的指標(biāo)度量
$ kubectl top node my-node    
$ kubectl cluster-info          
 # 將當(dāng)前集群狀態(tài)輸出到 stdout
$ kubectl cluster-info dump                                                               
 # 將當(dāng)前集群狀態(tài)輸出到 /path/to/cluster-state
$ kubectl cluster-info dump --output-directory=/path/to/cluster-state  
# 如果該鍵和影響的污點(diǎn)（taint）已存在，則使用指定的值替換
$ kubectl taint nodes foo dedicated=special-user:NoSchedule

	

	set 命令

	配置應(yīng)用的一些特定資源，也可以修改應(yīng)用已有的資源

	使用kubectl set --help查看，它的子命令，env，image，resources，selector，serviceaccount，subject。

	語(yǔ)法：resources (-f FILENAME | TYPE NAME) ([—limits=LIMITS & —requests=REQUESTS]

	kubectl set resources 命令

	這個(gè)命令用于設(shè)置資源的一些范圍限制。

	資源對(duì)象中的Pod可以指定計(jì)算資源需求（CPU-單位m、內(nèi)存-單位Mi），即使用的最小資源請(qǐng)求（Requests），限制（Limits）的最大資源需求，Pod將保證使用在設(shè)置的資源數(shù)量范圍。

	對(duì)于每個(gè)Pod資源，如果指定了Limits（限制）值，并省略了Requests（請(qǐng)求），則Requests默認(rèn)為L(zhǎng)imits的值。

	例如：

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

	

	kubectl set selector 命令

	設(shè)置資源的selector（選擇器）。如果在調(diào)用”set selector”命令之前已經(jīng)存在選擇器，則新創(chuàng)建的選擇器將覆蓋原來(lái)的選擇器。

	selector必須以字母或數(shù)字開頭，最多包含63個(gè)字符，可使用：字母、數(shù)字、連字符” - “ 、點(diǎn)”.”和下劃線” _ “。如果指定了—resource-version，則更新將使用此資源版本，否則將使用現(xiàn)有的資源版本。

	注意：目前selector命令只能用于Service對(duì)象。

	語(yǔ)法：selector (-f FILENAME | TYPE NAME) EXPRESSIONS [—resource-version=version]

	kubectl set image 命令

	用于更新現(xiàn)有資源的容器鏡像。

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

	語(yǔ)法：image (-f FILENAME | TYPE NAME) CONTAINER_NAME_1=CONTAINER_IMAGE_1 … CONTAINER_NAME_N=CONTAINER_IMAGE_N

	
# 將deployment中的nginx容器鏡像設(shè)置為“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

	

	資源類型

	下表列出的是 kubernetes 中所有支持的類型和縮寫的別名。

	

	格式化輸出

	要以特定的格式向終端窗口輸出詳細(xì)信息，可以在kubectl命令中添加-o或者-output標(biāo)志。

	

	Kubectl 詳細(xì)輸出和調(diào)試

	

	使用-v或--v標(biāo)志跟著一個(gè)整數(shù)來(lái)指定日志級(jí)別。

	審核編輯：湯梓紅