1、Kubernetes对象的描述
kubernetes中资源可以使用YAML描述(如果您对YAML格式不了解,可以参考YAML语法),也可以使用JSON。其内容可以分为如下四个部分:
- typeMeta:对象类型的元信息,声明对象使用哪个API版本,哪个类型的对象。
- objectMeta:对象的元信息,包括对象名称、使用的标签等。
- spec:对象的期望状态,例如对象使用什么镜像、有多少副本等。
- status:对象的实际状态,只能在对象创建后看到,创建对象时无需指定。
2、YAML文件概述
k8s 集群中对资源管理和资源对象编排部署都可以通过声明样式(YAML)文件来解决,也就是可以把需要对资源对象操作编辑到 YAML 格式文件中,我们把这种文件叫做资源清单文件,通过 kubectl 命令直接使用资源清单文件就可以实现对大量的资源对象进行编排部署 了。
3、YAML文件书写格式
- YAML介绍
YAML是一种标记语言。为了强调这种语言以数据做为中心,而不是以标记语言为重点;YAML是一个可读性高,用来表达数据序列的格式。
- YAML基本语法
a、使用空格做为缩进
b、缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
c、低版本缩进时不允许使用Tab健,只允许使用空格
d、使用#标识注释,从这个字符一直到行尾,都会被解释器忽略
- YAML支持的数据结构
对象:键值对的集合,又称为映射(mapping)/哈希(hashes)/字典(dictionary)
类型1:对象的一组键值对,使用冒号结构表示
name: TOM
age: 18
类型2:也允许另一种写法,将所有键值对写成一个行内对象
hash: {name: TOM , age: 18}
数组:一组按次序排列的值,又称为序列(sequence)/列表(list)
类型1:一组连词线开头的行,构成一个数组
People
- Tom
- Jack
类型2:也可以采用行内表示法
People: [Tom, Jack]
纯量:(scalars)单个的、不可再分的值
类型1:数值直接以字面量的形式表示(number: 12.30);
类型2:布尔值用true和false表示(isSet: true);
类型3:null用~表示(parent: ~);
类型4:时间采用ISO8601格式(iso8601: 2023-02-13t21:59:43.10-05:00);
类型5:日期采用复合iso8601格式的年、月、日表示(date: 2023-02-13);
类型6:YAML允许使用两个感叹号,强制转换数据类型(e: !!str 123);
类型7:字符串默认不使用引号表示(str: 这是一行字符串);
类型8:如果字符串之中包含空格或特殊字符,需要放在引导之中(str: '内容: 字符串');
类型9:单引号和双引号都可以使用,双引号不会对特殊字符转义(s1: '内容\n字符串' s2: "内容\n字符串");
类型10:单引号之中如果还有单引号,必须连接使用两个单引号转义(str: 'labor' 's day');
类型11:字符串可以写成多行,从第二行开始,必须有一个单空格缩进。换行符会被转为空格;
类型12:字符串可以写成多行,从第二行开始,必须有一个单空格缩进。换行符会被转为空格。
4、资源清单描述方法
在K8S中,一般使用YAML格式的文件来创建符合我们预期期望的pod,这样的YAML文件称为资源清单。
4.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.container[] | list | 这里是Spec对象的容器列表定义,是个列表 |
spec.container[].name | String | 这里定义容器的名字 |
spec.container[].image | String | 这里定义要用到的镜像名称 |
- spec主要对象
参数名 | 字段类型 | 说 明 |
spec.containers[].name | String | 定义容器的名字 |
spec.containers[].image | String | 定义要用到的镜像名称 |
spec.containers[].imagePullPolicy | String | 定义镜像拉取策略,有Always、Never、IfNotPresent三个值可选: 1、Always:意思是每次尝试重新拉取镜像; 2、Never:表示仅使用本地镜像; 3、IfNotPresent:如果本地有镜像就是本地镜像,没有就拉取在线镜像; 4、上面三个值都没设置的话,默认是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 | 设置存储卷路径的读写模式,true或者fales,默认为读写模式 |
spec.containers[].ports[] | List | 指定容器需要用到的端口列表 |
spec.containers[].ports[].name | String | 指定端口名称 |
spec.containers[].ports[].containerPort | String | 指定容器需要监听的端口号 |
spec.containers[].ports.hostPort | String | 指定容器所在主机需要监听的端口号,默认跟上面containerPort相同,注意设置了hostPort同一台主机无法启动该容器的相同副本(因为主机的端口号不能相同,这样会冲突) |
spec.containers[].ports[].protocol | 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 参数 |
spec.containers[].resources.limits.memory | String | 指定MEM内存的限制,单位为MIB,GIB |
spec.containers[].resources.requests | Object | 指定容器启动和调度室的限制设置 |
spec.containers[].resources.repuests.cpu | String | CPU请求,单位为core数,容器启动时初始化可用数量 |
spec.containers[].resources.repuests.memory | String | 内存请求,单位为MIB,GIB容器启动的初始化可用数量 |
- 额外的参数
参数名 | 字段类型 | 说 明 |
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.imagePullSecrets | Object | 定义pull镜像是使用secret名称,以name:secretkey格式指定。 |
spec.hostNetwork | Boolean | 定义是否使用主机网络模式,默认值为false。设置true表示使用宿主机网络,不使用docker网桥,同时设置了true将无法在同一台宿主机上启动第二个副本。 |
- yaml完整内容
apiversion: v1 # 必选,版本号,例如V1
kind: pod # 必选,类型如:Pod,Service,Deployment
metadate: # 必选,元数据
name: string # 必选,类型名称
namespace: string # 必选,所属的命名空间
labels: # 自定义标签
- name: string
spec: # 必选,Pod中容器的详细定义
containers: # 必选,Pod中容器列表
- name: string # 必选,容器名称
image: string # 必选,容器的镜像名称
imagePullPolicy: [Always | Never | IfNotPresent] # 获取镜像的策略:Alawys表示下载镜像,IfNotPresent表示优先使用本地镜像,否则下载镜像,Nerver表示仅使用本地镜像
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参数
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
secuityContext:
privileged: false
restartPolicy: [Always | Never | OnFailure ] # pod的重启策略,Always表示一旦不管以何种方式终止运行,kubelet都将重启,OnFailure表示只有pod以非O退出码退出才重启,Nerver表示不再重启该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: # 类型为secret的存储卷,挂载集群与定义的secre对象到容器内部
name: string
items:
- key: string
path: string