Skip to content

Commit 124edbe

Browse files
committed
Incorporated Fabrice's comments
1 parent 81cc9d6 commit 124edbe

File tree

2 files changed

+15
-14
lines changed

2 files changed

+15
-14
lines changed

modules/authentication/proc-enable-user-authentication-with-gitlab-basic.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@
44
= Enable user authentication with GitLab
55

66
[role="_abstract"]
7-
Add GitLab to your {product-very-short} deployment
8-
and use it as an authentication provider.
7+
Add GitLab to your {product-very-short} deployment and use it as an authentication provider.
98

109
.Prerequisites
1110
include::snip-enable-user-authentication-with-gitlab-common-prerequisites.adoc[]

modules/authentication/snip-enable-user-authentication-with-gitlab-common-first-steps.adoc

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,30 @@
11
:_mod-docs-content-type: SNIPPET
22

3-
. Allow {product-short} to authenticate with GitLab, by creating a GitLab OAuth application.
4-
.. link:https://docs.gitlab.com/integration/oauth_provider/[Register a GitLab OAuth 2 application] with the following configuration:
3+
. Register GitLab OAuth 2 application to allow {product-very-short} to authenticate with GitLab with the required callback URL and permissions.
4+
.. link:https://docs.gitlab.com/integration/oauth_provider/[Register a GitLab OAuth 2 application] using the following configuration:
55

66
GitLab OAuth 2 application name::
7-
Enter a unique name identifying your GitLab OAuth 2 application, such as `authenticating-with-rhdh-__<GUID>__`.
7+
Enter a unique name, such as `authenticating-with-rhdh-__<GUID>__`.
88

99
Redirect URI::
1010
Enter your {product-short} URL: `pass:c,a,q[{my-product-url}]`.
1111

1212
Authorization callback URL::
13-
Enter your {product-short} authentication backend URL: `pass:c,a,q[{my-product-url}/api/auth/gitlab/handler/frame]`.
13+
Enter your authentication backend URL: `pass:c,a,q[{my-product-url}/api/auth/gitlab/handler/frame]`.
1414

1515
Authorized application scope::
1616
Enable `email`, `profile`, `openid`, and `read_user`.
1717

18-
.. Save the application and note down the following values for the next step:
18+
.. Save the application and record these values for the next step:
1919

2020
* **OAuth 2 Client ID**, available in the *Application ID* field
2121
* **OAuth 2 Client secret**, accessible by selecting *Copy* in the *Secret* field
2222
23-
. Add your GitLab credentials to {product-short}
24-
by adding the following key/value pairs to {configuring-book-link}#provisioning-your-custom-configuration[your {product-short} secrets].
25-
You can use these secrets in the {product-short} configuration files by using their environment variable name.
23+
. Add your GitLab credentials to {configuring-book-link}#provisioning-your-custom-configuration[your {product-very-short} secrets] using the following key/value pairs.
24+
Use these environment variables in your {product-very-short} configuration files.
25+
26+
`GITLAB_HOST`::
27+
Enter your GitLab host: `<gitlab_host>`.
2628

2729
`GITLAB_CLIENT_ID`::
2830
Enter the saved **OAuth 2 Client ID**.
@@ -33,7 +35,7 @@ Enter the saved **OAuth 2 Client Secret**.
3335
`GITLAB_URL`::
3436
Enter the GitLab host domain: __`<gitlab_host_domain>`__.
3537

36-
`GITLAB_ORG`::
38+
`GITLAB_PARENT_ORG`::
3739
Enter your GitLab organization name, such as `__<your_gitlab_organization_name>__`.
3840

3941
. Enable the GitLab catalog provider plugin in your `dynamic-plugins.yaml` file to import GitLab users and groups to the {product-short} software catalog.
@@ -45,7 +47,7 @@ plugins:
4547
disabled: false
4648
----
4749
48-
. Enable provisioning GitLab users and groups to the {product-short} software catalog by adding the GitLab catalog provider section to your `{my-app-config-file}` file:
50+
. Enable provisioning for GitLab users and groups to the {product-short} software catalog by adding the provider section to your {product-very-short} `{my-app-config-file}` file:
4951
+
5052
[source,yaml]
5153
----
@@ -68,7 +70,7 @@ catalog:
6870
----
6971
7072
`host`::
71-
Enter your GitLab instance address: `${GITLAB_HOST}`.
73+
Enter your GitLab instance address: pass:c,a,q[`${GITLAB_HOST}`].
7274
7375
`group`::
7476
Enter your configured link:https://docs.gitlab.com/user/group/[GitLab parent group]: `${GITLAB_PARENT_ORG}`.
@@ -82,7 +84,7 @@ Enter your schedule timeout, in the ISO duration or "human duration" format.
8284
`schedule.initialDelay`::
8385
Enter your schedule initial delay, in the ISO duration or "human duration" format.
8486
85-
. Enable the GitLab authentication provider, by adding the GitLab authentication provider section to your `{my-app-config-file}` file:
87+
. Enable the GitLab authentication provider by adding the GitLab authentication provider section to your {product-very-short} `{my-app-config-file}` file:
8688
+
8789
[source,yaml,subs="+quotes,+attributes"]
8890
----

0 commit comments

Comments
 (0)