Use IBM COS as storage backend for PowerVS

Author: dharaneeshvrd

go.mod

@@ -27,7 +27,7 @@ require (
 	github.com/gophercloud/utils v0.0.0-20221124081324-7bac6f5cdf99
 	github.com/goware/urlx v0.3.2
 	github.com/jongio/azidext/go/azidext v0.4.0
-	github.com/openshift/api v0.0.0-20230210191657-68f4ffcda083
+	github.com/openshift/api v0.0.0-20230213202419-42edf4f1d905
 	github.com/openshift/build-machinery-go v0.0.0-20220913142420-e25cf57ea46d
 	github.com/openshift/client-go v0.0.0-20230120202327-72f107311084
 	github.com/openshift/library-go v0.0.0-20230120214501-9bc305884fcb

go.sum

@@ -589,8 +589,8 @@ github.com/onsi/gomega v1.7.1/go.mod h1:XdKZgCCFLUoM/7CFJVPcG8C1xQ1AJ0vpAezJrB7J
 github.com/onsi/gomega v1.10.1/go.mod h1:iN09h71vgCQne3DLsj+A5owkum+a2tYe+TOCB1ybHNo=
 github.com/onsi/gomega v1.10.3/go.mod h1:V9xEwhxec5O8UDM77eCW8vLymOMltsqPVYWrpDsH8xc=
 github.com/onsi/gomega v1.23.0 h1:/oxKu9c2HVap+F3PfKort2Hw5DEU+HGlW8n+tguWsys=
-github.com/openshift/api v0.0.0-20230210191657-68f4ffcda083 h1:Wc3z06B8JaEOnPlNovVB3ZR92CoSLWFupOeYO3khzCE=
-github.com/openshift/api v0.0.0-20230210191657-68f4ffcda083/go.mod h1:ctXNyWanKEjGj8sss1KjjHQ3ENKFm33FFnS5BKaIPh4=
+github.com/openshift/api v0.0.0-20230213202419-42edf4f1d905 h1:f+W57UXpRIJeZIh9lGLIPix/YxdFDBgHDGo0OkIgQw0=
+github.com/openshift/api v0.0.0-20230213202419-42edf4f1d905/go.mod h1:ctXNyWanKEjGj8sss1KjjHQ3ENKFm33FFnS5BKaIPh4=
 github.com/openshift/build-machinery-go v0.0.0-20220913142420-e25cf57ea46d h1:RR4ah7FfaPR1WePizm0jlrsbmPu91xQZnAsVVreQV1k=
 github.com/openshift/build-machinery-go v0.0.0-20220913142420-e25cf57ea46d/go.mod h1:b1BuldmJlbA/xYtdZvKi+7j5YGB44qJUJDZ9zwiNCfE=
 github.com/openshift/client-go v0.0.0-20230120202327-72f107311084 h1:66uaqNwA+qYyQDwsMWUfjjau8ezmg1dzCqub13KZOcE=

manifests/01-registry-credentials-request-powervs.yaml

@@ -0,0 +1,34 @@
+apiVersion: cloudcredential.openshift.io/v1
+kind: CredentialsRequest
+metadata:
+  labels:
+    controller-tools.k8s.io: "1.0"
+  name: openshift-image-registry-ibmcos-powervs
+  namespace: openshift-cloud-credential-operator
+  annotations:
+    include.release.openshift.io/ibm-cloud-managed: "true"
+    include.release.openshift.io/self-managed-high-availability: "true"
+    include.release.openshift.io/single-node-developer: "true"
+spec:
+  secretRef:
+    name: installer-cloud-credentials
+    namespace: openshift-image-registry
+  providerSpec:
+    apiVersion: cloudcredential.openshift.io/v1
+    kind: IBMCloudPowerVSProviderSpec
+    policies:
+      - attributes:
+          - name: serviceName
+            value: cloud-object-storage
+        roles:
+          - crn:v1:bluemix:public:iam::::role:Viewer
+          - crn:v1:bluemix:public:iam::::role:Operator
+          - crn:v1:bluemix:public:iam::::role:Editor
+          - crn:v1:bluemix:public:iam::::role:Administrator
+          - crn:v1:bluemix:public:iam::::serviceRole:Reader
+          - crn:v1:bluemix:public:iam::::serviceRole:Writer
+      - attributes:
+          - name: resourceType
+            value: resource-group
+        roles:
+          - crn:v1:bluemix:public:iam::::role:Viewer

pkg/storage/ibmcos/ibmcos.go

@@ -111,8 +111,16 @@ func (d *driver) UpdateEffectiveConfig() (*imageregistryv1.ImageRegistryConfigSt
 	}
 
 	var clusterLocation string
-	if infra.Status.PlatformStatus != nil && infra.Status.PlatformStatus.Type == configapiv1.IBMCloudPlatformType {
-		clusterLocation = infra.Status.PlatformStatus.IBMCloud.Location
+	if infra.Status.PlatformStatus != nil {
+		if infra.Status.PlatformStatus.Type == configapiv1.IBMCloudPlatformType {
+			clusterLocation = infra.Status.PlatformStatus.IBMCloud.Location
+		}
+		if infra.Status.PlatformStatus.Type == configapiv1.PowerVSPlatformType {
+			clusterLocation, err = cosRegionForPowerVSRegion(infra.Status.PlatformStatus.PowerVS.Region)
+			if err != nil {
+				return nil, err
+			}
+		}
 	}
 
 	// Use cluster defaults when custom config doesn't define values
@@ -135,8 +143,19 @@ func (d *driver) CreateStorage(cr *imageregistryv1.Config) error {
 	}
 
 	// Set configs from Infrastructure
-	d.Config.Location = infra.Status.PlatformStatus.IBMCloud.Location
-	d.Config.ResourceGroupName = infra.Status.PlatformStatus.IBMCloud.ResourceGroupName
+	if infra.Status.PlatformStatus != nil {
+		if infra.Status.PlatformStatus.Type == configapiv1.IBMCloudPlatformType {
+			d.Config.Location = infra.Status.PlatformStatus.IBMCloud.Location
+			d.Config.ResourceGroupName = infra.Status.PlatformStatus.IBMCloud.ResourceGroupName
+		}
+		if infra.Status.PlatformStatus.Type == configapiv1.PowerVSPlatformType {
+			d.Config.Location, err = cosRegionForPowerVSRegion(infra.Status.PlatformStatus.PowerVS.Region)
+			if err != nil {
+				return err
+			}
+			d.Config.ResourceGroupName = infra.Status.PlatformStatus.PowerVS.ResourceGroup
+		}
+	}
 
 	// Initialize IBMCOS status
 	if cr.Status.Storage.IBMCOS == nil {
@@ -672,8 +691,16 @@ func (d *driver) getIBMCOSClient(serviceInstanceCRN string) (*s3.S3, error) {
 	}
 
 	IBMCOSLocation := imageregistryv1.ImageRegistryConfigStorageIBMCOS{}.Location
-	if infra.Status.PlatformStatus != nil && infra.Status.PlatformStatus.Type == configapiv1.IBMCloudPlatformType {
-		IBMCOSLocation = infra.Status.PlatformStatus.IBMCloud.Location
+	if infra.Status.PlatformStatus != nil {
+		if infra.Status.PlatformStatus.Type == configapiv1.IBMCloudPlatformType {
+			IBMCOSLocation = infra.Status.PlatformStatus.IBMCloud.Location
+		}
+		if infra.Status.PlatformStatus.Type == configapiv1.PowerVSPlatformType {
+			IBMCOSLocation, err = cosRegionForPowerVSRegion(infra.Status.PlatformStatus.PowerVS.Region)
+			if err != nil {
+				return nil, err
+			}
+		}
 	}
 
 	if IBMCOSLocation == "" {

pkg/storage/ibmcos/powervs_regions.go

@@ -0,0 +1,64 @@
+package ibmcos
+
+import (
+	"fmt"
+)
+
+// powerVSRegion
+// Power VS is a cloud offering of Power Systems in IBM Cloud and COS provides object storage service in IBM Cloud.
+// powerVSRegion describes respective IBM Cloud COS region associated with a region in Power VS.
+// It helps to decide COS region from Power VS region with the intention to keep COS in same region as Power VS.
+// This is required since region notation followed by Power VS is different from COS.
+type powerVSRegion struct {
+	description string
+	cosRegion   string
+}
+
+// powerVSRegions provides a mapping between Power VS and COS region.
+var powerVSRegions = map[string]powerVSRegion{
+	"dal": {
+		description: "Dallas, USA",
+		cosRegion:   "us-south",
+	},
+	"eu-de": {
+		description: "Frankfurt, Germany",
+		cosRegion:   "eu-de",
+	},
+	"lon": {
+		description: "London, UK.",
+		cosRegion:   "eu-gb",
+	},
+	"mon": {
+		description: "Montreal, Canada",
+		cosRegion:   "ca-tor",
+	},
+	"osa": {
+		description: "Osaka, Japan",
+		cosRegion:   "jp-osa",
+	},
+	"syd": {
+		description: "Sydney, Australia",
+		cosRegion:   "au-syd",
+	},
+	"sao": {
+		description: "São Paulo, Brazil",
+		cosRegion:   "br-sao",
+	},
+	"tok": {
+		description: "Tokyo, Japan",
+		cosRegion:   "jp-tok",
+	},
+	"us-east": {
+		description: "Washington DC, USA",
+		cosRegion:   "us-east",
+	},
+}
+
+// cosRegionForPowerVSRegion returns the COS region for the specified Power VS region.
+func cosRegionForPowerVSRegion(region string) (string, error) {
+	if r, ok := powerVSRegions[region]; ok {
+		return r.cosRegion, nil
+	}
+
+	return "", fmt.Errorf("cos region corresponding to a powervs region %s not found ", region)
+}

pkg/storage/storage.go

@@ -185,7 +185,6 @@ func GetPlatformStorage(listers *regopclient.StorageListers) (imageregistryv1.Im
 		configapiv1.NutanixPlatformType,
 		configapiv1.KubevirtPlatformType,
 		configapiv1.EquinixMetalPlatformType,
-		configapiv1.PowerVSPlatformType,
 		configapiv1.ExternalPlatformType:
 		break
 
@@ -201,6 +200,7 @@ func GetPlatformStorage(listers *regopclient.StorageListers) (imageregistryv1.Im
 		cfg.GCS = &imageregistryv1.ImageRegistryConfigStorageGCS{}
 		replicas = 2
 	case configapiv1.IBMCloudPlatformType:
+	case configapiv1.PowerVSPlatformType:
 		cfg.IBMCOS = &imageregistryv1.ImageRegistryConfigStorageIBMCOS{}
 		replicas = 2
 	case configapiv1.OpenStackPlatformType: