ROSA: Support for OCM service account credentials

kubernetes-sigs · Dec 9, 2024 · 4cea03f · 4cea03f
1 parent dc86e24
commit 4cea03f
Show file tree

Hide file tree

Showing 2 changed files with 107 additions and 41 deletions.
diff --git a/docs/book/src/topics/rosa/creating-a-cluster.md b/docs/book/src/topics/rosa/creating-a-cluster.md
@@ -1,30 +1,45 @@
 # Creating a ROSA cluster
 
 ## Permissions
-CAPA controller requires an API token in order to be able to provision ROSA clusters:
+### Authentication using service account credentials
+CAPA controller requires service account credentials to be able to provision ROSA clusters:
+1. Visit [https://console.redhat.com/iam/service-accounts](https://console.redhat.com/iam/service-accounts) and create a new service account.
 
-1. Visit [https://console.redhat.com/openshift/token](https://console.redhat.com/openshift/token) to retrieve your API authentication token
-
-1. Create a credentials secret within the target namespace with the token to be referenced later by `ROSAControlePlane`
+1. Create a new kubernetes secret with the service account credentials to be referenced later by `ROSAControlPlane`
     ```shell
     kubectl create secret generic rosa-creds-secret \
-      --from-literal=ocmToken='eyJhbGciOiJIUzI1NiIsI....' \
+      --from-literal=ocmClientId='....' \
+      --from-literal=ocmClientSecret='eyJhbGciOiJIUzI1NiIsI....' \
       --from-literal=ocmApiUrl='https://api.openshift.com' 
     ```
 
-    Alternatively, you can edit CAPA controller deployment to provide the credentials:
-    ```shell
-    kubectl edit deployment -n capa-system capa-controller-manager
+    Note: to consume the secret without the need to reference it from your `ROSAControlPlane`, name your secret as `default-rosa-creds-secret`.
+
+
+### Authentication using SSO offline token (DEPRECATED)
+Instead of the service account credentials you can use SSO offline token, that you can specify either as a secret or specify the offline token
+as an environment variable in the capa manager deployment.
+1. Visit https://console.redhat.com/openshift/token to retrieve your SSO offline authentication token
+
+1. Create a credentials secret within the target namespace with the token to be referenced later by `ROSAControlePlane`
+```shell
+    kubectl create secret generic rosa-creds-secret \
+        --from-literal=ocmToken='eyJhbGciOiJIUzI1NiIsI....' \
+    --from-literal=ocmApiUrl='https://api.openshift.com'
     ```
 
-    and add the following environment variables to the manager container:
-    ```yaml
-      env:
+Alternatively, you can edit CAPA controller deployment to provide the credentials:
+```shell
+    kubectl edit deployment -n capa-system capa-controller-manager
+```
+and add the following environment variables to the manager container:
+```yaml
+    env:
       - name: OCM_TOKEN
         value: "<token>"
       - name: OCM_API_URL
         value: "https://api.openshift.com" # or https://api.stage.openshift.com
-    ```
+```
 
 ## Prerequisites
 

diff --git a/pkg/rosa/client.go b/pkg/rosa/client.go
@@ -4,80 +4,131 @@ package rosa
 import (
 	"context"
 	"fmt"
-	"os"
 
 	sdk "github.com/openshift-online/ocm-sdk-go"
 	ocmcfg "github.com/openshift/rosa/pkg/config"
 	"github.com/openshift/rosa/pkg/ocm"
 	"github.com/sirupsen/logrus"
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	"sigs.k8s.io/cluster-api-provider-aws/v2/pkg/cloud/scope"
 )
 
 const (
-	ocmTokenKey  = "ocmToken"
-	ocmAPIURLKey = "ocmApiUrl"
+	ocmTokenKey        = "ocmToken"
+	ocmAPIURLKey       = "ocmApiUrl"
+	ocmClientIdKey     = "ocmClientId"
+	ocmClientSecretKey = "ocmClientSecret"
 )
 
 // NewOCMClient creates a new OCM client.
 func NewOCMClient(ctx context.Context, rosaScope *scope.ROSAControlPlaneScope) (*ocm.Client, error) {
-	token, url, err := ocmCredentials(ctx, rosaScope)
+	token, url, clientId, clientSecret, err := ocmCredentials(ctx, rosaScope)
 	if err != nil {
 		return nil, err
 	}
-	return ocm.NewClient().Logger(logrus.New()).Config(&ocmcfg.Config{
-		AccessToken: token,
-		URL:         url,
-	}).Build()
+
+	ocmConfig := ocmcfg.Config{
+		URL: url,
+	}
+
+	if clientId != "" && clientSecret != "" {
+		ocmConfig.ClientID = clientId
+		ocmConfig.ClientSecret = clientSecret
+	} else if token != "" {
+		ocmConfig.AccessToken = token
+	}
+
+	return ocm.NewClient().Logger(logrus.New()).Config(&ocmConfig).Build()
 }
 
 func newOCMRawConnection(ctx context.Context, rosaScope *scope.ROSAControlPlaneScope) (*sdk.Connection, error) {
-	logger, err := sdk.NewGoLoggerBuilder().
+	ocmSdkLogger, err := sdk.NewGoLoggerBuilder().
 		Debug(false).
 		Build()
 	if err != nil {
 		return nil, fmt.Errorf("failed to build logger: %w", err)
 	}
-	token, url, err := ocmCredentials(ctx, rosaScope)
+
+	token, url, clientId, clientSecret, err := ocmCredentials(ctx, rosaScope)
 	if err != nil {
 		return nil, err
 	}
 
-	connection, err := sdk.NewConnectionBuilder().
-		Logger(logger).
-		Tokens(token).
-		URL(url).
-		Build()
+	connBuilder := sdk.NewConnectionBuilder().
+		Logger(ocmSdkLogger).
+		URL(url)
+
+	if clientId != "" && clientSecret != "" {
+		connBuilder.Client(clientId, clientSecret)
+	} else if token != "" {
+		connBuilder.Tokens(token)
+	}
+
+	connection, err := connBuilder.Build()
 	if err != nil {
 		return nil, fmt.Errorf("failed to create ocm connection: %w", err)
 	}
 
 	return connection, nil
 }
 
-func ocmCredentials(ctx context.Context, rosaScope *scope.ROSAControlPlaneScope) (string, string, error) {
-	var token string
-	var ocmAPIUrl string
+func ocmCredentials(ctx context.Context, rosaScope *scope.ROSAControlPlaneScope) (string, string, string, string, error) {
+	var token string           // Offline SSO token
+	var ocmClientId string     // Service account client id
+	var ocmClientSecret string // Service account client secret
+	var ocmAPIUrl string       // https://api.openshift.com by default
+	var secret *corev1.Secret
 
-	secret := rosaScope.CredentialsSecret()
+	secret = rosaScope.CredentialsSecret() // We'll retrieve the OCM credentials from the ROSA control plane
 	if secret != nil {
 		if err := rosaScope.Client.Get(ctx, client.ObjectKeyFromObject(secret), secret); err != nil {
-			return "", "", fmt.Errorf("failed to get credentials secret: %w", err)
+			return "", "", "", "", fmt.Errorf("failed to get credentials secret: %w", err)
 		}
+	} else { // If the reference to OCM secret wasn't specified in the ROSA control plane, we'll default to a predefined secret name
+		secret = &corev1.Secret{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "default-rosa-creds-secret",
+				Namespace: rosaScope.Namespace(),
+			},
+		}
+	}
+
+	if err := rosaScope.Client.Get(ctx, client.ObjectKeyFromObject(secret), secret); err != nil {
+		return "", "", "", "", fmt.Errorf("failed to get credentials secret: %w", err)
+	}
+
+	token = string(secret.Data[ocmTokenKey])
+	ocmAPIUrl = string(secret.Data[ocmAPIURLKey])
+	ocmClientId = string(secret.Data[ocmClientIdKey])
+	ocmClientSecret = string(secret.Data[ocmClientSecretKey])
 
-		token = string(secret.Data[ocmTokenKey])
-		ocmAPIUrl = string(secret.Data[ocmAPIURLKey])
-	} else {
-		// fallback to env variables if secrert is not set
+	// Deprecation warning in case SSO offline token was used
+	if token != "" {
+		rosaScope.Info(fmt.Sprintf("Using SSO offline token (%s) is deprecated, use service account credentials instead (%s and %s)",
+			ocmTokenKey, ocmClientIdKey, ocmClientSecretKey))
+	}
+
+	if token == "" && (ocmClientId == "" || ocmClientSecret == "") {
+		// Last fall-back is to use OCM_TOKEN & OCM_API_URL environment variables (soon to be deprecated)
 		token = os.Getenv("OCM_TOKEN")
-		if ocmAPIUrl = os.Getenv("OCM_API_URL"); ocmAPIUrl == "" {
-			ocmAPIUrl = "https://api.openshift.com"
+		ocmAPIUrl = os.Getenv("OCM_API_URL")
+
+		if token != "" {
+			rosaScope.Info(fmt.Sprintf("Defining OCM credentials in environment variable is deprecated, use secret with service account credentials instead (%s and %s)",
+				ocmTokenKey, ocmClientIdKey, ocmClientSecretKey))
+		} else {
+			return "", "", "", "",
+				fmt.Errorf("OCM credentials have not been provided. Make sure to set the secret with service account credentials (%s and %s)",
+					ocmClientIdKey, ocmClientSecretKey)
 		}
 	}
 
-	if token == "" {
-		return "", "", fmt.Errorf("token is not provided, be sure to set OCM_TOKEN env variable or reference a credentials secret with key %s", ocmTokenKey)
+	if ocmAPIUrl == "" {
+		ocmAPIUrl = "https://api.openshift.com" // Defaults to production URL
 	}
-	return token, ocmAPIUrl, nil
+
+	return token, ocmAPIUrl, ocmClientId, ocmClientSecret, nil
 }