使用自定义资源扩展API

注意:TPR已经停止维护,kubernetes 1.7及以上版本请使用CRD。

自定义资源是对Kubernetes API的扩展,kubernetes中的每个资源都是一个API对象的集合,例如我们在YAML文件里定义的那些spec都是对kubernetes中的资源对象的定义,所有的自定义资源可以跟kubernetes中内建的资源一样使用kubectl操作。

自定义资源

Kubernetes1.6版本中包含一个内建的资源叫做TPR(ThirdPartyResource),可以用它来创建自定义资源,但该资源在kubernetes1.7中版本已被CRD(CustomResourceDefinition)取代。

扩展API

自定义资源实际上是为了扩展kubernetes的API,向kubenetes API中增加新类型,可以使用以下三种方式:

  • 修改kubenetes的源码,显然难度比较高,也不太合适
  • 创建自定义API server并聚合到API中
  • 1.7以下版本编写TPR,kubernetes1.7及以上版本用CRD

编写自定义资源是扩展kubernetes API的最简单的方式,是否编写自定义资源来扩展API请参考Should I add a custom resource to my Kubernetes Cluster?,行动前请先考虑以下几点:

  • 你的API是否属于声明式的
  • 是否想使用kubectl命令来管理
  • 是否要作为kubenretes中的对象类型来管理,同时显示在kuberetes dashboard上
  • 是否可以遵守kubernetes的API规则限制,例如URL和API group、namespace限制
  • 是否可以接受该API只能作用于集群或者namespace范围
  • 想要复用kubernetes API的公共功能,比如CRUD、watch、内置的认证和授权等

如果这些都不是你想要的,那么你可以开发一个独立的API。

TPR

注意:TPR已经停止维护,kubernetes 1.7及以上版本请使用CRD。

假如我们要创建一个名为cron-tab.stable.example.com的TPR,yaml文件定义如下:

  1. apiVersion: extensions/v1beta1
  2. kind: ThirdPartyResource
  3. metadata:
  4. name: cron-tab.stable.example.com
  5. description: "A specification of a Pod to run on a cron style schedule"
  6. versions:
  7. - name: v1

然后使用kubectl create命令创建该资源,这样就可以创建出一个API端点/apis/stable.example.com/v1/namespaces/<namespace>/crontabs/...

下面是在Linkerd中的一个实际应用,Linkerd中的一个名为namerd的组件使用了TPR,定义如下:

  1. ---
  2. kind: ThirdPartyResource
  3. apiVersion: extensions/v1beta1
  4. metadata:
  5. name: d-tab.l5d.io
  6. description: stores dtabs used by namerd
  7. versions:
  8. - name: v1alpha1

CRD

参考下面的CRD,resourcedefinition.yaml:

  1. apiVersion: apiextensions.k8s.io/v1beta1
  2. kind: CustomResourceDefinition
  3. metadata:
  4. # 名称必须符合下面的格式:<plural>.<group>
  5. name: crontabs.stable.example.com
  6. spec:
  7. # REST API使用的组名称:/apis/<group>/<version>
  8. group: stable.example.com
  9. # REST API使用的版本号:/apis/<group>/<version>
  10. version: v1
  11. # Namespaced或Cluster
  12. scope: Namespaced
  13. names:
  14. # URL中使用的复数名称: /apis/<group>/<version>/<plural>
  15. plural: crontabs
  16. # CLI中使用的单数名称
  17. singular: crontab
  18. # CamelCased格式的单数类型。在清单文件中使用
  19. kind: CronTab
  20. # CLI中使用的资源简称
  21. shortNames:
  22. - ct

创建该CRD:

  1. kubectl create -f resourcedefinition.yaml

访问RESTful API端点如http://172.20.0.113:8080将看到如下API端点已创建:

  1. /apis/stable.example.com/v1/namespaces/*/crontabs/...

创建自定义对象

如下所示:

  1. apiVersion: "stable.example.com/v1"
  2. kind: CronTab
  3. metadata:
  4. name: my-new-cron-object
  5. spec:
  6. cronSpec: "* * * * /5"
  7. image: my-awesome-cron-image

引用该自定义资源的API创建对象。

终止器

可以为自定义对象添加一个终止器,如下所示:

  1. apiVersion: "stable.example.com/v1"
  2. kind: CronTab
  3. metadata:
  4. finalizers:
  5. - finalizer.stable.example.com

删除自定义对象前,异步执行的钩子。对于具有终止器的一个对象,删除请求仅仅是为metadata.deletionTimestamp字段设置一个值,而不是删除它,这将触发监控该对象的控制器执行他们所能处理的任意终止器。

详情参考:Extend the Kubernetes API with CustomResourceDefinitions

使用kubernetes1.7及以上版本请参考Migrate a ThirdPartyResource to CustomResourceDefinition

自定义控制器

单纯设置了自定义资源,并没有什么用,只有跟自定义控制器结合起来,才能讲资源对象中的声明式API翻译成用户所期望的状态。自定义控制器可以用来管理任何资源类型,但是一般是跟自定义资源结合使用。

请参考使用Operator模式,该模式可以让开发者将自己的领域知识转换成特定的kubenretes API扩展。

API server聚合

Aggregated(聚合的)API server是为了将原来的API server这个巨石(monolithic)应用给拆分成,为了方便用户开发自己的API server集成进来,而不用直接修改kubernetes官方仓库的代码,这样一来也能将API server解耦,方便用户使用实验特性。这些API server可以跟core API server无缝衔接,试用kubectl也可以管理它们。

详情参考Aggregated API Server

参考