文章目录
1. 简介
在K8s中,一般使用 yaml格式的文件来创建我们预期期望的Pod,这样的yaml文件我们一般称为资源清单;
1.1 简单说明
是一个可读性高,用来表达数据序列的格式。YAML的意思其实是:仍是一种标记语言,但为了强调这种语言以数据做为中心,而不是以标记语言为重点
1.2 基本语法
- 缩进时不允许使用Tab键,只允许使用空格
- 缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
- #标识注释,从这个字符一直到行尾,都会被解释器忽略
1.3 YAML支持的数据结构
- 对象:键值对的集合,又称为映射(mapping)/哈希(hashes)/字典(dictionary)
- 数组:一组按次序排列的值,又称为序列(sequence)/列表(list)
- 纯量(scalars): 单个的、不可再分的值
1.4 对象类型
写法1: 对象的属性和值是一组键值对,使用冒号结构表示
name: Steve
age: 18
写法2: 将所有键值对写成一个行内对象
hash: { name: Steve,age: 18}
1.5 数组类型
写法1:
animal:
- Cat
- Dog
写法2:
animal: [Cat,Dog]
1.6 纯量: 是最基本不可再分的值
- 字符串 布尔值 整数 浮点数 Null
- 时间 日期
- 数值直接以字面量的形式表示 number: 12.30
- 布尔值用true和false表示 isSet: true
- null 用~ 表示 parent: ~
- 时间采用ISO8601格式 iso8601: 2001-12-14t21:59:43.10-05:00
- 日期采用符合iso8601格式的年月日 date: 1976-03-01
- Yaml允许使用两个感叹号,强制转换数据类型 e: !! str 123 或 f: !!str true
1.7 字符串
字符串默认不使用引号表示
str: 这是一行字符串
如果字符串之间包含空格或特殊字符,需要放在引号之中
str: '内容: 字符串'
单引号和双引号都可以使用,双引号不会对特殊字符转义
s1: '内容\n字符串'
s2: "内容\n字符串"
单引号之中如果还有单引号,必须连续使用两个单引号转义
str: 'labor''s day'
字符串可以写成多行,从第二行开始,必须有一个单空格缩进,换行符会被转为空格
str: 这是一段
多行
字符串
多行字符串可以使用 | 保留换行符,也可以使用 > 折腾换行
this: |
FOO
Bar
that: >
Foo
Bar
+表示保留文字块末尾的换行, - 表示删除字符串末尾的换行
s1: |
Foo
S2: |+
Foo
S3: |-
Foo
2. 常用字段说明
2.1 必须存在的属性
参数名 | 字段类型 | 说明 |
---|---|---|
version | String | 这里指的是K8s API的版本,目前基本上是V1,可以使 kubectl api-version 命令查看 |
kind | String | 这里指的是yaml文件定义的资源类型和角色,比如 Pod |
metadata | Object | 元数据对象,固定值就写metadata |
metadata.name | String | 元数据对象的名字,这里由我们编写,比如命名Pod的名字 |
metadata.namespace | String | 元数据对象的命名空间,由我们自身定义 |
Spec | Object | 详细定义对象,固定值就写Spec |
spec.containers[] | list | 这里是spec对象的容器列表定义,是个列表 |
spec.containers[].name | String | 这里定义容器的名字 |
spec.containers[].image | String | 这里定义要用到的镜像名称 |
2.2 主要属性(不写会使用默认值)
参数名 | 字段类型 | 说明 |
---|---|---|
spec.containers[].imagePullPolicy | String | 定义镜像拉取策略,有Always ,Never ,lfNotPresent 三个值可选:(1)Always:意思是 每次都尝试重新拉取镜像(2) Never:表示仅 使用本地镜像 (3) IfNotPresent:如果本地有 镜像就使用本地镜像,没有就拉取在线镜像,上面三个值都没设置的话,默认是Always. |
spec.containers[].command | List | 指定容器启动命令,因为是数组可以指定多 个,不指定则使用镜像打包时使用的启动命令 |
spec.containers[].args[] | List | 指定容器启动命令参数,因为是数组可以指定 多个 |
spec.containers[].workingDir | String | 指定容器的工作目录 |
spec.containers[].volumeMounts[] | List | 指定容器内部的存储卷配置 |
spec.containers[].volumeMounts[] .name | String | 指定可以被容器挂载的存储卷的名称 |
spec.containers[].volumeMounts[] .mountPath | String | 指定可以被容器挂载的存储卷的路径 |
spec.containers[].volumeMounts[] .readOnly | String | 设置存储卷路径的读写模式,ture 或者false, 默认为读写模式 |
spec.containers[].ports[] | List | 指定容器需要用到的端☐列表 |
spec.containers[].ports[].name | String | 指定端☐名称 |
spec.containers[].ports[].containerPort | String | 指定容器需要监听的端☐号 |
spec.containers[].ports[].hostPort | String | String 指定容器所在主机需要监听的端☐号,默认跟 上面containerPort相同,注意设置了hostPort 同一台主机无法启动该容器的相同副本(因为 主机的端☐号不能相同,这样会冲突) |
spec.containers[].ports[].protocol | String | 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 -cpu-shares参数(这里前面文章 Pod资源限制有讲过) |
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,容器启动的初始 化可用数量 |
2.3 额外属性
参数名 | 字段类型 | 说明 |
---|---|---|
spec.restartPolicy | String | 定义Pod的重启策略,可选值为Always、 OnFailure,默认值为 Always. 1.Always: Pod一旦终止运 行,则无论容器是如何终止的,kubelet服务都将重启它。 2.OnFailure:只有Pod以非零退出码终止时,kubelet才会重启该容 器。如果容器正常结束(退出码为0),则kubelet将不会重启它。 3. Never: Pod终止后,Kubelet将退出码报告给Master,不会重启该 Pod。 |
spec.nodeSelector | Object | 定义Node的Label过滤标签,以key:value格式指定 |
spec.imageullSecrets | Object | 定义pull 镜像时使用secret名称,以name:secretkey格式指定 |
spec.hostNetwork | Boolean | 定义是否使用主机网络模式,默认值为false。设置true表示使用宿主 机网络,不使用docker网桥,同时设置了true将无法在同一台宿主机 上启动第二个副本。 |
2.4 举例创建一个最简单的demo
apiVersion: v1 # 版本 必选项
kind: pod # 告知类型是pod
metadata: # 元数据
name: myapp-pod #告知pod的名称
namespace: default # pod的名称空间,此行不写也可以,不写默认就说default
labels: # 标签
app: myapp # 定义app为myapp
version: v1 # 随便定义版本为v1版
spec: # 定义Pod里面运行的容器的详细信息
containers: # 容器组
- name: app # 定义第一个容器的名字
image: myapp:v1 #定义镜像
- name: test