K8S：Yaml文件详解及编写示例

一.Yaml文件详解

1.Yaml文件格式

（1）Kubernetes 支持 YAML 和 JSON 格式管理资源对象

（2）JSON 格式：主要用于 api 接口之间消息的传递

（3）YAML 格式：用于配置和管理，YAML 是一种简洁的非标记性语言，内容格式人性化，较易读

2.YAML 语法格式

（1）大小写敏感
（2）使用缩进表示层级关系
（3）不支持Tab键制表符缩进，只使用空格缩进
（4）缩进的空格数目不重要，只要相同层级的元素左侧对齐即可，通常开头缩进两个空格
（5）符号字符后缩进一个空格，如冒号，逗号，短横杆（-）等
（6）“—”表示YAML格式，一个文件的开始，用于分隔文件间
（7）“#”表示注释

二.Yaml文件编写及相关概念

1.查看 api 资源版本标签

kubectl api-versionskubectl api-versions
admissionregistration.k8s.io/v1
admissionregistration.k8s.io/v1beta1
apiextensions.k8s.io/v1
apiextensions.k8s.io/v1beta1
apiregistration.k8s.io/v1
apiregistration.k8s.io/v1beta1
apps/v1                             #如果是业务场景一般首选使用 apps/v1
authentication.k8s.io/v1   
authentication.k8s.io/v1beta1       #带有beta字样的代表的是测试版本，不用在生产环境中
authorization.k8s.io/v1
authorization.k8s.io/v1beta1
autoscaling/v1
autoscaling/v2beta1
autoscaling/v2beta2
batch/v1
batch/v1beta1
certificates.k8s.io/v1
certificates.k8s.io/v1beta1
coordination.k8s.io/v1
coordination.k8s.io/v1beta1
discovery.k8s.io/v1beta1
events.k8s.io/v1
events.k8s.io/v1beta1
extensions/v1beta1
flowcontrol.apiserver.k8s.io/v1beta1
networking.k8s.io/v1
networking.k8s.io/v1beta1
node.k8s.io/v1
node.k8s.io/v1beta1
policy/v1beta1
rbac.authorization.k8s.io/v1
rbac.authorization.k8s.io/v1beta1
scheduling.k8s.io/v1
scheduling.k8s.io/v1beta1
storage.k8s.io/v1
storage.k8s.io/v1beta1
v1

2.yaml编写案例

（1）相关标签介绍

#查看deployment的版本定义
kubectl explain deployment

#查看api的版本
kubectl explain deployment.apiVersion

#查看元数据信息
kubectl explain deployment.apiVersion

#定义标签介绍
kubectl explain deployment.spec.selector
#对matchLabels标签介绍
kubectl explain deployment.spec.selector.matchLabels

（2）Deployment类型编写nginx服务

• 创建pod

#写一个yaml文件demo
mkdir /opt/demo
cd demo/

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

#创建资源对象
kubectl create -f nginx-deployment.yaml
或
kubectl apply -f nginx-deployment.yaml 
#查看创建的资源对象，创建需等待running
kubectl get pod

#查看创建的pod资源
kubectl get pods -o wideNAME                            READY   STATUS    RESTARTS   AGE     IP            NODE     NOMINATED NODE   READINESS GATES
myapp-summer-5b5b5f6c6b-dpnw4   1/1     Running   0          3m53s   10.244.1.27   node02   <none>           <none>
myapp-summer-5b5b5f6c6b-qwlpq   1/1     Running   0          3m53s   10.244.2.20   node01   <none>           <none>
myapp-summer-5b5b5f6c6b-rgnmc   1/1     Running   0          3m53s   10.244.2.21   node01   <none>           <none>

• 容器如果想对外提供访问，需创建service 发布

#创建service服务对外提供访问并测试
vim nginx-service.yamlapiVersion: v1  
kind: Service  
metadata:name: nginx-servicelabels:app: nginx  
spec:type: NodePort  ports:- port: 80targetPort: 80  selector:app: nginx

#创建资源对象
kubectl create -f nginx-service.yaml 
或
kubectl apply -f nginx-service.yaml
#查看创建的service
[root@master01 demo]# kubectl  get svc
NAME                     TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)           AGE
kubernetes               ClusterIP   10.96.0.1       <none>        443/TCP           5d19h
myapp-summer             NodePort    10.96.30.130    <none>        8080:32666/TCP    119s

#在浏览器输入 nodeIP:nodePort 即可访问
http://192.168.198.11:32666
http://192.168.198.12:32666

（3）k8s集群中的port介绍

详解k8s中的port：
●port
port 是 k8s 集群内部访问service的端口，即通过 clusterIP: port 可以从 Pod 所在的 Node 上访问到 service

●nodePort
nodePort 是外部访问 k8s 集群中 service 的端口，通过 nodeIP: nodePort 可以从外部访问到某个 service。

●targetPort
targetPort 是 Pod 的端口，从 port 或 nodePort 来的流量经过 kube-proxy 反向代理负载均衡转发到后端 Pod 的 targetPort 上，最后进入容器。

●containerPort

containerPort 是 Pod 内部容器的端口，targetPort 映射到 containerPort。

（4）Deployment类型编写redis服务

vim demo02-redis.yamlapiVersion: apps/v1
kind: Deployment
metadata:name: redis-deploymentnamespace: defaultlabels:app: redis
spec:replicas: 2selector:matchLabels:app: redistemplate:                            metadata:labels:           app: redisspec:containers:                         - name: redis                            image: redis:latestports:- containerPort: 6379    ---   apiVersion: v1
kind: Service  
metadata:name: redislabels:app: redis
spec:type: NodePortports:- port: 6379targetPort: 6379nodePort: 32555selector:app: redis

#创建资源
kubectl apply -f demo02-redis.yaml 
#查看创建的资源
kubectl get pod,svc

使用Redis Desktop Manager测试redis，安装包在主页资源中

添加键值对

#登入查看创建的键值对
kubectl exec -it redis-deployment-756b4b8956-khw2m bash
redis-cli
keys *

（5）快速编写yaml文件

#kubectl run --dry-run=client 打印相应的 API 对象而不执行创建（空跑）
kubectl run nginx-test --image=nginx --port=80 --dry-run=client
kubectl create deployment nginx-deploy --image=nginx --port=80 --replicas=3 --dry-run=client

#查看生成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格式导出生成模板，并进行修改以及删除一些不必要的参数
kubectl run nginx-test --image=nginx --port=80 --dry-run=client -o yaml > nginx-test.yaml
kubectl create deployment nginx-deploy --image=nginx --port=80 --replicas=3 --dry-run=client -o yaml  > nginx-deploy.yaml

vim nginx-test.yamlapiVersion: v1
kind: Pod
metadata:creationTimestamp: null     #删除labels:run: nginx-testname: nginx-test
spec:containers:- image: nginxname: nginx-testports:- containerPort: 80resources: {}             #删除dnsPolicy: ClusterFirstrestartPolicy: Alwaysstatus: {}                    #删除

#将现有的资源生成模板导出
kubectl get svc nginx-service -o yaml

#保存到文件中
kubectl get svc nginx-service -o yaml > my-svc.yaml

#查看字段帮助信息，可一层层的查看相关资源对象的帮助信息
kubectl explain deployments.spec.template.spec.containers
或
kubectl explain pods.spec.containers

#快速查看相关模板
kubectl edit

（6）案例：自主式创建service并关联上面的pod

资源类型：pod 自主式

资源名称：nginx-rain

命名空间：rain

容器镜像要求：nginx 1.14

容器端口：80

标签：app-rain

#空跑
kubectl run nginx-rain --image=nginx:1.14 --port=80 --dry-run=client -oyaml > nginx-rain。yaml
#复制出来的模板
kubectl create ns rain --dry-run -oyaml

vim nginx-rain.yaml ---
apiVersion: v1
kind: Namespace
metadata:name: rain
---
apiVersion: v1
kind: Pod
metadata:labels:run: rainname: nginx-rainnamespace: rain
spec:containers:- image: nginx:1.14name: nginx-rainports:- containerPort: 80restartPolicy: Always
---
apiVersion: v1
kind: Service
metadata:name: nginx-rainlabels:run: rainnamespace: rain
spec:ports:- nodePort: 32333port: 80protocol: TcptargetPort: 80selector:run: raintype: NodePort

kubectl apply -f nginx-rain.yaml 

#查看创建所有信息
kubectl get pod,svc,ns -n rain

#访问测试
curl 10.96.80.12
http://192.168.198.11:32333/

#写yaml简洁方法
●用 --dry-run 命令生成
kubectl run my-deploy --image=nginx --dry-run=client -o yaml > my-deploy.yaml●用get命令导出
kubectl get svc nginx-service -o yaml > my-svc.yaml
或
kubectl edit svc nginx-service  #复制配置，再粘贴到新文件

（7）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，默认TCPenv:					#容器运行前需设置的环境变量列表- 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、portpath: stringport: numberhost: stringscheme: stringHttpHeaders:- name: stringvalue: stringtcpSocket:			#对Pod内个容器健康检查方式设置为tcpSocket方式port: numberinitialDelaySeconds: 0	#容器启动完成后首次探测的时间，单位为秒timeoutSeconds: 0		#对容器健康检查探测等待响应的超时时间，单位秒，默认1秒periodSeconds: 0			#对容器监控检查的定期探测时间设置，单位秒，默认10秒一次successThreshold: 0failureThreshold: 0securityContext:privileged:falserestartPolicy: [Always | Never | OnFailure]		#Pod的重启策略，Always表示一旦不管以何种方式终止运行，kubelet都将重启，OnFailure表示只有Pod以非0退出码退出才重启，Nerver表示不再重启该PodnodeSelector: obeject		#设置NodeSelector表示将该Pod调度到包含这个label的node上，以key：value的格式指定imagePullSecrets:			#Pull镜像时使用的secret名称，以key：secretkey格式指定- name: stringhostNetwork: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: stringpath: stringconfigMap:				#类型为configMap的存储卷，挂载预定义的configMap对象到容器内部name: stringitems:- key: string

（8）deployment.yaml文件详解

apiVersion: extensions/v1beta1   #接口版本
kind: Deployment                 #接口类型
metadata:name: cango-demo               #Deployment名称namespace: cango-prd           #命名空间labels:app: cango-demo              #标签
spec:replicas: 3strategy:rollingUpdate:  ##由于replicas为3,则整个升级,pod个数在2-4个之间maxSurge: 1      #滚动升级时会先启动1个podmaxUnavailable: 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: 8080scheme: HTTPinitialDelaySeconds: 60 ##启动后延时多久开始运行检测timeoutSeconds: 5successThreshold: 1failureThreshold: 5readinessProbe:httpGet:path: /health #如果没有心跳检测接口就为/port: 8080scheme: HTTPinitialDelaySeconds: 30 ##启动后延时多久开始运行检测timeoutSeconds: 5successThreshold: 1failureThreshold: 5resources:              ##CPU内存限制requests:cpu: 2memory: 2048Milimits:cpu: 2memory: 2048Mienv:                    ##通过环境变量的方式，直接传递pod=自定义Linux OS环境变量- name: LOCAL_KEY     #本地Keyvalue: value- name: CONFIG_MAP_KEY  #局策略可使用configMap的配置Key，valueFrom:configMapKeyRef:name: special-config   #configmap中找到name为special-configkey: special.type      #找到name为special-config里data下的keyports:- name: httpcontainerPort: 8080 #对service暴露端口volumeMounts:     #挂载volumes中定义的磁盘- name: log-cachemount: /tmp/log- name: sdb       #普通用法，该卷跟随容器销毁，挂载一个目录mountPath: /data/media    - name: nfs-client-root    #直接挂载硬盘方法，如挂载下面的nfs目录到/mnt/nfsmountPath: /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-cacheemptyDir: {}- 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中的Keypath: path/to/log-script  #指定目录下的一个相对路径path/to/log-script- key: backup-script        #ConfigMap中的Keypath: 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磁盘

（9）Service yaml文件详解

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

（10）k8s部署tomcat的yaml文件

vim tomcat-pod.yamlapiVersion: apps/v1
kind: Deployment
metadata:                   #定义了 Deployment 的元数据信息，包括名称和标签name: mytomcat
spec:                       #定义了 Deployment 的规范信息，包括副本数、Selector、升级策略replicas: 3               #指定了 Deployment 所需的 Pod 副本数selector:                 #定义了匹配标签的 Selector，以选择要控制的 PodmatchLabels: app: mytomcatminReadySeconds: 1             #指定了 Deployment 进行滚动升级时，新 Pod 可以被认为已准备好的最小时间progressDeadlineSeconds: 60    #指定了 Deployment 升级的最长时间，超过此时间将标记为失败revisionHistoryLimit: 5        #定义了 Deployment 可以保留的版本历史数量的最大值strategy:                      #定义了 Deployment 进行滚动升级的策略type: RollingUpdate          #指定了滚动升级的类型，此处设置为 RollingUpdate。另一个选项是 RecreaterollingUpdate:               #定义了 RollingUpdate 策略的参数maxSurge: 1                #定义了在进行滚动更新时，最大可以超出指定副本数的 Pod 数量maxUnavailable: 1          #定义了在进行滚动更新时，最大可以不可用的 Pod 数量template:                      #定义了要创建的 Pod 的规范信息，包括容器、端口和卷metadata:name: mytomcatlabels:app: mytomcatspec:containers:              #定义了 Pod 中的容器信息- name: mytomcat         #定义了容器的名称，此处设置为 mytomcatimage: tomcat:8        #定义了容器要使用的镜像，此处设置为 Tomcat 8ports:                 #定义了容器要监听的端口，此处设置为 8080 端口- containerPort: 8080volumeMounts:          #定义了容器要挂载的卷- name: zjf-configmountPath: /etc/localtimevolumes:                 #定义了卷的信息，包括名称和挂载路径- name: zjf-confighostPath:              #定义了要挂载的本地主机路径path: /usr/share/zoneinfo/Asia/Shanghai

kubectl apply -f tomcat-pod.yaml 

vim tomcat-service.yamlapiVersion: v1
kind: Service
metadata:name: mytomcat
spec:type: NodePortports:- port: 8080nodePort: 32222selector:app: mytomcat

kubectl apply -f tomcat-service.yaml 

#查看创建的pod及svc
kubectl get pod
kubectl get svc

#查看tomcat的分布node节点
kubectl get pods -o wide

#访问测试

总：

1.K8S集群中访问流向

port：为service在clusterIP上暴露的端口

targetport：对应容器映射在pod上的端口

nodeport：可以通过在K8S集群外部使用nodeIP+nodePort来去访问service

containerport：容器内部使用的端口

K8S集群内部：客户端——clusterIP：port——通过target port——podIP：containerport

K8S集群外部：客户端——nodeIP：nodeport——通过target port——podIP：containerport

2.语法格式

通过缩进表示层级关系

不能使用tab进行缩进，只能使用空格，一般开头缩进2个空格

字符后缩进一个空格，比如冒号，逗号等

使用—表示新的yaml文件的开始

使用#表示注释

3.yaml文件组成部署

（1）控制器定义

deployment：定义metadaea、spec、selector

通过yaml完成副本的定义，自主式的

（2）被控制对象

由哪一个控制器（自主式、deployment、statusfulset等）

4.常用字段的含义

如何快速编写yaml

（1）第一种使用kubectl create 命令生成yaml文件

（2）第二种使用kubectl get 命令导出yaml文件