You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/authentication/snip-enable-user-authentication-with-gitlab-common-first-steps.adoc
+14-12Lines changed: 14 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,28 +1,30 @@
1
1
:_mod-docs-content-type: SNIPPET
2
2
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:
5
5
6
6
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>__`.
8
8
9
9
Redirect URI::
10
10
Enter your {product-short} URL: `pass:c,a,q[{my-product-url}]`.
11
11
12
12
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]`.
14
14
15
15
Authorized application scope::
16
16
Enable `email`, `profile`, `openid`, and `read_user`.
17
17
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:
19
19
20
20
* **OAuth 2 Client ID**, available in the *Application ID* field
21
21
* **OAuth 2 Client secret**, accessible by selecting *Copy* in the *Secret* field
22
22
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>`.
26
28
27
29
`GITLAB_CLIENT_ID`::
28
30
Enter the saved **OAuth 2 Client ID**.
@@ -33,7 +35,7 @@ Enter the saved **OAuth 2 Client Secret**.
33
35
`GITLAB_URL`::
34
36
Enter the GitLab host domain: __`<gitlab_host_domain>`__.
35
37
36
-
`GITLAB_ORG`::
38
+
`GITLAB_PARENT_ORG`::
37
39
Enter your GitLab organization name, such as `__<your_gitlab_organization_name>__`.
38
40
39
41
. 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:
45
47
disabled: false
46
48
----
47
49
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:
49
51
+
50
52
[source,yaml]
51
53
----
@@ -68,7 +70,7 @@ catalog:
68
70
----
69
71
70
72
`host`::
71
-
Enter your GitLab instance address: `${GITLAB_HOST}`.
73
+
Enter your GitLab instance address: pass:c,a,q[`${GITLAB_HOST}`].
72
74
73
75
`group`::
74
76
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.
82
84
`schedule.initialDelay`::
83
85
Enter your schedule initial delay, in the ISO duration or "human duration" format.
84
86
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:
0 commit comments