K8S yaml文件中常用字段说明

最新推荐文章于 2024-06-01 21:41:40 发布

xxb249

最新推荐文章于 2024-06-01 21:41:40 发布

阅读量2.5k

点赞数 4

分类专栏： Docker&K8S&虚拟化文章标签：常用字段说明 kind分类

本文链接：https://blog.csdn.net/xxb249/article/details/116232493

版权

Docker&K8S&虚拟化专栏收录该内容

24 篇文章 6 订阅

订阅专栏

一、常用字段说明

参数名	字段类型	说明
version	string	k8s api的版本号，目前是v1，可以通过kubectl api-version查看
kind	string	指定资源类型，例如Pod，Deployment，Service等
metadata	object	自定义metadata
metadata.name	string	对象名字，用户自定义
metadata.namespace	string	对象的命名空间，用户自定义
spec	Object	对象的详细信息
spc.restartPolicy	string	pod重启策略 Always：pod一旦退出就要进行重启 OnFailure：只有非正常退出才进行重启 Nerver：退出后不再拉起
spec.hostNetwork	bool	是否使用主机网络，默认值false 设置为true，表示与主机在同一个网络空间
spec.nodeSelector	object	标签选择器，k-v形式
spec.containers[]	list	容器对象列表
spec.containers[].name	string	容器的名称
spec.containers[].image	string	容器使用的镜像
spec.containers[].imagePullPolicy	string	Always：每次都重新下载 IfNotPresent：如果本地存在则使用本地镜像，不重新拉取 Never：表示仅使用本地镜像
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	bool	读写模式，true只读（默认值），false读写
spec.containers[].ports[]	list	容器用到端口
spec.containers[].ports[].name	string	端口名称
spec.containers[].ports[].containerPort	number	端口号
spec.containers[].ports[].hostPort	number	指定host主机使用端口。主要适用于端口映射，默认值是和容器内端口相同
spec.containers[].ports[].protocol	string	监听协议，tcp、udp，默认是tcp
spec.containers[].env[]	list	容器的环境变量列表
spec.containers[].env[].name	string	环境变量name
spec.containers[].env[].value	string	环境变量value
spec.containers[].resources	object	用于设置资源限制和资源请求
spec.containers[].resources.limits	object	设置资源上限
spec.containers[].resources.limits.cpu	string	对cpu的限制，k8s将一个逻辑cpu划分成1000个millicore(毫核)。例如 limits.cpu=500m相当于0.5个cpu。 limits.cpu=2表示占用2个cpu
spec.containers[].resources.limits.memory	string	对内存的限制
spec.containers[].resources.requests	object	容器启动和调度是的限制设置
spec.containers[].resources.requests.cpu	string	对cpu的限制，k8s将一个逻辑cpu划分成1000个millicore(毫核)。例如 limits.cpu=500m相当于0.5个cpu。 limits.cpu=2表示占用2个cpu
spec.containers[].resources.requests.memory	string	对内存的限制

二、kind种类

在k8s中支持多种资源（kind），这里罗列一下各个资源

分类	说明	其他
Pod	k8s最基本管理单元
ReplicationController （RC）	副本控制器，用于控制Pod副本数，目前官方不建议使用	保证副本数，始终为用户指定数目
ReplicaSet （RS）	是RC的升级版本，比RC多了一个选择器，其他都一样。	保证副本数，始终为用户指定数目，不能动态扩缩容
Deployment	支持动态扩缩容，滚动升级，版本回滚，RS不支持
DeamonSet	确保全部或部分Node 上运行一个 Pod 的副本	例如：要求每个node上都有监控系统，日志系统等
Job	执行脚本，linux命令等	适用于批处理任务
CronJob	定时执行脚本，linux命令等	定时批处理任务
Service	提供负载均衡和服务自动发现，底层通过EndPoint实现
EndPoints	pod名字和ip映射关系集合，支撑Service
ConfigMap	配置集合，用于给pod/容器传递参数	1、将环境变量直接定义在configMap中，当Pod启动时,通过env来引用configMap中定义的环境变量。 2、将一个完整配置文件封装到configMap中,然后通过共享卷的方式挂载到Pod中,实现给应用传参。

三、举例

这个例子摘自其他网友

apiVersion: v1 #指定api版本，此值必须在kubectl apiversion中  
kind: Pod #指定创建资源的角色/类型  
metadata: #资源的元数据/属性  
  name: web04-pod #资源的名字，在同一个namespace中必须唯一  
  labels: #设定资源的标签，详情请见http://blog.csdn.net/liyingke112/article/details/77482384
    k8s-app: apache  
    version: v1  
    kubernetes.io/cluster-service: "true"  
  annotations:            #自定义注解列表  
    - name: String        #自定义注解名字  
spec:   #specification of the resource content 指定该资源的内容  
  restartPolicy: Always #表明该容器一直运行，默认k8s的策略，在此容器退出后，会立即创建一个相同的容器  
  nodeSelector:     #节点选择，先给主机打标签kubectl label nodes kube-node1 zone=node1  
    zone: node1  
  containers:  
  - name: web04-pod #容器的名字  
    image: web:apache #容器使用的镜像地址  
    imagePullPolicy: Never #三个选择Always、Never、IfNotPresent，每次启动时检查和更新（从registery）images的策略，
                           # Always，每次都检查
                           # Never，每次都不检查（不管本地是否有）
                           # IfNotPresent，如果本地有就不检查，如果没有就拉取
    command: ['sh'] #启动容器的运行命令，将覆盖容器中的Entrypoint,对应Dockefile中的ENTRYPOINT  
    args: ["$(str)"] #启动容器的命令参数，对应Dockerfile中CMD参数  
    env: #指定容器中的环境变量  
    - name: str #变量的名字  
      value: "/etc/run.sh" #变量的值  
    resources: #资源管理，请求请见http://blog.csdn.net/liyingke112/article/details/77452630
      requests: #容器运行时，最低资源需求，也就是说最少需要多少资源容器才能正常运行  
        cpu: 0.1 #CPU资源（核数），两种方式，浮点数或者是整数+m，0.1=100m，最少值为0.001核（1m）
        memory: 32Mi #内存使用量  
      limits: #资源限制  
        cpu: 0.5  
        memory: 32Mi  
    ports:  
    - containerPort: 80 #容器开发对外的端口
      name: httpd  #名称
      protocol: TCP  
    livenessProbe: #pod内容器健康检查的设置，详情请见http://blog.csdn.net/liyingke112/article/details/77531584
      httpGet: #通过httpget检查健康，返回200-399之间，则认为容器正常  
        path: / #URI地址  
        port: 80  
        #host: 127.0.0.1 #主机地址  
        scheme: HTTP  
      initialDelaySeconds: 180 #表明第一次检测在容器启动后多长时间后开始  
      timeoutSeconds: 5 #检测的超时时间  
      periodSeconds: 15  #检查间隔时间  
      #也可以用这种方法  
      #exec: 执行命令的方法进行监测，如果其退出码不为0，则认为容器正常  
      #  command:  
      #    - cat  
      #    - /tmp/health  
      #也可以用这种方法  
      #tcpSocket: //通过tcpSocket检查健康   
      #  port: number   
    lifecycle: #生命周期管理  
      postStart: #容器运行之前运行的任务  
        exec:  
          command:  
            - 'sh'  
            - 'yum upgrade -y'  
      preStop:#容器关闭之前运行的任务  
        exec:  
          command: ['service httpd stop']  
    volumeMounts:  #详情请见http://blog.csdn.net/liyingke112/article/details/76577520
    - name: volume #挂载设备的名字，与volumes[*].name 需要对应    
      mountPath: /data #挂载到容器的某个路径下  
      readOnly: True  
  volumes: #定义一组挂载设备  
  - name: volume #定义一个挂载设备的名字  
    #meptyDir: {}  
    hostPath:  
      path: /opt #挂载设备类型为hostPath，路径为宿主机下的/opt,这里设备类型支持很多种