Operator to fetch region and IaaS provider for IPI cluster (#45)

* Operator to fetch region and IaaS provider for IPI cluster

* move static string to contants

* fix constants

Author: Bhagyashreek8

config/rbac/role.yaml

@@ -128,6 +128,13 @@ rules:
   - deployments/finalizers
   verbs:
   - update
+- apiGroups:
+  - config.openshift.io
+  resources:
+  - infrastructures
+  verbs:
+  - get
+  - list
 - apiGroups:
   - monitoring.coreos.com
   resources:

controllers/constants/constants.go

@@ -98,6 +98,9 @@ const (
 	DefaultNamespace       = "default"
 	ReconcilationTime      = 5 * time.Minute
 	TransportEndpointError = "transport endpoint is not connected"
+
+	InfraProviderPlatformIBM = "IBMCloud"
+	InfraProviderType        = "VPC"
 )
 
 var CommonCSIResourceLabels = map[string]string{

controllers/ibmobjectcsi_controller.go

@@ -88,6 +88,7 @@ type IBMObjectCSIReconciler struct {
 //+kubebuilder:rbac:groups=apiextensions.k8s.io,resources=customresourcedefinitions,verbs=create;list;watch;delete
 //+kubebuilder:rbac:groups=objectdriver.csi.ibm.com,resources=*,verbs=*
 //+kubebuilder:rbac:groups=storage.k8s.io,resources=storageclasses,verbs=create;get;list;watch;delete;update
+//+kubebuilder:rbac:groups=config.openshift.io,resources=infrastructures,verbs=get;list
 
 // Reconcile is part of the main kubernetes reconciliation loop which aims to
 // move the current state of the cluster closer to the desired state.

controllers/ibmobjectcsi_controller_test.go

@@ -898,7 +898,7 @@ func TestIBMObjectCSIReconcile(t *testing.T) {
 				Client: client,
 				Scheme: scheme,
 				// Recorder:         record.NewFakeRecorder(0),
-				ControllerHelper: common.NewControllerHelper(client),
+				ControllerHelper: common.NewControllerHelper(client, TestLog),
 			}
 
 			res, err := ibmObjectCSIReconciler.Reconcile(TestCtx, ibmObjectCSIReconcileRequest)

controllers/util/common/common.go

@@ -10,6 +10,7 @@ import (
 	"github.com/IBM/ibm-object-csi-driver-operator/controllers/internal/crutils"
 	"github.com/IBM/ibm-object-csi-driver-operator/controllers/util"
 	"github.com/go-logr/logr"
+	openshiftclient "github.com/openshift/client-go/config/clientset/versioned"
 	corev1 "k8s.io/api/core/v1"
 	rbacv1 "k8s.io/api/rbac/v1"
 	storagev1 "k8s.io/api/storage/v1"
@@ -18,6 +19,7 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/client-go/kubernetes"
+	"k8s.io/client-go/rest"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/apiutil"
 )
@@ -34,9 +36,10 @@ type ControllerHelper struct {
 }
 
 // NewControllerHelper ...
-func NewControllerHelper(client client.Client) *ControllerHelper {
+func NewControllerHelper(client client.Client, logger logr.Logger) *ControllerHelper {
 	return &ControllerHelper{
 		Client: client,
+		Log:    logger,
 	}
 }
 
@@ -251,17 +254,24 @@ func (ch *ControllerHelper) getAccessorAndFinalizerName(instance crutils.Instanc
 	return accessor, finalizerName, nil
 }
 
-// Check the platform, if IBM Cloud then get Region and IaaS provider
-func (ch *ControllerHelper) GetIBMClusterInfo(clientset *kubernetes.Clientset) error {
+// Check the platform, if IBMCloud then get Region and IaaS provider
+// If not IBMCloud, check if it is unmanaged/IPI cluster
+func (ch *ControllerHelper) GetClusterInfo(inConfig rest.Config) error {
+	logger := ch.Log.WithName("getClusterInfo")
+	logger.Info("Checking cluster platform...")
+
 	var listOptions = &client.ListOptions{}
 	var err error
 	nodes := corev1.NodeList{}
 
-	logger := ch.Log.WithName("getClusterInfo")
-	logger.Info("Checking cluster platform...")
+	k8sClient, err := kubernetes.NewForConfig(&inConfig)
+	if err != nil {
+		logger.Error(err, "Unable to load cluster config")
+		return err
+	}
 
-	if clientset != nil {
-		list, err := clientset.CoreV1().Nodes().List(context.TODO(), metav1.ListOptions{})
+	if k8sClient != nil {
+		list, err := k8sClient.CoreV1().Nodes().List(context.TODO(), metav1.ListOptions{})
 		if err == nil {
 			nodes = *list
 		}
@@ -273,21 +283,74 @@ func (ch *ControllerHelper) GetIBMClusterInfo(clientset *kubernetes.Clientset) e
 		return err
 	}
 
-	logger.Info("Get cluster region...")
+	logger.Info("Get IBM cluster region...")
 	if val, ok := nodes.Items[0].Labels["ibm-cloud.kubernetes.io/region"]; ok {
 		ch.Region = val
-		logger.Info("Detected IBM Cluster region: ", ch.Region)
+		logger.Info("Detected", "IBM Cluster region: ", ch.Region)
+	} else {
+		logger.Info("Node label 'ibm-cloud.kubernetes.io/region' not found")
 	}
 
-	logger.Info("Get cluster IaaS Provider...")
+	logger.Info("Get IBM cluster IaaS Provider...")
 	if val, ok := nodes.Items[0].Labels["ibm-cloud.kubernetes.io/iaas-provider"]; ok {
-		logger.Info("Detected IBM IaaS provider: ", val)
+		logger.Info("Detected", "IBM IaaS provider: ", val)
 		if val == "g2" {
 			ch.IaaSProvider = constants.IaasIBMVPC
 		} else {
 			ch.IaaSProvider = constants.IaasIBMClassic
 		}
-		logger.Info("Detected endpoint type: ", ch.IaaSProvider)
+		logger.Info("Detected", "endpoint type: ", ch.IaaSProvider)
+	} else {
+		logger.Info("Node label 'ibm-cloud.kubernetes.io/iaas-provider' not found")
+	}
+
+	if ch.Region == "" || ch.IaaSProvider == "" {
+		// check if it is unmanaged cluster
+		logger.Info("Region or IaaSProvider not set. checking if it is unmanaged cluster")
+
+		ocClient, err := openshiftclient.NewForConfig(&inConfig)
+		if err != nil {
+			logger.Error(err, "Unable to load cluster config")
+			return err
+		}
+
+		infra, err := ocClient.ConfigV1().Infrastructures().Get(context.TODO(), "cluster", metav1.GetOptions{})
+		if err != nil {
+			logger.Error(err, "Failed to get infrastructure")
+			return err
+		}
+
+		logger.Info("cluster infrastructure", "platformStatus:", infra.Status.PlatformStatus)
+
+		platformType := infra.Status.PlatformStatus.Type
+		logger.Info("Detected", "infra cloud provider platform: ", platformType)
+
+		if platformType == constants.InfraProviderPlatformIBM {
+			logger.Info("Get cluster region...")
+			region := infra.Status.PlatformStatus.IBMCloud.Location
+			if region != "" {
+				ch.Region = region
+				logger.Info("Detected", "Cluster region: ", ch.Region)
+			} else {
+				logger.Info("cluster region not found")
+			}
+
+			logger.Info("Get cluster Provider...")
+			providerType := infra.Status.PlatformStatus.IBMCloud.ProviderType
+			if providerType != "" {
+				logger.Info("Detected", "IaaS provider: ", providerType)
+				if providerType == constants.InfraProviderType {
+					ch.IaaSProvider = constants.IaasIBMVPC
+				} else {
+					ch.IaaSProvider = constants.IaasIBMClassic
+				}
+				logger.Info("Detected", "endpoint type: ", ch.IaaSProvider)
+			} else {
+				logger.Info("cluster IaaS provider not found")
+			}
+		} else {
+			logger.Info("cloud provider is not IBMCloud")
+		}
 	}
 	return nil
 }

go.mod

@@ -8,6 +8,7 @@ require (
 	github.com/imdario/mergo v0.3.16
 	github.com/onsi/ginkgo/v2 v2.19.1
 	github.com/onsi/gomega v1.34.1
+	github.com/openshift/client-go v0.0.0-20240528061634-b054aa794d87
 	github.com/presslabs/controller-util v0.12.0
 	github.com/stretchr/testify v1.9.0
 	golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56
@@ -46,6 +47,7 @@ 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 v0.0.0-20240527133614-ba11c1587003 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/prometheus/client_golang v1.16.0 // indirect

go.sum

@@ -80,6 +80,10 @@ github.com/onsi/ginkgo/v2 v2.19.1 h1:QXgq3Z8Crl5EL1WBAC98A5sEBHARrAJNzAmMxzLcRF0
 github.com/onsi/ginkgo/v2 v2.19.1/go.mod h1:O3DtEWQkPa/F7fBMgmZQKKsluAy8pd3rEQdrjkPb9zA=
 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-20240527133614-ba11c1587003 h1:ewhIvyXCcvH6m3U02bMFtd/DfsmOSbOCuVzon+zGu7g=
+github.com/openshift/api v0.0.0-20240527133614-ba11c1587003/go.mod h1:OOh6Qopf21pSzqNVCB5gomomBXb8o5sGKZxG2KNpaXM=
+github.com/openshift/client-go v0.0.0-20240528061634-b054aa794d87 h1:JtLhaGpSEconE+1IKmIgCOof/Len5ceG6H1pk43yv5U=
+github.com/openshift/client-go v0.0.0-20240528061634-b054aa794d87/go.mod h1:3IPD4U0qyovZS4EFady2kqY32m8lGcbs/Wx+yprg9z8=
 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=

main.go

@@ -25,7 +25,6 @@ import (
 	// to ensure that exec-entrypoint and run can make use of them.
 	"k8s.io/apimachinery/pkg/runtime"
 	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
-	"k8s.io/client-go/kubernetes"
 	clientgoscheme "k8s.io/client-go/kubernetes/scheme"
 	_ "k8s.io/client-go/plugin/pkg/client/auth"
 	"k8s.io/client-go/rest"
@@ -93,24 +92,16 @@ func main() {
 		setupLog.Error(err, "unable to start manager")
 		os.Exit(1)
 	}
-	controllerHelper := common.NewControllerHelper(mgr.GetClient())
+	controllerHelper := common.NewControllerHelper(mgr.GetClient(), setupLog)
 
 	// TODO: TIER Based SC Get cluster info
-	var clstrClient *kubernetes.Clientset
 	inConfig, err := rest.InClusterConfig()
 	if err != nil {
 		setupLog.Info("Get Cluster Info: Unable to load config")
 	} else {
-		clstrClient, err = kubernetes.NewForConfig(inConfig)
+		err = controllerHelper.GetClusterInfo(*inConfig)
 		if err != nil {
-			setupLog.Info("Get Cluster Info: Unable to load config")
-		} else {
-			err = controllerHelper.GetIBMClusterInfo(clstrClient)
-			if err != nil {
-				setupLog.Info("Get Cluster Info", "warning", err)
-			} else {
-				setupLog.Info("Detected: ", "IaaS Provider", controllerHelper.GetIaaSProvider())
-			}
+			setupLog.Info("Get Cluster Info", "warning", err)
 		}
 	}