[COST-5632] Cost Management Metrics Operator V3.3.2 updates

.github/workflows/ci-manual.yaml

@@ -90,7 +90,7 @@ jobs:
               fi
             done
       - name: go unit test in zvsi
-        uses: appleboy/ssh-action@v1.0.3
+        uses: appleboy/ssh-action@v1.1.0
         with:
           host: ${{ env.ZVSI_FIP_ADD }}
           username: root

.pre-commit-config.yaml

@@ -1,5 +1,5 @@
 repos:
 - repo: https://github.com/golangci/golangci-lint
-  rev: v1.54.2
+  rev: v1.61.0
   hooks:
     - id: golangci-lint

.tekton/operator-pr.yaml

@@ -7,7 +7,11 @@ metadata:
     build.appstudio.redhat.com/pull_request_number: '{{pull_request_number}}'
     build.appstudio.redhat.com/target_branch: '{{target_branch}}'
     pipelinesascode.tekton.dev/max-keep-runs: "3"
-    pipelinesascode.tekton.dev/on-cel-expression: event == "pull_request" && target_branch == "downstream"
+    pipelinesascode.tekton.dev/on-cel-expression: event == "pull_request" && target_branch == "downstream" &&
+      (
+        ".tekton/operator-pr.yaml".pathChanged() ||
+        "Dockerfile".pathChanged() 
+      )
   creationTimestamp: null
   labels:
     appstudio.openshift.io/application: costmanagement-metrics-operator

Dockerfile

@@ -33,12 +33,14 @@ COPY --from=builder /etc/pki/ca-trust/extracted/openssl/ca-bundle.trust.crt /etc
 LABEL \
     com.redhat.component="costmanagement-metrics-operator-container"  \
     description="Red Hat Cost Management Metrics Operator"  \
+    distribution-scope="public" \
     io.k8s.description="Operator to deploy and manage instances of Cost Management Metrics"  \
     io.k8s.display-name="Cost Management Metrics Operator"  \
     io.openshift.tags="cost,cost-management,prometheus,servicetelemetry,operators"  \
     maintainer="Cost Management <cost-mgmt@redhat.com>"  \
     name="costmanagement-metrics-operator"  \
     summary="Red Hat Cost Management Metrics Operator"  \
-    version="3.3.1"
+    version="3.3.2" \
+    vendor="Red Hat, Inc."
 
 ENTRYPOINT ["/manager"]

Makefile

@@ -3,8 +3,8 @@
 # To re-generate a bundle for another specific version without changing the standard setup, you can:
 # - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2)
 # - use environment variables to overwrite this value (e.g export VERSION=0.0.2)
-PREVIOUS_VERSION ?= 3.3.0
-VERSION ?= 3.3.1
+PREVIOUS_VERSION ?= 3.3.1
+VERSION ?= 3.3.2
 
 MIN_KUBE_VERSION = 1.24.0
 MIN_OCP_VERSION = 4.12
@@ -273,8 +273,7 @@ get-token-and-cert:  ## Get a token from a running K8s cluster for local develop
 
 .PHONY: bundle
 bundle: operator-sdk manifests kustomize ## Generate bundle manifests and metadata, then validate generated files.
-	mkdir -p koku-metrics-operator/$(VERSION)/
-	rm -rf ./bundle koku-metrics-operator/$(VERSION)/
+	rm -rf ./bundle
 	$(OPERATOR_SDK) generate kustomize manifests
 	cd config/manager && $(KUSTOMIZE) edit set image controller=$(IMAGE_SHA)
 	$(KUSTOMIZE) build config/manifests | $(OPERATOR_SDK) generate bundle --overwrite --version $(VERSION) $(BUNDLE_METADATA_OPTS)
@@ -289,16 +288,13 @@ bundle: operator-sdk manifests kustomize ## Generate bundle manifests and metada
 ifdef NAMESPACE
 	$(YQ) -i '.metadata.namespace = "$(NAMESPACE)"' bundle/manifests/koku-metrics-operator.clusterserviceversion.yaml
 endif
-	sed -i '' '/^COPY / s/bundle\///g' bundle.Dockerfile
 
-	cp -r ./bundle/ koku-metrics-operator/$(VERSION)/
-	cp bundle.Dockerfile koku-metrics-operator/$(VERSION)/Dockerfile
-	$(OPERATOR_SDK) bundle validate koku-metrics-operator/$(VERSION) --select-optional name=multiarch
-	$(OPERATOR_SDK) bundle validate koku-metrics-operator/$(VERSION) --select-optional suite=operatorframework
+	$(OPERATOR_SDK) bundle validate bundle/ --select-optional name=multiarch
+	$(OPERATOR_SDK) bundle validate bundle/ --select-optional suite=operatorframework
 
 .PHONY: bundle-build
 bundle-build: ## Build the bundle image.
-	cd koku-metrics-operator/$(VERSION) && $(CONTAINER_TOOL) build --platform linux/x86_64 -t $(BUNDLE_IMG) .
+	$(CONTAINER_TOOL) build --platform linux/x86_64 -t $(BUNDLE_IMG) --file bundle.Dockerfile .
 
 .PHONY: bundle-push
 bundle-push: ## Push the bundle image.
@@ -330,7 +326,6 @@ DOWNSTREAM_LOWERCASE = costmanagement
 DOWNSTREAM_UPPERCASE = CostManagement
 .PHONY: downstream
 downstream: operator-sdk ## Generate the code changes necessary for the downstream image.
-	rm -rf $(REMOVE_FILES)
 	# sed replace everything but the Makefile
 	- LC_ALL=C find api/v1beta1 config/* docs/* -type f -exec sed -i '' 's/$(UPSTREAM_UPPERCASE)/$(DOWNSTREAM_UPPERCASE)/g' {} +
 	- LC_ALL=C find api/v1beta1 config/* docs/* -type f -exec sed -i '' 's/$(UPSTREAM_LOWERCASE)/$(DOWNSTREAM_LOWERCASE)/g' {} +
@@ -352,8 +347,7 @@ downstream: operator-sdk ## Generate the code changes necessary for the downstre
 
 	$(MAKE) manifests
 
-	mkdir -p costmanagement-metrics-operator/$(VERSION)/
-	rm -rf ./bundle costmanagement-metrics-operator/$(VERSION)/
+	rm -rf ./bundle
 
 	$(OPERATOR_SDK) generate kustomize manifests
 	cd config/manager && $(KUSTOMIZE) edit set image controller=$(DOWNSTREAM_IMAGE_TAG)
@@ -379,12 +373,9 @@ downstream: operator-sdk ## Generate the code changes necessary for the downstre
 
 	# scripts/update_bundle_dockerfile.py
 	cat downstream-assets/bundle.Dockerfile.txt >> bundle.Dockerfile
-	sed -i '' '/^COPY / s/bundle\///g' bundle.Dockerfile
 	sed -i '' 's/MIN_OCP_VERSION/$(MIN_OCP_VERSION)/g' bundle.Dockerfile
 	sed -i '' 's/REPLACE_VERSION/$(VERSION)/g' bundle.Dockerfile
 
-	cp -r ./bundle/ costmanagement-metrics-operator/$(VERSION)/
-	cp bundle.Dockerfile costmanagement-metrics-operator/$(VERSION)/Dockerfile
 
 ##@ Build Dependencies
 

bundle.Dockerfile

@@ -31,4 +31,4 @@ LABEL com.redhat.openshift.versions='v4.12'
 LABEL name=openshift/costmanagement-metrics-operator-bundle
 LABEL maintainer='<costmanagement@redhat.com>'
 LABEL summary='Operator required to upload metrics data to the cost management service in console.redhat.com.'
-LABEL version=3.3.1
+LABEL version=3.3.1

cmd/main.go

@@ -9,6 +9,7 @@
 	"flag"
 	"fmt"
 	"os"
+	"time"
 
 	configv1 "github.com/openshift/api/config/v1"
 	operatorsv1alpha1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
@@ -29,8 +30,11 @@
 )
 
 var (
-	scheme   = runtime.NewScheme()
-	setupLog = ctrl.Log.WithName("setup")
+	scheme               = runtime.NewScheme()
+	setupLog             = ctrl.Log.WithName("setup")
+	defaultLeaseDuration = 60 * time.Second
+	defaultRenewDeadline = 30 * time.Second
+	defaultRetryPeriod   = 5 * time.Second
 )
 
 func init() {
@@ -48,14 +52,22 @@
 
 func main() {
 	var metricsAddr string
-	var enableLeaderElection bool
 	var probeAddr string
+	var enableLeaderElection bool
 	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.")
 
+	// fetch leader election configurations from environment variables
+	leaseDuration := getEnvVarDuration("LEADER_ELECTION_LEASE_DURATION", defaultLeaseDuration)
+	renewDeadline := getEnvVarDuration("LEADER_ELECTION_RENEW_DEADLINE", defaultRenewDeadline)
+	retryPeriod := getEnvVarDuration("LEADER_ELECTION_RETRY_PERIOD", defaultRetryPeriod)
+
+	// validate leader election
+	leaseDuration, renewDeadline, retryPeriod = validateLeaderElectionConfig(leaseDuration, renewDeadline, retryPeriod)
+
 	opts := zap.Options{
 		Development: true,
 		TimeEncoder: zapcore.RFC3339NanoTimeEncoder,
@@ -83,6 +95,9 @@
 
 		LeaderElection:   enableLeaderElection,
 		LeaderElectionID: "91c624a5.openshift.io",
+		LeaseDuration:    &leaseDuration,
+		RenewDeadline:    &renewDeadline,
+		RetryPeriod:      &retryPeriod,
 		Cache:            cache.Options{DefaultNamespaces: map[string]cache.Config{watchNamespace: {}}},
 	})
 	if err != nil {
@@ -138,3 +153,62 @@
 	}
 	return ns, nil
 }
+
+// GetEnvVar returns the value from an environment variable
+// or the provided default value if the variable does not exist.
+func getEnvVarString(varName, defaultValue string) string {
+	if value, exists := os.LookupEnv(varName); exists {
+		return value
+	}
+	return defaultValue
+}
+
+// Returns time.Duration parsed from an env variable
+// or the default value if the variable does not exist or does not parse into a duration.
+func getEnvVarDuration(varName string, defaultValue time.Duration) time.Duration {
+	val := getEnvVarString(varName, "")
+
+	if val == "" {
+		return defaultValue
+	}
+
+	parsedVal, err := time.ParseDuration(val)
+	if err != nil {
+		setupLog.Error(err, "Invalid boolean format for environment variable", "Variable", varName, "Value", val)
+		return defaultValue
+	}
+	return parsedVal
+
+}
+
+// validateLeaderElectionConfig returns the Namespace the operator should be watching for changes
+func validateLeaderElectionConfig(leaseDuration, renewDeadline, retryPeriod time.Duration) (time.Duration, time.Duration, time.Duration) {
+
+	// validate that renewDeadlne < leaseDuration
+	if renewDeadline >= leaseDuration {
+
+		setupLog.Info("Invalid configuration: LEADER_ELECTION_RENEW_DEADLINE must be less that LEADER_ELECTION_LEASE_DURATION; using default values",
+			"Provided LEADER_ELECTION_LEASE_DURATION", leaseDuration,
+			"Provided LEADER_ELECTION_RENEW_DEADLINE", renewDeadline,
+			"Default LEADER_ELECTION_LEASE_DURATION", defaultLeaseDuration,
+			"Default LEADER_ELECTION_RENEW_DEADLINE", defaultRenewDeadline,
+		)
+
+		leaseDuration = defaultLeaseDuration
+		renewDeadline = defaultRenewDeadline
+	}
+
+	// validate that retryPeriod < renewDeadlne
+	if retryPeriod >= renewDeadline {
+		setupLog.Info("Invalid configuration: LEADER_ELECTION_RETRY_PERIOD must be less that LEADER_ELECTION_RENEW_DEADLINE; using default values",
+			"Provided LEADER_ELECTION_RETRY_PERIOD", retryPeriod,
+			"Provided LEADER_ELECTION_RENEW_DEADLINE", renewDeadline,
+			"Default LEADER_ELECTION_RETRY_PERIOD", defaultRetryPeriod,
+			"Default LEADER_ELECTION_RENEW_DEADLINE", defaultRenewDeadline,
+		)
+		retryPeriod = defaultRetryPeriod
+		renewDeadline = defaultRenewDeadline
+	}
+
+	return leaseDuration, renewDeadline, retryPeriod
+}