k8s 声明式（yaml）资源管理及yaml文件解析

目录

声明式概念

用途

语法

资源配置清单管理命令

查看资源配置清单：

查看资源详细信息：

创建资源配置清单：

删除资源：

编辑资源配置：

更新资源配置清单：

解释资源配置清单

两种方式来修改 Kubernetes 资源配置清单并应用更改

其他查看命令

查看 api 资源版本标签

查看创建的pod资源

查看创建的service

查看生成yaml格式

查看生成json格式

YAML文件格式

编写注意事项：

数据结构：

yaml示例

Pod yaml文件详解

Service yaml文件详解

deployment.yaml文件详解

---

声明式概念

Kubernetes（通常简称为K8s）声明式配置管理是指使用清单文件（如YAML或JSON格式）来声明应用程序及其资源的状态和配置，而不是直接操作系统。通过声明式API，用户可以描述他们想要的系统状态，而Kubernetes将负责确保系统达到所需状态。这种方法支持版本控制、自动化部署、回滚、扩展和自我修复等功能。

Kubernetes支持使用YAML和JSON格式来管理资源对象。

JSON格式主要用于API接口之间消息的传递，而YAML格式则更适合配置和管理，因为它是一种简洁的非标记性语言，内容格式更人性化，更易于阅读。

用途

• 简化配置管理： 通过声明式资源管理，可以将资源的状态描述为所需的状态，而不需要手动编写复杂的命令或脚本来管理资源的创建、更新和删除。

• 版本控制： 通过使用清晰的资源配置清单文件（如YAML或JSON格式），可以轻松地将资源的配置纳入版本控制系统，从而实现更好的版本控制和代码管理。

• 可重复性和一致性： 通过将资源的定义存储在清单文件中，可以确保在不同环境中（如开发、测试和生产）之间实现资源的一致性，并且可以轻松地重复部署相同的配置。

• 自动化和可扩展性： 声明式资源管理可以与自动化工具和编排系统（如Kubernetes）集成，从而实现资源的自动化部署、扩展和管理，减少人为操作的需求，提高效率和可靠性。

• 故障恢复和灾难恢复： 通过定义资源的期望状态，可以更轻松地进行故障恢复和灾难恢复，系统可以根据声明的配置自动调整和修复资源。

语法

kubectl create/apply/delete -f xxxx.yaml

使用 kubectl 命令来创建、应用或删除 Kubernetes 资源的通用格式，其中 xxxx.yaml 是包含资源配置信息的清单文件。具体解释如下：

• kubectl create: 用于创建资源。通过提供清单文件（如 YAML 或 JSON 格式），可以创建指定的 Kubernetes 资源。例如，kubectl create -f deployment.yaml 将根据 deployment.yaml 文件中的配置创建一个 Deployment 资源。

• kubectl apply: 用于应用或更新资源的配置。与 create 不同，apply 命令会检查当前集群中的资源状态，并根据清单文件中的配置进行必要的更新。这样可以保证资源的状态与配置文件一致。例如，kubectl apply -f service.yaml 将应用或更新 Service 资源的配置。

• kubectl delete: 用于删除资源。提供清单文件后，delete 命令将删除清单文件中描述的资源。例如，kubectl delete -f pod.yaml 将删除 Pod 资源，其中 pod.yaml 包含了要删除的 Pod 的配置信息。

资源配置清单管理命令

查看资源配置清单：

用于查看已经创建的资源的配置清单。

kubectl get <resource_type> <resource_name> -o yaml

• kubectl: Kubernetes 命令行工具，用于与 Kubernetes 集群进行交互和管理。

• get: 用于获取资源的操作。

• : 资源的类型，例如 deployment、service、pod 等。

• : 资源的名称，指定要获取配置信息的特定资源实例。

• -o yaml: 指定输出格式为 YAML，这样输出将以 YAML 格式显示资源的详细配置信息，包括元数据、规范和状态等。

查看资源详细信息：

kubectl describe <resource_type> <resource_name>

这个命令提供了关于指定资源的详细信息，例如 kubectl describe pod mypod 会显示有关名为 "mypod" 的 Pod 的详细信息。

创建资源配置清单：

用于创建新的资源或修改已有资源的配置清单。

kubectl create -f <yaml_file> 

删除资源：

kubectl delete -f nginx-svc.yaml #声明式删除

kubectl delete service nginx #陈述式删除

编辑资源配置：

kubectl edit <resource_type> <resource_name>

通过编辑器直接编辑资源配置，例如 kubectl edit deployment mydeployment 允许你编辑名为 "mydeployment" 的 Deployment。

更新资源配置清单：

用于更新已有资源的配置清单。

kubectl apply -f <updated_yaml_file>

解释资源配置清单

用于解释资源配置清单中各个字段的含义。

kubectl explain <resource_type>.<field> 或 kubectl explain <resource_type>

两种方式来修改 Kubernetes 资源配置清单并应用更改

• 离线修改：

• 先通过 kubectl get 命令获取服务的配置，并将其保存到一个 YAML 文件中（例如：nginx-svc.yaml）。

• 使用文本编辑器（如 vim）对该 YAML 文件进行修改，例如更改端口号为 8080。

• 通过 kubectl delete -f 命令删除现有的服务资源。

• 最后通过 kubectl apply -f 命令将修改后的 YAML 文件重新应用，从而使更改生效。

• 在线修改：

• 直接使用 kubectl edit 命令在线编辑服务的配置清单。例如：kubectl edit service nginx。

• 在编辑器中修改所需的配置，例如更改端口号为 888，并保存退出。

• 由于此修改是在线进行的，所以更改将立即生效，无需重新应用 YAML 文件。

需要注意的是，如果通过 kubectl apply 命令应用更改时遇到问题，可以尝试先使用 kubectl delete 命令删除资源，然后再重新应用更改。这种方式可以确保资源的状态与配置文件一致。

其他查看命令

查看 api 资源版本标签

kubectl api-versions

查看创建的pod资源

kubectl get pods -o wide

查看创建的service

kubectl get svc

查看生成yaml格式

kubectl run nginx-test --image=nginx --port=80 --dry-run=client -o yaml
kubectl create deployment nginx-deploy --image=nginx --port=80 --replicas=3 --dry-run=client -o yaml

查看生成json格式

kubectl run nginx-test --image=nginx --port=80 --dry-run=client -o json
kubectl create deployment nginx-deploy --image=nginx --port=80 --replicas=3 --dry-run=client -o json

YAML文件格式

• YAML（YAML Ain't Markup Language 或 YAML 是一种人类友好的数据序列化标准。

• YAML 文件是一种以人类可读的方式表示数据的格式，通常被用于配置文件和数据交换格式。它的语法简洁，使用空格来表示层次结构，避免了像 XML 和 JSON 这样的标记语言中使用的繁琐的符号。YAML 主要强调数据的可读性，使得编辑和理解文件变得更加容易。

• YAML 文件可以包含键值对、数组、标量等数据形式。在容器编排工具中，比如 Docker Compose 中的配置文件就经常采用 YAML 格式。在 YAML 文件中，缩进和空格的使用很重要，它们用来表示数据的层次结构关系。

• 与 XML 相比，YAML 语法更简单。YAML 数据结构通过缩进表示，连续的项目通过减号表示，键值对用冒号分隔，数组用中括号 [] 括起来，哈希用花括号 {} 括起来。

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

name: John Doe
age: 30
city: New York
hobbies:
  - Reading
  - Traveling

在这个例子中，我们定义了一个人物的信息，包括姓名、年龄、城市和爱好。这种人类可读性高的格式使得 YAML 在配置文件和数据交换方面被广泛应用。

编写注意事项：

• 大小写敏感： YAML 是大小写敏感的。

• 缩进表示层级关系： 使用缩进表示数据的层次结构。

• 不支持制表符： 只能使用空格进行缩进，不支持制表符（tab 键）。

• 缩进的空格数目不重要： 只要相同层级左对齐即可，通常开头缩进2个空格。

• 注释： 使用 # 号表示注释。

• 符号字符后缩进1个空格： 冒号 : 、逗号 , 、横杠 - 等符号后通常缩进1个空格。

• “---”表示YAML格式，一个文件的开始，用于分隔文件间

• 引号的使用： 单引号''引起来的字符串会被处理为普通字符串，双引号""内的特殊字符会被解析为其本身的意思。

name: "Hi,\lihua"

数据结构：

• 键值对： 键值对的字典。YAML 使用冒号 : 分隔键和值，形成键值对

animal: pets

• 列表： 一组按次序排列的列表。使用连字符 - 表示列表中的每个项

- Cat
- Dog
- Bird

对应 JSON：["Cat", "Dog", "Bird"]

• 布尔值：

debug: true
debug: false

• 哈希映射： 使用花括号 {} 表示哈希映射，即键值对的字典。

person:
  name: John
  age: 30

• 数组： 使用中括号 [] 表示数组。

fruits: [apple, orange, banana]

yaml示例

mkdir /opt/demo
cd demo/

vim nginx-deployment.yaml
apiVersion: apps/v1        #指定api版本标签
kind: Deployment        #定义资源的类型/角色，deployment为副本控制器，此处资源类型可以是Deployment、Job、Ingress、Service等
metadata:                    #定义资源的元数据信息，比如资源的名称、namespace、标签等信息
  name: nginx-deployment    #定义资源的名称，在同一个namespace空间中必须是唯一的
  labels:                #定义Deployment资源标签
    app: nginx    
spec:                    #定义deployment资源需要的参数属性，诸如是否在容器失败时重新启动容器的属性
  replicas: 3            #定义副本数量
  selector:                #定义标签选择器
    matchLabels:        #定义匹配标签
      app: nginx        #需与 .spec.template.metadata.labels 定义的标签保持一致
  template:                #定义业务模板，如果有多个副本，所有副本的属性会按照模板的相关配置进行匹配
    metadata:
      labels:           #定义Pod副本将使用的标签，需与 .spec.selector.matchLabels 定义的标签保持一致
        app: nginx
    spec:
      containers:                #定义容器属性
      - name: nginx                #定义一个容器名，一个 - name: 定义一个容器
        image: nginx:1.15.4        #定义容器使用的镜像以及版本
        ports:
        - containerPort: 80        #定义容器的对外的端口

这是一个 Kubernetes Deployment 的 YAML 文件示例，用于定义一个运行 Nginx 服务的部署。

• apiVersion: apps/v1: 指定使用的 Kubernetes API 版本。

• kind: Deployment: 定义资源类型为 Deployment，用于创建和管理 Pod 的副本。

• metadata: 包含有关资源的元数据，如名称和标签。

• spec: 包含有关 Deployment 配置的详细信息。

• replicas: 3: 指定副本数量为 3。

• selector: 定义用于匹配 Pod 的标签选择器。

  • matchLabels: 定义标签匹配规则。

• template: 定义 Pod 的模板。

  • metadata.labels: 定义 Pod 使用的标签。

  • spec.containers: 定义容器的属性。

  • name: 定义容器的名称。

  • image: 指定容器使用的镜像及版本。

  • ports: 定义容器对外暴露的端口。

该 YAML 文件描述了一个 Nginx Deployment，指定了副本数量、标签选择器和容器配置。

Pod yaml文件详解

//Pod yaml文件详解

apiVersion: v1            #必选，版本号，例如v1
kind: Pod                #必选，Pod
metadata:                #必选，元数据
  name: string              #必选，Pod名称
  namespace: string          #必选，Pod所属的命名空间
  labels:                  #自定义标签
    - name: string            #自定义标签名字
  annotations:                #自定义注释列表
    - 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参数
      requests:                  #资源请求的设置
        cpu: string                #Cpu请求，容器启动的初始可用数量
        memory: string            #内存清楚，容器启动的初始可用数量
    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
       securityContext:
         privileged:false
    restartPolicy: [Always | Never | OnFailure]        #Pod的重启策略，Always表示一旦不管以何种方式终止运行，kubelet都将重启，OnFailure表示只有Pod以非0退出码退出才重启，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:                #类型为configMap的存储卷，挂载预定义的configMap对象到容器内部
        name: string
        items:
        - key: string

这个 YAML 文件是 Kubernetes Pod 规范。它定义了一个 Pod，包括元数据、容器、卷和其他设置的详细信息。

Service yaml文件详解

Service yaml文件详解

apiVersion: v1
kind: Service
matadata:                                #元数据
  name: string                           #service的名称
  namespace: string                      #命名空间  
  labels:                                #自定义标签属性列表
    - name: string
  annotations:                           #自定义注解属性列表  
    - name: string
spec:                                    #详细描述
  selector: []                           #label selector配置，将选择具有label标签的Pod作为管理 
                                         #范围
  type: string                           #service的类型，指定service的访问方式，默认为 
                                         #clusterIp
  clusterIP: string                      #虚拟服务地址      
  sessionAffinity: string                #是否支持session
  ports:                                 #service需要暴露的端口列表
  - name: string                         #端口名称
    protocol: string                     #端口协议，支持TCP和UDP，默认TCP
    port: int                            #服务监听的端口号
    targetPort: int                      #需要转发到后端Pod的端口号
    nodePort: int                        #当type = NodePort时，指定映射到物理机的端口号
  status:                                #当spce.type=LoadBalancer时，设置外部负载均衡器的地址
    loadBalancer:                        #外部负载均衡器    
      ingress:                           #外部负载均衡器 
        ip: string                       #外部负载均衡器的Ip地址值
        hostname: string                 #外部负载均衡器的主机名

这是一个 Kubernetes Service 的 YAML 文件，用于定义服务的元数据、规格和端口信息。该服务可指定访问方式、虚拟服务地址、端口配置以及外部负载均衡器的设置。

deployment.yaml文件详解

apiVersion: extensions/v1beta1   #接口版本
kind: Deployment                 #接口类型
metadata:
  name: cango-demo               #Deployment名称
  namespace: cango-prd           #命名空间
  labels:
    app: cango-demo              #标签
spec:
  replicas: 3
  strategy:
    rollingUpdate:  ##由于replicas为3,则整个升级,pod个数在2-4个之间
      maxSurge: 1      #滚动升级时会先启动1个pod
      maxUnavailable: 1 #滚动升级时允许的最大Unavailable的pod个数
  template:         
    metadata:
      labels:
        app: cango-demo  #模板名称必填
    sepc: #定义容器模板，该模板可以包含多个容器
      containers:                                                                   
        - name: cango-demo                                                           #镜像名称
          image: swr.cn-east-2.myhuaweicloud.com/cango-prd/cango-demo:0.0.1-SNAPSHOT #镜像地址
          command: [ "/bin/sh","-c","cat /etc/config/path/to/special-key" ]    #启动命令
          args:                                                                #启动参数
            - '-storage.local.retention=$(STORAGE_RETENTION)'
            - '-storage.local.memory-chunks=$(STORAGE_MEMORY_CHUNKS)'
            - '-config.file=/etc/prometheus/prometheus.yml'
            - '-alertmanager.url=http://alertmanager:9093/alertmanager'
            - '-web.external-url=$(EXTERNAL_URL)'
    #如果command和args均没有写，那么用Docker默认的配置。
    #如果command写了，但args没有写，那么Docker默认的配置会被忽略而且仅仅执行.yaml文件的command（不带任何参数的）。
    #如果command没写，但args写了，那么Docker默认配置的ENTRYPOINT的命令行会被执行，但是调用的参数是.yaml中的args。
    #如果如果command和args都写了，那么Docker默认的配置被忽略，使用.yaml的配置。
          imagePullPolicy: IfNotPresent  #如果不存在则拉取
          livenessProbe:       #表示container是否处于live状态。如果LivenessProbe失败，LivenessProbe将会通知kubelet对应的container不健康了。随后kubelet将kill掉container，并根据RestarPolicy进行进一步的操作。默认情况下LivenessProbe在第一次检测之前初始化值为Success，如果container没有提供LivenessProbe，则也认为是Success；
            httpGet:
              path: /health #如果没有心跳检测接口就为/
              port: 8080
              scheme: HTTP
            initialDelaySeconds: 60 ##启动后延时多久开始运行检测
            timeoutSeconds: 5
            successThreshold: 1
            failureThreshold: 5
          readinessProbe:
            httpGet:
              path: /health #如果没有心跳检测接口就为/
              port: 8080
              scheme: HTTP
            initialDelaySeconds: 30 ##启动后延时多久开始运行检测
            timeoutSeconds: 5
            successThreshold: 1
            failureThreshold: 5
          resources:              ##CPU内存限制
            requests:
              cpu: 2
              memory: 2048Mi
            limits:
              cpu: 2
              memory: 2048Mi
          env:                    ##通过环境变量的方式，直接传递pod=自定义Linux OS环境变量
            - name: LOCAL_KEY     #本地Key
              value: value
            - name: CONFIG_MAP_KEY  #局策略可使用configMap的配置Key，
              valueFrom:
                configMapKeyRef:
                  name: special-config   #configmap中找到name为special-config
                  key: special.type      #找到name为special-config里data下的key
          ports:
            - name: http
              containerPort: 8080 #对service暴露端口
          volumeMounts:     #挂载volumes中定义的磁盘
          - name: log-cache
            mount: /tmp/log
          - name: sdb       #普通用法，该卷跟随容器销毁，挂载一个目录
            mountPath: /data/media    
          - name: nfs-client-root    #直接挂载硬盘方法，如挂载下面的nfs目录到/mnt/nfs
            mountPath: /mnt/nfs
          - name: example-volume-config  #高级用法第1种，将ConfigMap的log-script,backup-script分别挂载到/etc/config目录下的一个相对路径path/to/...下，如果存在同名文件，直接覆盖。
            mountPath: /etc/config       
          - name: rbd-pvc                #高级用法第2中，挂载PVC(PresistentVolumeClaim)

#使用volume将ConfigMap作为文件或目录直接挂载，其中每一个key-value键值对都会生成一个文件，key为文件名，value为内容，
  volumes:  # 定义磁盘给上面volumeMounts挂载
  - name: log-cache
    emptyDir: {}
  - name: sdb  #挂载宿主机上面的目录
    hostPath:
      path: /any/path/it/will/be/replaced
  - name: example-volume-config  # 供ConfigMap文件内容到指定路径使用
    configMap:
      name: example-volume-config  #ConfigMap中名称
      items:
      - key: log-script           #ConfigMap中的Key
        path: path/to/log-script  #指定目录下的一个相对路径path/to/log-script
      - key: backup-script        #ConfigMap中的Key
        path: path/to/backup-script  #指定目录下的一个相对路径path/to/backup-script
  - name: nfs-client-root         #供挂载NFS存储类型
    nfs:
      server: 10.42.0.55          #NFS服务器地址
      path: /opt/public           #showmount -e 看一下路径
  - name: rbd-pvc                 #挂载PVC磁盘
    persistentVolumeClaim:
      claimName: rbd-pvc1         #挂载已经申请的pvc磁盘