Red Hat OpenShift Container Platform

Configuring the OAuth server for a hosted cluster by using the CLI

You can configure the internal OAuth server for your hosted cluster by using the command-line interface (CLI).

You can configure OAuth for the following supported identity providers:

oidc
htpasswd
keystone
ldap
basic-authentication
request-header
github
gitlab
google

Adding any identity provider in the OAuth configuration removes the default kubeadmin user provider.

When you configure identity providers, you must configure at least one NodePool replica in your hosted cluster in advance. Traffic for DNS resolution is sent through the worker nodes. You do not need to configure the NodePool replicas in advance for the htpasswd and request-header identity providers.

Prerequisites

You created your hosted cluster.

Procedure

Edit the HostedCluster custom resource (CR) on the management cluster by running the following command:
```
$ oc edit hostedcluster <hosted_cluster_name> -n <hosted_cluster_namespace>
```
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>
  namespace: <hosted_cluster_namespace>
spec:
  configuration:
    oauth:
      identityProviders:
      - openID:
          claims:
            email:
              - <email_address>
            name:
              - <display_name>
            preferredUsername:
              - <preferred_username>
          clientID: <client_id>
          clientSecret:
            name: <client_id_secret_name>
          issuer: https://example.com/identity
        mappingMethod: lookup
        name: IAM
        type: OpenID
```
- metadata.name specifies your hosted cluster name.
- metadata.namespace specifies your hosted cluster namespace.
- spec.configuration.oauth.identityProviders.openID is a provider name that 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.
- spec.configuration.oauth.identityProviders.openID.claims.email defines a list of attributes to use as the email address.
- spec.configuration.oauth.identityProviders.openID.claims.name defines a list of attributes to use as a display name.
- spec.configuration.oauth.identityProviders.openID.claims.preferredUsername defines a list of attributes to use as a preferred user name.
- spec.configuration.oauth.identityProviders.openID.clientID 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.
- spec.configuration.oauth.identityProviders.openID.clientSecret.name defines a secret of a client registered with the OpenID provider.
- spec.configuration.oauth.identityProviders.openID.issuer specifies the Issuer Identifier described in the OpenID spec. You must use https without query or fragment component. For more information about Issuer Identifiers, see "Issuer Identifier".
- spec.configuration.oauth.identityProviders.mappingMethod defines a mapping method that controls how mappings are established between identities of this provider and User objects.
Save the file to apply the changes.