k8s yaml 文件详解 |
您所在的位置：网站首页 › yaml语法规则 › k8s yaml 文件详解 |
k8s yaml 文件详解
|
YAML基础
Kubernetes支持YAML和JSON格式管理资源对象 JSON格式：主要用于api接口之间消息的传递 YAML格式：用于配置和管理，YAML是一种简洁的非标记性语言，内容格式人性化，较易读 YAML文件优点YAML 文件易于人类阅读，具有表达性和可扩展性。 YAML 文件易于实现和使用。 可在编程语言之间轻松移植。 与敏捷语言的原生数据结构相匹配。 YAML 文件具有一致模型，支持通用工具。 YAML 文件支持 One-pass 处理。 使用方便，因此您无需再将所有的参数添加到命令行中。 易于维护 – 可以将 YAML 文件添加到源控件中以跟踪更改。 灵活便捷 – 可以使用 YAML 创建更加复杂的结构（相对于使用命令行可以创建的结构） YAML与 JSON 和 XML 的关系
YAML语法规则
大小写敏感
使用缩进表示层级关系
缩进时不允许使用Tal键，只允许使用空格
缩进的空格数目不重要，只要相同层级的元素左侧对齐即可，通常开头缩进两个空格
"#" 表示注释，从这个字符一直到行尾，都会被解析器忽略
"---"表示YAML格式，一个文件的开始，用于分隔文件
在Kubernetes中，只需要知道两种结构类型即可：
Lists
Maps
YAML Maps
Map顾名思义指的是字典，即一个Key:Value 的键值对信息。例如 apiVersion: v1 kind: Pod 注：---为可选的分隔符 ，当需要在一个文件中定义多个结构的时候需要使用。上述内容表示有两个键apiVersion和kind，分别对应的值为v1和Pod。Maps的value既能够对应字符串也能够对应一个Maps。例如 apiVersion: v1 kind: Pod metadata: name: kube100-site labels: app: web注：上述的YAML文件中，metadata这个KEY对应的值为一个Maps，而嵌套的labels这个KEY的值又是一个Map。实际使用中可视情况进行多层嵌套。 YAML处理器根据行缩进来知道内容之间的关联。上述例子中，使用两个空格作为缩进，但空格的数据量并不重要，只是至少要求一个空格并且所有缩进保持一致的空格数 。例如，name和labels是相同缩进级别，因此YAML处理器知道他们属于同一map；它知道app是lables的值因为app的缩进更大。 YAML ListsList即列表，说白了就是数组，例如 args: -henan -xianggang -aomen -taiwan可以指定任何数量的项在列表中，每个项的定义以破折号（-）开头，并且与父元素之间存在缩进。在JSON格式中，表示如下 { "args": ["henan", "xianggang", "aomen", "taiwan"] }当然Lists的子项也可以是Maps，Maps的子项也可以是List，例如 apiVersion: v1 kind: Pod metadata: name: kube100-site labels: app: web spec: containers: - name: front-end image: nginx ports: - containerPort: 80 - name: flaskapp-demo image: jcdemo/flaskapp ports: 8080如上述文件所示，定义一个containers的List对象，每个子项都由name、image、ports组成，每个ports都有一个KEY为containerPort的Map组成，转成JSON格式文件 { "apiVersion": "v1", "kind": "Pod", "metadata": { "name": "kube100-site", "labels": { "app": "web" }, }, "spec": { "containers": [{ "name": "front-end", "image": "nginx", "ports": [{ "containerPort": "80" }] }, { "name": "flaskapp-demo", "image": "jcdemo/flaskapp", "ports": [{ "containerPort": "5000" }] }] } } 使用YAML创建Pod定义配置时，指定最新稳定版API 配置文件应该存储在集群之外的版本控制仓库中。如果需要，可以快速回滚配置、重新创建和恢复 应该使用YAML格式编写配置文件，而不是json。YAML对用户更加友好 可以将相关对象组合成单个文件，通常会更容易管理 不要没必要指定默认值，简单和最小配置减小错误 在注释中说明一个对象描述更好维护 查看apiVersion # kubectl api-versions admissionregistration.k8s.io/v1 apiextensions.k8s.io/v1 apiregistration.k8s.io/v1 apps/v1 ##应用资源 authentication.k8s.io/v1 authorization.k8s.io/v1 autoscaling/v1 autoscaling/v2 autoscaling/v2beta1 ##弹性伸缩资源 autoscaling/v2beta2 batch/v1 batch/v1beta1 certificates.k8s.io/v1 coordination.k8s.io/v1 crd.projectcalico.org/v1 discovery.k8s.io/v1 discovery.k8s.io/v1beta1 events.k8s.io/v1 events.k8s.io/v1beta1 flowcontrol.apiserver.k8s.io/v1beta1 flowcontrol.apiserver.k8s.io/v1beta2 metrics.k8s.io/v1beta1 networking.k8s.io/v1 node.k8s.io/v1 node.k8s.io/v1beta1 policy/v1 policy/v1beta1 rbac.authorization.k8s.io/v1 ##权限控制资源 scheduling.k8s.io/v1 storage.k8s.io/v1 storage.k8s.io/v1beta1 v1 apiVersion：此处值是v1，这个版本号需要根据安装的Kubernetes版本和资源类型进行变化，记住不是写死的。 kind：此处创建的是Pod，根据实际情况，此处资源类型可以是Deployment、Job、Ingress、Service等。 metadata：包含Pod的一些meta信息，比如名称、namespace、标签等信息。 spec：包括一些container，storage，volume以及其他Kubernetes需要的参数，以及诸如是否在容器失败时重新启动容器的属性。可在特定Kubernetes API找到完整的Kubernetes Pod的属性。 典型的容器定义 spec: containers: - name: front-end image: nginx ports: - containerPort: 80上述例子只是一个简单的最小定义：一个名字（front-end）、基于nginx的镜像，以及容器将会监听的指定端口号（80）。 除了上述的基本属性外，还能够指定复杂的属性，包括容器启动运行的命令、使用的参数、工作目录以及每次实例化是否拉取新的副本。 还可以指定更深入的信息，例如容器的退出日志的位置。容器可选的设置属性包括： name、image、command、args、workingDir、ports、env、resource、volumeMounts、livenessProbe、readinessProbe、livecycle、terminationMessagePath、imagePullPolicy、securityContext、stdin、stdinOnce、tty 创建一个Pod # kubectl run nginx-test --image=nginx --port=80 pod/nginx-test created # kubectl get pod nginx-test -oyaml apiVersion: v1 # 必选，版本号，例如v1指定api版本，此值必须在kubectl apiversion中 kind: Pod # 指定创建资源的角色/类型 metadata: # 资源的元数据/属性 name: string # 必选，Pod名称 namespace: string # 必选，Pod所属的命名空间 labels: # 定义资源的标签 - name: string # 自定义标签名字 annotations: # 自定义注释列表 - name: string spec: # specification of the resource content 指定该资源的内容 Pod中容器的详细定义 containers: # 必选，Pod中容器列表 - name: string # 必选，容器名称 image: string # 必选，容器的镜像名称 imagePullPolicy: [Always | Never | IfNotPresent] # 获取镜像的策略 Alawys表示下载镜像；IfnotPresent表示优先使用本地镜像，否则下载镜像；Nerver表示仅使用本地镜像 command: [string] # 容器的启动命令列表，将覆盖容器中的Entrypoint,对应Dockefile中的ENTRYPOINT，如不指定，使用打包时使用的启动命令 args: [string] # 容器的启动命令参数列表 workingDir: string # 容器的工作目录 volumeMounts: # 挂载到容器内部的存储卷配置 - name: string # 引用pod定义的共享存储卷的名称，与volumes[*].name 需要对应 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 # 内存清楚，容器启动的初始可用数量 # 设置pod内容器健康检测，详细见 https://www.cnblogs.com/chuyiwang/p/16467242.html 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 enableServiceLinks: true # 表示是否将 Service 的相关信息注入到 Pod 的环境变量中，默认是 true。 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 dnsPolicy: ClusterFirst # DNS 策略可以逐个 Pod 来设定。目前 Kubernetes 支持以下特定 Pod 的 DNS 策略。 # "Default": Pod 从运行所在的节点继承名称解析配置。"Default" 不是默认的 DNS 策略。如果未明确指定 dnsPolicy，则使用 "ClusterFirst"。 # "ClusterFirst": 与配置的集群域后缀不匹配的任何 DNS 查询（例如 "www.kubernetes.io"） 都会由 DNS 服务器转发到上游名称服务器。集群管理员可能配置了额外的存根域和上游 DNS 服务器。 # hostNetwork: true # "ClusterFirstWithHostNet": 对于以 hostNetwork 方式运行的 Pod，应将其 DNS 策略显式设置为 "ClusterFirstWithHostNet"。否则，以 hostNetwork 方式和 "ClusterFirst" 策略运行的 Pod 将会做出回退至 "Default" 策略的行为。注意：这在 Windows 上不支持。 # "None": 此设置允许 Pod 忽略 Kubernetes 环境中的 DNS 设置。Pod 会使用其 dnsConfig 字段所提供的 DNS 设置。 hostNetwork:false #是否使用主机网络模式，默认为false，如果设置为true，表示使用宿主机网络 terminationGracePeriodSeconds: 30 # 定义pod的等待宽限期 详细可参考：https://www.cnblogs.com/chuyiwang/p/16467963.html 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 tolerations: # K8s中污点(Taint)和容忍度配置 - effect: NoExecute key: node.kubernetes.io/not-ready operator: Exists tolerationSeconds: 300 - effect: NoExecute key: node.kubernetes.io/unreachable operator: Exists tolerationSeconds: 300 |
【本文地址】
今日新闻 |
推荐新闻 |