目录
前言
Kubernetes 支持 YAML 和 JSON 格式管理资源对象
- JSON 格式:主要用于 api 接口之间消息的传递
- YAML 格式:用于配置和管理,YAML 是一种简洁的非标记性语言,内容格式人性化,较易读
一、YAML语法格式
- 大小写敏感
- 使用缩进表示层级关系
- 不支持Tab键制表符缩进,只使用空格缩进
- 缩进的空格数目不重要,只要相同层级的元素左侧对齐即可,通常开头缩进两个空格
- 符号字符后缩进一个空格,如冒号,逗号,短横杆(-)等
- “---”表示YAML格式,一个文件的开始,用于分隔文件间
- “#”表示注释
二、查看版本标签
kubectl api-versions
kubectl api-resources
如果是业务场景一般首选使用 apps/v1;带有beta字样的代表的是测试版本,不用在生产环境中
三、YAML文件详解
1.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磁盘
2.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
3.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 #外部负载均衡器的主机名
四、Port
在Kubernetes中,端口的概念非常重要。Pod中的应用程序可能需要暴露一些端口来让其他Pod或外部应用程序访问。在Kubernetes中,端口主要分为两种类型,节点端口和集群内部端口。
1.节点端口
节点端口(NodePort)允许外部流量通过节点直接访问Pod。使用这种方式后,外部流量将会通过节点的IP地址和指定的端口转发到相应的Pod。NodePort随机指定一个端口号,端口范围在30000-32767之间。可以通过指定NodePort的值来指定一个特定的节点端口。
2.集群内部端口
集群内部端口暴露应用程序服务给其他Pod使用。通过定义端口并把它们暴露给其他Pod,可以方便地实现服务发现和内部路由功能。在Kubernetes中,有三种类型的内部端口:容器端口(Container Port)、名称化端口(Named Port)和端点端口(Endpoint Port)。
- 容器端口(Container Port):应用程序在容器内部暴露的端口号。
- 名称化端口(Named Port):在为抽Service中定义的端口,作象概念使用,并将请求转发到一个或多个容器端口。
- 端点端口(Endpoint Port):通过Service提供的端口,它将转发到一个或多个Pod的容器端口和IP地址。
这些端口类型可用于不同的场景,可以根据需求来选择具体的端口类型。
在Kubernetes中定义端口时,通常需要指定两个属性:端口号和协议类型。端口号是一个整数,协议类型可以是TCP或UDP。例如,定义TCP协议的8080端口可以写成:8080/TCP。通过这两个属性定义,Kubernetes能够正确接受和转发请求,从而使应用程序正常工作。
五、编写YAML文件
1.写一个yaml文件demo
1.1编写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
#定义容器的对外的端口
1.2创建资源对象
kubectl create -f nginx-deployment.yaml
#查看创建的pod资源
kubectl get pods -o wide
1.3创建Service服务对外提供访问并测试
vim nginx-service.yaml
apiVersion: v1
kind: Service
metadata:
name: nginx-service
labels:
app: nginx
spec:
type: NodePort
ports:
- port: 80
targetPort: 80
selector:
app: nginx
#创建资源对象
kubectl create -f nginx-service.yaml
#查看创建的service
kubectl get svc
create和apply的区别:create创建的是一次性的,如果已经有了资源,那么会报错;如果使用apply创建的资源之后,那么再次使用apply就是读取yaml文件对已创建的资源进行更新。
2.编写一个Redis的YAML文件
2.1编写YAML文件
vim redis.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: redis-dpm
labels:
app: redis
spec:
replicas: 1
selector:
matchLabels:
app: redis
template:
metadata:
labels:
app: redis
spec:
containers:
- name: redis
image: redis:latest
ports:
- containerPort: 6379
---
apiVersion: v1
kind: Service
metadata:
name: redis-dbm
labels:
app: redis
spec:
selector:
app: redis
ports:
- nodePort: 32379
port: 6379
protocol: TCP
targetPort: 6379
type: NodePort
kubectl apply -f redis.yaml
kubectl get svc,pod
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
service/kubernetes ClusterIP 10.96.0.1 <none> 443/TCP 5d2h
service/myapp-cxk NodePort 10.105.62.216 <none> 8080:32000/TCP 17m
service/redis-dbm NodePort 10.109.123.43 <none> 6379:32379/TCP 99s
NAME READY STATUS RESTARTS AGE
pod/myapp-cxk-664ff4d675-bv7tp 1/1 Running 0 21m
pod/myapp-cxk-664ff4d675-kbbjw 1/1 Running 0 21m
pod/myapp-cxk-664ff4d675-tdjvz 1/1 Running 0 21m
pod/redis-dpm-756b4b8956-cc6d4 1/1 Running 0 99s
2.2测试连接
六、快速编写YAML文件
1.--dry-run——读取而不创建
kubectl run nginx-cs --image=soscscs/myapp:v1 --port=80 --dry-run=client
kubectl get pod
NAME READY STATUS RESTARTS AGE
myapp-cxk-664ff4d675-bv7tp 1/1 Running 0 44m
myapp-cxk-664ff4d675-kbbjw 1/1 Running 0 44m
myapp-cxk-664ff4d675-tdjvz 1/1 Running 0 44m
redis-dpm-756b4b8956-cc6d4 1/1 Running 0 24m
kubectl create deployment nginx-dpm --image=soscscs/myapp:v1 --port=80 --replicas=3 --dry-run=client
kubectl get pod
NAME READY STATUS RESTARTS AGE
myapp-cxk-664ff4d675-bv7tp 1/1 Running 0 46m
myapp-cxk-664ff4d675-kbbjw 1/1 Running 0 46m
myapp-cxk-664ff4d675-tdjvz 1/1 Running 0 46m
redis-dpm-756b4b8956-cc6d4 1/1 Running 0 26m
2.-o yaml——查看生成yaml格式
kubectl run nginx-cs --image=soscscs/myapp:v1 --port=80 --dry-run=client -o yaml
apiVersion: v1
kind: Pod
metadata:
creationTimestamp: null
labels:
run: nginx-cs
name: nginx-cs
spec:
containers:
- image: soscscs/myapp:v1
name: nginx-cs
ports:
- containerPort: 80
resources: {}
dnsPolicy: ClusterFirst
restartPolicy: Always
status: {}
kubectl create deployment nginx-dpm --image=nginx --port=80 --replicas=3 --dry-run=client -o yaml
apiVersion: apps/v1
kind: Deployment
metadata:
creationTimestamp: null
labels:
app: nginx-dpm
name: nginx-dpm
spec:
replicas: 3
selector:
matchLabels:
app: nginx-dpm
strategy: {}
template:
metadata:
creationTimestamp: null
labels:
app: nginx-dpm
spec:
containers:
- image: nginx
name: nginx
ports:
- containerPort: 80
resources: {}
status: {}
3.-o json——查看生成json格式
kubectl run nginx-test --image=nginx --port=80 --dry-run=client -o json
{
"kind": "Pod",
"apiVersion": "v1",
"metadata": {
"name": "nginx-test",
"creationTimestamp": null,
"labels": {
"run": "nginx-test"
}
},
"spec": {
"containers": [
{
"name": "nginx-test",
"image": "nginx",
"ports": [
{
"containerPort": 80
}
],
"resources": {}
}
],
"restartPolicy": "Always",
"dnsPolicy": "ClusterFirst"
},
"status": {}
}
kubectl create deployment nginx-deploy --image=nginx --port=80 --replicas=3 --dry-run=client -o json
4.导出一个yaml格式文件快速编写完成并访问
4.1使用YAML格式导出编写文件使其可以访问
kubectl run nginx-cs --image=soscscs/myapp:v1 --port=80 --dry-run=client -o yaml > nginx.yaml
vim nginx.yaml
apiVersion: v1
kind: Pod
metadata:
labels:
run: nginx-cs
name: nginx-cs
spec:
containers:
- image: soscscs/myapp:v1
name: nginx-cs
ports:
- containerPort: 80
restartPolicy: Always
kubectl apply -f nginx.yaml
pod/nginx-cs created
kubectl get pod -owide
NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES
myapp-cxk-664ff4d675-bv7tp 1/1 Running 0 63m 10.244.2.21 node1 <none> <none>
myapp-cxk-664ff4d675-kbbjw 1/1 Running 0 63m 10.244.1.35 node2 <none> <none>
myapp-cxk-664ff4d675-tdjvz 1/1 Running 0 63m 10.244.1.36 node2 <none> <none>
nginx-cs 1/1 Running 0 7s 10.244.2.23 node1 <none> <none>
redis-dpm-756b4b8956-cc6d4 1/1 Running 0 44m 10.244.2.22 node1 <none> <none>
curl 10.244.2.23
4.2将现有资源生成模版导出
kubectl get svc -o yaml > nginx-cs-svc.yaml
vim nginx-cs-svc.yaml
apiVersion: v1
kind: Service
metadata:
labels:
run: nginx-cs
name: nginx-cs-svc
namespace: default
spec:
ports:
- nodePort: 31000
port: 80
protocol: TCP
targetPort: 80
selector:
run: nginx-cs
type: NodePort
七、快速编写一个Nginx的YAML格式文件
kubectl create ns cxk --dry-run -o yaml
kubectl get svc nginx-cs-svc -o yaml
kubectl run my-nginx-cxk --image=nginx:1.14 --port=80 --dry-run -o yaml > pod-svc-ns.yaml
vim pod-svc-ns.yaml
八、总结
1.语法格式
- 通过缩进表示层级关系
- 不能使用Tab进行缩进,只能使用空格缩进(一般缩进两个空格)
- 字符后缩进一个空格,比如" : "、" , "等
- 使用" --- "表示新的yaml文件的开头
- 使用" # "表示注释
2.YAML文件组成部分
在Kubernetes中,控制器的定义是通过YAML文件完成的,该文件描述了资源的预期状态,这包括控制器的类型(如Deployment、StatefulSet、Service数量,使用的容器镜像,以及任何配置参数或环境变量)
3.常用字段含义
每一个控制器通常对应一种资源类型,如Deployment、Service等等,在YAML中,我们可以指定这些资源的状态以及如何管理它们
- Deployment控制器在YAML文件中的定义可能包括
- Metadata:例如控制器的名称和命名空间
- Spec:例如应用的副本数量,以及图像的URL
- Selector:例如确定哪些Pods应由该控制器管理的标签
- Template:例如Pod的基本设计
4.如何快速编写YAML文件
- 使用kubectl create命令直接生成yaml文件并导出
- 使用kubectl get命令在已有资源导出yaml文件
- 官网或者其他网站,下载yaml模板修改并导出
九、拓展——编写Mysql的YAML文件
vim mysql.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: mysql-deployment
spec:
replicas: 1
selector:
matchLabels:
app: mysql
template:
metadata:
labels:
app: mysql
spec:
containers:
- name: mysql
image: mysql:5.7
ports:
- containerPort: 3306
env:
- name: MYSQL_ROOT_PASSWORD
value: "123123"
volumeMounts:
- name: mysql-persistent-storage
mountPath: /var/lib/mysql
volumes:
- name: mysql-persistent-storage
persistentVolumeClaim:
claimName: mysql-pvc # 这里需要关联一个PersistentVolumeClaim
---
apiVersion: v1
kind: Service
metadata:
name: mysql-service
spec:
ports:
- port: 3306
selector:
app: mysql
type: NodePort
kubectl apply -f mysql.yaml