Kubebuilder:资源删除没有预期的副作用

Question

我正在使用库贝建设者创建一个具有关联控制器的自定义资源定义(CRD)。我的控制器协调循环创建了一个部署子资源，并使用controllerutil.SetControllerReference(&myResource, deployment, r.Scheme)将它与自定义资源相结合。我还将调节器配置为“拥有”子资源，如下所示：

// SetupWithManager sets up the controller with the Manager.
func (r *MyResourceReconciler) SetupWithManager(mgr ctrl.Manager) error {
    return ctrl.NewControllerManagedBy(mgr).
        For(&mygroupv1alpha1.MyResource{}).
        Owns(&appsv1.Deployment{}).
        Complete(r)
}

但是，当我使用make run在本地运行控制器时，我注意到删除我的CR (根对象)并不会导致部署子资源被垃圾收集。我还注意到，删除部署子资源不会触发我的协调器运行。为什么会这样呢？是否有什么是我没有做的，还是这可能是本地开发/测试的一个限制？

Answer 1

使用@coderanger的提示，我可以看到在运行以下命令时没有正确设置metadata.ownerReferences：

kubectl get deployments sample-deployment -o yaml

问题是我的控制器的协调代码。只有在我已经创建并持久化部署之后才调用controllerutil.SetControllerReference(&myResource, deployment, r.Scheme)。

Buggy代码

log.Info("Creating a deployment")

deployment := &appsv1.Deployment{
    ObjectMeta: metav1.ObjectMeta{
        Name:      deploymentName,
        Namespace: myResource.Namespace,
    },
    Spec: deploymentSpec,
}

if err = r.Create(ctx, deployment); err != nil {
    log.Error(err, "Failed to create deployment")
    if errors.IsInvalid(err) {
        // Don't retry on validation errors
        err = nil
    }
    return ctrl.Result{}, err
}

// Establish the parent-child relationship between my resource and the deployment
log.Info("Making my resource a parent of the deployment")
if err = controllerutil.SetControllerReference(&myResource, deployment, r.Scheme); err != nil {
    log.Error(err, "Failed to set deployment controller reference")
    return ctrl.Result{}, err
}

要修复它，我需要交换对r.Create和controllerutil.SetControllerReference调用的顺序。

工作代码

log.Info("Creating a deployment")

deployment := &appsv1.Deployment{
    ObjectMeta: metav1.ObjectMeta{
        Name:      deploymentName,
        Namespace: myResource.Namespace,
    },
    Spec: deploymentSpec,
}

// Establish the parent-child relationship between my resource and the deployment
log.Info("Making my resource a parent of the deployment")
if err = controllerutil.SetControllerReference(&myResource, deployment, r.Scheme); err != nil {
    log.Error(err, "Failed to set deployment controller reference")
    return ctrl.Result{}, err
}

// Create the deployment with the parent/child relationship configured
if err = r.Create(ctx, deployment); err != nil {
    log.Error(err, "Failed to create deployment")
    if errors.IsInvalid(err) {
        // Don't retry on validation errors
        err = nil
    }
    return ctrl.Result{}, err
}

通过查看我创建的部署的metadata.ownerReferences YAML数据(使用上面引用的命令)，我能够确认这是可行的。

apiVersion: apps/v1
kind: Deployment
metadata:
  annotations:
    deployment.kubernetes.io/revision: "1"
  creationTimestamp: "2021-08-02T16:22:04Z"
  generation: 1
  name: sample-deployment
  namespace: default
  ownerReferences:
  - apiVersion: resources.mydomain.io/v1alpha1
    blockOwnerDeletion: true
    controller: true
    kind: MyResource
    name: myresource-sample
    uid: 6ebb146c-afc7-4601-bd75-58efc29beac9
  resourceVersion: "569913"
  uid: d9a4496f-7418-4831-ab87-4804dcd1f8aa