文章目录
此文参考文章:Kubernetes 系列(四):如何编写k8s yaml文件 - -零 - 博客园 (cnblogs.com)
一、概述
K8s中,支持YAML
和JSON
两种格式来管理资源对象,但是通常来说使用JSON格式更多的是用于api接口之间的消息传递,而YAML格式是专门用来写配置文件的语言,对比JSON来说更加简洁方便,所以,在K8S中通常都使用YAML文件来管理资源对象
二、YAML文件基础
-
YAML文件编写规则:
- 文件中单词
大小写敏感
- yaml文件中使用缩进来表示层级关系,并且只能使用
空格
- 缩进使用的空格数量不重要,只要
相同层级对齐
即可 - yaml文件中使用
#
来表示注释 - 字符后缩进一个字符,如冒号
:
、逗号,
、短横杆-
等 ---
表示文件开始,利用---
可以把多个资源写入一个yaml文件中
- 文件中单词
-
YAML文件的结构类型:
(1)
键值对——key:value
:YAML文件中的基本条目类型是键值对
类型,格式为:键: 值
,注意冒号和值之间有一个空格- 例如: apiVersion: apps/v1 kind: Deployment #这两个就是键值对,中间有空格隔开 - 转换成json格式: { "apiVersion": "apps/v1", "kind": "Deployment" }
(2)
列表(数组)——list
:列表会在列表名称下列出一些元素,其实也就是数组,列表以-
开头,可以有多个列表,需要注意列表中各个元素的缩进- 例如: args: - "test" - "aaaa" - "ccc" #需要注意缩进需要相同 - 转换成json格式 { "args": [ "test", "aaaa", "ccc" ] }
(3)
字典(地图)——map
:字典中包含了键值对、列表,也可以嵌套字典- 例如: metadata: labels: app: test name: test namespace: test #可以嵌套字典 - 转换成json格式 { "metadata": { "labels": { "app": "test" }, "name": "test", "namespace": "test" } }
-
从上面的结构类型可以看出,YAML比JSON更加简洁,编写更加方便
三、YAML使用
- 在K8S中,Pod是最小单元,Pod的信息都记录在一个YAML文件中
- 下面是定义PodYAML文件的一些参数
- 必写参数:
- 一个YAML文件中,下面的参数是必须要写的,否则会报错:
参数 | 值类型 | 作用 |
---|---|---|
aplVersion | 字符串str | 指定K8S的API版本,通常使用v1,可以使用kubectl api-versions查询 可用版本,关于版本可以去k8s的官网查看 |
kind | 字符串str | 定义资源类型和角色,例如:Pod、Deployment等 |
metadata | 对象Object | 元数据对象,后面无需写其他的值,只需要写metadata: 即可 |
metadata.name | 字符串str | 定义元数据对象的名称,用于命名Pod的名字 |
metadata.namespace | 字符串str | 定义元数据对象的命名空间,用于指定Pod的命名空间 |
spec | 对象Object | 详细定义对象,后面无需写其他值,只需要写spec: 即可 |
spec.containers | 列表list | 定义spec对象的容器列表 |
spec.containers.name | 字符串str | 定义容器的名称 |
spec.containers.image | 字符串str | 定义容器使用的镜像名称 |
- 以上就是在K8S中编写一个YAML文件的必要参数
- spec.containers主要参数
- spec.containers是一个列表list,作用是定义容器方面的相关参数,下面是spec.containers的主要参数
参数名 | 值类型 | 作用 |
---|---|---|
spec.containers.name | 字符串str | 用于定义容器的名称 |
spec.containers.image | 字符串str | 用于定义容器使用的镜像名称 |
spec.containers.imagePullPolicy | 字符串str | 用于定义拉取镜像时的策略,有Always(每次都尝试重新拉取镜像) 、Never(从不拉取镜像,使用本地镜像) 、IfNotPresent(如果本地有镜像就是要本地的,没有就拉取镜像) 三种策略,默认为Always |
spec.containers.command | 列表list | 用于指定容器启动时命令,可以指定多个,如果不指定则使用镜像本身使用的启动命令 |
spec.containers.args | 列表list | 用于指定容器启动时命令参数 ,可以指定多个,不指定则使用镜像本身使用的启动命令 |
spec.containers.workingDir | 字符串str | 用于指定容器的工作目录,不指定则使用镜像本身设置的工作目录 |
spec.containers.volumeMounts | 列表list | 用于指定容器内部的存储卷位置 |
spec.containers.volumeMounts.name | 字符串str | 用于指定被容器挂载的存储卷的名称 |
spec.containers.volumeMounts.mountPath | 字符串str | 用于指定被容器挂载的存储卷的路径 |
spec.containers.volumeMounts.readOnly | 字符串str | 用于设置存储卷路径的读写模式,值为true 或者false ,默认为读写模式 |
spec.containers.ports | 列表list | 用于指定容器需要用到的端口,可以写多个 |
spec.containers.ports.name | 字符串str | 用于指定上面的端口的名称 |
spec.containers.ports.containerPort | 字符串str | 用于指定容器需要监听的端口号 |
spec.containers.ports.hostPort | 字符串str | 用于指定容器所在主机需要监听的端口号,默认跟上面containerPort 相同,需要注意:设置了hostPort 的同一台主机无法启动该容器的相同副本,因为主机的端口号不能相同,这样会产生冲突 |
spec.containers.ports.protocol | 字符串str | 用于指定端口协议,支持TCP和UDP,默认为TCP |
spec.containers.env | 列表list | 用于指定容器运行前需要设置的环境变量,可以指定多个 |
spec.containers.env.name | 字符串str | 用于指定环境变量名称 |
spec.containers.env.value | 字符串str | 用于指定环境变量的值 |
spec.containers.resources | 对象Object | 用于指定容器资源限制和资源请求的值 |
spec.containers.resources.limits | 对象Object | 用于指定容器运行时资源的分配以及上限 |
spec.containers.resources.limits.cpu | 字符串str | 用于指定容器中CPU的限制,单位为core核数 |
spec.containers.resources.limits.memory | 字符串str | 用于指定mem内存的限制,单位为MB 和GB |
spec.containers.resources.requests | 对象Object | 用于指定容器启动和调度时的资源限制 |
spec.containers.resources.requests.cpu | 字符串str | 用于指定容器启动时CPU初始化的可用数量,数量单位为core核数 |
spec.containers.resources.requests.memory | 字符串str | 用于指定容器启动时的初始化可用数量,数量单位为MB和GB |
- spec.volumes主要参数
- spec.volumes是个list列表,定义同步存储方面的参数,下面是主要参数
参数名 | 值类型 | 作用 |
---|---|---|
spec.volumes.name | 字符串str | 用于定义Pod的共享存储卷名称,与容器定义部分的spec.containers.volumeMounts.name 的值是一样的 |
spec.volumes.emptyDir | 对象Object | 用于指定Pod的临时目录,值是一个空对象emptyDir:{} |
spec.volumes.hostPath | 对象Object | 用于指定挂载Pod所在的宿主机目录 |
spec.volumes.hostPath.path | 字符串str | 用于指定Pod所在的主机目录,将被用于容器中mount挂载的目录 |
spec.volumes.secret | 对象Object | 用于指定类型为secret的存储卷,secret意为私密、秘密的意思,很容易理解,它可以存储一些密码、token或者秘钥等敏感安全文件。挂载集群预定义的secret对象到容器内部 |
spec.volumes.configMap | 对象Object | 用于指定类型为configMap的存储卷,表示挂载集群预定义的configMap对象到容器内部 |
spec.volumes.livenessProbe | 对象Object | 用于指定Pod内容器健康检查的设置,当探测无响应几次后,系统将自动重启该容器 |
spec.volumes.livenessProbe.exec | 对象Object | 用于指定Pod内容器健康检查的设置,使用exec方式 |
spec.volumes.livenessProbe.exec.command | 字符串str | 用于指定exec方式后需要指定命令或者脚本,用这个参数设置 |
spec.volumes.livenessProbe.httpGet | 对象Object | 用于指定Pod内容器健康检查的设置,使用httpGet方式 |
spec.volumes.livenessProbe.tcpSocket | 对象Object | 用于指定Pod内容器健康检查的设置,使用tcpSocket方式 |
spec.volumes.livenessProbe.initialDelaySeconds | 数字num | 用于容器启动完成后手册探测的时间设置,单位为s秒 |
spec.volumes.livenessProbe.timeoutSeconds | 数字num | 用于对容器健康检查的探测等待响应的超时时间设置,单位为s秒,默认为1s。若超过该超时时间设置,则认为该容器不健康,会重启该容器。 |
spec.volumes.livenessProbe.periodSeconds | 数字num | 用于对容器健康检查的定期探测时间设置,单位为s秒,默认10s探测一次。 |
- 额外参数对象
- 除了上面的containers容器设置和volumes挂载设置外,还有几个其他的参数
参数名 | 字段类型 | 说明 |
---|---|---|
spec.restartPolicy | 字符串str | 用于定义Pod的重启策略,可选值为Always(Pod一旦终止,kubelet就立即重启,不管什么原因) 、OnFailure(只有Pod以非0退出码终止时,kubelet才会重启,如果退出码为0也就是正常结束,则不会重启) ,Never(Pod终止后,kubelet会把报告提交给master,不会重启pod) 默认值为Always |
spec.nodeSelector | 对象Object | 用于定义Node的Label过滤标签,以key:value格式指定 |
spec.imagePullSecrets | 对象Object | 用于定义pull镜像时使用secret名称,以name:secretkey格式指定 |
spec.hostNetwork | 布尔值boolean | 用于定义是否使用主机网络模式,默认值为false 。设置true表示使用宿主机网络,不使用docker网桥,注意:同时设置了true将无法在同一台宿主机上启动第二个副本,也就是说同一台宿主机只能有一个使用主机网络的pod |
四、Pod完整定义文件
apiVersion: v1 #必选,版本号,例如v1,版本号必须可以用 kubectl api-versions 查询到 .
kind: Pod #必选,类型是Pod
metadata: #必选,元数据
name: string #必选,Pod的名称
namespace: string #必选,Pod所属的命名空间,默认为"default",这里定义为string
labels: #自定义标签
- name: string #自定义标签名字
annotations: #自定义注释列表
- name: string
spec: #必选,Pod中容器的详细定义
containers: #必选,Pod中容器列表
- name: string #必选,容器名称,需符合RFC 1035规范
image: string #必选,容器的镜像名称
imagePullPolicy: [ Always|Never|IfNotPresent ] #获取镜像的策略,三种策略,上面的参数中有详细描述
command: [string] #容器的启动命令列表,如不指定,使用打包时使用的启动命令
args: [string] #容器的启动命令参数列表
workingDir: string #容器的工作目录
volumeMounts: #挂载到容器内部的存储卷配置
- name: string #引用pod定义的共享存储卷的名称,需用volumes[]部分定义的的卷名
mountPath: string #存储卷在容器内mount的绝对路径,应少于512字符
readOnly: boolean #是否为只读模式
ports: #需要暴露的端口库号列表
- name: string #端口的名称
containerPort: int #容器需要监听的端口号
hostPort: int #容器所在主机需要监听的端口号,默认与Container相同
protocol: string #端口协议,支持TCP和UDP,默认TCP
env: #容器运行前需设置的环境变量列表
- name: string #环境变量名称
value: string #环境变量的值
resources: #资源限制和请求的设置
limits: #资源限制的设置
cpu: string #Cpu的限制,单位为core数,将用于docker run --cpu-shares参数
memory: string #内存限制,单位可以为Mib/Gib,将用于docker run --memory参数
requests: #资源请求的设置
cpu: string #Cpu请求,容器启动的初始可用数量
memory: string #内存请求,容器启动的初始可用数量
livenessProbe: #对Pod内各容器健康检查的设置,当探测无响应几次后将自动重启该容器,检查方法有exec、httpGet和tcpSocket,对一个容器只需设置其中一种方法即可
exec: #对Pod容器内检查方式设置为exec方式
command: [string] #exec方式需要制定的命令或脚本
httpGet: #对Pod内个容器健康检查方法设置为HttpGet,需要制定Path、port
path: string
port: number
host: string
scheme: string
HttpHeaders:
- name: string
value: string
tcpSocket: #对Pod内个容器健康检查方式设置为tcpSocket方式
port: number
initialDelaySeconds: 0 #容器启动完成后首次探测的时间,单位为秒
timeoutSeconds: 0 #对容器健康检查探测等待响应的超时时间,单位秒,默认1秒
periodSeconds: 0 #对容器监控检查的定期探测时间设置,单位秒,默认10秒一次
successThreshold: 0
failureThreshold: 0
securityContext:
privileged: false
restartPolicy: [Always | Never | OnFailure] #Pod的重启策略,三种模式,上面的参数中有详细描述
nodeSelector: obeject #设置NodeSelector表示将该Pod调度到包含这个label的node上,以key:value的格式指定
imagePullSecrets: #Pull镜像时使用的secret名称,以key:secretkey格式指定
- name: string
hostNetwork: false #是否使用主机网络模式,默认为false,如果设置为true,表示使用宿主机网络
volumes: #在该pod上定义共享存储卷列表
- name: string #共享存储卷名称 (volumes类型有很多种)
emptyDir: {} #类型为emtyDir的存储卷,与Pod同生命周期的一个临时目录。为空值
hostPath: string #类型为hostPath的存储卷,表示挂载Pod所在宿主机的目录
path: string #Pod所在宿主机的目录,将被用于同期中mount的目录
secret: #类型为secret的存储卷,挂载集群与定义的secre对象到容器内部
scretname: string
items:
- key: string
path: string
configMap: #类型为configMap的存储卷,挂载预定义的configMap对象到容器内部
name: string
items:
- key: string
path: string
五、Deployment完整定义文件
apiVersion: apps/v1
kind: Deployment
metadata:
spec:
minReadySeconds: <integer> #设置pod准备就绪的最小秒数
paused: <boolean> #表示部署已暂停并且deploy控制器不会处理该部署
progressDeadlineSeconds: <integer>
strategy: <Object> #将现有pod替换为新pod的部署策略
rollingUpdate: <Object> #滚动更新配置参数,仅当类型为RollingUpdate
maxSurge: <string> #滚动更新过程产生的最大pod数量,可以是个数,也可以是百分比
maxUnavailable: <string> #
type: <string> #部署类型,Recreate,RollingUpdate
replicas: <integer> #pods的副本数量
selector: <Object> #pod标签选择器,匹配pod标签,默认使用pods的标签
matchLabels: <map[string]string>
key1: value1
key2: value2
matchExpressions: <[]Object>
operator: <string> -required- #设定标签键与一组值的关系,In, NotIn, Exists and DoesNotExist
key: <string> -required-
values: <[]string>
revisionHistoryLimit: <integer> #设置保留的历史版本个数,默认是10
rollbackTo: <Object>
revision: <integer> #设置回滚的版本,设置为0则回滚到上一个版本
template: <Object> -required-
metadata:
spec:
containers: <[]Object> #容器配置
- name: <string> -required- #容器名、DNS_LABEL
image: <string> #镜像
imagePullPolicy: <string> #镜像拉取策略,Always、Never、IfNotPresent
ports: <[]Object>
- name: #定义端口名
containerPort: #容器暴露的端口
protocol: TCP #或UDP
volumeMounts: <[]Object>
- name: <string> -required- #设置卷名称
mountPath: <string> -required- #设置需要挂载容器内的路径
readOnly: <boolean> #设置是否只读
livenessProbe: <Object> #就绪探测
exec:
command: <[]string>
httpGet:
port: <string> -required-
path: <string>
host: <string>
httpHeaders: <[]Object>
name: <string> -required-
value: <string> -required-
scheme: <string>
initialDelaySeconds: <integer> #设置多少秒后开始探测
failureThreshold: <integer> #设置连续探测多少次失败后,标记为失败,默认三次
successThreshold: <integer> #设置失败后探测的最小连续成功次数,默认为1
timeoutSeconds: <integer> #设置探测超时的秒数,默认1s
periodSeconds: <integer> #设置执行探测的频率(以秒为单位),默认1s
tcpSocket: <Object> #TCPSocket指定涉及TCP端口的操作
port: <string> -required- #容器暴露的端口
host: <string> #默认pod的IP
readinessProbe: <Object> #同livenessProbe
resources: <Object> #资源配置
requests: <map[string]string> #最小资源配置
memory: "1024Mi"
cpu: "500m" #500m代表0.5CPU
limits: <map[string]string> #最大资源配置
memory:
cpu:
volumes: <[]Object> #数据卷配置
- name: <string> -required- #设置卷名称,与volumeMounts名称对应
hostPath: <Object> #设置挂载宿主机路径
path: <string> -required-
type: <string> #类型:DirectoryOrCreate、Directory、FileOrCreate、File、Socket、CharDevice、BlockDevice
- name: nfs
nfs: <Object> #设置NFS服务器
server: <string> -required- #设置NFS服务器地址
path: <string> -required- #设置NFS服务器路径
readOnly: <boolean> #设置是否只读
- name: configmap
configMap:
name: <string> #configmap名称
defaultMode: <integer> #权限设置0~0777,默认0664
optional: <boolean> #指定是否必须定义configmap或其keys
items: <[]Object>
- key: <string> -required-
path: <string> -required-
mode: <integer>
restartPolicy: <string> #重启策略,Always、OnFailure、Never
nodeName: <string>
nodeSelector: <map[string]string>
imagePullSecrets: <[]Object>
hostname: <string>
hostPID: <boolean>
status: <Object>