che-operator/main.go

414 lines
14 KiB
Go

//
// Copyright (c) 2019-2021 Red Hat, Inc.
// This program and the accompanying materials are made
// available under the terms of the Eclipse Public License 2.0
// which is available at https://www.eclipse.org/legal/epl-2.0/
//
// SPDX-License-Identifier: EPL-2.0
//
// Contributors:
// Red Hat, Inc. - initial API and implementation
//
package main
import (
"flag"
"os"
"time"
"github.com/devfile/devworkspace-operator/pkg/infrastructure"
devworkspaceinfra "github.com/devfile/devworkspace-operator/pkg/infrastructure"
"github.com/eclipse-che/che-operator/pkg/common/constants"
defaults "github.com/eclipse-che/che-operator/pkg/common/operator-defaults"
"github.com/eclipse-che/che-operator/pkg/common/signal"
"github.com/eclipse-che/che-operator/pkg/common/test"
"github.com/sirupsen/logrus"
dwoApi "github.com/devfile/devworkspace-operator/apis/controller/v1alpha1"
dwr "github.com/devfile/devworkspace-operator/controllers/controller/devworkspacerouting"
"github.com/eclipse-che/che-operator/controllers/devworkspace"
"github.com/eclipse-che/che-operator/controllers/devworkspace/solver"
"github.com/eclipse-che/che-operator/controllers/usernamespace"
"go.uber.org/zap/zapcore"
// 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/discovery"
_ "k8s.io/client-go/plugin/pkg/client/auth"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/selection"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/cache"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/healthz"
"sigs.k8s.io/controller-runtime/pkg/log/zap"
osruntime "runtime"
"fmt"
"github.com/go-logr/logr"
configv1 "github.com/openshift/api/config/v1"
consolev1 "github.com/openshift/api/console/v1"
oauthv1 "github.com/openshift/api/oauth/v1"
checontroller "github.com/eclipse-che/che-operator/controllers/che"
"github.com/eclipse-che/che-operator/pkg/common/utils"
admissionregistrationv1 "k8s.io/api/admissionregistration/v1"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
clientgoscheme "k8s.io/client-go/kubernetes/scheme"
operatorsv1 "github.com/operator-framework/api/pkg/operators/v1"
operatorsv1alpha1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
packagesv1 "github.com/operator-framework/operator-lifecycle-manager/pkg/package-server/apis/operators/v1"
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
image_puller_api "github.com/che-incubator/kubernetes-image-puller-operator/api/v1alpha1"
projectv1 "github.com/openshift/api/project/v1"
routev1 "github.com/openshift/api/route/v1"
userv1 "github.com/openshift/api/user/v1"
appsv1 "k8s.io/api/apps/v1"
batchv1 "k8s.io/api/batch/v1"
corev1 "k8s.io/api/core/v1"
networkingv1 "k8s.io/api/networking/v1"
rbacv1 "k8s.io/api/rbac/v1"
chev1 "github.com/eclipse-che/che-operator/api/v1"
chev2 "github.com/eclipse-che/che-operator/api/v2"
//+kubebuilder:scaffold:imports
)
var (
scheme = runtime.NewScheme()
setupLog = ctrl.Log.WithName("setup")
defaultsPath string
metricsAddr string
enableLeaderElection bool
probeAddr string
leaseDuration = 40 * time.Second
renewDeadline = 30 * time.Second
)
const (
leasesApiResourceName = "leases"
)
func init() {
flag.StringVar(&defaultsPath, "defaults-path", "", "Path to file with operator deployment defaults. This option is useful for local development.")
flag.StringVar(&metricsAddr, "metrics-bind-address", ":60000", "The address the metric endpoint binds to.")
flag.StringVar(&probeAddr, "health-probe-bind-address", ":6789", "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.")
opts := zap.Options{
Development: true,
Level: getLogLevel(),
}
opts.BindFlags(flag.CommandLine)
flag.Parse()
logger := zap.New(zap.UseFlagOptions(&opts))
ctrl.SetLogger(logger)
if err := infrastructure.Initialize(); err != nil {
logger.Error(err, "Unable determine installation platform")
os.Exit(1)
}
defaults.Initialize(defaultsPath)
printVersion(logger)
utilruntime.Must(chev1.AddToScheme(scheme))
utilruntime.Must(chev2.AddToScheme(scheme))
//+kubebuilder:scaffold:scheme
utilruntime.Must(clientgoscheme.AddToScheme(scheme))
utilruntime.Must(admissionregistrationv1.AddToScheme(scheme))
utilruntime.Must(apiextensionsv1.AddToScheme(scheme))
utilruntime.Must(rbacv1.AddToScheme(scheme))
// Setup Scheme for all resources
utilruntime.Must(image_puller_api.AddToScheme(scheme))
utilruntime.Must(packagesv1.AddToScheme(scheme))
utilruntime.Must(operatorsv1alpha1.AddToScheme(scheme))
utilruntime.Must(operatorsv1.AddToScheme(scheme))
if infrastructure.IsOpenShift() {
utilruntime.Must(routev1.AddToScheme(scheme))
utilruntime.Must(oauthv1.AddToScheme(scheme))
utilruntime.Must(userv1.AddToScheme(scheme))
utilruntime.Must(configv1.AddToScheme(scheme))
utilruntime.Must(corev1.AddToScheme(scheme))
utilruntime.Must(consolev1.AddToScheme(scheme))
utilruntime.Must(projectv1.AddToScheme(scheme))
}
}
func getLogLevel() zapcore.Level {
switch logLevel, _ := os.LookupEnv("LOG_LEVEL"); logLevel {
case zapcore.DebugLevel.String():
return zapcore.DebugLevel
case zapcore.InfoLevel.String():
return zapcore.InfoLevel
case zapcore.WarnLevel.String():
return zapcore.WarnLevel
case zapcore.ErrorLevel.String():
return zapcore.ErrorLevel
case zapcore.PanicLevel.String():
return zapcore.PanicLevel
default:
return zapcore.InfoLevel
}
}
func printVersion(logger logr.Logger) {
logger.Info("Binary info ", "Go version", osruntime.Version())
logger.Info("Binary info ", "OS", osruntime.GOOS, "Arch", osruntime.GOARCH)
logger.Info("Address ", "Metrics", metricsAddr)
logger.Info("Address ", "Probe", probeAddr)
infra := "Kubernetes"
if infrastructure.IsOpenShift() {
infra = "OpenShift v4.x"
}
logger.Info("Operator is running on ", "Infrastructure", infra)
}
// getWatchNamespace returns the Namespace the operator should be watching for changes
func getWatchNamespace() (string, error) {
// WatchNamespaceEnvVar is the constant for env variable WATCH_NAMESPACE
// which specifies the Namespace to watch.
// An empty value means the operator is running with cluster scope.
var watchNamespaceEnvVar = "WATCH_NAMESPACE"
ns, found := os.LookupEnv(watchNamespaceEnvVar)
if !found {
return "", fmt.Errorf("%s must be set", watchNamespaceEnvVar)
}
return ns, nil
}
func main() {
watchNamespace, err := getWatchNamespace()
if err != nil {
setupLog.Error(err, "unable to get WatchNamespace, "+
"the manager will watch and manage resources in all namespaces")
}
config := ctrl.GetConfigOrDie()
discoveryClient, err := discovery.NewDiscoveryClientForConfig(config)
if err != nil {
setupLog.Error(err, "failed to create discovery client")
os.Exit(1)
}
if !utils.IsK8SResourceServed(discoveryClient, leasesApiResourceName) {
setupLog.Info("Leader election was disabled", "Cause:", leasesApiResourceName+"k8s api resource is an absent.")
enableLeaderElection = false
}
cacheFunction, err := getCacheFunc()
if err != nil {
setupLog.Error(err, "failed to create cache function")
os.Exit(1)
}
mgr, err := ctrl.NewManager(config, ctrl.Options{
Scheme: scheme,
MetricsBindAddress: metricsAddr,
Port: 9443,
HealthProbeBindAddress: probeAddr,
LeaderElection: enableLeaderElection,
LeaderElectionID: "e79b08a4.org.eclipse.che",
LeaderElectionReleaseOnCancel: true,
LeaseDuration: &leaseDuration,
RenewDeadline: &renewDeadline,
NewCache: cacheFunction,
// NOTE: We CANNOT limit the manager to a single namespace, because that would limit the
// devworkspace routing reconciler to a single namespace, which would make it totally unusable.
// Instead, if some controller wants to limit itself to single namespace, it can do it
// for example using an event filter, as checontroller does.
// Namespace: watchNamespace,
})
if err != nil {
setupLog.Error(err, "unable to start manager")
os.Exit(1)
}
nonCachingClient, err := client.New(mgr.GetConfig(), client.Options{Scheme: scheme})
if err != nil {
setupLog.Error(err, "unable to initialize non cached client")
os.Exit(1)
}
cheReconciler := checontroller.NewReconciler(mgr.GetClient(), nonCachingClient, discoveryClient, mgr.GetScheme(), watchNamespace)
if err = cheReconciler.SetupWithManager(mgr); err != nil {
setupLog.Error(err, "unable to set up controller", "controller", "CheCluster")
os.Exit(1)
}
terminationPeriod := int64(20)
if !test.IsTestMode() {
namespace, err := infrastructure.GetOperatorNamespace()
if err == nil {
terminationPeriod = signal.GetTerminationGracePeriodSeconds(mgr.GetAPIReader(), namespace)
}
}
sigHandler := signal.SetupSignalHandler(terminationPeriod)
// we install the devworkspace CheCluster reconciler even if dw is not supported so that it
// can write meaningful status messages into the CheCluster CRs.
dwChe := devworkspace.CheClusterReconciler{}
if err := dwChe.SetupWithManager(mgr); err != nil {
setupLog.Error(err, "unable to set up devWorkspace controller", "controller", "DevWorkspaceReconciler")
os.Exit(1)
}
shouldDevWorkspaceBeEnabled, err := devworkspace.ShouldDevWorkspacesBeEnabled(mgr)
if err != nil {
setupLog.Error(err, "Failed to evaluate DevWorkspace mode state", "controller", "DevWorkspaceReconciler")
os.Exit(1)
}
if shouldDevWorkspaceBeEnabled {
if err := dwoApi.AddToScheme(mgr.GetScheme()); err != nil {
setupLog.Error(err, "failed to register DevWorkspace API Scheme", "controller", "DevWorkspace")
os.Exit(1)
}
// DWO use the infrastructure package for openshift detection. It needs to be initialized
// but only supports OpenShift v4 or Kubernetes.
if err := devworkspaceinfra.Initialize(); err != nil {
setupLog.Error(err, "failed to evaluate infrastructure which is needed for DevWorkspace support")
os.Exit(1)
}
routing := dwr.DevWorkspaceRoutingReconciler{
Client: mgr.GetClient(),
Log: ctrl.Log.WithName("controllers").WithName("DevWorkspaceRouting"),
Scheme: mgr.GetScheme(),
SolverGetter: solver.Getter(mgr.GetScheme()),
}
if err := routing.SetupWithManager(mgr); err != nil {
setupLog.Error(err, "unable to set up controller", "controller", "DevWorkspaceRouting")
os.Exit(1)
}
userNamespaceReconciler := usernamespace.NewReconciler()
if err = userNamespaceReconciler.SetupWithManager(mgr); err != nil {
setupLog.Error(err, "unable to set up controller", "controller", "CheUserReconciler")
os.Exit(1)
}
setupLog.Info("DevWorkspace support enabled.")
} else {
setupLog.Info("DevWorkspace support disabled. Will initiate restart when CheCluster with devworkspaces enabled will appear")
go devworkspace.NotifyWhenDevWorkspaceEnabled(mgr, sigHandler.Done(), func() {
setupLog.Info("CheCluster with DevWorkspace enabled discovered. Restarting to activate DevWorkspaces mode")
os.Exit(0)
})
}
if os.Getenv("ENABLE_WEBHOOKS") != "false" {
if err = (&chev2.CheCluster{}).SetupWebhookWithManager(mgr); err != nil {
setupLog.Error(err, "unable to create webhook", "webhook", "CheCluster")
os.Exit(1)
}
}
// +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)
}
// Start the Cmd
setupLog.Info("starting manager")
if err := mgr.Start(sigHandler); err != nil {
setupLog.Error(err, "problem running manager")
os.Exit(1)
}
}
func getCacheFunc() (cache.NewCacheFunc, error) {
partOfCheRequirement, err := labels.NewRequirement(constants.KubernetesPartOfLabelKey, selection.Equals, []string{constants.CheEclipseOrg})
if err != nil {
return nil, err
}
partOfCheObjectSelector := labels.NewSelector().Add(*partOfCheRequirement)
logrus.Infof("Limit cache by selector: %s", partOfCheObjectSelector.String())
routeKey := &routev1.Route{}
oauthKey := &oauthv1.OAuthClient{}
selectors := cache.SelectorsByObject{
&appsv1.Deployment{}: {
Label: partOfCheObjectSelector,
},
&corev1.Pod{}: {
Label: partOfCheObjectSelector,
},
&batchv1.Job{}: {
Label: partOfCheObjectSelector,
},
&corev1.Service{}: {
Label: partOfCheObjectSelector,
},
&networkingv1.Ingress{}: {
Label: partOfCheObjectSelector,
},
routeKey: {
Label: partOfCheObjectSelector,
},
&corev1.ConfigMap{}: {
Label: partOfCheObjectSelector,
},
&corev1.Secret{}: {
Label: partOfCheObjectSelector,
},
&corev1.ServiceAccount{}: {
Label: partOfCheObjectSelector,
},
&rbacv1.Role{}: {
Label: partOfCheObjectSelector,
},
&rbacv1.RoleBinding{}: {
Label: partOfCheObjectSelector,
},
&rbacv1.ClusterRole{}: {
Label: partOfCheObjectSelector,
},
&rbacv1.ClusterRoleBinding{}: {
Label: partOfCheObjectSelector,
},
&corev1.PersistentVolumeClaim{}: {
Label: partOfCheObjectSelector,
},
oauthKey: {
Label: partOfCheObjectSelector,
},
}
if !infrastructure.IsOpenShift() {
delete(selectors, routeKey)
delete(selectors, oauthKey)
}
return cache.BuilderWithOptions(cache.Options{
SelectorsByObject: selectors,
}), nil
}