YAML 基础

   刚刚写kubernetes的YAML文件时比较迷糊。

   本文参考https://blog.qikqiak.com/post/use-yaml-create-kubernetes-deployment/

YAML 基础

YAML 是专门用来写配置文件的语言，非常简洁和强大，远比JSON格式方便。YAML语言（发音 /ˈjæməl/）的设计目标，就是方便人类读写。它实质上是一种通用的数据串行化格式。

它的基本语法规则如下：

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

在我们的kubernetes中，你只需要两种结构类型就行了：

• Lists
• Maps

也就是说，你可能会遇到Lists的Maps和Maps的Lists，等等。不过不用担心，你只要掌握了这两种结构也就可以了，其他更加复杂的我们暂不讨论。

Maps

首先我们来看看Maps，我们都知道Map是字典，就是一个key:value的键值对，Maps可以让我们更加方便的去书写配置信息，例如：

--- apiVersion: v1 kind: Pod 

第一行的---是分隔符，是可选的，在单一文件中，可用连续三个连字号---区分多个文件。这里我们可以看到，我们有两个键：kind 和 apiVersion，他们对应的值分别是：v1和Pod。上面的 YAML 文件转换成 JSON 格式的话，你肯定就容易明白了：

{ "apiVersion": "v1", "kind": "pod" } 

我们在创建一个相对复杂一点的 YAML 文件，创建一个 KEY 对应的值不是字符串而是一个 Maps：

--- apiVersion: v1 kind: Pod metadata: name: kube100-site labels: app: web 

上面的 YAML 文件，metadata 这个 KEY 对应的值就是一个Maps了，而且嵌套的 labels 这个 KEY 的值又是一个Map，你可以根据你自己的情况进行多层嵌套。

上面我们也提到了 YAML 文件的语法规则，YAML 处理器是根据行缩进来知道内容之间的嗯关联性的。比如我们上面的 YAML 文件，我用了两个空格作为缩进，空格的数量并不重要，但是你得保持一致，并且至少要求一个空格（什么意思？就是你别一会缩进两个空格，一会缩进4个空格）。我们可以看到 name 和 labels 是相同级别的缩进，所以 YAML 处理器就知道了他们属于同一个 MAP，而 app 是 labels 的值是因为 app 的缩进更大。

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

同样的，我们可以将上面的 YAML 文件转换成 JSON 文件：

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

或许你对上面的 JSON 文件更熟悉，但是你不得不承认 YAML 文件的语义化程度更高吧？

Lists

Lists就是列表，说白了就是数组，在 YAML 文件中我们可以这样定义：

args - Cat - Dog - Fish 

你可以有任何数量的项在列表中，每个项的定义以破折号（-）开头的，与父元素直接可以缩进一个空格。对应的 JSON 格式如下：

{ "args": [ 'Cat', 'Dog', 'Fish' ] } 

当然，list 的子项也可以是 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: 5000 

比如这个 YAML 文件，我们定义了一个叫 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" }] }] } }

是不是觉得用 JSON 格式的话文件明显比 YAML 文件更复杂了呢？

使用 YAML 创建 Pod

现在我们已经对 YAML 文件有了大概的了解了，我相信你应该没有之前那么懵逼了吧？我们还是来使用 YAML 文件来创建一个 Deployment 吧。当然如果你的kubernetes集群还没搭建完成的话，可以继续阅读前面 手动搭建高可用的 kubernetes 集群 的文章。

创建 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 

这是我们上面定义的一个普通的 POD 文件，我们先来简单分析下文件内容：

• apiVersion，这里它的值是v1，这个版本号需要根据我们安装的kubernetes版本和资源类型进行变化的，记住不是写死的
• kind，这里我们创建的是一个 Pod，当然根据你的实际情况，这里资源类型可以是 Deployment、Job、Ingress、Service 等待。
• metadata：包含了我们定义的 Pod 的一些 meta 信息，比如名称、namespace、标签等等信息。
• spec：包括一些 containers，storage，volumes，或者其他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
• resources
• volumeMounts
• livenessProbe
• readinessProbe
• livecycle
• terminationMessagePath
• imagePullPolicy
• securityContext
• stdin
• stdinOnce
• tty

明白了 POD 的定义后，我们将上面创建 POD 的 YAML 文件保存成pod.yaml，然后使用kubectl创建 POD：

$ kubectl create -f pod.yaml pod "kube100-site" created 

然后我们就可以使用我们前面比较熟悉的kubectl命令来查看 POD 的状态了：

$ kubectl get pods NAME READY STATUS RESTARTS AGE kube100-site 2/2 Running 0 1m 

到这里我们的 POD 就创建成功了，如果你在创建过程中有任何问题，我们同样可以使用前面的kubectl describe进行排查。我们先删除上面创建的 POD：

$ kubectl delete -f pod.yaml pod "kube100-site" deleted 

创建 Deployment

现在我们可以来创建一个真正的 Deployment。在上面的例子中，我们只是单纯的创建了一个 POD 实例，但是如果这个 POD 出现了故障的话，我们的服务也就挂掉了，所以kubernetes提供了一个Deployment的概念，可以让kubernetes去管理一组 POD 的副本，也就是副本集，这样就可以保证一定数量的副本一直可用的，不会因为一个 POD 挂掉导致整个服务挂掉。我们可以这样定义一个Deployment：

--- apiVersion: extensions/v1beta1 kind: Deployment metadata: name: kube100-site spec: replicas: 2 

注意这里的apiVersion对应的值是extensions/v1beta1，当然kind要指定为Deployment，因为这就是我们需要的，然后我们可以指定一些 meta 信息，比如名字，或者标签之类的。最后，最重要的是spec配置选项，这里我们定义需要两个副本，当然还有很多可以设置的属性，比如一个 Pod 在没有任何错误变成准备的情况下必须达到的最小秒数。

我们可以在Kubernetes v1beta1 API参考中找到一个完整的 Depolyment 可指定的参数列表。

现在我们来定义一个完整的 Deployment 的 YAML 文件：

--- apiVersion: extensions/v1beta1 kind: Deployment metadata: name: kube100-site spec: 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 

看起来是不是和我们上面的pod.yaml很类似啊，注意其中的template，其实就是对 POD 对象的定义。将上面的 YAML 文件保存为deployment.yaml，然后创建 Deployment：

$ kubectl create -f deployment.yaml deployment "kube100-site" created 

同样的，想要查看它的状态，我们可以检查Deployment的列表：

$ kubectl get deployments NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE kube100-site 2 2 2 2 2m 

我们可以看到所有的 Pods 都已经正常运行了。

到这里我们就完成了使用 YAML 文件创建 Kubernetes Deployment 的过程，在了解了 YAML 文件的基础后，定义 YAML 文件其实已经很简单了，最主要的是要根据实际情况去定义 YAML 文件，所以查阅 Kubernetes 文档很重要。

下面是一个完整的yaml格式定义的文件

apiVersion: 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         //容器中的镜像
    imagesPullPolicy: [Always|Never|IfNotPresent]//获取镜像的策略
    command: [String]     //容器的启动命令列表（不配置的话使用镜像内部的命令）
    args: [String]        //启动参数列表
    workingDir: String    //容器的工作目录
    volumeMounts:         //挂载到到容器内部的存储卷设置
    - name: String
      mountPath: String
      readOnly: boolean
    ports:                //容器需要暴露的端口号列表
    - name: String
      containerPort: int  //容器要暴露的端口
      hostPort: int       //容器所在主机监听的端口（容器暴露端口映射到宿主机的端口）
      protocol: String
    env:                  //容器运行前要设置的环境列表
    - name: String
      value: String
    resources:            //资源限制
      limits:
        cpu: "250m"       //m表示cpu的千分之一，250m表示占用0.25个CPU
        memory: "64Mi"    //64MiB内存 
      requeste:
        cpu: "500m"
        memory: "128Mi"
    livenessProbe:         //pod内容器健康检查的设置
      exec:
        command: [String]
      httpGet:             //通过httpget检查健康
        path: String
        port: number
        host: String
        scheme: Srtring
        httpHeaders:
        - name: Stirng
          value: String 
      tcpSocket:           //通过tcpSocket检查健康
        port: number
      initialDelaySeconds: 0//首次检查时间
      timeoutSeconds: 0     //检查超时时间
      periodSeconds: 0      //检查间隔时间
      successThreshold: 0
      failureThreshold: 0
      securityContext:      //安全配置
        privileged: falae
    restartPolicy: [Always|Never|OnFailure]//重启策略
    nodeSelector: object    //节点选择
    imagePullSecrets:
    - name: String
    hostNetwork: false      //是否使用主机网络模式，默认否
  volumes:                  //在该pod上定义共享存储卷
  - name: String
    meptyDir: {}
    hostPath:
      path: string
    secret:                 //类型为secret的存储卷
      secretName: String
      item:
      - key: String
        path: String
    configMap:             //类型为configMap的存储卷
      name: String
      items:
      - key: String
        path: String

 

 

参考资料

• https://www.mirantis.com/blog/introduction-to-yaml-creating-a-kubernetes-deployment/
• http://yaml.org/
• Kubernetes v1beta1 API