kubebuilder 和 Operator SDK 中如何增加 CustomResource 的数量上限

在 Kubernetes 运算符中，有时需要限制属于特定 CustomResourceDefinition (CRD) 的 CustomResource (CR) 的数量。通过使用 `kubebuilder` 和 `Operator SDK`，可以实现此目标。默认情况下，`kubebuilder` 会生成一个 `kindlist` 结构，该结构跟踪已定义的 CR。通过使用 `client.Client` 的 `list()` 函数，可以访问此列表并验证其长度，从而实现对 CR 数量的限制。

我正在开发一个 kubernetes 运算符，它代表一个非常简单的 api 和一个控制器。 我想最大化属于操作员定义的特定 customresourcedefinition 的 customresources 数量。 （特别是我只想允许一个 cr，如果它已经定义，操作员应该抛出一条错误消息并跳过对其进行协调。） 如果我生成 api，则会默认生成一个 kindlist 结构，如果我理解正确的话，它应该跟踪已经为我的 crd 定义的 cr。默认情况下它也会添加到方案中。请参阅 kubebuilder 文档中的示例：

//+kubebuilder:object:root=true
//+kubebuilder:subresource:status

// cronjob is the schema for the cronjobs api
type cronjob struct {
    metav1.typemeta   `json:",inline"`
    metav1.objectmeta `json:"metadata,omitempty"`

    spec   cronjobspec   `json:"spec,omitempty"`
    status cronjobstatus `json:"status,omitempty"`
}

//+kubebuilder:object:root=true

// cronjoblist contains a list of cronjob
type cronjoblist struct {
    metav1.typemeta `json:",inline"`
    metav1.listmeta `json:"metadata,omitempty"`
    items           []cronjob `json:"items"`
}

func init() {
    schemebuilder.register(&cronjob{}, &cronjoblist{})
}

不幸的是，我无法找到如何从控制器访问此列表。我已经尝试过这样，但是r.get无法接受cachelist：

cronjob/cronjob_controller.go

package controllers

import (
    "context"

    "k8s.io/apimachinery/pkg/runtime"
    ctrl "sigs.k8s.io/controller-runtime"
    "sigs.k8s.io/controller-runtime/pkg/client"
    "sigs.k8s.io/controller-runtime/pkg/log"

    cronjobv1alpha1 "github.com/example/cronjob-operator/api/v1alpha1"
)

func (r *CronJobReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
    _ = log.FromContext(ctx)

    // TODO(user): your logic here

    cronjob := cronjobv1alpha1.Memcached{}
    if err := r.Get(ctx, req.NamespacedName, &cronjob); err != nil {
        return ctrl.Result{}, err
    }

    cronjobList := cachev1alpha1.MemcachedList{}
    if err := r.Get(ctx, req.NamespacedName, &cronjobList); err != nil {
        return ctrl.Result{}, err
    }

    return ctrl.Result{}, nil
}

如果我得到列表，我可以验证它的长度，并执行或跳过协调。

这是正确的方法吗？有更好的方法来实现我的目标吗？我应该创建一个 webhook 吗？

正确答案

假设您使用默认的 sigs.k8s.io/controller-runtime/pkg/client 的 client.client，您可以访问 list() 函数。

就您而言，r.list(...)。

用法：

情况1：按标签列出

func (r *cronjobreconciler) reconcile(ctx context.context, req ctrl.request) (ctrl.result, error) {
    cronjoblist := cronjobv1alpha1.cronjoblist{}
    err = r.list(ctx, &cronjoblist, client.matchinglabels{"foo": "bar"})
    if err != nil {
        return ctrl.result{}, err
    }
}

情况 2：列出命名空间中的所有内容

func (r *cronjobreconciler) reconcile(ctx context.context, req ctrl.request) (ctrl.result, error) {
    cronjoblist := cronjobv1alpha1.cronjoblist{}
    err = r.list(ctx, &cronjoblist, client.innamespace("default"))
    if err != nil {
        return ctrl.result{}, err
    }
}

情况3：按字段列出，即metadata.name

// in your Reconciler Setup function create an index
func SetupWithManager(mgr ctrl.Manager) error {
    r := &CronJobReconciler{
        Client:   mgr.GetClient(),
    }
    mgr.GetFieldIndexer().IndexField(context.TODO(), &cronjobv1alpha1.CronJob{}, "metadata.name", NameIndexer)

    return ctrl.NewControllerManagedBy(mgr).
        For(&cronjobv1alpha1.CronJob{}).
        Complete(r)
}    

func NameIndexer(o client.Object) []string {
    m := o.(*cronjobv1alpha1.CronJob)
    return []string{m.ObjectMeta.Name}
}

func (r *CronJobReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
    cronjobList := cronjobv1alpha1.CronJobList{}
    err = r.List(ctx, &cronjobList, client.MatchingFields{"metadata.name": "test"})
    if err != nil {
        return ctrl.Result{}, err
    }
}

今天关于《kubebuilder 和 Operator SDK 中如何增加 CustomResource 的数量上限》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！