watcher_controller.go

/*
Copyright 2022.

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 controller

import (
	"context"
	"errors"
	"fmt"

	apimetav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	machineryruntime "k8s.io/apimachinery/pkg/runtime"
	"k8s.io/client-go/rest"
	"k8s.io/client-go/tools/record"
	ctrl "sigs.k8s.io/controller-runtime"
	"sigs.k8s.io/controller-runtime/pkg/client"
	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
	logf "sigs.k8s.io/controller-runtime/pkg/log"

	"github.com/kyma-project/lifecycle-manager/api/shared"
	"github.com/kyma-project/lifecycle-manager/api/v1beta2"
	"github.com/kyma-project/lifecycle-manager/internal/istio"
	"github.com/kyma-project/lifecycle-manager/pkg/log"
	"github.com/kyma-project/lifecycle-manager/pkg/queue"
	"github.com/kyma-project/lifecycle-manager/pkg/status"
	"github.com/kyma-project/lifecycle-manager/pkg/util"
)

var (
	errRestConfigIsNotSet = errors.New("reconciler rest config is not set")
	errRemovingFinalizer  = errors.New("error removing finalizer")
	errAddingFinalizer    = errors.New("error adding finalizer")
)

// WatcherReconciler reconciles a Watcher object.
type WatcherReconciler struct {
	client.Client
	record.EventRecorder
	IstioClient           *istio.Client
	VirtualServiceFactory istio.VirtualServiceFactory
	RestConfig            *rest.Config
	Scheme                *machineryruntime.Scheme
	IstioGatewayNamespace string
	queue.RequeueIntervals
}

// +kubebuilder:rbac:groups=operator.kyma-project.io,resources=watchers,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=operator.kyma-project.io,resources=watchers/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=operator.kyma-project.io,resources=watchers/finalizers,verbs=update
// +kubebuilder:rbac:groups=networking.istio.io,resources=virtualservices,verbs=get;list;create;update;delete
// +kubebuilder:rbac:groups=networking.istio.io,resources=gateways,verbs=list;get;
// +kubebuilder:rbac:groups="",resources=secrets,verbs=get;list;watch;create;update;delete
// +kubebuilder:rbac:groups="",resources=configmaps,verbs=get;list;watch;create;update;patch;delete

// Reconcile is part of the main kubernetes reconciliation loop which aims to
// move the current state of the cluster closer to the desired state.
func (r *WatcherReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
	logger := logf.FromContext(ctx).WithName(req.NamespacedName.String())
	logger.V(log.DebugLevel).Info("Reconciliation loop starting")

	watcherObj := &v1beta2.Watcher{}
	if err := r.Get(ctx, client.ObjectKey{Name: req.Name, Namespace: req.Namespace}, watcherObj); err != nil {
		logger.V(log.DebugLevel).Info("Failed to get reconciliation object")
		if !util.IsNotFound(err) {
			return ctrl.Result{}, fmt.Errorf("watcherController: %w", err)
		}
		return ctrl.Result{Requeue: false}, nil
	}

	if !watcherObj.DeletionTimestamp.IsZero() && watcherObj.Status.State != shared.StateDeleting {
		return r.updateWatcherState(ctx, watcherObj, shared.StateDeleting, nil)
	}

	// check finalizer on native object
	if !controllerutil.ContainsFinalizer(watcherObj, shared.WatcherFinalizer) {
		finalizerAdded := controllerutil.AddFinalizer(watcherObj, shared.WatcherFinalizer)
		if !finalizerAdded {
			r.EventRecorder.Event(watcherObj, "Warning", "AddFinalizerErr",
				errAddingFinalizer.Error())
			return ctrl.Result{}, errAddingFinalizer
		}
		return ctrl.Result{Requeue: true}, r.updateFinalizer(ctx, watcherObj)
	}

	watcherObj.InitializeConditions()

	return r.stateHandling(ctx, watcherObj)
}

func (r *WatcherReconciler) updateFinalizer(ctx context.Context, watcherCR *v1beta2.Watcher) error {
	err := r.Client.Update(ctx, watcherCR)
	if err != nil {
		r.EventRecorder.Event(watcherCR, "Warning", "WatcherFinalizerErr",
			err.Error())
		return fmt.Errorf("failed to update finalizer: %w", err)
	}
	return nil
}

func (r *WatcherReconciler) stateHandling(ctx context.Context, watcherCR *v1beta2.Watcher) (ctrl.Result, error) {
	switch watcherCR.Status.State {
	case "":
		return r.updateWatcherState(ctx, watcherCR, shared.StateProcessing, nil)
	case shared.StateProcessing:
		return r.handleProcessingState(ctx, watcherCR)
	case shared.StateDeleting:
		return r.handleDeletingState(ctx, watcherCR)
	case shared.StateError:
		return r.handleProcessingState(ctx, watcherCR)
	case shared.StateReady, shared.StateWarning:
		return r.handleProcessingState(ctx, watcherCR)
	}

	return ctrl.Result{Requeue: false}, nil
}

func (r *WatcherReconciler) handleDeletingState(ctx context.Context, watcherCR *v1beta2.Watcher) (ctrl.Result, error) {
	err := r.IstioClient.DeleteVirtualService(ctx, watcherCR.GetName(), watcherCR.GetNamespace())
	if err != nil {
		vsConfigDelErr := fmt.Errorf("failed to delete virtual service (config): %w", err)
		return r.updateWatcherState(ctx, watcherCR, shared.StateError, vsConfigDelErr)
	}
	finalizerRemoved := controllerutil.RemoveFinalizer(watcherCR, shared.WatcherFinalizer)
	if !finalizerRemoved {
		return r.updateWatcherState(ctx, watcherCR, shared.StateError, errRemovingFinalizer)
	}
	return ctrl.Result{Requeue: true}, r.updateFinalizer(ctx, watcherCR)
}

func (r *WatcherReconciler) handleProcessingState(ctx context.Context,
	watcherCR *v1beta2.Watcher,
) (ctrl.Result, error) {
	gateways, err := r.IstioClient.ListGatewaysByLabelSelector(ctx, &watcherCR.Spec.Gateway.LabelSelector,
		r.IstioGatewayNamespace)
	if err != nil || len(gateways.Items) == 0 {
		r.EventRecorder.Event(watcherCR, "Warning", "WatcherGatewayNotFound",
			"Watcher: Gateway for the VirtualService not found")
		return r.updateWatcherState(ctx, watcherCR, shared.StateError, err)
	}

	virtualSvc, err := r.VirtualServiceFactory.NewVirtualService(watcherCR, gateways)
	if err != nil {
		return r.updateWatcherState(ctx, watcherCR, shared.StateError, err)
	}

	virtualSvcRemote, err := r.IstioClient.GetVirtualService(ctx, watcherCR.GetName(), watcherCR.GetNamespace())
	if client.IgnoreNotFound(err) != nil {
		return r.updateWatcherState(ctx, watcherCR, shared.StateError, err)
	}
	if util.IsNotFound(err) {
		err = r.IstioClient.CreateVirtualService(ctx, virtualSvc)
		if err != nil {
			vsCreateErr := fmt.Errorf("failed to create virtual service: %w", err)
			return r.updateWatcherState(ctx, watcherCR, shared.StateError, vsCreateErr)
		}
		return r.updateWatcherState(ctx, watcherCR, shared.StateReady, nil)
	}

	err = r.IstioClient.UpdateVirtualService(ctx, virtualSvc, virtualSvcRemote)
	if err != nil {
		vsUpdateErr := fmt.Errorf("failed to update virtual service: %w", err)
		return r.updateWatcherState(ctx, watcherCR, shared.StateError, vsUpdateErr)
	}
	return r.updateWatcherState(ctx, watcherCR, shared.StateReady, nil)
}

func (r *WatcherReconciler) updateWatcherState(ctx context.Context, watcherCR *v1beta2.Watcher,
	state shared.State, err error,
) (ctrl.Result, error) {
	watcherCR.Status.State = state
	if state == shared.StateReady {
		watcherCR.UpdateWatcherConditionStatus(v1beta2.WatcherConditionTypeVirtualService, apimetav1.ConditionTrue)
	} else if state == shared.StateError {
		watcherCR.UpdateWatcherConditionStatus(v1beta2.WatcherConditionTypeVirtualService, apimetav1.ConditionFalse)
	}
	if err != nil {
		r.EventRecorder.Event(watcherCR, "Warning", "WatcherStatusUpdate", err.Error())
	}
	requeueInterval := queue.DetermineRequeueInterval(state, r.RequeueIntervals)
	return ctrl.Result{RequeueAfter: requeueInterval}, r.updateWatcherStatusUsingSSA(ctx, watcherCR)
}

func (r *WatcherReconciler) updateWatcherStatusUsingSSA(ctx context.Context, watcher *v1beta2.Watcher) error {
	watcher.ManagedFields = nil
	err := r.Client.Status().Patch(ctx, watcher, client.Apply, client.FieldOwner(shared.OperatorName),
		status.SubResourceOpts(client.ForceOwnership))
	if err != nil {
		reason := "WatcherStatusUpdate"
		r.EventRecorder.Event(watcher, "Warning", reason, err.Error())
		return fmt.Errorf("%s failed: %w", reason, err)
	}
	return nil
}