ymal文件详解

最新推荐文章于 2023-08-08 02:41:24 发布

洛页

最新推荐文章于 2023-08-08 02:41:24 发布

阅读量2.2k

点赞数 4

文章标签： redis kubernetes docker 容器运维

本文链接：https://blog.csdn.net/weixin_45531306/article/details/121381620

版权

k8s ymal文件详解

Kubernetes只支持YAML和JSON格式创建资源对象，JSON格式用于接口之间消息的传递，适用于开发；YAML格式用于配置和管理，适用于云平台管理，YAML是一种简洁的非标记性语言。

一、yaml的语法规则：

大小写敏感
使用缩进表示层级关系
缩进时不允许使用Tal键，只允许使用空格
缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
”#” 表示注释，从这个字符一直到行尾，都会被解析器忽略

注：- - - 为可选的分隔符，当需要在一个文件中定义多个结构的时候需要使用

二、在Kubernetes中，只需要知道两种结构类型即可：

2.1、YAML Maps

Map顾名思义指的是字典，即一个Key:Value 的键值对信息。例如：

apiVersion: v1
kind: Pod

上述内容表示有两个键apiVersion和kind，分别对应的值为v1和Pod。

Maps的value既能够对应字符串也能够对应一个Maps。例如：

apiVersion: v1
kind: Pod
metadata:
  name: kube100-site
  labels:
    app: web

注：上述的YAML文件中，metadata这个KEY对应的值为一个Maps，而嵌套的labels这个KEY的值又是一个Map。实际使用中可视情况进行多层嵌套。

YAML处理器根据行缩进来知道内容之间的关联。上述例子中，使用两个空格作为缩进，但空格的数据量并不重要，只是至少要求一个空格并且所有缩进保持一致的空格数。例如，name和labels是相同缩进级别，因此YAML处理器知道他们属于同一map；它知道app是lables的值因为app的缩进更大。

注意：在YAML文件中绝对不要使用tab键

2.2、YAML Lists

List即列表，说白了就是数组，例如：

args
 -beijing
 -shanghai
 -shenzhen
 -guangzhou

可以指定任何数量的项在列表中，每个项的定义以破折号（-）开头，并且与父元素之间存在缩进。

{
  "args": ["beijing", "shanghai", "shenzhen", "guangzhou"]
}

当然Lists的子项也可以是Maps，Maps的子项也可以是List，例如：

apiVersion: v1
kind: Pod
metadata:
  name: kube100-site
  labels:
    app: web
spec:
  containers:
    - name: front-end
      image: nginx
      ports:
        - containerPort: 80
    - name: flaskapp-demo
      image: jcdemo/flaskapp
      ports: 8080

如上述文件所示，定义一个containers的List对象，每个子项都由name、image、ports组成，每个ports都有一个KEY为containerPort的Map组成。转成JSON格式文件

{
  "apiVersion": "v1",
  "kind": "Pod",
  "metadata": {
        "name": "kube100-site",
        "labels": {
            "app": "web"
        },
 
  },
  "spec": {
        "containers": [{
            "name": "front-end",
            "image": "nginx",
            "ports": [{
                "containerPort": "80"
            }]
        }, {
            "name": "flaskapp-demo",
            "image": "jcdemo/flaskapp",
            "ports": [{
                "containerPort": "5000"
            }]
        }]
  }
}

三、yaml常见语法

1）apiVersion

1.1查看当前所有可用的API版本

kubectl api-versions

1.6版本之前 apiVsersion：extensions/v1beta1

1.6版本到1.9版本之间：apps/v1beta1

1.9版本之后:apps/v1

1.2常用apiversion

只要记住6个常用的apiversion一般就够用了。

v1： Kubernetes API的稳定版本，包含很多核心对象：pod、service等。

apps/v1：包含一些通用的应用层的api组合，如：Deployments, RollingUpdates, and ReplicaSets。

batch/v1：包含与批处理和类似作业的任务相关的对象，如：job、cronjob。

autoscaling/v1：允许根据不同的资源使用指标自动调整容器。

networking.k8s.io/v1：用于Ingress。

rbac.authorization.k8s.io/v1：用于RBAC。

下面是官方原文链接，有兴趣的同学可以看看，页面是可以选择语言的，但是中文翻译有点问题，建议中文英文对照着看。https://kubernetes.io/docs/reference/using-api/

2）kind

kind指定这个资源对象的类型，如 pod、deployment、statefulset（有状态）、job、cronjob（定时任务）

3）metadata（元数据）

metadata常用的配置项有 name,namespace,即配置其显示的名字与归属的命名空间。

4）spec（配置项）

一个嵌套字典与列表的配置项，也是主要的配置项，支持的子项非常多，根据资源对象的不同，子项会有不同的配置。

4.1一个pod的spec配置：

apiVersion: v1 #必选，版本号，例如v1

kind: Pod #必选，Pod

metadata: #必选，元数据

  name: nginx #必选，Pod名称

  labels: #自定义标签

    app: nginx #自定义标签名字

spec: #必选，Pod中容器的详细定义

  containers: #必选，Pod中容器列表，一个pod里会有多个容器

    - name: nginx #必选，容器名称

      image: nginx #必选，容器的镜像名称

      imagePullPolicy: IfNotPresent # [Always | Never | IfNotPresent] #获取镜像的策略 Alawys表示下载镜像 IfnotPresent表示优先使用本地镜像，否则下载镜像，Nerver表示仅使用本地镜像

      ports: #需要暴露的端口库号列表

      - containerPort: 80 #容器需要监听的端口号

  restartPolicy: Always # [Always | Never | OnFailure]#Pod的重启策略，Always表示一旦不管以何种方式终止运行，kubelet都将重启，OnFailure表示只有Pod以非0退出码退出才重启，Nerver表示不再重启该Pod

4.2一个service 的 spec 的配置：

apiVersion: v1

kind: Service

metadata:

  name: service-hello

  labels:

  name: service-hello

spec:

  type: NodePort #这里代表是NodePort类型的,另外还有ingress,LoadBalancer

  ports:

  - port: 80 #这里的端口和clusterIP(kubectl describe service service-hello中的IP的port)对应，即在集群中所有机器上curl 10.98.166.242:80可访问发布的应用服务。

    targetPort: 8080 #端口一定要和container暴露出来的端口对应，nodejs暴露出来的端口是8081，所以这里也应是8081

    protocol: TCP

    nodePort: 31111 # 所有的节点都会开放此端口30000--32767，此端口供外部调用。

  selector:

    run: hello #这里选择器一定要选择容器的标签，之前写name:kube-node是错的。

这里是将nginx映射到外网，访问地址就是本机ip:31111

4.3一个deploy的spec配置

#test-pod 
apiVersion: v1 #指定api版本，此值必须在kubectl apiversion中   
kind: Pod #指定创建资源的角色/类型   
metadata: #资源的元数据/属性   
  name: test-pod #资源的名字，在同一个namespace中必须唯一   
  labels: #设定资源的标签 
    k8s-app: apache   
    version: v1   
    kubernetes.io/cluster-service: "true"   
  annotations:            #自定义注解列表   
    - name: String        #自定义注解名字   
spec: #specification of the resource content 指定该资源的内容   
  restartPolicy: Always #表明该容器一直运行，默认k8s的策略，在此容器退出后，会立即创建一个相同的容器   
  nodeSelector:     #节点选择，先给主机打标签kubectl label nodes kube-node1 zone=node1   
    zone: node1   
  containers:   
  - name: test-pod #容器的名字   
    image: 10.192.21.18:5000/test/chat:latest #容器使用的镜像地址   
    imagePullPolicy: Never #三个选择Always、Never、IfNotPresent，每次启动时检查和更新（从registery）images的策略， 
                           # Always，每次都检查 
                           # Never，每次都不检查（不管本地是否有） 
                           # IfNotPresent，如果本地有就不检查，如果没有就拉取 
    command: ['sh'] #启动容器的运行命令，将覆盖容器中的Entrypoint,对应Dockefile中的ENTRYPOINT   
    args: ["$(str)"] #启动容器的命令参数，对应Dockerfile中CMD参数   
    env: #指定容器中的环境变量   
    - name: str #变量的名字   
      value: "/etc/run.sh" #变量的值   
    resources: #资源管理 
      requests: #容器运行时，最低资源需求，也就是说最少需要多少资源容器才能正常运行   
        cpu: 0.1 #CPU资源（核数），两种方式，浮点数或者是整数+m，0.1=100m，最少值为0.001核（1m） 
        memory: 32Mi #内存使用量   
      limits: #资源限制   
        cpu: 0.5   
        memory: 1000Mi   
    ports:   
    - containerPort: 80 #容器开发对外的端口 
      name: httpd  #名称 
      protocol: TCP   
    livenessProbe: #pod内容器健康检查的设置 
      httpGet: #通过httpget检查健康，返回200-399之间，则认为容器正常   
        path: / #URI地址   
        port: 80   
        #host: 127.0.0.1 #主机地址   
        scheme: HTTP   
      initialDelaySeconds: 180 #表明第一次检测在容器启动后多长时间后开始   
      timeoutSeconds: 5 #检测的超时时间   
      periodSeconds: 15  #检查间隔时间   
      #也可以用这种方法   
      #exec: 执行命令的方法进行监测，如果其退出码不为0，则认为容器正常   
      #  command:   
      #    - cat   
      #    - /tmp/health   
      #也可以用这种方法   
      #tcpSocket: //通过tcpSocket检查健康    
      #  port: number    
    lifecycle: #生命周期管理   
      postStart: #容器运行之前运行的任务   
        exec:   
          command:   
            - 'sh'   
            - 'yum upgrade -y'   
      preStop:#容器关闭之前运行的任务   
        exec:   
          command: ['service httpd stop']   
    volumeMounts:  #挂载持久存储卷 
    - name: volume #挂载设备的名字，与volumes[*].name 需要对应     
      mountPath: /data #挂载到容器的某个路径下   
      readOnly: True   
  volumes: #定义一组挂载设备   
  - name: volume #定义一个挂载设备的名字   
    #meptyDir: {}   
    hostPath:   
      path: /opt #挂载设备类型为hostPath，路径为宿主机下的/opt,这里设备类型支持很多种 
    #nfs

四、port详解

port ：port是k8s集群内部访问service的端口，即通过clusterIP: port可以访问到某个service
nodePort ：nodePort是外部访问k8s集群中service的端口，通过nodeIP: nodePort可以从外部访问到某个service。
targetPort ：targetPort是pod的端口，从port和nodePort来的流量经过kube-proxy流入到后端pod的targetPort上，最后进入容器。
containerPort ：containerPort是pod内部容器的端口，targetPort映射到containerPort。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-J0cOoPIX-1637137794720)(image/okWtpehqArKjC3MnL4GRfy.png)]

五、yaml简单示例

接下来就是看看deployment、pod、service 这三种资源的说明书例子

1）deployment-1

apiVersion: apps/v1 # 1.9.0 之前的版本使用 apps/v1beta2，可通过命令 kubectl api-versions 查看

kind: Deployment #指定创建资源的角色/类型

metadata: #资源的元数据/属性

  name: nginx-deployment #资源的名字，在同一个namespace中必须唯一

spec:

  replicas: 2 #副本数量2

  selector: #定义标签选择器

    matchLabels:

      app: web-server

  template: #这里Pod的定义

    metadata:

      labels: #Pod的label

        app: web-server

    spec: # 指定该资源的内容

      containers:

      - name: nginx #容器的名字

        image: nginx:1.12.1 #容器的镜像地址

        ports:

        - containerPort: 80 #容器对外的端口

执行以下命令创建 deployment 资源

$ kubectl create -f nginx.yaml

deployment-2

[root@k8s-master-001 ~]# vim nginx-deploy.yaml 
apiVersion: apps/v1   ##版本号 ，pod资源
kind: Deployment      ##类型/控制器
metadata:                   ##数据标签
  name: nginx-deployment
  labels:            ##子标签
    app: nginx        ##业务容器
spec:
  replicas: 3          ##副本集
  selector:            ##选择器
    matchLabels:        ##匹配标签
      app: nginx          ##对应上面的业务容器
  template:          ##模板
    metadata:
      labels:
        app: nginx
    spec:
      containers:       ##容器
      - name: nginx     ##对应上面的业务容器
        image: nginx:1.15.4     ##使用镜像信息
        ports:
        - containerPort: 80      ##容器端口信息
---
apiVersion: v1        ##版本号
kind: Service        ##服务类型
metadata:
  name: nginx-service
  labels:
    app: nginx
spec:
  type: NodePort     ##端口映射
  ports:
  - port: 80     ##内部端口
    targetPort: 80   ##映射端口
  selector:       ##选择器/
    app: nginx      ##选择业务进行发布

2）pod

apiVersion: v1

kind: Pod

metadata:

  name: pod-redis

  labels:

    name: redis

spec:

  containers:

  - name: pod-redis

    image: [docker.io/redis](http://docker.io/redis)

    ports:

    - containerPort: 80 #容器对外的端口

执行以下命令创建 pod 资源

$ kubectl create -f pod-redis.yaml

3）service

apiVersion: v1

kind: Service # 指明资源类型是 service

metadata:

  name: httpd-svc # service 的名字是 httpd-svc

  labels:

    name: httpd-svc

spec:

  ports: # 将 service 8080 端口映射到 pod 的 80 端口，使用 TCP 协议

  - port: 8080

    targetPort: 80

    protocol: TCP

  selector:

    run: httpd # 指明哪些 label 的 pod 作为 service 的后端

执行以下命令创建 service 资源

$ kubectl create -f httpd-svc.yaml

六、Label与Selector

1）Label

Label是Kubernetes系列中另外一个核心概念。是一组绑定到K8s资源对象上的key/value对。同一个对象的labels属性的key必须唯一。label可以附加到各种资源对象上，如Node,Pod,Service,RC等。

通过给指定的资源对象捆绑一个或多个不用的label来实现多维度的资源分组管理功能，以便于灵活，方便地进行资源分配，调度，配置，部署等管理工作。

示例如下：

版本标签：“release” : “stable” , “release” : “canary”…

环境标签：“environment” : “dev” , “environment” : “production”

架构标签：“tier” : “frontend” , “tier” : “backend” , “tier” : “middleware”

分区标签：“partition” : “customerA” , “partition” : “customerB”…

质量管控标签：“track” : “daily” , “track” : “weekly”

2）Selector

Label selector是Kubernetes核心的分组机制，通过label selector客户端/用户能够识别一组有共同特征或属性的资源对象。符合这个标签的 Pod 会作为这个 Service 的 backend。

apiVersion: v1
kind: Service
metadata:
  name: hello
  labels:
    app: hello
spec:
  ports:
  - port: 80
    targetPort: 80
  selector:
app: hello

七、kubectl create还是 kubectl apply二者区别

kubectl create -f 还是 kubectl apply -f 都可以创建资源，但是有什么区别呢，请细品下面讲解。

kubectl create：命令可创建新资源。因此，如果再次运行该命令，则会抛出错误，因为资源名称在名称空间中应该是唯一的。
kubectl apply：命令将配置应用于资源。如果资源不在那里，那么它将被创建。 kubectl apply命令可以多次运行，因为它只是应用如下所示的配置。在这种情况下，配置没有改变。所以，pod没有改变。

洛页

关注

4
点赞
踩
9

收藏

觉得还不错? 一键收藏
1
评论
ymal文件详解

k8s ymal文件详解Kubernetes只支持YAML和JSON格式创建资源对象，JSON格式用于接口之间消息的传递，适用于开发；YAML格式用于配置和管理，适用于云平台管理，YAML是一种简洁的非标记性语言。一、yaml的语法规则：大小写敏感使用缩进表示层级关系缩进时不允许使用Tal键，只允许使用空格缩进的空格数目不重要，只要相同层级的元素左侧对齐即可”#” 表示注释，从这个字符一直到行尾，都会被解析器忽略注：- - - 为可选的分隔符，当需要在一个文件中定义
复制链接

扫一扫