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>
2024-12-23 17:51:34 +00:00 · 2024-12-23 17:51:34 +00:00 · 28f36ae25c
parent da51594f9d
commit 28f36ae25c
30 changed files with 130 additions and 0 deletions
--- a/changelogs/fragments/9284-add-keycloak-action-group.yml
+++ b/changelogs/fragments/9284-add-keycloak-action-group.yml
@ -0,0 +1,2 @@
+minor_changes:
+  - keycloak - add an action group for Keycloak modules to allow ``module_defaults`` to be set for Keycloak tasks (https://github.com/ansible-collections/community.general/pull/9284).
--- a/meta/runtime.yml
+++ b/meta/runtime.yml
@ -32,6 +32,34 @@ action_groups:
    - proxmox_template
    - proxmox_user_info
    - proxmox_vm_info
+  keycloak:
+    - keycloak_authentication
+    - keycloak_authentication_required_actions
+    - keycloak_authz_authorization_scope
+    - keycloak_authz_custom_policy
+    - keycloak_authz_permission
+    - keycloak_authz_permission_info
+    - keycloak_client
+    - keycloak_client_rolemapping
+    - keycloak_client_rolescope
+    - keycloak_clientscope
+    - keycloak_clientscope_type
+    - keycloak_clientsecret_info
+    - keycloak_clientsecret_regenerate
+    - keycloak_clienttemplate
+    - keycloak_component
+    - keycloak_component_info
+    - keycloak_group
+    - keycloak_identity_provider
+    - keycloak_realm
+    - keycloak_realm_key
+    - keycloak_realm_keys_metadata_info
+    - keycloak_realm_rolemapping
+    - keycloak_role
+    - keycloak_user
+    - keycloak_user_federation
+    - keycloak_user_rolemapping
+    - keycloak_userprofile
 plugin_routing:
  callback:
    actionable:
--- a/plugins/doc_fragments/keycloak.py
+++ b/plugins/doc_fragments/keycloak.py
@ -77,3 +77,13 @@ options:
        default: Ansible
        version_added: 5.4.0
 '''
+
+    ACTIONGROUP_KEYCLOAK = r"""
+options: {}
+attributes:
+  action_group:
+    description: Use C(group/community.general.keycloak) in C(module_defaults) to set defaults for this module.
+    support: full
+    membership:
+      - community.general.keycloak
+"""
--- a/plugins/modules/keycloak_authentication.py
+++ b/plugins/modules/keycloak_authentication.py
@ -24,6 +24,8 @@ attributes:
        support: full
    diff_mode:
        support: full
+    action_group:
+        version_added: 10.2.0

 options:
    realm:
@ -102,6 +104,7 @@ options:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes

 author:
--- a/plugins/modules/keycloak_authentication_required_actions.py
+++ b/plugins/modules/keycloak_authentication_required_actions.py
@ -26,6 +26,8 @@ attributes:
        support: full
    diff_mode:
        support: full
+    action_group:
+        version_added: 10.2.0

 options:
    realm:
@ -77,6 +79,7 @@ options:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes

 author:
--- a/plugins/modules/keycloak_authz_authorization_scope.py
+++ b/plugins/modules/keycloak_authz_authorization_scope.py
@ -35,6 +35,8 @@ attributes:
        support: full
    diff_mode:
        support: full
+    action_group:
+        version_added: 10.2.0

 options:
    state:
@ -74,6 +76,7 @@ options:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes

 author:
--- a/plugins/modules/keycloak_authz_custom_policy.py
+++ b/plugins/modules/keycloak_authz_custom_policy.py
@ -36,6 +36,8 @@ attributes:
        support: full
    diff_mode:
        support: none
+    action_group:
+        version_added: 10.2.0

 options:
    state:
@ -71,6 +73,7 @@ options:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes

 author:
--- a/plugins/modules/keycloak_authz_permission.py
+++ b/plugins/modules/keycloak_authz_permission.py
@ -43,6 +43,8 @@ attributes:
        support: full
    diff_mode:
        support: none
+    action_group:
+        version_added: 10.2.0

 options:
    state:
@ -121,6 +123,7 @@ options:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes

 author:
--- a/plugins/modules/keycloak_authz_permission_info.py
+++ b/plugins/modules/keycloak_authz_permission_info.py
@ -31,6 +31,10 @@ description:
      The Authorization Services paths and payloads have not officially been documented by the Keycloak project.
      U(https://www.puppeteers.net/blog/keycloak-authorization-services-rest-api-paths-and-payload/)

+attributes:
+    action_group:
+        version_added: 10.2.0
+
 options:
    name:
        description:
@ -51,6 +55,7 @@ options:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes
    - community.general.attributes.info_module

--- a/plugins/modules/keycloak_client.py
+++ b/plugins/modules/keycloak_client.py
@ -35,6 +35,8 @@ attributes:
        support: full
    diff_mode:
        support: full
+    action_group:
+        version_added: 10.2.0

 options:
    state:
@ -595,6 +597,7 @@ options:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes

 author:
--- a/plugins/modules/keycloak_client_rolemapping.py
+++ b/plugins/modules/keycloak_client_rolemapping.py
@ -38,6 +38,8 @@ attributes:
        support: full
    diff_mode:
        support: full
+    action_group:
+        version_added: 10.2.0

 options:
    state:
@ -130,6 +132,7 @@ options:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes

 author:
--- a/plugins/modules/keycloak_client_rolescope.py
+++ b/plugins/modules/keycloak_client_rolescope.py
@ -34,6 +34,8 @@ attributes:
        support: full
    diff_mode:
        support: full
+    action_group:
+        version_added: 10.2.0

 options:
    state:
@ -76,6 +78,7 @@ options:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes

 author:
--- a/plugins/modules/keycloak_clientscope.py
+++ b/plugins/modules/keycloak_clientscope.py
@ -38,6 +38,8 @@ attributes:
        support: full
    diff_mode:
        support: full
+    action_group:
+        version_added: 10.2.0

 options:
    state:
@ -158,6 +160,7 @@ options:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes

 author:
--- a/plugins/modules/keycloak_clientscope_type.py
+++ b/plugins/modules/keycloak_clientscope_type.py
@ -30,6 +30,8 @@ attributes:
        support: full
    diff_mode:
        support: full
+    action_group:
+        version_added: 10.2.0

 options:
  realm:
@ -59,6 +61,7 @@ options:

 extends_documentation_fragment:
  - community.general.keycloak
+  - community.general.keycloak.actiongroup_keycloak
  - community.general.attributes

 author:
--- a/plugins/modules/keycloak_clientsecret_info.py
+++ b/plugins/modules/keycloak_clientsecret_info.py
@ -32,6 +32,10 @@ description:
  - "Note that this module returns the client secret. To avoid this showing up in the logs,
     please add C(no_log: true) to the task."

+attributes:
+  action_group:
+    version_added: 10.2.0
+
 options:
  realm:
    type: str
@ -57,6 +61,7 @@ options:

 extends_documentation_fragment:
  - community.general.keycloak
+  - community.general.keycloak.actiongroup_keycloak
  - community.general.attributes
  - community.general.attributes.info_module

--- a/plugins/modules/keycloak_clientsecret_regenerate.py
+++ b/plugins/modules/keycloak_clientsecret_regenerate.py
@ -37,6 +37,8 @@ attributes:
    support: full
  diff_mode:
    support: none
+  action_group:
+    version_added: 10.2.0

 options:
  realm:
@ -63,6 +65,7 @@ options:

 extends_documentation_fragment:
  - community.general.keycloak
+  - community.general.keycloak.actiongroup_keycloak
  - community.general.attributes

 author:
--- a/plugins/modules/keycloak_clienttemplate.py
+++ b/plugins/modules/keycloak_clienttemplate.py
@ -33,6 +33,8 @@ attributes:
        support: full
    diff_mode:
        support: full
+    action_group:
+        version_added: 10.2.0

 options:
    state:
@ -168,6 +170,7 @@ notes:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes

 author:
--- a/plugins/modules/keycloak_component.py
+++ b/plugins/modules/keycloak_component.py
@ -32,6 +32,8 @@ attributes:
        support: full
    diff_mode:
        support: full
+    action_group:
+        version_added: 10.2.0

 options:
    state:
@ -72,6 +74,7 @@ options:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes

 author:
--- a/plugins/modules/keycloak_component_info.py
+++ b/plugins/modules/keycloak_component_info.py
@ -18,6 +18,11 @@ version_added: 8.2.0

 description:
    - This module retrive information on component from Keycloak.
+
+attributes:
+    action_group:
+        version_added: 10.2.0
+
 options:
    realm:
        description:
@ -46,6 +51,7 @@ options:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes
    - community.general.attributes.info_module

--- a/plugins/modules/keycloak_group.py
+++ b/plugins/modules/keycloak_group.py
@ -36,6 +36,8 @@ attributes:
        support: full
    diff_mode:
        support: full
+    action_group:
+        version_added: 10.2.0

 options:
    state:
@ -114,6 +116,7 @@ notes:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes

 author:
--- a/plugins/modules/keycloak_identity_provider.py
+++ b/plugins/modules/keycloak_identity_provider.py
@ -31,6 +31,8 @@ attributes:
        support: full
    diff_mode:
        support: full
+    action_group:
+        version_added: 10.2.0

 options:
    state:
@ -277,6 +279,7 @@ options:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes

 author:
--- a/plugins/modules/keycloak_realm.py
+++ b/plugins/modules/keycloak_realm.py
@ -37,6 +37,8 @@ attributes:
        support: full
    diff_mode:
        support: full
+    action_group:
+        version_added: 10.2.0

 options:
    state:
@ -516,6 +518,7 @@ options:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes

 author:
--- a/plugins/modules/keycloak_realm_key.py
+++ b/plugins/modules/keycloak_realm_key.py
@ -43,6 +43,8 @@ attributes:
        support: full
    diff_mode:
        support: partial
+    action_group:
+        version_added: 10.2.0

 options:
    state:
@ -138,6 +140,7 @@ notes:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes

 author:
--- a/plugins/modules/keycloak_realm_keys_metadata_info.py
+++ b/plugins/modules/keycloak_realm_keys_metadata_info.py
@ -23,6 +23,10 @@ description:
    - The names of module options are snake_cased versions of the camelCase ones found in the
      Keycloak API and its documentation at U(https://www.keycloak.org/docs-api/latest/rest-api/index.html).

+attributes:
+    action_group:
+        version_added: 10.2.0
+
 options:
    realm:
        type: str
@ -32,6 +36,7 @@ options:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes
    - community.general.attributes.info_module

--- a/plugins/modules/keycloak_realm_rolemapping.py
+++ b/plugins/modules/keycloak_realm_rolemapping.py
@ -40,6 +40,8 @@ attributes:
        support: full
    diff_mode:
        support: full
+    action_group:
+        version_added: 10.2.0

 options:
    state:
@ -118,6 +120,7 @@ options:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes

 author:
--- a/plugins/modules/keycloak_role.py
+++ b/plugins/modules/keycloak_role.py
@ -35,6 +35,8 @@ attributes:
        support: full
    diff_mode:
        support: full
+    action_group:
+        version_added: 10.2.0

 options:
    state:
@ -116,6 +118,7 @@ options:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes

 author:
--- a/plugins/modules/keycloak_user.py
+++ b/plugins/modules/keycloak_user.py
@ -212,12 +212,15 @@ options:
        default: false
 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes
 attributes:
    check_mode:
        support: full
    diff_mode:
        support: full
+    action_group:
+        version_added: 10.2.0
 notes:
    - The module does not modify the user ID of an existing user.
 author:
--- a/plugins/modules/keycloak_user_federation.py
+++ b/plugins/modules/keycloak_user_federation.py
@ -31,6 +31,8 @@ attributes:
        support: full
    diff_mode:
        support: full
+    action_group:
+        version_added: 10.2.0

 options:
    state:
@ -513,6 +515,7 @@ options:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes

 author:
--- a/plugins/modules/keycloak_user_rolemapping.py
+++ b/plugins/modules/keycloak_user_rolemapping.py
@ -37,6 +37,8 @@ attributes:
        support: full
    diff_mode:
        support: full
+    action_group:
+        version_added: 10.2.0

 options:
    state:
@ -110,6 +112,7 @@ options:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes

 author:
--- a/plugins/modules/keycloak_userprofile.py
+++ b/plugins/modules/keycloak_userprofile.py
@ -28,6 +28,8 @@ attributes:
        support: full
    diff_mode:
        support: full
+    action_group:
+        version_added: 10.2.0

 options:
    state:
@ -270,6 +272,7 @@ notes:

 extends_documentation_fragment:
    - community.general.keycloak
+    - community.general.keycloak.actiongroup_keycloak
    - community.general.attributes

 author: