pod yml配置参数解释
apiVersion:v1 #必选,版本号,例如v1
kind:Pod #必选,Pod
metadata: #必选,元数据
name:string #必选,Pod名称,命名需要规范
namespace:string #必选,Pod所属于的命名空间,不写的话默认创建在default空间
labels: #自定义标签
- name:string #自定义标签名字
annotations: #自定义注释
- name:string#自定义注释列表
spec: #必选,取值类型为Object,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参数
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的重启策略,默认值为Always,Always表示一旦不管以何种方式终止运行,kubelet都将重启,OnFailure表示只有Pod以非0退出码退出才重启,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: #类型为configMap的存储卷,挂载预定义的configMap对象到容器内部
name: string
items:
- key: string
path: string
spec
containers <[]Object> -required- # 必选参数
name <string> -required- # 指定容器名称,不可更新
image <string> -required- # 指定镜像
imagePullPolicy <string> # 指定镜像拉取方式
# Always: 始终从registory拉取镜像。如果镜像标签为latest,则默认值为Always
# Never: 仅使用本地镜像
# IfNotPresent: 本地不存在镜像时才去registory拉取。默认值
env <[]Object> # 指定环境变量
name <string> -required- # 变量名称
value <string> # 变量值
valueFrom <Object> # 从文件中读取,不常用
command <[]string> # 以数组方式指定容器运行指令,替代docker的ENTRYPOINT指令
args <[]string> # 以数组方式指定容器运行参数,替代docker的CMD指令
workingDir <string> # 指定工作目录,不指定则使用镜像默认值
ports <[]Object> # 指定容器暴露的端口
containerPort <integer> -required- # 容器的监听端口
name <string> # 为端口取名,该名称可以在service种被引用
protocol <string> # 指定协议:UDP, TCP, SCTP,默认TCP
hostIP <string> # 绑定到宿主机的某个IP
hostPort <integer> # 绑定到宿主机的端口
resources <Object> # 资源设置
limits <map[string]string> # 消耗的最大资源限制,通常设置cpu和memory
requests <map[string]string> # 最低资源要求,在scheduler中被用到,通常设置cpu和memory
volumeMounts <[]Object> # 指定存储卷挂载
name <string> -required- # 存储卷名称
mountPath <string> -required- # 容器内挂载路径
subPath <string> # 存储卷的子目录
readOnly <boolean> # 是否为只读方式挂载
volumeDevices <[]Object> # 配置块设备的挂载
devicePath <string> -required- # 容器内挂载路径
name <string> -required- # pvc名称
readinessProbe <Object> # 就绪性探测,确认就绪后提供服务
initialDelaySeconds <integer> # 容器启动后到开始就绪性探测中间的等待秒数
periodSeconds <integer> # 两次探测的间隔多少秒,默认值为10
successThreshold <integer> # 连续多少次检测成功认为容器正常,默认值为1。不支持修改
failureThreshold <integer> # 连续多少次检测失败认为容器异常,默认值为3
timeoutSeconds <integer> # 探测请求超时时间
exec <Object> # 通过执行特定命令来探测容器健康状态
command <[]string> # 执行命令,返回值为0表示健康,不自持shell模式
tcpSocket <Object> # 检测TCP套接字
host <string> # 指定检测地址,默认pod的IP
port <string> -required- # 指定检测端口
httpGet <Object> # 以HTTP请求方式检测
host <string> # 指定检测地址,默认pod的IP
httpHeaders <[]Object> # 设置请求头,很少会需要填写
path <string> # 设置请求的location
port <string> -required- # 指定检测端口
scheme <string> # 指定协议,默认HTTP
livenessProbe <Object> # 存活性探测,确认pod是否具备对外服务的能力,该对象中字段和readinessProbe一致
lifecycle <Object> # 生命周期
postStart <Object> # pod启动后钩子,执行指令或者检测失败则退出容器或者重启容器
exec <Object> # 执行指令,参考readinessProbe.exec
httpGet <Object> # 执行HTTP,参考readinessProbe.httpGet
tcpSocket <Object> # 检测TCP套接字,参考readinessProbe.tcpSocket
preStop <Object> # pod停止前钩子,停止前执行清理工作,该对象中字段和postStart一致
startupProbe <Object> # 容器启动完毕的配置,该配置与readinessProbe一致,在lifecycle和Probe之前运行,失败则重启
securityContext <Object> # 与容器安全相关的配置,如运行用户、特权模式等
initContainers <[]Object> # 初始化容器,执行完毕会退出,用户数据迁移、文件拷贝等
volumes <[]Object> # 存储卷配置,https://www.yuque.com/duduniao/k8s/vgms23#Ptdfs
restartPolicy <string> # Pod重启策略,Always, OnFailure,Never,默认Always
nodeName <string> # 调度到指定的node节点, 强制要求满足
nodeSelector <map[string]string> # 指定预选的node节点, 强制要求满足
affinity <Object> # 调度亲和性配置
nodeAffinity <Object> # node亲和性配置
preferredDuringSchedulingIgnoredDuringExecution <[]Object> # 首选配置
preference <Object> -required- # 亲和偏好
matchExpressions <[]Object> # 表达式匹配
key <string> -required- # label的key
values <[]string> # label的value,当operator为Exists和DoesNotExist时为空
operator <string> -required- # key和value的连接符,In,NotIn,Exists,DoesNotExist,Gt,Lt
matchFields <[]Object> # 字段匹配,与matchExpressions一致
weight <integer> -required- # 权重
requiredDuringSchedulingIgnoredDuringExecution <Object> # 强制要求的配置
nodeSelectorTerms <[]Object> -required- # nodeselect配置,与preferredDuringSchedulingIgnoredDuringExecution.preference一致
podAffinity <Object> # pod亲和性配置
preferredDuringSchedulingIgnoredDuringExecution <[]Object> # 首选配置
podAffinityTerm <Object> -required- # 选择器
labelSelector <Object> # pod标签选择器
matchExpressions<[]Object> # 表达式匹配
matchLabels <map[string]string> # 标签匹配
namespaces <[]string> # 对方Pod的namespace,为空时表示与当前Pod同一名称空间
topologyKey <string> -required- # 与对方Pod亲和的Node上具备的label名称
weight <integer> -required- # 权重
requiredDuringSchedulingIgnoredDuringExecution <[]Object> # 强制配置,与requiredDuringSchedulingIgnoredDuringExecution.podAffinityTerm一致
podAntiAffinity <Object> # Pod反亲和性配置,与podAffinity一致
tolerations <[]Object> # 污点容忍配置
key <string> # 污点的Key,为空表示所有污点的Key
operator <string> # key和value之间的操作符,Exists,Equal。Exists时value为空,默认值 Equal
value <string> # 污点的值
effect <string> # 污点的影响行为,空表示容忍所有的行为
tolerationSeconds <integer> # 当Pod被节点驱逐时,延迟多少秒
hostname <string> # 指定pod主机名
hostIPC <boolean> # 使用宿主机的IPC名称空间,默认false
hostNetwork <boolean> # 使用宿主机的网络名称空间,默认false
hostPID <boolean> # 使用宿主机的PID名称空间,默认false
serviceAccountName <string> # Pod运行时的使用的serviceAccount
imagePullSecrets <[]Object> # 当拉取私密仓库镜像时,需要指定的密码密钥信息
name <string> # secrets 对象名