Kubernetes K8S之通过yaml文件创建Pod与Pod常用字段详解

 

YAML语法规范;在kubernetes k8s中如何通过yaml文件创建pod,以及pod常用字段详解

 

YAML 语法规范

K8S 里所有的资源或者配置都可以用 yaml 或 Json 定义。YAML 是一个 JSON 的超集,任何有效的 JSON 文件也都是一个有效的YAML文件。

具体参见:「YAML 语言教程与使用案例

 

通过yaml创建nginx pod对象

yaml文件

在Kubernetes的 yaml文件中,最好不要出现下划线,可以有中横线

 1 [root@k8s-master test]# pwd
 2 /root/k8s_practice/test
 3 [root@k8s-master test]# cat nginx_demo.yaml
 4 apiVersion: v1
 5 kind: Pod
 6 metadata:
 7   name: nginx-demo
 8   namespace: default
 9   labels:
10     k8s-app: nginx
11     environment: dev
12   annotations:
13     name: nginx-demo
14 spec:
15   containers:
16   - name: nginx
17     image: registry.cn-beijing.aliyuncs.com/google_registry/nginx:1.17
18     imagePullPolicy: IfNotPresent
19     ports:
20     - name: httpd
21       containerPort: 80
22       #除非绝对必要,否则不要为 Pod 指定 hostPort。 将 Pod 绑定到hostPort时,它会限制 Pod 可以调度的位置数
23       #DaemonSet 中的 Pod 可以使用 hostPort,从而可以通过节点 IP 访问到 Pod;因为DaemonSet模式下Pod不会被调度到其他节点。
24       #一般情况下 containerPort与hostPort值相同
25       hostPort: 8090     #可以通过宿主机+hostPort的方式访问该Pod。例如:pod在/调度到了k8s-node02【172.16.1.112】,那么该Pod可以通过172.16.1.112:8090方式进行访问。
26       protocol: TCP
27     volumeMounts:        #定义容器挂载内容
28     - name: nginx-site   #使用的存储卷名称,跟下面volume字段的某个name值相同,这里表示使用volume的nginx-site这个存储卷
29       mountPath: /usr/share/nginx/html  #挂载至容器中哪个目录
30       readOnly: false                   #读写挂载方式,默认为读写模式false
31     - name: nginx-log
32       mountPath: /var/log/nginx/
33       readOnly: false
34   volumes:              #volumes字段定义了paues容器关联的宿主机或分布式文件系统存储卷
35   - name: nginx-site    #存储卷名称
36     hostPath:           #路径,为宿主机存储路径
37       path: /data/volumes/nginx/html/   #在宿主机上目录的路径
38       type: DirectoryOrCreate           #定义类型,这表示如果宿主机没有此目录,则会自动创建
39   - name: nginx-log
40     hostPath:
41       path: /data/volumes/nginx/log/
42       type: DirectoryOrCreate

 

Pod常见操作

 1 [root@k8s-master test]# pwd
 2 /root/k8s_practice/test
 3 [root@k8s-master test]# ll
 4 total 4
 5 -rw-r--r-- 1 root root 1317 Jul 29 16:42 nginx_demo.yaml
 6 # 创建pod
 7 [root@k8s-master test]# kubectl apply -f nginx_demo.yaml 
 8 pod/nginx-demo created
 9 # 查看pod。根据结果可见被调度到了 k8s-node02 节点
10 [root@k8s-master test]# kubectl get pod -o wide   # 或者 kubectl get pod -n default -o wide  因为名称空间为default
11 NAME                READY   STATUS    RESTARTS   AGE   IP            NODE         NOMINATED NODE   READINESS GATES
12 nginx-demo          1/1     Running   0          10s   10.244.2.16   k8s-node02   <none>           <none>
13 # 查看pod描述
14 [root@k8s-master test]# kubectl describe pod -n default nginx-demo   # 由于是默认名称空间,因此可以省略 -n default
15 …………
16 # 查看指定pod的基本信息,并显示标签信息
17 [root@k8s-master test]# kubectl get pod nginx-demo -o wide --show-labels
18 NAME          READY   STATUS    RESTARTS   AGE   IP            NODE         NOMINATED NODE   READINESS GATES   LABELS
19 nginx-demo    1/1     Running   0          61s   10.244.2.16   k8s-node02   <none>           <none>            environment=dev,k8s-app=nginx
20 # 删除pod
21 [root@k8s-master test]# kubectl delete -f nginx_demo.yaml   # 或者 kubectl delete pod nginx-demo
22 pod "nginx-demo" deleted

 

volume查看

由上可知 pod nginx-demo 被调度到了 k8s-node02 节点。那么对应的volume信息如下:

站点信息

1 [root@k8s-node02 nginx]# ll /data/volumes/nginx/html/    # 宿主机目录已经被创建
2 total 4
3 -rw-r--r-- 1 root root 14 May 20 22:50 index.html
4 [root@k8s-node02 nginx]# vim /data/volumes/nginx/html/index.html   # 然后我们创建该文件,用于后续站点访问
5 <h1>Test</h1>

 

日志信息

1 [root@k8s-node02 nginx]# ll /data/volumes/nginx/log/   # 宿主机目录已经被创建,且下面的两个日志文件也是容器启动时创建的
2 total 4
3 -rw-r--r-- 1 root root  0 May 20 23:04 access.log
4 -rw-r--r-- 1 root root  0 May 20 22:47 error.log

 

nginx站点访问

查看指定pod的基本信息。得到了该pod的IP

1 [root@k8s-master test]# kubectl get pod nginx-demo -o wide
2 NAME                READY   STATUS    RESTARTS   AGE   IP            NODE         NOMINATED NODE   READINESS GATES
3 nginx-demo          1/1     Running   0          61s   10.244.2.16   k8s-node02   <none>           <none>
4 [root@k8s-master test]# curl http://10.244.2.16   # curl 访问站点
5 <h1>Test</h1>
6 # 由于pod调用到了k8s-node02【172.16.1.112】节点,因此可以通过节点+hostPort端口方式访问
7 [root@k8s-master test]# curl 172.16.1.112:8090
8 <h1>Test</h1>

 

同时在k8s-node02节点机器也可见访问日志,信息如下:

1 [root@k8s-node02 nginx]# cat /data/volumes/nginx/log/access.log 
2 10.244.0.0 - - [20/May/2020:15:04:42 +0000] "GET / HTTP/1.1" 200 14 "-" "curl/7.29.0" "-"
3 10.244.0.0 - - [20/May/2020:15:34:50 +0000] "GET / HTTP/1.1" 200 14 "-" "curl/7.29.0" "-"
4 172.16.1.110 - - [20/May/2020:15:35:50 +0000] "GET / HTTP/1.1" 200 14 "-" "curl/7.29.0" "-"
5 172.16.1.110 - - [20/May/2020:15:36:50 +0000] "GET / HTTP/1.1" 200 14 "-" "curl/7.29.0" "-"

 

K8S Pod Yaml文件参数详细说明

特别说明:注意格式,层级与缩进。

 1 apiVersion: v1                  #必选,版本号,例如v1,可以用 kubectl api-versions 查询到
 2 kind: Pod                       #必选,指yaml文件定义的k8s 资源类型或角色,比如:Pod
 3 metadata:                       #必选,元数据对象
 4   name: string                  #必选,元数据对象的名字,自己定义,比如命名Pod的名字
 5   namespace: string             #必选,元数据对象的名称空间,默认为"default"
 6   labels:                       #自定义标签
 7     key1: value1               #自定义标签键值对1
 8     key2: value2               #自定义标签键值对2
 9   annotations:                  #自定义注解
10     key1: value1               #自定义注解键值对1
11     key2: value2               #自定义注解键值对2
12 spec:                           #必选,对象【如pod】的详细定义
13   containers:                   #必选,spec对象的容器信息
14   - name: string                #必选,容器名称
15     image: string               #必选,要用到的镜像名称
16     imagePullPolicy: [Always|Never|IfNotPresent]  #获取镜像的策略;(1)Always:意思是每次都尝试重新拉取镜像;(2)Never:表示仅使用本地镜像,即使本地没有镜像也不拉取;(3) IfNotPresent:如果本地有镜像就使用本地镜像,没有就拉取远程镜像。默认:Always
17     command: [string]           #指定容器启动命令,由于是数组因此可以指定多个。不指定则使用镜像打包时指定的启动命令。
18     args: [string]              #指定容器启动命令参数,由于是数组因此可以指定多个
19     workingDir: string          #指定容器的工作目录
20     volumeMounts:               #指定容器内部的存储卷配置
21     - name: string              #指定可以被容器挂载的存储卷的名称。跟下面volume字段的name值相同表示使用这个存储卷
22       mountPath: string         #指定可以被容器挂载的存储卷的路径,应少于512字符
23       readOnly: boolean         #设置存储卷路径的读写模式,true或者false,默认为读写模式false
24     ports:                      #需要暴露的端口号列表
25     - name: string              #端口的名称
26       containerPort: int        #容器监听的端口号
27       #除非绝对必要,否则不要为 Pod 指定 hostPort。 将 Pod 绑定到hostPort时,它会限制 Pod 可以调度的位置数
28       #DaemonSet 中的 Pod 可以使用 hostPort,从而可以通过节点 IP 访问到 Pod;因为DaemonSet模式下Pod不会被调度到其他节点。
29       #一般情况下 containerPort与hostPort值相同
30       hostPort: int     #可以通过宿主机+hostPort的方式访问该Pod。例如:pod在/调度到了k8s-node02【172.16.1.112】,hostPort为8090,那么该Pod可以通过172.16.1.112:8090方式进行访问。
31       protocol: string          #端口协议,支持TCP和UDP,默认TCP
32     env:                        #容器运行前需设置的环境变量列表
33     - name: string              #环境变量名称
34       value: string             #环境变量的值
35     resources:                  #资源限制和资源请求的设置(设置容器的资源上线)
36       limits:                   #容器运行时资源使用的上线
37         cpu: string             #CPU限制,单位为core数,允许浮点数,如0.1等价于100m,0.5等价于500m;因此如果小于1那么优先选择如100m的形式,精度为1m。这个数字用作 docker run 命令中的 --cpu-quota 参数。
38         memory: string          #内存限制,单位:E,P,T,G,M,K;或者Ei,Pi,Ti,Gi,Mi,Ki;或者字节数。将用于docker run --memory参数
39       requests:                 #容器启动和调度时的限制设定
40         cpu: string             #CPU请求,容器启动时初始化可用数量,单位为core数,允许浮点数,如0.1等价于100m,0.5等价于500m;因此如果小于1那么优先选择如100m的形式,精度为1m。这个数字用作 docker run 命令中的 --cpu-shares 参数。
41         memory: string          #内存请求,容器启动的初始化可用数量。单位:E,P,T,G,M,K;或者Ei,Pi,Ti,Gi,Mi,Ki;或者字节数
42     # 参见官网地址:https://kubernetes.io/zh/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
43     livenessProbe:            #对Pod内各容器健康检查的设置,当探测无响应几次后将自动重启该容器,检查方法有exec、httpGet和tcpSocket,对一个容器【只需设置其中一种方法即可】
44       exec:               #对Pod内容器健康检查方式设置为exec方式
45         command: [string]       #exec方式需要制定的命令或脚本
46       httpGet:              #对Pod内容器健康检查方法设置为HttpGet,需要制定Path、port
47         path: string            #访问 HTTP 服务的路径
48         port: number            #访问容器的端口号或者端口名。如果数字必须在 1 ~ 65535 之间。
49         host: string            #当没有定义 "host" 时,使用 "PodIP"
50         scheme: string          #当没有定义 "scheme" 时,使用 "HTTP",scheme 只允许 "HTTP""HTTPS"
51         HttpHeaders:            #请求中自定义的 HTTP 头。HTTP 头字段允许重复。
52         - name: string
53           value: string
54       tcpSocket:            #对Pod内容器健康检查方式设置为tcpSocket方式
55          port: number
56       initialDelaySeconds: 5    #容器启动完成后,kubelet在执行第一次探测前应该等待 5 秒。默认是 0 秒,最小值是 057       periodSeconds: 60       #指定 kubelet 每隔 60 秒执行一次存活探测。默认是 10 秒。最小值是 1
58       timeoutSeconds: 3       #对容器健康检查探测等待响应的超时时间为 3 秒,默认1秒
59       successThreshold: 1       #检测到有1次成功则认为服务是`就绪`
60       failureThreshold: 5       #检测到有5次失败则认为服务是`未就绪`。默认值是 3,最小值是 161     nodeSelector:             #定义Node的label过滤标签,以key:value的格式指定。节点选择,先给主机打标签kubectl label nodes kube-node01 key1=value1 
62       key1: value1
63     imagePullSecrets:         #Pull镜像时使用的secret名称,以name:secretKeyName格式指定
64     - name: string
65     hostNetwork: false        #是否使用主机网络模式,默认为false。如果设置为true,表示使用宿主机网络,不使用docker网桥
66   restartPolicy: [Always|Never|OnFailure] #Pod的重启策略,默认Always。Always表示一旦不管以何种方式终止运行,kubelet都将重启;OnFailure表示只有Pod以非0退出码退出才重启;Nerver表示不再重启该Pod
67   # volumes 和 containers 是同层级 ******************************
68   # 参见官网地址:https://kubernetes.io/zh/docs/concepts/storage/volumes/
69   volumes:              #定义了paues容器关联的宿主机或分布式文件系统存储卷列表 (volumes类型有很多种,选其中一种即可)
70   - name: string          #共享存储卷名称。
71     emptyDir: {}            #类型为emtyDir的存储卷,与Pod同生命周期的一个临时目录。当Pod因为某些原因被从节点上删除时,emptyDir卷中的数据也会永久删除。
72     hostPath: string        #类型为hostPath的存储卷,表示挂载Pod所在宿主机的文件或目录
73       path: string          #在宿主机上文件或目录的路径
74       type: [|DirectoryOrCreate|Directory|FileOrCreate|File] #空字符串(默认)用于向后兼容,这意味着在安装 hostPath 卷之前不会执行任何检查。DirectoryOrCreate:如果给定目录不存在则创建,权限设置为 0755,具有与 Kubelet 相同的组和所有权。Directory:给定目录必须存在。FileOrCreate:如果给定文件不存在,则创建空文件,权限设置为 0644,具有与 Kubelet 相同的组和所有权。File:给定文件必须存在。
75     secret:              #类型为secret的存储卷,挂载集群预定义的secre对象到容器内部。Secret 是一种包含少量敏感信息例如密码、token 或 key 的对象。放在一个 secret 对象中可以更好地控制它的用途,并降低意外暴露的风险。
76       secretName: string      #secret 对象的名字
77       items:                  #可选,修改key 的目标路径
78       - key: username         #username secret存储在/etc/foo/my-group/my-username 文件中而不是 /etc/foo/username 中。【此时存在spec.containers[].volumeMounts[].mountPath为/etc/foo】
79         path: my-group/my-username
80     configMap:            #类型为configMap的存储卷,挂载预定义的configMap对象到容器内部。ConfigMap 允许您将配置文件与镜像文件分离,以使容器化的应用程序具有可移植性。
81       name: string            #提供你想要挂载的 ConfigMap 的名字

 

资源需求(Requests)和限制(Limits)说明

对于每一个资源,container可以指定具体的资源需求(requests)和限制(limits)。

requests申请范围是0到node节点的最大配置,而limits申请范围是requests到无限,即0 <= requests <=Node Allocatable,requests <= limits <= Infinity。

对于CPU,如果pod中服务使用CPU超过设置的limits,pod不会被kill掉但会被限制。如果没有设置limits,pod可以使用全部空闲的cpu资源。

对于内存,当一个pod使用内存超过了设置的limits,【一个Pod可能有多个container】pod中container的进程会被kernel因OOM kill掉。当container因为OOM被kill掉时,系统倾向于在其原所在的机器上重启该container或本机或其他重新创建一个pod。

 

volumeMounts和volumes区别

volumeMounts示例如下:

1 volumeMounts:        #定义容器挂载内容
2 - name: nginx-site   #使用的存储卷名称,跟下面volume字段的某个name值相同,这里表示使用volume的nginx-site这个存储卷
3   mountPath: /usr/share/nginx/html  #挂载至容器中哪个目录
4   readOnly: false                   #读写挂载方式,默认为读写模式false
5 - name: nginx-log
6   mountPath: /var/log/nginx/
7   readOnly: false

  

volumes示例如下:

1 volumes:              #volumes字段定义了paues容器关联的宿主机或分布式文件系统存储卷
2 - name: nginx-site    #存储卷名称
3   hostPath:           #路径,为宿主机存储路径
4     path: /data/volumes/nginx/html/   #在宿主机上目录的路径
5     type: DirectoryOrCreate           #定义类型,这表示如果宿主机没有此目录,则会自动创建
6 - name: nginx-log
7   hostPath:
8     path: /data/volumes/nginx/log/
9     type: DirectoryOrCreate

 

相关阅读

1、YAML 语言教程与使用案例

完毕!

 

 


 

 

———END———
如果觉得不错就关注下呗 (-^O^-) !

 

posted on 2020-08-05 22:26  踏歌行666  阅读(3564)  评论(0编辑  收藏  举报

导航