入門Kubernetes - YAML檔案
阿新 • • 發佈：2021-06-27
前言
前篇文章中簡單瞭解到如何把.Net Core 程式部署到k8s中，過程中使用了多個*.yaml檔案，那麼這些檔案的格式及含義、語法是如何的呢？
接下來，進一步瞭解學習
一、YAML介紹:
1、簡介：
YAML 語言（發音 /ˈjæməl/ ）的設計目標，就是方便人類讀寫。它實質上是一種通用的資料序列化格式。YAML又被稱為是 json 的超集，使用起來比 json 更方便
2、語法：
- 大小寫敏感
- 使用縮排表示層級關係
- 縮排時不允許使用Tab鍵，只允許使用空格。
- 縮排的空格數目不重要，只要相同層級的元素左側對齊即可
- #表示註釋，從該字元到行尾
3、支援的資料結構
- 物件：鍵值對的集合，又稱為對映（mapping）/ 雜湊（hashes） / 字典（dictionary）
- 陣列：一組按次序排列的值，又稱為序列（sequence） / 列表（list）
- 純量（scalars）：單個的、不可再分的值，場景型別如下：
- 字串
- 布林值
- 整數
- 浮點數
- Null
- 時間
- 日期
物件：一組鍵值對，使用冒號結構表示，如下
#yaml格式： api: v1 #對應json格式： {api:'v1'} #yaml格式:行內物件 obj: { name: Steve, foo: bar } #Json格式： { obj: { name: 'Steve', foo: 'bar' } }
陣列：一組連詞線開頭的行，構成一個數組，且支援多維陣列
#yaml格式： - Cat- Dog #json格式： ['Cat','Dog'] #yaml格式：多維陣列 - -Cat -Dog #json格式：多維陣列 [['Cat','Dog']]
純量：最基本的、不可再分的值
#字串型別 str: 字串 #字串之中包含空格或特殊字元，需要放在引號之中。 #單引號和雙引號都可以使用，雙引號不會對特殊字元轉義 #多行字串可以使用|保留換行符，也可以使用>摺疊換行 #+表示保留文字塊末尾的換行，-表示刪除字串末尾的換行 #數字型別： number: 10.01 #布林型別： isRun: true #空型別： name: ~ #時間型別：時間採用 ISO8601 格式iso8601: 2021-06-27t15:00:00.00-05:00 #日期型別：採用複合 iso8601 格式的年、月、日表示 date: 2021-06-27 #使用兩個感嘆號，強制轉換資料型別。 strnum: !!str 123 strbol: !!str true
3、引用用法：
錨點&和別名*，可以用來引用。
&用來建立錨點，<<表示合併到當前資料，*用來引用錨點
#yaml引用示例： defaults: &defaults adapter: postgres host: localhost development: database: myapp_development <<: *defaults test: database: myapp_test <<: *defaults #等效於： defaults: adapter: postgres host: localhost development: database: myapp_development adapter: postgres host: localhost test: database: myapp_test adapter: postgres host: localhost
以上是yaml的基礎語法，接下來看下在k8s中怎麼使用呢？
二、YAML在k8s中的使用
k8s有兩種建立資源的方式：kubectl 命令和 yaml 配置檔案。
kubectl命令列：最為簡單，一條命令就OK.
yaml配置檔案：提供了一種讓你知其然更知其所以然的方式。
優勢如下：
完整性：配置檔案描述了一個資源的完整狀態，可以很清楚地知道一個資源的建立背後究竟做了哪些事；
靈活性：配置檔案可以建立比命令列更復雜的結構；
可維護性：配置檔案提供了建立資源物件的模板，能夠重複使用；
可擴充套件性：適合跨環境、規模化的部署。
k8s(Kubernetes)中Pod、Deployment、ReplicaSet、Service之間關係如下：
Pod：來管理容器，每個 Pod 可以包含一個或多個緊密關聯的容器
ReplicaSet：是rc的升級版，也是來管理pod，Kubernetes官方強烈建議避免直接使用ReplicaSet，而應該通過Deployment來建立RS和Pod。由於ReplicaSet是ReplicationController的代替物，因此用法基本相同，唯一的區別在於ReplicaSet支援集合式的selector。
Deployment：更加方便的管理Pod和Replica Set，提供釋出更新維護監控等功能
Service：是在這一整套基礎之上提供給外部的穩定的服務
1、Deployment配置模板
apiVersion: extensions/v1beta1 kind: Deployment metadata: <Object> spec: <Object> minReadySeconds: <integer> #設定pod準備就緒的最小秒數 paused: <boolean> #表示部署已暫停並且deploy控制器不會處理該部署 progressDeadlineSeconds: <integer> strategy: <Object> #將現有pod替換為新pod的部署策略 rollingUpdate: <Object> #滾動更新配置引數，僅當型別為RollingUpdate maxSurge: <string> #滾動更新過程產生的最大pod數量，可以是個數，也可以是百分比 maxUnavailable: <string> # type: <string> #部署型別，Recreate，RollingUpdate replicas: <integer> #pods的副本數量 selector: <Object> #pod標籤選擇器，匹配pod標籤，預設使用pods的標籤 matchLabels: <map[string]string> key1: value1 key2: value2 matchExpressions: <[]Object> operator: <string> -required- #設定標籤鍵與一組值的關係，In, NotIn, Exists and DoesNotExist key: <string> -required- values: <[]string> revisionHistoryLimit: <integer> #設定保留的歷史版本個數，預設是10 rollbackTo: <Object> revision: <integer> #設定回滾的版本，設定為0則回滾到上一個版本 template: <Object> -required- metadata: spec: containers: <[]Object> #容器配置 - name: <string> -required- #容器名、DNS_LABEL image: <string> #映象 imagePullPolicy: <string> #映象拉取策略，Always、Never、IfNotPresent ports: <[]Object> - name: #定義埠名 containerPort: #容器暴露的埠 protocol: TCP #或UDP volumeMounts: <[]Object> - name: <string> -required- #設定卷名稱 mountPath: <string> -required- #設定需要掛載容器內的路徑 readOnly: <boolean> #設定是否只讀 livenessProbe: <Object> #就緒探測 exec: command: <[]string> httpGet: port: <string> -required- path: <string> host: <string> httpHeaders: <[]Object> name: <string> -required- value: <string> -required- scheme: <string> initialDelaySeconds: <integer> #設定多少秒後開始探測 failureThreshold: <integer> #設定連續探測多少次失敗後，標記為失敗，預設三次 successThreshold: <integer> #設定失敗後探測的最小連續成功次數，預設為1 timeoutSeconds: <integer> #設定探測超時的秒數，預設1s periodSeconds: <integer> #設定執行探測的頻率（以秒為單位），預設1s tcpSocket: <Object> #TCPSocket指定涉及TCP埠的操作 port: <string> -required- #容器暴露的埠 host: <string> #預設pod的IP readinessProbe: <Object> #同livenessProbe resources: <Object> #資源配置 requests: <map[string]string> #最小資源配置 memory: "1024Mi" cpu: "500m" #500m代表0.5CPU limits: <map[string]string> #最大資源配置 memory: cpu: volumes: <[]Object> #資料卷配置 - name: <string> -required- #設定卷名稱,與volumeMounts名稱對應 hostPath: <Object> #設定掛載宿主機路徑 path: <string> -required- type: <string> #型別：DirectoryOrCreate、Directory、FileOrCreate、File、Socket、CharDevice、BlockDevice - name: nfs nfs: <Object> #設定NFS伺服器 server: <string> -required- #設定NFS伺服器地址 path: <string> -required- #設定NFS伺服器路徑 readOnly: <boolean> #設定是否只讀 - name: configmap configMap: name: <string> #configmap名稱 defaultMode: <integer> #許可權設定0~0777，預設0664 optional: <boolean> #指定是否必須定義configmap或其keys items: <[]Object> - key: <string> -required- path: <string> -required- mode: <integer> restartPolicy: <string> #重啟策略，Always、OnFailure、Never nodeName: <string> nodeSelector: <map[string]string> imagePullSecrets: <[]Object> hostname: <string> hostPID: <boolean> status: <Object>
nginx例項：
apiVersion: app/v1 # 1.9.0 之前的版本使用 apps/v1beta2，可通過命令 kubectl api-versions 檢視 kind: Deployment #指定建立資源的角色/型別 metadata: #資源的元資料/屬性 name: nginx-deployment #資源的名字，在同一個namespace中必須唯一 namespace: xxxx #名稱空間 labels: app: demo #標籤 spec: replicas: 3 #副本數量3 strategy: rollingUpdate: ##由於replicas為3,則整個升級,pod個數在2-4個之間 maxSurge: 1 #滾動升級時會先啟動1個pod maxUnavailable: 1 #滾動升級時允許的最大Unavailable的pod個數 selector: #定義標籤選擇器,部署需要管理的pod（帶有該標籤的的會被管理）需在pod 模板中定義 matchLabels: app: web-server template: #這裡Pod的定義 metadata: labels: #Pod的label app: web-server spec: # 模板的規範 containers: - name: nginx #容器的名字 image: nginx:1.12.1 #容器的映象地址 command: [ "/bin/sh","-c","cat /etc/config/path/to/special-key" ] #啟動命令 args: #啟動引數 - '-storage.local.retention=$(STORAGE_RETENTION)' - '-storage.local.memory-chunks=$(STORAGE_MEMORY_CHUNKS)' - '-config.file=/etc/prometheus/prometheus.yml' - '-alertmanager.url=http://alertmanager:9093/alertmanager' - '-web.external-url=$(EXTERNAL_URL)' #如果command和args均沒有寫，那麼用Docker預設的配置。 #如果command寫了，但args沒有寫，那麼Docker預設的配置會被忽略而且僅僅執行.yaml檔案的command（不帶任何引數的）。 #如果command沒寫，但args寫了，那麼Docker預設配置的ENTRYPOINT的命令列會被執行，但是呼叫的引數是.yaml中的args。 #如果如果command和args都寫了，那麼Docker預設的配置被忽略，使用.yaml的配置。 imagePullPolicy: IfNotPresent # IfNotPresent ：預設值,本地有則使用本地映象,不拉取，如果不存在則拉取 # Always： 總是拉取 # Never： 只使用本地映象，從不拉取 livenessProbe: #表示container是否處於live狀態。如果LivenessProbe失敗，LivenessProbe將會通知kubelet對應的container不健康了。
#隨後kubelet將kill掉container，並根據RestarPolicy進行進一步的操作。預設情況下LivenessProbe在第一次檢測之前初始化值為Success，如果container沒有提供LivenessProbe，則也認為是Success； httpGet: path: /health #如果沒有心跳檢測介面就為/ port: 8080 scheme: HTTP initialDelaySeconds: 60 ##啟動後延時多久開始執行檢測 timeoutSeconds: 5 successThreshold: 1 failureThreshold: 5 readinessProbe: readinessProbe: httpGet: path: /health #如果沒有心跳檢測介面就為/ port: 8080 scheme: HTTP initialDelaySeconds: 30 ##啟動後延時多久開始執行檢測 timeoutSeconds: 5 successThreshold: 1 failureThreshold: 5 resources: ##CPU記憶體限制 requests: cpu: 2 memory: 2048Mi limits: cpu: 2 memory: 2048Mi env: ##通過環境變數的方式，直接傳遞pod=自定義Linux OS環境變數 - name: LOCAL_KEY #本地Key value: value - name: CONFIG_MAP_KEY #局策略可使用configMap的配置Key， valueFrom: configMapKeyRef: name: special-config #configmap中找到name為special-config key: special.type #找到name為special-config裡data下的key ports: - name: http containerPort: 8080 #對service暴露埠 volumeMounts: #掛載volumes中定義的磁碟 - name: log-cache mount: /tmp/log - name: sdb #普通用法，該卷跟隨容器銷燬，掛載一個目錄 mountPath: /data/media - name: nfs-client-root #直接掛載硬碟方法，如掛載下面的nfs目錄到/mnt/nfs mountPath: /mnt/nfs - name: example-volume-config #高階用法第1種，將ConfigMap的log-script,backup-script分別掛載到/etc/config目錄下的一個相對路徑path/to/...下，如果存在同名檔案，直接覆蓋。 mountPath: /etc/config - name: rbd-pvc #高階用法第2中，掛載PVC(PresistentVolumeClaim) #使用volume將ConfigMap作為檔案或目錄直接掛載，其中每一個key-value鍵值對都會生成一個檔案，key為檔名，value為內容， volumes: # 定義磁碟給上面volumeMounts掛載 - name: log-cache emptyDir: {} - name: sdb #掛載宿主機上面的目錄 hostPath: path: /any/path/it/will/be/replaced - name: example-volume-config # 供ConfigMap檔案內容到指定路徑使用 configMap: name: example-volume-config #ConfigMap中名稱 items: - key: log-script #ConfigMap中的Key path: path/to/log-script #指定目錄下的一個相對路徑path/to/log-script - key: backup-script #ConfigMap中的Key path: path/to/backup-script #指定目錄下的一個相對路徑path/to/backup-script - name: nfs-client-root #供掛載NFS儲存型別 nfs: server: 10.42.0.55 #NFS伺服器地址 path: /opt/public #showmount -e 看一下路徑 - name: rbd-pvc #掛載PVC磁碟 persistentVolumeClaim: claimName: rbd-pvc1 #掛載已經申請的pvc磁碟
2、SERVICE 配置模板
apiVersion: v1 kind: Service matadata: #元資料 name: string #service的名稱 namespace: string #名稱空間 labels: #自定義標籤屬性列表 - name: string annotations: #自定義註解屬性列表 - name: string spec: #詳細描述 selector: [] #label selector配置，將選擇具有label標籤的Pod作為管理 範圍 type: string #service的型別，指定service的訪問方式，預設為clusterIp clusterIP: string #虛擬服務地址 sessionAffinity: string #是否支援session ports: #service需要暴露的埠列表 - name: string #埠名稱 protocol: string #埠協議，支援TCP和UDP，預設TCP port: int #服務監聽的埠號 targetPort: int #需要轉發到後端Pod的埠號 nodePort: int #當type = NodePort時，指定對映到物理機的埠號 status: #當spce.type=LoadBalancer時，設定外部負載均衡器的地址 loadBalancer: #外部負載均衡器 ingress: #外部負載均衡器 ip: string #外部負載均衡器的Ip地址值 hostname: string #外部負載均衡器的主機名
Service節點說明：
3、Pod配置模板：
apiVersion: v1 #必選，版本號，例如v1,版本號必須可以用 kubectl api-versions 查詢到 . kind: Pod #必選，Pod metadata: #必選，元資料 name: string #必選，Pod名稱 namespace: string #必選，Pod所屬的名稱空間,預設為"default" labels: #自定義標籤 - name: string #自定義標籤名字 annotations: #自定義註釋列表 - name: string spec: #必選，Pod中容器的詳細定義 containers: #必選，Pod中容器列表 - name: string #必選，容器名稱,需符合RFC 1035規範 image: string #必選，容器的映象名稱 imagePullPolicy: [ Always|Never|IfNotPresent ] #獲取映象的策略 Alawys表示下載映象 IfnotPresent表示優先使用本地映象,否則下載映象，Nerver表示僅使用本地映象 command: [string] #容器的啟動命令列表，如不指定，使用打包時使用的啟動命令 args: [string] #容器的啟動命令引數列表 workingDir: string #容器的工作目錄 volumeMounts: #掛載到容器內部的儲存卷配置 - name: string #引用pod定義的共享儲存卷的名稱，需用volumes[]部分定義的的卷名 mountPath: string #儲存卷在容器內mount的絕對路徑，應少於512字元 readOnly: boolean #是否為只讀模式 ports: #需要暴露的埠庫號列表 - name: string #埠的名稱 containerPort: int #容器需要監聽的埠號 hostPort: int #容器所在主機需要監聽的埠號，預設與Container相同 protocol: string #埠協議，支援TCP和UDP，預設TCP env: #容器執行前需設定的環境變數列表 - name: string #環境變數名稱 value: string #環境變數的值 resources: #資源限制和請求的設定 limits: #資源限制的設定 cpu: string #Cpu的限制，單位為core數，將用於docker run --cpu-shares引數 memory: string #記憶體限制，單位可以為Mib/Gib，將用於docker run --memory引數 requests: #資源請求的設定 cpu: string #Cpu請求，容器啟動的初始可用數量 memory: string #記憶體請求,容器啟動的初始可用數量 livenessProbe: #對Pod內各容器健康檢查的設定，當探測無響應幾次後將自動重啟該容器，檢查方法有exec、httpGet和tcpSocket，對一個容器只需設定其中一種方法即可 exec: #對Pod容器內檢查方式設定為exec方式 command: [string] #exec方式需要制定的命令或指令碼 httpGet: #對Pod內個容器健康檢查方法設定為HttpGet，需要制定Path、port path: string port: number host: string scheme: string HttpHeaders: - name: string value: string tcpSocket: #對Pod內個容器健康檢查方式設定為tcpSocket方式 port: number initialDelaySeconds: 0 #容器啟動完成後首次探測的時間，單位為秒 timeoutSeconds: 0 #對容器健康檢查探測等待響應的超時時間，單位秒，預設1秒 periodSeconds: 0 #對容器監控檢查的定期探測時間設定，單位秒，預設10秒一次 successThreshold: 0 failureThreshold: 0 securityContext: privileged: false restartPolicy: [Always | Never | OnFailure] #Pod的重啟策略，Always表示一旦不管以何種方式終止執行，kubelet都將重啟，OnFailure表示只有Pod以非0退出碼退出才重啟，Nerver表示不再重啟該Pod nodeSelector: obeject #設定NodeSelector表示將該Pod排程到包含這個label的node上，以key：value的格式指定 imagePullSecrets: #Pull映象時使用的secret名稱，以key：secretkey格式指定 - name: string hostNetwork: false #是否使用主機網路模式，預設為false，如果設定為true，表示使用宿主機網路 volumes: #在該pod上定義共享儲存卷列表 - name: string #共享儲存卷名稱 （volumes型別有很多種） emptyDir: {} #型別為emtyDir的儲存卷，與Pod同生命週期的一個臨時目錄。為空值 hostPath: string #型別為hostPath的儲存卷，表示掛載Pod所在宿主機的目錄 path: string #Pod所在宿主機的目錄，將被用於同期中mount的目錄 secret: #型別為secret的儲存卷，掛載叢集與定義的secre物件到容器內部 scretname: string items: - key: string path: string configMap: #型別為configMap的儲存卷，掛載預定義的configMap物件到容器內部 name: string items: - key: string path: string nfs: #型別為NFS的儲存卷 server: 192.168.66.50 #nfs伺服器ip或是域名 path: "/test" #nfs伺服器共享的目錄 persistentVolumeClaim: #型別為persistentVolumeClaim的儲存卷 claimName: test-pvc #名字一定要正確，使用的是kind為PersistentVolumeClaim中的name
4、快速生成YAML檔案
a) 命令：
kubectl run --image=nginx my-deploy -o yaml --dry-run >my-deploy.yaml kubectl create -f deploy-nginx.yaml -o yaml --dry-run >my-deploy.yaml kubectl create -f deploy-nginx.yaml -o json --dry-run >my-deploy.json # 指定輸出json格式 – image # 指定模板映象 my-deploy # 執行標籤名稱 –dry-run # 只測試執行,不會實際執行pod -o yaml # 指定輸出格式
2、查詢Pod容器的欄位資源內部文件
kubectl explain pods # 每一個層級的指令都會有欄位資訊 kubectl explain pods.spec kubectl explain pods.spec.containers
總結
本篇對yaml檔案語法瞭解，以及對k8s中常用建立Deployment、Service、Pod的yaml檔案中各個節點的含義用法瞭解。接下來對k8s中各種資源進一步瞭解、學習。並實際操作應用。