OADP-3340: Support the standardized Azure Identity configuration flow via OLM and CCO for OADP

bundle/manifests/oadp-operator.clusterserviceversion.yaml

@@ -163,7 +163,7 @@ metadata:
     features.operators.openshift.io/proxy-aware: "true"
     features.operators.openshift.io/tls-profiles: "false"
     features.operators.openshift.io/token-auth-aws: "true"
-    features.operators.openshift.io/token-auth-azure: "false"
+    features.operators.openshift.io/token-auth-azure: "true"
     features.operators.openshift.io/token-auth-gcp: "false"
     olm.skipRange: '>=0.0.0 <99.0.0'
     operatorframework.io/suggested-namespace: openshift-adp

config/manifests/bases/oadp-operator.clusterserviceversion.yaml

@@ -17,7 +17,7 @@ metadata:
     features.operators.openshift.io/proxy-aware: "true"
     features.operators.openshift.io/tls-profiles: "false"
     features.operators.openshift.io/token-auth-aws: "true"
-    features.operators.openshift.io/token-auth-azure: "false"
+    features.operators.openshift.io/token-auth-azure: "true"
     features.operators.openshift.io/token-auth-gcp: "false"
     olm.skipRange: '>=0.0.0 <99.0.0'
     operatorframework.io/suggested-namespace: openshift-adp

controllers/bucket_controller.go

@@ -115,14 +115,15 @@ func (b BucketReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl
 			return ctrl.Result{Requeue: true}, nil
 		}
 	}
-	var ok bool
-	if common.CCOWorkflow() {
+	var ok, CCO bool
+	CCO, _ = common.CCOWorkflow()
+	if CCO {
 		// wait for the credential request to be processed and the secret to be created
 		log.Info(fmt.Sprintf("Following standardized STS workflow, waiting for for the credential request to be processed and provision the secret"))
 		installNS := os.Getenv("WATCH_NAMESPACE")
 		_, err = b.WaitForSecret(installNS, VeleroAWSSecretName)
 		if err != nil {
-			log.Error(err, "unable to fetch secert created by CCO")
+			log.Error(err, "unable to fetch secret created by CCO")
 			return result, err
 		}
 	}

main.go

@@ -22,14 +22,18 @@ import (
 	"fmt"
 	"github.com/openshift/oadp-operator/pkg/common"
 	monitor "github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1"
+	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/apimachinery/pkg/types"
+	"k8s.io/apimachinery/pkg/util/wait"
 	"k8s.io/client-go/discovery"
 	"k8s.io/client-go/kubernetes"
 	"os"
 	client "sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/config"
+	"time"
 
 	// Import all Kubernetes client auth plugins (e.g. Azure, GCP, OIDC, etc.)
 	// to ensure that exec-entrypoint and run can make use of them.
@@ -101,13 +105,9 @@ func main() {
 		os.Exit(1)
 	}
 
-	// check if this is standardized STS workflow via OLM and CCO
-	if common.CCOWorkflow() {
-		setupLog.Info("AWS Role ARN specified by the user, following standardized STS workflow")
-		// ROLEARN env var is set via operator subscription
-		roleARN := os.Getenv("ROLEARN")
-		setupLog.Info("getting role ARN", "role ARN =", roleARN)
-
+	// check if this is standardized STS/Azure Identity workflow via OLM and CCO\
+	CCO, provider := common.CCOWorkflow()
+	if CCO && len(provider) > 0 {
 		// check if cred request API exists in the cluster before creating a cred request
 		setupLog.Info("Checking if credentialsrequest CRD exists in the cluster")
 		credReqCRDExists, err := DoesCRDExist(CloudCredentialGroupVersion, CloudCredentialsCRDName)
@@ -116,15 +116,50 @@ func main() {
 			os.Exit(1)
 		}
 
-		if credReqCRDExists {
-			// create cred request
-			setupLog.Info(fmt.Sprintf("Creating credentials request for role: %s, and WebIdentityTokenPath: %s", roleARN, WebIdentityTokenPath))
-			if err := CreateCredRequest(roleARN, WebIdentityTokenPath, watchNamespace); err != nil {
-				if !errors.IsAlreadyExists(err) {
-					setupLog.Error(err, "unable to create credRequest")
-					os.Exit(1)
+		if provider == "aws" {
+			setupLog.Info("AWS Role ARN specified by the user, following standardized STS workflow")
+			// ROLEARN env var is set via operator subscription
+			roleARN := os.Getenv("ROLEARN")
+			setupLog.Info("getting role ARN", "role ARN =", roleARN)
+
+			if credReqCRDExists {
+				// create cred request
+				setupLog.Info(fmt.Sprintf("Creating credentials request for role: %s, and WebIdentityTokenPath: %s", roleARN, WebIdentityTokenPath))
+				if err := CreateCredRequestAWS(roleARN, WebIdentityTokenPath, watchNamespace); err != nil {
+					if !errors.IsAlreadyExists(err) {
+						setupLog.Error(err, "unable to create credRequest")
+						os.Exit(1)
+					}
+				}
+			}
+		}
+
+		if provider == "azure" {
+			setupLog.Info("Azure CLIENTID, TENANTID and SUBSCRIPTIONID specified by the user, following standardized Azure Identity workflow")
+			clientID := os.Getenv("CLIENTID")
+			tenantID := os.Getenv("TENANTID")
+			subscriptionID := os.Getenv("SUBSCRIPTIONID")
+			setupLog.Info("getting CLIENTID", "CLIENTID=", clientID)
+			setupLog.Info("getting TENANTID", "TENANTID=", tenantID)
+			setupLog.Info("getting SUBSCRIPTIONID", "SUBSCRIPTIONID=", subscriptionID)
+
+			if credReqCRDExists {
+				// create cred request
+				setupLog.Info(fmt.Sprintf("Creating credentials request for clientID: %s, tenantID: %s, subscriptionID: %s and WebIdentityTokenPath: %s", clientID, tenantID, subscriptionID, WebIdentityTokenPath))
+				if err := CreateCredRequestAzure(clientID, tenantID, subscriptionID, WebIdentityTokenPath, watchNamespace); err != nil {
+					if !errors.IsAlreadyExists(err) {
+						setupLog.Error(err, "unable to create credRequest")
+						os.Exit(1)
+					}
 				}
 			}
+
+			// wait for credentials request to be processed in ARO cluster
+			_, err := WaitForSecret(watchNamespace, "cloud-credentials-azure")
+			if err != nil {
+				setupLog.Error(err, "unable to fetch secret created by CCO")
+				os.Exit(1)
+			}
 		}
 	}
 
@@ -287,7 +322,7 @@ func DoesCRDExist(CRDGroupVersion, CRDName string) (bool, error) {
 }
 
 // CreateCredRequest WITP : WebIdentityTokenPath
-func CreateCredRequest(roleARN string, WITP string, secretNS string) error {
+func CreateCredRequestAWS(roleARN string, WITP string, secretNS string) error {
 	cfg := config.GetConfigOrDie()
 	client, err := client.New(cfg, client.Options{})
 	if err != nil {
@@ -339,3 +374,91 @@ func CreateCredRequest(roleARN string, WITP string, secretNS string) error {
 	setupLog.Info("Custom resource credentialsrequest created successfully")
 	return nil
 }
+
+// For Azure azureFederatedTokenFile is same as WebIdentityTokenPath for AWS
+func CreateCredRequestAzure(clientID string, tenantID string, subscriptionID string, azureFederatedTokenFile string, secretNS string) error {
+	cfg := config.GetConfigOrDie()
+	client, err := client.New(cfg, client.Options{})
+	if err != nil {
+		setupLog.Error(err, "unable to create client")
+	}
+
+	// Create Credentials Request to be processed by CCO (Cloud Credentials Operator)
+	credRequest := &unstructured.Unstructured{
+		Object: map[string]interface{}{
+			"apiVersion": "cloudcredential.openshift.io/v1",
+			"kind":       "CredentialsRequest",
+			"metadata": map[string]interface{}{
+				"name":      "oadp-azure-credentials-request",
+				"namespace": "openshift-cloud-credential-operator",
+			},
+			"spec": map[string]interface{}{
+				"secretRef": map[string]interface{}{
+					"name":      "cloud-credentials-azure",
+					"namespace": secretNS,
+				},
+				"serviceAccountNames": []interface{}{
+					"openshift-adp-controller-manager",
+				},
+				"providerSpec": map[string]interface{}{
+					"apiVersion":    "cloudcredential.openshift.io/v1",
+					"kind":          "AzureProviderSpec",
+					"azureClientID": clientID,
+					// region as specified in the RH Azure identity docs
+					"azureRegion":         "centralus",
+					"azureSubscriptionID": subscriptionID,
+					"azureTenantID":       tenantID,
+					// TODO: check type/name of rolebindings needed for credentials Request
+					"roleBindings": []interface{}{
+						map[string]interface{}{
+							"role": "Contributor",
+						},
+					},
+				},
+				"cloudTokenPath": azureFederatedTokenFile,
+			},
+		},
+	}
+
+	if err := client.Create(context.Background(), credRequest); err != nil {
+		setupLog.Error(err, "unable to create credentials request resource")
+	}
+
+	setupLog.Info("Custom resource credentialsrequest for azure created successfully")
+	return nil
+
+}
+
+func WaitForSecret(namespace, name string) (*corev1.Secret, error) {
+	// set a timeout of 10 minutes
+	timeout := 10 * time.Minute
+
+	secret := corev1.Secret{}
+	key := types.NamespacedName{
+		Name:      name,
+		Namespace: namespace,
+	}
+
+	cfg := config.GetConfigOrDie()
+	client, err := client.New(cfg, client.Options{})
+	if err != nil {
+		setupLog.Error(err, "unable to create client")
+	}
+
+	err = wait.PollImmediate(5*time.Second, timeout, func() (bool, error) {
+
+		err := client.Get(context.Background(), key, &secret)
+		if err != nil {
+			if errors.IsNotFound(err) {
+				return false, nil
+			}
+		}
+		return true, nil
+	})
+
+	if err != nil {
+		return nil, err
+	}
+
+	return &secret, nil
+}

pkg/bucket/client.go

@@ -57,8 +57,8 @@ func getCredentialFromCloudStorageSecret(a client.Client, cloudStorage v1alpha1.
 		if err != nil {
 			return "", err
 		}
-
-		if common.CCOWorkflow() {
+		CCO, _ := common.CCOWorkflow()
+		if CCO {
 			filename, err = SharedCredentialsFileFromSecret(secret)
 			if err != nil {
 				return "", err

pkg/common/common.go

@@ -184,15 +184,26 @@ func AppendTTMapAsCopy[T comparable](add ...map[T]T) map[T]T {
 	return base
 }
 
-// CCOWorkflow checks if the AWS STS secret is to be obtained from Cloud Credentials Operator (CCO)
+// CCOWorkflow checks if the AWS STS/Azure Identity secret is to be obtained from Cloud Credentials Operator (CCO)
 // if the user provides role ARN during installation then the ARN gets set as env var on operator deployment
 // during installation via OLM
-func CCOWorkflow() bool {
+// for Azure identity the user needs to provide clientID, tenantID and subscriptionID
+func CCOWorkflow() (CCO bool, provider string) {
+	// AWS STS case
 	roleARN := os.Getenv("ROLEARN")
 	if len(roleARN) > 0 {
-		return true
+		return true, "aws"
 	}
-	return false
+
+	//Azure Identity case
+	clientID := os.Getenv("CLIENTID")
+	tenantID := os.Getenv("TENANTID")
+	subscriptionID := os.Getenv("SUBSCRIPTIONID")
+	if len(clientID) > 0 && len(tenantID) > 0 && len(subscriptionID) > 0 {
+		return true, "azure"
+	}
+
+	return false, ""
 }
 
 // StripDefaultPorts removes port 80 from HTTP URLs and 443 from HTTPS URLs.