Chapter 3. Authentication and authorization for hosted control planes

Procedure

1. Edit the HostedCluster custom resource (CR) on the hosting cluster by running the following command:

   $ oc edit <hosted_cluster_name> -n <hosted_cluster_namespace>

2. Add the OAuth configuration in the HostedCluster CR by using the following example:

   apiVersion: hypershift.openshift.io/v1alpha1
   kind: HostedCluster
   metadata:
     name: <hosted_cluster_name> 1
     namespace: <hosted_cluster_namespace> 2
   spec:
     configuration:
       oauth:
         identityProviders:
         - openID: 3
             claims:
               email: 4
                 - <email_address>
               name: 5
                 - <display_name>
               preferredUsername: 6
                 - <preferred_username>
             clientID: <client_id> 7
             clientSecret:
               name: <client_id_secret_name> 8
             issuer: https://example.com/identity 9
           mappingMethod: lookup 10
           name: IAM
           type: OpenID

   1

   Specifies your hosted cluster name.

   2

   Specifies your hosted cluster namespace.

   3

   This provider name is prefixed to the value of the identity claim to form an identity name. The provider name is also used to build the redirect URL.

   4

   Defines a list of attributes to use as the email address.

   5

   Defines a list of attributes to use as a display name.

   6

   Defines a list of attributes to use as a preferred user name.

   7

   Defines the ID of a client registered with the OpenID provider. You must allow the client to redirect to the https://oauth-openshift.apps.<cluster_name>.<cluster_domain>/oauth2callback/<idp_provider_name> URL.

   8

   Defines a secret of a client registered with the OpenID provider.

   9

   The Issuer Identifier described in the OpenID spec. You must use https without query or fragment component.

   10

   Defines a mapping method that controls how mappings are established between identities of this provider and User objects.

3. Save the file to apply the changes.

Procedure

1. Navigate to Home API Explorer.
2. Use the Filter by kind box to search for your HostedCluster resource.
3. Click the HostedCluster resource that you want to edit.
4. Click the Instances tab.
5. Click the Options menu next to your hosted cluster name entry and click Edit HostedCluster.

6. Add the OAuth configuration in the YAML file:

   spec:
     configuration:
       oauth:
         identityProviders:
         - openID: 1
             claims:
               email: 2
                 - <email_address>
               name: 3
                 - <display_name>
               preferredUsername: 4
                 - <preferred_username>
             clientID: <client_id> 5
             clientSecret:
               name: <client_id_secret_name> 6
             issuer: https://example.com/identity 7
           mappingMethod: lookup 8
           name: IAM
           type: OpenID

   1

   This provider name is prefixed to the value of the identity claim to form an identity name. The provider name is also used to build the redirect URL.

   2

   Defines a list of attributes to use as the email address.

   3

   Defines a list of attributes to use as a display name.

   4

   Defines a list of attributes to use as a preferred user name.

   5

   Defines the ID of a client registered with the OpenID provider. You must allow the client to redirect to the https://oauth-openshift.apps.<cluster_name>.<cluster_domain>/oauth2callback/<idp_provider_name> URL.

   6

   Defines a secret of a client registered with the OpenID provider.

   7

   The Issuer Identifier described in the OpenID spec. You must use https without query or fragment component.

   8

   Defines a mapping method that controls how mappings are established between identities of this provider and User objects.

7. Click Save.