前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Kubernetes系列学习文章 - Pod YAML文件如何写(五)

Kubernetes系列学习文章 - Pod YAML文件如何写(五)

原创
作者头像
宝哥@上云专家
修改2019-08-02 16:34:04
13.1K1
修改2019-08-02 16:34:04
举报
文章被收录于专栏:宝哥的专栏

| 导语 刚学习K8S的同学除了接触一堆的概念,另外见得最多的就是各种YAML文件配置了。大多数网上文章讲解K8S的时候都会丢那么一小段YAML配置文件,很多初学者看到的只是一部分,没有整体的认识大多数都会是懵逼状态。这里我们整体讲解下Pod的YAML文件如何编写和配置,我们要清楚里面包含哪些字段,然后值怎么定义。

一、什么是YAML文件

前面我们了解到K8S配置文件都是走YAML文件格式的,那么什么是YAML?它的编写语法是什么?

1. YAML特点

YAML 的英文全称是:”Yet Another Markup Language”(仍是一种置标语言)。我们之前接触过properties、XML、json等数据格式,越到后面越好用。其实YAML就是结合了这些标记语言的特性,整合新开发的。

大体来讲,YAML有下面特点:

  • 层次分明、结构清晰
  • 使用简单、上手容易
  • 表达强大、语义丰富

但是要注意的是,下面几点:

  • 大小写敏感
  • 禁止使用tab键缩进,只能空格键

2. YAML语法

我们举个模版例子就能快速了解YAML的语法:

代码语言:yaml
复制
# 前面是key,后面是value,表示如下:
name: nginx 

# 表示metadata.name=nginx:
metadata:
    name: nginx 
# 表达数组,即表示containers为[name,image,port] 那么用 - 就可以表示了

containers:
    - nginx
    - nginx
    - 80
    
# 常量、布尔、字符串定义
version: 1.1     # 定义一个数值1.1
rich: true       # 定义一个boolean值
say: 'hello world'    # 定义一个字符串

掌握了上面的语法,基本上K8S的 YAML你就能看懂和编写了。K8S里的YAML几乎用不到什么高级的其他语法格式。

详细想了解全的话,可以看看这个文章:https://learnxinyminutes.com/docs/yaml/

二、Pod YAML参数定义

Pod是K8S的最小单元,它的信息都记录在了一个YAML文件里。那么这个YAML文件到底怎么写呢?里面有哪些参数?如何去修改YAML文件?带着这几个问题我们来了解下。

Pod YAML有哪些参数?

K8S的YAML配置文件我们初学者看了后都觉得很长,然后也觉得没什么规律。其实,我们可以梳理下从两个方面去了解。第一个是哪些是必写项,第二个是YAML包含哪些主要参数对象。

1. 哪些是必写项

注意,一个YAML文件,下面几个参数是必须要声明,不然绝对会出错:

参数名

字段类型

说明

version

String

这里是指的是K8S API的版本,目前基本上是v1,可以用kubectl api-versions命令查询

kind

String

这里指的是yaml文件定义的资源类型和角色,比如:Pod

metadata

Object

元数据对象,固定值就写metadata

metadata.name

String

元数据对象的名字,这里由我们编写,比如命名Pod的名字

metadata.namespace

String

元数据对象的命名空间,由我们自身定义

Spec

Object

详细定义对象,固定值就写Spec

spec.containers[]

list

这里是Spec对象的容器列表定义,是个列表

spec.containers[].name

String

这里定义容器的名字

spec.containers[].image

String

这里定义要用到的镜像名称

以上这些都是编写一个YAML文件的必写项,一个最基本的YAML文件就包含它们。

2. 主要参数对象

第一小点里讲的都是必选参数,那么还是否有其他参数呢?其他功能的参数,虽然不是必选项,但是为了让YAML定义得更详细、功能更丰富,这里其他参数也需要了解下。接下来的参数都是Spec对象下面的,主要分了两大块:spec.containers 和 spec.volumes。

spec.containers

spec.containers 是个list数组,很明显,它代表的是描述container容器方面的参数。所以它下面的参数是非常多的,具体参数看如下表格:

参数名

字段类型

说明

spec.containers[].name

String

定义容器的名字

spec.containers[].image

String

定义要用到的镜像名称

spec.containers[].imagePullPolicy

String

定义镜像拉取策略,有Always、Never、IfNotPresent三个值可选(1)Always:意思是每次都尝试重新拉取镜像 (2)Never:表示仅使用本地镜像 (3)IfNotPresent:如果本地有镜像就使用本地镜像,没有就拉取在线镜像。 上面三个值都没设置的话,默认是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

设置存储卷路径的读写模式,ture 或者false,默认为读写模式

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参数(这里前面文章Pod资源限制有讲过)

spec.containers[].resources.limits.memory

String

指定MEM内存的限制,单位为MIB、GiB

spec.containers[].resources.requests

Object

指定容器启动和调度时的限制设置

spec.containers[].resources.requests.cpu

String

CPU请求,单位为core数,容器启动时初始化可用数量

spec.containers[].resources.requests.memory

String

内存请求,单位为MIB、GiB,容器启动的初始化可用数量

spec.volumes

spec.volumes是个list数组,很明显,看名字就知道它是定义同步存储方面的参数。它下面的参数是非常多,具体参数看如下表格:

参数名

字段类型

说明

spec.volumes[].name

String

定义Pod的共享存储卷的名称,容器定义部分的spec.containers[].volumeMounts[].name的值跟这里是一样的。

spec.volumes[].emptyDir

Object

指定Pod的临时目录,值为一个空对象:emptyDir:{}

spec.volumes[].hostPath

Object

指定挂载Pod所在宿主机的目录

spec.volumes[].hostPath.path

String

指定Pod所在主机的目录,将被用于容器中mount的目录

spec.volumes[].secret

Object

指定类型为secret的存储卷,secret意为私密、秘密的意思,很容易理解,它存储一些密码,token或者秘钥等敏感安全文件。挂载集群预定义的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.command[]

String

指定exec方式后需要指定命令或者脚本,用这个参数设置

spec.volumes[].livenessProbe.httpGet

Object

指定Pod内容器健康检查的设置,确定是httpGet方式

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探测一次。

3. 额外参数对象

除了上面containers和volumes两个主要参数,剩下有几个参数:

参数名

字段类型

说明

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将无法在同一台宿主机上启动第二个副本。

总结三张表

这几张表内容很多很长,有的同学一看到可能会说,这么多没法记。是的,谁会去记?其实你可以把上面的内容当一字典,需要用到的时候来查就可以了。话说回来,如果参数不那么丰富,那么K8S的功能定义将大幅下降。

另外,YAML里的这些参数其实是K8S声明式的一种体现,你可以简单的理解为它是用户与K8S的一个操作接口。YAML里设置的参数数值,最终都会持久化到ETCD里去的。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 一、什么是YAML文件
    • 1. YAML特点
      • 2. YAML语法
      • 二、Pod YAML参数定义
        • 1. 哪些是必写项
          • 2. 主要参数对象
            • 3. 额外参数对象
            相关产品与服务
            容器服务
            腾讯云容器服务(Tencent Kubernetes Engine, TKE)基于原生 kubernetes 提供以容器为核心的、高度可扩展的高性能容器管理服务,覆盖 Serverless、边缘计算、分布式云等多种业务部署场景,业内首创单个集群兼容多种计算节点的容器资源管理模式。同时产品作为云原生 Finops 领先布道者,主导开源项目Crane,全面助力客户实现资源优化、成本控制。
            领券
            问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档