bump to golang 1.24

stuggi · stuggi · commit 3a6dfc5281a4 · 2025-09-17T17:18:23.000+02:00
* bump in go.mod (base and api)
* bump go-toolset in Dockerfile
* bump in github jobs ('.github/workflows')
* Bump the golangci-lint version in the .pre-commit-config.yaml to v2.4.0
* Bump build_root_image in .ci-operator.yaml to ci-build-root-golang-1.24-sdk-1.31

Also fixes golangci-lint reported issues for new v2.4.0 version.

Jira: OSPRH-12935
Signed-off-by: Martin Schuppert &lt;mschuppert@redhat.com&gt;
diff --git a/.ci-operator.yaml b/.ci-operator.yaml
@@ -1,4 +1,4 @@
 build_root_image:
   name: tools
   namespace: openstack-k8s-operators
-  tag: ci-build-root-golang-1.21-sdk-1.31
+  tag: ci-build-root-golang-1.24-sdk-1.31
diff --git a/.github/workflows/build-nova-operator.yaml b/.github/workflows/build-nova-operator.yaml
@@ -15,7 +15,7 @@ jobs:
     uses: openstack-k8s-operators/openstack-k8s-operators-ci/.github/workflows/reusable-build-operator.yaml@main
     with:
       operator_name: nova
-      go_version: 1.21.x
+      go_version: 1.24.x
       operator_sdk_version: 1.31.0
     secrets:
       IMAGENAMESPACE: ${{ secrets.IMAGENAMESPACE }}
diff --git a/.github/workflows/force-bump-pr-manual.yaml b/.github/workflows/force-bump-pr-manual.yaml
@@ -9,5 +9,6 @@ jobs:
     with:
       operator_name: nova
       branch_name: ${{ github.ref_name }}
+      custom_image: quay.io/openstack-k8s-operators/openstack-k8s-operators-ci-build-tools:golang-1.24-sdk-1.31
     secrets:
       FORCE_BUMP_PULL_REQUEST_PAT: ${{ secrets.FORCE_BUMP_PULL_REQUEST_PAT }}
diff --git a/.github/workflows/force-bump-pr-scheduled.yaml b/.github/workflows/force-bump-pr-scheduled.yaml
@@ -10,5 +10,6 @@ jobs:
     uses: openstack-k8s-operators/openstack-k8s-operators-ci/.github/workflows/force-bump-branches.yaml@main
     with:
       operator_name: nova
+      custom_image: quay.io/openstack-k8s-operators/openstack-k8s-operators-ci-build-tools:golang-1.24-sdk-1.31
     secrets:
       FORCE_BUMP_PULL_REQUEST_PAT: ${{ secrets.FORCE_BUMP_PULL_REQUEST_PAT }}
diff --git a/.golangci.yaml b/.golangci.yaml
@@ -1,14 +1,20 @@
+version: 2
+
 linters:
   # Enable specific linter
   # https://golangci-lint.run/usage/linters/#enabled-by-default
   enable:
     - errorlint
     - revive
     - ginkgolinter
-    - gofmt
     - govet
     - gosec
     - errname
     - err113
+
+formatters:
+  enable:
+    - gofmt
+
 run:
   timeout: 5m
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -83,7 +83,7 @@ repos:
       args: ['--ignore-words=.codespell.ignore']
 
 - repo: https://github.com/golangci/golangci-lint
-  rev: v1.59.1
+  rev: v2.4.0
   hooks:
     - id: golangci-lint-full
       args: ["-v"]
diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,4 @@
-ARG GOLANG_BUILDER=registry.access.redhat.com/ubi9/go-toolset:1.21
+ARG GOLANG_BUILDER=registry.access.redhat.com/ubi9/go-toolset:1.24
 ARG OPERATOR_BASE_IMAGE=registry.access.redhat.com/ubi9/ubi-minimal:latest
 
 # Build the manager binary
diff --git a/Makefile b/Makefile
@@ -69,7 +69,7 @@ endif
 SHELL = /usr/bin/env bash -o pipefail
 .SHELLFLAGS = -ec
 
-GOTOOLCHAIN_VERSION ?= go1.21.0
+GOTOOLCHAIN_VERSION ?= go1.24.0
 
 .PHONY: all
 all: build
@@ -134,10 +134,11 @@ tidy: ## Run go mod tidy on every mod file in the repo
 	go mod tidy
 	cd ./api && go mod tidy
 
+GOLANGCI_LINT_VERSION ?= v2.4.0
 .PHONY: golangci-lint
 golangci-lint:
 	# NOTE this will install golangci-lint in to local bin dir
-	test -s $(LOCALBIN)/golangci-lint || curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s v1.59.1
+	test -s $(LOCALBIN)/golangci-lint || curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s $(GOLANGCI_LINT_VERSION)
 	$(LOCALBIN)/golangci-lint run --fix
 
 PROCS?=$(shell expr $(shell nproc --ignore 2) / 2)
diff --git a/api/go.mod b/api/go.mod
@@ -1,6 +1,6 @@
 module github.com/openstack-k8s-operators/nova-operator/api
 
-go 1.21
+go 1.24
 
 require (
 	github.com/google/go-cmp v0.7.0
diff --git a/controllers/common.go b/controllers/common.go
@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package controllers contains the Nova operator controllers for managing OpenStack Nova services.
 package controllers
 
 import (
@@ -287,7 +288,7 @@ func ensureSecret(
 				condition.InputReadyCondition,
 				condition.RequestedReason,
 				condition.SeverityInfo,
-				fmt.Sprintf(novav1.InputReadyWaitingMessage, "secret/"+secretName.Name)))
+				novav1.InputReadyWaitingMessage, "secret/"+secretName.Name))
 			return "",
 				ctrl.Result{RequeueAfter: requeueTimeout},
 				*secret,
@@ -572,6 +573,7 @@ func hashOfStringMap(input map[string]string) (string, error) {
 	return util.ObjectHash(keyValues)
 }
 
+// GetSecret defines an interface for objects that can provide a secret name
 type GetSecret interface {
 	GetSecret() string
 	client.Object
@@ -750,6 +752,7 @@ func ensureMemcached(
 	return memcached, err
 }
 
+// SortNovaCellListByName sorts a NovaCellList by name in ascending order
 func SortNovaCellListByName(cellList *novav1.NovaCellList) {
 	sort.SliceStable(cellList.Items, func(i, j int) bool {
 		return cellList.Items[i].Name < cellList.Items[j].Name
diff --git a/controllers/nova_controller.go b/controllers/nova_controller.go
@@ -688,7 +688,7 @@ func (r *NovaReconciler) Reconcile(ctx context.Context, req ctrl.Request) (resul
 				cr.Spec.CellName, apiTransportURL,
 				secret, apiDB, cellDBs[novav1.Cell0Name].Database.GetDatabaseHostname(), cells[novav1.Cell0Name])
 			if err != nil {
-				deleteErrs = append(deleteErrs, fmt.Errorf("Cell '%s' deletion failed, because: %w", cr.Spec.CellName, err))
+				deleteErrs = append(deleteErrs, fmt.Errorf("cell '%s' deletion failed, because: %w", cr.Spec.CellName, err))
 			}
 			if result == nova.CellDeleteComplete {
 				Log.Info("Cell deleted", "cell", cr.Spec.CellName)
@@ -1029,7 +1029,7 @@ func (r *NovaReconciler) ensureNovaManageJobSecret(
 	)
 
 	var tlsCfg *tls.Service
-	if instance.Spec.APIServiceTemplate.TLS.Ca.CaBundleSecretName != "" {
+	if instance.Spec.APIServiceTemplate.TLS.CaBundleSecretName != "" {
 		tlsCfg = &tls.Service{}
 	}
 
@@ -1604,7 +1604,7 @@ func (r *NovaReconciler) ensureDBDeletion(
 	for _, novaDb := range novaDbs {
 		dbName, accountName := novaDb[0], novaDb[1]
 
-		err := mariadbv1.DeleteDatabaseAndAccountFinalizers(ctx, h, dbName, accountName, instance.ObjectMeta.Namespace)
+		err := mariadbv1.DeleteDatabaseAndAccountFinalizers(ctx, h, dbName, accountName, instance.Namespace)
 		if err != nil {
 			return err
 		}
diff --git a/controllers/novaapi_controller.go b/controllers/novaapi_controller.go
@@ -278,7 +278,7 @@ func (r *NovaAPIReconciler) Reconcile(ctx context.Context, req ctrl.Request) (re
 					condition.TLSInputReadyCondition,
 					condition.RequestedReason,
 					condition.SeverityInfo,
-					fmt.Sprintf(condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName)))
+					condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName))
 				return ctrl.Result{}, nil
 			}
 			instance.Status.Conditions.Set(condition.FalseCondition(
@@ -303,7 +303,7 @@ func (r *NovaAPIReconciler) Reconcile(ctx context.Context, req ctrl.Request) (re
 				condition.TLSInputReadyCondition,
 				condition.RequestedReason,
 				condition.SeverityInfo,
-				fmt.Sprintf(condition.TLSInputReadyWaitingMessage, err.Error())))
+				condition.TLSInputReadyWaitingMessage, err.Error()))
 			return ctrl.Result{}, nil
 		}
 		instance.Status.Conditions.Set(condition.FalseCondition(
@@ -536,7 +536,7 @@ func (r *NovaAPIReconciler) generateConfigs(
 	templateParameters["VHosts"] = httpdVhostConfig
 
 	var tlsCfg *tls.Service
-	if instance.Spec.TLS.Ca.CaBundleSecretName != "" {
+	if instance.Spec.TLS.CaBundleSecretName != "" {
 		tlsCfg = &tls.Service{}
 	}
 
diff --git a/controllers/novacompute_controller.go b/controllers/novacompute_controller.go
@@ -59,7 +59,7 @@ type NovaComputeReconciler struct {
 	ReconcilerBase
 }
 
-// GetLOgger returns a logger object with a prefix of "controller.name" and additional controller context fields
+// GetLogger returns a logger object with a prefix of "controller.name" and additional controller context fields
 func (r *NovaComputeReconciler) GetLogger(ctx context.Context) logr.Logger {
 	return log.FromContext(ctx).WithName("Controllers").WithName("NovaCompute")
 }
@@ -219,7 +219,7 @@ func (r *NovaComputeReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 					condition.TLSInputReadyCondition,
 					condition.RequestedReason,
 					condition.SeverityInfo,
-					fmt.Sprintf(condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName)))
+					condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName))
 				return ctrl.Result{}, nil
 			}
 			instance.Status.Conditions.Set(condition.FalseCondition(
diff --git a/controllers/novaconductor_controller.go b/controllers/novaconductor_controller.go
@@ -240,7 +240,7 @@ func (r *NovaConductorReconciler) Reconcile(ctx context.Context, req ctrl.Reques
 					condition.TLSInputReadyCondition,
 					condition.RequestedReason,
 					condition.SeverityInfo,
-					fmt.Sprintf(condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName)))
+					condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName))
 				return ctrl.Result{}, nil
 			}
 			instance.Status.Conditions.Set(condition.FalseCondition(
diff --git a/controllers/novametadata_controller.go b/controllers/novametadata_controller.go
@@ -255,7 +255,7 @@ func (r *NovaMetadataReconciler) Reconcile(ctx context.Context, req ctrl.Request
 					condition.TLSInputReadyCondition,
 					condition.RequestedReason,
 					condition.SeverityInfo,
-					fmt.Sprintf(condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName)))
+					condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName))
 				return ctrl.Result{}, nil
 			}
 			instance.Status.Conditions.Set(condition.FalseCondition(
@@ -281,7 +281,7 @@ func (r *NovaMetadataReconciler) Reconcile(ctx context.Context, req ctrl.Request
 					condition.TLSInputReadyCondition,
 					condition.RequestedReason,
 					condition.SeverityInfo,
-					fmt.Sprintf(condition.TLSInputReadyWaitingMessage, err.Error())))
+					condition.TLSInputReadyWaitingMessage, err.Error()))
 				return ctrl.Result{}, nil
 			}
 			instance.Status.Conditions.Set(condition.FalseCondition(
@@ -536,7 +536,7 @@ func (r *NovaMetadataReconciler) generateConfigs(
 	}
 
 	// create httpd tls template parameters
-	if instance.Spec.TLS.GenericService.Enabled() {
+	if instance.Spec.TLS.Enabled() {
 		templateParameters["tls"] = true
 		templateParameters["SSLCertificateFile"] = fmt.Sprintf("/etc/pki/tls/certs/%s.crt", novametadata.ServiceName)
 		templateParameters["SSLCertificateKeyFile"] = fmt.Sprintf("/etc/pki/tls/private/%s.key", novametadata.ServiceName)
diff --git a/controllers/novanovncproxy_controller.go b/controllers/novanovncproxy_controller.go
@@ -234,7 +234,7 @@ func (r *NovaNoVNCProxyReconciler) Reconcile(ctx context.Context, req ctrl.Reque
 					condition.TLSInputReadyCondition,
 					condition.RequestedReason,
 					condition.SeverityInfo,
-					fmt.Sprintf(condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName)))
+					condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName))
 				return ctrl.Result{}, nil
 			}
 			instance.Status.Conditions.Set(condition.FalseCondition(
@@ -260,7 +260,7 @@ func (r *NovaNoVNCProxyReconciler) Reconcile(ctx context.Context, req ctrl.Reque
 					condition.TLSInputReadyCondition,
 					condition.RequestedReason,
 					condition.SeverityInfo,
-					fmt.Sprintf(condition.TLSInputReadyWaitingMessage, err.Error())))
+					condition.TLSInputReadyWaitingMessage, err.Error()))
 				return ctrl.Result{}, nil
 			}
 			instance.Status.Conditions.Set(condition.FalseCondition(
@@ -283,7 +283,7 @@ func (r *NovaNoVNCProxyReconciler) Reconcile(ctx context.Context, req ctrl.Reque
 					condition.TLSInputReadyCondition,
 					condition.RequestedReason,
 					condition.SeverityInfo,
-					fmt.Sprintf(condition.TLSInputReadyWaitingMessage, err.Error())))
+					condition.TLSInputReadyWaitingMessage, err.Error()))
 				return ctrl.Result{}, nil
 			}
 			instance.Status.Conditions.Set(condition.FalseCondition(
diff --git a/controllers/novascheduler_controller.go b/controllers/novascheduler_controller.go
@@ -241,7 +241,7 @@ func (r *NovaSchedulerReconciler) Reconcile(ctx context.Context, req ctrl.Reques
 					condition.TLSInputReadyCondition,
 					condition.RequestedReason,
 					condition.SeverityInfo,
-					fmt.Sprintf(condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName)))
+					condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName))
 				return ctrl.Result{}, nil
 			}
 			instance.Status.Conditions.Set(condition.FalseCondition(
diff --git a/go.mod b/go.mod
@@ -1,6 +1,6 @@
 module github.com/openstack-k8s-operators/nova-operator
 
-go 1.21
+go 1.24
 
 require (
 	github.com/go-logr/logr v1.4.3
diff --git a/main.go b/main.go
@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package main implements the nova-operator controller manager.
 package main
 
 import (
diff --git a/pkg/nova/celldelete.go b/pkg/nova/celldelete.go
@@ -1,3 +1,4 @@
+// Package nova contains common Nova service functionality and utilities.
 package nova
 
 import (
@@ -10,6 +11,7 @@ import (
 	novav1 "github.com/openstack-k8s-operators/nova-operator/api/v1beta1"
 )
 
+// CellDeleteJob creates a Kubernetes job to delete a Nova cell
 func CellDeleteJob(
 	instance *novav1.Nova,
 	cell *novav1.NovaCell,
diff --git a/pkg/nova/cellmapping.go b/pkg/nova/cellmapping.go
@@ -10,6 +10,7 @@ import (
 	novav1 "github.com/openstack-k8s-operators/nova-operator/api/v1beta1"
 )
 
+// CellMappingJob creates a Kubernetes job to create Nova cell mappings
 func CellMappingJob(
 	instance *novav1.Nova,
 	cell *novav1.NovaCell,
diff --git a/pkg/nova/common.go b/pkg/nova/common.go
@@ -66,6 +66,7 @@ const (
 	MQCompleted MessageBusStatus = iota
 )
 
+// CellDeploymentStatus represents the deployment status of a Nova cell
 type CellDeploymentStatus int
 
 // CellDeploymentStatus -
diff --git a/pkg/nova/host_discover.go b/pkg/nova/host_discover.go
@@ -12,6 +12,7 @@ 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 nova
 
 import (
@@ -24,6 +25,7 @@ import (
 	"k8s.io/utils/ptr"
 )
 
+// HostDiscoveryJob creates a Kubernetes job to discover Nova compute hosts
 func HostDiscoveryJob(
 	instance *novav1.NovaCell,
 	configName string,
diff --git a/pkg/nova/volumes.go b/pkg/nova/volumes.go
@@ -31,6 +31,7 @@ var (
 	scriptMode int32 = 0740
 )
 
+// GetConfigVolumeMount returns a volume mount for Nova configuration files
 func GetConfigVolumeMount() corev1.VolumeMount {
 	return corev1.VolumeMount{
 		Name:      configVolume,
@@ -39,6 +40,7 @@ func GetConfigVolumeMount() corev1.VolumeMount {
 	}
 }
 
+// GetKollaConfigVolumeMount returns a volume mount for Kolla configuration files
 func GetKollaConfigVolumeMount(serviceName string) corev1.VolumeMount {
 	return corev1.VolumeMount{
 		Name:      configVolume,
@@ -48,6 +50,7 @@ func GetKollaConfigVolumeMount(serviceName string) corev1.VolumeMount {
 	}
 }
 
+// GetConfigVolume returns a volume for Nova configuration files from a secret
 func GetConfigVolume(secretName string) corev1.Volume {
 	return corev1.Volume{
 		Name: configVolume,
@@ -60,6 +63,7 @@ func GetConfigVolume(secretName string) corev1.Volume {
 	}
 }
 
+// GetLogVolumeMount returns a volume mount for Nova log files
 func GetLogVolumeMount() corev1.VolumeMount {
 	return corev1.VolumeMount{
 		Name:      logVolume,
@@ -68,6 +72,7 @@ func GetLogVolumeMount() corev1.VolumeMount {
 	}
 }
 
+// GetLogVolume returns an empty directory volume for Nova log files
 func GetLogVolume() corev1.Volume {
 	return corev1.Volume{
 		Name: logVolume,
@@ -77,6 +82,7 @@ func GetLogVolume() corev1.Volume {
 	}
 }
 
+// GetScriptVolumeMount returns a volume mount for Nova script files
 func GetScriptVolumeMount() corev1.VolumeMount {
 	return corev1.VolumeMount{
 		Name:      scriptVolume,
@@ -85,6 +91,7 @@ func GetScriptVolumeMount() corev1.VolumeMount {
 	}
 }
 
+// GetScriptVolume returns a volume for Nova script files from a secret
 func GetScriptVolume(secretName string) corev1.Volume {
 	return corev1.Volume{
 		Name: scriptVolume,
diff --git a/pkg/novaapi/const.go b/pkg/novaapi/const.go
@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package novaapi contains Nova API service configuration and deployment functionality.
 package novaapi
 
 const (
diff --git a/pkg/novacompute/deployment.go b/pkg/novacompute/deployment.go
diff --git a/pkg/novaconductor/dbpurge.go b/pkg/novaconductor/dbpurge.go
diff --git a/pkg/novametadata/const.go b/pkg/novametadata/const.go
diff --git a/pkg/novametadata/deployment.go b/pkg/novametadata/deployment.go
diff --git a/pkg/novascheduler/deployment.go b/pkg/novascheduler/deployment.go
diff --git a/pkg/novncproxy/const.go b/pkg/novncproxy/const.go
diff --git a/test/functional/api_fixture.go b/test/functional/api_fixture.go
diff --git a/test/functional/nova_multicell_test.go b/test/functional/nova_multicell_test.go
diff --git a/test/functional/nova_reconfiguration_test.go b/test/functional/nova_reconfiguration_test.go
diff --git a/test/functional/novacell_controller_test.go b/test/functional/novacell_controller_test.go
diff --git a/test/functional/sample_test.go b/test/functional/sample_test.go
diff --git a/test/functional/suite_test.go b/test/functional/suite_test.go

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-ARG GOLANG_BUILDER=registry.access.redhat.com/ubi9/go-toolset:1.21`
	`1`	`+ARG GOLANG_BUILDER=registry.access.redhat.com/ubi9/go-toolset:1.24`
`2`	`2`	`ARG OPERATOR_BASE_IMAGE=registry.access.redhat.com/ubi9/ubi-minimal:latest`
`3`	`3`
`4`	`4`	`# Build the manager binary`