10 // Import all Kubernetes client auth plugins (e.g. Azure, GCP, OIDC, etc.)
11 _ "k8s.io/client-go/plugin/pkg/client/auth"
12 "k8s.io/client-go/rest"
14 "remote-config-operator/pkg/apis"
15 "remote-config-operator/pkg/controller"
17 monitoringv1 "github.com/coreos/prometheus-operator/pkg/apis/monitoring/v1"
18 "github.com/operator-framework/operator-sdk/pkg/k8sutil"
19 kubemetrics "github.com/operator-framework/operator-sdk/pkg/kube-metrics"
20 "github.com/operator-framework/operator-sdk/pkg/leader"
21 "github.com/operator-framework/operator-sdk/pkg/log/zap"
22 "github.com/operator-framework/operator-sdk/pkg/metrics"
23 "github.com/operator-framework/operator-sdk/pkg/restmapper"
24 sdkVersion "github.com/operator-framework/operator-sdk/version"
25 "github.com/spf13/pflag"
26 v1 "k8s.io/api/core/v1"
27 "k8s.io/apimachinery/pkg/util/intstr"
28 "sigs.k8s.io/controller-runtime/pkg/client/config"
29 logf "sigs.k8s.io/controller-runtime/pkg/log"
30 "sigs.k8s.io/controller-runtime/pkg/manager"
31 "sigs.k8s.io/controller-runtime/pkg/manager/signals"
34 // Change below variables to serve metrics on different host or port.
36 metricsHost = "0.0.0.0"
37 metricsPort int32 = 8383
38 operatorMetricsPort int32 = 8686
40 var log = logf.Log.WithName("cmd")
43 log.Info(fmt.Sprintf("Go Version: %s", runtime.Version()))
44 log.Info(fmt.Sprintf("Go OS/Arch: %s/%s", runtime.GOOS, runtime.GOARCH))
45 log.Info(fmt.Sprintf("Version of operator-sdk: %v", sdkVersion.Version))
49 // Add the zap logger flag set to the CLI. The flag set must
50 // be added before calling pflag.Parse().
51 pflag.CommandLine.AddFlagSet(zap.FlagSet())
53 // Add flags registered by imported packages (e.g. glog and
54 // controller-runtime)
55 pflag.CommandLine.AddGoFlagSet(flag.CommandLine)
59 // Use a zap logr.Logger implementation. If none of the zap
60 // flags are configured (or if the zap flag set is not being
61 // used), this defaults to a production zap logger.
63 // The logger instantiated here can be changed to any logger
64 // implementing the logr.Logger interface. This logger will
65 // be propagated through the whole operator, generating
66 // uniform and structured logs.
67 logf.SetLogger(zap.Logger())
71 namespace, err := k8sutil.GetWatchNamespace()
73 log.Error(err, "Failed to get watch namespace")
77 // Get a config to talk to the apiserver
78 cfg, err := config.GetConfig()
85 // Become the leader before proceeding
86 err = leader.Become(ctx, "remote-config-operator-lock")
92 // Create a new Cmd to provide shared dependencies and start components
93 mgr, err := manager.New(cfg, manager.Options{
95 MapperProvider: restmapper.NewDynamicRESTMapper,
96 MetricsBindAddress: fmt.Sprintf("%s:%d", metricsHost, metricsPort),
103 log.Info("Registering Components.")
105 // Setup Scheme for all resources
106 if err := apis.AddToScheme(mgr.GetScheme()); err != nil {
111 // Adding the monitoringv1
112 if err := monitoringv1.AddToScheme(mgr.GetScheme()); err != nil {
117 // Setup all Controllers
118 if err := controller.AddToManager(mgr); err != nil {
123 if err = serveCRMetrics(cfg); err != nil {
124 log.Info("Could not generate and serve custom resource metrics", "error", err.Error())
127 // Add to the below struct any other metrics ports you want to expose.
128 servicePorts := []v1.ServicePort{
129 {Port: metricsPort, Name: metrics.OperatorPortName, Protocol: v1.ProtocolTCP, TargetPort: intstr.IntOrString{Type: intstr.Int, IntVal: metricsPort}},
130 {Port: operatorMetricsPort, Name: metrics.CRPortName, Protocol: v1.ProtocolTCP, TargetPort: intstr.IntOrString{Type: intstr.Int, IntVal: operatorMetricsPort}},
132 // Create Service object to expose the metrics port(s).
133 service, err := metrics.CreateMetricsService(ctx, cfg, servicePorts)
135 log.Info("Could not create metrics Service", "error", err.Error())
138 // CreateServiceMonitors will automatically create the prometheus-operator ServiceMonitor resources
139 // necessary to configure Prometheus to scrape metrics from this operator.
140 services := []*v1.Service{service}
141 _, err = metrics.CreateServiceMonitors(cfg, namespace, services)
143 log.Info("Could not create ServiceMonitor object", "error", err.Error())
144 // If this operator is deployed to a cluster without the prometheus-operator running, it will return
145 // ErrServiceMonitorNotPresent, which can be used to safely skip ServiceMonitor creation.
146 if err == metrics.ErrServiceMonitorNotPresent {
147 log.Info("Install prometheus-operator in your cluster to create ServiceMonitor objects", "error", err.Error())
151 log.Info("Starting the Cmd.")
154 if err := mgr.Start(signals.SetupSignalHandler()); err != nil {
155 log.Error(err, "Manager exited non-zero")
160 // serveCRMetrics gets the Operator/CustomResource GVKs and generates metrics based on those types.
161 // It serves those metrics on "http://metricsHost:operatorMetricsPort".
162 func serveCRMetrics(cfg *rest.Config) error {
163 // Below function returns filtered operator/CustomResource specific GVKs.
164 // For more control override the below GVK list with your own custom logic.
165 filteredGVK, err := k8sutil.GetGVKsFromAddToScheme(apis.AddToScheme)
169 // Get the namespace the operator is currently deployed in.
170 operatorNs, err := k8sutil.GetOperatorNamespace()
174 // To generate metrics in other namespaces, add the values below.
175 ns := []string{operatorNs}
176 // Generate and serve custom resource specific metrics.
177 err = kubemetrics.GenerateAndServeCRMetrics(cfg, ns, filteredGVK, metricsHost, operatorMetricsPort)