声明式
- 一、声明式资源管理方式
- 1.1 简介
- 1.2 基本语法
- 1.3 子命令详解
- 1.3.1 获取资源配置清单
- 1.3.2 创建/更新资源
- 补充：creat和apply的区别
- 1.3.3 删除资源----- delete
- 1.3.4 编辑资源配置 -----edit
- 1.3.5 获取资源的解释-----explain
- 二、资源清单格式详解
- 2.1 yaml语法格式
- 2.2 Pod yaml文件详解
- 2.2.1 编写方式
- 2.2.2 举个例子
- 2.3 Deployment yaml文件详解
- 2.3.1 编写方式
- 2.3.2 举个例子
- 2.4 Service yaml文件详解
- 三、创建配置清单文件的方法
- 3.1 方法一：逐级编写资源配置清单
- 3.2 方法二：预运行资源创建命令
- 3.3 方法三：通过已有资源创建
- 3.4 方法四：根据官方文档
- 补充：externalTraffiicPolicy 字段（面试常问）
- 1）值为Cluster
- 2）值为Local
- 小结
一、声明式资源管理方式
可理解成使用yaml配置文件的定义来实现资源的管理操作
1.1 简介
声明式资源管理方法依赖于资源配置清单文件对资源进行管理，适合于对资源的修改操作。
对资源的管理，是通过事先定义在统一资源配置清单内，再通过陈述式命令应用到k8s集群里。
Kubernetes 支持 YAML 和 JSON 格式管理资源对象
JSON 格式：主要用于 api 接口之间消息的传递。
YAML 格式：用于配置和管理，YAML 是一种简洁的非标记性语言，内容格式人性化，较易读。
1.2 基本语法
kubectl <command> -f xxxx.yaml
| 常用子命令 | 功能描述 |
|---|---|
create | 创建资源 |
apply | 创建/更新资源 |
explain | 查看 Kubernetes 资源及其字段的详细信息和说明，包括其文档和字段类型 |
delete | 删除 |
edit | 在线编辑 |
replace | 替换 |
1.3 子命令详解
1.3.1 获取资源配置清单
kubectl get [-n <命名空间>] <资源类型> <资源名称> -o yaml > XXX.yaml #获取资源配置清单
#举个例子
kubectl get pods -n kube-system coredns-54d67798b7-27d2s -o yaml > /opt/test1.yaml
1.3.2 创建/更新资源
kubectl create|apply -f XXX.yaml
举个例子
vim /opt/nt1.yaml
kubectl apply -f /opt/yaml/nt1.yaml
kubectl get pods -n my-ns -o wide
补充：creat和apply的区别
共同点
kubectl create -f 和 kubectl apply -f 都是使用 Kubernetes 集群中的 YAML 配置文件来创建和管理 Kubernetes 资源对象。
区别
kubectl create -f 用于创建 Kubernetes 对象。
如果对应的资源已经存在，则会返回错误，此时需要先删除原有的资源对象，然后再执行创建操作。
如果资源对象不存在，则会自动创建对应的资源对象。
kubectl apply -f 用于创建或更新一个 Kubernetes 对象。
如果该资源对象已经存在，则会首先尝试更新对应的字段值和配置。
如果不存在则会自动创建资源对象。
同时 kubectl apply 还提供了许多可选的参数，例如 --force、–validate、–record 等，可以使更新操作更加精确和可控。
总结
kubectl create -f 适用于初始化资源对象的场景；
kubectl apply -f 则更加适合更新和修改已有的资源对象，
推荐使用 kubectl apply -f 命令来创建和更新资源对象，因为该命令可以在需要时高效地对资源进行更新，并且具有回滚功能，更加适合 Kubernetes 中动态扩展和更新资源对象的场景。
1.3.3 删除资源----- delete
kubectl delete -f XXX.yaml #删除资源
1.3.4 编辑资源配置 -----edit
1.在线修改
只能修改支持在线修改的字段，比如端口号…。
kubectl edit [-n <命名空间>] <资源类型> <资源名称>
#在线修改/编辑资源配置
#如果要修改Pod，不能处于running状态
#举个例子
kubectl edit -n my-ns service service-test1
2.离线修改
对于不支持在线修改的字段，比如IP地址，只能通过离线修改的方式更新资源。
#使用vim编辑器修改配置文件
#再删除原有配置
#最后重新应用
kubectl delete -f XXX.yaml && kubectl apply -f XXX.yaml
#举个例子
vim
kubectl delete -f /opt/yaml/st1.yaml && kubectl apply -f /opt/yaml/st1.yaml
1.3.5 获取资源的解释-----explain
kubectl explain <资源类型>.<一级字段>.<二级字段>.... #获取资源的解释
二、资源清单格式详解
2.1 yaml语法格式
1）大小写敏感，即区分大小写；
2）使用缩进表示层级关系；
3）不支持Tab键制表符缩进，只能使用空格缩进；
4）缩进的空格数目不重要，只要相同层级的元素左侧对齐即可，通常开头缩进两个空格；
5）符号字符后缩进一个空格，如冒号，逗号，短横杆（-）等；
6）“—”表示YAML格式，一个文件的开始，用于分隔文件间；
7）“#”表示注释。
2.2 Pod yaml文件详解
2.2.1 编写方式
以Pod的一级字段和二级字段为例。
kubectl explain service
kubectl explain service.metada
2.2.2 举个例子
#扩展模板
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
2.3 Deployment yaml文件详解
以Deployment的一级字段和二级字段为例。
2.3.1 编写方式
kubectl explain deploy
kubectl explain deploy.metadata
kubectl explain deploy.spec
2.3.2 举个例子
#扩展模板
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.4 Service yaml文件详解
一些常用的字段，可以根据explain命令查看每一级字段的子内容。
kubectl explain service
kubectl explain service.metadata
kubectl explain service.spec
kubectl explain service.spec.
#扩展模板
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 #外部负载均衡器的主机名
三、创建配置清单文件的方法
3.1 方法一：逐级编写资源配置清单
根据kubectl explain命令获取字段信息，然后逐级手动输入。
kubectl explain <资源类型>[.<一级字段>.<二级字段>]
3.2 方法二：预运行资源创建命令
快速获取,根据kubectl create|run|expose... --dry-run=client-o yaml > xxx.yaml 命令，模拟生成配置文件，将已有的配置文件作为模板进行修改。
#举个例子
kubectl create service clusterip --tcp=80:80 nginx-test2 --dry-run=client -o yaml > /opt/yaml/st2.yaml
3.3 方法三：通过已有资源创建
1）根据kubectl get [-n <命名空间>] <资源类型> <资源名称> -o yaml > xxx.yaml命令，根据已有的资源创建；
2）根据kubectl edit [-n <命名空间>] <资源类型> <资源名称>命令，获取配置清单，手动复制。
3.4 方法四：根据官方文档
复制K8S官方文档的资源配置案例，这里以service的创建为例。
官方文档：服务（Service） | Kubernetes
补充：externalTraffiicPolicy 字段（面试常问）
外部流量策略，值为Cluster或者Local。
1）值为Cluster
流量可以转发到其他节点上的Pod。
这个是默认模式，Kube-proxy不管容器实例在哪，公平转发。
Kube-proxy转发时会替换掉报文的源IP，即：容器收的报文，源IP地址，已经被替换为上一个转发节点的了。
2）值为Local
流量只发给本机的Pod。
Kube-proxy转发时会保留源IP，即：容器收到的报文，看到源IP地址还是用户的。
注：这种模式下的Service类型只能为外部流量，即：LoadBalancer 或者 NodePort 两种，否则会报错。
小结
1.声明式资源管理方式的相关命令
kubectl get [-n <命名空间>] <资源类型> <资源名称> -o yaml > XXX.yaml #获取资源配置清单
kubectl create|apply -f XXX.yaml #创建/更新资源
kubectl delete -f XXX.yaml #删除资源
kubectl edit [-n <命名空间>] <资源类型> <资源名称> #在线修改/编辑资源配置
对于不支持在线修改的字段只能通过离线修改的方式更新资源：kubectl delete -f XXX.yaml && kubectl apply -f XXX.yaml
kubectl explain <资源类型>.<一级字段>.<二级字段>.... #获取资源的解释
2.创建yaml配置清单文件的方法
方法一： 手动输入，根据kubectl explain命令获取字段信息，然后逐级手动输入
方法二： 根据kubectl create|run|expose... --dry-run=cilent-o yaml > xxx.yaml 命令，模拟生成配置文件，将已有的配置文件作为模板进行修改
快速获取，面试常问，通过预运行资源创建命令，将配置文件作为模板
方法三： 如果集群中已经有创建好的资源
1）根据kubectl get [-n <命名空间>] <资源类型> <资源名称> -o yaml > xxx.yaml命令，根据已有的资源创建；
2）根据kubectl edit [-n <命名空间>] <资源类型> <资源名称>命令，获取配置清单，手动复制。
方法四：复制Kurbernetes官方文档的资源配置案例，然后进行相关的修改。
