Skip to content

Commit 0598ed6

Browse files
authored
RHIDP-8118: update variables in authentication docs (#1488)
* RHIDP-8118 * RHIDP-8118
1 parent 27e81fc commit 0598ed6

5 files changed

+32
-26
lines changed

modules/authentication/snip-enabling-user-authentication-with-microsoft-azure-common-authentication-provider-steps.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,24 @@ auth:
99
providers:
1010
microsoft:
1111
production:
12-
clientId: ${AUTHENTICATION_AZURE_CLIENT_ID}
13-
clientSecret: ${AUTHENTICATION_AZURE_CLIENT_SECRET}
14-
tenantId: ${AUTHENTICATION_AZURE_TENANT_ID}
12+
clientId: ${MICROSOFT_CLIENT_ID}
13+
clientSecret: ${MICROSOFT_CLIENT_SECRET}
14+
tenantId: ${MICROSOFT_TENANT_ID}
1515
signInPage: microsoft
1616
----
1717

1818
`environment`::
1919
Enter `production` to disable the **Guest** login option in the {product-short} login page.
2020

2121
`clientId`::
22-
Enter the configured secret variable name: `$\{AUTHENTICATION_AZURE_CLIENT_ID}`.
22+
Enter the configured secret variable name: `$\{MICROSOFT_CLIENT_ID}`.
2323

2424
`clientSecret`::
2525
Enter the configured secret variable name:
26-
`$\{AUTHENTICATION_AZURE_CLIENT_SECRET}`.
26+
`$\{MICROSOFT_CLIENT_SECRET}`.
2727

2828
`tenantId`::
29-
Enter the configured secret variable name: `$\{AUTHENTICATION_AZURE_TENANT_ID}`.
29+
Enter the configured secret variable name: `$\{MICROSOFT_TENANT_ID}`.
3030

3131
`signInPage`::
3232
Enter `microsoft` to set the {azure-short} provider as your {product-short} sign-in provider.

modules/authentication/snip-enabling-user-authentication-with-microsoft-azure-common-first-steps.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -73,13 +73,13 @@ Optional: Enter optional custom scopes for the Microsoft Graph API that you defi
7373
7474
. Add your {azure-short} credentials to {product-short}, by adding the following key/value pairs to {configuring-book-link}#provisioning-your-custom-configuration[your {product-short} secrets]:
7575

76-
`AUTHENTICATION_AZURE_TENANT_ID`::
76+
`MICROSOFT_TENANT_ID`::
7777
Enter your saved *Directory (tenant) ID*.
7878

79-
`AUTHENTICATION_AZURE_CLIENT_ID`::
79+
`MICROSOFT_CLIENT_ID`::
8080
Enter your saved *Application (client) ID*.
8181

82-
`AUTHENTICATION_AZURE_CLIENT_SECRET`::
82+
`MICROSOFT_CLIENT_SECRET`::
8383
Enter your saved *Application (client) secret*.
8484

8585
. Enable the Microsoft Graph catalog provider plugin in your `dynamic-plugins.yaml`
@@ -103,9 +103,9 @@ catalog:
103103
microsoftGraphOrg:
104104
providerId:
105105
target: https://graph.microsoft.com/v1.0
106-
tenantId: ${AUTHENTICATION_AZURE_TENANT_ID}
107-
clientId: ${AUTHENTICATION_AZURE_CLIENT_ID}
108-
clientSecret: ${AUTHENTICATION_AZURE_CLIENT_SECRET}
106+
tenantId: ${MICROSOFT_TENANT_ID}
107+
clientId: ${MICROSOFT_CLIENT_ID}
108+
clientSecret: ${MICROSOFT_CLIENT_SECRET}
109109
schedule:
110110
frequency:
111111
hours: 1
@@ -120,13 +120,13 @@ Enter `\https://graph.microsoft.com/v1.0` to define the MSGraph API endpoint the
120120
You might change this parameter to use a different version, such as the link:https://learn.microsoft.com/en-us/graph/api/overview?view=graph-rest-beta#call-the-beta-endpoint[beta endpoint].
121121

122122
`tenandId`::
123-
Enter the configured secret variable name: `$\{AUTHENTICATION_AZURE_TENANT_ID}`.
123+
Enter the configured secret variable name: `$\{MICROSOFT_TENANT_ID}`.
124124

125125
`clientId`::
126-
Enter the configured secret variable name: `$\{AUTHENTICATION_AZURE_CLIENT_ID}`.
126+
Enter the configured secret variable name: `$\{MICROSOFT_CLIENT_ID}`.
127127

128128
`clientSecret`::
129-
Enter the configured secret variable name: `$\{AUTHENTICATION_AZURE_CLIENT_SECRET}`.
129+
Enter the configured secret variable name: `$\{MICROSOFT_CLIENT_SECRET}`.
130130

131131
`schedule`::
132132

modules/authentication/snip-enabling-user-authentication-with-microsoft-azure-optional-authentication-provider-steps.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ auth:
99
providers:
1010
microsoft:
1111
production:
12-
clientId: ${AUTHENTICATION_AZURE_CLIENT_ID}
13-
clientSecret: ${AUTHENTICATION_AZURE_CLIENT_SECRET}
14-
tenantId: ${AUTHENTICATION_AZURE_TENANT_ID}
15-
domainHint: ${AUTHENTICATION_AZURE_TENANT_ID}
12+
clientId: ${MICROSOFT_CLIENT_ID}
13+
clientSecret: ${MICROSOFT_CLIENT_SECRET}
14+
tenantId: ${MICROSOFT_TENANT_ID}
15+
domainHint: ${MICROSOFT_TENANT_ID}
1616
additionalScopes:
1717
- Mail.Send
1818
sessionDuration:

modules/authentication/snip-enabling-user-authentication-with-rhbk-common-first-steps.adoc

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,12 @@ Enter the saved **Client Secret**.
4242
`KEYCLOAK_BASE_URL`::
4343
Enter the saved **{rhbk} realm base URL**.
4444

45+
`KEYCLOAK_REALM`::
46+
Enter the realm name to provision users.
47+
48+
`KEYCLOAK_LOGIN_REALM`::
49+
Enter the realm name to authenticate users.
50+
4551
. Enable the Keycloak catalog provider plugin in your `dynamic-plugins.yaml` file.
4652
+
4753
The plugin is named after {rhbk} upstream project.
@@ -67,8 +73,8 @@ catalog:
6773
baseUrl: ${KEYCLOAK_BASE_URL}
6874
clientId: ${KEYCLOAK_CLIENT_ID}
6975
clientSecret: ${KEYCLOAK_CLIENT_SECRET}
70-
realm: master
71-
loginRealm: master
76+
realm: ${KEYCLOAK_REALM}
77+
loginRealm: ${KEYCLOAK_LOGIN_REALM}
7278
----
7379

7480
`baseUrl`::
@@ -81,7 +87,7 @@ Enter your {product-short} application client ID in {rhbk}, defined earlier.
8187
Enter your {product-short} application client secret in {rhbk}, defined earlier.
8288

8389
`realm`::
84-
Enter the realm name to provision users, such as `master`.
90+
Enter the realm name to provision users.
8591

8692
`loginRealm`::
87-
Enter the realm name to authenticate users, such as `master`.
93+
Enter the realm name to authenticate users.

modules/authentication/snip-enabling-user-authentication-with-rhbk-optional-catalog-provider-steps.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: SNIPPET
22

3-
Optional: Add optional fields to the keycloackOrg catalog provider section in your `{my-app-config-file}` file:
3+
Optional: Add optional fields to the `keycloackOrg` catalog provider section in your `{my-app-config-file}` file:
44

55
[source,yaml]
66
----
@@ -11,8 +11,8 @@ catalog:
1111
baseUrl: ${KEYCLOAK_BASE_URL}
1212
clientId: ${KEYCLOAK_CLIENT_ID}
1313
clientSecret: ${KEYCLOAK_CLIENT_SECRET}
14-
realm: master
15-
loginRealm: master
14+
realm: ${KEYCLOAK_REALM}
15+
loginRealm: ${KEYCLOAK_LOGIN_REALM}
1616
userQuerySize: 100
1717
groupQuerySize: 100
1818
schedule:

0 commit comments

Comments
 (0)