Use internal Volume struct for tls

This change switches the tls package over to using the lib-common
copy of the Volume struct. This will allow us to append TLS volumes to the volume
struct in each service Operator as we update the version of lib-common in each of
them.

Signed-off-by: Brendan Shephard <[email protected]>

Author: bshephar

modules/common/go.mod

@@ -9,6 +9,7 @@ require (
 	github.com/onsi/ginkgo/v2 v2.20.1
 	github.com/onsi/gomega v1.34.1
 	github.com/openshift/api v3.9.0+incompatible
+	github.com/openstack-k8s-operators/lib-common/modules/storage v0.5.1-0.20241104140916-71a0e9d9766d
 	github.com/pkg/errors v0.9.1
 	go.uber.org/zap v1.27.0
 	gopkg.in/yaml.v3 v3.0.1

modules/common/go.sum

@@ -80,6 +80,8 @@ github.com/onsi/gomega v1.34.1 h1:EUMJIKUjM8sKjYbtxQI9A4z2o+rruxnzNvpknOXie6k=
 github.com/onsi/gomega v1.34.1/go.mod h1:kU1QgUvBDLXBJq618Xvm2LUX6rSAfRaFRTcdOeDLwwY=
 github.com/openshift/api v0.0.0-20240830023148-b7d0481c9094 h1:J1wuGhVxpsHykZBa6Beb1gQ96Ptej9AE/BvwCBiRj1E=
 github.com/openshift/api v0.0.0-20240830023148-b7d0481c9094/go.mod h1:CxgbWAlvu2iQB0UmKTtRu1YfepRg1/vJ64n2DlIEVz4=
+github.com/openstack-k8s-operators/lib-common/modules/storage v0.5.1-0.20241104140916-71a0e9d9766d h1:6fA7kvhKRelVwNWxcMVe2d2lkN8MITY0OIudTBnmT+A=
+github.com/openstack-k8s-operators/lib-common/modules/storage v0.5.1-0.20241104140916-71a0e9d9766d/go.mod h1:tfgBeLRqmlH/NQkLPe7396rj+t0whv2wPuMb8Ttvh8w=
 github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=

modules/common/tls/tls.go

@@ -29,6 +29,7 @@ import (
 	"github.com/openstack-k8s-operators/lib-common/modules/common/secret"
 	"github.com/openstack-k8s-operators/lib-common/modules/common/service"
 	"github.com/openstack-k8s-operators/lib-common/modules/common/util"
+	"github.com/openstack-k8s-operators/lib-common/modules/storage"
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
 	k8s_errors "k8s.io/apimachinery/pkg/api/errors"
@@ -382,15 +383,15 @@ func (s *Service) CreateVolumeMounts(serviceID string) []corev1.VolumeMount {
 }
 
 // CreateVolume - add volume for TLS certificates and CA certificate for the service
-func (s *Service) CreateVolume(serviceID string) corev1.Volume {
-	volume := corev1.Volume{}
+func (s *Service) CreateVolume(serviceID string) storage.Volume {
+	volume := storage.Volume{}
 	if serviceID == "" {
 		serviceID = "default"
 	}
 	if s.SecretName != "" {
-		volume = corev1.Volume{
+		volume = storage.Volume{
 			Name: serviceID + "-tls-certs",
-			VolumeSource: corev1.VolumeSource{
+			VolumeSource: storage.VolumeSource{
 				Secret: &corev1.SecretVolumeSource{
 					SecretName:  s.SecretName,
 					DefaultMode: ptr.To[int32](0400),

modules/common/tls/tls_test.go

@@ -24,6 +24,7 @@ import (
 
 	. "github.com/onsi/gomega"
 	"github.com/openstack-k8s-operators/lib-common/modules/common/service"
+	"github.com/openstack-k8s-operators/lib-common/modules/storage"
 )
 
 func TestAPIEnabled(t *testing.T) {
@@ -206,20 +207,20 @@ func TestServiceCreateVolume(t *testing.T) {
 		name    string
 		service *Service
 		id      string
-		want    corev1.Volume
+		want    storage.Volume
 	}{
 		{
 			name:    "No Secrets",
 			service: &Service{},
-			want:    corev1.Volume{},
+			want:    storage.Volume{},
 		},
 		{
 			name:    "Only TLS Secret",
 			service: &Service{SecretName: "cert-secret"},
 			id:      "foo",
-			want: corev1.Volume{
+			want: storage.Volume{
 				Name: "foo-tls-certs",
-				VolumeSource: corev1.VolumeSource{
+				VolumeSource: storage.VolumeSource{
 					Secret: &corev1.SecretVolumeSource{
 						SecretName:  "cert-secret",
 						DefaultMode: ptr.To[int32](0400),
@@ -230,9 +231,9 @@ func TestServiceCreateVolume(t *testing.T) {
 		{
 			name:    "Only TLS Secret no serviceID",
 			service: &Service{SecretName: "cert-secret"},
-			want: corev1.Volume{
+			want: storage.Volume{
 				Name: "default-tls-certs",
-				VolumeSource: corev1.VolumeSource{
+				VolumeSource: storage.VolumeSource{
 					Secret: &corev1.SecretVolumeSource{
 						SecretName:  "cert-secret",
 						DefaultMode: ptr.To[int32](0400),