$ oc create secret generic <secret_name> --from-literal=clientSecret=<secret> -n openshift-config
Configure a gitlab
identity provider to use
GitLab.com or any other GitLab instance as an identity
provider. If you use GitLab version 7.7.0 to 11.0, you connect using the
OAuth integration.
If you use GitLab version 11.1 or later, you can use
OpenID Connect (OIDC)
to connect instead of OAuth.
Identity providers use Azure Red Hat OpenShift Secrets in the openshift-config
namespace to contain the client secret, client certificates, and keys.
You can define an Azure Red Hat OpenShift Secret containing a string by using the following command.
$ oc create secret generic <secret_name> --from-literal=clientSecret=<secret> -n openshift-config
You can define an Azure Red Hat OpenShift Secret containing the contents of a file, such as a certificate file, by using the following command.
$ oc create secret generic <secret_name> --from-file=/path/to/file -n openshift-config
Identity providers use Azure Red Hat OpenShift ConfigMaps in the openshift-config
namespace to contain the certificate authority bundle. These are primarily
used to contain certificate bundles needed by the identity provider.
Define an Azure Red Hat OpenShift ConfigMap containing the
certificate authority by using the following command. The certificate
authority must be stored in the ca.crt
key of the ConfigMap.
$ oc create configmap ca-config-map --from-file=ca.crt=/path/to/ca -n openshift-config
The following Custom Resource (CR) shows the parameters and acceptable values for a GitLab identity provider.
apiVersion: config.openshift.io/v1
kind: OAuth
metadata:
name: cluster
spec:
identityProviders:
- name: gitlabidp (1)
mappingMethod: claim (2)
type: GitLab
gitlab:
clientID: {...} (3)
clientSecret: (4)
name: gitlab-secret
url: https://gitlab.com (5)
ca: (6)
name: ca-config-map
1 | This provider name is prefixed to the GitLab numeric user ID to form an identity name. It is also used to build the callback URL. |
2 | Controls how mappings are established between this provider’s identities and user objects. |
3 | The client ID of a
registered GitLab OAuth application.
The application must be configured with a callback URL of
https://oauth-openshift.apps.<cluster-name>.<cluster-domain>/oauth2callback/<idp-provider-name> . |
4 | Reference to an Azure Red Hat OpenShift Secret containing the client secret issued by GitLab. |
5 | The host URL of a GitLab provider. This could either be https://gitlab.com/
or any other self hosted instance of GitLab. |
6 | Optional: Reference to an Azure Red Hat OpenShift ConfigMap containing the PEM-encoded certificate authority bundle to use in validating server certificates for the configured URL. |
After you install your cluster, add an identity provider to it so your users can authenticate.
Create an Azure Red Hat OpenShift cluster.
Create the Custom Resource (CR) for your identity providers.
You must be logged in as an administrator.
Apply the defined CR:
$ oc apply -f </path/to/CR>
If a CR does not exist, |
Log in to the cluster as a user from your identity provider, entering the password when prompted.
$ oc login -u <username>
Confirm that the user logged in successfully, and display the user name.
$ oc whoami