--- title: Configuring a GitLab identity provider --- # Configuring a GitLab identity provider {#configuring-gitlab-identity-provider} Configure the `gitlab` identity provider so users can log in to OpenShift Container Platform with GitLab account credentials through OAuth. ## Identity providers in OpenShift Container Platform {#identity-provider-overview_configuring-gitlab-identity-provider} You can configure identity providers by creating a custom resource (CR) that describes the provider and adding it to the cluster. Identity providers enable user authentication in OpenShift Container Platform beyond the default `kubeadmin` user. > [!NOTE] > OpenShift Container Platform usernames containing `/`, `:`, and `%` are not supported. ## About GitLab authentication {#identity-provider-gitlab-about_configuring-gitlab-identity-provider} Review GitLab authentication options for OpenShift Container Platform. Use this integration when you want users to log in with GitLab account credentials through OAuth or OpenID Connect. If you use GitLab version 7.7.0 to 11.0, you connect using OAuth integration. If you use GitLab version 11.1 or later, you can use OpenID Connect (OIDC) to connect instead of OAuth. **Additional resources** {._additional-resources} - [OAuth integration](https://docs.gitlab.com/ce/integration/oauth_provider.html) - [OpenID Connect](https://docs.gitlab.com/ce/integration/openid_connect_provider.html) ## Creating the secret {#identity-provider-creating-secret_configuring-gitlab-identity-provider} Create a `Secret` object in the `openshift-config` namespace to store the client secret for your identity provider. The identity provider custom resource (CR) references this secret during configuration. **Procedure** 1. Create a `Secret` object containing the client secret by running the following command: ```terminal $ oc create secret generic --from-literal=clientSecret= -n openshift-config ``` 2. Optional: Apply the following YAML to create the secret: ```yaml apiVersion: v1 kind: Secret metadata: name: namespace: openshift-config type: Opaque data: clientSecret: ``` 3. Create a `Secret` object from a file by running the following command: ```terminal $ oc create secret generic --from-file= -n openshift-config ``` ## Creating a ConfigMap {#identity-provider-creating-configmap_configuring-gitlab-identity-provider} Create a `ConfigMap` object in the `openshift-config` namespace that contains the certificate authority bundle for the identity provider. OpenShift Container Platform uses this bundle to validate Transport Layer Security (TLS) connections to the identity provider. **Procedure** 1. Define an OpenShift Container Platform `ConfigMap` object containing the CA by running the following command: ```terminal $ oc create configmap ca-config-map --from-file=ca.crt=/path/to/ca -n openshift-config ``` 2. Optional: Apply the following YAML to create the config map: ```yaml apiVersion: v1 kind: ConfigMap metadata: name: ca-config-map namespace: openshift-config data: ca.crt: | ``` The CA must be stored in the `ca.crt` key of the `ConfigMap` object. ## Sample GitLab custom resource {#identity-provider-gitlab-CR_configuring-gitlab-identity-provider} Review the sample GitLab `OAuth` custom resource (CR) to understand provider parameters and acceptable values before you configure the identity provider in your cluster. ```yaml apiVersion: config.openshift.io/v1 kind: OAuth metadata: name: cluster spec: identityProviders: - name: gitlabidp mappingMethod: claim type: GitLab gitlab: clientID: {...} clientSecret: name: gitlab-secret url: https://gitlab.com ca: name: ca-config-map ``` where: `spec.identityProviders.name` : Specifies that the provider name is prefixed to the GitLab numeric user ID to form an identity name. It is also used to build the callback URL. `spec.identityProviders.mappingMethod` : Specifies how mappings are established between identities from this provider and `User` objects. `spec.identityProviders.gitlab.clientID` : Specifies the client ID of a registered GitLab OAuth application. The application must be configured with a callback URL of `https://oauth-openshift.apps../oauth2callback/`. `spec.identityProviders.gitlab.clientSecret` : Specifies a reference to an OpenShift Container Platform `Secret` object containing the client secret issued by GitLab. `spec.identityProviders.gitlab.url` : Specifies the host URL of a GitLab provider. This could either be `https://gitlab.com/` or any other self-hosted instance of GitLab. `spec.identityProviders.gitlab.ca` : Specifies a reference to an OpenShift Container Platform `ConfigMap` object containing the PEM-encoded certificate authority bundle to use in validating server certificates for the configured URL. This value is optional. **Additional resources** {._additional-resources} - [Identity provider parameters](/openshift-docs-markdown/authentication/understanding-identity-provider#identity-provider-parameters_understanding-identity-provider) ## Adding an identity provider to your cluster {#add-identity-provider_configuring-gitlab-identity-provider} Apply the identity provider custom resource (CR) to your cluster after you define it. With this configuration, you can authenticate with the configured identity provider. **Prerequisites** - You have access to a OpenShift Container Platform cluster. - You have created the CR for your identity providers. - You are logged in as an administrator. **Procedure** 1. Apply the defined CR by running the following command: ```terminal $ oc apply -f ``` > [!NOTE] > If a CR does not exist, `oc apply` creates a new CR and might trigger the following warning: `Warning: oc apply should be used on resources created by either oc create --save-config or oc apply`. In this case you can safely ignore this warning. 2. Log in to the cluster as a user from your identity provider, entering the password when prompted. ```terminal $ oc login -u ``` 3. Confirm that the user logged in successfully and that the username displays by running the following command: ```terminal $ oc whoami ``` **Additional resources** {._additional-resources} - [GitLab.com](https://gitlab.com/)