十三、Kubernetes yaml资源清单详解

全栈行动派

已于 2023-01-03 09:09:03 修改

阅读量346

点赞数

分类专栏： kubernetes 文章标签： kubernetes docker java

于 2023-01-02 04:30:00 首次发布

本文链接：https://blog.csdn.net/u011837804/article/details/128421536

版权

kubernetes 专栏收录该内容

45 篇文章 42 订阅

订阅专栏

1、概述

kubectl提供了各种命令，来管理集群中的pod，但是这些命令都是为了方便运维测试，实际生产部署还得用yaml文件来部署，所以弄清楚各类资源的字段是非常重要的。

资源清单就是k8s当中用来定义pod的文件，语法格式遵循yaml语法，在yaml当中可以定义控制器类型，元数据，容器端口号等等等....，也可以针对于清单对pod进行删除等操作。

2、yaml资源清单各个字段中文详解

以Deployment为例，详解常用字段

小提示：
        # 在这里，可通过一个命令来查看每种资源的可配置项
        # kubectl explain 资源类型查看某种资源可以配置的一级属性
        # kubectl explain 资源类型.属性查看属性的子属性

apiVersion: apps/v1             #必填，版本号
kind: Deployment                #必填，资源类型
metadata:                       #必填，元数据
  labels:                       #自定义标签列表
    app: mynginx
  name: mynginx                 #Deployment名称
  namespace: dev                #Deployment命名空间
spec:                           #必填，Deployment管理的pod信息
  replicas: 1                   #管理pod副本个数
  selector:                     #选择器
    matchLabels:                #匹配标签选择器
      app: mynginx              #匹配标签，本例意思：Deployment控制器管理拥有app=mynginx标签的pod
  template:                     #模板
    metadata:                   #模板元数据
      labels:                   #模板标签，意思是此模板下所有容器均增加此标签
        app: mynginx
    spec:                       #必填，Pod中容器的详细定义
      containers:               #模板下拥有的容器，最少1个
        - image: nginx          #容器使用的镜像
          name: nginx           #容器名称
          imagePullPolicy: [ Always|Never|IfNotPresent ]  #获取镜像的策略
          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      #内存请求,容器启动的初始可用数量
          lifecycle:              #生命周期钩子
            postStart:            #容器启动后立即执行此钩子,如果执行失败,会根据重启策略进行重启
            preStop:              #容器终止前执行此钩子,无论结果如何,容器都会终止
          livenessProbe:          #对Pod内各容器健康检查的设置，当探测无响应几次后将自动重启该容器
            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的重启策略
      nodeName: <string>          #设置NodeName表示将该Pod调度到指定到名称的node节点上
      nodeSelector: obeject       #设置NodeSelector表示将该Pod调度到包含这个label的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的存储卷，挂载集群与定义的secret对象到容器内部
            scretname: string
            items:
              - key: string
                path: string
          configMap:               #类型为configMap的存储卷，挂载预定义的configMap对象到容器内部
            name: string
            items:
              - key: string
                path: string
status: {}

重要详解：

apiversion

用来指定api的版本，定义的语法格式为group/version,比如我们要定义deployment控制器，那么我们的apiVersion：apps/v1，如果我们要定义自主式pod，那么需要定义apiVersion：v1，如果要获取有哪些apiVersion可以用如下命令

kind

kind字段主要用于定义控制器类型,指的是yml文件定义的资源类型和角色，比如：我们想定义一个自助式pod，那么我们就应该定义kind：Pod，如果我们要定义一个deployment控制器管理的pod，那么我们就应该定义kind：Deployment

metadate

对于metadata字段为元数据，我们已经知道k8s是通过标签选择器的方式管理pod，因此，在metadata当中最重要的就是标签，我们可以在metadata当中定义名称空间，标签等，我们如果想查看metadata下可以定义哪些元数据可以使用kubectl explain pod.metadata命令来查看

labels：标签选择器，labels的值决定service控制器关联pod的重要选项

name：这里是自主式pod名称，如果是控制器pod，这里是控制器名称

namespace：名称空间，默认为default名称空间

annotations：资源注解，这里跟labels很像，都是键值对，但是不同点是，不能用于挑选资源对象，仅用于“元数据”