Add action group for keycloak #9284
Merged
Conversation
This file contains 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
This will allows keycloak authentication details to be set as a module_defaults rather than repeated on each task
ansibullbot
added
feature
felixfontein
added
check-before-release
There was a problem hiding this comment.
Thanks for your contribution! Please add a changelog fragment.
Also please add a documentation fragment to plugins/doc_fragments/keycloak.py, similar to ACTIONGROUP_PROXMOX in plugins/doc_fragments/proxmox.py, and use it in the modules by updating extends_documentation_fragment and attributes as follows:
extends_documentation_fragment:
- community.general.keycloak.actiongroup_keycloak
attributes:
action_group:
version_added: 11.0.0
ansibullbot
added
docs_fragments
This comment was marked as outdated.
This comment was marked as outdated.
ansibullbot
added
ci_verified
| extends_documentation_fragment: | ||
| - community.general.keycloak.actiongroup_keycloak | ||
| - community.general.attributes | ||
| - community.general.attributes.info_module |
There was a problem hiding this comment.
Hmm, this module is exceptional in that it does not use the docs fragment and the argument spec from the module utils. Basically it only has the auth_keycloak_url and validate_certs options that are shared by the other modules. For that reason it should probably be excluded from the action group, since otherwise you cannot use the action group when using this module (except for these two options, but not for all other shared ones).
It's probably best to skip it here, and once someone makes the module use the module utils' argument spec and docs fragment, to then also add it to the action group.
There was a problem hiding this comment.
good catch, excluded this one now
This comment was marked as outdated.
This comment was marked as outdated.
…ame set of base parameters
Co-authored-by: Felix Fontein <felix@fontein.de>
felixfontein
approved these changes
Dec 23, 2024
ansibullbot
removed
ci_verified
Backport to stable-10: 💚 backport PR created✅ Backport PR branch: Backported as #9340 🤖 @patchback |
felixfontein
removed
the
check-before-release
patchback bot
pushed a commit
that referenced
this pull request
Dec 23, 2024
* Create group for keycloak This will allows keycloak authentication details to be set as a module_defaults rather than repeated on each task * add documentation to keycloak modules to note creation of action_group * add changelog for keycloak action_group creation * exclude keycloak_realm_info from action group, as it does not share same set of base parameters * fix formatting on changelog entry for adding Keycloak action group Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 28f36ae)
|
@cnorthwood thanks for your contribution! |
felixfontein
added a commit
to felixfontein/community.general
that referenced
this pull request
Dec 23, 2024
felixfontein
pushed a commit
that referenced
this pull request
Dec 23, 2024
…#9340) Add action group for keycloak (#9284) * Create group for keycloak This will allows keycloak authentication details to be set as a module_defaults rather than repeated on each task * add documentation to keycloak modules to note creation of action_group * add changelog for keycloak action_group creation * exclude keycloak_realm_info from action group, as it does not share same set of base parameters * fix formatting on changelog entry for adding Keycloak action group Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 28f36ae) Co-authored-by: Chris Northwood <cnorthwood@users.noreply.github.com>
felixfontein
added a commit
that referenced
this pull request
Dec 23, 2024
* Add sanity test for action groups. * Fix interpolation. * Fix message. Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Improve regex. * Add entry for new 'keycloak' action group. Ref: #9284 --------- Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
patchback bot
pushed a commit
that referenced
this pull request
Dec 23, 2024
* Add sanity test for action groups. * Fix interpolation. * Fix message. Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Improve regex. * Add entry for new 'keycloak' action group. Ref: #9284 --------- Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> (cherry picked from commit d5237ee)
felixfontein
added a commit
that referenced
this pull request
Dec 23, 2024
…oups (#9343) Add sanity test for action groups (#9294) * Add sanity test for action groups. * Fix interpolation. * Fix message. Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Improve regex. * Add entry for new 'keycloak' action group. Ref: #9284 --------- Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> (cherry picked from commit d5237ee) Co-authored-by: Felix Fontein <felix@fontein.de>
Massl123
pushed a commit
to Massl123/community.general
that referenced
this pull request
Feb 7, 2025
* Create group for keycloak This will allows keycloak authentication details to be set as a module_defaults rather than repeated on each task * add documentation to keycloak modules to note creation of action_group * add changelog for keycloak action_group creation * exclude keycloak_realm_info from action group, as it does not share same set of base parameters * fix formatting on changelog entry for adding Keycloak action group Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de>
Massl123
pushed a commit
to Massl123/community.general
that referenced
this pull request
Feb 7, 2025
* Add sanity test for action groups. * Fix interpolation. * Fix message. Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * Improve regex. * Add entry for new 'keycloak' action group. Ref: ansible-collections#9284 --------- Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
SUMMARY
Add an action group for all the keycloak modules. This will allows keycloak authentication details to be set as a module_defaults rather than repeated on each task
ISSUE TYPE
COMPONENT NAME
keycloak
ADDITIONAL INFORMATION