main.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 main

import (
	"context"
	"flag"
	"fmt"
	"os"
	"runtime"
	"strings"

	// Import all Kubernetes client auth plugins (e.g. Azure, GCP, OIDC, etc.)
	// to ensure that exec-entrypoint and run can make use of them.
	_ "k8s.io/client-go/plugin/pkg/client/auth"

	apiruntime "k8s.io/apimachinery/pkg/runtime"
	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
	clientgoscheme "k8s.io/client-go/kubernetes/scheme"
	ctrl "sigs.k8s.io/controller-runtime"
	"sigs.k8s.io/controller-runtime/pkg/healthz"
	logf "sigs.k8s.io/controller-runtime/pkg/log"
	"sigs.k8s.io/controller-runtime/pkg/log/zap"

	"github.com/openshift/must-gather-operator/config"
	"github.com/openshift/must-gather-operator/version"
	osdmetrics "github.com/openshift/operator-custom-metrics/pkg/metrics"
	"github.com/operator-framework/operator-lib/leader"
	"github.com/redhat-cop/operator-utils/pkg/util"

	v1 "github.com/openshift/api/config/v1"
	imagev1 "github.com/openshift/api/image/v1"
	managedv1alpha1 "github.com/openshift/must-gather-operator/api/v1alpha1"
	"github.com/openshift/must-gather-operator/controllers/mustgather"
	"github.com/openshift/must-gather-operator/pkg/k8sutil"
	"github.com/openshift/must-gather-operator/pkg/localmetrics"
	metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
	//+kubebuilder:scaffold:imports
)

const (
	// Environment variable to determine operator run mode
	ForceRunModeEnv = "OSDK_FORCE_RUN_MODE"
	// Flags that the operator is running locally
	LocalRunMode = "local"
)

var (
	scheme   = apiruntime.NewScheme()
	setupLog = ctrl.Log.WithName("setup")
)

// Change below variables to serve metrics on different host or port.
var (
	metricsPort = "8080"
	metricsPath = "/metrics"
)

var log = logf.Log.WithName("cmd")

func printVersion() {
	log.Info("Operator Version", "version", version.Version)
	log.Info("Go Version", "goVersion", runtime.Version())
	log.Info("Go OS/Arch", "goOS", runtime.GOOS, "goArch", runtime.GOARCH)
	log.Info("SDK Version", "sdkVersion", version.SDKVersion)
}

func init() {
	utilruntime.Must(clientgoscheme.AddToScheme(scheme))
	utilruntime.Must(v1.AddToScheme(scheme))
	utilruntime.Must(imagev1.AddToScheme(scheme))
	utilruntime.Must(managedv1alpha1.AddToScheme(scheme))
	//+kubebuilder:scaffold:scheme
}

func main() {
	// var metricsAddr string
	var enableLeaderElection bool
	var probeAddr string
	var trustedCAConfigMapName string
	// flag.StringVar(&metricsAddr, "metrics-bind-address", ":8080", "The address the metric endpoint binds to.")
	flag.StringVar(&probeAddr, "health-probe-bind-address", ":8081", "The address the probe endpoint binds to.")
	flag.BoolVar(&enableLeaderElection, "leader-elect", false,
		"Enable leader election for controller manager. "+
			"Enabling this will ensure there is only one active controller manager.")
	flag.StringVar(&trustedCAConfigMapName, "trusted-ca-configmap", "", // empty by default, disables trusted CA behaviour.
		"Name of the ConfigMap containing the trusted CA certificate bundle, default: disabled. "+
			"No CA config map will be explicitly mounted on Job pods if unset.")
	opts := zap.Options{
		Development: true,
	}
	opts.BindFlags(flag.CommandLine)
	flag.Parse()

	ctrl.SetLogger(zap.New(zap.UseFlagOptions(&opts)))

	printVersion()

	options := ctrl.Options{
		Scheme: scheme,
		Metrics: metricsserver.Options{
			BindAddress: "0",
		},
		HealthProbeBindAddress: probeAddr,
		LeaderElection:         enableLeaderElection,
		LeaderElectionID:       "b15e5fc1.openshift.io",
	}

	mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), options)
	if err != nil {
		setupLog.Error(err, "unable to start manager")
		os.Exit(1)
	}

	ctx := context.TODO()

	// Become the leader before proceeding
	// This doesn't work locally, so only perform it when running on-cluster
	if strings.ToLower(os.Getenv(ForceRunModeEnv)) != LocalRunMode {
		err = leader.Become(ctx, "must-gather-operator-lock")
		if err != nil {
			log.Error(err, "")
			os.Exit(1)
		}
	} else {
		setupLog.Info("bypassing leader election due to local execution")
	}

	// Get operator namespace for metrics and reconciler
	operatorNamespace, err := k8sutil.GetOperatorNamespace()
	if err != nil {
		if err != k8sutil.ErrRunLocal {
			log.Error(err, "Failed to get operator namespace")
			os.Exit(1)
		}

		// when OSDK_FORCE_RUN_MODE is local, use "default" namespace
		operatorNamespace = mustgather.DefaultMustGatherNamespace
	}

	// Get default must-gather image from environment
	defaultMustGatherImage, varPresent := os.LookupEnv(mustgather.DefaultMustGatherImageEnv)
	if !varPresent {
		setupLog.Error(fmt.Errorf("environment variable %s not found", mustgather.DefaultMustGatherImageEnv), "unable to start manager")
		os.Exit(1)
	}

	// Discover the operator's service account name via the Downward API
	// (OPERATOR_SERVICE_ACCOUNT env var set from spec.serviceAccountName).
	// Falls back to config.OperatorName in local mode only.
	operatorSAName := os.Getenv("OPERATOR_SERVICE_ACCOUNT")
	if operatorSAName == "" {
		if strings.ToLower(os.Getenv(ForceRunModeEnv)) == LocalRunMode {
			operatorSAName = config.OperatorName
		} else {
			setupLog.Error(fmt.Errorf("OPERATOR_SERVICE_ACCOUNT environment variable not set"), "unable to discover operator service account")
			os.Exit(1)
		}
	}
	setupLog.Info("operator service account", "name", operatorSAName)

	if err = (&mustgather.MustGatherReconciler{
		ReconcilerBase:             util.NewReconcilerBase(mgr.GetClient(), mgr.GetScheme(), mgr.GetConfig(), mgr.GetEventRecorderFor("must-gather-controller"), mgr.GetAPIReader()),
		TrustedCAConfigMap:         trustedCAConfigMapName,
		OperatorNamespace:          operatorNamespace,
		DefaultMustGatherImage:     defaultMustGatherImage,
		OperatorServiceAccountName: operatorSAName,
	}).SetupWithManager(mgr); err != nil {
		setupLog.Error(err, "unable to create controller", "controller", "MustGather")
		os.Exit(1)
	}

	metricsServer := osdmetrics.NewBuilder(operatorNamespace, config.OperatorName).
		WithPort(metricsPort).
		WithPath(metricsPath).
		WithCollectors(localmetrics.MetricsList).
		WithServiceMonitor().
		GetConfig()

	if err := osdmetrics.ConfigureMetrics(ctx, *metricsServer); err != nil {
		log.Error(err, "Failed to configure OSD metrics")
	}

	//+kubebuilder:scaffold:builder

	if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil {
		setupLog.Error(err, "unable to set up health check")
		os.Exit(1)
	}
	if err := mgr.AddReadyzCheck("readyz", healthz.Ping); err != nil {
		setupLog.Error(err, "unable to set up ready check")
		os.Exit(1)
	}

	setupLog.Info("starting manager")
	if err := mgr.Start(ctrl.SetupSignalHandler()); err != nil {
		setupLog.Error(err, "problem running manager")
		os.Exit(1)
	}
}