Kubernetes——YAML文件编写

已于 2024-06-10 22:18:19 修改
阅读量1.1k 收藏 27
点赞数 18
文章标签： kubernetes 容器 云原生
于 2024-06-02 10:01:42 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/g_d0120/article/details/139384960
版权

目录

一、创建Kubernetes对象YAML文件必备字段

1.apiVersion

2.kind

3.metadata

4.spec

二、YAML格式基本规范

1.结构表示

2.键值对

3.列表（数组）

4.字典（映射）

5.数据类型

6.注释

7.多文档支持

8.复杂结构

9.示例 

三、YAML文件编写

1.YAML文件的组成

2.生成YAML文件框架

2.1--dry-run命令

2.2通过explain获取YAML文件字段的含义

3.调整YAML文件内容

3.1Deployment

3.2Service

4.Deployment Workload部署

5.Kubectl命令行使用

一、创建Kubernetes对象YAML文件必备字段

在Kubernetes创建对象，我们通常是通过一个声明式的清单来创建。Kubernetes 对象是持久化的实体。是一种“意向表达”（Record of Intent）。一旦创建该对象， Kubernetes 系统将不断工作以确保该对象存在。

我们在Kubernetes中创建对象，本质上是在通知 Kubernetes 系统，我们想要的集群工作负载状态看起来应该是什么样子的， 也就是 Kubernetes 集群所谓的期望状态（Desired State）。

1.apiVersion

创建该对象所使用的 Kubernetes API 的版本，比如 apps/v1，networking.k8s.io/v1等。

2.kind

想要创建的对象的类别，比如 Deployment，DaemonSet等。

3.metadata

帮助唯一标识对象的一些数据，包括一个 name 字符串（必需字段）、UID（自动生成） 和可选的 namespace。

4.spec

我们所期望的该对象的状态，对每个 Kubernetes 对象而言，其 spec都不同

具体的可以参考官方文档：https://kubernetes.io/zh-cn/docs/reference/kubernetes-api/

apiVersion: v1           # Kubernetes API 的版本，对于 Pod 来说，通常是 v1  
kind: Pod                # 要创建的对象的类别，这里是 Pod  
metadata:  
  name: my-pod           # 对象的名称，在命名空间中必须是唯一的  
  namespace: default     # 命名空间，如果省略，则默认为 default  
                         # UID 是由 Kubernetes 系统自动生成的，不需要在清单文件中指定  
spec:  
  containers:            # Pod 规格中定义了容器的列表  
  - name: my-container   # 容器的名称  
    image: nginx:1.19.2  # 容器使用的镜像及其标签  
                         # 其他容器配置，如端口、环境变量等...

wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==

二、YAML格式基本规范

YAML（YAML Ain't Markup Language）是一种用于数据序列化的格式，常用于配置文件、数据交换等场景。YAML的目标是易于阅读和书写，同时也易于与编程语言交互。YAML文件通常以.yaml或.yml作为文件扩展名。

1.结构表示

  • 使用缩进表示层级关系，通常使用两个或四个空格的缩进，但必须在同一文档中保持一致。
  • 不使用制表符（Tab）进行缩进。

2.键值对

  • 使用冒号加空格: 来分隔键和值。
  • 键是唯一的，通常是字符串。

3.列表（数组）

  • 使用短横线加空格-  来表示列表项。
  • 列表项通常会缩进，表示属于上一级的列表。

4.字典（映射）

  • 字典是一组键值对的集合。
  • 字典的每个键值对都会缩进，表示属于上一级的字典。

5.数据类型

  • 支持字符串、布尔值、整数、浮点数、null、时间、日期等数据类型。
  • 字符串通常不需要引号，但如果包含特殊字符，则需要用单引号或双引号括起来。
  • 使用true/false表示布尔值。
  • 使用null表示空值。

6.注释

使用井号 # 开头表示注释，注释内容不会被解析。

7.多文档支持

使用三个短横线---来分隔文件中的多个文档。

8.复杂结构

字典和列表可以嵌套使用，形成复杂的结构。

9.示例 

# 这是一个注释
person:  # 字典的开始
  name: John Doe  # 字符串
  age: 30  # 整数
  married: true  # 布尔值
  children:  # 列表的开始
    - name: Jane Doe
      age: 10
    - name: Doe Junior
      age: 5

wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==

三、YAML文件编写

YAML文件通常用于配置管理系统、部署工具、持续集成和持续部署（CI/CD）等场景，它们易于阅读和编辑。在Kubernetes中，YAML文件被广泛用于定义资源对象，如Deployments、Services、Pods等。

1.YAML文件的组成

YAML文件由apiVersion、kind、metadata、spec、status五部分组成，前四部分较常用。

kubectl explain deployment
KIND:     Deployment
VERSION:  apps/v1

DESCRIPTION:
     Deployment enables declarative updates for Pods and ReplicaSets.

FIELDS:
   apiVersion  <string>
     APIVersion defines the versioned schema of this representation of an
     object. Servers should convert recognized schemas to the latest internal
     value, and may reject unrecognized values. More info:
     https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

   kind  <string>
     Kind is a string value representing the REST resource this object
     represents. Servers may infer this from the endpoint the client submits
     requests to. Cannot be updated. In CamelCase. More info:
     https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

   metadata  <Object>
     Standard object's metadata. More info:
     https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

   spec  <Object>
     Specification of the desired behavior of the Deployment.

   status  <Object>
     Most recently observed status of the Deployment.

wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==

2.生成YAML文件框架

2.1--dry-run命令

kubectl create deployment jumpoint-web --image=nginx:latest --port=80 --replicas=2 --namespace=jumpoint-ns --dry-run=client --output=yaml

apiVersion: apps/v1
kind: Deployment
metadata:
  creationTimestamp: null
  labels:
    app: jumpoint-web
  name: jumpoint-web
  namespace: jumpoint-ns
spec:
  replicas: 2
  selector:
    matchLabels:
      app: jumpoint-web
  strategy: {}
  template:
    metadata:
      creationTimestamp: null
      labels:
        app: jumpoint-web
    spec:
      containers:
      - image: nginx:latest
        name: nginx
        ports:
        - containerPort: 80
        resources: {}
status: {}

wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==

若要定义Pod等资源对象，生成YAML文件的方法类似。

2.2通过explain获取YAML文件字段的含义

#若要查看metadata.labels字段的含义

kubectl explain deployment.metadata.labels
KIND:     Deployment
VERSION:  apps/v1

FIELD:    labels <map[string]string>

DESCRIPTION:
     Map of string keys and values that can be used to organize and categorize
     (scope and select) objects. May match selectors of replication controllers
     and services. More info: http://kubernetes.io/docs/user-guide/labels

wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==

#若要查看spec.selector.matchLabels字段的含义（其它字段含义查询方式类似）

kubectl explain deployment.spec.selector.matchLabels
KIND:     Deployment
VERSION:  apps/v1

FIELD:    matchLabels <map[string]string>

DESCRIPTION:
     matchLabels is a map of {key,value} pairs. A single {key,value} in the
     matchLabels map is equivalent to an element of matchExpressions, whose key
     field is "key", the operator is "In", and the values array contains only
     "value". The requirements are ANDed.

wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==

#若要查看deployment.spec.template.spec.containers字段下还有哪些字段可用，有时可能要根据实际需求添加一些字段（上边生成的YAML文件略简单）

kubectl explain deployment.spec.template.spec.containers
KIND:     Deployment
VERSION:  apps/v1

RESOURCE: containers <[]Object>

DESCRIPTION:
     List of containers belonging to the pod. Containers cannot currently be
     added or removed. There must be at least one container in a Pod. Cannot be
     updated.

     A single application container that you want to run within a pod.

FIELDS:
...
   imagePullPolicy  <string>
     Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always
     if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated.
     More info:
     https://kubernetes.io/docs/concepts/containers/images#updating-images

     Possible enum values:
     - `"Always"` means that kubelet always attempts to pull the latest image.
     Container will fail If the pull fails.
     - `"IfNotPresent"` means that kubelet pulls if the image isn't present on
     disk. Container will fail if the image isn't present and the pull fails.
     - `"Never"` means that kubelet never pulls an image, but only uses a local
     image. Container will fail if the image isn't present
...

wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==

3.调整YAML文件内容

精简不用的字段、修改字段的内容、添加镜像的拉取策略等，将其保存到nginx-deployment.yaml文件中。

3.1Deployment

apiVersion: apps/v1
kind: Deployment
metadata:
  labels:
    app: jumpoint-web-deployment-label
  name: jumpoint-web
  namespace: jumpoint-ns
spec:
  replicas: 2
  selector:
    matchLabels:
      app: jumpoint-web-pod-label
  template:
    metadata:
      labels:
        app: jumpoint-web-pod-label
    spec:
      containers:
      - image: nginx:latest
        name: jumpoint-web-container-name
        imagePullPolicy: Always
        ports:
        - containerPort: 80
          protocol: TCP
          name: http

wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==

#使用nginx-deployment.yaml文件创建Deployment资源对象。


kubectl create namespace jumpoint-ns

kubectl apply -f nginx-deployment.yaml

kubectl get deployments -n jumpoint-ns

kubectl get pods -n jumpoint-ns -o wide

kubectl describe deployment -n jumpoint-ns jumpoint-web

wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==

注意：YAML文件中spec.selector.matchLabels必须与spec.template.metadata.labels一致，若不一致，如spec.selector.matchLabels=jumpoint-web-pod-selector，spec.template.metadata.labels=jumpoint-web-pod-label，会遇到如下报错：

kubectl apply -f nginx-deployment.yaml
The Deployment "jumpoint-web" is invalid: spec.template.metadata.labels: Invalid value: map[string]string{"app":"jumpoint-web-pod-label"}: `selector` does not match template `labels`

上述报错的原因也比较好理解，在Kubernetes中，Deployment标签、Pod选择器，和Pod标签之间的关系是为了确保Deployment能够正确地管理其下属的Pod。以下是这三个标签作用的说明

  • Deployment标签（metadata.labels）

这些标签是附加在Deployment资源本身上的，用于识别和组织资源，但并不直接影响Deployment如何选择和管理Pod。通常，这些标签用于帮助用户通过标签选择器（如kubectl get deployments -l app=jumpoint-web-deployment-label）找到特定的Deployment。

  • Pod选择器 (spec.selector.matchLabels)

这个选择器定义了Deployment如何找到它应该管理的Pod。Deployment会监视并管理所有与这个选择器匹配的Pod。因此，该选择器需要与创建的Pod的标签相匹配，以便Deployment可以“认领”并管理这些Pod。

  • Pod标签 (spec.template.metadata.labels)

这些标签是在Pod模板中定义的，将被附加到由Deployment创建的每个Pod实例上。该标签必须与Deployment的Pod选择器匹配，其会告诉Deployment哪些Pod属于它。如果这些标签不匹配，Deployment将无法找到（也就是无法选择）它应该管理的Pod，导致它不会执行任何更新或回滚操作。

简而言之，spec.selector.matchLabels必须与spec.template.metadata.labels一致，因为这样设置后，Deployment才能正确地识别出它应该管理的Pod。而metadata.labels在Deployment上的标签主要是为了方便用户对Deployment进行分类和查询，并不直接参与Pod的选择过程。

3.2Service

cat nginx-service.yaml

apiVersion: v1
kind: Service
metadata:
  labels:
    app: nginx-web-service-label
  name: nginx-web-service
  namespace: jumpoint-ns
spec:
  type: NodePort
  ports:
  - name: http
    port: 80
    protocol: TCP
    targetPort: 80
    nodePort: 30001
  selector:
    app: jumpoint-web-pod-label

Service的spec.selector，会匹配Pod的spec.template.metadata.labels，并将网络流量路由到匹配到的Pod上。

4.Deployment Workload部署

下面开始部署一个完整的Deployment工作负载（创建NameSpace---->部署Deployment---->创建Service）

cat nginx-deployment-v2.yaml

apiVersion: v1
kind: Namespace
metadata:
  name: jumpoint-ns-v2
  labels:
    app: jumpoint-ns-v2-namespace-label

---
apiVersion: apps/v1
kind: Deployment
metadata:
  labels:
    app: jumpoint-web-deployment-label
  name: jumpoint-web
  namespace: jumpoint-ns-v2
spec:
  replicas: 2
  selector:
    matchLabels:
      app: jumpoint-web-pod-label
  template:
    metadata:
      labels:
        app: jumpoint-web-pod-label
    spec:
      containers:
      - image: nginx:latest
        name: jumpoint-web-container-name
        imagePullPolicy: Always
        ports:
        - containerPort: 80
          protocol: TCP
          name: http

---
apiVersion: v1
kind: Service
metadata:
  labels:
    app: nginx-web-service-label
  name: nginx-web-service
  namespace: jumpoint-ns-v2
spec:
  type: NodePort
  ports:
  - name: http
    port: 80
    protocol: TCP
    targetPort: 80
    nodePort: 30004
  selector:
    app: jumpoint-web-pod-label


kubectl apply -f nginx-deployment-v2.yaml

5.Kubectl命令行使用

kubectl get deployment -n jumpoint-ns-v2

kubectl get pods -n jumpoint-ns-v2 -o wide

kubectl get svc -n jumpoint-ns-v2

kubectl get ep -n jumpoint-ns-v2
K8s脱坑前的挣扎——YAML文件
weixin_45724795的博客
05-23 555
前言：YAML(/ˈjæməl/，尾音类似 camel ) 是"YAML不是一种标记语言"的外语缩写 (见前方参考资料原文内容);但为了强调这种语言以数据做为中心，而不是以置标语言为重点，而用返璞词重新命名。它是一种直观的能够被电脑识别的数据序列化格式，是一个可读性高并且容易被人类阅读，容易和脚本语言交互，用来表达资料序列的编程语言 它是类似于标准通用标记语言的子集XML的数据描述语言，语法比XML简单很多 文章目录一、YAML概述1.诞生2.命名3.功能4.格式5.适用场景二、示例三、YAML文件格式的获
如何规范式编写yaml文件
今夜不设防，让我们猎个痛快！
07-17 3920
一起学习YAML 语言的语法、如何用 YAML 来描述 API 对象，还有一些编写 YAML 文件的技巧。
yaml文件写法和加载(1）
最新发布
@bangbang的博客
08-13 971
yaml 是专门用来写配置文件的语言，个人认为比yaml比json格式更方便。在Python中，使用PyYAML库来处理YAML文件是一种常见的做法。YAML（YAML Ain’t Markup Language）是一种数据序列化格式，它以。
云原生Kubernetes：Yaml文件编写
cronaldo91的博客
09-07 1729
yaml文件的学习方法(1)多看别人(官方)写的，能读懂(2)能照着现场的文件改着用(3)遇到不懂的，善用kubectl explain ...命令查。
高效编写 kubernetes-YAML文件
weixin_52943021的博客
04-07 1567
Kubernetes YAML字段类型 POD资源配置选项 如何去确定这些字段的类型？ ​ 如何查看参数？如何使用 help? 如何快速获取所需的 YAML 文件 dry-run 可以快速获取所需的 YAML 文件 VSCode工具生成和编写 VSCode安装扩展： Kubernetes-Templates: 帮助你轻松地编辑和管理 Kubernetes YAML文件
【yaml文件的编写】
m0_56405902的博客
10-08 1106
kubernetes支持YAML和JSON格式管理资源对象JSON格式:主要用于api接口之间消息的传递YAML格式:用于配置和管理，YAML是一种简介的非标记性语言，内容格式人性化，较易读。
YAML--文件编写教程
lck_csdn的博客
05-24 1573
YAML--文件编写教程
kubernetes——存储之Volumes配置管理
S_K15的博客
08-03 1618
kubernetes——存储之Volumes配置管理一、Volumes的简介二、emptyDir卷1、emptyDir的引入2、emptyDir 的使用场景3、emptyDir 示例 一、Volumes的简介 1、问题引入 容器中的文件在磁盘上是临时存放的，这给容器中运行的特殊应用程序带来一些问题。 首先，当容器崩溃时，kubelet 将重新启动容器，容器中的文件将会丢失,因为容器会以纯净的状态重建。 其次，当在一个 Pod 中同时运行多个容器时，常常需要在这些容器之间共享文件。 2、Kubernete
Kubernetes——资源管理
m0_56681539的博客
11-19 246
其实声明式对象配置就是使用apply描述一个资源最终的状态（在yaml中定义状态）如果资源不存在，就创建，相当于 kubectl create。如果资源已存在，就更新，相当于 kubectl patch。
Kubernetes —— Pod
nswdiphone6的博客
10-11 304
本章核心内容： 1、Kubernetes 核心模块Pod 2、如何决定是否将某些容器组合在一个pod中 3、pod可以运行多个进程，类似于物理机 4、如何编写Yaml或Json描述文件用于创建Pod，以及如何查看pod的规格和当前状态 5、如何使用标签来组织pod，并且同时在多个pod中执行操作 6、如何使用节点标签将pod只调度到提供某些特性的节点上 7、注解的作用，用法。 8、Kubernetes的命名空间。 1、介绍Pod pod是一组并置的容器，代表了K8s中的基本构建模块。在实际应用中，我们并不会
kubernetes——存储之ConfigMap配置管理
S_K15的博客
07-31 520
kubernetes——存储之ConfigMap配置管理一、configmap简介二、创建configmap1、使用字面值创建2、使用文件创建3、使用目录创建4、编写configmap的yaml文件三、如何使用configmap1、使用configmap设置环境变量2、通过在pod的命令行下运行的方式3、使用conigmap设置命令行参数4、通过数据卷使用configmap四、configmap热更新 一、configmap简介 configmap用于保存配置数据，以键值对形式存储。 configmap
yaml文件格式说明及编写教程
热门推荐
huahua1999的博客
03-29 2万+
1、ymal介绍 k8s是容器编排引擎，使用yaml来编排部署应用 特点：1、缩进表示层级关系 2、不支持制表符“tab”缩进，需要使用空格缩进 3、通常开头缩进两个空格 4、关键词字符后缩进一个空格，比如冒号与逗号后面需要缩进一个字符 5、“---”表示YAML格式，一个文件的开始 6、“#”表示注释 以下yaml为例 等同于 kubectl create deploy...
Yaml 编写入门
nvd11的专栏
10-26 965
yml 我地在springboot 里见得多了.但yaml 跟yml 是同一种语法的东西， 历史原因例如springboot, docker-compose 仍然在使用yml格式。但是一些新的tools, 例如ansible 的playbook， k8s 的资源编排已经默认使用yaml后序.本文来深究yaml的编写方式。
K8S：Yaml文件详解及编写示例
Katie_ff的博客
09-12 2927
本文主要针对K8S中的yaml文件格式、yaml的语法格式以及编写的注意事项和deployment编写nginx服务、deployment编写redis服务进行示例安装部署并对相关的文件中的内容进行了详细的介绍
kubernetes使用 （二）yaml文件编写
默子昂
12-18 1047
yaml文件----排版很舒服的文件o(*￣▽￣*)o 不过yaml文件有几个编写要求 yaml文件编写格式 1. 通过缩进表示不同的层级 2. 不能使用tab缩进，只能用空格 3. 一般开头缩进2两个空格 4. 每个字符后面缩进一个空格 5. 3个横杠"---"表示下一个yaml文件的开始 6. 使用"#"注释 先上一段案例 #这是上一章我们创建的时候用的，这里说明一下是什么意思 apiVersion: apps/v1 kind: Deployment metadata: nam..
kubernetes-----YAML文件编写详解
qq_42761527的博客
05-05 3547
一.YAML文件分析 YAML简介 YAML语言的设计目标，就是方便读写，它实质是一种通用数据串行化格式，它的基本语法规则如下： 大小写敏感 使用缩进表示层级关系 缩进时不允许使用Tab键，只允许使用空格键 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可 #表示注释，这个字符一直到行尾都会被解析器忽略 YAML支持的数据结构有三种 对象：键值对的集合，又称为映射（......
yaml文件编写学习
llxx1234的博客
03-22 804
http://gerrit.zte.com.cn/#/c/1498533/3/neutron/task/alarm.pyYAML 语言（发音 /ˈjæməl/ ）https://blog.csdn.net/vincent_hbl/article/details/75411243
180619-Yaml文件语法及读写小结
difouyan3029的博客
06-19 234
Yaml文件小结 Yaml文件有自己独立的语法，常用作配置文件使用，相比较于xml和json而言，减少很多不必要的标签或者括号，阅读也更加清晰简单；本篇主要介绍下YAML文件的基本语法，以及如何在Java中实现读写逻辑 I. 基本语法 使用空格 Space 缩进表示分层，不同层次之间的缩进可以使用不同的空格数目，但是同层元素一定左对齐，即前面空格数目相同（不要使用tab） # 表示...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值