最大化CustomResourceDefinition可以拥有的CustomResources数量 | kubebuilder和operator-sdk

huangapple go评论118阅读模式
英文:

Maximize the number of CustomResources that a CustomResourceDefinition can have | kubebuilder & operator-sdk

问题

我正在开发一个 Kubernetes Operator,它代表了一个非常简单的 API 和一个控制器。
我想要最大化属于操作员定义的特定 CustomResourceDefinition 的 CustomResources 的数量。(特别是,如果已经定义了一个 CR,操作员应该抛出一个错误消息并跳过对其进行调和。)
如果我生成了 API,会默认生成一个 KindList 结构体,并且如果我理解正确的话,它应该跟踪已为我的 CRD 定义的 CR。它也会默认添加到 scheme 中。请参考 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{})
}

不幸的是,我找不到如何从控制器中访问这个 List。我尝试过这样,但是 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 吗?

英文:

I'm developing a kubernetes operator that represents a very simple api and a controller.
I would like to maximize the number of the CustomResources those could belonging to the specific CustomResourceDefinition that the operator defines. (As specially I would like to allow just one CR, if it is already defined, the operator should throw an error message and skip reconciling it.)
If I generate the api, there is a KindList struct default generated, and if I understand correctly, it should keep track of the CRs already defined for my CRD. It is also added to the scheme by default. See the example from kubebuilder documentation:

//+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{})
}

Unfortunately, I can not find out how to access this List from the controller. I have tried like this, but r.Get can not accept 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
}

If I get the list, I could validate the length of it, and do or skip the reconcile.

Is it even a correct approach? Is there a better way to achieve my goal? Should I create a webhook instead?

答案1

得分: 2

假设您正在使用默认的sigs.k8s.io/controller-runtime/pkg/clientclient.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)列出

// 在您的Reconciler Setup函数中创建一个索引
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
	}
}
英文:

Assuming you are using the default sigs.k8s.io/controller-runtime/pkg/client's client.Client, you get access to the List() function.

In your case r.List(...).

Usage:

case 1: list by label

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
	}
}

case 2: list all in namespace

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
	}
}

case 3: list by field i.e. 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
	}
}

huangapple
  • 本文由 发表于 2022年10月21日 03:11:18
  • 转载请务必保留本文链接:https://go.coder-hub.com/74145169.html
匿名

发表评论

匿名网友

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

确定