116 lines
5.0 KiB
Markdown
116 lines
5.0 KiB
Markdown
# 使用自定义资源扩展 API
|
||
|
||
自定义资源是对 Kubernetes API 的扩展,Kubernetes 中的每个资源都是一个 API 对象的集合,例如我们在 YAML 文件里定义的那些 spec 都是对 Kubernetes 中的资源对象的定义,所有的自定义资源可以跟 Kubernetes 中内建的资源一样使用 kubectl 操作。
|
||
|
||
## 自定义资源
|
||
|
||
Kubernetes 从 1.6 版本开始包含一个内建的资源叫做 TPR(ThirdPartyResource),可以用它来创建自定义资源,但该资源在 Kubernetes 1.7 版本开始已被 CRD(CustomResourceDefinition)取代。
|
||
|
||
## 扩展 API
|
||
|
||
自定义资源实际上是为了扩展 Kubernetes 的 API,向 Kubernetes API 中增加新类型,可以使用以下三种方式:
|
||
|
||
- 修改 Kubernetes 的源码,显然难度比较高,也不太合适
|
||
- 创建自定义 API server 并聚合到 API 中
|
||
|
||
编写自定义资源是扩展 Kubernetes API 的最简单的方式,是否编写自定义资源来扩展 API 请参考 [Should I add a custom resource to my Kubernetes Cluster?](https://kubernetes.io/docs/concepts/api-extension/custom-resources/),行动前请先考虑以下几点:
|
||
|
||
- 你的 API 是否属于 [声明式的](https://kubernetes.io/docs/concepts/api-extension/custom-resources/#declarative-apis)
|
||
- 是否想使用 kubectl 命令来管理
|
||
- 是否要作为 Kubernetes 中的对象类型来管理,同时显示在 Kubernetes dashboard 上
|
||
- 是否可以遵守 Kubernetes 的 API 规则限制,例如 URL 和 API group、namespace 限制
|
||
- 是否可以接受该 API 只能作用于集群或者 namespace 范围
|
||
- 想要复用 Kubernetes API 的公共功能,比如 CRUD、watch、内置的认证和授权等
|
||
|
||
如果这些都不是你想要的,那么你可以开发一个独立的 API。
|
||
|
||
### CRD
|
||
|
||
参考下面的 CRD,resourcedefinition.yaml:
|
||
|
||
```yaml
|
||
apiVersion: apiextensions.k8s.io/v1beta1
|
||
kind: CustomResourceDefinition
|
||
metadata:
|
||
# 名称必须符合下面的格式:<plural>.<group>
|
||
name: crontabs.stable.example.com
|
||
spec:
|
||
# REST API 使用的组名称:/apis/<group>/<version>
|
||
group: stable.example.com
|
||
# REST API 使用的版本号:/apis/<group>/<version>
|
||
version: v1
|
||
# Namespaced 或 Cluster
|
||
scope: Namespaced
|
||
names:
|
||
# URL 中使用的复数名称: /apis/<group>/<version>/<plural>
|
||
plural: crontabs
|
||
# CLI 中使用的单数名称
|
||
singular: crontab
|
||
# CamelCased 格式的单数类型。在清单文件中使用
|
||
kind: CronTab
|
||
# CLI 中使用的资源简称
|
||
shortNames:
|
||
- ct
|
||
```
|
||
|
||
创建该 CRD:
|
||
|
||
```bash
|
||
kubectl create -f resourcedefinition.yaml
|
||
```
|
||
|
||
访问 RESTful API 端点如 <http://172.20.0.113:8080> 将看到如下 API 端点已创建:
|
||
|
||
```bash
|
||
/apis/stable.example.com/v1/namespaces/*/crontabs/...
|
||
```
|
||
|
||
**创建自定义对象**
|
||
|
||
如下所示:
|
||
|
||
```yaml
|
||
apiVersion: "stable.example.com/v1"
|
||
kind: CronTab
|
||
metadata:
|
||
name: my-new-cron-object
|
||
spec:
|
||
cronSpec: "* * * * /5"
|
||
image: my-awesome-cron-image
|
||
```
|
||
|
||
引用该自定义资源的 API 创建对象。
|
||
|
||
**终止器**
|
||
|
||
可以为自定义对象添加一个终止器,如下所示:
|
||
|
||
```yaml
|
||
apiVersion: "stable.example.com/v1"
|
||
kind: CronTab
|
||
metadata:
|
||
finalizers:
|
||
- finalizer.stable.example.com
|
||
```
|
||
|
||
删除自定义对象前,异步执行的钩子。对于具有终止器的一个对象,删除请求仅仅是为`metadata.deletionTimestamp` 字段设置一个值,而不是删除它,这将触发监控该对象的控制器执行他们所能处理的任意终止器。
|
||
|
||
详情参考:[Extend the Kubernetes API with CustomResourceDefinitions](https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/)
|
||
|
||
## 自定义控制器
|
||
|
||
单纯设置了自定义资源,并没有什么用,只有跟自定义控制器结合起来,才能将资源对象中的声明式 API 翻译成用户所期望的状态。自定义控制器可以用来管理任何资源类型,但是一般是跟自定义资源结合使用。
|
||
|
||
请参考使用 [Operator](https://coreos.com/blog/introducing-operators.html) 模式,该模式可以让开发者将自己的领域知识转换成特定的 Kubernetes API 扩展。
|
||
|
||
## API server 聚合
|
||
|
||
Aggregated(聚合的)API server 是为了将原来的 API server 这个巨石(monolithic)应用给拆分成,为了方便用户开发自己的 API server 集成进来,而不用直接修改 kubernetes 官方仓库的代码,这样一来也能将 API server 解耦,方便用户使用实验特性。这些 API server 可以跟 core API server 无缝衔接,使用 kubectl 也可以管理它们。
|
||
|
||
详情参考 [Aggregated API Server](aggregated-api-server.md)。
|
||
|
||
## 参考
|
||
|
||
- [Custom Resources - kubernetes.io](https://kubernetes.io/docs/concepts/api-extension/custom-resources/)
|
||
- [Extend the Kubernetes API with CustomResourceDefinitions - kubernetes.io](https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/)
|
||
- [Introducing Operators: Putting Operational Knowledge into Software - coreos.com](https://coreos.com/blog/introducing-operators.html) |