K8s＜四＞

六、Kubernetes YAML

1、YAML 基础

• YAML 是专门用来写配置文件的语言，非常简洁和强大，使用比 json 更方便。它实质上是一种通用的数据串行化格式。后文会说明定义 YAML 文件创建 Pod 和创建Deployment。

1、YAML 语法规则

• 大小写敏感
• 使用缩进表示层级关系
• 缩进时不允许使用Tal键，只允许使用空格
• 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
• ”#” 表示注释，从这个字符一直到行尾，都会被解析器忽略

2、使用 YAML 用于K8s的定义带来的好处

• 便捷性：不必添加大量的参数到命令行中执行命令
• 可维护性：YAML 文件可以通过源头控制，跟踪每次操作
• 灵活性：YAML 可以创建比命令行更加复杂的结构

3、YAML 结构类型

• 在 Kubernetes 中，只需要知道两种结构类型即可：
  • Lists
  • Maps

1、YAML Maps

• Map顾名思义指的是字典，即一个Key:Value 的键值对信息。例如：

---
apiVersion: v1
kind: Pod

• 注：— 为可选的分隔符 ，当需要在一个文件中定义多个结构的时候需要使用。上述内容表示有两个键 apiVersion 和 kind，分别对应的值为 v1 和 Pod。

• Maps 的 value 既能够对应字符串也能够对应一个Maps例如：

---
apiVersion: v1
kind: Pod
metadata:
  name: kube100-site1
  labels:
    app: web
spec:
  containers:
  - name: myapp
    image: ikubernetes/myapp:v1
  - name: busybox
    image: busybox
    command:
    - "/bin/sh"
    - "-c"
    - "sleep 3600"

---
apiVersion: v1
kind: Pod
metadata:
  name: kube100-site1
  labels:
    app: web
spec:
  containers:
  - name: myapp
    image: ikubernetes/myapp:v1
  - name: busybox
    image: busybox
    command:
    - "/bin/sh"
    - "-c"
    - "sleep 3600"
# 通配置 json 结构
{
  "containers": [{name:myapp,image:myapp}, {name:busybox,image:busybox,"command":["/bin/sh", "-c", "sleep 3600"]}]
}

• 注：上述的YAML文件中，metadata 这个KEY对应的值为一个Maps，而嵌套的labels这个KEY的值又是一个Map。实际使用中可视情况进行多层嵌套。

• YAML处理器根据行缩进来知道内容之间的关联。上述例子中，使用两个空格作为缩进，但空格的数据量并不重要，只是至少要求一个空格并且所有缩进保持一致的空格数 。例如，name和labels是相同缩进级别，因此YAML处理器知道他们属于同一map；它知道app是lables的值因为app的缩进更大。

• 注意：在YAML文件中绝对不要使用 tab 键

2、YAML Lists

• List 即列表，说白了就是数组，例如：

    command:
    - "/bin/sh"
    - "-c"
    - "sleep 3600"

• 可以指定任何数量的项在列表中，每个项的定义以破折号（-）开头，并且与父元素之间存在缩进。在JSON格式中，表示如下：

{
  "command": ["/bin/sh", "-c", "sleep 3600"]
}

• 当然 Lists 的子项也可以是 Maps，Maps 的子项也可以是List，例如：

---
apiVersion: v1
kind: Pod
metadata:
  name: kube100-site
  labels:
    app: web
spec:
  containers:
    - name: front-end
      image: nginx
      ports:
        - containerPort: 80
    - name: flaskapp-demo
      image: jcdemo/flaskapp
      ports:
        - containerPort: 8080

• 定义一个containers的List对象，每个子项都由name、image、ports组成，每个ports都有一个KEY为containerPort的Map组成，转成JSON格式文件：

{
  "apiVersion": "v1",
  "kind": "Pod",
  "metadata": {
        "name": "kube100-site",
        "labels": {
            "app": "web"
        },

  },
  "spec": {
        "containers": [{
            "name": "front-end",
            "image": "nginx",
            "ports": [{
                "containerPort": "80"
            }]
        }, {
            "name": "flaskapp-demo",
            "image": "jcdemo/flaskapp",
            "ports": [{
                "containerPort": "5000"
            }]
        }]
  }
}

2、使用 YAML创建 Pod

1、创建 Pod

---
apiVersion: v1
kind: Pod
metadata:
  name: kube100-site
  labels:
    app: web
spec:
  containers:
    - name: front-end
      image: nginx
      ports:
        - containerPort: 80
    - name: flaskapp-demo
      image: jcdemo/flaskapp
      ports:
        - containerPort: 5000

• apiVersion：此处值是v1，这个版本号需要根据安装的 Kubernetes 版本和资源类型进行变化，记住不是写死的。

• kind：此处创建的是Pod，根据实际情况，此处资源类型可以是Deployment、Job、Ingress、Service等。

• metadata：包含 Pod 的一些 meta 信息，比如 名称、namespace、标签等信息。

• spec：包括一些 container，storage，volume 以及其他 Kubernetes 需要的参数，以及诸如是否在容器失败时重新启动容器的属性。可在特定 Kubernetes API 找到完整的 Kubernetes Pod 的属性。

• 下面是一个典型的容器的定义：

…
spec:
  containers:
    - name: front-end
      image: nginx
      ports:
        - containerPort: 80

• 上述例子只是一个简单的最小定义：一个名字（front-end）、基于nginx的镜像，以及容器将会监听的指定端口号（80）。

• 除了上述的基本属性外，还能够指定复杂的属性，包括容器启动运行的命令、使用的参数、工作目录以及每次实例化是否拉取新的副本。 还可以指定更深入的信息，例如容器的退出日志的位置。容器可选的设置属性包括：name、image、command、args、workingDir、ports、env、resource、volumeMounts、livenessProbe、readinessProbe、livecycle、terminationMessagePath（终止消息）、imagePullPolicy、securityContext（安全上下文）、stdin、stdinOnce、tty

• 了解了Pod的定义后，将上面创建Pod的YAML文件保存成pod.yaml，然后使用Kubectl创建Pod：

[root@k8s-master ~]# kubectl create -f pod.yaml
pod "kube100-site" created

• 可以使用Kubectl命令查看Pod的状态

[root@k8s-master ~]# kubectl get pods
NAME           READY     STATUS    RESTARTS   AGE
kube100-site   2/2       Running   0          1m123

• 注： Pod创建过程中如果出现错误，可以使用kubectl describe 进行排查。

2、使用 YAML 创建 Deployment

• 上述介绍了如何使用YAML文件创建Pod实例，但是如果这个Pod出现了故障的话，对应的服务也就挂掉了，所以Kubernetes提供了一个Deployment的概念 ，目的是让Kubernetes去管理一组Pod的副本，也就是副本集 ，这样就能够保证一定数量的副本一直可用，不会因为某一个Pod挂掉导致整个服务挂掉。

---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: kube100-site
  labels:
    kube: kubetest
spec:
  selector:
    matchLabels:   # 匹配标签，matchExpressions 匹配表达式 
      app: web      
  replicas: 2
  template:
    metadata:
      labels:
        app: web
    spec: 
      containers:
        - name: front-end
          image: nginx
          ports:
            - containerPort: 80
        - name: flaskapp-demo
          image: jcdemo/flaskapp
          ports:
            - containerPort: 5000

• 注意这里apiVersion对应的值是apps/v1beta1或者v1，同时也需要将kind的类型指定为Deployment。

• metadata指定一些meta信息，包括名字或标签之类的。

• spec 选项定义需要两个副本，此处可以设置很多属性，例如受此Deployment影响的Pod的选择器等

• spec 选项的template其实就是对Pod对象的定义

• 可以在Kubernetes v1beta1 API 参考中找到完整的Deployment可指定的参数列表

• 将上述的YAML文件保存为deployment.yaml，然后创建Deployment：

[root@k8s-master ~]# kubectl create -f deployment.yaml
deployment "kube100-site" created

• 可以使用如下命令检查Deployment的列表：

[root@k8s-master ~]# kubectl get deployments
NAME           DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
kube100-site   2         2         2            2           2m123

3、Yaml 配置示例

apiVersion: v1             # 指定api版本，此值必须在 kubectl apiversion 中  
kind: Pod                  # 指定创建资源的角色/类型  
metadata:                  # 资源的元数据/属性  
  name: django-pod         # 资源的名字，在同一个 namespace 中必须唯一  
  labels:                  # 设定资源的标签，使这个标签在 service 网络中备案，以便被获知
    k8s-app: django
    version: v1  
    kubernetes.io/cluster-service: "true"  
  annotations:             # 设置自定义注解列表  
    - name: String         # 设置自定义注解名字  
spec:                      # 设置该资源的内容  
  restartPolicy: Always    # 表示自动重启，一直都会有这个容器运行
  nodeSelector: 
    zone: hd               # 选择node 节点     zone: k8s-node01  
  containers:  
  - name: django-pod       # 容器的名字  
    image: django:v1.1     # 容器使用的镜像地址  
    imagePullPolicy: Never # 三个选择Always、Never、IfNotPresent，每次启动时检查和更新（从registery）images的策略，
                           # Always，每次都检查
                           # Never，每次都不检查（不管本地是否有）
                           # IfNotPresent，如果本地有就不检查，如果没有就拉取
    command: ['sh']        # 启动容器的运行命令，将覆盖容器中的Entrypoint,对应Dockefile中的ENTRYPOINT  
    args: ["$(str)"]       # 启动容器的命令参数，对应 Dockerfile 中 CMD 参数  
    env:                   # 指定容器中的环境变量  
    - name: str            # 变量的名字  
      value: "/etc/run.sh" # 变量的值   sh /etc/run.sh
    resources:             # 资源管理
      requests:            # 容器运行时，最低资源需求，也就是说最少需要多少资源容器才能正常运行  
        cpu: 100m          # CPU资源（核数），两种方式，浮点数或者是整数+m，0.1=100m，最少值为0.001核（1m）  4  16  4  c 0.1
        memory: 32Mi       # 内存使用量  
      limits:              # 资源限制  
        cpu: 500m 
        memory: 32Mi  
    ports:  
    - containerPort: 8080  # 容器开放对外的端口
      name: uwsgi          # 名称
      protocol: TCP  
    livenessProbe:         # pod内容器健康检查的设置
      httpGet:             # 通过httpget检查健康，返回200-399之间，则认为容器正常  
        path: /            # URI地址  
        port: 8080  
        #host: 127.0.0.1   #主机地址  
        scheme: HTTP       # 访问协议（方式）
      initialDelaySeconds: 18 # 表明第一次检测在容器启动后多长时间后开始  
      timeoutSeconds: 5    # 检测的超时时间  
      periodSeconds: 15    # 检查间隔时间  
      #也可以用这种方法  
      #exec: 执行命令的方法进行监测，如果其退出码不为0，则认为容器正常  
      #  command:  
      #    - cat  
      #    - /tmp/health  
      #也可以用这种方法  
      #tcpSocket: # 通过 tcpSocket 检查健康   
      #  port: number   
    lifecycle:             # 生命周期管理(钩子)  
      postStart:           # 容器运行之前运行的任务  
        exec:  
          command:  
            - 'sh'  
            - 'yum upgrade -y'  
      preStop:             # 容器关闭之前运行的任务  
        exec:  
          command: ['service httpd stop']  
    volumeMounts:          # 挂载设置
    - name: volume         # 挂载设备的名字，与volumes[*].name 需要对应    
      mountPath: /data     # 挂载到容器的某个路径下  
      readOnly: True  
  volumes:                 # 定义一组挂载设备  
  - name: volume           # 定义一个挂载设备的名字  
    # meptyDir: {}  
    hostPath:  
      path: /opt           # 挂载设备类型为 hostPath，路径为宿主机下的 /opt