K8S集群-(YAML.YML)文件详解

清疚 2023-03-06 05:50 47阅读 0赞

**友情提示网页可以使用Ctrl+F搜索关键字，快速跳转**

大神借鉴地址：https://blog.csdn.net/Ay\_Ly/article/details/89393281

--------------------

k8s平台是GO语言开发的 支持yaml和json

相比之下yaml语言比json更加简单，格式也没有那个细致，方便编辑和记忆

### 一.deployment.yaml文件详解（集群pod管理，自动伸缩相关） ###

apiVersion: extensions/v1beta1   #接口版本 #查看api接口命令kubectl api-version
    kind: Deployment                 #接口类型
    metadata:
      name: cango-demo               #Deployment名称
      namespace: cango-prd           #命名空间
      labels:
        app: cango-demo              #标签
    spec:
      replicas: 3
      strategy:
        rollingUpdate:  ##由于replicas为3,则整个升级,pod个数在2-4个之间
          maxSurge: 1 #滚动升级时会先启动1个pod
          maxUnavailable: 1 #滚动升级时允许的最大Unavailable的pod个数
      template:         
        metadata:
          labels:             # matchLabels一样匹配下面的pods标签
            app: cango-demo  #模板名称必填
        sepc: #定义容器模板，该模板可以包含多个容器
          containers:                                                                   
            - name: cango-demo                                                           #镜像名称
              image: swr.cn-east-2.myhuaweicloud.com/cango-prd/cango-demo:0.0.1-SNAPSHOT #镜像地址
              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  #如果不存在则拉取
              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:
                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磁盘

--------------------

### 二.Pod 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的格式指定 #这一步需要先在node节点上先定义标签，最好唯一
        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

--------------------

### 三.Service yaml文件详解（真实运行在pod里的服务配置） ###

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                 #外部负载均衡器的主机名

这三类就是k8s中 比较重要的元素，整个架构就是依据这些文件运行的

下图就是官方给定的定义规则

![img][]

介绍完了详细的yml文件

下面列出几个简单的yaml文件，大家可以练习一下，非常帮助我们初学k8s平台的新生来理解。

### 练习 ###

1.定义nginx伸缩组，并绑定node节点

---
    apiVersion: apps/v1
    kind: Deployment
    metadata:
      name: kube100-site
      labels:
        aaa: bbb
    spec:
      selector:
        matchLabels:
         app: web
      replicas: 2
      template:
        metadata:
          labels:
            app: web
        spec: 
          containers:
            - name: front-end
              image: nginx
              ports:
                - containerPort: 80
          nodeSelector:
            disktype: ssd

解析

---
    apiVersion: apps/v1             #资源api接口
    kind: Deployment                #资源类型
    metadata:                       #资源元数据
      name: kube100-site            #资源名
      labels:                       #资源标签
        aaa: bbb                    #给这个资源打个标签
    spec:
      selector:
        matchLabels:
         app: web                   #定义要匹配的标签，和下面的pod要一样来保证对pod的正常监控
      replicas: 2 #定义保持pod的数量
      template:                     #模板（从这以下全是pod的配置）
        metadata:
          labels:                   #标签相关
            app: web                #便签信息
        spec: 
          containers:
            - name: front-end       #容器名
              image: nginx          #容器的镜像
              ports:                #端口定义
                - containerPort: 80
          nodeSelector:             ##定义到标签的node上，首先保证节点上存在的标签，没有则定义
            disktype: ssd

[img]: /images/20230208/e2967f2e15f944d8b3e544c87b3b9f05.png