完整的属性说明

属性名称 取值类型 是否必选 取值说明
version String 版本号,如 v1
kind String Pod
metadata Object 源数据
metada.name String Pod的名称,命名规范需符合RFC1035规范
metadata.namespace String Pod所属的命名空间,默认值为default
metadata.labels[] List 自定义标签列表
metada.annotation[] List 自定义注解列表
Spec Object Pod中容器的详细定义
spec.containers[] List Pod中的容器列表
spec.containers[].name String 容器的名称,需符合RFC1035规范
spec.containers[].image String 容器的镜像名称
spec.containers[].imagePullPolicy String 镜像拉取策略
可选址包括: Always , Never , IfNotPresent 默认值为Always。
1) Always: 表示每次都尝试重新拉取镜像。
2) IfNotPresent: 如果本地有该镜像,则使用本地的镜像,本地不存在时拉取镜像。
3) Never: 标识仅使用本地镜像
另外,如果包括如下设置,系统将默认设置imagePullPolicy=Always,如下所述:
1)不设置imagePullPolicy, 也未指定镜像的tag
2)不设置imagePullPolicy,镜像tag为latest;
3)启用名为AlwaysPullImages 的准入控制器(Admission Controller)
spec.containers[].command[] List 容器的启动命令列表,如果不指定,则使用镜像打包时使用的启动命令
spec.containers[].args[] List 容器的启动命令参数列表
spec.containers[].workingDir String 容器的工作目录
spec.containers[].volumeMounts[] List 挂载到容器内部的存储卷配置
spec.containers[].volumeMounts[].name String 引用Pod定义的共享存储卷的名称,需使用volumes[]部分定义的共享存储卷名称
spec.containers[].volumeMounts[].mountPath String 存储卷在容器内Mount的绝对路径,应少于512个字符
spec.containers[].volumeMounts[].readOnly Boolean
是否为只读模式,默认为读写模式
spec.containers[].ports[] List 容器需要暴露的端口号列表
spec.containers[].ports[].name String 端口的名称
spec.containers[].ports[].containerPort Int 容器需要监听的端口号
spec.containers[].ports[].hostPort Int 容器所在主机需要监听的端口号,默认与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 资源限制和资源请求的设置,详见第10章的说明
spec.containers[].resources.limits Object 资源限制的设置
spec.containers[].resources.limits.cpu String CPU限制,单位为core数,将用于docker run —cpu-shares参数
spec.containers[].resources.request.memory String 内存请求,单位可以为MiB,GiB等,容器启动的初始可用数量
spec.volumes[] List 在该Pod上定义的共享存储卷列表
spec.volumes[].name String 共享存储卷的名称,在一个Pod中每个存储卷定义一个名称,应符合RFC1035规范。容器定义部分的containers[].volumeMounts[].name将引用该共享存储卷的名称。
Volume的类型包括:
emptyDir , hostPath , geePersistentDisk , awsElasticBlockStore , gitReposecret , nfs , iscsi , glusterfs , persistentVolumeClaim , rbd , flexVolume , cinder , cephfs , flocker , downwardAPI , fc , azureFile , configMap , vsphereVolume
可以定义多个Volume,每个Volume的name保持唯一。本节讲解emptyDir , hostPath , secret , configMap 这4中Volume,其他类型的Volume的设置方式详见第1章的说明
spec.volumes[].emptyDir Object 类型为emptyDir的存储卷,表示与Pod同声明周期的一个临时目录,其值为一个空对象: emptyDir:{}
spec.volumes[].hostPath Object 类型为hostPath的存储卷,表示不再Pod所在宿主机的目录,通过volumes[].hostPath.path指定
spec.volumes[].hostPath.path String Pod所在主机的目录,将被用于容器中的mount的目录
spec.volumes[].secret Object 类型为secret的存储卷,表示挂在集群预定义的secret对象到容器内部
spec.volumes[].configMap Object 类型为configMap的存储卷,表示挂在集群预定义的configMap对象到容器内部
spec.volumes[].livenessProbe Object
对Pod内各容器健康检查的设置,当探测无响应几次之后,系统将自动重启该容器。可以设置的方法包括: exec , httpGet 和 tcpSocket 。 对一个容器仅需设置一种健康检查方法
spec.volumes[].livenessProbe.exec Object 对Pod内各容器健康检查的设置,exec方式
spec.volumes[].livenessProbe.exec.conmmand[] String exec方式需要指定的明林或脚本
spec.volumens[].livenessPorbe.httpGet Object 对Pod内各容器健康检查的设置,httpGet方式需指定path ,port
spec.volumes[].livenessProbe.tcpSocket Object 对Pod内各容器健康检查的设置,tcpSocket方恨死
spec.volumes[].livenessProbe.initialDelaySeconds Number 容器启动完成后首次探测的时间,单位为s
spec.volumes[].livenessProbe.timeoutSeconds Number 对容器健康检查的探测等待响应的超时时间设置,单位为s,默认为1s 。 若超过该超时时间设置,则认为该容器不健康,会重启该容器
spec.volumes[].livenessProbe.periodSeconds Number 对容器健康检查的定期探测时间设置,单位为s , 默认10s 探测一次
spec.restartPolicy String Pod的重启策略,可选值为
Always , OnFailure , Never 默认值为 Always
1)Always:Pod一旦终止运行,则无论容器是如何终止的,kubelet都将重启它。
2)OnFailure:只有Pod以非零退出码终止时,kubelet才会重启该容器。如果容器正常结束(退出码为0),则kubelet将不会重启它。
3)Never:Pod终止后,kubelet将退出码报告给Master,不会再重启该Pod
spec.NodeSelector Object 设置Node的Label,以key:value格式指定,Pod将被调度到具有这些Label的Node上
spec.imagePullSecrets Object pull镜像时使用的secret名称,以name:secretkey格式指定
spec.hostNetwork Boolean 是否使用主机网络模式,默认值为false。设置为true表示容器使用数字聚集网络,不再使用

完整的Pod定义文件

  1. apiVersion: v1
  2. kind: Pod
  3. metadata:
  4. name: string
  5. namespace: string
  6. labels:
  7. - name: string
  8. annotations:
  9. - name: string
  10. spec:
  11. containers:
  12. - name: string
  13. image: string
  14. imagePullPolicy: [Always | Never | IfNotPresent]
  15. command: [string]
  16. args: [string]
  17. workingDir: string
  18. volumeMounts:
  19. - name: string
  20. mountPath: string
  21. readOnly: boolean
  22. ports:
  23. - name: string
  24. containerPort: int
  25. hostPort: int
  26. protocol: string
  27. env:
  28. - name: string
  29. value: string
  30. resources:
  31. limits:
  32. cpu: string
  33. memory: string
  34. requests:
  35. cpu: string
  36. memory: string
  37. livenessProbe:
  38. exec:
  39. command: [string]
  40. httpGet:
  41. path: string
  42. port: number
  43. host: string
  44. scheme: string
  45. httpHeaders:
  46. - name: string
  47. value: string
  48. tcpSocket:
  49. port: number
  50. initialDelaySeconds: 0
  51. timeoutSeconds: 0
  52. periodSeconds: 0
  53. successThreshold: 0
  54. failureThreshold: 0
  55. securityContext:
  56. privileged: false
  57. restartPolicy: [Always | Never | OnFailure]
  58. nodeSelector: object
  59. imagePullSecrets:
  60. - name: string
  61. hostNetwork: false
  62. volumes:
  63. - name: string
  64. emptyDir: {}
  65. hostPath:
  66. path: string
  67. secret:
  68. secretName: string
  69. items:
  70. - key: string
  71. path: string
  72. configMap:
  73. name: string
  74. items:
  75. - key: string
  76. path: string