Skip to content

Commit

Permalink
controllers: new controller for maintenance mode
Browse files Browse the repository at this point in the history
Signed-off-by: Rewant Soni <[email protected]>
  • Loading branch information
rewantsoni committed Nov 21, 2024
1 parent 7190d9f commit f7462ff
Show file tree
Hide file tree
Showing 12 changed files with 333 additions and 5 deletions.
2 changes: 2 additions & 0 deletions api/v1alpha1/storageclient_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ type StorageClientSpec struct {
type StorageClientStatus struct {
Phase storageClientPhase `json:"phase,omitempty"`

InMaintenanceMode bool `json:"inMaintenanceMode"`

// ConsumerID will hold the identity of this cluster inside the attached provider cluster
ConsumerID string `json:"id,omitempty"`
}
Expand Down
16 changes: 16 additions & 0 deletions api/v1alpha1/zz_generated.deepcopy.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

27 changes: 26 additions & 1 deletion bundle/manifests/ocs-client-operator.clusterserviceversion.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ metadata:
categories: Storage
console.openshift.io/plugins: '["odf-client-console"]'
containerImage: quay.io/ocs-dev/ocs-client-operator:latest
createdAt: "2024-11-18T12:48:54Z"
createdAt: "2024-11-21T09:38:57Z"
description: OpenShift Data Foundation client operator enables consumption of
storage services from a remote centralized OpenShift Data Foundation provider
cluster.
Expand Down Expand Up @@ -326,6 +326,31 @@ spec:
- list
- update
- watch
- apiGroups:
- ramendr.openshift.io
resources:
- maintenancemodes
verbs:
- create
- delete
- get
- list
- update
- watch
- apiGroups:
- ramendr.openshift.io
resources:
- maintenancemodes/finalizers
verbs:
- update
- apiGroups:
- ramendr.openshift.io
resources:
- maintenancemodes/status
verbs:
- get
- patch
- update
- apiGroups:
- security.openshift.io
resources:
Expand Down
4 changes: 4 additions & 0 deletions bundle/manifests/ocs.openshift.io_storageclients.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,12 @@ spec:
description: ConsumerID will hold the identity of this cluster inside
the attached provider cluster
type: string
inMaintenanceMode:
type: boolean
phase:
type: string
required:
- inMaintenanceMode
type: object
type: object
served: true
Expand Down
11 changes: 11 additions & 0 deletions cmd/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ func main() {
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
OperatorNamespace: utils.GetOperatorNamespace(),
AvailableCrds: availCrds,
}).SetupWithManager(mgr); err != nil {
setupLog.Error(err, "unable to create controller", "controller", "StorageClient")
os.Exit(1)
Expand Down Expand Up @@ -208,6 +209,16 @@ func main() {
os.Exit(1)
}

if availCrds[controller.MaintenanceModeCRDName] {
if err = (&controller.MaintenanceModeReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
}).SetupWithManager(mgr); err != nil {
setupLog.Error(err, "unable to create controller", "controller", "MaintenanceMode")
os.Exit(1)
}
}

setupLog.Info("starting manager")
if err := mgr.Start(ctrl.SetupSignalHandler()); err != nil {
setupLog.Error(err, "problem running manager")
Expand Down
4 changes: 4 additions & 0 deletions config/crd/bases/ocs.openshift.io_storageclients.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,12 @@ spec:
description: ConsumerID will hold the identity of this cluster inside
the attached provider cluster
type: string
inMaintenanceMode:
type: boolean
phase:
type: string
required:
- inMaintenanceMode
type: object
type: object
served: true
Expand Down
25 changes: 25 additions & 0 deletions config/rbac/role.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,31 @@ rules:
- list
- update
- watch
- apiGroups:
- ramendr.openshift.io
resources:
- maintenancemodes
verbs:
- create
- delete
- get
- list
- update
- watch
- apiGroups:
- ramendr.openshift.io
resources:
- maintenancemodes/finalizers
verbs:
- update
- apiGroups:
- ramendr.openshift.io
resources:
- maintenancemodes/status
verbs:
- get
- patch
- update
- apiGroups:
- security.openshift.io
resources:
Expand Down
208 changes: 208 additions & 0 deletions internal/controller/maintenancemode_controller.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,208 @@
package controller

import (
"context"
"fmt"
"k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"time"

"github.com/red-hat-storage/ocs-client-operator/api/v1alpha1"

"github.com/go-logr/logr"
ramenv1alpha1 "github.com/ramendr/ramen/api/v1alpha1"
providerclient "github.com/red-hat-storage/ocs-operator/services/provider/api/v4/client"
storagev1 "k8s.io/api/storage/v1"
kerrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/runtime"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/builder"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/predicate"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
)

const (
maintenanceModeFinalizer = "ocs-client-operator.ocs.openshift.io/maintenance-mode"
ramenReplicationIDLabel = "ramendr.openshift.io/replicationID"
MaintenanceModeCRDName = "maintenancemodes.ramendr.openshift.io"
)

// MaintenanceModeReconciler reconciles a ClusterVersion object
type MaintenanceModeReconciler struct {
client.Client
Scheme *runtime.Scheme

log logr.Logger
ctx context.Context
}

// SetupWithManager sets up the controller with the Manager.
func (r *MaintenanceModeReconciler) SetupWithManager(mgr ctrl.Manager) error {
generationChangePredicate := predicate.GenerationChangedPredicate{}
return ctrl.NewControllerManagedBy(mgr).
For(&ramenv1alpha1.MaintenanceMode{}, builder.WithPredicates(generationChangePredicate)).
Watches(
&storagev1.StorageClass{},
&handler.EnqueueRequestForObject{},
builder.WithPredicates(generationChangePredicate),
).
Watches(
&v1alpha1.StorageClient{},
&handler.EnqueueRequestForObject{},
builder.WithPredicates(generationChangePredicate),
).
Complete(r)
}

//+kubebuilder:rbac:groups=ramendr.openshift.io,resources=maintenancemodes,verbs=get;list;update;create;watch;delete
//+kubebuilder:rbac:groups=ramendr.openshift.io,resources=maintenancemodes/status,verbs=get;update;patch
//+kubebuilder:rbac:groups=ramendr.openshift.io,resources=maintenancemodes/finalizers,verbs=update
//+kubebuilder:rbac:groups=ocs.openshift.io,resources=storageclients,verbs=get;list;watch
//+kubebuilder:rbac:groups=storage.k8s.io,resources=storageclasses,verbs=get;list;watch

func (r *MaintenanceModeReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
r.ctx = ctx
r.log = log.FromContext(ctx, "MaintenanceMode", req)
r.log.Info("Reconciling MaintenanceMode")

maintenanceMode := &ramenv1alpha1.MaintenanceMode{}
maintenanceMode.Name = req.Name
if err := r.get(maintenanceMode); err != nil {
if kerrors.IsNotFound(err) {
r.log.Info("Maintenance Mode resource not found. Ignoring since object might be deleted.")
return reconcile.Result{}, nil
}
r.log.Error(err, "failed to get the Maintenance Mode")
return reconcile.Result{}, err
}

// find the storageClass with the targetID
storageClassList := &storagev1.StorageClassList{}
err := r.list(storageClassList, client.MatchingLabels{ramenReplicationIDLabel: maintenanceMode.Spec.TargetID})
if err != nil {
return ctrl.Result{}, err
}
if len(storageClassList.Items) != 1 {
return ctrl.Result{}, fmt.Errorf("failed to find storageClass for maintenance mode")
}

storageClass := &storageClassList.Items[0]

// find the storageClient
// TODO: when storageClass is owned by storageClient, move to find the Client by ownerRef
storageClient := &v1alpha1.StorageClient{}
storageClient.Name = storageClass.GetLabels()[storageClientLabel]
err = r.get(storageClient)
if err != nil {
return ctrl.Result{}, fmt.Errorf("failed to get the storage client: %v", err)
}

result, reconcileErr := r.reconcilePhases(maintenanceMode, storageClient)

// Apply status changes to the StorageClient
statusErr := r.Client.Status().Update(ctx, maintenanceMode)
if statusErr != nil {
r.log.Error(statusErr, "Failed to update MaintenanceMode status.")
}
if reconcileErr != nil {
err = reconcileErr
} else if statusErr != nil {
err = statusErr
}
return result, err
}

func (r *MaintenanceModeReconciler) reconcilePhases(maintenanceMode *ramenv1alpha1.MaintenanceMode, storageClient *v1alpha1.StorageClient) (ctrl.Result, error) {

// ensure finalizer
if controllerutil.AddFinalizer(maintenanceMode, maintenanceModeFinalizer) {
r.log.Info("finalizer missing on the Maintenance Mode resource, adding...")
if err := r.Client.Update(r.ctx, maintenanceMode); err != nil {
return ctrl.Result{}, err
}
}

if !storageClient.Status.InMaintenanceMode {
providerClient, err := providerclient.NewProviderClient(
r.ctx,
storageClient.Spec.StorageProviderEndpoint,
10*time.Second,
)
if err != nil {
return reconcile.Result{}, fmt.Errorf(
"failed to create provider client with endpoint %v: %v",
storageClient.Spec.StorageProviderEndpoint,
err,
)
}
// Close client-side connections.
defer providerClient.Close()

_, err = providerClient.RequestMaintenanceMode(r.ctx, storageClient.Status.ConsumerID, true)
if err != nil {
return ctrl.Result{}, fmt.Errorf("failed to Request maintenance mode: %v", err)
}
maintenanceMode.Status.State = ramenv1alpha1.MModeStateUnknown
return ctrl.Result{Requeue: true}, nil
}

// Ramen reads the State and Conditions in order to determine that the MaintenanceMode is Completed
maintenanceMode.Status.State = ramenv1alpha1.MModeStateCompleted
maintenanceMode.Status.ObservedGeneration = maintenanceMode.Generation
meta.SetStatusCondition(&maintenanceMode.Status.Conditions,
metav1.Condition{
Type: string(ramenv1alpha1.MModeConditionFailoverActivated),
ObservedGeneration: maintenanceMode.Generation,
Reason: string(ramenv1alpha1.MModeStateCompleted),
Status: metav1.ConditionTrue,
},
)

if !maintenanceMode.GetDeletionTimestamp().IsZero() {
// deletion phase
if storageClient.Status.InMaintenanceMode {
providerClient, err := providerclient.NewProviderClient(
r.ctx,
storageClient.Spec.StorageProviderEndpoint,
10*time.Second,
)
if err != nil {
return reconcile.Result{}, fmt.Errorf(
"failed to create provider client with endpoint %v: %v",
storageClient.Spec.StorageProviderEndpoint,
err,
)
}
// Close client-side connections.
defer providerClient.Close()

_, err = providerClient.RequestMaintenanceMode(r.ctx, storageClient.Status.ConsumerID, false)
if err != nil {
return ctrl.Result{}, fmt.Errorf("failed to disable maintenance mode: %v", err)
}
return ctrl.Result{Requeue: true}, nil
}

// remove finalizer
if controllerutil.RemoveFinalizer(maintenanceMode, maintenanceModeFinalizer) {
if err := r.Client.Update(r.ctx, maintenanceMode); err != nil {
return ctrl.Result{}, err
}
r.log.Info("finalizer removed successfully")
}
}

return ctrl.Result{}, nil
}

func (r *MaintenanceModeReconciler) get(obj client.Object, opts ...client.GetOption) error {
return r.Get(r.ctx, client.ObjectKeyFromObject(obj), obj, opts...)
}

func (r *MaintenanceModeReconciler) list(obj client.ObjectList, opts ...client.ListOption) error {
return r.List(r.ctx, obj, opts...)
}
2 changes: 2 additions & 0 deletions internal/controller/storageclaim_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ import (
const (
storageClaimFinalizer = "storageclaim.ocs.openshift.io"
storageClaimAnnotation = "ocs.openshift.io/storageclaim"
storageClientLabel = "ocs.openshift.io/storageclient"
keyRotationAnnotation = "keyrotation.csiaddons.openshift.io/schedule"

pvClusterIDIndexName = "index:persistentVolumeClusterID"
Expand Down Expand Up @@ -391,6 +392,7 @@ func (r *StorageClaimReconciler) reconcilePhases() (reconcile.Result, error) {
}
err = utils.CreateOrReplace(r.ctx, r.Client, storageClass, func() error {
utils.AddLabels(storageClass, resource.Labels)
utils.AddLabel(storageClass, storageClientLabel, r.storageClient.Name)
utils.AddAnnotation(storageClass, storageClaimAnnotation, r.storageClaim.Name)
storageClass.Parameters = data
return nil
Expand Down
Loading

0 comments on commit f7462ff

Please sign in to comment.