手写 K8S YAML 文件太难，三个小技巧助你游刃有余

在如今快节奏的技术领域，容器编排平台 Kubernetes（简称K8s）以其强大的功能和灵活性，成为了现代应用开发和部署的重要工具。然而，对于刚刚接触K8s的新手而言，手动编写 K8s 的 YAML 配置文件可能会是一件令人望而却步的挑战。

毕竟，这些配置文件包含了许多复杂的对象和属性，光是理解 Pod 对象的各个字段、它们的含义以及可接受的值就可能让人头疼不已。如果你也曾为此烦恼，不妨阅读本篇文章，相信你会从中获得提升，功力大增。尽管本文内容以基础为主，但其中的实用技巧可能会让你豁然开朗，哪怕是已经入门的小白同学也未必知晓。

三把利剑：help、dry-run、explain

尽管手写 K8s 的 YAML 配置文件可能会让刚接触K8s的小白望而却步，但别担心！

K8s 平台提供了一系列强大的工具和技巧，可以助你提升在K8s中编写YAML文件的功力。本篇文章将带你进行实战，借助 Kubectl 工具的 help、dry-run、explain 功能，让你在编写 K8S 的 YAML 文件时游刃有余，轻松驾驭这一复杂领域。

• help：有时候，我们可能会忘记具体的命令用法或参数选项。在这种情况下，help命令将成为你的得力助手，为你提供清晰的指导。

• dry-run：在真正执行命令之前，通过使用 dry-run 选项，你可以预先验证命令的效果。这种模拟执行命令不会对集群产生实际影响，再搭配上 -o 选项以将结果输出为YAML格式，能够快速地获得所需的YAML文件。

• explain：在编写YAML文件时，了解资源类型的结构和属性至关重要。通过 explain 命令，你可以轻松掌握资源的所有字段、默认值以及示例的详细信息，帮助你更好地构建配置文件。

开始实战

接下来，我们将以创建一个名为 “web” 的应用的 Deployment 为例，展示如何运用上述三把利剑进行实际操作。

首先，通过 help 命令，你可以了解命令的使用方式、参数选项和示例用法，例如：

kubectl helpkubectl create deployment --help

接着，利用 --dry-run 选项来获取所需的YAML配置文件，例如：

kubectl create deployment web --image=nginx --port=80 -r 3 -n default --dry-run=client -o yaml

这样，Kubectl 将模拟执行创建 Deployment 的操作，但并不会实际创建它。而是输出一个 YAML 格式的资源定义，帮助你避免潜在的错误和不必要的更改，从而提高工作效率。执行后，你会得到类似以下的 yaml 配置：

apiVersion: apps/v1kind: Deploymentmetadata:  creationTimestamp: null  labels:    app: web  name: web  namespace: defaultspec:  replicas: 3  selector:    matchLabels:      app: web  strategy: {}  template:    metadata:      creationTimestamp: null      labels:        app: web    spec:      containers:      - image: nginx        name: web        ports:        - containerPort: 80        resources: {}status: {}

explain

在准备 K8s manifest 时，可以使用 Kubectl explain 命令，例如你要创建一个 Pod、Node、RC，可以请求 Kubectl 来开始：

kubectl explain pods

explain 会输出：

* Pod 名称：表示 Pod 这个容器的名称。  

* Pod ID：表示 Pod 的唯一 ID。  

* IP 地址：表示 Pod 所在的网络接口的 IP 地址。  

* 网络接口：表示 Pod 所在的网络接口的名称。  

* 容器 ID：表示 Pod 中容器的唯一 ID。  

* 容器名称：表示 Pod 中容器的名称。  

* 容器 IP 地址：表示 Pod 中容器的 IP 地址。  

* 容器端口：表示 Pod 中容器的端口号。  

* 容器启动时间：表示容器启动的时间。  

* 容器状态：表示容器的状态，包括 running、exited、dead 等。  

* 容器进程：表示容器中正在运行的进程。 

通过解释 Pod 的定义和行为，我们可以更好地理解和调试容器化运行时环境中的 Pod。