Skip to content

Commit d121eeb

Browse files
themr0cclaudedeerskindoll
authored
[RHDHBUGS-2722]: Restructure authentication title to JTBD outline (#2049)
* feat: create new JTBD outline shell for authentication title Establish the new section structure: share secrets, import users, enable auth, external services. Existing content temporarily parked under the auth section pending per-IdP splits. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * feat: split RHBK auth procedure into secret, import, and auth modules Extract secrets sharing, user import, and auth config from the monolithic RHBK procedure into focused JTBD modules. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * feat: split GitHub auth procedure into secret, import, and auth modules Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * feat: split Azure auth procedure into secret, import, and auth modules Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * feat: split GitLab auth procedure into secret, import, and auth modules Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * feat: extract LDAP secret sharing into dedicated procedure Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * feat: update get-started mandatory-only assembly to use split procedures Replace old monolithic proc-enable-user-authentication-with-{rhbk,github,microsoft-azure} wrapper includes with the new split procedures (secret, import, auth) for each IdP. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * chore: remove old monolithic auth procedures, assemblies, and orphaned snippets Delete 26 files replaced by the new JTBD-structured authentication docs: - 4 old per-IdP assemblies (RHBK, GitHub, Microsoft Azure, GitLab) - 3 old monolithic with-optional-steps procedures - 1 old monolithic GitLab procedure - 3 old mandatory-only wrapper procedures - 15 orphaned snippet files 5 snippet files retained (still referenced by new split procedures): - snip-enabling-user-authentication-with-rhbk-common-prerequisites.adoc - snip-enabling-user-authentication-with-github-common-prerequisites.adoc - snip-enabling-user-authentication-with-microsoft-azure-common-prerequisites.adoc - snip-enable-user-authentication-with-gitlab-common-prerequisites.adoc - snip-disabling-the-guest-user-step.adoc Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: use secrets-context attribute for cross-assembly xref resolution Hardcoded xref targets to _share-a-secret-with-your-identity-provider broke when procedures were included in the mandatory-only assembly (which uses a different context). Introduce a {secrets-context} attribute set by each parent assembly to ensure xrefs resolve correctly in both the auth title and the get-started mandatory-only assembly. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: update broken xrefs in transformer and LDAP procedures Custom transformer prerequisites referenced old monolithic procedure IDs. LDAP procedure referenced RHBK auth with {parent-context} which no longer resolves correctly after the assembly restructure. Hardcode the correct target contexts for cross-assembly xrefs. * fix(RHDHBUGS-2722): fix broken xrefs in LDAP and troubleshoot modules Update xref context suffixes to match the actual assembly contexts: - LDAP procedure: use enable-authentication-with-your-identity-provider - Troubleshoot catalog errors: use import-users-and-groups-from-your-identity-provider Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Apply suggestions from code review Co-authored-by: Jana Vrbkova <jvrbkova@redhat.com> * Apply suggestions from code review Co-authored-by: Fabrice Flore-Thébault <ffloreth@redhat.com> * Apply suggestion from @themr0c * fix CQA issue Signed-off-by: Fabrice Flore-Thébault <ffloreth@redhat.com> * fix CQA issues Signed-off-by: Fabrice Flore-Thébault <ffloreth@redhat.com> * Apply suggestions from code review Co-authored-by: Jana Vrbkova <jvrbkova@redhat.com> * fix CQA issue Signed-off-by: Fabrice Flore-Thébault <ffloreth@redhat.com> --------- Signed-off-by: Fabrice Flore-Thébault <ffloreth@redhat.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: Jana Vrbkova <jvrbkova@redhat.com>
1 parent aed2d32 commit d121eeb

46 files changed

Lines changed: 949 additions & 895 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

assemblies/shared/assembly-enable-authentication-in-rhdh-with-mandatory-steps-only.adoc

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,36 @@ ifdef::context[:parent-context: {context}]
66
= Enable authentication in {product} (with mandatory steps only)
77

88
:context: enable-authentication-in-rhdh-with-mandatory-steps-only
9+
:secrets-context: enable-authentication-in-rhdh-with-mandatory-steps-only
910

1011
[role="_abstract"]
11-
You can enable authentication in {product} to allow users to sign in using credentials from an external identity provider, such as {rhbk}, GitHub, or {azure-brand-name}, and provision user and group data to the software catalog.
12+
Enable authentication in {product} to allow users to sign in using credentials from an external identity provider, such as {rhbk}, GitHub, or {azure-brand-name}, and provision user and group data to the software catalog.
1213

1314
include::../modules/shared/con-understand-authentication-and-user-provisioning.adoc[leveloffset=+1]
1415

1516

1617
include::assembly-enable-or-disable-authentication-with-the-guest-user.adoc[leveloffset=+1]
1718

1819

19-
include::../modules/shared/proc-enable-user-authentication-with-rhbk.adoc[leveloffset=+1]
20+
include::../modules/shared/proc-share-a-secret-with-rhbk.adoc[leveloffset=+1]
2021

22+
include::../modules/shared/proc-import-users-and-groups-from-rhbk.adoc[leveloffset=+1]
2123

22-
include::../modules/shared/proc-enable-user-authentication-with-github.adoc[leveloffset=+1]
24+
include::../modules/shared/proc-enable-authentication-with-rhbk.adoc[leveloffset=+1]
2325

2426

25-
include::../modules/shared/proc-enable-user-authentication-with-microsoft-azure.adoc[leveloffset=+1]
27+
include::../modules/shared/proc-share-a-secret-with-github.adoc[leveloffset=+1]
28+
29+
include::../modules/shared/proc-import-users-and-groups-from-github.adoc[leveloffset=+1]
30+
31+
include::../modules/shared/proc-enable-authentication-with-github.adoc[leveloffset=+1]
32+
33+
34+
include::../modules/shared/proc-share-a-secret-with-microsoft-azure.adoc[leveloffset=+1]
35+
36+
include::../modules/shared/proc-import-users-and-groups-from-microsoft-azure.adoc[leveloffset=+1]
37+
38+
include::../modules/shared/proc-enable-authentication-with-microsoft-azure.adoc[leveloffset=+1]
2639

2740
ifdef::parent-context[:context: {parent-context}]
2841
ifndef::parent-context[:!context:]
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
ifdef::context[:parent-context: {context}]
3+
4+
[id="enable-authentication-with-external-services_{context}"]
5+
= Enable authentication with external services
6+
7+
:context: enable-authentication-with-external-services
8+
9+
[role="_abstract"]
10+
Enable authentication with external services to allow {product} to communicate with secondary identity providers and external APIs.
11+
12+
include::../modules/shared/proc-enable-user-authentication-with-github-as-an-auxiliary-authentication-provider.adoc[leveloffset=+1]
13+
14+
include::assembly-enable-service-to-service-authentication.adoc[leveloffset=+1]
15+
16+
ifdef::parent-context[:context: {parent-context}]
17+
ifndef::parent-context[:!context:]

assemblies/shared/assembly-enable-authentication-with-github.adoc

Lines changed: 0 additions & 22 deletions
This file was deleted.

assemblies/shared/assembly-enable-authentication-with-gitlab.adoc

Lines changed: 0 additions & 18 deletions
This file was deleted.

assemblies/shared/assembly-enable-authentication-with-microsoft-azure.adoc

Lines changed: 0 additions & 18 deletions
This file was deleted.

assemblies/shared/assembly-enable-authentication-with-rhbk.adoc

Lines changed: 0 additions & 24 deletions
This file was deleted.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
ifdef::context[:parent-context: {context}]
3+
4+
[id="enable-authentication-with-your-identity-provider_{context}"]
5+
= Enable authentication with your identity provider
6+
7+
:context: enable-authentication-with-your-identity-provider
8+
:secrets-context: share-a-secret-with-your-identity-provider
9+
10+
[role="_abstract"]
11+
Enable authentication with your main identity provider to allow users to sign in to {product} using their organizational credentials.
12+
13+
include::../modules/shared/proc-enable-authentication-with-rhbk.adoc[leveloffset=+1]
14+
15+
include::../modules/shared/proc-enable-authentication-with-github.adoc[leveloffset=+1]
16+
17+
include::../modules/shared/proc-enable-authentication-with-microsoft-azure.adoc[leveloffset=+1]
18+
19+
include::../modules/shared/proc-enable-authentication-with-gitlab.adoc[leveloffset=+1]
20+
21+
ifdef::parent-context[:context: {parent-context}]
22+
ifndef::parent-context[:!context:]
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
ifdef::context[:parent-context: {context}]
3+
4+
[id="import-users-and-groups-from-your-identity-provider_{context}"]
5+
= Import users and groups from your identity provider
6+
7+
:context: import-users-and-groups-from-your-identity-provider
8+
:secrets-context: share-a-secret-with-your-identity-provider
9+
10+
[role="_abstract"]
11+
Import users and groups from your identity provider to the {product} software catalog to enable user identity resolution and role-based access control.
12+
13+
include::../modules/shared/proc-import-users-and-groups-from-rhbk.adoc[leveloffset=+1]
14+
15+
include::../modules/shared/proc-create-a-custom-transformer-to-provision-users-from-rhbk-to-the-software-catalog.adoc[leveloffset=+2]
16+
17+
include::../modules/shared/proc-enable-user-provisioning-with-ldap.adoc[leveloffset=+1]
18+
19+
include::../modules/shared/proc-create-a-custom-transformer-to-provision-users-from-ldap-to-the-software-catalog.adoc[leveloffset=+2]
20+
21+
include::../modules/shared/proc-import-users-and-groups-from-github.adoc[leveloffset=+1]
22+
23+
include::../modules/shared/proc-create-a-custom-transformer-to-provision-users-from-github-to-the-software-catalog.adoc[leveloffset=+2]
24+
25+
include::../modules/shared/proc-import-users-and-groups-from-microsoft-azure.adoc[leveloffset=+1]
26+
27+
include::../modules/shared/proc-create-a-custom-transformer-to-provision-users-from-to-the-software-catalog.adoc[leveloffset=+2]
28+
29+
include::../modules/shared/proc-import-users-and-groups-from-gitlab.adoc[leveloffset=+1]
30+
31+
include::../modules/shared/proc-create-a-custom-transformer-to-provision-users-from-gitlab-to-the-software-catalog.adoc[leveloffset=+2]
32+
33+
ifdef::parent-context[:context: {parent-context}]
34+
ifndef::parent-context[:!context:]
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
ifdef::context[:parent-context: {context}]
3+
4+
[id="share-a-secret-with-your-identity-provider_{context}"]
5+
= Share a secret with your identity provider
6+
7+
:context: share-a-secret-with-your-identity-provider
8+
9+
[role="_abstract"]
10+
Share credentials between your identity provider and {product} to enable secure communication for authentication and user provisioning.
11+
12+
include::../modules/shared/proc-share-a-secret-with-rhbk.adoc[leveloffset=+1]
13+
14+
include::../modules/shared/proc-share-a-secret-with-ldap.adoc[leveloffset=+1]
15+
16+
include::../modules/shared/proc-share-a-secret-with-github.adoc[leveloffset=+1]
17+
18+
include::../modules/shared/proc-share-a-secret-with-microsoft-azure.adoc[leveloffset=+1]
19+
20+
include::../modules/shared/proc-share-a-secret-with-gitlab.adoc[leveloffset=+1]
21+
22+
ifdef::parent-context[:context: {parent-context}]
23+
ifndef::parent-context[:!context:]

modules/shared/proc-create-a-custom-transformer-to-provision-users-from-github-to-the-software-catalog.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Customize how {product} provisions users and groups to {product-short} software
88
by creating a backend module plugin that uses the `githubOrgEntityProviderTransformsExtensionPoint` to offer custom user and group transformers for the GitHub backend.
99

1010
.Prerequisites
11-
* You have xref:enable-user-authentication-with-github-with-optional-steps_{context}[enabled provisioning users from GitHub to the software catalog].
11+
* You have xref:import-users-and-groups-from-github_{context}[imported users and groups from GitHub to the software catalog].
1212

1313
.Procedure
1414
. Create a new backend module:

0 commit comments

Comments
 (0)