cozystack/cmd/cozystack-controller/main.go

/*
Copyright 2025.

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 (
	"crypto/tls"
	"flag"
	"os"
	"time"

	// 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"

	corev1 "k8s.io/api/core/v1"
	"k8s.io/apimachinery/pkg/fields"
	"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/cache"
	"sigs.k8s.io/controller-runtime/pkg/client"
	"sigs.k8s.io/controller-runtime/pkg/log/zap"
	"sigs.k8s.io/controller-runtime/pkg/metrics/filters"
	metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
	"sigs.k8s.io/controller-runtime/pkg/webhook"

	gatewayv1alpha1 "github.com/cozystack/cozystack/api/gateway/v1alpha1"
	gpuv1alpha1 "github.com/cozystack/cozystack/api/gpu/v1alpha1"
	internalv1alpha1 "github.com/cozystack/cozystack/api/internalapi/v1alpha1"
	cozystackiov1alpha1 "github.com/cozystack/cozystack/api/v1alpha1"
	"github.com/cozystack/cozystack/internal/controller"
	"github.com/cozystack/cozystack/internal/controller/wildcardsecret"
	"github.com/cozystack/cozystack/internal/gpu"
	"github.com/cozystack/cozystack/internal/gpu/model"
	"github.com/cozystack/cozystack/internal/telemetry"

	cmv1 "github.com/cert-manager/cert-manager/pkg/apis/certmanager/v1"
	helmv2 "github.com/fluxcd/helm-controller/api/v2"
	cosiv1alpha1 "sigs.k8s.io/container-object-storage-interface-api/apis/objectstorage/v1alpha1"
	gatewayv1 "sigs.k8s.io/gateway-api/apis/v1"
	gatewayv1alpha2 "sigs.k8s.io/gateway-api/apis/v1alpha2"
	gatewayv1beta1 "sigs.k8s.io/gateway-api/apis/v1beta1"
	// +kubebuilder:scaffold:imports
)

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

func init() {
	utilruntime.Must(clientgoscheme.AddToScheme(scheme))

	utilruntime.Must(cozystackiov1alpha1.AddToScheme(scheme))
	utilruntime.Must(gatewayv1alpha1.AddToScheme(scheme))
	utilruntime.Must(gpuv1alpha1.AddToScheme(scheme))
	utilruntime.Must(internalv1alpha1.AddToScheme(scheme))
	utilruntime.Must(gatewayv1.Install(scheme))
	utilruntime.Must(gatewayv1alpha2.Install(scheme))
	utilruntime.Must(gatewayv1beta1.Install(scheme))
	utilruntime.Must(cmv1.AddToScheme(scheme))
	utilruntime.Must(helmv2.AddToScheme(scheme))
	utilruntime.Must(cosiv1alpha1.AddToScheme(scheme))
	// +kubebuilder:scaffold:scheme
}

func main() {
	var metricsAddr string
	var enableLeaderElection bool
	var probeAddr string
	var secureMetrics bool
	var enableHTTP2 bool
	var disableTelemetry bool
	var telemetryEndpoint string
	var telemetryInterval string
	var quotaBufferPercent int64
	var seaweedfsMetricsEndpoint string
	var tlsOpts []func(*tls.Config)
	var gpuCfg gpu.Config
	var gpuResourceNames, gpuRawResourceNames string
	var gpuOnly bool
	var leaderElectionID string
	flag.StringVar(&metricsAddr, "metrics-bind-address", "0", "The address the metrics endpoint binds to. "+
		"Use :8443 for HTTPS or :8080 for HTTP, or leave as 0 to disable the metrics service.")
	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(&leaderElectionID, "leader-election-id", defaultLeaderElectionID,
		"Name of the leader election Lease, in the controller's own namespace.")
	flag.BoolVar(&secureMetrics, "metrics-secure", true,
		"If set, the metrics endpoint is served securely via HTTPS. Use --metrics-secure=false to use HTTP instead.")
	flag.BoolVar(&enableHTTP2, "enable-http2", false,
		"If set, HTTP/2 will be enabled for the metrics and webhook servers")
	flag.BoolVar(&disableTelemetry, "disable-telemetry", false,
		"Disable telemetry collection")
	flag.StringVar(&telemetryEndpoint, "telemetry-endpoint", "https://telemetry.cozystack.io",
		"Endpoint for sending telemetry data")
	flag.StringVar(&telemetryInterval, "telemetry-interval", "15m",
		"Interval between telemetry data collection (e.g. 15m, 1h)")
	flag.Int64Var(&quotaBufferPercent, "tenant-quota-buffer-percent", 0,
		"Temporary buffer (e.g. 130 = +30%) added to every hierarchical tenant quota pool so workloads already over a freshly-introduced quota keep running during rollout. 0 disables it.")
	flag.StringVar(&seaweedfsMetricsEndpoint, "seaweedfs-metrics-endpoint", "",
		"Base URL of a Prometheus-compatible query API to fetch SeaweedFS bucket size metrics from, e.g. https://vm.example.com/path/to/prometheus (/api/v1/query is appended). "+
			"Overrides discovery via the namespace.cozystack.io/monitoring label; use when SeaweedFS and the monitoring stack that scrapes it run in a separate cluster. "+
			"Basic auth may be embedded as userinfo (https://user:pass@host/...). Empty keeps label-based discovery.")
	flag.BoolVar(&gpuCfg.Enabled, "enable-gpu", false,
		"Enable the GPU features that need KubeVirt, such as GPUDevice placement. GPU finalizers and usage records run without it.")
	flag.StringVar(&gpuResourceNames, "gpu-resource-names", "",
		"Comma-separated GPU resource names besides those of GPUClasses and the node agents (gpu.resourceNames).")
	flag.StringVar(&gpuRawResourceNames, "gpu-raw-resource-names", string(gpu.RawNamesAllowed),
		"Whether VMs and pods may request GPU resource names directly: allowed or forbidden (gpu.rawResourceNames).")
	flag.DurationVar(&gpuCfg.LostCapacityGrace, "gpu-lost-capacity-grace", 5*time.Minute,
		"How long a GPU node stays NotReady, or serves fewer units of a GPU resource than its devices hold, before those devices move.")
	flag.DurationVar(&gpuCfg.AttachmentGrace, "gpu-attachment-grace", 2*time.Minute,
		"How long a GPUDevice attachment waits for its VMI to appear; must exceed the API server request timeout.")
	flag.BoolVar(&gpuOnly, "gpu-only", false,
		"Run only the GPU binder, its webhooks and probes. Needs --enable-gpu. Meant to run beside a cozystack-controller built without the GPU binder: "+
			"beside one built from this tree, two binders would run, so enable GPU on that one instead. "+
			"That older controller's WorkloadMonitor still counts device GPUs on virt-launcher pods, so a VM an application monitor covers is counted twice.")
	opts := zap.Options{
		Development: false,
	}
	opts.BindFlags(flag.CommandLine)
	flag.Parse()
	ctrl.SetLogger(zap.New(zap.UseFlagOptions(&opts)))

	// Parse telemetry interval
	interval, err := time.ParseDuration(telemetryInterval)
	if err != nil {
		setupLog.Error(err, "invalid telemetry interval")
		os.Exit(1)
	}

	// Validate and normalize the SeaweedFS metrics endpoint override; the sizes
	// it serves feed billing, so a malformed URL must fail startup, not queries.
	if seaweedfsMetricsEndpoint != "" {
		seaweedfsMetricsEndpoint, err = controller.ParseMetricsEndpointURL(seaweedfsMetricsEndpoint)
		if err != nil {
			setupLog.Error(err, "invalid --seaweedfs-metrics-endpoint")
			os.Exit(1)
		}
	}

	gpuCfg.ResourceNames = model.ParseResourceNames(gpuResourceNames)
	gpuCfg.RawResourceNames = gpu.RawNamesPolicy(gpuRawResourceNames)
	if gpuCfg.RawResourceNames == "" {
		gpuCfg.RawResourceNames = gpu.RawNamesAllowed
	}
	if gpuCfg.LostCapacityGrace <= 0 || gpuCfg.AttachmentGrace <= 0 {
		setupLog.Error(nil, "--gpu-lost-capacity-grace and --gpu-attachment-grace must be positive")
		os.Exit(1)
	}
	if gpuCfg.RawResourceNames != gpu.RawNamesAllowed && gpuCfg.RawResourceNames != gpu.RawNamesForbidden {
		setupLog.Error(nil, "invalid --gpu-raw-resource-names, want allowed or forbidden", "value", gpuRawResourceNames)
		os.Exit(1)
	}
	if err := validateGPUOnly(gpuOnly, gpuCfg.Enabled, enableLeaderElection, leaderElectionID); err != nil {
		setupLog.Error(err, "invalid flags")
		os.Exit(1)
	}

	// Configure telemetry
	telemetryConfig := telemetry.Config{
		Disabled: disableTelemetry,
		Endpoint: telemetryEndpoint,
		Interval: interval,
	}

	// if the enable-http2 flag is false (the default), http/2 should be disabled
	// due to its vulnerabilities. More specifically, disabling http/2 will
	// prevent from being vulnerable to the HTTP/2 Stream Cancellation and
	// Rapid Reset CVEs. For more information see:
	// - https://github.com/advisories/GHSA-qppj-fm5r-hxr3
	// - https://github.com/advisories/GHSA-4374-p667-p6c8
	disableHTTP2 := func(c *tls.Config) {
		setupLog.Info("disabling http/2")
		c.NextProtos = []string{"http/1.1"}
	}

	if !enableHTTP2 {
		tlsOpts = append(tlsOpts, disableHTTP2)
	}

	webhookServer := webhook.NewServer(webhook.Options{
		TLSOpts: tlsOpts,
	})

	// Metrics endpoint is enabled in 'config/default/kustomization.yaml'. The Metrics options configure the server.
	// More info:
	// - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.19.1/pkg/metrics/server
	// - https://book.kubebuilder.io/reference/metrics.html
	metricsServerOptions := metricsserver.Options{
		BindAddress:   metricsAddr,
		SecureServing: secureMetrics,
		TLSOpts:       tlsOpts,
	}

	if secureMetrics {
		// FilterProvider is used to protect the metrics endpoint with authn/authz.
		// These configurations ensure that only authorized users and service accounts
		// can access the metrics endpoint. The RBAC are configured in 'config/rbac/kustomization.yaml'. More info:
		// https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.19.1/pkg/metrics/filters#WithAuthenticationAndAuthorization
		metricsServerOptions.FilterProvider = filters.WithAuthenticationAndAuthorization

		// TODO(user): If CertDir, CertName, and KeyName are not specified, controller-runtime will automatically
		// generate self-signed certificates for the metrics server. While convenient for development and testing,
		// this setup is not recommended for production.
	}

	// Configure rate limiting for the Kubernetes client
	config := ctrl.GetConfigOrDie()
	config.QPS = 50.0  // Increased from default 5.0
	config.Burst = 100 // Increased from default 10

	mgr, err := ctrl.NewManager(config, ctrl.Options{
		Scheme:                 scheme,
		Metrics:                metricsServerOptions,
		WebhookServer:          webhookServer,
		HealthProbeBindAddress: probeAddr,
		LeaderElection:         enableLeaderElection,
		LeaderElectionID:       leaderElectionID,
		// Scope the shared Secret informer so the WildcardSecret reconciler's
		// cluster-wide Secret watch does not cache every Secret (and its key
		// material) in memory. Only managed wildcard replicas and the values
		// channel are cached; no other reconciler reads Secrets through THIS
		// (the manager's) typed Secret cache. See wildcardsecret.SecretCacheByObject.
		//
		// The CA-extraction reconciler does NOT use this cache at all — neither its
		// typed Secret informer nor a metadata one. A metadata informer for
		// v1/Secret would route to THIS same per-GVK cache and inherit its
		// wildcard-replica label selector, so its source watch would never fire for
		// an unlabelled CA source. It therefore owns a SEPARATE metadata-only cache
		// (caSecretCluster, in the CACert step of setup.go) and reads the one
		// source it projects through the uncached APIReader. So this
		// manager-level Secret scoping is wildcardsecret's alone.
		Cache: cache.Options{
			ByObject: map[client.Object]cache.ByObject{
				&corev1.Secret{}: wildcardsecret.SecretCacheByObject(),
				// The GPU settings ConfigMap is the only ConfigMap this binary
				// reads through the cache, so cache only that one.
				&corev1.ConfigMap{}: {
					Namespaces: map[string]cache.Config{gpu.SettingsNamespace: {
						FieldSelector: fields.OneTermEqualSelector("metadata.name", gpu.SettingsConfigMap),
					}},
				},
			},
		},
		// The program exits as soon as the manager stops, which is what makes
		// releasing the lease on cancel safe. Without it a rollout leaves GPU
		// bind requests unanswered for a whole lease duration, longer than an
		// admission webhook can wait.
		LeaderElectionReleaseOnCancel: true,
	})
	if err != nil {
		setupLog.Error(err, "unable to start manager")
		os.Exit(1)
	}

	steps := managerSteps(mgr, setupConfig{
		restConfig:               config,
		gpu:                      gpuCfg,
		quotaBufferPercent:       quotaBufferPercent,
		seaweedfsMetricsEndpoint: seaweedfsMetricsEndpoint,
		telemetry:                telemetryConfig,
	})
	for _, s := range selectSteps(steps, gpuOnly) {
		if err := s.run(); err != nil {
			setupLog.Error(err, "unable to set up the manager", "step", s.name)
			os.Exit(1)
		}
	}
	// +kubebuilder:scaffold:builder

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