K8S-YAML文件说明

已于 2023-04-06 20:16:22 修改
阅读量824 收藏 1
点赞数 1
分类专栏： K8S 文章标签： kubernetes docker 容器
于 2023-02-13 11:55:01 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_63674789/article/details/125175259
版权

1、Kubernetes对象的描述 

        kubernetes中资源可以使用YAML描述（如果您对YAML格式不了解，可以参考YAML语法），也可以使用JSON。其内容可以分为如下四个部分：

  • typeMeta：对象类型的元信息，声明对象使用哪个API版本，哪个类型的对象。
  • objectMeta：对象的元信息，包括对象名称、使用的标签等。
  • spec：对象的期望状态，例如对象使用什么镜像、有多少副本等。
  • status：对象的实际状态，只能在对象创建后看到，创建对象时无需指定。
  • YAML描述文件

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、常用字段

  • 必须存在的属性
参数名字段类型说    明
versionStringK8S API的版本，目前基本是v1，可以用kubectl api-version命令查询
kindString这里指的是yaml文件定义的资源类型和角色，比如：Pod
metadataObject元数据对象，固定值写metadata
metadata.nameString元数据对象的名字，这里由我们编写，比如命令Pod的名字
metadata.namespaceString元数据对象的命名空间，由我们自身定义
SpecObject详细定义对象，固定值写Spec
spec.container[]list这里是Spec对象的容器列表定义，是个列表
spec.container[].nameString这里定义容器的名字
spec.container[].imageString这里定义要用到的镜像名称
  • spec主要对象
参数名字段类型说    明
spec.containers[].nameString定义容器的名字
spec.containers[].imageString定义要用到的镜像名称
spec.containers[].imagePullPolicyString

定义镜像拉取策略，有Always、Never、IfNotPresent三个值可选：

1、Always：意思是每次尝试重新拉取镜像；

2、Never：表示仅使用本地镜像；

3、IfNotPresent：如果本地有镜像就是本地镜像，没有就拉取在线镜像；

4、上面三个值都没设置的话，默认是Always。

spec.containers[].command[]List指定容器启动命令，因为是数组可以指定多个，不指定则使用镜像打包时使用的启动命令。
spec.containers[].args[]List指定容器启动命令参数，因为是数组可以指定多个。
spec.containers[].workingDirString指定容器的工作目录
spec.containers[].volumeMounts[]List指定容器内部的存储卷配置。
spec.containers[].volumeMounts[].nameString指定可以被容器挂载的存储卷的名称
spec.containers[].volumeMounts[].mountPathString指定可以被容器挂载的容器卷的路径
spec.containers[].volumeMounts[].readOnlyString设置存储卷路径的读写模式，true或者fales，默认为读写模式
spec.containers[].ports[]List指定容器需要用到的端口列表
spec.containers[].ports[].nameString指定端口名称
spec.containers[].ports[].containerPortString 指定容器需要监听的端口号
spec.containers[].ports.hostPortString指定容器所在主机需要监听的端口号，默认跟上面containerPort相同，注意设置了hostPort同一台主机无法启动该容器的相同副本（因为主机的端口号不能相同，这样会冲突）
spec.containers[].ports[].protocolString指定端口协议，支持TCP和UDP，默认值为TCP
spec.containers[].env[]List指定容器运行所需设置的环境变量列表
spec.containers[].env[].nameString指定环境变量名称
spec.containers[].env[].valueString指定环境变量值
spec.containers[].resourcesObject指定资源限制和资源请求的值（这里开始就是设置容器的资源上限）
spec.containers[].resources.limitsObject指定容器运行时资源的运行上限
spec.containers[].resources.limits.cpuString指定CPU的限制，单位为core数，将用于docker run --cpu-shares 参数
spec.containers[].resources.limits.memoryString指定MEM内存的限制，单位为MIB，GIB
spec.containers[].resources.requestsObject指定容器启动和调度室的限制设置
spec.containers[].resources.repuests.cpuStringCPU请求，单位为core数，容器启动时初始化可用数量
spec.containers[].resources.repuests.memoryString内存请求，单位为MIB，GIB容器启动的初始化可用数量
  • 额外的参数
参数名字段类型说    明
spec.restartPolicyString

定义Pod重启策略，可以选择值为Always、OnFailure，默认值为Always：

1、Always：Pod一旦终止运行，则无论容器是如何终止的，kubelet服务都将重启；

2、OnFailure：只有Pod以非零退出码终止时，kubelet才会重启该容器。如果容器正常结束（退出码为0），则kubelet将不会重启它；

3、Never：Pod终止后，kubelet将退出码报告给Master，不会重启访Pod。

spec.nodeSelectorObject定义Node的Label过滤标签，以key:value格式指定。
spec.imagePullSecretsObject定义pull镜像是使用secret名称，以name:secretkey格式指定。
spec.hostNetworkBoolean定义是否使用主机网络模式，默认值为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

芷阳99
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
K8s中yaml文件详解（超详细）
06-07
K8s中yaml文件详解（超详细）
nacos-k8s-yaml.zip
09-01
在Kubernetes（简称k8s）环境中，Nacos可以通过YAML文件进行部署，实现服务在容器集群中的高可用和动态管理。本文将深入探讨如何使用YAML文件在k8s上部署Nacos集群，以及如何结合NFS（Network File System）实现数据...
【云原生之k8s】Yaml文件详解
qq_45088125的博客
08-01 2580
kubernetes支持YAML和JSON文件格式管理资源对象
k8s之yaml文件详解
最新发布
2301_81272194的博客
05-24 1373
没有相关资源，使用run命令--dry-run选项#已有相关资源，使用get命令导出。
干货！K8S之yaml文件详解
热门推荐
时光慢旅的博客
05-10 1万+
文章目录一、概述二、YAML文件优点三、YAML与 JSON 和 XML 的关系四、YAML 文件的结构五、YAML 在 Kubernetes 中的使用六、YAML文件模板生成/导出 一、概述 Kubernetes只支持YAML和JSON格式创建资源对象 JSON格式用于接口之间消息的传递，YAML格式用于配置和管理 YAML是专门用来写配置文件的语言，非常简洁和强大，使用比json更方便。它实质上是一种通用的数据串行化格式。 二、YAML文件优点 YAML 文件易于人类阅读，具有表达性和可扩展性。
​K8s中yaml文件详解（超详细）​
Java后端技术栈
09-20 5482
上述例子中，使用两个空格作为缩进，但空格的数据量并不重要，只是至少要求一个空格并且所有缩进保持一致的空格数。除了上述的基本属性外，还能够指定复杂的属性，包括容器启动运行的命令、使用的参数、工作目录以及每次实例化是否拉取新的副本。注：上述的YAML文件中，metadata这个KEY对应的值为一个Maps，而嵌套的labels这个KEY的值又是一个Map。上述例子只是一个简单的最小定义：一个名字（front-end）、基于nginx的镜像，以及容器将会监听的指定端口号（80）。YAML对用户更加友好。
使用python脚本自动生成K8S-YAML的方法示例
09-16
在Kubernetes（K8S）环境中，YAML文件是用于定义和管理集群资源的主要方式。Python作为一种强大且灵活的编程语言，可以用来自动化创建这些YAML配置文件，从而提高效率和准确性。本篇文章将深入探讨如何使用Python脚...
k8s-yaml:k8s-yaml
03-29
持久文件会放在报表的/ data / k8s / etcd目录下。 prometheus.v2.11.0为官方版本。修复目录下的yaml进行了一些功能调整。主要为prometheus运行时绑定到主节点上。通过配置kubernetes.io/role：master进行进行选择...
calico flannel k8s 安装yaml文件
03-05
在Kubernetes（k8s）集群中，网络插件起着至关重要的作用，它们负责为Pod之间提供网络通信。在本话题中，我们将探讨两个流行的网络插件：Calico和Flannel，以及如何通过YAML文件来安装它们。YAML是Kubernetes的主要...
K8S中 yaml 文件详解
kele_baba
08-23 1万+
K8S中 yaml 文件详解一、K8S中的 yaml 文件二、写一个 yaml 文件，通过声明式创建pod创建 Deployment 资源 - kind: Deployment创建 Service 资源 - kind-Service导出 yaml 格式方式例子：deployment.yaml 文件详解例子：Service yaml 文件详解 一、K8S中的 yaml 文件 Kubernetes 支持 YAML 和 JSON格式 管理资源对象 JSON 格式：主要用于 api 接口之间消息的传递 YAML
k8s下部署nginx集群，以及相关yaml文件的编写和说明
07-26
k8s下部署nginx集群部署方式(相关yaml文件的编写和说明)
k8s yaml说明
weixin_30410119的博客
04-19 114
k8s yaml # yaml格式的pod定义文件完整内容： apiVersion: v1#必选，版本号，例如v1 kind: Pod #必选，Pod metadata: #必选，元数据 name: string#必选，Pod名称 namespace: string#必选，Pod所属的命名空间 labels:...
K8S之yaml文件详解
迪之的博客
10-19 2915
文章目录一、概述二、YAML文件优点三、YAML与 JSON 和 XML 的关系四、YAML 文件的结构五、YAML 在 Kubernetes 中的使用六、YAML文件模板生成/导出一、概述只支持YAML和JSON格式创建资源对象JSON格式用于接口之间消息的传递，格式用于配置和管理YAML是专门用来写配置文件的语言，非常简洁和强大，使用比json更方便。它实质上是一种通用的数据串行化格式。二、YAML文件优点。
Kubernetes（k8s） YAML文件详解
匠人精神，持之以恒！
09-12 3569
一、yaml文件简介 Kubernetes只支持YAML和JSON格式创建资源对象，JSON格式用于接口之间消息的传递，适用于开发；YAML格式用于配置和管理，适用于云平台管理，YAML是一种简洁的非标记性语言。 1）yaml的语法规则： 大小写敏感 使用缩进表示层级关系 缩进时不允许使用Tal键，只允许使用空格 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可 ”#” 表示注释，从这个字符一直到行尾，都会被解析器忽略 注：- - - 为可选的分隔符 ，当需要在一个文件中定义多个结构的时候需要使用
K8S---yaml文件详解
Liqi23的博客
02-27 1962
没有相关资源，使用 run 命令 --dry-run 选项已有相关资源，使用 get 命令 --export 选项写yaml太累怎么办？用 --dry-run 命令生成用get命令导出或kubectl edit svc nginx-service #复制配置，再粘贴到新文件。
K8s中yaml文件详解
qq_36864672的博客
02-23 4896
YAML是专门用来写配置文件的语言，非常简洁和强大，使用比json更方便。它实质上是一种通用的数据串行化格式。
K8S：Yaml文件详解
m0_71493671的博客
09-13 4918
详解k8s中的port：●portport 是 k8s 集群内部访问service的端口，即通过 clusterIP: port 可以从 Pod 所在的 Node 上访问到 service●nodePortnodePort 是外部访问 k8s 集群中 service 的端口，通过 nodeIP: nodePort 可以从外部访问到某个 service。
K8S之yaml 文件详解（pod、deployment、service）
m0_46168595的博客
09-16 1272
K8S中的 yaml 文件。
kubernetes-----YAML文件编写详情
08-18
在Kubernetes中，可以使用YAML格式来编写资源对象的配置文件。YAML是一种简洁的非标记性语言，以数据为中心，使用空白、缩进和换行来组织数据。以下是一些关于YAML文件编写的详细信息： 1. 大小写敏感：YAML是大小写敏感的，因此在编写YAML文件时需要注意大小写的正确使用。 2. 使用缩进表示层级关系：YAML使用缩进来表示数据的层级关系，一般使用空格键进行缩进。Tab键是不被允许的。 3. 缩进的空格数目不重要：相同层级的元素只需要左侧对齐即可，一般情况下使用两个空格进行缩进。 4. 使用#表示注释：在YAML文件中，可以使用#符号来添加注释，注释内容从#字符开始一直到行尾都会被解析器忽略。 5. 特殊字符的使用：在YAML中，一些特殊字符如冒号、逗号、短横杠等需要进行特殊处理，通常在这些字符后面会缩进一个空格。 6. 对象的表示：对象使用键值对的方式表示，使用冒号结构进行分隔，例如`animal: pets`。 7. 另一种对象的写法：YAML还支持将所有键值对写在一行内的行内对象表示法，例如`hash: {name: Steve, foo: bar}`。 8. 数组的表示：数组使用连词线开头的行来表示，每个元素占据一行，例如： ``` - Cat - Dog - Goldfish ``` 9. 子成员是数组：如果数据结构的子成员是一个数组，可以在该项下面缩进一个空格，例如： ``` - - Cat - Dog - Goldfish ``` 10. 文件示例：下面是一个Kubernetes的YAML文件的示例，用于创建一个名为"kubernetes-dashboard"的命名空间： ``` apiVersion: v1 kind: Namespace metadata: name: kubernetes-dashboard ``` 以上是关于Kubernetes中YAML文件编写的一些详细信息。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *2* [kubernetes-----YAML文件编写详解](https://blog.csdn.net/qq_42761527/article/details/105897465)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_1"}}] [.reference_item style="max-width: 50%"] - *3* [k8s集成kubernetes-dashboard可视化界面](https://blog.csdn.net/crazy1013/article/details/126575777)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_1"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值