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

YAML 语法规范

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

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

通过yaml创建nginx pod对象

yaml文件

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

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

Pod常见操作

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

volume查看

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

站点信息

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

日志信息

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

nginx站点访问

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

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

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

 [root@k8s-node02 nginx]# cat /data/volumes/nginx/log/access.log
10.244.0.0 - - [/May/::: +] "GET / HTTP/1.1" "-" "curl/7.29.0" "-"
10.244.0.0 - - [/May/::: +] "GET / HTTP/1.1" "-" "curl/7.29.0" "-"
172.16.1.110 - - [/May/::: +] "GET / HTTP/1.1" "-" "curl/7.29.0" "-"
172.16.1.110 - - [/May/::: +] "GET / HTTP/1.1" "-" "curl/7.29.0" "-"

K8S Pod Yaml文件参数详细说明

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

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

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

volumes示例如下:

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

相关阅读

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

完毕!


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

Kubernetes K8S之通过yaml文件创建Pod与Pod常用字段详解的更多相关文章

  1. Kubernetes YAML 文件全字段详解

    Kubernetes YAML 文件全字段详解 Deployment yaml 其中主要参数都在podTemplate 中,DaemonSet StatefulSet 中的pod部分一样. apiVe ...

  2. Kubernetes,kubectl常用命令详解

    kubectl概述 祭出一张图,转载至 kubernetes-handbook/kubectl命令概述 ,可以对命令族有个整体的概念. 环境准备 允许master节点部署pod,使用命令如下: kub ...

  3. Kubernetes K8S之存储ConfigMap详解

    K8S之存储ConfigMap概述与说明,并详解常用ConfigMap示例 主机配置规划 服务器名称(hostname) 系统版本 配置 内网IP 外网IP(模拟) k8s-master CentOS ...

  4. Kubernetes K8S之资源控制器Daemonset详解

    Kubernetes的资源控制器Daemonset详解与示例 主机配置规划 服务器名称(hostname) 系统版本 配置 内网IP 外网IP(模拟) k8s-master CentOS7.7 2C/ ...

  5. Kubernetes K8S之存储Secret详解

    K8S之存储Secret概述与类型说明,并详解常用Secret示例 主机配置规划 服务器名称(hostname) 系统版本 配置 内网IP 外网IP(模拟) k8s-master CentOS7.7 ...

  6. Kubernetes K8S之affinity亲和性与反亲和性详解与示例

    Kubernetes K8S之Node节点亲和性与反亲和性以及Pod亲和性与反亲和性详解与示例 主机配置规划 服务器名称(hostname) 系统版本 配置 内网IP 外网IP(模拟) k8s-mas ...

  7. kubernetes/k8s CRI分析-kubelet创建pod分析

    先来简单回顾上一篇博客<kubernetes/k8s CRI 分析-容器运行时接口分析>的内容. 上篇博文先对 CRI 做了介绍,然后对 kubelet CRI 相关源码包括 kubele ...

  8. kubernetes/k8s CRI分析-kubelet删除pod分析

    关联博客<kubernetes/k8s CRI 分析-容器运行时接口分析> <kubernetes/k8s CRI分析-kubelet创建pod分析> 之前的博文先对 CRI ...

  9. kubernetes (k8s) CKA认证之第二课:亲和性与 Pod 的调度

    手动调度一个 pod // cat manual-schedule.yaml apiVersion: v1 kind: Pod metadata: labels: run: pod-manual-sc ...

随机推荐

  1. NOI题库分治算法刷题记录

    今天晚自习机房刷题,有一道题最终WA掉两组,极其不爽,晚上回家补完作业欣然搞定它,特意来写篇博文来记录下 (最想吐槽的是这个叫做分治的分类,里面的题目真的需要分治吗...) 先来说下分治法 分治法的设 ...

  2. jquery初涉,First Blood

    jquery可以帮助干的事情有: 遍历HTML文档 操作DOM 处理事件 执行动画 开发Ajax操作 优点就不在这儿扯蛋了~ 1.jquery环境配置 jquery不需要安装,只需要将下载的jquer ...

  3. 简单实用的纯CSS百分比圆形进度条插件

    percircle是一款简单实用的纯CSS百分比圆形进度条插件.你不需要做任何设置,只需要按该圆形进度条插件提供的标准HTML结构来编写代码,就可以生成一个漂亮的百分比圆形进度条. 首先要做的就是引入 ...

  4. Linux安装Oracle报Checking operating system version must be redhat-3, SuSE-9, redhat-4

    解决办法:vi /xx/database/install/oraparam.ini 找到[Certified Versions] Linux=redhat-3,SuSe-9,redhat-4,后面加上 ...

  5. 整理SVN代码--&gt;正式环境的代码

    最近我被分配到了合并正式补丁代码的工作.聊聊整个流程 第一步解压补丁

  6. 用C# (.NET Core) 实现迭代器设计模式

    本文的概念来自深入浅出设计模式一书 项目需求 有两个饭店合并了, 它们各自有自己的菜单. 饭店合并之后要保留这两份菜单. 这两个菜单是这样的: 菜单项MenuItem的代码是这样的: 最初我们是这样设 ...

  7. CSIS 1119B/C Introduction to Data Structures and Algorithms

    CSIS 1119B/C Introduction to Data Structures and Algorithms Programming Assignment TwoDue Date: 18 A ...

  8. Spark大型电商项目实战-及其改良(2) RDD优化效果不稳定的真正原因

    首先看没有map join的第2任务: 时间线如下 接着是对应id的算子计算时间表 Stage Id Description Submitted Duration Tasks: Succeeded/T ...

  9. WebService接口定义及调用

    Web service是一个平台独立的,松耦合的,自包含的.基于可编程的web的应用程序,可使用开放的XML标准来描述.发布.发现.协调和配置这些应用程序,用于开发分布式的互操作的应用程序. WebS ...

  10. Java 基础:变量 与 字符串

    变量 Java中没有初始化的变量是不能直接使用的 局部变量 String msg; System.out.print(msg); 就会提示错误,我们必须显式的为变量指定一个初值如null.刚开始学Ja ...