Kubernetes之yaml文件詳解-v1.15.x

Kubernetes之yaml文件詳解

K8S 創建資源的方式

K8S有兩種創建資源的方式：kubectl 命令和 yaml 配置文件。

kubectl命令行：最為簡單，一條命令就OK，但缺點也很明顯，你并不知道這條命令背后到底做了哪些事!
yaml配置文件：提供了一種讓你知其然更知其所以然的方式。優勢如下：

完整性：配置文件描述了一個資源的完整狀態，可以很清楚地知道一個資源的創建背后究竟做了哪些事；
靈活性：配置文件可以創建比命令行更復雜的結構；
可維護性：配置文件提供了創建資源對象的模板，能夠重復使用；
可擴展性：適合跨環境、規模化的部署。

yaml 是什么？

yaml 是一種用來寫配置文件的語言，沒錯，它是一門語言。如果你用過 json，那么對它就不會陌生，yaml 又被稱為是 json 的超集，使用起來比 json 更方便。

結構上它有兩種可選的類型：Lists 和 Maps。List 用 -（破折號） 來定義每一項，Map 則是一個 key:value 的鍵值對來表示。

YAML語法規則：

大小寫敏感
使用縮進表示層級關系
縮進時不允許使用Tal鍵，只允許使用空格
縮進的空格數目不重要，只要相同層級的元素左側對齊即可
"#"表示注釋，從這個字符一直到行尾，都會被解析器忽略　
"---"" 為可選的分隔符　

在Kubernetes中，只需要知道兩種結構類型即可：
Lists
Maps

kubernetes yaml 文件模板：

 yaml格式的pod定義文件完整內容：
apiVersion: v1       #必選，版本號，例如v1
kind: Pod       #必選，Pod
metadata:       #必選，元數據
  name: string       #必選，Pod名稱
  namespace: string    #必選，Pod所屬的命名空間
  labels:      #自定義標簽
    - name: string     #自定義標簽名字
  annotations:       #自定義注釋列表
    - name: string
spec:         #必選，Pod中容器的詳細定義
  containers:      #必選，Pod中容器列表
  - name: string     #必選，容器名稱
    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

yaml實例文件

apiVersion: extensions/v1beta1   #接口版本
kind: Deployment                 #接口類型
metadata:
  name: ptengine-demo               #Deployment名稱
  namespace: ptengine-prd           #namespace 名稱
  labels:
    app: ptengine-demo              #標簽
spec:
  replicas: 3
   strategy:
    rollingUpdate:  ##由于replicas為3,則整個升級,pod個數在2-4個之間
      maxSurge: 1       #滾動升級時會先啟動1個pod
      maxUnavailable: 1 #滾動升級時允許的最大Unavailable的pod個數
  template:         
    metadata:
      labels:
        app: ptengine-demo  #模板名稱必填
    sepc: #定義容器模板，該模板可以包含多個容器
      containers:                                                                   
        - name: ptengine-demo                                                           #鏡像名稱
          image: reg.pt1.com/ptengine-prd/ptengine-demo:0.0.1-SNAPSHOT #鏡像地址
          CMD: [ "/bin/sh","-c","cat /etc/config/path/to/special-key" ]    #啟動CMD
          args:                                                                #啟動參數
            - '-storage.local.retention=$(STORAGE_RETENTION)'
。。。。。。。。
            - '-web.external-url=$(EXTERNAL_URL)'

          imagePullPolicy: IfNotPresent  #如果不存在則拉取
          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  #local策略可使用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磁盤

參考文檔：

https://blog.csdn.net/phantom_111/article/details/79427144
https://www.cnblogs.com/bakari/p/10509484.html
https://my.oschina.net/gibsonxue/blog/1840887