本文记录Kubernetes 对象在 Kubernetes API的表现形式,以及如何在 .yaml 格式的文件中表示。
Kubernetes对象
在 Kubernetes 系统中,Kubernetes 对象 是持久化的实体,Kubernetes 使用这些实体去表示整个集群的状态,如哪些容器化应用在运行(以及在哪些节点上),可以被应用使用的资源,关于应用运行时表现的策略,比如重启策略、升级策略,以及容错策略等。
当操作 Kubernetes 对象如创建、修改,或者删除 ,就需要使用 Kubernetes API。 比如,当使用 kubectl 命令行接口时,CLI 会执行必要的 Kubernetes API 调用。
几乎每个 Kubernetes 对象包含: 对象 spec(规约) 和 对象 status(状态),它们负责管理对象的配置。在创建对象时设置其内容,描述你希望对象所具有的特征,如在创建Deployment时指定该应用需要有 3 个副本运行,Kubernetes 系统读取 Deployment 规约,并启动我们所期望的应用的 3 个实例,并更新状态以与规约相匹配。对象的状态则如Initial,running,pending等状态。
使用yaml文件描述 Kubernetes 对象
当使用 Kubernetes API 创建对象时(或者直接创建,或者基于kubectl), API 请求必须在请求体中包含 JSON 格式的信息。 大多数情况下,需要在 .yaml 文件中为 kubectl 提供这些信息。 kubectl 在发起 API 请求时,将这些信息转换成 JSON 格式。
.yaml 示例文件,展示了 Kubernetes Deployment 的必需字段和对象规约:
使用类似于上面的 .yaml 文件来创建 Deployment的一种方式是使用 kubectl 命令行接口(CLI)中的 kubectl apply 命令, 将 .yaml 文件作为参数。
kubectl apply -f https://k8s.io/examples/application/deployment.yaml --record
返回:deployment.apps/nginx-deployment created
.yaml 文件必需字段:
1. apiVersion - 创建该对象所使用的 Kubernetes API 的版本
2. kind - 想要创建的对象的类别,如deployment,secret,server等
3. metadata - 帮助唯一性标识对象的一些数据,包括一个 name 字符串、UID 和可选的 namespace
kubectl 命令行工具能够支持三种对象管理方式: 指令式命令、指令式对象配置 、声明式对象配置。实际使用中有时候会混合搭配使用。
1. 命令式命令
kubectl 命令行工具中的指令式命令可以直接快速创建、更新和删除 Kubernetes 对象。
创建对象:
run:创建一个新的 Pod 来运行一个容器
expose:创建一个新的 Service 对象为若干 Pod 提供流量负载均衡
autoscale:创建一个新的 Autoscaler 对象来自动对某控制器(如 Deployment) 执行水平扩缩
kubectl 命令也支持根据对象类型来创建。这种方法可以支持更多的对象类别,也更灵活,不过要求了解所要创建的对象的类别。
create <对象类别> [<子类别>] <实例名称>
如果某些对象类别拥有自己的子类别,可以在 create 命令中设置。 例如,Service 对象有 ClusterIP、LoadBalancer 和 NodePort 三种子类别。 则可以执行
kubectl create service nodeport <服务名称>
更新对象:
一些常见的更新操作:
scale:对某控制器进行水平扩缩以便通过更新控制器的副本个数来添加或删除 Pod。
annotate:为对象添加或删除注解。
label:为对象添加或删除标签。
set <字段>:设置对象的某一属性。
edit:通过在编辑器中打开现时对象的配置,直接编辑其原始配置。
patch:通过使用补丁字符串(Patch String)直接更改某现时对象的的特定字段
删除对象:
使用 delete 命令从集群中删除一个对象:delete <类别>/<名称>,如:
kubectl delete deployment/nginx
查看对象:
用来打印对象信息的命令有:
get:打印匹配到的对象的基本信息。使用 get -h 可以查看选项列表。
describe:打印匹配到的对象的详细信息的汇集版本。
logs:打印 Pod 中运行的容器的 stdout 和 stderr 输出。
使用 set 命令在创建对象之前修改对象:
有些对象字段在 create 命令中没有对应的标志。在这些场景中, 你可以使用 set 和 create 命令的组合来在对象创建之前设置字段值。 这是通过将 create 命令的输出用管道方式传递给 set 命令来实现的, 最后执行 create 命令来创建对象。下面是一个例子:
kubectl create service clusterip my-svc --clusterip="None"-o yaml --dry-run=client | kubectlsetselector --local -f -'environment=qa'-o yaml | kubectl create -f -
1). 命令 kubectl create service -o yaml --dry-run=client 创建 Service 的配置,但 将其以 YAML 格式在标准输出上打印而不是发送给 API 服务器。
2). 命令 kubectl set selector --local -f - -o yaml 从标准输入读入配置,并将更新后的 配置以 YAML 格式输出到标准输出。
3). 命令 kubectl create -f - 使用标准输入上获得的配置创建对象。
在创建之前使用 --edit 更改对象:
用 kubectl create --edit 来在对象被创建之前执行任意的变更。
kubectl create service clusterip my-svc --clusterip="None"-o yaml --dry-run=client > /tmp/srv.yaml
kubectl create --edit -f /tmp/srv.yaml
也可以直接 kubectl edit 指定的service或deployment等
2. 命令式对象配置
创建对象:
使用 kubectl create -f 从配置文件创建一个对象。
kubectl create -f
更新对象:
使用 kubectl replace -f 根据配置文件更新活动对象。
kubectl replace -f
删除对象:
使用 kubectl delete -f 删除配置文件中描述的对象。
kubectl delete -f
查看对象:
使用 kubectl get -f 查看有关配置文件中描述的对象的信息。
kubectl get -f
-o yaml 标志指定打印完整的对象配置
3. 声明式对象配置
通过在一个目录中存储多个对象配置文件、并使用 kubectl apply 来递归地创建和更新对象来创建、更新和删除 Kubernetes 对象。 这种方法会保留对现有对象已作出的修改,而不会将这些更改写回到对象配置文件中。 kubectl diff 可以查看 apply 将作出的变更。
创建对象:
使用 kubectl apply 来创建指定目录中配置文件所定义的所有对象,除非对应对象已经存在:
kubectl apply -f <目录>/
执行 kubectl diff 可以打印出将被创建的对象:、
kubectl diff -f https://k8s.io/examples/application/simple_deployment.yaml
使用 kubectl apply 来创建对象:
kubectl apply -f https://k8s.io/examples/application/simple_deployment.yaml
使用 kubectl get 打印其现时配置:
kubectl get -f https://k8s.io/examples/application/simple_deployment.yaml -o yaml
更新对象:
也可以使用 kubectl apply 来更新某个目录中定义的所有对象,即使那些对象已经存在。这一操作会包含:
1). 在现时配置中设置配置文件中出现的字段;
2). 在现时配置中清除配置文件中已删除的字段。
通过 kubeclt scale 命令直接更新现时配置中的 replicas 字段。 这一命令没有使用 kubectl apply:
kubectl scale deployment/nginx-deployment --replicas=2
使用 kubectl get 来打印现时配置:
kubectl get deployment nginx-deployment -o yaml
输出显示,replicas 字段已经被设置为 2
删除对象:
两种方法来删除 kubectl apply 管理的对象
1). kubectl delete -f <文件名> (建议方法)
2). kubectl apply -f <目录名称/> --prune -l your=label
查看对象:
使用 kubectl get 并指定 -o yaml 选项来查看现时对象的配置:
kubectl get -f <文件名 | URL> -o yaml