kubernetes实践(三)yaml文件详解
1.yaml文件简介
YAML(IPA: /ˈjæməl/)是一个可读性高,专门用来写配置文件的语言,非常简洁和强大,使用比json更方便。它实质上是一种通用的数据串行化格式
理解:Yet Another Markup Language
后缀:可以是.yml或者是.yaml,更加推荐.yaml,其实用任意后缀都可以,只是阅读性不强
2.yaml规则
它的基本语法规则如下:
- 大小写敏感
- 使用缩进表示层级关系
- 缩进时不允许使用Tab键,只允许使用空格。
- 缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
#
表示注释,从这个字符一直到行尾,都会被解析器忽略。- —表示分隔符,可以在一个文件中定义多个结构
- 使用key: value,其中“:”和value之间要有一个英文空格
在我们的kubernetes
中,你只需要两种结构类型就行了:
- Lists
- Maps
也就是说,你可能会遇到Lists的Maps和Maps的Lists,等等。不过不用担心,你只要掌握了这两种结构也就可以了,其他更加复杂的我们暂不讨论。
3.YAML Maps
首先我们来看看Maps
,我们都知道Map
是字典,就是一个key:value的键值对,Maps
可以让我们更加方便的去书写配置信息,例如:
--- apiVersion: v1 kind: Pod
解析
2.apiVersion表示key,v1表示value,英文":"后面要有一个空格 3.kind表示key,Pod表示value 4.也可以这样写apiVersion: "v1"
上面的 YAML 文件转换成 JSON 格式的话,你肯定就容易明白了:
{ "apiVersion": "v1", "kind": "pod" }
我们在创建一个相对复杂一点的 YAML 文件,创建一个 KEY 对应的值不是字符串而是一个 Maps:
apiVersion: apps/v1 kind: Pod metadata: name: nginx-pod labels: app: nginx
解析
2.name表示key,nginx-deployment表示value 3.labels表示key,下面的表示value,这个值又是一个map 4.app表示key,nginx表示value
注:上述的YAML文件中,metadata这个KEY对应的值为一个Maps,而嵌套的labels这个KEY的值又是一个Map。实际使用中可视情况进行多层嵌套。
YAML处理器根据行缩进来知道内容之间的关联。上述例子中,使用两个空格作为缩进,但空格的数据量并不重要,只是至少要求一个空格并且所有缩进保持一致的空格数 。例如,name和labels是相同缩进级别,因此YAML处理器知道他们属于同一map;它知道app是lables的值因为app的缩进更大。
注意:在YAML文件中绝对不要使用tab键
同样的,我们可以将上面的 YAML 文件转换成 JSON 文件:
{ "apiVersion": "apps/v1", "kind": "Pod", "metadata": { "name": "nginx-pod", "labels": { app": "nginx" } } }
4.YAML Lists
Lists
就是列表,说白了就是数组,在 YAML 文件中我们可以这样定义:
args -beijing -shanghai -shenzhen -guangzhou
你可以有任何数量的项在列表中,每个项的定义以破折号(-
)开头的,与父元素直接可以缩进一个空格。对应的 JSON 格式如下:
{
"args": ["beijing", "shanghai", "shenzhen", "guangzhou"]
}
当然,list 的子项也可以是 Maps,Maps 的子项也可以是list如下所示:
apiVersion: v1 kind: Pod metadata: name: myapp-pod labels: app: myapp spec: containers: - name: myapp-container01 image: busybox:1.28 ports: - containerPort: 80 - name: myapp-container02 image: busybox:1.28 ports: - containerPort: 80
比如这个 YAML 文件,我们定义了一个叫 containers 的 List 对象,每个子项都由 name、image、ports 组成,每个 ports 都有一个 key 为 containerPort 的 Map 组成,同样的,我们可以转成如下 JSON 格式文件:
{ "apiVersion": "v1", "kind": "Pod", "metadata": { "name": "myapp", "labels": { "app": "myapp" } }, "spec": { "containers": [{ "name": "myapp-container01", "image": "busybox:1.28", "ports": [{ "containerPort": "80" }] }, { "name": "myapp-container02", "image": "busybox:1.28", "ports": [{ "containerPort": "80" }] }] } }
5.使用 YAML 创建 Pod
(1)创建一个pod的yaml文件,名称为nginx_pod.yaml
apiVersion: v1 kind: Pod metadata: name: nginx-pod labels: app: nginx spec: containers: - name: nginx-container image: nginx ports: - containerPort: 80
这是我们上面定义的一个普通的 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 nginx_pod.yaml pod "nginx-pod" created
然后我们就可以使用我们前面比较熟悉的kubectl命令来查看 POD 的状态了:
$ kubectl get pods NAME READY STATUS RESTARTS AGE nginx-pod 2/2 Running 0 1m
到这里我们的 POD 就创建成功了,如果你在创建过程中有任何问题,我们同样可以使用前面的kubectl describe进行排查。我们删除上面创建的 POD:
$ kubectl delete -f nginx_pod.yaml pod "nginx-pod" deleted