[RHIDP#10991]: Document custom transformers for user provisioning#1767
Merged
themr0c merged 20 commits intoredhat-developer:mainfrom Apr 2, 2026
Merged
[RHIDP#10991]: Document custom transformers for user provisioning#1767themr0c merged 20 commits intoredhat-developer:mainfrom
themr0c merged 20 commits intoredhat-developer:mainfrom
Conversation
Collaborator
|
Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1767/ @ 4/2/2026, 7:10:05 PM |
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
8dae077 to
a02f687
Compare
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
a02f687 to
425812f
Compare
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
425812f to
dc5f5ef
Compare
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
dc5f5ef to
045c875
Compare
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
045c875 to
887feca
Compare
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
887feca to
bc58a65
Compare
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
bc58a65 to
41b651b
Compare
themr0c
added
Peer review needed 📖
Technical review needed 🔩
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
41b651b to
36194a1
Compare
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
36194a1 to
f943ab1
Compare
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
f943ab1 to
08abbb6
Compare
themr0c
force-pushed
the
RHIDP-10991-custom-transformers
branch
from
08abbb6 to
5eedc2f
Compare
…, and LDAP Add procedures for creating custom transformers to provision users from GitHub, Azure, GitLab, and LDAP to the software catalog. Update auth assemblies to include the new modules and expand abstracts to mention custom transformer support. Fix xrefs to use correct IDs with context suffixes, and fix GitLab module copy-paste errors (GitHub -> GitLab). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Convert Verification sections from unnumbered to numbered lists in GitHub, Azure, and GitLab custom transformer modules. Fix Azure module referencing GitHub instead of Azure in verification step. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Shorten assembly abstracts to under 300 chars
- Add [role="_abstract"] to all four modules
- Add _{context} suffix to all module IDs
- Replace hardcoded "Azure" with {azure-short} attribute
- Replace hardcoded "Backstage" with {backstage} attribute
- Attach [IMPORTANT] blocks to last procedure step with +
- Convert LDAP verification list to numbered
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
CQA-10 derives the module ID and filename from the title text.
Using {azure-short} in the title resolves to empty during that process,
producing a broken ID. Keep Azure hardcoded in the title only.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The ID is explicitly set, so the attribute in the title won't affect it. This satisfies CQA-16 (no hardcoded product names). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The LDAP provisioning module is included in the RHBK assembly, so the LDAP custom transformer module belongs there too, after the RHBK custom transformer. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The prerequisite xref pointed to a non-existent ID. Updated to
reference the correct enable-user-provisioning-with-ldap_{context}.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Update include path for renamed Azure transformer module, replace
hardcoded Azure with {azure-short} in plugin migration table,
add content type to ref-deprecated-plugins, fix list continuation.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Apply lhite8041 review feedback: remove second {product} reference,
remove extra colon, add missing period, capitalize "See the", reword
verification step.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…e link Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Remove hard-to-maintain synchronization log examples from transformer modules. Revert unrelated changes to dynamic plugins reference files. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Collaborator
Content Quality Assessment ResultsCQA Report
SummaryChecks: 19 total, 16 pass, 3 fail Automated CQA check run on the entire repository — 2026-04-02 19:06:02 UTC |
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Collaborator
|
Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1767/ @ 04/01/26 18:17:18 |
JessicaJHee
previously requested changes
Apr 2, 2026
Member
JessicaJHee
left a comment
JessicaJHee
left a comment
There was a problem hiding this comment.
Already looking great! Left a few suggestions :)
…sers-from-github-to-the-software-catalog.adoc Co-authored-by: Jessica He <jessicahe4741@gmail.com>
Add notes in verification steps to check that custom transformations are reflected in user and group entities. Fix Vale suggestions: backtick UserEntity/GroupEntity, replace "desired" with "required". Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
After exporting the dynamic plugin, users need to publish and enable it. Added a step linking to the "Add a custom dynamic plugin to RHDH" section in the Installing and viewing plugins guide, across all 5 provider-specific custom transformer procedures. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Member
Author
|
/cherry-pick release-1.9-post-cqa |
Contributor
|
@themr0c: once the present PR merges, I will cherry-pick it on top of DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
Contributor
|
@themr0c: #1767 failed to apply on top of branch "release-1.9-post-cqa": DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
IMPORTANT: Do Not Merge - To be merged by Docs Team Only
Version(s): 1.5+
Issue: https://redhat.atlassian.net/browse/RHIDP-10991
Preview: N/A
Summary
Add documentation for creating custom transformers to provision users from external identity providers (GitHub, Azure, GitLab, LDAP) to the RHDH software catalog.
New modules
proc-create-a-custom-transformer-to-provision-users-from-github-to-the-software-catalog.adocproc-create-a-custom-transformer-to-provision-users-from-azure-to-the-software-catalog.adocproc-create-a-custom-transformer-to-provision-users-from-gitlab-to-the-software-catalog.adocproc-create-a-custom-transformer-to-provision-users-from-ldap-to-the-software-catalog.adocUpdated assemblies
Each custom transformer module is included in the corresponding authentication assembly:
assembly-enable-authentication-with-github.adocassembly-enable-authentication-with-microsoft-azure.adocassembly-enable-authentication-with-gitlab.adocassembly-enable-authentication-with-rhbk.adoc(LDAP custom transformer)CQA compliance
All new modules pass CQA checks. Includes a fix to CQA-10
_title_to_id_form()to handle{azure-short}attribute mapping.