Files
my-rook-config/pkg/operator/ceph/object/notification/controller.go
T

263 lines
11 KiB
Go
Raw Normal View History

/*
Copyright 2021 The Rook Authors. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package notification
import (
"context"
"strings"
"time"
"github.com/coreos/pkg/capnslog"
bktv1alpha1 "github.com/kube-object-storage/lib-bucket-provisioner/pkg/apis/objectbucket.io/v1alpha1"
"github.com/pkg/errors"
cephv1 "github.com/rook/rook/pkg/apis/ceph.rook.io/v1"
"github.com/rook/rook/pkg/clusterd"
cephclient "github.com/rook/rook/pkg/daemon/ceph/client"
"github.com/rook/rook/pkg/operator/ceph/cluster/mon"
opcontroller "github.com/rook/rook/pkg/operator/ceph/controller"
"github.com/rook/rook/pkg/operator/ceph/object/topic"
kerrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/types"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/manager"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"sigs.k8s.io/controller-runtime/pkg/source"
)
const (
packageName = "ceph-bucket-notification"
controllerName = packageName + "-controller"
)
var logger = capnslog.NewPackageLogger("github.com/rook/rook", packageName)
var waitForRequeueIfTopicNotReady = reconcile.Result{Requeue: true, RequeueAfter: 10 * time.Second}
var waitForRequeueIfNotificationNotReady = reconcile.Result{Requeue: true, RequeueAfter: 10 * time.Second}
var waitForRequeueIfObjectBucketNotReady = reconcile.Result{Requeue: true, RequeueAfter: 10 * time.Second}
// ReconcileNotifications reconciles a CephbucketNotification
type ReconcileNotifications struct {
client client.Client
context *clusterd.Context
clusterInfo *cephclient.ClusterInfo
clusterSpec *cephv1.ClusterSpec
opManagerContext context.Context
}
// Add creates a new CephBucketNotification controller and a new ObjectBucketClaim Controller and adds it to the Manager.
// The Manager will set fields on the Controller and start it when the Manager is started.
func Add(mgr manager.Manager, context *clusterd.Context, opManagerContext context.Context, opConfig opcontroller.OperatorConfig) error {
if err := addNotificationReconciler(mgr, &ReconcileNotifications{
client: mgr.GetClient(),
context: context,
opManagerContext: opManagerContext,
}); err != nil {
return err
}
return addOBCLabelReconciler(mgr, &ReconcileOBCLabels{
client: mgr.GetClient(),
context: context,
opManagerContext: opManagerContext,
})
}
func addNotificationReconciler(mgr manager.Manager, r reconcile.Reconciler) error {
// Create a new controller
c, err := controller.New(controllerName, mgr, controller.Options{Reconciler: r})
if err != nil {
return err
}
logger.Info("successfully started")
// Watch for changes on the OBC CRD object
err = c.Watch(&source.Kind{Type: &cephv1.CephBucketNotification{}}, &handler.EnqueueRequestForObject{}, opcontroller.WatchControllerPredicate())
if err != nil {
return err
}
return nil
}
// Reconcile reads that state of the cluster for a CephBucketNotification object and makes changes based on the state read
// The Controller will requeue the Request to be processed again if the returned error is non-nil or
// Result.Requeue is true, otherwise upon completion it will remove the work from the queue.
func (r *ReconcileNotifications) Reconcile(context context.Context, request reconcile.Request) (reconcile.Result, error) {
// workaround because the rook logging mechanism is not compatible with the controller-runtime logging interface
reconcileResponse, err := r.reconcile(request)
if err != nil {
logger.Errorf("failed to reconcile %v", err)
}
return reconcileResponse, err
}
func (r *ReconcileNotifications) reconcile(request reconcile.Request) (reconcile.Result, error) {
// fetch the CephBucketNotification instance
notification := &cephv1.CephBucketNotification{}
err := r.client.Get(r.opManagerContext, request.NamespacedName, notification)
if err != nil {
if kerrors.IsNotFound(err) {
logger.Debugf("CephBucketNotification %q resource not found. Ignoring since resource must be deleted.", request.NamespacedName)
return reconcile.Result{}, nil
}
// Error reading the object - requeue the request.
return reconcile.Result{}, errors.Wrapf(err, "failed to retrieve CephBucketNotification %q", request.NamespacedName)
}
// get the topic associated with the notification
bucketTopic := &cephv1.CephBucketTopic{}
topicName := types.NamespacedName{Namespace: notification.Namespace, Name: notification.Spec.Topic}
if err := r.client.Get(r.opManagerContext, topicName, bucketTopic); err != nil {
if kerrors.IsNotFound(err) {
logger.Infof("CephBucketTopic %q not provisioned yet", topicName)
return waitForRequeueIfTopicNotReady, nil
}
return reconcile.Result{}, errors.Wrapf(err, "failed to retrieve CephBucketTopic %q", topicName)
}
// find the namespace for the ceph cluster (may be different than the namespace of the notification CR)
// Make sure a CephCluster is present otherwise do nothing
cephCluster, isReadyToReconcile, cephClusterExists, reconcileResponse := opcontroller.IsReadyToReconcile(
r.opManagerContext,
r.client,
types.NamespacedName{Namespace: bucketTopic.Spec.ObjectStoreNamespace},
controllerName,
)
if !isReadyToReconcile {
// This handles the case where the Ceph Cluster is gone and we want to delete that CR
if !notification.GetDeletionTimestamp().IsZero() && !cephClusterExists {
// Return and do not requeue. Successful deletion.
return reconcile.Result{}, nil
}
logger.Debug("Ceph cluster not yet present.")
return reconcileResponse, nil
}
r.clusterSpec = &cephCluster.Spec
// DELETE: the CR was deleted
if !notification.GetDeletionTimestamp().IsZero() {
logger.Debugf("CephBucketNotification %q was deleted", notification.Name)
// Return and do not requeue. Successful deletion.
return reconcile.Result{}, nil
}
// Populate clusterInfo during each reconcile
r.clusterInfo, _, _, err = mon.LoadClusterInfo(r.context, r.opManagerContext, cephCluster.Namespace)
if err != nil {
return reconcile.Result{}, errors.Wrap(err, "failed to populate cluster info")
}
// create the notification if needed
return r.updateCephBucketNotification(notification, bucketTopic)
}
func getCephObjectStoreName(ob bktv1alpha1.ObjectBucket) (objectStoreName types.NamespacedName, err error) {
// prase the following string: <prefix>-rgw-<store>.<namespace>.svc
// to ge the object store name and namespace
logger.Debugf("BucketHost of %q is %q",
types.NamespacedName{Name: ob.Name, Namespace: ob.Namespace}.String(),
ob.Spec.Endpoint.BucketHost,
)
parsedBucketHost := strings.Split(ob.Spec.Endpoint.BucketHost, ".")
if len(parsedBucketHost) < 3 {
err = errors.Errorf("malformed BucketHost %q", ob.Spec.Endpoint.BucketHost)
return
}
parsedSubdomain := strings.Split(parsedBucketHost[0], "-rgw-")
if len(parsedSubdomain) != 2 {
err = errors.Errorf("malformed BucketHost subdomain %q", parsedBucketHost[0])
return
}
objectStoreName.Namespace = parsedBucketHost[1]
objectStoreName.Name = parsedSubdomain[1]
return
}
// verify that object store is configured correctly for OB, CephBucketNotification and CephBucketTopic
func validateObjectStoreName(topic *cephv1.CephBucketTopic, bucketStoreName types.NamespacedName) error {
topicStoreName := types.NamespacedName{Name: topic.Spec.ObjectStoreName, Namespace: topic.Spec.ObjectStoreNamespace}
if topicStoreName != bucketStoreName {
return errors.Errorf("object store name mismatch between topic and bucket. %q != %q", topicStoreName, bucketStoreName)
}
return nil
}
func (r *ReconcileNotifications) updateCephBucketNotification(notification *cephv1.CephBucketNotification, bucketTopic *cephv1.CephBucketTopic) (reconcile.Result, error) {
topicARN, err := topic.GetARN(bucketTopic)
if err != nil {
return reconcile.Result{}, errors.Wrapf(err, "failed to get topic ARN for CephBucketTopic %q", types.NamespacedName{Name: bucketTopic.Name, Namespace: bucketTopic.Namespace})
}
// fetch all OBCs that has a label matching this CBN
namespace := notification.Namespace
bnName := types.NamespacedName{Namespace: namespace, Name: notification.Name}
namespaceListOpt := client.InNamespace(namespace)
labelListOpt := client.MatchingLabels{
notificationLabelPrefix + notification.Name: notification.Name,
}
obcList := &bktv1alpha1.ObjectBucketClaimList{}
err = r.client.List(r.opManagerContext, obcList, namespaceListOpt, labelListOpt)
if err != nil {
return reconcile.Result{}, errors.Wrapf(err, "failed to list ObjectBucketClaims for CephBucketNotification %q", bnName)
}
if len(obcList.Items) == 0 {
logger.Debugf("no ObjectbucketClaim associated with CephBucketNotification %q", bnName)
return reconcile.Result{}, nil
}
// loop through all OBCs in the list and get their OBs
for _, obc := range obcList.Items {
ob := bktv1alpha1.ObjectBucket{}
bucketName := types.NamespacedName{Namespace: namespace, Name: obc.Spec.ObjectBucketName}
if err := r.client.Get(r.opManagerContext, bucketName, &ob); err != nil {
return reconcile.Result{}, errors.Wrapf(err, "failed to retrieve ObjectBucket %v", bucketName)
}
objectStoreName, err := getCephObjectStoreName(ob)
if err != nil {
return reconcile.Result{}, errors.Wrapf(err, "failed to get object store from ObjectBucket %q", bucketName)
}
if err = validateObjectStoreName(bucketTopic, objectStoreName); err != nil {
return reconcile.Result{}, err
}
// provision the notification
provisioner := Provisioner{
Client: r.client,
Context: r.context,
ClusterInfo: r.clusterInfo,
ClusterSpec: r.clusterSpec,
opManagerContext: r.opManagerContext,
}
session, err := provisioner.createSession(
ob.Spec.AdditionalState["cephUser"],
objectStoreName,
)
if err != nil {
return reconcile.Result{}, errors.Wrapf(err, "failed to create session for CephBucketNotification provisioning %q for ObjectBucketClaims %q", bnName, bucketName)
}
err = provisioner.Create(&ob, topicARN, notification, session)
if err != nil {
return reconcile.Result{}, errors.Wrapf(err, "failed to provision CephBucketNotification %q for ObjectBucketClaims %q", bnName, bucketName)
}
}
return reconcile.Result{}, nil
}