kubernetes code-generator使用

Overview

Kubernetes中提供了多种自定义控制器的方式：

• code-generator
  
• kubebuilder
  
• Operator
  

Controller 作为CRD的核心，这里将解释如何使用 code-generator 来创建自定义的控制器，作为文章的案例，将完成一个 Firewalld Port 规则的控制器作为描述，通过 Kubernetes 规则来生成对应节点上的 iptables规则。
Prerequisites

CRD

1. apiVersion: apiextensions.k8s.io/v1
2. kind: CustomResourceDefinition
3. metadata:
4.   name: ports.firewalld.fedoraproject.org
5. spec:
6.   group: firewalld.fedoraproject.org
7.   scope: Namespaced
8.   names:
9.     plural: ports
10.     singular: port
11.     kind: PortRule
12.     shortNames:
13.     - fp
14.   versions:
15.   - name: v1
16.     served: true
17.     storage: true
18.     schema:
19.       openAPIV3Schema:
20.         type: object
21.         properties:
22.           spec:
23.             type: object
24.             properties:
25.               name:
26.                 type: string
27.               port:
28.                 type: integer
29.               host:
30.                 type: string
31.               isPermanent:
32.                 type: boolean

复制代码

code-generator

需要预先下载 code-generator 。因为这个工具不是必需要求的。

注意，下载完成后需要将代码库的的分支更改为你目前使用的版本，版本的选择与client-go类似，如果使用master分支，会与当前的 Kubernetes 集群不兼容。

1. git clone https://github.com/kubernetes/code-generator
2. cd code-generator; git checkout {version}  # ex. v0.18.0

复制代码

编写代码模板

要想使用 code-generator 生成控制器，必须准备三个文件 doc.go , register.go , types.go 。

• doc.go 中声明了这个包全局内，要使用生成器的tag
  
• register.go 类似于kubernetes API，是将声明的类型注册到schema中
  
• type.go 是需要具体声明对象类型
  

code-generator Tag说明

在使用 code-generator 时，就需要对 code-generator 的tag进行了解。code-generator 的tag是根据几个固定格式进行定义的，tag是 +k8s: + conversion 的组合，在仓库中 cmd 中的 *-gen* 文件夹就代表了 conversion 的替换位置。

• 对于 client-gen的tag 参数可以在 code-generator\cmd\client-gen\generators\util\tags.go
  
• 对于其他类型的使用方法，例如 deepcopy-gen ,可以在包 main.go中看注释说明
  
  
  
  • +k8s:openapi-gen=true：启用一个生成器
    
  
  

注：最终准备完成的文件（ doc.go , register.go , types.go）应该为：apis/example.com/v1 这种类型的
需要遵循的是，将这些文件放在  目录中，例如 v1 。这里 v1, v1alpha1, 根据自己需求定义。

开始填写文件内容

type.go

1. package v1
3. import (
4.         metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
5. )
7. // +genclient
8. // +genclient:noStatus
9. // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
10. type Port struct {
11.         metav1.TypeMeta `json:",inline"`
12.         // Standard object metadata.
13.         // +optional
14.         metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
16.         // Specification of the desired behavior of the Deployment.
17.         // +optional
18.         Spec PortSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
19. }
21. // +k8s:deepcopy-gen=false
22. type PortSpec struct {
23.         Name        string `json:"name"`
24.         Host        string `json:"host"`
25.         Port        int    `json:"port"`
26.         IsPermanent bool   `json:"isPermanent"`
27. }
29. // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
30. type PortList struct {
31.         metav1.TypeMeta `json:",inline"`
32.         // +optional
33.         metav1.ListMeta `json:"metadata,omitempty"`
35.         Items []Port `json:"items"`
36. }

复制代码

doc.go

1. // +k8s:deepcopy-gen=package
2. // +k8s:protobuf-gen=package
3. // +k8s:openapi-gen=true
5. // +groupName=firewalld.fedoraproject.org
7. package v1 // import "k8s.io/api/firewalld/v1"

复制代码

register.go

这里是从 k8s.io/api 里任意一个复制的，例如 k8s.io/api/core/v1/register.go

1. package v1
3. import (
4.         metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
5.         "k8s.io/apimachinery/pkg/runtime"
6.         "k8s.io/apimachinery/pkg/runtime/schema"
7. )
9. // GroupName is the group name use in this package
10. const GroupName = "firewalld.fedoraproject.org"
12. // SchemeGroupVersion is group version used to register these objects
13. var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}
15. // Resource takes an unqualified resource and returns a Group qualified GroupResource
16. func Resource(resource string) schema.GroupResource {
17.         return SchemeGroupVersion.WithResource(resource).GroupResource()
18. }
20. var (
21.         // TODO: move SchemeBuilder with zz_generated.deepcopy.go to k8s.io/api.
22.         // localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
23.         SchemeBuilder      = runtime.NewSchemeBuilder(addKnownTypes)
24.         localSchemeBuilder = &SchemeBuilder
25.         AddToScheme        = localSchemeBuilder.AddToScheme
26. )
28. // Adds the list of known types to the given scheme.
29. func addKnownTypes(scheme *runtime.Scheme) error {
30.         scheme.AddKnownTypes(SchemeGroupVersion,
31.                 &Port{},
32.                 &PortList{},
33.         )
34.         metav1.AddToGroupVersion(scheme, SchemeGroupVersion)
35.         return nil
36. }

复制代码

生成所需文件

使用 code-generator 时，实际上就是使用这个库中的脚本 generate-groups.sh ，该脚本又四个参数

• 第一个参数：使用那些生成器，就是 *.gen，用逗号分割，all表示使用全部
  
• 第二个参数：client（client-go中informer, lister等）生成的文件存放到哪里
  
• 第三个参数：api（api结构，k8s.io/api/） 生成的文件存放到哪里，可以和定义的文件为一个目录
  
• 第四个参数：定义group:version
  
• -output-base：输出包存放的根目录
  
• -go-header-file：生成文件的头注释信息，这个是必要参数，除非生成失败
  

注：对于参数二，三，与-output-base，指定的路径，这里可以使用相对路径也可以使用go.mod中的定义的包名，对于使用相对路径而言，生成的文件中的import也将会为 "../../" 的格式

一个完整的示例

1. ../code-generator/generate-groups.sh all \
2.         ../code-controller/client \
3.         ../code-controller/apis  \
4.         firewalld:v1 \
5.         --output-base ../code-controller/ \
6.         --go-header-file ../code-generator/hack/boilerplate.go.txt

复制代码

Reference
CRD Programming

出处：http://lc161616.cnblogs.com/本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。 阿里云优惠：点击力享低价墨墨学英语：帮忙点一下
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！