add plugin for generic keycloak component #8826

fivetide · 2024-09-03T11:36:39Z

SUMMARY

This MR adds a new plugin for generic management of keycloak components. It is derived from the keycloak_realm_keys plugin, but omits the key-specific handling of secrets and certs. Instead it is possible to manage any component.
Possible examples are ThemeSelector, LocaleSelector, UserStorageProvider.
see the official docs for more information:
https://www.keycloak.org/docs/latest/server_development/index.html#_providers

ISSUE TYPE

New Module/Plugin Pull Request

COMPONENT NAME

keycloak_component

ansibullbot · 2024-09-03T11:58:41Z

cc @eikef @mattock @ndclt @thomasbach-dev
click here for bot help

ansibullbot · 2024-09-03T12:04:06Z

The test botmeta failed with 1 error:

.github/BOTMETA.yml:0:0: Author fivetide not mentioned as active or inactive maintainer for plugins/modules/keycloak_component.py (mentioned are: eikef, ndclt, mattock, thomasbach-dev)

click here for bot help

felixfontein

Thanks for your contribution! Please reference to https://github.com/ansible-collections/community.general/blob/main/CONTRIBUTING.md#creating-new-modules-or-plugins for how to fix the BOTMETA issue (you need to add the module and yourself to .github/BOTMETA.yml).

felixfontein · 2024-09-06T19:15:51Z

changelogs/fragments/8826-keycloak-component.yml

Please remove the changelog fragment. New modules shouldn't have one (see https://github.com/ansible-collections/community.general/blob/main/CONTRIBUTING.md#creating-new-modules-or-plugins).

plugins/modules/keycloak_component.py

Co-authored-by: Felix Fontein <[email protected]>

plugins/modules/keycloak_component.py

Co-authored-by: Felix Fontein <[email protected]>

russoz

hi @fivetide , thanks for your contribution!

Overall the code loogs good, I left just a couple of comments below, and as pointed before you need to add an entry for this module in the .github/BOTMETA.yml file.

russoz · 2024-09-13T08:05:46Z

changelogs/fragments/8826-keycloak-component.yml

@@ -0,0 +1,2 @@
+minor_changes:
+  - keycloak_component - add plugin for managing any keycloak component (https://github.com/ansible-collections/community.general/pull/8826)


Please use punctuation here, this is later exported to public documentation.

Suggested change

- keycloak_component - add plugin for managing any keycloak component (https://github.com/ansible-collections/community.general/pull/8826)

- keycloak_component - add plugin for managing any keycloak component (https://github.com/ansible-collections/community.general/pull/8826).

This file needs to be removed anyway.

russoz · 2024-09-13T08:06:17Z

plugins/modules/keycloak_component.py

+# Copyright (c) 2017, Eike Frost <[email protected]>
+# Copyright (c) 2021, Christophe Gilles <[email protected]>


You should update this ;-)

russoz · 2024-09-13T08:07:46Z

plugins/modules/keycloak_component.py

+      used must have the requisite access rights. In a default Keycloak installation, admin-cli
+      and an admin user would work, as would a separate realm definition with the scope tailored


I think using the markup here might be helpful for the readers:

Suggested change

used must have the requisite access rights. In a default Keycloak installation, admin-cli

and an admin user would work, as would a separate realm definition with the scope tailored

used must have the requisite access rights. In a default Keycloak installation, C(admin-cli)

and an C(admin) user would work, as would a separate realm definition with the scope tailored

russoz · 2024-09-13T08:09:30Z

plugins/modules/keycloak_component.py

+        required: true
+    config:
+        description:
+            - Dict specifying the key and its properties. Contents vary depending on the provider type.


A bit odd to define the dict as being a dict. ;-) If I may suggest:

Suggested change

- Dict specifying the key and its properties. Contents vary depending on the provider type.

- Configuration properties for the provider.

- Contents vary depending on the provider type.

Or something along those lines.

russoz · 2024-09-13T08:11:19Z

plugins/modules/keycloak_component.py

+    """
+    Module execution
+
+    :return:
+    """


IMO the code is cleaner without this.

russoz · 2024-09-13T08:12:44Z

plugins/modules/keycloak_component.py

+    # Initialize the result object. Only "changed" seems to have special
+    # meaning for Ansible.


A bit redundant to describe how module results look like. And, to be fair, diff also has special meaning for Ansible.

Suggested change

# Initialize the result object. Only "changed" seems to have special

# meaning for Ansible.

# Initialize the result object. Only "changed" seems to have special

# meaning for Ansible.

fivetide added 3 commits September 3, 2024 13:31

add plugin for generic keycloak component

5eb678b

add changelog fragment

8c168cb

fix import in test

390e395

ansibullbot added module module new_contributor Help guide this first time contributor new_plugin New plugin plugins plugin (any type) tests tests unit tests/unit labels Sep 3, 2024

ansibullbot added ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Sep 3, 2024

felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-9 Automatically create a backport for the stable-9 branch labels Sep 4, 2024

felixfontein reviewed Sep 6, 2024

View reviewed changes

fivetide and others added 5 commits September 9, 2024 13:42

Update plugins/modules/keycloak_component.py

94d6b6e

Co-authored-by: Felix Fontein <[email protected]>

Update plugins/modules/keycloak_component.py

3875b95

Co-authored-by: Felix Fontein <[email protected]>

Update plugins/modules/keycloak_component.py

dfc07be

Co-authored-by: Felix Fontein <[email protected]>

Update plugins/modules/keycloak_component.py

a4f9e90

Co-authored-by: Felix Fontein <[email protected]>

set correct supported diff_mode

027c932

ansibullbot removed ci_verified Push fixes to PR branch to re-run CI new_contributor Help guide this first time contributor labels Sep 9, 2024

fix line lenght

2982a86

ansibullbot added the needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI label Sep 9, 2024

This comment was marked as outdated.

Sign in to view

ansibullbot removed the needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI label Sep 9, 2024

felixfontein reviewed Sep 9, 2024

View reviewed changes

plugins/modules/keycloak_component.py Outdated Show resolved Hide resolved

Update docblock

b2efc0d

Co-authored-by: Felix Fontein <[email protected]>

ansibullbot added the ci_verified Push fixes to PR branch to re-run CI label Sep 10, 2024

ansibullbot added ci_verified Push fixes to PR branch to re-run CI and removed ci_verified Push fixes to PR branch to re-run CI labels Sep 10, 2024

russoz reviewed Sep 13, 2024

View reviewed changes

ansibullbot added the stale_ci CI is older than 7 days, rerun before merging label Sep 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add plugin for generic keycloak component #8826

add plugin for generic keycloak component #8826

fivetide commented Sep 3, 2024

ansibullbot commented Sep 3, 2024

ansibullbot commented Sep 3, 2024

felixfontein left a comment

felixfontein Sep 6, 2024

This comment was marked as outdated.

russoz left a comment

russoz Sep 13, 2024

felixfontein Sep 13, 2024

russoz Sep 13, 2024

russoz Sep 13, 2024

russoz Sep 13, 2024

russoz Sep 13, 2024

russoz Sep 13, 2024

		@@ -0,0 +1,2 @@
		minor_changes:
		- keycloak_component - add plugin for managing any keycloak component (https://github.com/ansible-collections/community.general/pull/8826)

		# Copyright (c) 2017, Eike Frost <[email protected]>
		# Copyright (c) 2021, Christophe Gilles <[email protected]>

		used must have the requisite access rights. In a default Keycloak installation, admin-cli
		and an admin user would work, as would a separate realm definition with the scope tailored

	- Dict specifying the key and its properties. Contents vary depending on the provider type.
	- Configuration properties for the provider.
	- Contents vary depending on the provider type.

		# Initialize the result object. Only "changed" seems to have special
		# meaning for Ansible.

add plugin for generic keycloak component #8826

Are you sure you want to change the base?

add plugin for generic keycloak component #8826

Conversation

fivetide commented Sep 3, 2024

SUMMARY

ISSUE TYPE

COMPONENT NAME

ansibullbot commented Sep 3, 2024

ansibullbot commented Sep 3, 2024

felixfontein left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as outdated.

russoz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment