Skip to content

Commit cf302e1

Browse files
themr0cJessicaJHee
andcommitted
Update modules/authentication/proc-enabling-user-provisioning-with-ldap.adoc
Co-authored-by: Jessica He <[email protected]> Signed-off-by: Fabrice Flore-Thébault <[email protected]>
1 parent e5eceab commit cf302e1

File tree

1 file changed

+39
-19
lines changed

1 file changed

+39
-19
lines changed

modules/authentication/proc-enabling-user-provisioning-with-ldap.adoc

Lines changed: 39 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,9 @@
33
[id="enabling-user-provisioning-with-ldap"]
44
= Enabling user provisioning with LDAP
55

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.
77

88
.Prerequisites
9-
* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
10-
119
* You have configured xref:assembly-authenticating-with-rhbk[authentication with {rhbk-brand-name} ({rhbk})].
1210

1311
* You have collected the required LDAP credentials:
@@ -22,26 +20,36 @@ LDAP secret::
2220
Your LDAP secret.
2321

2422
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+
====
2730

2831
.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].
33+
+
34+
[source,subs="+attributes,+quotes"]
35+
----
36+
$ oc patch secret {my-product-secrets} --patch '{"stringData": { "LDAP_SECRET": "<ldap_secret>" }}'
37+
----
3138

32-
`LDAP_SECRET`::
39+
_<ldap_secret>_::
3340
Enter your LDAP secret.
3441

35-
. 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+
----
4050

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.
4352
+
44-
.`dynamic-plugins.yaml` file fragment
4553
[source,yaml]
4654
----
4755
plugins:
@@ -97,7 +105,7 @@ Enter the DN containing the user information.
97105
`options`:::
98106

99107
`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`.
101109

102110
`groups`::
103111
Enter information about how to find your groups:
@@ -357,10 +365,22 @@ Enter a value to enable paged results.
357365
Enter a value to set the results page size, such as `500`.
358366

359367
`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.
362369

363370

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+
364384
.Verification
365385
* To verify user and group provisioning, check the console logs.
366386
+

0 commit comments

Comments
 (0)