k8s yaml怎么编写

在Kubernetes（K8s）中，编写YAML文件是管理和部署容器化应用程序的关键。YAML文件用于定义Kubernetes资源、描述应用程序的配置、指定服务和持久化存储。具体来说，YAML文件可以用来描述Pod、Service、Deployment、ConfigMap等各种资源。本文将深入探讨K8s YAML文件的编写方法及最佳实践，以便于高效地管理容器化应用。

一、K8S YAML文件的基础结构

Kubernetes YAML文件遵循严格的层次结构，每个文件通常包含四个主要部分：apiVersion、kind、metadata、spec。

apiVersion：指定资源的API版本。例如，apps/v1用于Deployment。
kind：定义资源类型，例如Pod、Service、Deployment。
metadata：包含资源的元数据，如名称、命名空间和标签。
spec：详细描述资源的期望状态，包括容器镜像、端口、环境变量等。

以下是一个简单的Pod YAML示例：

apiVersion: v1 kind: Pod metadata: name: mypod spec: containers: - name: mycontainer image: nginx:1.14.2 ports: - containerPort: 80

二、K8S YAML文件中重要资源的编写

Pod：最基本的Kubernetes资源，表示一个或多个容器的实例。一个Pod YAML文件的关键部分包括容器名称、镜像和端口。
Service：用于将流量分配到Pod。Service YAML文件包含选择器、端口和类型。
Deployment：用于管理Pod的部署，确保正确数量的Pod在运行。Deployment YAML文件包含副本数量、选择器和模板。
ConfigMap和Secret：用于存储配置信息和敏感数据，这些数据可以在Pod中使用。

三、详细解析常见的K8S YAML文件

Pod YAML 文件

Pod是Kubernetes中的最小部署单元，下面是一个更详细的Pod YAML文件示例：

apiVersion: v1 kind: Pod metadata: name: mypod labels: app: myapp spec: containers: - name: mycontainer image: nginx:1.14.2 ports: - containerPort: 80 env: - name: ENV_VAR value: "value"

这个文件定义了一个名称为mypod的Pod，包含一个名为mycontainer的容器，该容器使用nginx:1.14.2镜像，并在端口80上提供服务。

Service YAML 文件

Service用于将网络流量路由到指定的Pod，以下是一个Service的示例：

apiVersion: v1 kind: Service metadata: name: myservice spec: selector: app: myapp ports: - protocol: TCP port: 80 targetPort: 80 type: LoadBalancer

这个文件定义了一个名称为myservice的Service，它将TCP流量从端口80路由到标签为app: myapp的Pod上的端口80。

Deployment YAML 文件

Deployment用于声明应用的期望状态并自动执行部署和扩展操作，以下是一个Deployment示例：

apiVersion: apps/v1 kind: Deployment metadata: name: mydeployment spec: replicas: 3 selector: matchLabels: app: myapp template: metadata: labels: app: myapp spec: containers: - name: mycontainer image: nginx:1.14.2 ports: - containerPort: 80

这个文件定义了一个名称为mydeployment的Deployment，其中包含3个副本，每个副本都是一个运行nginx:1.14.2镜像的容器。

四、进阶配置与最佳实践

使用ConfigMap和Secret：将配置信息和敏感数据外部化，有助于应用程序的配置管理和安全性。例如：

apiVersion: v1 kind: ConfigMap metadata: name: myconfig data: config_key: config_value apiVersion: v1 kind: Secret metadata: name: mysecret type: Opaque data: secret_key: c2VjcmV0X3ZhbHVl

资源限制与请求：为Pod配置CPU和内存资源的限制和请求，以确保公平的资源分配和高效的资源使用。

spec: containers: - name: mycontainer image: nginx:1.14.2 resources: requests: memory: "64Mi" cpu: "250m" limits: memory: "128Mi" cpu: "500m"

使用Liveness和Readiness探针：确保应用的可靠性，通过探测应用的健康状态来自动重启不健康的容器。

spec: containers: - name: mycontainer image: nginx:1.14.2 livenessProbe: httpGet: path: /healthz port: 80 initialDelaySeconds: 3 periodSeconds: 3 readinessProbe: httpGet: path: /ready port: 80 initialDelaySeconds: 3 periodSeconds: 3

滚动更新与回滚：利用Deployment的特性，进行无中断的滚动更新，并在必要时进行回滚操作，以确保应用的持续可用性。

五、实际应用中的K8S YAML示例

综合示例

apiVersion: apps/v1 kind: Deployment metadata: name: myapp-deployment spec: replicas: 3 selector: matchLabels: app: myapp template: metadata: labels: app: myapp spec: containers: - name: myapp-container image: myapp:1.0 ports: - containerPort: 8080 envFrom: - configMapRef: name: myapp-config - secretRef: name: myapp-secret livenessProbe: httpGet: path: /health port: 8080 initialDelaySeconds: 10 periodSeconds: 5 readinessProbe: httpGet: path: /ready port: 8080 initialDelaySeconds: 5 periodSeconds: 5 resources: requests: memory: "256Mi" cpu: "500m" limits: memory: "512Mi" cpu: "1"

这个综合示例展示了一个名称为myapp-deployment的Deployment，它管理着3个副本。每个容器都使用myapp:1.0镜像，并在端口8080上运行。该Deployment还使用了ConfigMap和Secret来管理环境变量，并配置了资源请求和限制，以及Liveness和Readiness探针。

六、总结

编写K8s YAML文件是管理Kubernetes资源的基础技能，通过理解其结构和常见资源的配置，可以高效地部署和管理容器化应用。掌握YAML文件的编写方法、利用最佳实践配置资源限制和探针、以及使用ConfigMap和Secret管理配置和敏感数据，能够大大提升应用的可用性和安全性。实际应用中，利用滚动更新与回滚特性，确保应用的持续可用性，是Kubernetes管理中的重要一环。

相关问答FAQs：

常见问题解答（FAQs）

1. 如何编写基础的 Kubernetes YAML 文件？

编写 Kubernetes YAML 文件的基本步骤包括定义 Kubernetes 对象及其属性。这些对象包括 Pods、Services、Deployments 等。一个基础的 YAML 文件结构包含 apiVersion、kind、metadata 和 spec 四个主要部分。每个部分的功能如下：

apiVersion: 指定 Kubernetes API 版本。比如 apps/v1 或 v1。
kind: 定义对象的类型，例如 Pod、Service 或 Deployment。
metadata: 提供对象的名称、标签和注释等信息。
spec: 描述对象的具体配置，如容器镜像、端口和副本数等。

例如，下面是一个简单的 Pod 定义的 YAML 文件：

apiVersion: v1
kind: Pod
metadata:
  name: my-pod
spec:
  containers:
  - name: my-container
    image: nginx:latest
    ports:
    - containerPort: 80

这个 YAML 文件创建了一个名为 my-pod 的 Pod，其中包含一个名为 my-container 的容器，并且这个容器使用 nginx:latest 镜像，监听端口 80。

2. 如何在 Kubernetes YAML 文件中定义服务（Service）？

服务（Service）在 Kubernetes 中用于暴露 Pod 的网络访问。定义一个服务的 YAML 文件通常包含以下几个部分：

apiVersion: 定义服务的 API 版本，一般为 v1。
kind: 设置为 Service 以创建服务对象。
metadata: 包含服务的名称、标签和注释。
spec: 描述服务的具体配置，包括服务的类型（ClusterIP、NodePort、LoadBalancer 等）、选择器、端口和目标端口等。

例如，下面的 YAML 文件定义了一个名为 my-service 的服务，它选择标签为 app=my-app 的 Pods，并将请求转发到这些 Pods 上的 80 端口：

apiVersion: v1
kind: Service
metadata:
  name: my-service
spec:
  selector:
    app: my-app
  ports:
    - protocol: TCP
      port: 80
      targetPort: 80
  type: ClusterIP

此服务将作为一个 ClusterIP 类型的服务，仅在集群内部暴露。

3. 如何在 Kubernetes YAML 文件中定义部署（Deployment）？

部署（Deployment）是 Kubernetes 中用于管理应用程序副本和进行滚动更新的资源。创建部署的 YAML 文件包含以下内容：

apiVersion: 通常为 apps/v1。
kind: 设置为 Deployment。
metadata: 包括部署的名称、标签等。
spec: 包含部署的配置，如副本数、选择器和模板等。

下面是一个创建名为 my-deployment 的 Deployment 的 YAML 文件示例：

apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-deployment
spec:
  replicas: 3
  selector:
    matchLabels:
      app: my-app
  template:
    metadata:
      labels:
        app: my-app
    spec:
      containers:
      - name: my-container
        image: nginx:latest
        ports:
        - containerPort: 80

这个部署配置定义了 3 个副本，每个副本运行一个 nginx:latest 镜像的容器，并监听 80 端口。

关于 GitLab 的更多内容，可以查看官网文档：
官网地址： https://gitlab.cn
文档地址： https://docs.gitlab.cn
论坛地址： https://forum.gitlab.cn

原创文章，作者：xiaoxiao，如若转载，请注明出处：https://devops.gitlab.cn/archives/59575