Update cinderapi to use service override

Removes creation of routes.Those get done in the openstack-operator. Via service overrides the service can be customized. The service operator adds annotation to the service which needs to be exposed as a route. Jira: OSP-26690 Depends-On: openstack-k8s-operators/lib-common#332
openstack-k8s-operators · Sep 18, 2023 · 97bc3c2 · 97bc3c2
1 parent 27ac165
commit 97bc3c2
Show file tree

Hide file tree

Showing 16 changed files with 379 additions and 264 deletions.
diff --git a/README.md b/README.md
@@ -286,13 +286,16 @@ spec:
   ...
   cinderAPI:
     ...
-    externalEndpoints:
-      - endpoint: internal
-        ipAddressPool: osp-internalapi
-        loadBalancerIPs:
-        - 172.17.0.202
-        sharedIP: true
-        sharedIPKey: ""
+    override:
+      service:
+        internal:
+          metadata:
+            annotations:
+              metallb.universe.tf/address-pool: osp-internalapi
+              metallb.universe.tf/allow-shared-ip: internalapi
+              metallb.universe.tf/loadBalancerIPs: 172.17.0.202
+          spec:
+            type: LoadBalancer
     ...
 ...
 ```

diff --git a/api/bases/cinder.openstack.org_cinderapis.yaml b/api/bases/cinder.openstack.org_cinderapis.yaml
@@ -63,32 +63,6 @@ spec:
                 additionalProperties:
                   type: string
                 type: object
-              externalEndpoints:
-                items:
-                  properties:
-                    endpoint:
-                      enum:
-                      - internal
-                      - public
-                      type: string
-                    ipAddressPool:
-                      minLength: 1
-                      type: string
-                    loadBalancerIPs:
-                      items:
-                        type: string
-                      type: array
-                    sharedIP:
-                      default: true
-                      type: boolean
-                    sharedIPKey:
-                      default: ""
-                      type: string
-                  required:
-                  - endpoint
-                  - ipAddressPool
-                  type: object
-                type: array
               extraMounts:
                 items:
                   properties:
@@ -853,6 +827,57 @@ spec:
                 additionalProperties:
                   type: string
                 type: object
+              override:
+                properties:
+                  service:
+                    additionalProperties:
+                      properties:
+                        endpointURL:
+                          type: string
+                        metadata:
+                          properties:
+                            annotations:
+                              additionalProperties:
+                                type: string
+                              type: object
+                            labels:
+                              additionalProperties:
+                                type: string
+                              type: object
+                          type: object
+                        spec:
+                          properties:
+                            externalName:
+                              type: string
+                            externalTrafficPolicy:
+                              type: string
+                            internalTrafficPolicy:
+                              type: string
+                            ipFamilyPolicy:
+                              type: string
+                            loadBalancerClass:
+                              type: string
+                            loadBalancerSourceRanges:
+                              items:
+                                type: string
+                              type: array
+                            sessionAffinity:
+                              type: string
+                            sessionAffinityConfig:
+                              properties:
+                                clientIP:
+                                  properties:
+                                    timeoutSeconds:
+                                      format: int32
+                                      type: integer
+                                  type: object
+                              type: object
+                            type:
+                              type: string
+                          type: object
+                      type: object
+                    type: object
+                type: object
               passwordSelectors:
                 default:
                   database: CinderDatabasePassword

diff --git a/api/bases/cinder.openstack.org_cinders.yaml b/api/bases/cinder.openstack.org_cinders.yaml
@@ -56,32 +56,6 @@ spec:
                     additionalProperties:
                       type: string
                     type: object
-                  externalEndpoints:
-                    items:
-                      properties:
-                        endpoint:
-                          enum:
-                          - internal
-                          - public
-                          type: string
-                        ipAddressPool:
-                          minLength: 1
-                          type: string
-                        loadBalancerIPs:
-                          items:
-                            type: string
-                          type: array
-                        sharedIP:
-                          default: true
-                          type: boolean
-                        sharedIPKey:
-                          default: ""
-                          type: string
-                      required:
-                      - endpoint
-                      - ipAddressPool
-                      type: object
-                    type: array
                   networkAttachments:
                     items:
                       type: string
@@ -90,6 +64,57 @@ spec:
                     additionalProperties:
                       type: string
                     type: object
+                  override:
+                    properties:
+                      service:
+                        additionalProperties:
+                          properties:
+                            endpointURL:
+                              type: string
+                            metadata:
+                              properties:
+                                annotations:
+                                  additionalProperties:
+                                    type: string
+                                  type: object
+                                labels:
+                                  additionalProperties:
+                                    type: string
+                                  type: object
+                              type: object
+                            spec:
+                              properties:
+                                externalName:
+                                  type: string
+                                externalTrafficPolicy:
+                                  type: string
+                                internalTrafficPolicy:
+                                  type: string
+                                ipFamilyPolicy:
+                                  type: string
+                                loadBalancerClass:
+                                  type: string
+                                loadBalancerSourceRanges:
+                                  items:
+                                    type: string
+                                  type: array
+                                sessionAffinity:
+                                  type: string
+                                sessionAffinityConfig:
+                                  properties:
+                                    clientIP:
+                                      properties:
+                                        timeoutSeconds:
+                                          format: int32
+                                          type: integer
+                                      type: object
+                                  type: object
+                                type:
+                                  type: string
+                              type: object
+                          type: object
+                        type: object
+                    type: object
                   replicas:
                     default: 1
                     format: int32

diff --git a/api/go.mod b/api/go.mod
@@ -46,7 +46,6 @@ require (
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
-	github.com/openshift/api v3.9.0+incompatible // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/prometheus/client_golang v1.14.0 // indirect
 	github.com/prometheus/client_model v0.3.0 // indirect
@@ -80,3 +79,5 @@ require (
 // mschuppert: map to latest commit from release-4.13 tag
 // must consistent within modules and service operators
 replace github.com/openshift/api => github.com/openshift/api v0.0.0-20230414143018-3367bc7e6ac7 //allow-merging
+
+replace github.com/openstack-k8s-operators/lib-common/modules/common => github.com/stuggi/lib-common/modules/common v0.0.0-20230911170028-26ca518cd865
diff --git a/api/go.sum b/api/go.sum
@@ -228,10 +228,6 @@ github.com/onsi/ginkgo/v2 v2.12.0 h1:UIVDowFPwpg6yMUpPjGkYvf06K3RAiJXUhCxEwQVHRI
 github.com/onsi/ginkgo/v2 v2.12.0/go.mod h1:ZNEzXISYlqpb8S36iN71ifqLi3vVD1rVJGvWRCJOUpQ=
 github.com/onsi/gomega v1.27.10 h1:naR28SdDFlqrG6kScpT8VWpu1xWY5nJRCF3XaYyBjhI=
 github.com/onsi/gomega v1.27.10/go.mod h1:RsS8tutOdbdgzbPtzzATp12yT7kM5I5aElG3evPbQ0M=
-github.com/openshift/api v0.0.0-20230414143018-3367bc7e6ac7 h1:rncLxJBpFGqBztyxCMwNRnMjhhIDOWHJowi6q8G6koI=
-github.com/openshift/api v0.0.0-20230414143018-3367bc7e6ac7/go.mod h1:ctXNyWanKEjGj8sss1KjjHQ3ENKFm33FFnS5BKaIPh4=
-github.com/openstack-k8s-operators/lib-common/modules/common v0.1.1-0.20230912075107-19e1d7506ae8 h1:OUL5XlUD0/pDPa+JHlbVTFjm8GDUCuW5O7qGSk9G5ZY=
-github.com/openstack-k8s-operators/lib-common/modules/common v0.1.1-0.20230912075107-19e1d7506ae8/go.mod h1:Mqg9hyHpWPda62750vqmk5TajxP3zbYPDP1rtSH7mg0=
 github.com/openstack-k8s-operators/lib-common/modules/storage v0.1.1-0.20230912075107-19e1d7506ae8 h1:NcdTj37pP7uVhLNFo0b7g0LCf0rZm38vGTYYWCGcpi8=
 github.com/openstack-k8s-operators/lib-common/modules/storage v0.1.1-0.20230912075107-19e1d7506ae8/go.mod h1:lazDTPD8BYde2yyzZ3HbOfG51Sf87vSr4KXwpF57hDs=
 github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
@@ -290,6 +286,8 @@ github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/
 github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
 github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
 github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
+github.com/stuggi/lib-common/modules/common v0.0.0-20230911170028-26ca518cd865 h1:6KbPTZCQRwZ/dUKLkyyIaKjT2HcMQDqjEcBQjEPXRv0=
+github.com/stuggi/lib-common/modules/common v0.0.0-20230911170028-26ca518cd865/go.mod h1:Mqg9hyHpWPda62750vqmk5TajxP3zbYPDP1rtSH7mg0=
 github.com/xeipuuv/gojsonpointer v0.0.0-20180127040702-4e3ac2762d5f/go.mod h1:N2zxlSyiKSe5eX1tZViRH5QA0qijqEDrYZiPEAiq3wU=
 github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415/go.mod h1:GwrjFmJcFw6At/Gs6z4yjiIwzuJ1/+UwLxMQDVQXShQ=
 github.com/xeipuuv/gojsonschema v1.2.0/go.mod h1:anYRn/JVcOK2ZgGU+IjEV4nwlhoK5sQluxsYJ78Id3Y=

diff --git a/api/v1beta1/cinderapi_types.go b/api/v1beta1/cinderapi_types.go
@@ -18,6 +18,7 @@ package v1beta1
 
 import (
 	condition "github.com/openstack-k8s-operators/lib-common/modules/common/condition"
+	"github.com/openstack-k8s-operators/lib-common/modules/common/service"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
@@ -33,8 +34,15 @@ type CinderAPITemplate struct {
 	Replicas *int32 `json:"replicas"`
 
 	// +kubebuilder:validation:Optional
-	// ExternalEndpoints, expose a VIP via MetalLB on the pre-created address pool
-	ExternalEndpoints []MetalLBConfig `json:"externalEndpoints,omitempty"`
+	// Override, provides the ability to override the generated manifest of several child resources.
+	Override APIOverrideSpec `json:"override,omitempty"`
+}
+
+// APIOverrideSpec to override the generated manifest of several child resources.
+type APIOverrideSpec struct {
+	// Override configuration for the Service created to serve traffic to the cluster.
+	// The key must be the endpoint type (public, internal)
+	Service map[service.Endpoint]service.RoutedOverrideSpec `json:"service,omitempty"`
 }
 
 // CinderAPISpec defines the desired state of CinderAPI

diff --git a/api/v1beta1/common_types.go b/api/v1beta1/common_types.go
@@ -17,7 +17,6 @@ limitations under the License.
 package v1beta1
 
 import (
-	"github.com/openstack-k8s-operators/lib-common/modules/common/endpoint"
 	corev1 "k8s.io/api/core/v1"
 )
 
@@ -119,32 +118,3 @@ type CinderServiceDebug struct {
 	// service enable debug
 	Service bool `json:"service"`
 }
-
-// MetalLBConfig to configure the MetalLB loadbalancer service
-type MetalLBConfig struct {
-	// +kubebuilder:validation:Required
-	// +kubebuilder:validation:Enum=internal;public
-	// Endpoint, OpenStack endpoint this service maps to
-	Endpoint endpoint.Endpoint `json:"endpoint"`
-
-	// +kubebuilder:validation:Required
-	// +kubebuilder:validation:MinLength=1
-	// IPAddressPool expose VIP via MetalLB on the IPAddressPool
-	IPAddressPool string `json:"ipAddressPool"`
-
-	// +kubebuilder:validation:Optional
-	// +kubebuilder:default=true
-	// SharedIP if true, VIP/VIPs get shared with multiple services
-	SharedIP bool `json:"sharedIP"`
-
-	// +kubebuilder:validation:Optional
-	// +kubebuilder:default=""
-	// SharedIPKey specifies the sharing key which gets set as the annotation on the LoadBalancer service.
-	// Services which share the same VIP must have the same SharedIPKey. Defaults to the IPAddressPool if
-	// SharedIP is true, but no SharedIPKey specified.
-	SharedIPKey string `json:"sharedIPKey"`
-
-	// +kubebuilder:validation:Optional
-	// LoadBalancerIPs, request given IPs from the pool if available. Using a list to allow dual stack (IPv4/IPv6) support
-	LoadBalancerIPs []string `json:"loadBalancerIPs,omitempty"`
-}
diff --git a/api/v1beta1/zz_generated.deepcopy.go b/api/v1beta1/zz_generated.deepcopy.go