入门Kubernetes - YAML文件 - Powered by Discuz! Archiver

叶辰飞 發表於 2021-6-27 17:10:00

入门Kubernetes - YAML文件

<h3>前言</h3>
　前篇文章中简单了解到如何把.Net Core 程序部署到k8s中，过程中使用了多个*.yaml文件，那么这些文件的格式及含义、语法是如何的呢？
　接下来，进一步了解学习
<h3>一、YAML介绍:</h3>
　1、简介：
　　YAML 语言（发音 /ˈjæməl/ ）的设计目标，就是方便人类读写。它实质上是一种通用的数据串行化格式。YAML又被称为是 json 的超集，使用起来比 json 更方便
　2、语法：
<ul>
<li>大小写敏感</li>
<li>使用缩进表示层级关系</li>
<li>缩进时不允许使用Tab键，只允许使用空格。</li>
<li>缩进的空格数目不重要，只要相同层级的元素左侧对齐即可</li>
<li>#表示注释，从该字符到行尾</li>
</ul>
　3、支持的数据结构　　
<ul>
<li>对象：键值对的集合，又称为映射（mapping）/ 哈希（hashes） / 字典（dictionary）</li>
<li>数组：一组按次序排列的值，又称为序列（sequence） / 列表（list）</li>
<li>纯量（scalars）：单个的、不可再分的值，场景类型如下：
<ul>
<li>字符串</li>
<li>布尔值</li>
<li>整数</li>
<li>浮点数</li>
<li>Null</li>
<li>时间</li>
<li>日期</li>
</ul>
</li>
</ul>
　　对象：一组键值对，使用冒号结构表示，如下
<div class="cnblogs_code" style="margin-left: 30px">
<pre>#yaml格式：
api: v1

#对应json格式：
{api:'v1'}

#yaml格式:行内对象
obj: { name: Steve, foo: bar }

#Json格式：
{ obj: { name: 'Steve', foo: 'bar' } }</pre>
</div>
　　数组：一组连词线开头的行，构成一个数组，且支持多维数组
<div class="cnblogs_code" style="margin-left: 30px">
<pre>#yaml格式：
- Cat
- Dog

#json格式：
['Cat','Dog']

#yaml格式：多维数组
-
-Cat
-Dog

#json格式：多维数组
[['Cat','Dog']]</pre>
</div>
　　纯量：最基本的、不可再分的值　　
<div class="cnblogs_code" style="margin-left: 30px">
<pre>#字符串类型
str: 字符串
#字符串之中包含空格或特殊字符，需要放在引号之中。
#单引号和双引号都可以使用，双引号不会对特殊字符转义
#多行字符串可以使用|保留换行符，也可以使用>折叠换行
#+表示保留文字块末尾的换行，-表示删除字符串末尾的换行

#数字类型：
number: 10.01

#布尔类型：
isRun: true

#空类型：
name: ~

#时间类型：时间采用 ISO8601 格式
iso8601: 2021-06-27t15:00:00.00-05:00

#日期类型：采用复合 iso8601 格式的年、月、日表示
date: 2021-06-27

#使用两个感叹号，强制转换数据类型。
strnum: !!str 123
strbol: !!str true</pre>
</div>
　3、引用用法：
　　锚点<code>&</code>和别名<code>*</code>，可以用来引用。
　　<code>&</code>用来建立锚点，<code><<</code>表示合并到当前数据，<code>*</code>用来引用锚点　　
<div class="cnblogs_code" style="margin-left: 30px">
<pre>#yaml引用示例：
defaults: &defaults
adapter:postgres
host: localhost

development:
database: myapp_development
<<: *defaults

test:
database: myapp_test
<<: *defaults

#等效于：
defaults:
adapter:postgres
host: localhost

development:
database: myapp_development
adapter:postgres
host: localhost

test:
database: myapp_test
adapter:postgres
host: localhost</pre>
</div>
 　以上是yaml的基础语法，接下来看下在k8s中怎么使用呢？
<h3>二、YAML在k8s中的使用</h3>
　k8s有两种创建资源的方式：kubectl 命令和 yaml 配置文件。 　　kubectl命令行：最为简单，一条命令就OK. 　　yaml配置文件：提供了一种让你知其然更知其所以然的方式。 　优势如下：
完整性：配置文件描述了一个资源的完整状态，可以很清楚地知道一个资源的创建背后究竟做了哪些事； 灵活性：配置文件可以创建比命令行更复杂的结构； 可维护性：配置文件提供了创建资源对象的模板，能够重复使用； 可扩展性：适合跨环境、规模化的部署。
　k8s(Kubernetes)中Pod、Deployment、ReplicaSet、Service之间关系如下：
　Pod：来管理容器，每个 Pod 可以包含一个或多个紧密关联的容器
　ReplicaSet：是rc的升级版，也是来管理pod，Kubernetes官方强烈建议避免直接使用ReplicaSet，而应该通过Deployment来创建RS和Pod。由于ReplicaSet是ReplicationController的代替物，因此用法基本相同，唯一的区别在于ReplicaSet支持集合式的selector。
　Deployment：更加方便的管理Pod和Replica Set，提供发布更新维护监控等功能
　Service：是在这一整套基础之上提供给外部的稳定的服务
　1、Deployment配置模板
<div class="cnblogs_code" style="margin-left: 30px">
<pre>apiVersion: extensions/v1beta1
kind: Deployment
metadata: <Object>
spec: <Object>
minReadySeconds: <integer> #设置pod准备就绪的最小秒数
paused: <boolean> #表示部署已暂停并且deploy控制器不会处理该部署
progressDeadlineSeconds: <integer>
strategy: <Object> #将现有pod替换为新pod的部署策略
rollingUpdate: <Object> #滚动更新配置参数，仅当类型为RollingUpdate
 maxSurge: <string> #滚动更新过程产生的最大pod数量，可以是个数，也可以是百分比
 maxUnavailable: <string> #
 type: <string> #部署类型，Recreate，RollingUpdate
replicas: <integer> #pods的副本数量
selector: <Object> #pod标签选择器，匹配pod标签，默认使用pods的标签
matchLabels: <mapstring>
 key1: value1
 key2: value2
matchExpressions: <[]Object>
 operator: <string> -required- #设定标签键与一组值的关系，In, NotIn, Exists and DoesNotExist
 key: <string> -required-
 values: <[]string>
revisionHistoryLimit: <integer> #设置保留的历史版本个数，默认是10
rollbackTo: <Object>
revision: <integer> #设置回滚的版本，设置为0则回滚到上一个版本
template: <Object> -required-
metadata:
spec:
 containers: <[]Object> #容器配置
 - name: <string> -required- #容器名、DNS_LABEL
 image: <string> #镜像
 imagePullPolicy: <string> #镜像拉取策略，Always、Never、IfNotPresent
 ports: <[]Object>
 - name: #定义端口名
 containerPort: #容器暴露的端口
 protocol: TCP #或UDP
 volumeMounts: <[]Object>
 - name: <string> -required- #设置卷名称
 mountPath: <string> -required- #设置需要挂载容器内的路径
 readOnly: <boolean> #设置是否只读
 livenessProbe: <Object> #就绪探测
 exec:
 command: <[]string>
 httpGet:
 port: <string> -required-
 path: <string>
 host: <string>
 httpHeaders: <[]Object>
 name: <string> -required-
 value: <string> -required-
 scheme: <string>
 initialDelaySeconds: <integer> #设置多少秒后开始探测
 failureThreshold: <integer> #设置连续探测多少次失败后，标记为失败，默认三次
 successThreshold: <integer> #设置失败后探测的最小连续成功次数，默认为1
 timeoutSeconds: <integer> #设置探测超时的秒数，默认1s
 periodSeconds: <integer> #设置执行探测的频率（以秒为单位），默认1s
 tcpSocket: <Object> #TCPSocket指定涉及TCP端口的操作
 port: <string> -required- #容器暴露的端口
 host: <string> #默认pod的IP
 readinessProbe: <Object> #同livenessProbe
 resources: <Object> #资源配置
 requests: <mapstring> #最小资源配置
 memory: "1024Mi"
 cpu: "500m" #500m代表0.5CPU
 limits: <mapstring> #最大资源配置
 memory:
 cpu:
 volumes: <[]Object> #数据卷配置
 - name: <string> -required- #设置卷名称,与volumeMounts名称对应
 hostPath: <Object> #设置挂载宿主机路径
 path: <string> -required-
 type: <string> #类型：DirectoryOrCreate、Directory、FileOrCreate、File、Socket、CharDevice、BlockDevice
 - name: nfs
 nfs: <Object> #设置NFS服务器
 server: <string> -required- #设置NFS服务器地址
 path: <string> -required- #设置NFS服务器路径
 readOnly: <boolean> #设置是否只读
 - name: configmap
 configMap:
 name: <string> #configmap名称
 defaultMode: <integer> #权限设置0~0777，默认0664
 optional: <boolean> #指定是否必须定义configmap或其keys
 items: <[]Object>
 - key: <string> -required-
 path: <string> -required-
 mode: <integer>
 restartPolicy: <string> #重启策略，Always、OnFailure、Never
 nodeName: <string>
 nodeSelector: <mapstring>
 imagePullSecrets: <[]Object>
 hostname: <string>
 hostPID: <boolean>
status: <Object></pre>
</div>
<pre>　nginx实例：</pre>
<div class="cnblogs_code" style="margin-left: 30px">
<pre>apiVersion: app/v1 　　 # 1.9.0 之前的版本使用 apps/v1beta2，可通过命令 kubectl api-versions 查看
kind: Deployment 　　#指定创建资源的角色/类型
metadata: 　　#资源的元数据/属性
name: nginx-deployment #资源的名字，在同一个namespace中必须唯一
namespace:xxxx #命名空间
labels:
app: demo #标签
spec:
replicas: 3 　　　　　#副本数量3
strategy:
rollingUpdate: 　　　　　 ##由于replicas为3,则整个升级,pod个数在2-4个之间
 maxSurge: 1 　　　　 #滚动升级时会先启动1个pod
 maxUnavailable: 1 　　　　#滚动升级时允许的最大Unavailable的pod个数
selector: 　　　　#定义标签选择器,部署需要管理的pod（带有该标签的的会被管理）需在pod 模板中定义
 matchLabels:
 app: web-server
template: 　　　　　　　　#这里Pod的定义
 metadata:
 labels: 　　　　　　　　#Pod的label
 app: web-server
spec: 　　　　　　　　# 模板的规范
 containers:
 - name: nginx 　　　#容器的名字
 image: nginx:1.12.1 #容器的镜像地址 
 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
 # IfNotPresent ：默认值,本地有则使用本地镜像,不拉取，如果不存在则拉取
 # Always：总是拉取
 # Never：只使用本地镜像，从不拉取
 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:
 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磁盘</pre>
</div>
　2、SERVICE 配置模板
<div class="cnblogs_code" style="margin-left: 30px">
<pre>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 #外部负载均衡器的主机名</pre>
</div>
Service节点说明：
　　<img src="https://img2020.cnblogs.com/blog/374428/202106/374428-20210627160308947-947135813.png">
　3、Pod配置模板：
<div class="cnblogs_code" style="margin-left: 30px">
<pre>apiVersion: v1 　　 #必选，版本号，例如v1,版本号必须可以用 kubectl api-versions 查询到 .
kind: Pod 　　　　　　 #必选，Pod
metadata: 　　　　　　 #必选，元数据
name: string 　　 #必选，Pod名称
namespace: string 　　 #必选，Pod所属的命名空间,默认为"default"
labels: 　　　　　　 #自定义标签
- name: string 　 #自定义标签名字
annotations: 　　 #自定义注释列表
- name: string
spec: 　　　　　　　 #必选，Pod中容器的详细定义
containers: 　　　　 #必选，Pod中容器列表
- name: string 　　 #必选，容器名称,需符合RFC 1035规范
image: string 　　 #必选，容器的镜像名称
imagePullPolicy: [ Always|Never|IfNotPresent ]#获取镜像的策略 Alawys表示下载镜像 IfnotPresent表示优先使用本地镜像,否则下载镜像，Nerver表示仅使用本地镜像
command: 　　 　　#容器的启动命令列表，如不指定，使用打包时使用的启动命令
args: 　　 #容器的启动命令参数列表
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: #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: #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
 path: string
 nfs: #类型为NFS的存储卷
 server: 192.168.66.50 #nfs服务器ip或是域名 
 path: "/test" #nfs服务器共享的目录
 persistentVolumeClaim: #类型为persistentVolumeClaim的存储卷
 claimName: test-pvc #名字一定要正确，使用的是kind为PersistentVolumeClaim中的name</pre>
</div>
<h4>　4、快速生成YAML文件</h4>
　　a) 命令：
<div class="cnblogs_code" style="margin-left: 30px">
<pre>kubectl run --image=nginx my-deploy -o yaml --dry-run >my-deploy.yaml
kubectl create -f deploy-nginx.yaml -o yaml --dry-run >my-deploy.yaml
kubectl create -f deploy-nginx.yaml -o json --dry-run >my-deploy.json# 指定输出json格式

– image # 指定模板镜像
my-deploy # 运行标签名称
–dry-run # 只测试运行,不会实际运行pod
-o yaml # 指定输出格式</pre>
</div>
　2、查询Pod容器的字段资源内部文档
<div class="cnblogs_code" style="margin-left: 30px">
<pre>kubectl explain pods# 每一个层级的指令都会有字段信息
kubectl explain pods.spec
kubectl explain pods.spec.containers</pre>
</div>
<h4>总结</h4>
　本篇对yaml文件语法了解，以及对k8s中常用创建Deployment、Service、Pod的yaml文件中各个节点的含义用法了解。接下来对k8s中各种资源进一步了解、学习。并实际操作应用。　　 
来源：https://www.cnblogs.com/cwsheng/p/14940571.html

頁: [1]

琼殿技术论坛's Archiver

入门Kubernetes - YAML文件