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/proc-enabling-user-provisioning-with-ldap.adoc
+39-19Lines changed: 39 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,11 +3,9 @@
3
3
[id="enabling-user-provisioning-with-ldap"]
4
4
= Enabling user provisioning with LDAP
5
5
6
-
When your authentication provider depends on Lightweight Directory Access Protocol (LDAP) to resolve user and group identities, you can opt to provision users and groups from LDAP directly to the {product} software catalog, rather than using the provisioning mechanism from your authentication provider.
6
+
When {rhbk-brand-name} ({rhbk}) depends on Lightweight Directory Access Protocol (LDAP) to resolve user and group identities, you can opt to provision users and groups from LDAP directly to the {product} software catalog, rather than using the {rhbk} provisioning mechanism.
7
7
8
8
.Prerequisites
9
-
* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
10
-
11
9
* You have configured xref:assembly-authenticating-with-rhbk[authentication with {rhbk-brand-name} ({rhbk})].
12
10
13
11
* You have collected the required LDAP credentials:
@@ -22,26 +20,36 @@ LDAP secret::
22
20
Your LDAP secret.
23
21
24
22
Recommended: LDAP certificates and keys::
25
-
Your LDAP certificates and keys, when using a secure LDAP connexion (`ldaps://`).
26
-
23
+
To use a secure LDAP connexion (`ldaps://`):
24
+
you stored your LDAP certificates and keys respectively in the `ldap_certs.pem` and `ldap_keys.pem` files.
25
+
+
26
+
[WARNING]
27
+
====
28
+
In production mode, use a secure LDAP connexion.
29
+
====
27
30
28
31
.Procedure
29
-
. Enter your LDAP credentials to {product-short}, by adding the following key/value pairs to link:{configuring-dynamic-plugins-book-url}#provisioning-your-custom-configuration[your {product-short} secrets].
30
-
You can use these secrets in the {product-short} configuration files by using their respective environment variable name.
32
+
. Enter your LDAP credentials to {product-short}, by adding the `LDAP_SECRET` environment variable to {configuring-book-link}#provisioning-your-custom-configuration[your {product-short} secrets].
. Recommended: To use a secure LDAP connection (`ldaps://`), add your LDAP certificates and keys files to link:{configuring-dynamic-plugins-book-url}#provisioning-your-custom-configuration[your {product-short} secrets].
36
-
37
-
`ldap_certs`::
38
-
39
-
`ldap_keys`::
42
+
. Recommended: To use a secure LDAP connection (`ldaps://`), add your LDAP certificates and keys files to a {a-platform-generic} secret.
43
+
+
44
+
[source,subs="+attributes,+quotes"]
45
+
----
46
+
$ oc create secret generic my-rhdh-ldap-secrets \
47
+
--from-file=./ldap_certs.pem \
48
+
--from-file=./ldap_keys.pem
49
+
----
40
50
41
-
. Enable the LDAP organization provisioning plugin (`backstage-plugin-catalog-backend-module-ldap`).
42
-
This plugin ingests LDAP users and groups to the {product-short} software catalog.
51
+
. Enable the LDAP catalog provider plugin in your `dynamic-plugins.yaml` file.
43
52
+
44
-
.`dynamic-plugins.yaml` file fragment
45
53
[source,yaml]
46
54
----
47
55
plugins:
@@ -97,7 +105,7 @@ Enter the DN containing the user information.
97
105
`options`:::
98
106
99
107
`filter`::::
100
-
Enter your filter, such as `(uid=*)` to provision to the {product-very-short} software catalog only users with a valid `uid`.
108
+
Enter your filter, such as `(uid=*)` to provision to the {product-very-short} software catalog only users with an existing `uid`.
101
109
102
110
`groups`::
103
111
Enter information about how to find your groups:
@@ -357,10 +365,22 @@ Enter a value to enable paged results.
357
365
Enter a value to set the results page size, such as `500`.
358
366
359
367
`pagePause`:::
360
-
Enter `true` to tell the client to wait for the asynchronous results of the next page,
361
-
when the page limit has been reached.
368
+
Enter `true` to tell the client to wait for the asynchronous results of the next page, when the page limit has been reached.
362
369
363
370
371
+
. Recommended: To use a secure LDAP connection (`ldaps://`), mount your LDAP certificates and keys files in your {product-short} deployment, by editing your {backstage} custom resource.
372
+
+
373
+
----
374
+
kind: Backstage
375
+
spec:
376
+
application:
377
+
extraFiles:
378
+
mountPath: /opt/ldap-secrets
379
+
secrets:
380
+
- name: my-rhdh-database-database-secrets
381
+
key: ldap-certs.pem, ldap-keys.pem
382
+
----
383
+
364
384
.Verification
365
385
* To verify user and group provisioning, check the console logs.
0 commit comments