4、Kubernetes 集群 YAML 文件详解

一、YAML 概述

k8s 集群中对资源管理和资源对象编排部署都可以通过声明YAML文件来解决，也就是可以把需要对资源对象操作编辑到 YAML 格式文件中，我们把这种文件叫做资源清单文件，通过 kubectl 命令直接使用资源清单文件就可以实现对大量的资源对象进行编排部署了。

• YAML 文件 : 就是资源清单文件，用于资源编排。

二、YAML 基本语法

• 通过缩进表示层级关系；
• 使用空格做为缩进，缩进的空格数目不重要，只要相同层级的元素左侧对齐即可，一般缩进两个空格；
• 低版本缩进时不允许使用 Tab 键，只允许使用空格；
• 使用#代表注释，从这个字符一直到行尾，都会被解释器忽略；
• 使用 --- 表示新的 yaml 文件开始；

三、YAML 数据结构

• 对象：键值对的集合，又称为映射 (mapping) / 哈希（hashes） / 字典（dictionary）

# 对象类型：对象的一组键值对，使用冒号结构表示
name: Tom
age: 18

# yaml 也允许另一种写法，将所有键值对写成一个行内对象
hash: {name: Tom, age: 18}

• 数组： 一组按次序排列的值，又称为序列（sequence） / 列表 （list）

# 数组类型：一组连词线开头的行，构成一个数组
People
- Tom
- Jack

# 数组也可以采用行内表示法
People: [Tom, Jack]

• 纯量（scalars）： 单个的、不可再分的值

number: 10.01

flag: true

# 字符串默认不使用引号表示
str: hello world

# 如果字符串中间包含空格或者特殊字符，需要放到引号中
str1: 'hello: world'

# 双引号不会对特殊字符进行转义
s1: '张\n三'
s2: "张\n三"

# 单引号中还有单引号，需要连续用两个单引号进行转义
s3: 'hello''world'

四、k8s资源清单描述方法

在 k8s 中，一般使用 YAML 格式的文件来创建符合我们预期期望的pod，这样的YAML 文件称为资源清单。主要分为两大部分，一个是控制器的定义、另一个是被控制的对象。

资源清单中常用的属性名称：

参数名

字段类型

说明

是否必须

version

String

这里指定是K8S API的版本，目前基本上是v1，可以通过kubectl api-versions命令查询

是

kind

String

yaml文件定义的资源类型和角色，比如：Pod、Deployment、ReplicaSet、Service

是

metadata

Object

元数据对象，固定值就写metadata

是

metadata.name

String

元数据对象的名字，由我们自定义，比如命名Pod的名字，Service的名字

是

metadata.namespace

String

元数据对象的命名空间，由我们自定义。非必填，默认为default

否

spec

Object

详细定义对象，固定值就写spec

是

spec.containers[]

list

spec对象的容器列表定义

是

spec.containers[].name

String

容器名字

是

spec.containers[].image

String

容器所使用的镜像

是

spec.containers[].imagePullPolicy

String

定义镜像拉取策略，有Always、Never、IfNotPresent三个值。

Always：意思是每次都尝试重新拉取镜像。（默认值是Always）

Never：表示仅使用本地镜像。

IfNotPresent：如果本地有镜像，就使用本地镜像，本地没有就拉取在线镜像。

否

spec.containers[].args[]

List

指定容器启动命令参数，因为是数组可以指定多个

否

spec.containers[].command[]

list

容器启动时执行的命令，因为是数组，可以指定多个。如果不指定，使用镜像打包时的启动命令

spec.containers[].workingDir

String

指定容器工作目录

否

spec.containers[].volumeMounts[]

List

指定容器内部的存储卷配置

否

spec.containers[].volumeMounts[].name

String

指定可以被容器挂载的存储卷的名称

否

spec.containers[].volumeMounts[].mountPath

String

指定可以被容器挂载的存储卷的路径

否

spec.containers[].volumeMounts[].readOnly

String

设置存储卷路径的读写模式，true或者false

默认为读写模式

否

spec.containers[].ports[]

List

指定容器需要用到的端口列表

否

spec.containers[].ports[].name

String

指定端口名

否

spec.containers[].ports[].containerPort

String

指定容器需要监听的端口号

否

spec.containers[].ports[].hostPort

String

指定容器所在主机需要监听的端口号，默认跟上面的containerPort相同，注意设置了hostPort，同一台主机无法启动该容器的相同副本（因为主机端口号不能相同，这样会冲突）

否

spec.containers[].ports[].protocol

String

指定端口协议，支持TCP和UDP。默认值为TCP

否

spec.containers[].env[]

List

容器运行前需要设置的环境变量列表

否

spec.containers[].env[].name

String

环境变量的名称

否

spec.containers[].env[].value

String

环境变量的值

否

spec.containers[].resources

Object

指定资源限制和资源请求的值（这里开始就是设置容器的资源上限）

否

spec.containers[].resources.limits

Object

指定容器运行时资源的运行上限

否

spec.containers[].resources.limits.cpu

String

指定CPU的限制，单位为core数，将用于docker run --cou-shares参数

否

spec.containers[].resources.limits.memory

String

指定MEM内存的限制，单位为MiB、GiB

否

spec.containers[].resources.requests

Object

指定容器启动和调度时的限制设置

否

spec.containers[].resources.requests.cpu

String

CPU请求，单位为core数，容器启动时初始化可用数量

否

spec.containers[].resources.requests.memory

String

内存请求，单位为MiB、GiB，容器启动时初始化可用数量

否

spec.restartPolicy

String

定义Pod重启策略，可选值为Always、OnFailure、Never，默认值为Always。

Always：Pod一旦终止运行，则无论容器是如何终止的，kubelet服务都将重启Pod

OnFailure：只有Pod以非零退出码终止时，kubelet才会重启该容器。如果容器正常结束（退出码为0），则kubelet将不会重启它。

Never：Pod终止后，kubelet将退出码报告给Master，不会重启该Pod

否

spec.nodeSelector

Object

定义Node的Label过滤标签，以key-value格式指定

否

spec.imagePullSecrets

Object

定义PUll镜像时使用secret名称，以name:secretkey格式指定

spec.hostNetwork

Bollean

是否使用主机网络模式，默认值为false。设置为true表示使用宿主机网络，不适用docker网桥。同时设置了true将无法在同一台宿主机上启动第二个副本。

五、YAML 快速编写

一般来说，我们很少自己手写 YAML 文件，因为这里面涉及到了很多内容，我们一般都会借助工具来创建。

1、使用 kubectl create 命令

这种方式一般用于资源没有部署的时候，我们可以直接创建一个 YAML 配置文件。

# 尝试运行，并不会真正的创建镜像
[root@localhost ~]# kubectl create deployment web --image=nginx -o yaml --dry-run=client
apiVersion: apps/v1
kind: Deployment
metadata:
  creationTimestamp: null
  labels:
    app: web
  name: web
spec:
  replicas: 1
  selector:
    matchLabels:
      app: web
  strategy: {}
  template:
    metadata:
      creationTimestamp: null
      labels:
        app: web
    spec:
      containers:
      - image: nginx
        name: nginx
        resources: {}
status: {}

--dry-run：尝试运行，并不会真正的创建镜像。

或者我们可以输出到一个文件中：

[root@localhost ~]# kubectl create deployment web --image=nginx -o yaml --dry-run=client > nginx.yaml

[root@localhost ~]# cat nginx.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  creationTimestamp: null
  labels:
    app: web
  name: web
spec:
  replicas: 1
  selector:
    matchLabels:
      app: web
  strategy: {}
  template:
    metadata:
      creationTimestamp: null
      labels:
        app: web
    spec:
      containers:
      - image: nginx
        name: nginx
        resources: {}
status: {}

然后我们就在文件中直接修改即可。

2、使用 kubectl get 命令导出 yaml 文件

可以首先查看一个目前已经部署的镜像：

kubectl get deploy

然后我们导出 nginx 的配置，然后会生成一个 nginx.yaml 的配置文件。

# 本例使用的1.21.3版本
kubectl get deploy nginx -o=yaml > nginx.yaml

# 如果是旧版本的k8s，需指定--export
kubectl get deploy nginx -o=yaml --export > nginx.yaml

示例如下：

[root@localhost ~]# kubectl create deployment nginx --image=nginx
deployment.apps/nginx created

[root@localhost ~]# kubectl get deploy
NAME    READY   UP-TO-DATE   AVAILABLE   AGE
nginx   1/1     1            1           8s

[root@localhost ~]# kubectl get deploy nginx -o=yaml > nginx.yaml
[root@localhost ~]# cat nginx.yaml 
apiVersion: apps/v1
kind: Deployment
metadata:
  annotations:
    deployment.kubernetes.io/revision: "1"
  creationTimestamp: "2022-11-25T06:55:03Z"
  generation: 1
  labels:
    app: nginx
  name: nginx
  namespace: default
  resourceVersion: "4408"
  uid: d6dc9709-72d1-4657-ace2-273cee3e0013
spec:
  progressDeadlineSeconds: 600
  replicas: 1
  revisionHistoryLimit: 10
  selector:
    matchLabels:
      app: nginx
  strategy:
    rollingUpdate:
      maxSurge: 25%
      maxUnavailable: 25%
    type: RollingUpdate
  template:
    metadata:
      creationTimestamp: null
      labels:
        app: nginx
    spec:
      containers:
      - image: nginx
        imagePullPolicy: Always
        name: nginx
        resources: {}
        terminationMessagePath: /dev/termination-log
        terminationMessagePolicy: File
      dnsPolicy: ClusterFirst
      restartPolicy: Always
      schedulerName: default-scheduler
      securityContext: {}
      terminationGracePeriodSeconds: 30
status:
  availableReplicas: 1
  conditions:
  - lastTransitionTime: "2022-11-25T06:55:09Z"
    lastUpdateTime: "2022-11-25T06:55:09Z"
    message: Deployment has minimum availability.
    reason: MinimumReplicasAvailable
    status: "True"
    type: Available
  - lastTransitionTime: "2022-11-25T06:55:03Z"
    lastUpdateTime: "2022-11-25T06:55:09Z"
    message: ReplicaSet "nginx-6799fc88d8" has successfully progressed.
    reason: NewReplicaSetAvailable
    status: "True"
    type: Progressing
  observedGeneration: 1
  readyReplicas: 1
  replicas: 1
  updatedReplicas: 1