kubectl簡介


kubectl簡介

kubectl是操作k8s集群的命令行工具,安裝在k8s的master節點,kubectl在$HOME/.kube目錄中查找一個名為config的文件, 你可以通過設置Kubeconfig環境變量或設置--kubeconfig來指定其他的kubeconfig文件。kubectl通過與apiserver交互可以實現對k8s集群中各種資源的增刪改查。接下來將會介紹kubectl語法,命令行的操作,並介紹常見的示例。命令的詳細信息、參數和子命令可在kubectl參考文檔中查看。 

kubectl語法

kubectl語法格式如下,可在k8s集群的master節點執行:

 

kubectl [command] [TYPE] [NAME] [flags]

 

上述語法解釋說明:

command:指定要對一個或多個資源執行的操作,例如create、get、describe、delete等。

type:指定資源類型。資源類型不區分大小寫,可以指定單數、復數或縮寫形式。例如,以下命令輸出相同的結果:

kubectl get pod pod1

kubectl get pods pod1

kubectl get po pod1

NAME:指定資源的名稱。名稱區分大小寫。如果省略名稱,則顯示所有資源的詳細信息:kubectl get pods。

flags: 指定可選的參數。例如,可以使用-s或-server參數指定 Kubernetes API服務器的地址和端口。

注意事項說明:

從命令行指定的參數會覆蓋默認值和任何相應的環境變量。

 

1.在對多個資源執行操作時,可以按類型、名稱、一個或者多個文件指定每個資源:

1)按類型和名稱指定資源:

要對所有類型相同的資源進行分組,請執行以下操作:

TYPE1 name1 name2 name<#>。
例子:kubectl get pod example-pod1 example-pod2

分別指定多個資源類型:

TYPE1/name1 TYPE1/name2 TYPE2/name3 TYPE<#>/name<#>。

例:kubectl get pod/example-pod1 deployment/example-rc1

 

2)用一個或多個文件指定資源:-f file1 -f file2 -f file<#>

使用YAML而不是JSON,因為YAML更容易使用,特別是用於配置文件時。
例子:kubectl get pod -f ./pod.yaml

 

2.kubectl –-help

可查看kubectl的幫助命令

操作

下面講解和kubectl操作相關的命令和語法:

1. annotate

1)語法:
kubectl annotate (-f FILENAME | TYPE NAME | TYPE/NAME) KEY_1=VAL_1 … KEY_N=VAL_N [--overwrite] [--all] [--resource-version=version] [flags]

2)描述:

添加或更新一個或多個資源的注釋。

 

**2. api-versions

1)語法:

kubectl api-versions [flags]

2)描述:

列出可用的api版本

 

**3.apply

1)語法:

kubectl apply -f FILENAME [flags]

從文件或stdin對資源的應用配置進行更改。

 

4.attach-不用

1)語法:

kubectl attach POD-name -c CONTAINER-name  [-i] [-t] [flags]

附加到正在運行的容器,查看輸出流或與容器交互。

 

**5.autoscale

1)語法:

kubectl autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU] [flags]

自動擴縮容由副本控制器管理的一組 pod。

 

6.cluster-info

1)語法:

kubectl cluster-info [flags]

顯示有關集群中的主服務器和服務的端點信息。

 

7.config

1)語法:

kubectl config SUBCOMMAND [flags]

修改kubeconfig文件

 

8.create-一般不用,用apply替代這個

1)語法:

kubectl create -f FILENAME [flags]

從文件或標准輸入創建一個或多個資源。

 

**9.delete

1)語法:
kubectl delete (-f FILENAME | TYPE [NAME | /NAME | -l label | --all]) [flags]

從文件、標准輸入或指定標簽選擇器、名稱、資源選擇器或資源中刪除資源。

 

**10.describe

1)語法:

kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | /NAME | -l label]) [flags]

顯示一個或多個資源的詳細狀態。

 

11.diff

1)語法:

kubectl diff -f FILENAME [flags]

將 live 配置和文件或標准輸入做對比 (BETA版)

 

**12.edit

1)語法:
kubectl edit (-f FILENAME | TYPE NAME | TYPE/NAME) [flags]

使用默認編輯器編輯和更新服務器上一個或多個資源的定義。

 

**13.exec-常用的

1)語法:

kubectl exec POD-name [-c CONTAINER-name] [-i] [-t] [flags] [-- COMMAND [args...]]

對 pod 中的容器執行命令。

 

下面的命令就是登錄到pod中的容器的命令

kubectl exec calico-node-cblk2 -n kube-system -i -t -- /bin/sh

 

 

**14.explain-常用的

1)語法:

kubectl explain [--recursive=false] [flags]

獲取多種資源的文檔。例如 pod, node, service 等,相當於幫助命令,可以告訴我們怎么創建資源

 

**15.expose

1)語法:

kubectl expose (-f FILENAME | TYPE NAME | TYPE/NAME) [--port=port] [--protocol=TCP|UDP] [--target-port=number-or-name] [--name=name] [--external-ip=external-ip-of-service] [--type=type] [flags]

將副本控制器、服務或pod作為新的Kubernetes服務進行暴露。

 

**16.get

1)語法:

kubectl get (-f FILENAME | TYPE [NAME | /NAME | -l label]) [--watch] [--sort-by=FIELD] [[-o | --output]=OUTPUT_FORMAT] [flags]

列出一個或多個資源。

 

17.label

1)語法:

kubectl label (-f FILENAME | TYPE NAME | TYPE/NAME) KEY_1=VAL_1 … KEY_N=VAL_N [--overwrite] [--all] [--resource-version=version] [flags]

添加或更新一個或多個資源的標簽。

 

**18.logs

1)語法:
kubectl logs POD [-c CONTAINER] [--follow] [flags]

在 pod 中打印容器的日志。

 

19.patch

1)語法:
kubectl patch (-f FILENAME | TYPE NAME | TYPE/NAME) --patch PATCH [flags]

更新資源的一個或多個字段

 

20.port-forward

1)語法:

kubectl port-forward POD [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMOTE_PORT_N] [flags]

將一個或多個本地端口轉發到Pod。

 

21.proxy

1)語法:

kubectl proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--api-prefix=prefix] [flags]

運行Kubernetes API服務器的代理。

 

22.replace

1)語法:
kubectl replace -f FILENAM

從文件或標准輸入中替換資源。

 

**23.run

1)語法:

kubectl run NAME --image=image [--env=“key=value”] [--port=port] [--dry-run=server | client | none] [--overrides=inline-json] [flags]

在集群上運行指定的鏡像

 

24.scale

1)語法:

kubectl scale (-f FILENAME | TYPE NAME | TYPE/NAME) --replicas=COUNT [--resource-version=version] [--current-replicas=count] [flags]

更新指定副本控制器的大小。

25.version

1)語法:

kubectl version [--client] [flags] 

顯示運行在客戶端和服務器上的 Kubernetes 版本

 

舉例說明:

kubectl run nginx --image=nginx 可以創建一個nginx應用

實際創建pod應用都是通過編寫資源清單文件進行創建

 

注:

上面標注**是常用命令,需要重點記一下

 

有關kubectl更詳細的操作命令,可參考https://kubernetes.io/docs/reference/kubectl/kubectl/

 

資源類型

下表列出所有受支持的資源類型及其縮寫別名:

(以下輸出可以通過kubectl api-resources獲取,內容以 Kubernetes 1.13.3 版本為准。)

 

 

輸出選項

下面給大家介紹怎么對輸出的命令進行格式化或者排序

1.格式輸出

kubectl命令的默認輸出格式是人類可讀的明文格式,若要以特定格式向終端窗口輸出詳細信息,可以將-o或—out參數添加到受支持的kubectl命令中。

 

2.語法

kubectl [command] [TYPE] [NAME] -o=<output_format>

 

根據 kubectl 操作,支持以下輸出格式:

 

 

**示例:在此示例中,以下命令將單個 pod 的詳細信息輸出為 YAML 格式的對象:

kubectl get pod web-pod-13je7 -o yaml

 

注:有關每個命令支持哪種輸出格式的詳細信息,可參考:

https://kubernetes.io/docs/user-guide/kubectl/

 

3.自定義列

要定義自定義列並僅將所需的詳細信息輸出到表中,可以使用custom-columns 選項。你可以選擇內聯定義自定義列或使用模板文件:-o=custom-columns=<spec> 或 -o=custom-columns-file=<filename>

 

示例:

1)內聯:

kubectl get pods <pod-name> -o custom-columns=NAME:.metadata.name,RSRC:.metadata.resourceVersion

2)模板文件:

kubectl get pods <pod-name> -o custom-columns-file=template.txt

其中,template.txt文件內容是:

NAME          RSRC

metadata.name metadata.resourceVersion

 

運行任何一個命令的結果是:

NAME           RSRC

submit-queue   610995

 

4.server-side 列

kubectl支持從服務器接收關於對象的特定列信息。 這意味着對於任何給定的資源,服務器將返回與該資源相關的列和行,以便客戶端打印。 通過讓服務器封裝打印的細節,這允許在針對同一集群使用的客戶端之間提供一致的人類可讀輸出。默認情況下,此功能在kubectl 1.11及更高版本中啟用。要禁用它,請將該--server-print=false參數添加到 kubectl get 命令中。

 

例子:

要打印有關 pod 狀態的信息,請使用如下命令:

kubectl get pods <pod-name> --server-print=false

輸出如下:

NAME                               AGE

nfs-provisioner-595dcd6b77-527np     5d21h

 

5. 排序列表對象

要將對象排序后輸出到終端窗口,可以將--sort-by參數添加到支持的kubectl命令。通過使用--sort-by參數指定任何數字或字符串字段來對對象進行排序。要指定字段,請使用jsonpath表達式。

語法

kubectl [command] [TYPE] [NAME] --sort-by=<jsonpath_exp>

示例

要打印按名稱排序的pod列表,請運行:

kubectl get pods -n kube-system --sort-by=.metadata.name

NAME                               READY   STATUS    RESTARTS   AGE

calico-node-cblk2                  1/1     Running   40         7d8h

calico-node-q84kx                  1/1     Running   31         7d8h

coredns-66bff467f8-f2nrb           1/1     Running   3          5d21h

coredns-66bff467f8-x24ff           1/1     Running   4          5d21h

etcd-master1                       1/1     Running   7          7d8h

kube-apiserver-master1             1/1     Running   22         7d8h

kube-controller-manager-master1    1/1     Running   81         7d8h

kube-proxy-4xlzz                   1/1     Running   4          7d8h

kube-proxy-pxjlx                   1/1     Running   5          7d8h

kube-scheduler-master1             1/1     Running   72         7d8h

metrics-server-8459f8db8c-lvx9x    2/2     Running   2          5d21h

traefik-ingress-controller-c8dm6   1/1     Running   4          7d8h

traefik-ingress-controller-nr4n6   1/1     Running   6          7d8h

列子:常用操作

使用下面的列子幫你熟悉kubectl常用的操作

1.kubectl apply   

用文件或者標准輸入來應用或者更新k8s的資源

# 使用 example-service.yaml 中的定義創建服務。

kubectl apply -f example-service.yaml

 

# 使用 example-controller.yaml 中的定義創建 replication controller

kubectl apply -f example-controller.yaml

 

# 使用 <directory> 路徑下的任意 .yaml, .yml, .json 文件創建對象。

kubectl apply -f <directory>

 

2.kubectl get 

列出一個或多個資源。

# 以純文本輸出格式列出所有 pod

kubectl get pods

 

# 以純文本輸出格式列出所有 pod,並包含附加信息(如節點名)

kubectl get pods -o wide

 

# 以純文本輸出格式列出具有指定名稱的副本控制器。提示:你可以使用別名 'rc' 縮短和替換 'replicationcontroller' 資源類型。

kubectl get replicationcontroller <rc-name>

 

# 以純文本輸出格式列出所有副本控制器和服務。

kubectl get rc,services

 

# 以純文本輸出格式列出所有守護程序集。

kubectl get ds

 

# 列出在節點 server01 上運行的所有 pod

kubectl get pods --field-selector=spec.nodeName=server01

 

3.kubectl describe

顯示一個或多個資源的詳細狀態,默認情況下包括未初始化的資源。

# 顯示名稱為 <node-name> 的節點的詳細信息。

kubectl describe nodes <node-name>

 

# 顯示名為 <pod-name> pod 的詳細信息。

kubectl describe pods/<pod-name>

 

# 顯示由名為 <rc-name> 的副本控制器管理的所有 pod 的詳細信息。

# 記住:副本控制器創建的任何 pod 都以復制控制器的名稱為前綴。

kubectl describe pods <rc-name>

 

# 描述所有的 pod

kubectl describe pods

 

 

注意:

kubectl get 命令通常用於檢索同一資源類型的一個或多個資源。 它具有豐富的參數,允許您使用 -o  --output 參數自定義輸出格式。您可以指定 -w  --watch 參數以開始觀察特定對象的更新。 kubectl describe 命令更側重於描述指定資源的許多相關方面。它可以調用對 API 服務器 的多個 API 調用來為用戶構建視圖。 例如,該 kubectl describe node 命令不僅檢索有關節點的信息,還檢索在其上運行的 pod 的摘要,為節點生成的事件等。

 

4.kubectl delete

從文件、標注輸入或指定標簽選擇器、名稱、資源選擇器或資源中刪除資源。

# 使用 pod.yaml 文件中指定的類型和名稱刪除 pod

kubectl delete -f pod.yaml

 

# 刪除標簽名= <label-name> 的所有 pod 和服務。

kubectl delete pods,services -l name=<label-name>

 

# 刪除所有具有標簽名稱= <label-name> pod 和服務,包括未初始化的那些。

kubectl delete pods,services -l name=<label-name> --include-uninitialized

 

# 刪除所有 pod,包括未初始化的 pod

kubectl delete pods --all

 

5.kubectl exec

pod中的容器執行命令。

# pod <pod-name> 中獲取運行 'date' 的輸出。默認情況下,輸出來自第一個容器。

kubectl exec <pod-name> date

  

# 運行輸出 'date' 獲取在容器的 <container-name> pod <pod-name> 的輸出。

kubectl exec <pod-name> -c <container-name> date

 

# 獲取一個交互 TTY 並運行 /bin/bash <pod-name >。默認情況下,輸出來自第一個容器。

kubectl exec -ti <pod-name> -- /bin/bash

 

6.kubectl logs

打印 Pod 中容器的日志。

# pod 返回日志快照。

kubectl logs <pod-name>

 

# pod <pod-name> 開始流式傳輸日志。這類似於 'tail -f' Linux 命令。

kubectl logs -f <pod-name>

 

 

查看有哪些pods

kubectl get pods -o go-template --template '{{range .items}}{{.metadata.name}}{{"\n"}}{{end}}'


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM