extension.go

/*
Copyright 2020 The Tekton Authors

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 tektonconfig

import (
	"context"
	"fmt"
	"os"
	"path/filepath"

	mf "github.com/manifestival/manifestival"
	security "github.com/openshift/client-go/security/clientset/versioned"
	"github.com/tektoncd/operator/pkg/apis/operator/v1alpha1"
	"github.com/tektoncd/operator/pkg/client/clientset/versioned"
	operatorclient "github.com/tektoncd/operator/pkg/client/injection/client"
	pkgCommon "github.com/tektoncd/operator/pkg/common"
	"github.com/tektoncd/operator/pkg/reconciler/common"
	"github.com/tektoncd/operator/pkg/reconciler/openshift/tektonconfig/extension"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	nsV1 "k8s.io/client-go/informers/core/v1"
	rbacV1 "k8s.io/client-go/informers/rbac/v1"
	"k8s.io/client-go/kubernetes"
	kubeclient "knative.dev/pkg/client/injection/kube/client"
	namespaceinformer "knative.dev/pkg/client/injection/kube/informers/core/v1/namespace"
	rbacInformer "knative.dev/pkg/client/injection/kube/informers/rbac/v1/clusterrolebinding"
	"knative.dev/pkg/logging"
)

const (
	versionKey = "VERSION"
)

func OpenShiftExtension(ctx context.Context) common.Extension {
	logger := logging.FromContext(ctx)
	operatorVer, err := common.OperatorVersion(ctx)
	if err != nil {
		logger.Fatal(err)
	}

	ext := openshiftExtension{
		operatorClientSet: operatorclient.Get(ctx),
		kubeClientSet:     kubeclient.Get(ctx),
		rbacInformer:      rbacInformer.Get(ctx),
		nsInformer:        namespaceinformer.Get(ctx),
		securityClientSet: pkgCommon.GetSecurityClient(ctx),
		operatorVersion:   operatorVer,
	}

	ext.consolePluginReconciler = &consolePluginReconciler{
		resourcesYamlDirectory: filepath.Join(common.ComponentBaseDir(), consolePluginReconcileYamlDirectory),
		logger:                 logger,
		operatorClientSet:      ext.operatorClientSet,
		operatorVersion:        operatorVer,
	}

	return ext
}

type openshiftExtension struct {
	operatorClientSet       versioned.Interface
	kubeClientSet           kubernetes.Interface
	rbacInformer            rbacV1.ClusterRoleBindingInformer
	nsInformer              nsV1.NamespaceInformer
	consolePluginReconciler *consolePluginReconciler

	// OpenShift clientsets are a bit... special, we need to get each
	// clientset separately
	securityClientSet *security.Clientset

	operatorVersion string
}

func (oe openshiftExtension) Transformers(comp v1alpha1.TektonComponent) []mf.Transformer {
	return []mf.Transformer{
		// update namespace in pruner RBAC
		common.ReplaceNamespaceInServiceAccount(comp.GetSpec().GetTargetNamespace()),
		common.ReplaceNamespaceInClusterRoleBinding(comp.GetSpec().GetTargetNamespace()),
	}
}

func (oe openshiftExtension) PreReconcile(ctx context.Context, tc v1alpha1.TektonComponent) error {
	config := tc.(*v1alpha1.TektonConfig)
	r := rbac{
		kubeClientSet:     oe.kubeClientSet,
		operatorClientSet: oe.operatorClientSet,
		securityClientSet: oe.securityClientSet,
		rbacInformer:      oe.rbacInformer,
		nsInformer:        oe.nsInformer,
		version:           os.Getenv(versionKey),
		tektonConfig:      config,
	}

	// set openshift specific defaults
	r.setDefault()

	// below code helps to retain state of pre-existing SA at the time of upgrade
	if existingSAWithOwnerRef(r.tektonConfig) {
		if err := changeOwnerRefOfPreExistingSA(ctx, r.kubeClientSet, *config); err != nil {
			return err
		}
		tcLabels := config.GetLabels()
		tcLabels[serviceAccountCreationLabel] = "true"
		config.SetLabels(tcLabels)
		if _, err := oe.operatorClientSet.OperatorV1alpha1().TektonConfigs().Update(ctx, config, metav1.UpdateOptions{}); err != nil {
			return err
		}
	}

	createRBACResource := true
	for _, v := range config.Spec.Params {
		// check for param name and if its matches to createRbacResource
		// then disable auto creation of RBAC resources by deleting installerSet
		if v.Name == rbacParamName && v.Value == "false" {
			createRBACResource = false
			if err := deleteInstallerSet(ctx, r.operatorClientSet, r.tektonConfig, componentNameRBAC); err != nil {
				return err
			}
			// remove openshift-pipelines.tekton.dev/namespace-reconcile-version label from namespaces while deleting RBAC resources.
			if err := r.cleanUp(ctx); err != nil {
				return err
			}
		}
	}

	// TODO: Remove this after v0.55.0 release, by following a depreciation notice
	// --------------------
	if err := r.cleanUpRBACNameChange(ctx); err != nil {
		return err
	}
	// --------------------

	if createRBACResource {
		return r.createResources(ctx)
	}
	return nil
}

func (oe openshiftExtension) PostReconcile(ctx context.Context, comp v1alpha1.TektonComponent) error {
	configInstance := comp.(*v1alpha1.TektonConfig)

	if configInstance.Spec.Profile == v1alpha1.ProfileAll {
		if _, err := extension.EnsureTektonAddonExists(ctx, oe.operatorClientSet.OperatorV1alpha1().TektonAddons(), configInstance, oe.operatorVersion); err != nil {
			configInstance.Status.MarkComponentNotReady(fmt.Sprintf("TektonAddon: %s", err.Error()))
			return v1alpha1.REQUEUE_EVENT_AFTER
		}
	}
	if configInstance.Spec.Profile == v1alpha1.ProfileLite || configInstance.Spec.Profile == v1alpha1.ProfileBasic {
		if err := extension.EnsureTektonAddonCRNotExists(ctx, oe.operatorClientSet.OperatorV1alpha1().TektonAddons()); err != nil {
			return err
		}
	}

	pac := configInstance.Spec.Platforms.OpenShift.PipelinesAsCode
	if pac != nil && *pac.Enable {
		if _, err := extension.EnsureOpenShiftPipelinesAsCodeExists(ctx, oe.operatorClientSet.OperatorV1alpha1().OpenShiftPipelinesAsCodes(), configInstance, oe.operatorVersion); err != nil {
			configInstance.Status.MarkComponentNotReady(fmt.Sprintf("OpenShiftPipelinesAsCode: %s", err.Error()))
			return v1alpha1.REQUEUE_EVENT_AFTER
		}
	} else {
		if err := extension.EnsureOpenShiftPipelinesAsCodeCRNotExists(ctx, oe.operatorClientSet.OperatorV1alpha1().OpenShiftPipelinesAsCodes()); err != nil {
			return err
		}
	}

	// execute console plugin reconciler
	return oe.consolePluginReconciler.reconcile(ctx, configInstance)
}

func (oe openshiftExtension) Finalize(ctx context.Context, comp v1alpha1.TektonComponent) error {
	configInstance := comp.(*v1alpha1.TektonConfig)
	if configInstance.Spec.Profile == v1alpha1.ProfileAll {
		if err := extension.EnsureTektonAddonCRNotExists(ctx, oe.operatorClientSet.OperatorV1alpha1().TektonAddons()); err != nil {
			return err
		}
	}
	if configInstance.Spec.Platforms.OpenShift.PipelinesAsCode != nil && *configInstance.Spec.Platforms.OpenShift.PipelinesAsCode.Enable {
		if err := extension.EnsureOpenShiftPipelinesAsCodeCRNotExists(ctx, oe.operatorClientSet.OperatorV1alpha1().OpenShiftPipelinesAsCodes()); err != nil {
			return err
		}
	}

	r := rbac{
		kubeClientSet: oe.kubeClientSet,
		version:       os.Getenv(versionKey),
	}
	return r.cleanUp(ctx)
}

// configOwnerRef returns owner reference pointing to passed instance
func configOwnerRef(tc v1alpha1.TektonInstallerSet) metav1.OwnerReference {
	return *metav1.NewControllerRef(&tc, tc.GetGroupVersionKind())
}

// tektonConfigOwnerRef returns owner reference of tektonConfig
func tektonConfigOwnerRef(tc v1alpha1.TektonConfig) metav1.OwnerReference {
	return *metav1.NewControllerRef(&tc, tc.GetGroupVersionKind())
}

func changeOwnerRefOfPreExistingSA(ctx context.Context, kc kubernetes.Interface, tc v1alpha1.TektonConfig) error {
	allSAs, err := kc.CoreV1().ServiceAccounts("").List(ctx, metav1.ListOptions{})
	if err != nil {
		return err
	}
	for _, sa := range allSAs.Items {
		if sa.Name == "pipeline" && !nsRegex.MatchString(sa.Namespace) {
			// set tektonconfig ownerRef
			tcOwnerRef := tektonConfigOwnerRef(tc)
			sa.SetOwnerReferences([]metav1.OwnerReference{tcOwnerRef})
			if _, err := kc.CoreV1().ServiceAccounts(sa.Namespace).Update(ctx, &sa, metav1.UpdateOptions{}); err != nil {
				return err
			}
		}
	}
	return nil
}

// existingSAWithOwnerRef checks if openshift-pipelines.tekton.dev/sa-created label is present on tektonconfig
// we add this label from pipelines 1.8, and do not add tektoninstaller set as owner of serviceaccount created
// if label not present it means SA was created earlier and we need to remove ownerRef before we do the update
// this helps us to keep pre-existing SA as it is.
func existingSAWithOwnerRef(tc *v1alpha1.TektonConfig) bool {
	tcLabels := tc.GetLabels()
	_, ok := tcLabels[serviceAccountCreationLabel]
	return !ok
}